syntaxer 0.2.0 → 0.3.0

data/Gemfile

@@ -5,6 +5,7 @@ gem "git"
 
 #for colorizing output
 gem "rainbow"
+gem "progress_bar"
 
 group :development do
   gem "rspec", ">= 2.5.0"

data/Gemfile.lock

@@ -15,16 +15,23 @@ GEM
       json (>= 1.4.6)
       term-ansicolor (>= 1.0.5)
     diff-lcs (1.1.2)
+    fattr (2.2.0)
     ffi (1.0.7)
       rake (>= 0.8.7)
     gherkin (2.3.5)
       json (>= 1.4.6)
     git (1.2.5)
+    highline (1.6.1)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
     json (1.5.1)
+    options (2.3.0)
+      fattr
+    progress_bar (0.3.4)
+      highline (~> 1.6.1)
+      options (~> 2.3.0)
     rainbow (1.1.1)
     rake (0.8.7)
     rspec (2.5.0)
@@ -46,6 +53,7 @@ DEPENDENCIES
   cucumber
   git
   jeweler (~> 1.5.2)
+  progress_bar
   rainbow
   rspec (>= 2.5.0)
   yard (~> 0.6.0)

data/README.rdoc

@@ -2,15 +2,18 @@
 
 == Overview
 
-Syntaxer make possible check syntax of scripts. It may be used in standalone mode and with git repository.
-When syntaxer is used with git it checks syntax in added and changed files before every commit and stop it if there are an error in some of the files.
+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.
+It is useful for for rails team, because you need to store only 
 
 == Installation
 
 To install syntaxer run
 
   [sudo] gem install syntaxer
+  
+ Works with 1.8.x and 1.9.x
 
+== Fast Usage for Rails team
 
 == Usage
 
@@ -20,9 +23,9 @@ Run syntax checking in current directory recursively
 
   syntaxer
 
-Run syntax checking in another directory recursively
+Run syntax checking in another directory recursively. Make sure to add '/' at the end.
 
-  syntaxer -p ./developement
+  syntaxer -p ./developement/
 
 Install hook to git repository in current directory
 
@@ -63,16 +66,15 @@ You can specify multiple rules, for example you want to check only ruby files in
   end
 
 
-Languages available for now are: ruby, erb, haml, sass. But you can extend this by your own, how to do that i will describe below.
+Languages available for now are: ruby, erb, haml, sass. You can extend this by your own, how to do that will be described below.
 
 
 Options for usage
   -c, --config          specify config file
   -p, --path            path for syntax check. If this option is not specify it checks files from current directory
-  -l, --languages       specify language for check. Available sass, haml and ruby. By default check all of them.
   -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
-  -q, --quite           disable information messages.
+  -q, --quite           disable information messages. Is needed when you only want to know the result: 1 or 0
   -h, --help            show help and options describe above.
 
 == Contributing to syntaxer
@@ -89,10 +91,11 @@ Options for usage
 
 * 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
-* Git gem doesn't work properly on the very first commit.
 
+* Git gem doesn't work properly on the very first commit.
 
 == Author
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/bin/syntaxer

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))  #TODO: remove this
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'optparse'
 require 'ostruct'
@@ -31,9 +31,9 @@ class SyntaxerCLI
         options.root_path = r
       end
 
-      opts.on("-l", "--languages [ruby, haml, sass]", Array, "List of languages to be used in syntax checking") do |l|
-        options.languages = l
-      end
+      # opts.on("-l", "--languages [ruby, haml, sass]", Array, "List of languages to be used in syntax checking") do |l|
+      #   options.languages = l
+      # end
 
       opts.on("-r", "--repo [TYPE]", ['git', 'svn'],
               "Select repository type (git, svn)") do |r|
@@ -57,7 +57,7 @@ class SyntaxerCLI
       end
 
       opts.on_tail("--version", "Show version") do
-        puts IO.readlines('../VERSION','').first.to_s
+        puts IO.readlines(File.join(File.dirname(__FILE__), '..', 'VERSION'),'').first.to_s
         exit
       end
     end

data/features/step_definitions/plain_checker.rb

@@ -7,6 +7,6 @@ When /^I cd to working directory$/ do
 end
 
 Then /^the output should be the same as in "(.*)" file$/ do |f|
-  content = IO.readlines(File.join(SYNTAXER_ROOT_PATH, f),'').first.to_s
-  Then %{the output should contain "#{content}"}  
+  content = IO.readlines(File.join(PlainHelpers::SYNTAXER_ROOT_PATH, f),'').first.to_s
+  Then %{the output should contain exactly "#{content}\n"}
 end

data/features/syntaxer_check.feature

@@ -7,7 +7,7 @@ Feature: Test options
 
   @plain
   Scenario: Run version checking
-    When I run `syntaxer -v` interactively
-    Then the exit status should not be 0
+    When I run `syntaxer -v`
+    Then the exit status should be 0
     And the output should be the same as in "VERSION" file
 

data/lib/syntaxer.rb

@@ -1,3 +1,4 @@
+require "rubygems"
 require "rake"
 require "open3"
 require "forwardable"
@@ -8,6 +9,7 @@ require File.join(%w{syntaxer checker})
 require File.join(%w{syntaxer repository})
 require File.join(%w{syntaxer language_definition})
 require File.join(%w{syntaxer printer})
+require 'progress_bar'
 
 module Syntaxer
   DEFAULT_FILES_MASK = "**/*"

data/lib/syntaxer/checker.rb

@@ -1,18 +1,21 @@
-#       Rake::FileList
 require 'set'
+require "observer"
 module Syntaxer
   class Checker
     include Open3
+    include Observable
     extend Forwardable
 
     def_delegators Syntaxer::FileStatus, :error_files, :fine_files      
          
     attr_accessor :syntaxer, :reader
     
-    def initialize(syntaxer)
+    def initialize(syntaxer, count)
+      Printer.count_of_files count
+      add_observer(Printer)
       @syntaxer = syntaxer
       @reader = @syntaxer.reader
-      @results = []   
+      @results = []
     end
 
     # Factory for checker
@@ -26,6 +29,13 @@ module Syntaxer
         PlainChecker.new(syntaxer).process
       end
     end
+
+    protected
+    def check rule, file
+      popen3(rule.exec_rule.gsub('%filename%', file)) do |stdin, stdout, stderr, wait_thr|
+        stderr.read.split("\n")
+      end
+    end
          
   end
 
@@ -33,6 +43,10 @@ module Syntaxer
 
   class RepoChecker < Checker
 
+    def initialize syntaxer
+      super syntaxer, syntaxer.repository.changed_and_added_files.length
+    end
+
     # Check syntax in repository directory
     #
     # @see Checker#process
@@ -51,13 +65,11 @@ module Syntaxer
         end
 
         files_collection.each do |file|
-          errors = nil
           full_path = File.join(@syntaxer.root_path,file)
-          stdout, stderr, status = capture3(rule.exec_rule.gsub('%filename%', full_path))
-          errors = stderr.split("\n")
-
-          Printer.print_progress errors.empty?
+          errors = check(rule, full_path)
           FileStatus.build(file, errors)
+          changed
+          notify_observers(errors.empty?)
         end
       end
       
@@ -72,6 +84,10 @@ module Syntaxer
 
   class PlainChecker < Checker
 
+    def initialize syntaxer
+      super syntaxer, syntaxer.reader.files_count(syntaxer)
+    end
+
     # Check syntax in indicated directory
     #
     # @see Checker#process
@@ -79,12 +95,10 @@ module Syntaxer
     def process
       @reader.rules.each do |rule|
         rule.files_list(@syntaxer.root_path).each do |file|
-          errors = nil
-          stdout, stderr, status = capture3(rule.exec_rule.gsub('%filename%', file))
-          errors = stderr.split("\n")
-          
-          Printer.print_progress errors.empty?
+          errors = check(rule, file)
           FileStatus.build(file, errors)
+          changed
+          notify_observers(errors.empty?)
         end
       end
       

data/lib/syntaxer/printer.rb

@@ -5,19 +5,23 @@ module Syntaxer
 
   class Printer
     class << self
+      @@bar = nil
       attr_accessor :quite
 
-      # Print progress in dot notation
+      # Set count of files for progress bar
+      #
+      # @param [Integer] count of files
+
+      def count_of_files count
+        @@bar = ProgressBar.new(count, :bar, :counter)
+      end
+
+      # Show progress
       #
       # @param [Boolean] (true|false)
 
-      def print_progress succ = true
-        if succ
-          s = '.'.color(:green)
-        else
-          s = 'E'.color(:red)
-        end
-        print s unless @quite
+      def update status
+        @@bar.increment! unless @quite
       end
 
       # Print error message for each if file
@@ -28,6 +32,7 @@ module Syntaxer
         return if @quite
         puts "\n"
         puts "Syntax OK".color(:green) if files.empty?
+        puts "Errors:".color(:red) unless files.empty?
 
         files.each do |file|
           puts file.file_name

data/lib/syntaxer/reader.rb

@@ -13,6 +13,12 @@ module Syntaxer
         @rules = LanguageRules.new
         @ignore_folders = []
       end
+
+      def files_count syntaxer
+        @rules.map{ |rule|
+          rule.files_list(syntaxer.root_path).length
+        }.inject(:+)
+      end
             
       class << self
         
@@ -58,7 +64,6 @@ module Syntaxer
       #   | 
       def parse(dsl_data)
         self.instance_eval(dsl_data)
-        @rules << @current_rule
       rescue SyntaxError, NoMethodError, NameError => e
         raise DSLSyntaxError, "Illegal DSL syntax: #{e}"
       end

data/lib/syntaxer/repository.rb

@@ -17,11 +17,11 @@ module Syntaxer
   
   class Git
     require "git"
-        
+
     def initialize(repo_path)
-      @repository = ::Git.open(Dir.new(repo_path))
+      @repository = ::Git.open(File.expand_path(repo_path))
     rescue ArgumentError => ex
-        raise GitRepositoryError, "The path you specified is not a git repository: '#{File.expand_path(repo_path)}'"
+      raise GitRepositoryError, "The path you specified is not a git repository: '#{File.expand_path(repo_path)}'"
     end
 
     # Returns list of files what have been changed
@@ -30,7 +30,7 @@ module Syntaxer
 
     def changed_files
       @repository.chdir do
-        @changed ||= @repository.status.changed.keys
+        @changed ||= @repository.status.changed.to_a.map(&:first)
       end
     end
 
@@ -40,7 +40,7 @@ module Syntaxer
     
     def added_files
       @repository.chdir do
-        @added ||= @repository.status.added.keys
+        @added ||= @repository.status.added.to_a.map(&:first)
       end
     end
 
@@ -49,21 +49,20 @@ module Syntaxer
     # @return [Array]
     
     def changed_and_added_files
+      check_repo
       changed_files + added_files
-    rescue
-      []
     end
-=begin
+
     private
-    def check_repo repository
+    def check_repo
       @logs = @repository.log
       @logs.first
     rescue ::Git::GitExecuteError => e
-      puts "\nRepository is empty. There are no any revision.".color(:red)
+      puts "We can not find new or changed files. Log history is empty.\nPlease make first commit.".color(:red)
       raise e
       exit 1
     end
-=end
+
   end
   
   

data/spec/checker_spec.rb

@@ -7,7 +7,8 @@ describe "Syntaxer::Checker" do
     before(:each) do
       reader = mock('Reader')
       reader.stub!(:rules).and_return([Syntaxer::LanguageDefinition.new(:ruby, ["rb.example", "rake"], ["Rakefile", "Thorfile"], ["**/*"], nil, "ruby -wc %filename%")])
-      Syntaxer.should_receive(:reader).and_return(reader)
+      reader.stub!(:files_count).and_return(2)
+      Syntaxer.should_receive(:reader).any_number_of_times.and_return(reader)
       Syntaxer.stub!(:root_path).and_return(fixtures_path(:ruby))
 
       Syntaxer::Printer.stub!(:print_result)

data/spec/printer_spec.rb

@@ -9,11 +9,9 @@ describe "Syntaxer" do
     subject{Syntaxer::Printer}
 
     it "should be quite if passed --quite option" do
-      IO.should_not_receive(:print)
-      IO.should_not_receive(:puts)
-
+      ProgressBar.new.should_not_receive(:update)
       subject.quite = true
-      subject.print_progress true
+      subject.update true
       subject.print_result ['a','b']
     end
   end

data/spec/spec_helper.rb

@@ -37,7 +37,7 @@ def add_file_to_repo(lang, repo_dir, file_name)
 end
 
 def make_git_add(ruby_repo_dir)
-  g = Git.open(Dir.new(ruby_repo_dir))
+  g = Git.open(File.expand_path(ruby_repo_dir))
   
   g.chdir do
     g.add('.')
@@ -45,7 +45,7 @@ def make_git_add(ruby_repo_dir)
 end
 
 def make_initial_commit(ruby_repo_dir)
-  g = Git.open(Dir.new(ruby_repo_dir))
+  g = Git.open(File.expand_path(ruby_repo_dir))
   FileUtils.touch(File.join(ruby_repo_dir, 'README'))
   
   make_git_add(ruby_repo_dir)
@@ -54,7 +54,7 @@ def make_initial_commit(ruby_repo_dir)
 end
 
 def make_commit(ruby_repo_dir)
-  g = Git.open(Dir.new(ruby_repo_dir))
+  g = Git.open(File.expand_path(ruby_repo_dir))
   
   g.chdir do
     g.commit('second commit')

data/spec/syntaxer_spec.rb

@@ -23,7 +23,7 @@ describe "Syntaxer" do
       add_file_to_repo(:ruby, @repo_dir, "wrong.rb.example")
       make_git_add(@repo_dir)
       add_hook @repo_dir
-      g = Git.open(Dir.new(@repo_dir))
+      g = Git.open(File.expand_path(@repo_dir))
       g.chdir do
         lambda {g.commit('second commit')}.should raise_exception
       end
@@ -33,7 +33,7 @@ describe "Syntaxer" do
       add_file_to_repo(:ruby, @repo_dir, "correct.rb.example")
       make_git_add(@repo_dir)
       add_hook @repo_dir
-      g = Git.open(Dir.new(@repo_dir))
+      g = Git.open(File.expand_path(@repo_dir))
       g.chdir do
         lambda {g.commit('second commit')}.should_not raise_exception
       end

data/syntaxer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{syntaxer}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["artemk"]
-  s.date = %q{2011-04-17}
+  s.date = %q{2011-04-18}
   s.default_executable = %q{syntaxer}
   s.description = %q{Syntax checker for ruby and other languages}
   s.email = %q{kramarenko.artyom@gmail.com}
@@ -84,6 +84,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<git>, [">= 0"])
       s.add_runtime_dependency(%q<rainbow>, [">= 0"])
+      s.add_runtime_dependency(%q<progress_bar>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 2.5.0"])
       s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
@@ -92,6 +93,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<git>, [">= 0"])
       s.add_dependency(%q<rainbow>, [">= 0"])
+      s.add_dependency(%q<progress_bar>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 2.5.0"])
       s.add_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
@@ -101,6 +103,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<git>, [">= 0"])
     s.add_dependency(%q<rainbow>, [">= 0"])
+    s.add_dependency(%q<progress_bar>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 2.5.0"])
     s.add_dependency(%q<yard>, ["~> 0.6.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: syntaxer
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
-  version: 0.2.0
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - artemk
@@ -10,86 +15,127 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-17 00:00:00 +03:00
+date: 2011-04-18 00:00:00 +03:00
 default_executable: syntaxer
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: git
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-  type: :runtime
-  prerelease: false
+  name: git
   version_requirements: *id001
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rainbow
+  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-  type: :runtime
-  prerelease: false
+  name: rainbow
   version_requirements: *id002
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  type: :runtime
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.5.0
-  type: :development
-  prerelease: false
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: progress_bar
   version_requirements: *id003
+  prerelease: false
 - !ruby/object:Gem::Dependency 
-  name: yard
+  type: :development
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  name: rspec
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
         version: 0.6.0
-  type: :development
+  name: yard
+  version_requirements: *id005
   prerelease: false
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: jeweler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
         version: 1.5.2
-  type: :development
+  name: jeweler
+  version_requirements: *id006
   prerelease: false
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: cucumber
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-  type: :development
+  name: cucumber
+  version_requirements: *id007
   prerelease: false
-  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: aruba
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-  type: :development
+  name: aruba
+  version_requirements: *id008
   prerelease: false
-  version_requirements: *id007
 description: Syntax checker for ruby and other languages
 email: kramarenko.artyom@gmail.com
 executables: 
@@ -155,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3897909288735270095
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -164,6 +210,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []