checker 0.6.2 → 0.6.3

data/README.md

@@ -9,10 +9,11 @@ Checker is available in rubygems, so you just need to do:
 ```
 gem install checker
 ```
-If you are using bundler, you can add it to your project via `Gemfile` file (best to put it under `:development` group):
+If you are using bundler, you can add it to your project via `Gemfile` file (best to put it under `:development` group).
+Since checker is a command-line utility, there is no need to load it up in the application:
 ```ruby
 group :development do
-  gem 'checker'
+  gem 'checker', :required => false
 end
 ```
 
@@ -20,10 +21,10 @@ After installing the gem please follow [Git hook](#git-hook) section for further
 
 ### Git hook
 
-#### prepare-commit-msg hook
-If you want every commit be appended with checker approved icon (:checkered_flag:) add to your `.git/hooks/prepare-commit-msg` following:
+All you need to do is type in `checker install` and it will automatically install the prepare-commit-msg hook
+to your current git project. It will look like this:
 
-``` bash
+```
 #!/bin/bash
 checker
 
@@ -31,40 +32,36 @@ if [ $? == 1 ]; then
   exit 1
 fi
 
-echo ":checkered_flag:" >> $1
-```
-
-you can also prepend the flag to the first line of commit message, by changing last line with:
-
-``` bash
 text=`echo -n ':checkered_flag: '; cat $1`
 echo $text > $1
 ```
 
-#### pre-commit hook
-To just check your source code every time you commit, add to your `.git/hooks/pre-commit` line:
-
-``` bash
-#!/bin/bash
-checker
-```
-
-Use only either one hook.
-
+If you don't want your commits be prepended by checkered flag you can remove two last lines from the prepare-commit-msg hook.
 
-Don't forget to make the hooks files executable:
+Now checker will halt the commit if it finds problem with source code. Couple examples:
 
-``` bash
-chmod +x .git/hooks/pre-commit
-chmod +x .git/hooks/prepare-commit-msg
+#### pry
+```
+[ PRY - 1 files ]
+  Checking app/models/user.rb... [FAIL]
+46:binding.pry
 ```
 
-Now checker will halt the commit if it finds problem with source code:
+#### conflict
+```
+[ CONFLICT - 1 files ]
+  Checking a.bad.scss... [FAIL]
+4:<<<<<<< Updated upstream
+30:>>>>>>> Stashed changes
+```
 
+#### sass
 ```
-Checking app/models/user.rb...
-FAIL app/models/user.rb found occurence of 'binding.pry'
-46:binding.pry
+[ SASS - 1 files ]
+  Checking a.bad.scss... [FAIL]
+Syntax error: Invalid CSS after "qwe:": expected pseudoclass or pseudoelement, was "asd:"
+        on line 1 of .checker-cache/3cc74408b797b92e79207a64d97ae429
+  Use --trace for backtrace.
 ```
 
 ### Advanced usage
@@ -75,7 +72,28 @@ To check only specific filetypes on commit, use `git config` :
 git config checker.check 'ruby, haml, coffeescript'
 ```
 
-Available options are: ruby, haml, pry, coffeescript, sass, slim
+### Available options
+
+#### ruby
+Checks for correct syntax in ruby (.rb) files
+
+#### haml
+Checks for correct syntax in haml files
+
+#### pry
+Checks for any occurence of `binding.pry` or `binding.remote_pry`
+
+#### coffeescript
+Checks for correct syntax in coffeescript (.coffee) files
+
+#### sass
+Checks for correct syntax in sass and scss files
+
+#### slim
+Checks for correct syntax in slim files
+
+#### conflict
+Checks for any occurence of git conflicts when merging (looks for `<<<<<<< ` or `>>>>>>> `)
 
 ### Dependencies
 

data/checker.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/checker/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'checker'
   s.version     = Checker::VERSION
-  s.date        = '2012-08-30'
+  s.date        = '2012-09-19'
   s.summary     = "Syntax checker for various files"
   s.description = "A collection of modules which every is designed to check syntax for specific files."
   s.authors     = ["Jacek Jakubik", "Tomasz Pewiński"]

data/lib/checker.rb

@@ -3,13 +3,17 @@ require 'digest/md5'
 
 require 'checker/core_ext'
 require 'checker/version'
+require 'checker/installator'
+require 'checker/helper'
 
-require "checker/modules/base"
-require "checker/modules/ruby"
-require "checker/modules/haml"
-require "checker/modules/slim"
-require "checker/modules/pry"
-require "checker/modules/coffeescript"
-require "checker/modules/javascript"
-require "checker/modules/sass"
-require "checker/modules/yaml"
+%w[base ruby haml slim pry coffeescript javascript sass yaml conflict].each do |mod|
+  require "checker/modules/#{mod}"
+end
+
+def debug_mode?
+  ENV['CHECKER_DEBUG'].to_s == "1"
+end
+
+if debug_mode?
+  puts "Running checker with debug mode!".colorize(:yellow)
+end

data/lib/checker/cli.rb

@@ -7,7 +7,15 @@ module Checker
         if ARGV.size == 0
           modules = get_modules_to_check
         else
-          modules = ARGV.map(&:downcase)
+          if ARGV[0] == "install"
+            Checker::Installator.install!
+          elsif ARGV[0] == "help"
+            Checker::Helper.show_help!
+          elsif ARGV[0] == "modules"
+            Checker::Helper.show_modules!(self.available_modules)
+          else
+            modules = ARGV.map(&:downcase)
+          end
         end
 
         if modules.empty? || modules.include?('all')
@@ -35,7 +43,7 @@ module Checker
         exit (results.all_true? ? 0 : 1)
       end
 
-      private
+      protected
       def available_modules
         Checker::Modules.constants.map(&:to_s).map(&:downcase) - ['base']
       end

data/lib/checker/helper.rb

@@ -0,0 +1,17 @@
+module Checker
+  class Helper
+    def self.show_help!
+      puts "Checker version #{Checker::VERSION}"
+      puts "* install - type 'checker install' to install git pre-commit-hook"
+      puts "* modules - type 'checker modules' to see available modules"
+      puts "* checks  - type 'checker [module name]' to check your current git stage"
+      puts "* help    - type 'checker help' to see this message :)"
+      exit 0
+    end
+
+    def self.show_modules!(modules)
+      puts "Available modules are: all, #{modules.join(", ")}"
+      exit 0
+    end
+  end
+end

data/lib/checker/installator.rb

@@ -0,0 +1,46 @@
+module Checker
+  class Installator
+    def self.template
+      dir = File.dirname(__FILE__) + "/../.."
+      open(dir + "/templates/checker-prepare-commit-msg").read
+    end
+
+    def self.install!
+      hooks_dir = "#{Dir.pwd}/.git/hooks"
+
+      unless Dir.exist?(hooks_dir)
+        puts "Git Hooks dir not found. Are you sure you are inside project with git?"
+        exit 1
+      end
+
+      pre_commit = "#{hooks_dir}/prepare-commit-msg"
+      if File.exist?(pre_commit)
+        puts "Appending checker script to existing prepare-commit-msg hook..."
+        begin
+          open(pre_commit, 'a') do |f| 
+            f.puts(self.template)
+            f.chmod(0755)
+          end
+        rescue Exception => e
+          puts "Couldn't append checker script: #{e.message}"
+          exit 1
+        end
+        exit 0
+      else
+        tmp = self.template
+        str = "#!/bin/bash \n #{tmp}"
+        begin
+          open(pre_commit, "w") do |f| 
+            f.puts(str)
+            f.chmod(0755)
+          end
+        rescue Exception => e
+          puts "Couldn't write checker script: #{e.message}"
+          exit 1
+        end
+        puts "Script installed!"
+        exit 0
+      end
+    end
+  end
+end

data/lib/checker/modules/base.rb

@@ -64,10 +64,16 @@ module Checker
         end
       end
 
+      def check_one(filename, options = {})
+        puts "Called from #{self.class} - extend me in here!"
+        false
+      end
+
       def check_one_file file_name
         checksum = ::Digest::MD5.hexdigest(file_name)
+        puts file_name if debug_mode?
         checkout_file(file_name, checksum)
-        check_one(checkout_file_name(checksum))
+        check_one(checkout_file_name(checksum), :extension => File.extname(file_name))
       end
 
       def self.extensions *args
@@ -104,6 +110,7 @@ module Checker
       end
 
       def execute(cmd)
+        puts cmd if debug_mode?
         io = IO.popen(cmd)
         Process.wait(io.pid)
         @buffer ||= ""
@@ -144,9 +151,8 @@ module Checker
       end
 
       def rvm_command(command)
-        rvm_path = ENV['rvm_path'].to_s
         rvm_gem  = ENV['GEM_HOME'].to_s
-        rvm_version = rvm_gem.gsub(Regexp.new(rvm_path + "/gems/"), "")
+        rvm_version = rvm_gem.gsub(/.+rvm\/gems\//, "")
 
         "#{rvm_shell} '#{rvm_version}' -c '#{command}'"
       end

data/lib/checker/modules/coffeescript.rb

@@ -3,7 +3,7 @@ module Checker
     class Coffeescript < Base
       extensions 'coffee'
       private
-      def check_one(file)
+      def check_one(file, opts = {})
         plain_command("cat #{file} | egrep -v '^//=' | coffee -sc > /dev/null")
       end
 

data/lib/checker/modules/conflict.rb

@@ -0,0 +1,19 @@
+module Checker
+  module Modules
+    class Conflict < Base
+
+      private
+      def check_one(file, opts = {})
+        [check_for_conflict_start(file), check_for_conflict_end(file)].all_true?
+      end
+
+      def check_for_conflict_start(file)
+        !plain_command("grep -n \"<<<<<<< \" #{file}", :bundler => false)
+      end
+
+      def check_for_conflict_end(file)
+        !plain_command("grep -n \">>>>>>> \" #{file}", :bundler => false)
+      end
+    end
+  end
+end

data/lib/checker/modules/haml.rb

@@ -3,7 +3,7 @@ module Checker
     class Haml < Base
       extensions 'haml'
       private
-      def check_one(file)
+      def check_one(file, opts = {})
         plain_command("haml --check #{file} >> /dev/null")
       end
 

data/lib/checker/modules/javascript.rb

@@ -3,7 +3,7 @@ module Checker
     class Javascript < Base
       extensions 'js'
       private
-      def check_one(file)
+      def check_one(file, opts = {})
         plain_command("jsl -process #{file}")
       end
 

data/lib/checker/modules/pry.rb

@@ -3,7 +3,7 @@ module Checker
     class Pry < Base
 
       private
-      def check_one file
+      def check_one(file, opts = {})
         [check_for_binding_pry(file), check_for_binding_remote_pry(file)].all_true?
       end
 

data/lib/checker/modules/ruby.rb

@@ -3,7 +3,7 @@ module Checker
     class Ruby < Base
       extensions 'rb'
       private
-      def check_one(file)
+      def check_one(file, opts = {})
         plain_command("ruby -c #{file}", :bundler => false)
       end
     end

data/lib/checker/modules/sass.rb

@@ -3,8 +3,8 @@ module Checker
     class Sass < Base
       extensions 'scss', 'sass'
       private
-      def check_one(file)
-        plain_command("sass #{file}")
+      def check_one(file, opts = {})
+        plain_command("sass #{"--scss" if opts[:extension] == ".scss"} -c #{file}")
       end
 
       def check_for_executable

data/lib/checker/modules/slim.rb

@@ -3,7 +3,7 @@ module Checker
     class Slim < Base
       extensions 'slim'
       private
-      def check_one(file)
+      def check_one(file, opts = {})
         plain_command("slimrb --compile #{file} >> /dev/null")
       end
 

data/lib/checker/modules/yaml.rb

@@ -5,7 +5,7 @@ module Checker
     class Yaml < Base
       extensions 'yaml', 'yml'
       private
-      def check_one(file)
+      def check_one(file, opts = {})
         ret = begin
           YAML.load_file(file)
           true

data/lib/checker/version.rb

@@ -1,3 +1,3 @@
 module Checker
-  VERSION = '0.6.2'
+  VERSION = '0.6.3'
 end

data/spec/checker/fixtures/conflict/with_conflict.rb

@@ -0,0 +1,5 @@
+def test
+<<<<<<< Updated upstream
+=======
+end
+>>>>>>> Stashed changes

data/spec/checker/fixtures/conflict/without_conflict.rb

@@ -0,0 +1,2 @@
+def test
+end

data/spec/checker/modules/base_spec.rb

@@ -25,5 +25,29 @@ describe Checker::Modules::Base do
         Checker::Modules::Base.new.send(:rvm_command, "test").should == "/Users/test/.rvm/bin/rvm-shell 'some_ruby_version@v2' -c 'test'"
       end
     end
+
+    context "using different rvm_path (system-wide rvm)" do
+      before do
+        ENV.stub!(:[]).with("rvm_path").and_return "/usr/lib/rvm"
+      end
+
+      it "uses no gemsets" do
+        ENV.stub!(:[]).with("GEM_HOME").and_return "/Users/test/.rvm/gems/some_ruby_version"
+
+        Checker::Modules::Base.new.send(:rvm_command, "test").should == "/usr/lib/rvm/bin/rvm-shell 'some_ruby_version' -c 'test'"
+      end
+
+      it "uses global gemset" do
+        ENV.stub!(:[]).with("GEM_HOME").and_return "/Users/test/.rvm/gems/some_ruby_version@global"
+
+        Checker::Modules::Base.new.send(:rvm_command, "test").should == "/usr/lib/rvm/bin/rvm-shell 'some_ruby_version@global' -c 'test'"
+      end
+
+      it "uses some other gemset" do
+        ENV.stub!(:[]).with("GEM_HOME").and_return "/Users/test/.rvm/gems/some_ruby_version@v2"
+
+        Checker::Modules::Base.new.send(:rvm_command, "test").should == "/usr/lib/rvm/bin/rvm-shell 'some_ruby_version@v2' -c 'test'"
+      end
+    end
   end
 end

data/spec/checker/modules/conflict_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Checker::Modules::Conflict do
+  it 'checks all files' do
+    files = ['a.rb', 'b.js.erb', 'c.r', 'd.yaml', 'e.yml', 'f.coffee']
+    mod = Checker::Modules::Conflict.new(files)
+    mod.stub(:check_one).and_return(true)
+    mod.should_receive(:check_one).exactly(6).times
+    mod.check 
+  end
+
+  it "does find git conflict" do
+    files = [fixture("conflict", "with_conflict.rb")]
+    mod = Checker::Modules::Conflict.new(files)
+    mod.check.should be_false
+  end
+
+  it "does not find git conflict" do
+    files = [fixture("conflict", "without_conflict.rb")]
+    mod = Checker::Modules::Conflict.new(files)
+    mod.check.should be_true
+  end
+end

data/spec/checker/modules/sass_spec.rb

@@ -18,4 +18,22 @@ describe Checker::Modules::Sass do
     mod.should_not_receive(:check_one_file).with('c.r')
     mod.check 
   end
+
+  context "different extensions" do
+    it "gives proper command to sass module while checking .sass files" do
+      files = ["a.sass"]
+      mod = Checker::Modules::Sass.new(files)
+      mod.stub(:check_for_executable).and_return(true)
+      mod.should_receive(:plain_command).with("sass  -c .checker-cache/69cb154f5eeff19216d2879872ba6569")
+      mod.check
+    end
+
+    it "gives proper command to sass module while checking .scss files" do
+      files = ["a.scss"]
+      mod = Checker::Modules::Sass.new(files)
+      mod.stub(:check_for_executable).and_return(true)
+      mod.should_receive(:plain_command).with("sass --scss -c .checker-cache/13dbadc466ed1f9bdfbb2b545e45d012")
+      mod.check
+    end
+  end
 end

data/templates/checker-prepare-commit-msg

@@ -0,0 +1,11 @@
+
+#### Begin of checker script
+checker
+
+if [ $? == 1 ]; then
+  exit 1
+fi
+
+text=`echo -n ':checkered_flag: '; cat $1`
+echo $text > $1
+#### End of checker script

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checker
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-30 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -35,7 +35,6 @@ email:
 - tomasz.pewinski@netguru.pl
 executables:
 - checker
-- prepare-commit-msg
 extensions: []
 extra_rdoc_files: []
 files:
@@ -48,13 +47,15 @@ files:
 - README.md
 - Rakefile
 - bin/checker
-- bin/prepare-commit-msg
 - checker.gemspec
 - lib/checker.rb
 - lib/checker/cli.rb
 - lib/checker/core_ext.rb
+- lib/checker/helper.rb
+- lib/checker/installator.rb
 - lib/checker/modules/base.rb
 - lib/checker/modules/coffeescript.rb
+- lib/checker/modules/conflict.rb
 - lib/checker/modules/haml.rb
 - lib/checker/modules/javascript.rb
 - lib/checker/modules/pry.rb
@@ -64,6 +65,8 @@ files:
 - lib/checker/modules/yaml.rb
 - lib/checker/version.rb
 - spec/checker/cli_spec.rb
+- spec/checker/fixtures/conflict/with_conflict.rb
+- spec/checker/fixtures/conflict/without_conflict.rb
 - spec/checker/fixtures/pry/with_both.rb
 - spec/checker/fixtures/pry/with_pry.rb
 - spec/checker/fixtures/pry/with_pry_remote.rb
@@ -77,6 +80,7 @@ files:
 - spec/checker/fixtures/yaml/good.yaml
 - spec/checker/modules/base_spec.rb
 - spec/checker/modules/coffeescript_spec.rb
+- spec/checker/modules/conflict_spec.rb
 - spec/checker/modules/haml_spec.rb
 - spec/checker/modules/javascript_spec.rb
 - spec/checker/modules/pry_spec.rb
@@ -85,6 +89,7 @@ files:
 - spec/checker/modules/slim_spec.rb
 - spec/checker/modules/yaml_spec.rb
 - spec/spec_helper.rb
+- templates/checker-prepare-commit-msg
 homepage: http://github.com/netguru/checker
 licenses: []
 post_install_message: 

data/bin/prepare-commit-msg

@@ -1,9 +0,0 @@
-#!/bin/bash
-
-checker
-
-if [ $? == 1 ]; then
-  exit 1
-fi
-
-echo ":checkered_flag:" >> $1