Project

obcd

0.02
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
obcddblock/obcdHomepageDocumentationSource CodeBug TrackerWiki
Deal with obsessive compulsive issues of programmers in Objective-C.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
16,449
Stars
42
Forks
6
Watchers
8
 Releases
Current version
0.1.0
Total releases
1
First release
2014-03-28
Latest release
2014-03-28
 Issues
Open Issues
13
Closed Issues
1
Total Issues
14
Issue Closure Rate
7%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
4
Pull Request Acceptance Rate
80%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2014-04-07
Reverse Dependencies
0

 Dependencies

Runtime

activesupport
>= 0
gli
>= 0
 Project Readme

Obcd

Build Status

Deal with obsessive compulsive issues of programmers in Objective-C.

Eventually, the goal of OBCD is to become to Objective-C what Rubocop is to Ruby. So far it does one useful thing: help you fix the comment style on top of .h and .m files. For example, it can tell you that the name of the file in that comment doesn't match the actual file name.

Checks

  • HeaderStyle: Check header style on top of .h, .m and .pch files.
  • SpectaFocus: Detect instances of focused specs (e.g. fdescribe(…), fit(…)).

Usage

gem install obcd

Get Help

obcd help

Example: Find Files with Invalid Headers

$ obcd --path=spec/fixtures find HeaderStyle

HeaderStyle/WrongExtension.m: 1 violation
/Users/artsy/HeaderStyle/WrongExtension.m:2:1: warning: HeaderStyle: Filename extension doesn't match, expected .m, got .h.

HeaderStyle/WrongFilename.h: 1 violation
/Users/artsy/HeaderStyle/WrongExtension.h:2:1: warning: HeaderStyle: Expected header to include file name, instead got //  ThisFilenameIsWrong.h.

Found 2 violations.

Example: Find Focused Specs

$ obcd --path=spec/fixtures find SpectaFocus

SpectaFocus/FocusedSpec.m: 5 violations
/Users/artsy/SpectaFocus/FocusedSpec.m:5:1: warning: SpectaFocus: Unexpected fcontext(…) found.
/Users/artsy/SpectaFocus/FocusedSpec.m:6:1: warning: SpectaFocus: Unexpected fdescribe(…) found.
/Users/artsy/SpectaFocus/FocusedSpec.m:7:1: warning: SpectaFocus: Unexpected fexample(…) found.
/Users/artsy/SpectaFocus/FocusedSpec.m:9:1: warning: SpectaFocus: Unexpected fit(…) found.
/Users/artsy/SpectaFocus/FocusedSpec.m:11:1: warning: SpectaFocus: Unexpected fspecify(…) found.
SpectaFocus/InconsistentlyFormattedSpec.m: 2 violations

/Users/artsy/SpectaFocus/InconsistentlyFormattedSpec.m:4:1: warning: SpectaFocus: Unexpected fdescribe(…) found.
/Users/artsy/SpectaFocus/InconsistentlyFormattedSpec.m:5:1: warning: SpectaFocus: Unexpected fit(…) found.
Found 7 violations.

Xcode

You can also run OBCD as an Xcode build phase in order to see warnings inline in your files.

  1. Add a new Run Script Build Phase

  2. Add something like:

    source ~/.zshrc # or `source ~/.bashrc`
obcd find HeaderStyle

The next time you build your project you should see any OBCD warnings alongside others:

Xcode Warnings Screenshot

Contributing

See CONTRIBUTING.

Copyright and License

Copyright (c) 2014, Daniel Doubrovkine, Artsy.

This project is licensed under the MIT License.