checker 0.0.4.2 → 0.0.5

data/CHANGELOG

@@ -1,3 +1,11 @@
+=== version 0.0.5 (released 2012-07-09)
+
+* depencendy message - if executable not found, 
+  then proper message is displayed
+  where to fetch executable for module
+* fix ruby module, it should check only .rb files now
+* adding javascript checker using jsl (thx to Tomasz "pewniak747" Pewiński)
+
 === version 0.0.4.2 (released 2012-07-09)
 
 * another fix (i hope last one) - pry checking all files, not only .rb

data/README.md

@@ -4,18 +4,52 @@ A collection of modules for which every is designed to check syntax in files to
 
 ## Usage
 
+### Install
+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):
+```ruby
+group :development do
+  gem 'checker'
+end
+```
+
+After installing the gem please follow [Git hook](#git-hook) section for further details.
+
 ### Git hook
 
-To check your source code every time you commit, add to your .git/hooks/pre-commit line:
+#### 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:
+
+``` bash
+#!/bin/bash
+checker
+
+if [ $? == 1 ]; then
+  exit 1
+fi
 
+echo ":checkered_flag:" >> $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
 ```
 
-Don't forget to make the hook file executable:
+Use only either one hook.
+
+
+Don't forget to make the hooks files executable:
 
 ``` bash
 chmod +x .git/hooks/pre-commit
+chmod +x .git/hooks/prepare-commit-msg
 ```
 
 Now checker will halt the commit if it finds problem with source code:
@@ -31,9 +65,15 @@ FAIL app/models/user.rb found occurence of 'binding.pry'
 To check only specific filetypes on commit, use `git config` :
 
 ``` bash
-git config checker.check 'all'
-
 git config checker.check 'ruby, haml, coffeescript'
 ```
 
-Available options are: all, ruby, haml, pry, coffeescript, sass
+Available options are: ruby, haml, pry, coffeescript, sass
+
+### Dependencies
+
+For various modules to work you may need to install additional dependencies:
+
+* coffeescript - `npm install -g coffee-script` - see https://github.com/jashkenas/coffee-script/
+* javascript - `npm install -g jshint` - see https://github.com/jshint/node-jshint/#install
+* haml & sass - `gem install haml` `gem install sass`

data/Rakefile

@@ -0,0 +1,2 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/bin/prepare-commit-msg

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

data/checker.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'checker'
-  s.version     = '0.0.4.2'
-  s.date        = '2012-07-09'
+  s.version     = '0.0.5'
+  s.date        = '2012-07-11'
   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"]

data/lib/checker.rb

@@ -7,4 +7,5 @@ require "checker/modules/ruby"
 require "checker/modules/haml"
 require "checker/modules/pry"
 require "checker/modules/coffeescript"
+require "checker/modules/javascript"
 require "checker/modules/sass"

data/lib/checker/modules/base.rb

@@ -20,6 +20,10 @@ module Checker
         color "[ #{name} ]\n", :light_blue
       end
 
+      def dependency_message
+        "Executable not found, skipping...\n"
+      end
+
       def prepare_check
         @files_to_check = []
         @results = []
@@ -29,7 +33,7 @@ module Checker
         if check_for_executable
           true
         else
-          color "executable not found, skipping...\n", :magenta
+          color dependency_message, :magenta
           false
         end
       end
@@ -42,7 +46,7 @@ module Checker
         @files_to_check = self.files
         if self.class.extensions.any?
           @files_to_check = @files_to_check.select { |f|
-            self.class.extensions.map { |ex| f.ends_with?(ex) }.any?
+            self.class.extensions.map { |ex| f.ends_with?(".#{ex}") }.any?
           }
         end
         @files_to_check
@@ -100,7 +104,7 @@ module Checker
       end
 
       def color(str, color)
-        print str.colorize(color) 
+        print str.colorize(color) if str.length > 0
       end
 
       def name

data/lib/checker/modules/coffeescript.rb

@@ -10,6 +10,13 @@ module Checker
       def check_for_executable
         command('coffee -v', :show_output => false, :append => ">> /dev/null 2>&1")
       end
+
+      def dependency_message
+        str = "Executable not found\n"
+        str << "Install coffeescript from npm: 'npm install -g coffee-script'\n"
+        str << "More info: https://github.com/jashkenas/coffee-script/\n"
+        str
+      end
     end
   end
 end

data/lib/checker/modules/haml.rb

@@ -6,6 +6,12 @@ module Checker
       def check_one(file)
         plain_command("haml --check #{file} >> /dev/null")
       end
+
+      def dependency_message
+        str = "Executable not found\n"
+        str << "Install haml from rubygems: 'gem install haml'\n"
+        str
+      end
     end
   end
 end

data/lib/checker/modules/javascript.rb

@@ -0,0 +1,30 @@
+module Checker
+  module Modules
+    class Javascript < Base
+      extensions 'js'
+      private
+      def check_one(file)
+        plain_command("jsl -process #{file}")
+      end
+
+      def check_for_executable
+        command('jsl -help:conf', :show_output => false, :append => ">> /dev/null 2>&1")
+      end
+
+      def dependency_message
+        str = "Executable not found\n"
+        str << "Install jsl linter binary\n"
+        str << "More info: http://www.javascriptlint.com/download.htm\n"
+        str
+      end
+
+      # ignore exit status 1 - warnings
+      def plain_command cmd, options={}
+        system(cmd)
+        exitstatus = $?.exitstatus == 0 || $?.exitstatus == 1
+        show_output(exitstatus, options)
+        exitstatus
+      end
+    end
+  end
+end

data/lib/checker/modules/sass.rb

@@ -10,6 +10,13 @@ module Checker
       def check_for_executable
         command("sass -v", :use_bundler => true, :show_output => false, :append => ">> /dev/null 2>&1")
       end
+
+      def dependency_message
+        str = "Executable not found\n"
+        str << "Install sass from rubygems: 'gem install sass'\n"
+        str << "Sass requires haml to work properly: 'gem install haml'\n"
+        str
+      end
     end
   end
 end

data/spec/checker/cli_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module Checker
+  module Modules
+    class Bogus < Base
+      extensions '.test'
+      private
+      def check_one(file)
+        true
+      end
+
+      def check_for_executable
+        true
+      end
+    end
+  end
+end
+
+describe Checker::CLI do
+  before do
+    @argv_copy = ARGV
+  end
+  after do
+    ARGV = @argv_copy
+  end
+
+  context "running without arguments" do
+    it "should run checks on modules from git config" do
+      ARGV.stub(:size).and_return 0
+      Checker::CLI.should_receive(:get_modules_to_check).and_return(["bogus"])
+      Checker::CLI.should_receive(:exit).with(0).and_return true
+      Checker::CLI.execute
+    end
+  end
+
+  context "running with argument" do
+    it "should run check on modules from argument" do
+      ARGV = ["pry"]
+      Checker::CLI.should_not_receive(:get_modules_to_check)
+      Checker::CLI.should_receive(:exit).with(0).and_return true
+      Checker::CLI.execute
+    end
+  end
+end

data/spec/checker/modules/ruby_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Checker::Modules::Ruby do
+  it 'should only check .rb files' do
+    files = ['a.rb', 'b.js.erb', 'c.r']
+    mod = Checker::Modules::Ruby.new(files)
+    mod.stub(:check_one).and_return(true)
+    mod.should_receive(:check_one).once
+    mod.check 
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'checker/cli'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checker
 version: !ruby/object:Gem::Version
-  version: 0.0.4.2
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-09 00:00:00.000000000 Z
+date: 2012-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &70190454793620 !ruby/object:Gem::Requirement
+  requirement: &70291943302500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,19 +21,22 @@ dependencies:
         version: 0.5.8
   type: :runtime
   prerelease: false
-  version_requirements: *70190454793620
+  version_requirements: *70291943302500
 description: A collection of modules which every is designed to check syntax for specific
   files.
 email: jacek.jakubik@netguru.pl
 executables:
 - checker
+- prepare-commit-msg
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - CHANGELOG
 - README.md
+- Rakefile
 - bin/checker
+- bin/prepare-commit-msg
 - checker.gemspec
 - lib/checker.rb
 - lib/checker/cli.rb
@@ -41,9 +44,13 @@ files:
 - lib/checker/modules/base.rb
 - lib/checker/modules/coffeescript.rb
 - lib/checker/modules/haml.rb
+- lib/checker/modules/javascript.rb
 - lib/checker/modules/pry.rb
 - lib/checker/modules/ruby.rb
 - lib/checker/modules/sass.rb
+- spec/checker/cli_spec.rb
+- spec/checker/modules/ruby_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/netguru/checker
 licenses: []
 post_install_message: