cane-hashcheck 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e4a26f7dc5ae8c65a46f15a0cca16f037b33039
+  data.tar.gz: c65ff8d79d6d702cdab50fb4c421af67efc67507
+SHA512:
+  metadata.gz: 374483c36079cd117b187481ab44d033e250594cb5c72cecc0b814005c52b56a092aea70803ced38a05b69ae5838c23a122acc4594c62c8c869f1153268aebce
+  data.tar.gz: 4093494b70d4f0c491100fb0216b1493c9e48862a8c1683fba7b5cd5161c3329323865fe675a4b11fab925d30ef8baab41166173303b6db76adafa974a414ed7

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cane-hashcheck.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Hunt
+
+MIT License
+
+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,84 @@
+# Cane Hash Check
+
+`cane-hashcheck` enforces Ruby 1.9 hash syntax in your Ruby project using
+[cane](https://github.com/square/cane).
+
+## Description
+
+If you no longer like hash rockets, `cane-hashcheck` is for you. For example,
+see this ugliness?
+
+```ruby
+# person.rb
+def options
+  {
+    :name => 'Bob',
+    :age => 30,
+    :location => 'Seattle'
+  }
+end
+```
+
+When we run run our quality rake task, we are scolded for using the old hash
+syntax and encouraged to make a change on three lines:
+
+```bash
+$ rake quality
+Ruby 1.9 hash syntax violation (3):
+
+  person.rb:3
+  person.rb:4
+  person.rb:5
+
+  Total Violations: 3
+```
+
+Ah, much better:
+
+```ruby
+# person.rb
+def options
+  {
+    name: 'Bob',
+    age: 30,
+    location: 'Seattle'
+  }
+end
+```
+
+## Usage
+
+Add `cane-hashcheck` to your project's Gemfile:
+
+```ruby
+gem 'cane-hashcheck'
+```
+
+Use the `Cane::HashCheck` in your quality rake task:
+
+```ruby
+require 'cane/hashcheck'
+
+desc 'Check code quality'
+Cane::RakeTask.new(:quality) do |task|
+  task.use Cane::HashCheck
+end
+```
+
+Check code quality using rake:
+
+```bash
+$ rake quality
+```
+
+See the [cane project](https://github.com/square/cane) for general usage
+instructions.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes, with tests (`git commit -am 'Add some feature'`)
+4. Run the tests (`bundle exec rake`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cane/rake_task'
+require './lib/cane/hashcheck/hash_check'
+
+desc 'Run all tests'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = '--color --order random'
+end
+
+desc 'Check code quality'
+Cane::RakeTask.new(:quality) do |task|
+  task.abc_max = 9
+  task.use Cane::HashCheck
+end
+
+task default: :spec
+task default: :quality

data/cane-hashcheck.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cane/hashcheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cane-hashcheck'
+  spec.version       = Cane::Hashcheck::VERSION
+  spec.authors       = ['Chris Hunt']
+  spec.email         = ['c@chrishunt.co']
+  spec.description   = %q{Create Cane violations for pre-Ruby 1.9 hash syntax}
+  spec.summary       = %q{Create Cane violations for pre-Ruby 1.9 hash syntax}
+  spec.homepage      = 'https://github.com/chrishunt/cane-hashcheck'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_runtime_dependency 'cane'
+end

data/lib/cane/hashcheck.rb

@@ -0,0 +1,2 @@
+require 'cane/hashcheck/version'
+require 'cane/hashcheck/hash_check'

data/lib/cane/hashcheck/hash_check.rb

@@ -0,0 +1,59 @@
+module Cane
+  # Creates violations for hashes using pre-Ruby 1.9 hash syntax. Hash rockets
+  # are allowed only if the key is a 'string' or CONSTANT.
+  HashCheck = Struct.new(:options) do
+
+    DESCRIPTION  = 'Ruby 1.9 hash syntax violation'
+    DEFAULT_GLOB = '{app,lib}/**/*.rb'
+
+    def self.key; :hash; end
+    def self.name; 'Hash check'; end
+    def self.options
+      {
+        hash_glob: [
+          'File glob to run hash checks over',
+          default: DEFAULT_GLOB,
+          clobber: :no_hash
+        ]
+      }
+    end
+
+    def violations
+      [].tap do |violations|
+        unless options[:no_hash]
+          each_violation do |file_name, line_number|
+            violations << new_violation(file_name, line_number)
+          end
+        end
+      end
+    end
+
+    private
+
+    def new_violation(file_name, line_number)
+      {
+        file: file_name,
+        line: line_number,
+        description: DESCRIPTION
+      }
+    end
+
+    def each_violation
+      file_names.each do |file_name|
+        ::File.read(file_name).each_line.map.with_index do |line, line_number|
+          if invalid? line
+            yield file_name, line_number + 1
+          end
+        end
+      end
+    end
+
+    def invalid?(line)
+      line =~ /([^'A-Z])\s+=>\s+/
+    end
+
+    def file_names
+      Dir[ options.fetch(:hash_glob){ DEFAULT_GLOB } ]
+    end
+  end
+end

data/lib/cane/hashcheck/version.rb

@@ -0,0 +1,5 @@
+module Cane
+  module Hashcheck
+    VERSION = '0.9.0'
+  end
+end

data/spec/cane/hash_check_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'tempfile'
+require './lib/cane/hashcheck/hash_check'
+
+describe Cane::HashCheck do
+  subject { described_class.new hash_glob: file.path }
+
+  let(:file) do
+    Tempfile.new('file.rb').tap do |file|
+      file.write file_content
+      file.flush
+    end
+  end
+
+  context 'when the file contains hash rockets that should not be there' do
+    let(:file_content) do
+      <<-RUBY
+        { totally: :valid }
+        { :not => 'valid' }
+        {
+          totally: 'valid',
+          :not  =>  :valid,
+          TOTALLY => :valid
+        }
+        { 'also' =>  'valid' }
+      RUBY
+    end
+
+    it 'has a violation for each hash rocket' do
+      expect(subject.violations.count).to eq 2
+    end
+
+    it 'returns the offending file names' do
+      subject.violations.each do |violation|
+        expect(violation[:file]).to eq file.path
+      end
+    end
+
+    it 'returns the offending file lines' do
+      expect(subject.violations[0][:line]).to eq 2
+      expect(subject.violations[1][:line]).to eq 5
+    end
+  end
+
+  context 'when the file has no hashrockets' do
+    let(:file_content) do
+      <<-RUBY
+        { totally: :valid }
+        { totally: 'valid' }
+      RUBY
+    end
+
+    it 'does not have violations' do
+      expect(subject.violations).to be_empty
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: cane-hashcheck
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Chris Hunt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  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: Create Cane violations for pre-Ruby 1.9 hash syntax
+email:
+- c@chrishunt.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cane-hashcheck.gemspec
+- lib/cane/hashcheck.rb
+- lib/cane/hashcheck/hash_check.rb
+- lib/cane/hashcheck/version.rb
+- spec/cane/hash_check_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chrishunt/cane-hashcheck
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Create Cane violations for pre-Ruby 1.9 hash syntax
+test_files:
+- spec/cane/hash_check_spec.rb
+- spec/spec_helper.rb