morecane 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.1.0 (9th September 2012)
+- initial release

data/README.rdoc

@@ -0,0 +1,67 @@
+= Morecane
+
+== What?
+
+The cane gem provides a great framework for running quality checks over your
+ruby project as part of continuous integration build. It comes with a few
+checks out of the box, but also provides an API for loading custom checks.
+
+This gem provides a set of additional checks that I use across my projects.
+Maybe you'll find the useful as well.
+
+== How?
+
+Install this project like any rubygem:
+
+    gem install morecane
+
+Or add it to your Gemfile:
+
+    gem 'morecane'
+
+Then create a new rake task and load in the checks you require
+
+    require 'cane/rake_task'
+    require 'morecane'
+
+    desc "Run cane to check quality metrics"
+    Cane::RakeTask.new(:quality) do |cane|
+      cane.use Morecane::EncodingCheck, encoding_glob: "{app,lib,spec}/**/*.rb"
+    end
+
+=== Checks
+
+Here is a list of the checks available in this gem and the options they take.
+
+==== Morecane::EncodingCheck
+
+Ensure files have a ruby encoding marker in the first two lines.
+
+* encoding_glob - a string to specify the files to check. You probably want
+  something list "{app,lib,spec}/**/*.rb"
+
+==== Morecane::MustMatchCheck
+
+Ensure files match a given regular expression.
+
+* must_match_glob - a string to specify the files to check. You probably want
+  something list "{app,lib}/**/*.rb"
+* must_match_regexp - a regular expression to check each file against
+
+==== Morecane::MustNotMatchCheck
+
+Ensure files do not match a given regular expression.
+
+* must_not_match_glob - a string to specify the files to check. You probably want
+  something list "{app,lib}/**/*.rb"
+* must_not_match_regexp - a regular expression to check each file against
+
+== Who?
+
+This gem is written and maintained by James Healy <james@yob.id.au>
+
+== More?
+
+For more information on cane, check out it's comprehensive README
+
+    https://github.com/square/cane

data/lib/morecane.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+
+require 'cane'
+require 'morecane/encoding_check'
+require 'morecane/must_match_check'
+require 'morecane/must_not_match_check'

data/lib/morecane/encoding_check.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+module Morecane
+  # Creates violations for ruby files that have no encoding marker in the
+  # first two lines
+  class EncodingCheck < Struct.new(:opts)
+    def self.options
+      {
+        encoding_glob: ['Glob to run encoding checks over',
+                            default:  '{app,lib,spec}/**/*.rb',
+                            variable: 'GLOB',
+                            clobber:  :no_encoding]
+      }
+    end
+
+    def violations
+      file_names.map { |file_name|
+        find_violations(file_name)
+      }.flatten.compact
+    end
+
+    private
+
+    def find_violations(file_name)
+      data = ::File.open(file_name, 'r:utf-8')
+      line_one, line_two = *data.lines
+
+      if !line_one.to_s.match(/coding:/) && !line_two.to_s.match(/coding:/)
+        {
+          description: "Source file missing an encoding marker",
+          file:        file_name
+        }
+      end
+    end
+
+    def file_names
+      Dir[opts.fetch(:encoding_glob)]
+    end
+
+  end
+end

data/lib/morecane/must_match_check.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+module Morecane
+  # Creates violations for ruby files that don't match a given regexp
+  #
+  class MustMatchCheck < Struct.new(:opts)
+    def self.options
+      {
+        must_match_glob: ['Glob to run match checks over',
+                          default:  '{app,lib,spec}/**/*.rb',
+                          variable: 'GLOB',
+                          clobber:  :no_must_match],
+        must_match_regexp: ['Regexp to check files against',
+                            variable: 'REGEXP',
+                            clobber:  :no_must_match],
+      }
+    end
+
+    def violations
+      file_names.map { |file_name|
+        find_violations(file_name)
+      }.flatten.compact
+    end
+
+    private
+
+    def find_violations(file_name)
+      data = ::File.open(file_name, 'r:utf-8').read
+
+      if !data.match(opts.fetch(:must_match_regexp))
+        {
+          description: "Source file doesn't match regexp",
+          file:        file_name
+        }
+      end
+    end
+
+    def file_names
+      Dir[opts.fetch(:must_match_glob)]
+    end
+
+  end
+end

data/lib/morecane/must_not_match_check.rb

@@ -0,0 +1,43 @@
+# coding: utf-8
+
+module Morecane
+  # Creates violations for ruby files that match a given regexp
+  #
+  class MustNotMatchCheck < Struct.new(:opts)
+    def self.options
+      {
+        must_not_match_glob: ['Glob to run no-match checks over',
+                              default:  '{app,lib,spec}/**/*.rb',
+                              variable: 'GLOB',
+                              clobber:  :no_must_not_nomatch],
+        must_not_match_regexp: ['Regexp to check files against',
+                                variable: 'REGEXP',
+                                clobber:  :no_must_not_match],
+      }
+    end
+
+    def violations
+      file_names.map { |file_name|
+        find_violations(file_name)
+      }.flatten.compact
+    end
+
+    private
+
+    def find_violations(file_name)
+      data = ::File.open(file_name, 'r:utf-8').read
+
+      if data.match(opts.fetch(:must_not_match_regexp))
+        {
+          description: "Source file matches regexp",
+          file:        file_name
+        }
+      end
+    end
+
+    def file_names
+      Dir[opts.fetch(:must_not_match_glob)]
+    end
+
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: morecane
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: A set of common checks that I use with cane across my projects
+email:
+- james@yob.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/morecane.rb
+- lib/morecane/must_match_check.rb
+- lib/morecane/must_not_match_check.rb
+- lib/morecane/encoding_check.rb
+- README.rdoc
+- CHANGELOG
+homepage: http://github.com/yob/morecane
+licenses: []
+post_install_message: 
+rdoc_options:
+- --title
+- Morecane
+- --line-numbers
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.2
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Extra checks for the cane gem
+test_files: []