stars-checkers 0.1.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 27stars Limited.
+
+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,17 @@
+  .oooooo.   oooo                            oooo                                    
+ d8P'  `Y8b  `888                            `888                                    
+888           888 .oo.    .ooooo.   .ooooo.   888  oooo   .ooooo.  oooo d8b  .oooo.o 
+888           888P"Y88b  d88' `88b d88' `"Y8  888 .8P'   d88' `88b `888""8P d88(  "8 
+888           888   888  888ooo888 888        888888.    888ooo888  888     `"Y88b.  
+`88b    ooo   888   888  888    .o 888   .o8  888 `88b.  888    .o  888     o.  )88b 
+ `Y8bood8P'  o888o o888o `Y8bod8P' `Y8bod8P' o888o o888o `Y8bod8P' d888b    8""888P'
+
+== Suggested Improvements
+
+* Specify filename(s) directly as command-line argument
+* bin support (parse shebang line to determine type)
+* SVN support (parse svn status)
+
+== Copyright
+
+Copyright (c) 2009 27stars Limited. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 2
+:major: 0
+:minor: 1

data/bin/check

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+require 'pp'
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'checkers'
+include Checkers
+
+ARGV.options do |o|
+  o.banner =    "Usage: #{File.basename(__FILE__)}"
+  o.define_head "Easy syntax checking of source files."
+  # o.on("-f", "--first=[val]", String,
+  #      "A long and short (optional) string argument",
+  #      "Default: #{OPTIONS[:first]}")   { |OPTIONS[:first]| }
+  # o.on("-a", "--another=val", Integer,
+  #      "Requires an int argument")      { |OPTIONS[:another]| }
+  # o.on("-b", "--boolean",
+  #      "A boolean argument")            { |OPTIONS[:bool]| }
+  # o.on("--list=[x,y,z]", Array, 
+  #      "Example 'list' of arguments")   { |OPTIONS[:list]| }
+  # o.separator ""
+  o.on_tail("-h", "--help", "Show this help message.") { puts o; exit(1) }
+  o.parse!
+end
+
+# Process files
+if File.exist?('.git')
+  @filenames = Parser::Git.parse(`git status`)
+else
+  puts 'No file(s) specified.'
+  exit(1)
+end
+
+@filenames.each do |filename|
+  result = Processor.check(filename)
+  unless result == :na
+    puts result.to_s.upcase.ljust(7) + (' '*2) + filename
+  end
+end

data/lib/checkers.rb

@@ -0,0 +1,5 @@
+require 'checkers/processor'
+require 'checkers/parser/git'
+
+module Checkers
+end

data/lib/checkers/parser/git.rb

@@ -0,0 +1,21 @@
+module Checkers
+  
+  module Parser
+
+    class Git
+      
+      def self.parse(text)
+        filenames = []
+        text.each_line do |line|
+          if md = line.match(/^#(\s*)(new file|modified):(\s*)(.*)$/)
+            filenames << md[4]
+          end
+        end
+        filenames
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/checkers/processor.rb

@@ -0,0 +1,64 @@
+module Checkers
+
+  # Thanks to: http://eigenclass.org/hiki.rb?ruby+plugins
+  class Processor
+    @registered_processors = {}
+    class << self
+      attr_reader :registered_processors
+      private :new
+    end
+    
+    def self.check(filename)
+      ext = File.extname(filename).delete('.')
+      if processor = self.for(ext)
+        if processor.check(filename)
+          :valid
+        else
+          :invalid
+        end
+      else
+        :na
+      end
+    end
+    
+    def self.for(extension)
+      # TODO: just initialise this once elsewhere
+      # Map file extensions to the processors that process them
+      filetypes = {}
+      self.registered_processors.each do |definition|
+        name, processor = *definition
+        processor.handles.to_a.each do |ext|
+          filetypes[ext] = name
+        end
+      end
+      # Return processor for this extension
+      self.registered_processors[filetypes[extension]]
+    end
+
+    def self.define(name, &block)
+      p = new
+      p.instance_eval(&block)
+      self.registered_processors[name] = p
+    end
+
+    def self.def_field(*names)
+      class_eval do 
+        names.each do |name|
+          define_method(name) do |*args| 
+            case args.size
+            when 0: instance_variable_get("@#{name}")
+            else    instance_variable_set("@#{name}", *args)
+            end
+          end
+        end
+      end
+    end
+  
+    def_field :handles
+  end
+
+end
+
+# Load plugins
+PROCESSOR_DIR = File.dirname(File.expand_path(__FILE__))
+Dir.glob(File.join(PROCESSOR_DIR, 'processors', '*.rb')).map { |file| load file }

data/lib/checkers/processors/erb.rb

@@ -0,0 +1,17 @@
+require 'open3'
+require 'erb'
+
+Checkers::Processor.define "erb" do
+  handles ['erb','rhtml']
+
+  def check(filename)
+    Open3.popen3('ruby -c') do |stdin, stdout, stderr|
+      stdin.puts(ERB.new(File.read(filename), nil, '-').src)
+      stdin.close
+      ret = (error = (stderr.readline rescue false)) ? false : true
+      stdout.close rescue false
+      stderr.close rescue false
+      ret
+    end
+  end
+end

data/lib/checkers/processors/haml.rb

@@ -0,0 +1,16 @@
+require 'open3'
+
+Checkers::Processor.define "haml" do
+  handles 'haml'
+
+  def check(filename)
+    Open3.popen3('haml --stdin --check') do |stdin, stdout, stderr|
+      stdin.puts(File.read(filename))
+      stdin.close
+      ret = (error = (stderr.readline rescue false)) ? false : true
+      stdout.close rescue false
+      stderr.close rescue false
+      ret
+    end
+  end
+end

data/lib/checkers/processors/ruby.rb

@@ -0,0 +1,18 @@
+require 'open3'
+require 'erb'
+
+Checkers::Processor.define "ruby" do
+  # TODO: handle 'Rakefile'
+  handles ['rb','rjs']
+
+  def check(filename)
+    Open3.popen3('ruby -c') do |stdin, stdout, stderr|
+      stdin.puts(File.read(filename))
+      stdin.close
+      ret = (error = (stderr.readline rescue false)) ? false : true
+      stdout.close rescue false
+      stderr.close rescue false
+      ret
+    end
+  end
+end

data/lib/checkers/processors/sass.rb

@@ -0,0 +1,16 @@
+require 'open3'
+
+Checkers::Processor.define "sass" do
+  handles 'sass'
+
+  def check(filename)
+    Open3.popen3('sass --stdin --check') do |stdin, stdout, stderr|
+      stdin.puts(File.read(filename))
+      stdin.close
+      ret = (error = (stderr.readline rescue false)) ? false : true
+      stdout.close rescue false
+      stderr.close rescue false
+      ret
+    end
+  end
+end

data/test/checkers_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+class CheckersTest < Test::Unit::TestCase
+  
+  context "Valid files" do
+    setup do
+      @filenames = Dir.glob(File.join('test', 'files', 'valid*'))
+    end
+    
+    should "be detected as valid" do
+      assert(@filenames.all? do |filename|
+        Checkers::Processor.check(filename) == :valid
+      end)
+    end
+  end
+  
+  context "Invalid files" do
+    setup do
+      @filenames = Dir.glob(File.join('test', 'files', 'invalid*'))
+    end
+    
+    should "be detected as invalid" do
+      assert(@filenames.all? do |filename|
+        Checkers::Processor.check(filename) == :invalid
+      end)
+    end
+  end
+
+  context "Git status output (with new and modified files)" do
+    setup do
+      @status =<<EOS
+# On branch master
+# Changes to be committed:
+#   (use "git reset HEAD <file>..." to unstage)
+#
+#	new file:   lib/checkers.rb
+#
+# Changed but not updated:
+#   (use "git add <file>..." to update what will be committed)
+#
+#	modified:   test/checkers_test.rb
+#
+# Untracked files:
+#   (use "git add <file>..." to include in what will be committed)
+#
+#	lib/checkers/
+EOS
+    end
+
+    should "be correctly parsed in to filenames" do
+      filenames = Checkers::Parser::Git.parse(@status)
+      assert_equal ['lib/checkers.rb', 'test/checkers_test.rb'], filenames
+    end
+  end
+  
+end

data/test/files/file.xyz

@@ -0,0 +1 @@
+abcdefghijklmnopqrstuvwxyz

data/test/files/invalid.erb

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>Invalid</title>
+  </head>
+  <body>
+    <%== 1+2 %>
+  </body>
+</html>

data/test/files/invalid.haml

@@ -0,0 +1,6 @@
+%html
+  %head
+    %title Valid
+  %body
+    Nesting within
+      plain text is illegal.

data/test/files/invalid.rb

@@ -0,0 +1 @@
+class Invalid

data/test/files/invalid.rhtml

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>Invalid</title>
+  </head>
+  <body>
+    <%== 1+2 %>
+  </body>
+</html>

data/test/files/invalid.sass

@@ -0,0 +1,2 @@
+syntax
+    invalid

data/test/files/valid.erb

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>Valid</title>
+  </head>
+  <body>
+    <%= 1+2 %>
+  </body>
+</html>

data/test/files/valid.haml

@@ -0,0 +1,5 @@
+%html
+  %head
+    %title Valid
+  %body
+    Hello World.

data/test/files/valid.rb

@@ -0,0 +1,2 @@
+class Valid
+end

data/test/files/valid.rhtml

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>Valid</title>
+  </head>
+  <body>
+    <%= 1+2 %>
+  </body>
+</html>

data/test/files/valid.sass

@@ -0,0 +1,2 @@
+body
+  :background-color blue

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'checkers'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: stars-checkers
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Karl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-08 00:00:00 -08:00
+default_executable: check
+dependencies: []
+
+description: 
+email: hello@27stars.co.uk
+executables: 
+- check
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- bin/check
+- lib/checkers
+- lib/checkers/parser
+- lib/checkers/parser/git.rb
+- lib/checkers/processor.rb
+- lib/checkers/processors
+- lib/checkers/processors/erb.rb
+- lib/checkers/processors/haml.rb
+- lib/checkers/processors/ruby.rb
+- lib/checkers/processors/sass.rb
+- lib/checkers.rb
+- test/checkers_test.rb
+- test/files
+- test/files/file.xyz
+- test/files/invalid.erb
+- test/files/invalid.haml
+- test/files/invalid.rb
+- test/files/invalid.rhtml
+- test/files/invalid.sass
+- test/files/valid.erb
+- test/files/valid.haml
+- test/files/valid.rb
+- test/files/valid.rhtml
+- test/files/valid.sass
+- test/test_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/stars/checkers
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easy syntax checking of source files.
+test_files: []
+