checker 0.0.1 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 894360b4c4709d62126e69e0b01358ab2e9804a1
+  data.tar.gz: f0e0e368a70349ada13d3ee4d76135b4040a44ee
+SHA512:
+  metadata.gz: cb79267069194530f065c9d344566ef1b28659dfd1b3d6cf454f3b75371141d1df1ff754dc14096b5d0746f870c161145a1da74c7cee88fd99d72f4dd8645f15
+  data.tar.gz: ee42f4ce711ca0882ba7542b760d38d2f1e28c9264f30647af22ae809fd0a77157ebb9f6d80ea1b5273cfe7537aeed7c735e5f9e44889d9c464e92387d4e0b55

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+coverage/

data/.rspec

@@ -0,0 +1 @@
+--color --order rand

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+notifications:
+  email:
+    recipients:
+      - jacek.jakubik@netguru.pl
+      - tomasz.pewinski@netguru.pl
+

data/CHANGELOG

@@ -0,0 +1,103 @@
+=== version 0.7.0 (released 2015-03-02)
+
+* support for ruby 1.8 and ree is now gone
+* added rubocop module
+* some minor changes
+
+=== version 0.6.6 (released 2013-06-03)
+
+* you can now check all files inside specific directory
+* faster checks for binding.pry / console.log / conflict
+* sass check will use rails runner only if @import found in sass file
+* fix bug with no executable found
+* new fancy output
+
+=== version 0.6.5.rc2 (released 2013-02-23)
+
+* works with rbenv
+
+=== version 0.6.5.rc1 (released 2013-02-21)
+
+* release candidate version because of quite much changes
+
+KNOWN ISSUES
+* might not work with rbenv
+
+CHANGES
+* new state: warning. it is using by couple of checks (console.log, javascript)
+* added two more options: commit-on-warning and rails-for-sass (see readme for docs)
+* added check for console.log existance - returns warning if found
+* added reinstall script for git hook
+* updated sass check to use rails runner if project is using asset-pipeline
+* fixed bug when checker was running from system ruby version from git hook, not current rvm one
+  (checker reinstall required)
+
+=== version 0.6.4 (released 2012-09-24)
+
+* fix a prepare-commit-msg hook so it won't destroy line endings in the commit message
+
+=== version 0.6.3 (released 2012-09-19)
+
+* installation script
+* fix two issues (#14, #15)
+* new module: detecting commiting git conflicts
+* added a debug mode
+* added help (command: checker help)
+
+=== version 0.6.2 (released 2012-08-30)
+
+* quick fix for rbenv users
+
+=== version 0.6.1 (released 2012-08-29)
+
+* changed the version numbering
+* fixed rvm looking at wrong gemset if set (issue #9)
+
+=== version 0.0.6 (released 2012-08-28)
+
+* better support for rvm users
+* adding slim support (thanks to Filip Skokan)
+* better check for files which are staged and modified
+* cleanups, speed and refactor
+
+=== 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
+
+=== version 0.0.4.1 (released 2012-07-09)
+
+* some refactoring (thx again Tomasz Pewiński)
+* fix haml (--check is needed)
+
+=== version 0.0.4 (released 2012-07-09)
+
+* added colors
+* fix for sass
+* should work on rbenv rbenv (thx Tomasz Pewiński)
+
+=== version 0.0.3 (released 2012-06-07)
+
+* fix for ruby checker
+* added coffeescript checker
+* added sass checker
+
+=== version 0.0.2 (released 2012-04-20)
+
+* added ruby checker
+* added pry checker
+* all checker - checks all checkers
+* git config for selecting checkers
+
+
+=== version 0.0.1 (released 2012-04-03)
+
+* initial version
+* haml checker

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    checker (0.6.6)
+      colorize (~> 0.7.0)
+      rubocop (~> 0.28.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    colorize (0.7.5)
+    coveralls (0.7.11)
+      multi_json (~> 1.10)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    diff-lcs (1.1.3)
+    docile (1.1.5)
+    mime-types (2.4.3)
+    multi_json (1.10.1)
+    netrc (0.10.3)
+    parser (2.2.0.3)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rest-client (1.7.3)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    rubocop (0.28.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.7, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.1)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.3.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  checker!
+  coveralls
+  rspec

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 netguru
+
+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,142 @@
+# Checker
+[![Build Status](https://secure.travis-ci.org/netguru/checker.png?branch=master)](http://travis-ci.org/netguru/checker)
+[![Coverage Status](https://coveralls.io/repos/netguru/checker/badge.png?branch=master)](https://coveralls.io/r/netguru/checker)
+[![Code Climate](https://codeclimate.com/github/netguru/checker.png)](https://codeclimate.com/github/netguru/checker)
+[![Gem Version](https://badge.fury.io/rb/checker.png)](http://badge.fury.io/rb/checker)
+
+A collection of modules for which every is designed to check syntax in files to be commited via git.
+
+## Compatibility
+
+Checker works with rubies 1.9.2, 1.9.3 and 2.x.
+As for Rails with SASS - tested with RoR 3.2.x
+
+## Usage
+
+### Install
+Checker is available in rubygems (current stable version is 0.7.0), 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).
+Since checker is a command-line utility, there is no need to load it up in the application:
+```ruby
+group :development do
+  gem 'checker', :require => false
+end
+```
+
+After installing the gem please follow [Git hook](#git-hook) section for further details.
+
+### Git hook
+
+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 something like this:
+
+```
+#!/bin/bash
+
+#### Begin of checker script
+if [ -f /Users/user/.rvm/bin/rvm-shell ]; then
+  /Users/user/.rvm/bin/rvm-shell 'ruby-1.9.3-p286' -c 'checker'
+else
+  checker
+fi
+
+if [ $? = 1 ]; then
+  exit 1
+fi
+
+text=`echo -n ':ok: '; cat $1`
+echo "$text" > $1
+#### End of checker script
+```
+
+If you don't want your commits be prepended by checkered flag you can remove two last lines from the prepare-commit-msg hook.
+
+Now checker will halt the commit if it finds problem with source code. Couple examples:
+
+#### pry
+```
+[ PRY - 1 files ]
+  Checking app/models/user.rb... [FAIL]
+46:binding.pry
+```
+
+#### conflict
+```
+[ CONFLICT - 1 files ]
+  Checking a.bad.scss... [FAIL]
+4:<<<<<<< Updated upstream
+30:>>>>>>> Stashed changes
+```
+
+#### sass
+```
+[ 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
+
+You can specify checker behaviour for your project by changing the git config for checker.
+Available options are:
+
+* check
+
+  List of modules, seperated by comma, which checker will use. Defaults to all modules.
+  Example: `git config checker.check 'ruby, haml, coffeescript'`
+
+* commit-on-warning
+
+  Boolean value. If given false, checker will not commit when any module returns warning.
+  Defaults to true.
+  Example: `git config checker.commit-on-warning 'false'`
+
+* rails-for-sass
+
+  Boolean value. Will use rails runner to check for sass syntax using sprockets.
+  Works work rails >= 3.1. Defaults to true.
+  Example: `git config checker.rails-for-sass 'true'`
+
+
+### Available modules
+
+#### 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 `>>>>>>> `)
+
+#### rubocop
+Checks for if code follows the style guides ( https://github.com/bbatsov/rubocop )
+
+### 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 - install jsl binary - see http://www.javascriptlint.com/download.htm
+* haml & sass & slim - `gem install haml sass slim`
+* rubocop - `gem install rubocop`
+
+Copyright (c) 2015 Netguru. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default  => :spec

data/bin/checker

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'checker/cli'
 Checker::CLI.execute

data/checker.gemspec

@@ -1,13 +1,20 @@
+# -*- encoding : utf-8 -*-
+require File.expand_path('../lib/checker/version', __FILE__)
+
 Gem::Specification.new do |s|
   s.name        = 'checker'
-  s.version     = '0.0.1'
-  s.date        = '2012-04-03'
+  s.version     = Checker::VERSION
+  s.date        = '2015-03-02'
   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"]
-  s.email       = 'jacek.jakubik@netguru.pl'
+  s.authors     = ["Jacek Jakubik", "Tomasz Pewiński"]
+  s.email       = ['jacek.jakubik@netguru.pl', 'tomasz.pewinski@netguru.pl']
   s.files       = `git ls-files`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   s.homepage    = 'http://github.com/netguru/checker'
+  s.add_dependency 'colorize', '~> 0.7.0'
+  s.add_dependency 'rubocop', '~> 0.28.0'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'rspec'
 end

data/lib/checker.rb

@@ -1,7 +1,32 @@
+require 'colorize'
+require 'digest/md5'
+require 'erb'
+
 require 'checker/core_ext'
+require 'checker/rvm'
+require 'checker/version'
+require 'checker/installator'
+require 'checker/helper'
+require 'checker/options'
+require 'checker/result'
+
+%w[base ruby haml slim pry coffeescript javascript sass yaml conflict console_log rubocop].each do |mod|
+  require "checker/modules/#{mod}"
+end
+
+%w[default console_log javascript rubocop].each do |res|
+  require "checker/results/#{res}"
+end
+
+def debug_mode?
+  ENV['CHECKER_DEBUG'].to_s == "1"
+end
 
+if debug_mode?
+  puts "Running checker with debug mode!".colorize(:yellow)
+end
 
-require "checker/modules/all"
-require "checker/modules/ruby"
-require "checker/modules/haml"
+def debug(msg)
+  puts "[DEBUG] - #{msg}".colorize(:yellow) if debug_mode?
+end