obcd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce0f61d47d3ad8f8183174fd16ce9f4e4eb6c7fe
+  data.tar.gz: 85efeaca218c6df59d7f09af0e61f4a03cc22b0b
+SHA512:
+  metadata.gz: 5ce59c7e3b4243f67c94e34147585e2164adea9ce41a210e5b613ddf2d1f7bf67e1d960d9911ac1e3ee65e2513b038f112d79df8dba9eb144a8e4a9867216bfe
+  data.tar.gz: 55c0e3c4547c09c59b6675c5cdc35d111ee51cedda9e3874bb67653f1ea7c8e2a505b52b2e3f9204eae4d78b4a23e216806f8e1021bb257a85f13a4d0e7a16fd

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (3/28/2014)
+
+* Initial public release with the [HeaderStyle](checks/HeaderStyle.md) check - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,118 @@
+Contributing to OBCD
+====================
+
+This project can't happen without your time. You're encouraged to submit [pull requests](https://github.com/intridea/obcd/pulls), [propose features and discuss issues](https://github.com/intridea/obcd/issues).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/intridea/obcd) and check out your copy.
+
+```
+git clone https://github.com/contributor/obcd.git
+cd obcd
+git remote add upstream https://github.com/intridea/obcd.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/obcd](spec/obcd).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Make it look like every other line, including your name and link to your Github account.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/obcd and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+#### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/intridea/obcd/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+#### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2014 Daniel Doubrovkine, Artsy.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+Obcd
+====
+
+[![Build Status](https://travis-ci.org/dblock/obcd.png)](https://travis-ci.org/dblock/obcd)
+
+Deal with obsessive compulsive issues of programmers in Objective-C.
+
+Eventually, the goal of OBCD is to become to Objective-C what [Rubocop](https://github.com/bbatsov/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](checks/HeaderStyle.md): Check header style on top of .h, .m and .pch files.
+
+## Usage
+
+```
+gem install obcd
+```
+
+#### Get Help
+
+```
+obcd help
+```
+
+#### Example: Find Files with Invalid Headers
+
+```
+$ obcd --path=spec/fixtures find HeaderStyle
+
+Checking HeaderStyle/WrongExtension.m: [1 violation(s) found]
+ HeaderStyle: line 2: Filename extension doesn't match, expected .m, got .h.
+
+Checking HeaderStyle/WrongFilename.h: [1 violation(s) found]
+ HeaderStyle: line 2: Expected header to include file name, instead got //  ThisFilenameIsWrong.h.
+
+Found 2 violation(s).
+```
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright and License
+
+Copyright (c) 2014, Daniel Doubrovkine, [Artsy](http://artsy.github.io).
+
+This project is licensed under the [MIT License](LICENSE.md).

data/bin/obcd

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'obcd'
+
+include GLI::App
+
+program_desc 'Deal with obsessive compulsive issues of programmers in Objective-C'
+
+flag [:p, :path], desc: 'Path to search', default_value: Dir.pwd
+switch [:v, :verbose], desc: 'Verbose', default_value: false
+
+default_command :help
+
+pre do |global_options, command, options, args|
+  $obcd = Obcd::Finder.new(global_options[:path])
+end
+
+desc "Find files that don't match rules."
+arg_name 'check, check[, check]*'
+long_desc "Available checks:\n\n" + Obcd::Checks.all.map { |check|
+  "- #{check.name.split('::').last}: #{check.desc}"
+}.join("\n")
+command :find do |c|
+  c.action do |global_options, options, args|
+    root = File.file?($obcd.path) ? Pathname.new(File.dirname($obcd.path)) : Pathname.new($obcd.path)
+
+    checks = args.map do |arg|
+      begin
+        "Obcd::Checks::#{arg}".constantize
+      rescue Exception => e
+        STDERR.puts "Invalid check #{arg}, #{e.message}."
+        exit_now! nil, -1
+      end
+    end
+
+    if checks.empty?
+      STDERR.puts "Please specify at least one check. Run 'obcd help find' for a list."
+      exit_now! nil, -1
+    end
+
+    violation_count = 0
+    $obcd.find do |filename|
+      relative_path = Pathname.new(filename).relative_path_from(root).to_s
+      STDOUT.write "Checking #{relative_path}: " if global_options[:verbose]
+      violations = {}
+      checks.each do |check|
+        instance_violations = check.check(filename)
+        violation_count += instance_violations.count
+        violations.merge! check => instance_violations unless instance_violations.empty?
+      end
+      if violations.empty?
+        STDOUT.puts "ok" if global_options[:verbose]
+      else
+        STDOUT.write "#{relative_path}: " unless global_options[:verbose]
+        puts "#{violations.count} violation#{violations.count == 1 ? '' : 's'}"
+        violations.each_pair do |check, violations|
+          violations.each do |violation|
+            puts " #{check.name.split('::').last}: #{violation}"
+          end
+        end
+      end
+    end
+    if violation_count > 0 || global_options[:verbose]
+      puts "Found #{violation_count} violation#{violation_count == 1 ? '' : 's'}."
+    end
+    exit_now! nil, violation_count
+  end
+end
+
+exit run(ARGV)

data/lib/obcd.rb

@@ -0,0 +1,8 @@
+require 'find'
+require 'pathname'
+require 'active_support/inflector'
+
+require 'obcd/version'
+require 'obcd/finder'
+require 'obcd/violations'
+require 'obcd/checks'

data/lib/obcd/checks.rb

@@ -0,0 +1,10 @@
+require 'obcd/checks/check'
+require 'obcd/checks/header_style'
+
+module Obcd
+  module Checks
+    def self.all
+      [Obcd::Checks::HeaderStyle]
+    end
+  end
+end

data/lib/obcd/checks/check.rb

@@ -0,0 +1,22 @@
+module Obcd
+  module Checks
+    class Check
+      attr_accessor :filename, :violations
+
+      def initialize(filename)
+        @filename = filename
+        @violations = []
+      end
+
+      def check!
+        # implement in a child class
+      end
+
+      def self.check(filename)
+        instance = new(filename)
+        instance.check!
+        instance.violations
+      end
+    end
+  end
+end

data/lib/obcd/checks/header_style.rb

@@ -0,0 +1,53 @@
+module Obcd
+  module Checks
+    class HeaderStyle < Check
+      def self.desc
+        'Normalize header style on top of .m and .h files.'
+      end
+
+      def check!
+        if head.select { |line| line.start_with?('//') }.count != 7
+          violations << Obcd::Violations::Violation.new(1, "Number of lines in header doesn't match.")
+        elsif head.select { |line| (line.start_with?('//') || line.start_with?('//  ')) && !line.start_with?('//   ') }.count != 7
+          violations << Obcd::Violations::Violation.new(1, "Header text alignment or number of spaces in header doesn't match.")
+        elsif head[7].strip != ''
+          violations << Obcd::Violations::Violation.new(1, 'Missing empty line after header.')
+        else
+          # opening
+          violations << Obcd::Violations::Violation.new(1, 'Expected header to start with a //.') unless head[0] == '//'
+          # filename
+          if head[1] != "//  #{File.basename(filename)}"
+            if head[1].downcase == "//  #{File.basename(filename).downcase}"
+              violations << Obcd::Violations::Violation.new(2, "Filename case doesn't match, expected #{File.basename(filename)}, got #{head[1]}.")
+            elsif (extension = File.extname(head[1].split('//').last)) != File.extname(filename)
+              violations << Obcd::Violations::Violation.new(2, "Filename extension doesn't match, expected #{File.extname(filename)}, got #{extension}.")
+            else
+              violations << Obcd::Violations::Violation.new(2, "Expected header to include file name, instead got #{head[1]}.") unless head[1] == "//  #{File.basename(filename)}"
+            end
+          end
+          # TODO: check company
+          # blank line
+          violations << Obcd::Violations::Violation.new(4, 'Expected a blank // after company name.') unless head[3] == '//'
+          # TODO: created by
+          # TODO: copyright
+          violations << Obcd::Violations::Violation.new(7, 'Expected a blank // after copyright.') unless head[3] == '//'
+        end
+      end
+
+      private
+
+      def head
+        @head ||= begin
+          open(filename) do |f|
+            lines = []
+            8.times do
+              line = f.gets || break
+              lines << line.chomp
+            end
+            lines
+          end
+        end
+      end
+    end
+  end
+end

data/lib/obcd/finder.rb

@@ -0,0 +1,20 @@
+module Obcd
+  class Finder
+    attr_reader :path
+
+    def initialize(path)
+      @path = File.expand_path(path)
+      fail Errno::ENOENT.new(path) unless File.exist?(@path) || Dir.exist?(@path)
+    end
+
+    def find(&block)
+      if File.file?(path)
+        yield path
+      else
+        Find.find(path) do |path|
+          yield path if ['.h', '.m', '.pch'].include? File.extname(path)
+        end
+      end
+    end
+  end
+end

data/lib/obcd/version.rb

@@ -0,0 +1,3 @@
+module Obcd
+  VERSION = '0.1.0'
+end

data/lib/obcd/violations.rb

@@ -0,0 +1 @@
+require 'obcd/violations/violation'

data/lib/obcd/violations/violation.rb

@@ -0,0 +1,16 @@
+module Obcd
+  module Violations
+    class Violation
+      attr_accessor :line, :description
+
+      def initialize(line, description)
+        @line = line
+        @description = description
+      end
+
+      def to_s
+        "line #{line}: #{description}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: obcd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: dblock@dblock.org
+executables:
+- obcd
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/obcd
+- lib/obcd/checks/check.rb
+- lib/obcd/checks/header_style.rb
+- lib/obcd/checks.rb
+- lib/obcd/finder.rb
+- lib/obcd/version.rb
+- lib/obcd/violations/violation.rb
+- lib/obcd/violations.rb
+- lib/obcd.rb
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+homepage: http://github.com/dblock/obcd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Deal with obsessive compulsive issues of programmers in Objective-C.
+test_files: []