syntaxer 0.4.0 → 0.5.0

data/lib/syntaxer/writer.rb

@@ -0,0 +1,88 @@
+module Syntaxer
+  class Writer
+    # Recreate config DSL string operation general rules and set of
+    # languages
+    
+    EXCLUDE_PROPERTIES = "executor", "exec_existence", "deferred", "name"
+
+    # Initializing Writer
+    #
+    # @param [Array] array of languages to recreate
+    # @param [LanguageRules]
+    def initialize langs, rules
+      raise ArgumentError unless rules.kind_of?(LanguageRules)
+      @config = ''
+      @allowed_methods = ["syntaxer", "lang", "languages"]
+
+      @config = syntaxer do
+        lang_st = ''
+        langs.each do |l|
+          language = l.first
+          @paths = l.last
+          rule = rules.find(language)
+          next if rule.nil?
+          
+          @allowed_methods += rule.members if (rule.members - @allowed_methods).length > 0
+          lang_st += languages(rule.send(:name)) do
+            prop_st = ''
+            rule.members.each do |m|
+              properties = rule.send(m)
+              prop_st += property(m, properties) if m != "name"
+            end
+            prop_st
+          end
+        end
+        lang_st
+      end
+
+    end
+
+    # return config
+    #
+    # @return [String] DSL config string
+    def get_config
+      @config
+    end
+
+    protected
+    def method_missing name, *args, &b
+      name = name.to_sym
+      super unless @allowed_methods.include?(name.to_s)
+      if name == :lang || name == :syntaxer || name == :languages
+        block(name, args.first, &b)
+      else
+        property(name, args)
+      end
+    end
+
+    # Create DSL block
+    #
+    # @param [Symbol, String] block name
+    # @param [String] parameter that is passed in to block
+    # @return [String] DSL block string
+    def block name, param = nil, &b
+      sp = ' '*2 if name == :lang || name == :languages
+      body = yield self if block_given?
+      param = ":#{param.to_s}" unless param.nil?
+      "#{sp}#{name.to_s} #{param} do\n#{body}\n#{sp}end\n"
+    end
+
+    # Create DSL property of block
+    #
+    # @param [String] name of the property
+    # @param [Syntaxer::Runner, Array] properties
+    # @return [String] DSL property string
+    def property name, prop
+      return '' if EXCLUDE_PROPERTIES.include?(name.to_s) || prop.nil? || (prop.kind_of?(Array) && prop.empty?)
+      
+      prop = prop.flatten.map{|p| "'#{p}'"}.join(', ') if prop.respond_to?(:flatten) && name.to_sym != :folders
+      prop = @paths.map{|f| "'#{f}'"}.join(',') if name.to_sym == :folders
+      
+      prop = "'#{prop.exec_rule}'" if prop.instance_of?(Syntaxer::Runner) && !prop.exec_rule.nil?
+      prop = "Syntaxer::Runner.#{prop.language}" if prop.instance_of?(Syntaxer::Runner) && prop.exec_rule.nil?
+      
+      ' '*4 + "#{name.to_s} #{prop}\n"
+    end
+
+  end
+end

data/lib/tasks/syntaxer.rake

@@ -1,9 +1,6 @@
 namespace :syntaxer do
-  desc 'my plugins rake task'
+  desc 'Install syntaxer to rails project'
   task :install => :environment do
-    system('syntaxer -i -r git --hook --rails')
-    FileUtils.cp(File.join(File.dirname(__FILE__),'..','..','syntaxer_rails_rules.dist.rb'),\
-                 File.join(Rails.root,'config','syntaxer.rb'))
-    puts "Syntaxer hook installed. Look to the config/syntaxer.rb to change configuration.".color(:green)
+    Syntaxer::Wizzard.start
   end
 end

data/spec/checker_spec.rb

@@ -6,7 +6,7 @@ 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 -c %filename%", "ruby", true)])
+      reader.stub!(:rules).and_return([Syntaxer::LanguageDefinition.new(:ruby, ["rb.example", "rake"], ["Rakefile", "Thorfile"], ["**/*"], nil, Syntaxer::Runner.default("ruby -c %filename%"), "ruby", true)])
       reader.stub!(:files_count).and_return(3)
       Syntaxer.should_receive(:reader).any_number_of_times.and_return(reader)
       Syntaxer.stub!(:root_path).and_return(fixtures_path(:ruby))
@@ -53,8 +53,8 @@ describe "Syntaxer::Checker" do
       make_git_add(@repo_dir)
 
       reader = mock('Reader')
-      reader.stub!(:rules).and_return([Syntaxer::LanguageDefinition.new(:ruby, ["example", "rake"], ["Rakefile", "Thorfile"], ["**/*"], nil, "ruby -c %filename%", "ruby", true)])
-      Syntaxer.should_receive(:reader).and_return(reader)
+      reader.stub!(:rules).and_return([Syntaxer::LanguageDefinition.new(:ruby, ["example", "rake"], ["Rakefile", "Thorfile"], ["**/*"], nil, Syntaxer::Runner.default("ruby -c %filename%"), "ruby", true)])
+      Syntaxer.should_receive(:reader).at_least(1).times.and_return(reader)
       Syntaxer.stub!(:root_path).and_return(@repo_dir)
       repo = Syntaxer::Repository.factory(@repo_dir, :git)
       Syntaxer.stub!(:repository).and_return(repo)

data/spec/fixtures/syntaxer_rules_jslint.rb

@@ -0,0 +1,9 @@
+syntaxer do
+
+  languages :javascript do
+    extensions "example"
+    folders '**/*'
+    exec_rule Syntaxer::Runner.javascript
+  end
+  
+end

data/spec/reader_spec.rb

@@ -4,10 +4,12 @@ describe "Syntaxer::Reader::DSLReader" do
   
   context "#build" do
     it "should build from default distr rules files" do
+      Syntaxer::Runner.stub(:default)
+
       @reader = Syntaxer::Reader::DSLReader.build
-      @reader.rules.find(:ruby).should == Syntaxer::LanguageDefinition.new(:ruby, ["rb", "rake"], ["Rakefile", "Thorfile", "Gemfile"], ["**/*"], nil, "ruby -c %filename%", "ruby", true)
-      @reader.rules.find(:haml).should == Syntaxer::LanguageDefinition.new(:haml, ["haml"], nil, ["**/*"], nil, "haml -c %filename%", "haml", system("which haml 2>&1 > /dev/null"))
-      @reader.rules.find(:sass).should == Syntaxer::LanguageDefinition.new(:sass, ["sass"], nil, ["**/*"], nil, "sass -c %filename%", "sass", system("which haml 2>&1 > /dev/null"))
+      @reader.rules.find(:ruby).should eql(Syntaxer::LanguageDefinition.new(:ruby, ["rb", "rake"], ["Rakefile", "Thorfile", "Gemfile"], ["**/*"], nil, Syntaxer::Runner.default("ruby -c %filename%"), "ruby", true, false))
+      @reader.rules.find(:haml).should eql(Syntaxer::LanguageDefinition.new(:haml, ["haml"], nil, ["**/*"], nil, Syntaxer::Runner.default("haml -c %filename%"), "haml", system("which haml 2>&1 > /dev/null"), false))
+      @reader.rules.find(:sass).should eql(Syntaxer::LanguageDefinition.new(:sass, ["sass"], nil, ["**/*"], nil, Syntaxer::Runner.default("sass -c %filename%"), "sass", system("which haml 2>&1 > /dev/null"), false))
       
     end
   end
@@ -114,5 +116,13 @@ describe "Syntaxer::Reader::DSLReader" do
       @reader.overall_ignore_folders().should == []
     end   
   end
+
+  context "#exec_rule" do
+    subject{Syntaxer::Reader::DSLReader.new}
+    it "should return Syntaxer::Runner instance" do
+      reader = Syntaxer::Reader::DSLReader.load(syntaxer_rules_example_file('syntaxer_rules_jslint'))
+      reader.rules.first.exec_rule.should be_instance_of(Syntaxer::Runner)
+    end
+  end
     
 end

data/spec/runner_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Syntaxer::Runner" do
+  subject{Syntaxer::Runner}
+  
+  context "default runner" do
+    
+    it "should return Syntaxer::Runner" do
+      subject.default("ruby -c %filename%").should be_instance_of(Syntaxer::Runner)
+    end
+
+    it "should have run method" do
+      subject.default("ruby -c %filename%").should respond_to(:run)
+    end
+
+    it "should invoke Open3#popen3" do
+      Open3.should_receive(:popen3)
+      subject.default("ruby -c %filename%").run('')
+    end
+
+  end
+
+  context "javascript runner" do
+    subject{Syntaxer::Runner.javascript}
+
+    it "should return Proc" do
+      subject.should be_instance_of(Proc)
+    end
+
+    it "Proc should return Syntaxer::Runner class instance" do
+      subject.call.should be_instance_of(Syntaxer::Runner)
+    end
+
+    it "should invoke run of JSLint::Lint instance" do
+      ins = double()
+      ins.should_receive(:run)
+      JSLint::Lint.should_receive(:new).and_return(ins)
+      subject.call.run('', [])
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -24,7 +24,13 @@ end
 def create_temp_git_repo
   @dir = Dir.tmpdir + "/#{Time.now.to_i}" + "/git_repo"
   FileUtils.mkdir_p(@dir)
-  return @dir
+  @dir
+end
+
+def create_temp_dir
+  @dir = Dir.tmpdir + "/#{Time.now.to_i}" + "/syntaxer"
+  FileUtils.mkdir_p(@dir)
+  @dir
 end
   
 def create_temp_ruby_project

data/spec/wizzard_spec.rb

@@ -0,0 +1,95 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Syntaxer::Wizzard" do
+  subject{Syntaxer::Wizzard}
+
+  context "installation of config to non rails project without git and no jslint" do
+
+    before(:each) do
+      @working_dir = create_temp_dir
+      @options = {
+        :rails => false,
+        :git => false,
+        :config_path => @working_dir,
+        :config_path_exists => true,
+        :languages => [[:ruby, ['*/*', 'lib/*']]]
+      }
+    end
+    
+    it "should create config" do
+      subject.new(@options).run
+      FileTest.file?(File.join(@working_dir, Syntaxer::SYNTAXER_CONFIG_FILE_NAME)).should be_true
+      rules = Syntaxer::Reader::DSLReader.load(File.join(@working_dir, Syntaxer::SYNTAXER_CONFIG_FILE_NAME)).rules
+      ruby_rule = rules.find(:ruby)
+      ruby_rule.folders.should eql(@options[:languages].first.last)
+    end
+
+    after(:each) do
+      FileUtils.rm_r(@working_dir)
+    end
+    
+  end
+
+  context "installation of config to rails project without git" do
+    before(:each) do
+      @working_dir = create_temp_dir
+      @options = {
+        :rails => true,
+        :git => false,
+        :config_path => @working_dir+"/config",
+        :config_path_exists => true,
+        :languages => [[:ruby, Syntaxer::Wizzard::FOLDERS_RAILS[:ruby]]]
+      }
+      FileUtils.mkdir_p(File.join(@working_dir,'config'))
+      File.new(File.join(@working_dir,'config','application.rb'),'w').close
+      File.new(File.join(@working_dir,'config','routes.rb'),'w').close
+    end
+
+    it "should install config for rails without errors" do
+      subject.new(@options).run
+      rules = Syntaxer::Reader::DSLReader.load(File.join(@working_dir, 'config', Syntaxer::SYNTAXER_CONFIG_FILE_NAME)).rules
+      ruby_rules = rules.find(:ruby)
+      ruby_rules.folders.should eql(@options[:languages].first.last)
+    end
+    
+    after(:each) do
+      FileUtils.rm_r(@working_dir)
+    end
+
+  end
+
+  context "installation of config to rails with git" do
+    before(:each) do
+      repo_dir = create_temp_ruby_project
+      @working_dir = repo_dir
+      File.new(File.join(@working_dir,'README'),'w').close
+      make_git_add(repo_dir)
+      make_initial_commit(repo_dir)
+      @options = {
+        :rails => true,
+        :root_path => repo_dir,
+        :git => true,
+        :config_path => @working_dir+"/config",
+        :config_path_exists => true,
+        :languages => [[:ruby, Syntaxer::Wizzard::FOLDERS_RAILS[:ruby]]]
+      }
+      FileUtils.mkdir_p(File.join(@working_dir,'config'))
+      File.new(File.join(@working_dir,'config','application.rb'),'w').close
+      File.new(File.join(@working_dir,'config','routes.rb'),'w').close
+    end
+
+    it "should install hook to git and create syntaxer config" do
+      subject.new(@options).run
+      rules = Syntaxer::Reader::DSLReader.load(File.join(@working_dir, 'config', Syntaxer::SYNTAXER_CONFIG_FILE_NAME)).rules
+      ruby_rules = rules.find(:ruby)
+      ruby_rules.folders.should eql(@options[:languages].first.last)
+      FileTest.file?(File.join(@working_dir,'.git','hooks','pre-commit')).should be_true
+    end
+
+    after(:each) do
+      FileUtils.rm_r(@working_dir)
+    end
+
+  end
+
+end

data/syntaxer.gemspec

@@ -5,24 +5,25 @@
 
 Gem::Specification.new do |s|
   s.name = %q{syntaxer}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["artemk"]
-  s.date = %q{2011-04-23}
+  s.date = %q{2011-05-10}
   s.default_executable = %q{syntaxer}
   s.description = %q{Syntax checker for ruby and other languages}
   s.email = %q{kramarenko.artyom@gmail.com}
   s.executables = ["syntaxer"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.markdown"
   ]
   s.files = [
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "VERSION",
     "bin/syntaxer",
@@ -47,6 +48,9 @@ Gem::Specification.new do |s|
     "lib/syntaxer/railtie.rb",
     "lib/syntaxer/reader.rb",
     "lib/syntaxer/repository.rb",
+    "lib/syntaxer/runner.rb",
+    "lib/syntaxer/wizzard.rb",
+    "lib/syntaxer/writer.rb",
     "lib/tasks/syntaxer.rake",
     "rails/init.rb",
     "spec/checker_spec.rb",
@@ -57,14 +61,18 @@ Gem::Specification.new do |s|
     "spec/fixtures/ruby/wrong.rb.example",
     "spec/fixtures/syntaxer_rules.rb",
     "spec/fixtures/syntaxer_rules_git.rb",
+    "spec/fixtures/syntaxer_rules_jslint.rb",
     "spec/language_rules_spec.rb",
     "spec/printer_spec.rb",
     "spec/reader_spec.rb",
     "spec/repository_spec.rb",
+    "spec/runner_spec.rb",
     "spec/spec_helper.rb",
     "spec/syntaxer_spec.rb",
+    "spec/wizzard_spec.rb",
     "syntaxer.gemspec",
     "syntaxer_rails_rules.dist.rb",
+    "syntaxer_rails_rules_jslint.dist.rb",
     "syntaxer_rules.dist.rb"
   ]
   s.homepage = %q{http://github.com/artemk/syntaxer}
@@ -76,12 +84,15 @@ Gem::Specification.new do |s|
     "spec/checker_spec.rb",
     "spec/fixtures/syntaxer_rules.rb",
     "spec/fixtures/syntaxer_rules_git.rb",
+    "spec/fixtures/syntaxer_rules_jslint.rb",
     "spec/language_rules_spec.rb",
     "spec/printer_spec.rb",
     "spec/reader_spec.rb",
     "spec/repository_spec.rb",
+    "spec/runner_spec.rb",
     "spec/spec_helper.rb",
-    "spec/syntaxer_spec.rb"
+    "spec/syntaxer_spec.rb",
+    "spec/wizzard_spec.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -91,6 +102,8 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<git>, [">= 0"])
       s.add_runtime_dependency(%q<rainbow>, [">= 0"])
       s.add_runtime_dependency(%q<progress_bar>, [">= 0"])
+      s.add_runtime_dependency(%q<jslint_on_rails>, [">= 1.0.6"])
+      s.add_runtime_dependency(%q<highline>, [">= 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"])
@@ -100,6 +113,8 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<git>, [">= 0"])
       s.add_dependency(%q<rainbow>, [">= 0"])
       s.add_dependency(%q<progress_bar>, [">= 0"])
+      s.add_dependency(%q<jslint_on_rails>, [">= 1.0.6"])
+      s.add_dependency(%q<highline>, [">= 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"])
@@ -110,6 +125,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<git>, [">= 0"])
     s.add_dependency(%q<rainbow>, [">= 0"])
     s.add_dependency(%q<progress_bar>, [">= 0"])
+    s.add_dependency(%q<jslint_on_rails>, [">= 1.0.6"])
+    s.add_dependency(%q<highline>, [">= 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"])

data/syntaxer_rails_rules_jslint.dist.rb

@@ -0,0 +1,26 @@
+syntaxer do    
+  languages :ruby do
+    folders "app/*", "app/**/*", "lib/*", "lib/**/*"
+    extensions "rb", "rake"
+    specific_files "Rakefile", "Thorfile", "Gemfile"
+    exec_rule "ruby -c %filename%"
+  end
+  
+  lang :sass do
+    folders "public/stylesheets/**/*"
+    extensions "sass"
+    exec_rule "sass -c %filename%"    
+  end
+  
+  lang :haml do
+    folders "app/views/**/*", "app/views/*"
+    extensions "haml"
+    exec_rule "haml -c %filename%"
+  end
+
+  lang :javascript do
+    folders "public/javascripts/*", "public/javascripts/**/*"
+    extensions "js"
+    exec_rule Syntaxer::Runner.javascript
+  end
+end

data/syntaxer_rules.dist.rb

@@ -17,4 +17,11 @@ syntaxer do
     extensions "haml"
     exec_rule "haml -c %filename%"
   end
+
+  lang :javascript do
+    folders "**/*"
+    extensions "js"
+    exec_rule Syntaxer::Runner.javascript
+  end
+  
 end