syntaxer 0.1.0

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+gem "git"
+gem "rainbow"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "cucumber"
+  gem "aruba"
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.3.2)
+      childprocess (~> 0.1.6)
+      cucumber (~> 0.10.0)
+      rspec (~> 2.3.0)
+    builder (3.0.0)
+    childprocess (0.1.8)
+      ffi (~> 1.0.6)
+    cucumber (0.10.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (>= 2.3.5)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
+    diff-lcs (1.1.2)
+    ffi (1.0.7)
+      rake (>= 0.8.7)
+    gherkin (2.3.5)
+      json (>= 1.4.6)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.1)
+    rainbow (1.1.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    term-ansicolor (1.0.5)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler (~> 1.0.0)
+  cucumber
+  git
+  jeweler (~> 1.5.2)
+  rainbow
+  rcov
+  rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 artemk
+
+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.rdoc

@@ -0,0 +1,104 @@
+= syntaxer
+
+== 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.
+
+== Installation
+
+To install syntaxer run
+
+  sudo gem install syntaxer
+
+== Usage
+
+== Syntaxer with rails
+
+Example of usage:
+
+Run syntax checking in current directory recursively
+
+  syntaxer
+
+Run syntax checking in another directory recursively
+
+  syntaxer -p ./developement
+
+Install hook to git repository in current directory
+
+  syntaxer -i -r git
+
+Indicate custom config file
+
+  syntaxer -c config.rb
+
+
+Describe your rules in syntaxer.rb file and put in "initializers" folder for rails
+
+Example of syntaxer.rb file:
+
+  syntaxer do
+    languages :ruby, :haml, :sass do         # type of files to be watched
+      folders 'app/**/*', 'lib/**/*'               # folders to be checked
+    end               
+  end
+
+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:
+
+  syntaxer do
+    languages :ruby do
+      folders 'app/controllers/*'
+    end
+  
+    lang :haml do  # lang is an alias for languages
+      f 'app/views/*' #f is an alias for folders    
+    end
+    
+    #all supported types at app/**
+    languages :all do
+      folders 'app/**'
+    end
+  
+    ignore_folders 'app/models/**' # this folders will be deleted from all languages
+  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.
+
+
+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.
+  -h, --help            show help and options describe above.
+
+== 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
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* 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
+
+* Have to fix the problem with only created repository and initial commit with GIT reposytory
+* Add SVN support
+
+== Author
+
+Artyom Kramarenko (artemk) Svitla Systems Inc (svitla.com)
+
+== Contributors
+
+Artem Melnikov (ignar) Svitla Systems Inc (svitla.com)
+
+== Copyright
+
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "syntaxer"
+  gem.homepage = "http://github.com/artemk/syntaxer"
+  gem.license = "MIT"
+  gem.summary = "Syntax checker for ruby and other languages"
+  gem.description = %Q{Syntax checker for ruby and other languages}
+  gem.email = "kramarenko.artyom@gmail.com"
+  gem.authors = ["artemk"]
+  gem.executables = ["syntaxer"]
+  gem.add_runtime_dependency 'git', '>=1.2.5'
+  gem.add_runtime_dependency 'rainbow', '>=1.1.1'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = Rake::FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/syntaxer

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))  #TODO: remove this
+
+require 'optparse'
+require 'ostruct'
+require 'pp'
+
+require 'syntaxer'
+
+class SyntaxerCLI
+
+  def self.parse(args)
+    options = OpenStruct.new  
+    options.config_file = Syntaxer::SYNTAXER_RULES_FILE  
+    options.root_path   = Dir.getwd
+    options.languages   = :all
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: syntaxer [options]"
+
+      opts.separator ""
+      opts.separator "Specific options:"
+
+      opts.on("-c", "--config [CONFIG_FILE]", String,
+              "Syntax rules file to be used for syntaxer") do |config_file|
+        options.config_file = config_file
+      end
+
+      opts.on("-p", "--path [DIR]", String, "If you want to check files not from current place") do |r|
+        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("-r", "--repo [TYPE]", ['git', 'svn'],
+              "Select repository type (git, svn)") do |r|
+        options.repository = r
+      end
+      
+      opts.on("-q", "--quite", "Run in verbose mode") do |r|
+        options.quite = true
+      end
+
+      opts.on("-i", "--install", "Write hooks to git") do |r|
+        options.generate = true
+      end
+
+      opts.separator ""
+      opts.separator "Common options:"
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      opts.on_tail("--version", "Show version") do
+        puts Syntaxer::VERSION
+        exit
+      end
+    end
+
+    opts.parse!(args)
+    options
+  end
+
+end
+
+options = SyntaxerCLI.parse(ARGV)
+if options.generate.nil?
+  Syntaxer.check_syntax(options.instance_variable_get("@table"))
+else
+  Syntaxer.make_hook(options.instance_variable_get("@table"))
+end
+

data/features/plain_check.feature

@@ -0,0 +1,14 @@
+@announce
+Feature: Check syntax in plain mode
+
+  In order to check syntax
+  A user who used gem
+  Should be abble run command
+
+  @plain
+  Scenario: Run checker in directory
+    Given directory containt two files
+    When I run `syntaxer` interactively
+    Then the exit status should not be 0
+    And the output should not contain "Syntax OK"
+

data/features/repository_check.feature

@@ -0,0 +1,13 @@
+@announce
+Feature: Check git repository before commit
+
+  In order to check syntax
+  A user print "git commit"
+  Commit have to be rejected in case of wrong syntax
+
+  @repo
+  Scenario: Run "git commit"
+    Given git repository
+    And some file with worng syntax
+    When run `git commit -m "some message"` interactively
+    Then the syntaxer should stop commit

data/features/step_definitions/plain_checker.rb

@@ -0,0 +1,8 @@
+Given /^directory containt two files$/ do
+  create_temp_plain_work_dir
+end
+
+When /^I cd to working directory$/ do
+  cd(@tmp_dir)
+end
+

data/features/step_definitions/repository_checker.rb

@@ -0,0 +1,18 @@
+Given /^git repository$/ do
+  create_temp_repo_work_dir
+end
+
+Given /^some file with worng syntax$/ do
+  in_current_dir do
+    add_fixtures_files
+  end
+end
+
+When /^run `git commit \-m \"some message\"` interactively$/ do 
+  add_hook
+end
+
+Then /^the syntaxer should stop commit$/ do
+  lambda{make_git_commit}.should raise_exception
+  #@last_exit_status.should_not == 0
+end

data/features/support/env.rb

@@ -0,0 +1,3 @@
+require 'aruba/cucumber'
+require 'fileutils'
+require "git"

data/features/support/hooks.rb

@@ -0,0 +1,7 @@
+Before do
+  
+end
+
+After do
+  
+end

data/features/support/plain_helpers.rb

@@ -0,0 +1,73 @@
+module PlainHelpers
+  @tmp_dir
+  def temp_dir
+    tmpdir = File.expand_path current_dir #"#{Time.now.to_i}"
+    @tmp_dir = tmpdir
+    tmpdir
+  end
+
+  def add_fixtures_files
+    Dir["#{fixtures_path}/*.example"].each do |f|
+      FileUtils.cp f, File.join(@tmp_dir,File.basename(f,'.example'))
+    end
+  end
+  
+  def create_tmp_dir
+    tmpdir = temp_dir
+    create_dir(tmpdir)
+    tmpdir
+  end
+
+  def syntaxer_rules_example_file file = ''
+    File.join(File.expand_path('../../',File.dirname(__FILE__)), 'spec/fixtures', "#{file.empty? ? 'syntaxer_rules': file}.rb")
+  end
+
+  def create_tmp_repo_dir
+  end
+  
+  def fixtures_path
+    File.join(File.expand_path('../../',File.dirname(__FILE__)),'spec/fixtures/ruby')
+  end
+  
+  def create_temp_plain_work_dir
+    tmp = create_tmp_dir
+    in_current_dir do
+      add_fixtures_files
+    end
+  end
+
+  def create_temp_repo_work_dir
+    create_tmp_dir
+    g = Git.init(File.expand_path(File.join(@tmp_dir)))
+    FileUtils.touch(File.join(@tmp_dir,'README'))
+    g.add('.')
+    g.commit('first commit')
+  end
+
+  def add_hook
+    in_current_dir do
+      bin_file = File.join(File.expand_path('../../',File.dirname(__FILE__)), 'bin/syntaxer')
+      hook_file = File.expand_path(File.join('.git/hooks/pre-commit'))
+      File.open(hook_file, 'w') do |f|
+        f.puts "#{bin_file} -c #{syntaxer_rules_example_file('syntaxer_rules_git')} -r git -p #{File.expand_path(@tmp_dir)}"
+      end
+      File.chmod(0755, hook_file)
+    end
+  end
+
+  def make_git_commit
+    g = Git.open File.expand_path(@tmp_dir) #(File.expand_path(File.join(current_dir)))
+    g.add
+    #pp File.expand_path(current_dir)
+    #Dir.chdir(File.expand_path(current_dir)) do
+      #g = Git.open Dir.pwd
+      #g.add
+    Dir.chdir(current_dir)
+      g.commit('second commit')
+    #end
+    
+  end
+
+end
+
+World(PlainHelpers)

data/init.rb

@@ -0,0 +1,5 @@
+begin
+  require File.join(File.dirname(__FILE__), 'lib', 'syntaxer') # From here
+rescue LoadError
+  require 'syntaxer' # From gem
+end

data/lib/syntaxer/checker.rb

@@ -0,0 +1,115 @@
+#       Rake::FileList
+require 'set'
+module Syntaxer
+  class Checker
+    include Open3
+    extend Forwardable
+
+    # Does not working
+    def_delegators Syntaxer::FileStatus, :error_files, :fine_files      
+         
+    attr_accessor :syntaxer, :reader
+
+    # List of files with correct syntax
+    #
+    # @return [Array<FileStatus>, #each] array with files
+    #
+    # @see FileStatus#fine_files
+    
+    def self.fine_files
+      FileStatus.fine_files
+    end
+
+    # List of files with wrong syntax
+    #
+    # @return [Array<FileStatus>, #each] array with files
+    #
+    # @see FileStatus#fine_files
+
+    def self.error_files
+      FileStatus.error_files
+    end
+    
+    def initialize(syntaxer)
+      @syntaxer = syntaxer
+      @reader = @syntaxer.reader
+      @results = []   
+    end
+
+    # Factory for checker
+    #
+    # @return [RepoChecker, #process] 
+
+    def self.process(syntaxer)
+      if syntaxer.repository
+        RepoChecker.new(syntaxer).process
+      else
+        PlainChecker.new(syntaxer).process
+      end
+    end
+         
+  end
+
+  # Check status of files in repository
+
+  class RepoChecker < Checker
+
+    # Check syntax in repository directory
+    #
+    # @see Checker#process
+
+    def process
+      checked_files = Set.new
+      @reader.rules.each do |rule|
+        files_collection = []
+        rule.extensions.each do |ext|
+          files.each do |file|
+            if file.include?(ext) && !checked_files.include?(file)
+              files_collection << file
+              checked_files.add(file)
+            end
+          end
+        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?
+          FileStatus.build(file, errors)
+        end
+      end
+      FileStatus
+    end
+
+    private
+    def files
+      @syntaxer.repository.changed_and_added_files
+    end
+  end
+
+  class PlainChecker < Checker
+
+    # Check syntax in indicated directory
+    #
+    # @see Checker#process
+
+    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?
+          FileStatus.build(file, errors)
+        end
+      end
+      FileStatus
+    end
+
+  end
+  
+end

data/lib/syntaxer/file_status.rb

@@ -0,0 +1,34 @@
+module Syntaxer
+
+  # Contain filename, status of the syntax and list of errors
+
+  class FileStatus
+    @@error_files = []
+    @@fine_files = []
+    
+    attr_reader :file_name, :status, :errors
+    
+    def initialize(file_name, errors = [])
+      @errors = errors
+      @file_name = file_name      
+      @status = @errors.empty? ? :ok : :failed 
+    end
+    
+    class << self
+      def build(file_name, errors = [])
+        file_status = new(file_name, errors)
+        errors.empty? ? @@fine_files << file_status : @@error_files << file_status
+      end   
+      
+      def error_files
+         @@error_files
+      end
+
+      def fine_files
+        @@fine_files
+      end
+         
+    end
+ 
+  end
+end

data/lib/syntaxer/language_definition.rb

@@ -0,0 +1,43 @@
+module Syntaxer
+  class LanguageDefinitionException < Exception; end
+    
+  LanguageDefinition = Struct.new(:name, :extensions, :specific_files, :folders, :ignore_folders, :exec_rule) do
+    def initialize(*args)
+      super(*args)      
+      raise LanguageDefinitionException.new "name can't be blank" unless self.name     
+    end
+    
+    
+    def files_list(root_path)
+      main_rule = folders.map{|f| root_path + f + ".\{#{extensions.join(',')}\}"}
+      list = Rake::FileList.new(main_rule) do |fl|              
+        #fl.add(specific_files) if specific_files  TODO:fix this
+        fl.exclude(ignore_folders) if ignore_folders
+      end
+      list
+    end
+  end
+  
+  
+  class LanguageRules < Array
+
+    def << (smth)
+      raise LanguageDefinitionException.new "can't be other then LanguageDefinition class object" unless smth.is_a?(LanguageDefinition)
+      super        
+    end
+    
+    def find_or_create(name)
+      found = find(name) 
+      unless found
+        found = LanguageDefinition.new(name)
+        self << found
+      end
+      found
+    end
+    
+    def find(name)
+      self.detect{|ld| ld.name == name}
+    end
+  end
+  
+end