syntaxer 0.4.0 → 0.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+
+script: "bundle exec rake spec && bundle exec cucumber"    

data/Gemfile

@@ -6,6 +6,8 @@ gem "git"
 #for colorizing output
 gem "rainbow"
 gem "progress_bar"
+gem "jslint_on_rails", ">= 1.0.6"
+gem "highline"
 
 group :development do
   gem "rspec", ">= 2.5.0"

data/Gemfile.lock

@@ -26,6 +26,7 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    jslint_on_rails (1.0.6)
     json (1.5.1)
     options (2.3.0)
       fattr
@@ -52,7 +53,9 @@ DEPENDENCIES
   aruba
   cucumber
   git
+  highline
   jeweler (~> 1.5.2)
+  jslint_on_rails (>= 1.0.6)
   progress_bar
   rainbow
   rspec (>= 2.5.0)

data/{README.rdoc → README.markdown}

@@ -1,64 +1,97 @@
-= syntaxer
+# syntaxer
 
-== Overview
+[![Build Status](http://travis-ci.org/artemk/syntaxer.png)](http://travis-ci.org/artemk/syntaxer)
 
-Syntaxer make possible check syntax of scripts. It may be used in standalone mode and with git repository for checking changed and added files only.
+## Overview
+
+Syntaxer is a gem that gives ability to check syntax of all files in your project at once. It may be used in standalone mode and with git repository for checking changed and added files only.
 It is useful for for rails team, because you need to store only file with rules, and git hook will be generated for you.
 
-== Installation
+## Installation
 
 To install syntaxer run
 
+<pre><code>
   [sudo] gem install syntaxer
+</code></pre>  
   
-  
-== Usage with rails
+## Usage with rails
 
 1) Add to Gemfile
 
-  gem "syntaxer"
-
+<pre><code>
+    gem "syntaxer"
+</code></pre>
+    
 2)
 
-  bundle install
+<pre><code>
+    bundle install
+</code></pre>
 
 3) 
 
+<pre><code>
   rake syntaxer:install
+</code></pre>
 
-It creates config/syntaxer.rb file with common rails options, you may edit it as you wish, and .git/hooks/pre-commit script, which will run syntax checking before every commit.
+or run in working dir
 
-== Standalone usage
+<pre><code>
+  syntaxer --install 
+</code></pre>
+
+This command will run wizard which help you to decide which languages and files should be processed using syntaxer.
+
+At final it will create config/syntaxer.rb file with common rails options, you may edit it as you wish, and .git/hooks/pre-commit script, which will run syntax checking before every commit.
+
+## Standalone usage (w/o Rails)
 
 Example of usage:
 
 Run syntax checking in current directory recursively
 
+<pre><code>
   syntaxer
+</code></pre>
 
 Run syntax checking in another directory recursively. Make sure to add '/' at the end.
 
+<pre><code>
   syntaxer -p ./developement/
+</code></pre>
 
 Install hook to git repository in current directory
 
-  syntaxer -i -r git
+<pre><code>
+  syntaxer -g -r git
+</code></pre>
 
-Indicate custom config file
+If you want to use custom config in pair with git
 
-  syntaxer -c config.rb
+<pre><code>
+  syntaxer -g -r git -c [CONFIG_FILE]
+</code></pre>
 
+Run syntaxer with custom config file
+
+<pre><code>
+  syntaxer -c config.rb
+</code></pre>
 
 Example of syntaxer.rb file:
 
+<pre><code>
   syntaxer do
     languages :ruby, :haml, :sass do         # type of files to be watched
       folders 'app/**/*', 'lib/**/*'               # folders to be checked
     end               
   end
+</code></pre>
 
 You can specify multiple rules, for example you want to check only ruby files in app/controllers/* and only haml in app/views/*, you can write the next in your "initializers/syntaxer.rb" file:
 
+<pre><code>
   syntaxer do
     languages :ruby do
       folders 'app/controllers/*'
@@ -75,22 +108,32 @@ You can specify multiple rules, for example you want to check only ruby files in
   
     ignore_folders 'app/models/**' # this folders will be deleted from all languages
   end
-
+</code></pre>
 
 Languages available for now are: ruby, erb, haml, sass. You can extend this by your own, how to do that will be described below.
 
 
+<pre><code>
 Options for usage
+  -i, --install         run install wizzard, preferred method of installation
   -c, --config          specify config file
   -p, --path            path for syntax check. If this option is not specify it checks files from current directory
   -r, --repo            indicate type of repository. Available git and svn at this time.
-  -i, --install         generates pre-commit hook and put it in .git/hooks folder. It checks syntax of languages what are indicated in options file before every commit
+  -g, --generate        generates pre-commit hook and put it in .git/hooks folder. It checks syntax of languages what are indicated in options file before every commit
   -q, --quite           disable information messages. Is needed when you only want to know the result: 1 or 0
   -l, --loud            informate about every checked file
   -W, --warnings        show warning messages
   -h, --help            show help and options describe above.
+</code></pre>
+
+## Syntaxer for javascript files
+
+You may use syntaxer to check javascript files using jslint (http://github.com/psionides/jslint_on_rails)
+
+Java and Rhino should be installed, you can read about it at jslint gem page.
+
 
-== Contributing to syntaxer
+## Contributing to syntaxer
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -100,24 +143,23 @@ Options for usage
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== TODO
+## TODO
 
 * Have to fix the problem with only created repository and initial commit with GIT repository
-* Add SVN support
 * Add description on how to add new languages
 
-== Known problems
+## Known problems
 
 * Git gem doesn't work properly on the very first commit.
 
-== Author
+## Author
 
 Artyom Kramarenko (artemk) Svitla Systems Inc (www.svitla.com)
 
-== Contributors
+## Contributors
 
 Artem Melnikov (ignar) Svitla Systems Inc (www.svitla.com)
 
-== Copyright
+## Copyright
 
 See LICENSE.txt for further details.

data/Rakefile

@@ -35,6 +35,30 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
+namespace :rcov do
+  desc "Run all specs on multiple ruby versions (requires rvm)"
+  task :portability do
+    %w{1.8.7 1.9.2}.each do |version|
+      system <<-BASH
+        bash -c 'if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
+                   source ~/.rvm/scripts/rvm;
+                   rvm gemset list | grep syntaxer > /dev/null;
+                   if [ $? -eq 1 ]; then
+                     echo -e "\e[0;31m--------- Please run \033[4mrvm use #{version}@syntaxer --create; gem install bundler; bundle install;\033[0m\e[0;31m to create gemset for tests. Thanks. ----------\n\e[0m"
+                     exit;
+                   fi
+                   rvm use #{version}@syntaxer;
+                   echo -e "\e[0;33m--------- version #{version}@syntaxer ----------\n\e[0m";
+                   rspec --color spec/*;
+                   cucumber;
+                 else
+                   echo You have no rvm installed or it is installed not in home directory.
+                 fi'
+      BASH
+    end
+  end
+end
+
 task :default => :spec
 
 require 'yard'

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/bin/syntaxer

@@ -17,6 +17,9 @@ class SyntaxerCLI
     options.languages   = :all
     options.warnings    = false
     options.rails       = false
+    options.jslint      = false
+    options.wizzard     = false
+    options.restore     = false # restore git hook, internal gem option
 
     opts = OptionParser.new do |opts|
       opts.banner = "Usage: syntaxer [options]"
@@ -50,7 +53,7 @@ class SyntaxerCLI
         options.loud = true
       end
 
-      opts.on("-i", "--install", "Write hooks to git") do |r|
+      opts.on("-g", "--generate", "Write hooks to git") do |r|
         options.generate = true
       end
 
@@ -66,6 +69,16 @@ class SyntaxerCLI
         options.rails = true
       end
 
+      opts.on("-j", "--jslint [DIR]", String, "Run jslint") do |r|
+        raise OptionParser::MissingArgument if r.nil?
+        r = r+'/' unless r =~ /\/$/
+        options.jslint = r
+      end
+
+      opts.on("-i", "--install", "Run wizzard") do
+        options.wizzard = true
+      end
+
       opts.separator ""
       opts.separator "Common options:"
 
@@ -80,14 +93,21 @@ class SyntaxerCLI
       end
     end
 
-    opts.parse!(args)
+    begin
+      opts.parse!(args)
+    rescue 
+      puts opts
+      raise
+    end
     options
   end
 
 end
 
 options = SyntaxerCLI.parse(ARGV)
-if options.generate.nil?
+if options.wizzard
+  Syntaxer.wizzard(options)
+elsif options.generate.nil?
   Syntaxer.check_syntax(options.instance_variable_get("@table"))
 else
   Syntaxer.make_hook(options.instance_variable_get("@table"))

data/features/plain_check.feature

@@ -12,3 +12,22 @@ Feature: Check syntax in plain mode
     Then the exit status should not be 0
     And the output should not contain "Syntax OK"
 
+  @plain @jslint
+  Scenario: Run checker in directory with jslint and wrong rubies
+    Given a file named "correct.rb" with:
+      """
+      class A;end
+      """
+    And a file named "wrong.rb" with:
+      """
+      class B
+      """
+    And a file named "javascripts/correct.js" with:
+      """
+      var func = function(){};
+      """
+    And a file named "javascripts/wrong.js" with:
+      """
+      var func = function(){
+      """
+    When I run 'syntaxer --jslint ./' and jslint should be invoked

data/features/rails_check.feature

@@ -9,4 +9,16 @@ Feature: Check git repository before commit
     When I run `git commit -m "some message"`
     Then the syntaxer shoud stop commit
     And the output should contain "Errors:"
+
+  @repo @rails @jslint
+  Scenario: Installation hook in rails environment with jslint feature
+    Given rails project with js scripts
+    And some lib with wrong syntax
+    And some js script
+    And installed hook in rails context with jslint
+    When I run `git commit -m "some message"`
+    Then the syntaxer shoud stop commit
+    And the output should contain "Running JSLint:"
+    And the output should contain "jslint checking failed"
+    And the output should contain "Errors:"
     And the output should contain "EE"

data/features/repository_check.feature

@@ -11,7 +11,3 @@ Feature: Check git repository before commit
     And some file with wrong syntax
     When run `git commit -m "some message"` interactively
     Then the syntaxer should stop commit
-
-
-
-

data/features/step_definitions/plain_checker.rb

@@ -7,20 +7,30 @@ Given /^directory contains two files$/ do
   create_temp_plain_work_dir
 end
 
-When /^I run 'syntaxer'$/ do
-  run_simple(unescape("#{File.join(File.dirname(__FILE__),'..','..','bin','syntaxer')}"), false)
+Then /^I run 'syntaxer([^']*)'$/ do |arg|
+  run_simple(unescape("#{File.join(File.dirname(__FILE__),'..','..','bin','syntaxer')} #{arg}"), false)
 end
 
-Then /^I run 'syntaxer \-l'$/ do
-  run_simple(unescape("#{File.join(File.dirname(__FILE__),'..','..','bin','syntaxer')} -l"), false)
-end
+When /^I run 'syntaxer \-\-jslint \.\/' and jslint should be invoked$/ do
+  options = OpenStruct.new()
+  options.restore = false
+  options.languages = :all
+  options.jslint = './'
+  options.config_file = Syntaxer::SYNTAXER_RULES_FILE
+  options.root_path = '.'
 
-Then /^I run 'syntaxer \-W'$/ do
-  run_simple(unescape("#{File.join(File.dirname(__FILE__),'..','..','bin','syntaxer')} -W"), false)
-end
+  Syntaxer::Printer.stub(:print_result)
+
+  reader = double
+  reader.stub(:add_rule)
+  Syntaxer::Reader::DSLReader.stub(:load){reader}
 
-Then /^I run 'syntaxer \-v'$/ do
-  run_simple(unescape("#{File.join(File.dirname(__FILE__),'..','..','bin','syntaxer')} -v"), false)
+  checker = double
+  checker.stub(:error_files){[]}
+  Syntaxer::Runner.should_receive(:javascript).and_return(Proc.new{})
+  Syntaxer::Checker.stub(:process){checker}
+  
+  Syntaxer.check_syntax(options.instance_variable_get("@table"))
 end
 
 When /^I cd to working directory$/ do

data/features/step_definitions/rails_checker.rb

@@ -9,20 +9,41 @@ Given /^rails project$/ do
   run_simple(unescape("git commit -m'first commit'"), false)
 end
 
+Given /^rails project with js scripts$/ do
+  in_current_dir do
+    FileUtils.mkdir_p("public/scripts")
+  end
+  Given "rails project"
+end
+
+
 Given /^some lib with wrong syntax$/ do
   write_file('lib/wrong.rb', "mod A;end")
   write_file('app/wrong.rb', "mod A;end")
   run_simple(unescape("git add ."), false)
 end
 
+Given /^some js script$/ do
+  write_file('public/javascripts/main.js', "var func = function(){")
+  run_simple(unescape("git add ."), false)
+end
+
 Given /^installed hook in rails context$/ do
-  run_simple("#{File.join(File.dirname(__FILE__),'..','..','bin','syntaxer')} -i -r git --hook --rails")
+  run_simple("#{File.join(File.dirname(__FILE__),'..','..','bin','syntaxer')} -g -r git --hook --rails")
   in_current_dir do
     FileUtils.cp(File.join(File.dirname(__FILE__),'..','..',"syntaxer_rails_rules.dist.rb"),"config/syntaxer.rb")
   end
   run_simple('chmod 755 .git/hooks/pre-commit')
 end
 
+Given /^installed hook in rails context with jslint$/ do
+  Given "installed hook in rails context"
+  in_current_dir do
+    FileUtils.cp(File.join(File.dirname(__FILE__),'..','..',"syntaxer_rails_rules_jslint.dist.rb"),"config/syntaxer.rb")
+  end
+  run_simple('chmod 755 .git/hooks/pre-commit')
+end
+
 Then /^the syntaxer shoud stop commit$/ do
   @last_exit_status.should eql(1)
 end

data/features/step_definitions/repository_checker.rb

@@ -12,8 +12,8 @@ When /^run `git commit \-m \"some message\"` interactively$/ do
   add_hook
 end
 
-Then /^I run 'syntaxer \-i \-r git'$/ do
-  run_simple(unescape("#{File.join(File.dirname(__FILE__),'..','..','bin','syntaxer')} -i -r git"), false)
+Then /^I run 'syntaxer \-g \-r git'$/ do
+  run_simple(unescape("#{File.join(File.dirname(__FILE__),'..','..','bin','syntaxer')} -g -r git"), false)
 end