readminator 0.0.1

data/lib/readminator.rb

@@ -0,0 +1,16 @@
+module Readminator
+  def validate(readme)
+    errors = []
+    blocks = Parsinator.blocks(readme)
+    blocks.each do |(line, language, code)|
+      validator = Validator.for(language)
+      errors << validator.check(code, line)
+    end
+    errors.compact
+  end
+  module_function :validate
+
+  autoload :Parsinator, "readminator/parsinator"
+  autoload :Validator,  "readminator/validator"
+  autoload :VERSION,    "readminator/version"
+end

data/lib/readminator/parsinator.rb

@@ -0,0 +1,12 @@
+module Readminator
+  class Parsinator
+    def self.blocks(readme)
+      blocks = readme.scan(/^``` ?([^\r\n]+)?\r?\n(.+?)\r?\n```\r?$/m)
+      lines  = readme.split("\n")
+      blocks.map do |(language, code)|
+        line = code.split("\n", 2).first
+        [lines.index(line), language, code]
+      end
+    end
+  end
+end

data/lib/readminator/validator.rb

@@ -0,0 +1,15 @@
+require "readminator/validator/default"
+
+module Readminator
+  class Validator
+    def self.for(language)
+      if File.exists?(File.expand_path "../validator/#{language}.rb", __FILE__)
+        require "readminator/validator/#{language}"
+        Validator.const_get(language.capitalize).new
+      else
+        Validator::Default.new
+      end
+    end
+
+  end
+end

data/lib/readminator/validator/coffeescript.rb

@@ -0,0 +1,15 @@
+require "open3"
+
+module Readminator
+  class Validator::Coffeescript
+    def check(code, line)
+      Open3.popen3("coffee -c -s") do |stdin, stdout, stderr, wait|
+        stdin << code
+        stdin.close
+        exit_status = wait.value
+        return { line: line, error: stderr.read.split(/\r|\n/, 2).first, language: "coffeescript" } if exit_status != 0
+      end
+      nil
+    end
+  end
+end

data/lib/readminator/validator/default.rb

@@ -0,0 +1,9 @@
+module Readminator
+  class Validator
+    class Default
+      def check(code, line)
+        nil
+      end
+    end
+  end
+end

data/lib/readminator/validator/ruby.rb

@@ -0,0 +1,15 @@
+require "open3"
+
+module Readminator
+  class Validator::Ruby
+    def check(code, line)
+      Open3.popen3("ruby -c") do |stdin, stdout, stderr, wait|
+        stdin << code
+        stdin.close
+        exit_status = wait.value
+        return { line: line, error: stderr.read.chomp, language: "ruby" } if exit_status != 0
+      end
+      nil
+    end
+  end
+end

data/lib/readminator/version.rb

@@ -0,0 +1,3 @@
+module Readminator
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: readminator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bruno Michel
+- Julien Boyer
+- François de Metz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-05 00:00:00.000000000 Z
+dependencies: []
+description: Improve your README
+email:
+- bruno.michel@af83.com
+- julien.boyer@af83.com
+- fdemetz@af83.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/readminator.rb
+- lib/readminator/parsinator.rb
+- lib/readminator/validator.rb
+- lib/readminator/validator/coffeescript.rb
+- lib/readminator/validator/default.rb
+- lib/readminator/validator/ruby.rb
+- lib/readminator/version.rb
+homepage: https://github.com/af83/readminator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Improve your README
+test_files: []