hamlit 1.5.4 → 1.5.5

data/spec/spec_helper.rb

@@ -17,18 +17,20 @@ module HamlitSpecHelper
   def assert_render(haml, html, options = {})
     errs  = array_wrap(options.delete(:error_with) || [])
     impls = array_wrap(options.delete(:compatible_only) || [:haml, :faml] - errs)
-    haml  = haml.unindent
-    html  = html.unindent
+    fails = [:haml, :faml] - impls - errs
 
-    expect(render_string(haml, options)).to eq(html)
-    impls.each do |impl|
-      expect_compatibility(impl, haml, options)
-    end
-    errs.each do |impl|
-      expect_compatibility(impl, haml, options, type: :error)
-    end
-    ([:haml, :faml] - impls - errs).each do |impl|
-      expect_compatibility(impl, haml, options, type: :failure)
+    test = TestCase.new
+    test.src_haml = haml.unindent
+    test.hamlit_html = html.unindent
+
+    expect(render_string(test.src_haml, options)).to eq(test.hamlit_html)
+    impls.each { |i| expect_compatibility(i, test, options) }
+    errs.each  { |i| expect_compatibility(i, test, options, type: :error) }
+    fails.each { |i| expect_compatibility(i, test, options, type: :failure) }
+
+    if TestCase.generate_docs? && (errs.any? || fails.any?)
+      write_caller!(test)
+      TestCase.register_test!(test)
     end
   end
 
@@ -46,48 +48,57 @@ module HamlitSpecHelper
 
   private
 
-  def expect_compatibility(impl, haml, options, type: :success)
+  def write_caller!(test)
+    line = caller.find{ |l| l =~ %r{spec/hamlit} }
+    path, lineno = line.match(/^([^:]+):([0-9]+)/).to_a.last(2)
+    test.lineno = lineno.to_i - 1
+    test.dir, test.file = path.gsub(%r{^.+spec/hamlit/}, '').split('/')
+  end
+
+  def expect_compatibility(impl, test, options, type: :success)
     case impl
     when :haml
-      expect_haml(haml, options, type: type)
+      expect_haml(impl, test, options, type)
     when :faml
-      expect_faml(haml, options, type: type)
+      expect_faml(impl, test, options, type)
     end
   end
 
-  def expect_faml(haml, options, type: :success)
-    hamlit_html = render_string(haml, options)
-    options = options.dup
-    options.delete(:escape_html)
+  def expect_haml(impl, test, options, type)
+    expect_implementation(impl, test, options, type) do |test, options|
+      options = DEFAULT_OPTIONS.merge(options)
+      Haml::Engine.new(test.src_haml, options).render(Object.new, {})
+    end
+  end
 
-    case type
-    when :success
-      faml_html = eval Faml::Engine.new(options).call(haml)
-      expect(hamlit_html).to eq(faml_html)
-    when :failure
-      faml_html = eval Faml::Engine.new(options).call(haml)
-      expect(hamlit_html).to_not eq(faml_html)
-    when :error
-      expect {
-        eval Faml::Engine.new(options).call(haml)
-      }.to raise_error
+  def expect_faml(impl, test, options, type)
+    expect_implementation(impl, test, options, type) do |test, options|
+      options = options.dup
+      options.delete(:escape_html)
+      eval Faml::Engine.new(options).call(test.src_haml)
     end
   end
 
-  def expect_haml(haml, options, type: :success)
-    hamlit_html = render_string(haml, options)
-    options = DEFAULT_OPTIONS.merge(options)
+  def expect_implementation(impl, test, options, type, &block)
+    if type == :error
+      expect { block.call(test, options) }.to raise_error
+      begin
+        block.call(test, options)
+      rescue Exception => e
+        err = "#{e.class}: #{e.message}"
+        test.send(:"#{impl}_html=", err)
+      end
+      return
+    end
+
+    result = block.call(test, options)
+    test.send(:"#{impl}_html=", result)
+
     case type
     when :success
-      haml_html = Haml::Engine.new(haml, options).render(Object.new, {})
-      expect(hamlit_html).to eq(haml_html)
+      expect(test.hamlit_html).to eq(result)
     when :failure
-      haml_html = Haml::Engine.new(haml, options).render(Object.new, {})
-      expect(hamlit_html).to_not eq(haml_html)
-    when :error
-      expect {
-        Haml::Engine.new(haml, options).render(Object.new, {})
-      }.to raise_error
+      expect(test.hamlit_html).to_not eq(result)
     end
   end
 
@@ -95,6 +106,128 @@ module HamlitSpecHelper
     return arr if arr.is_a?(Array)
     [arr]
   end
+
+  def tests
+    @tests ||= []
+  end
+end
+
+# This is used to generate a document automatically.
+class TestCase < Struct.new(:file, :dir, :lineno, :src_haml, :haml_html, :faml_html, :hamlit_html)
+  class << self
+    def incompatibilities
+      @incompatibilities ||= []
+    end
+
+    def generate_docs!
+      prepare_dirs!
+      generate_toc!
+
+      incompatibilities.group_by(&:doc_path).each do |path, tests|
+        doc = tests.sort_by(&:lineno).map(&:document).join("\n")
+        full_path = File.join(doc_dir, path)
+        File.write(full_path, doc)
+      end
+    end
+
+    def generate_docs?
+      ENV['AUTODOC']
+    end
+
+    def register_test!(test)
+      incompatibilities << test unless @skipdoc
+    end
+
+    def skipdoc(&block)
+      @skipdoc = true
+      block.call
+    ensure
+      @skipdoc = false
+    end
+
+    private
+
+    def generate_toc!
+      table_of_contents = <<-TOC.unindent
+        # Hamlit incompatibilities
+
+        This is a document generated from RSpec test cases.  
+        Showing incompatibilities against [Haml](https://github.com/haml/haml) and [Faml](https://github.com/eagletmt/faml).
+      TOC
+
+      incompatibilities.group_by(&:dir).each do |dir, tests|
+        # TODO: Split incompatibility documents into haml and faml
+        # There are too many noisy documents now.
+        next if dir == 'filters'
+
+        table_of_contents << "\n## #{dir}\n"
+
+        tests.group_by(&:doc_path).each do |path, tests|
+          test = tests.first
+          file_path = File.join(test.dir, test.file)
+          base_url  = 'https://github.com/k0kubun/hamlit/blob/master/doc/'
+          table_of_contents << "\n- [#{escape_markdown(file_path)}](#{File.join(base_url, path)})"
+        end
+        table_of_contents << "\n"
+      end
+
+      path = File.join(doc_dir, 'README.md')
+      File.write(path, table_of_contents)
+    end
+
+    def prepare_dirs!
+      system("rm -rf #{doc_dir}")
+      incompatibilities.map(&:dir).uniq.each do |dir|
+        system("mkdir -p #{doc_dir}/#{dir}")
+      end
+    end
+
+    def doc_dir
+      @doc_dir ||= File.expand_path('./doc')
+    end
+
+    def escape_markdown(text)
+      text.gsub(/_/, '\\_')
+    end
+  end
+
+  def document
+    base_url = 'https://github.com/k0kubun/hamlit/blob/master/spec/hamlit'
+    url = File.join(base_url, dir, file)
+    doc = <<-DOC
+# [#{escape_markdown("#{file}:#{lineno}")}](#{url}#L#{lineno})
+## Input
+```haml
+#{src_haml}
+```
+
+## Output
+    DOC
+
+    html_by_name = {
+      'Haml' => haml_html,
+      'Faml' => faml_html,
+      'Hamlit' => hamlit_html,
+    }
+    html_by_name.group_by(&:last).each do |html, pairs|
+      doc << "### #{pairs.map(&:first).join(', ')}\n"
+      doc << "```html\n"
+      doc << "#{html}\n"
+      doc << "```\n\n"
+    end
+
+    doc
+  end
+
+  def doc_path
+    File.join(dir, file.gsub(/_spec\.rb$/, '.md'))
+  end
+
+  private
+
+  def escape_markdown(text)
+    self.class.send(:escape_markdown, text)
+  end
 end
 
 RSpec.configure do |config|
@@ -107,4 +240,14 @@ RSpec.configure do |config|
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end
+
+  config.around(:each, skipdoc: true) do |example|
+    TestCase.skipdoc do
+      example.run
+    end
+  end
+
+  config.after(:suite) do
+    TestCase.generate_docs! if TestCase.generate_docs?
+  end
 end

data/test

@@ -12,6 +12,9 @@ VERSIONS=(
 function test_with() {
   version=$1
   rbenv local $version
+  if ! bundle check > /dev/null; then
+    bundle install
+  fi
   ruby -v
   rake spec
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hamlit
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.5.5
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 0.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 0.7.6
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -313,6 +313,18 @@ files:
 - benchmarks/view.rbhtml
 - benchmarks/view.slim
 - bin/hamlit
+- doc/README.md
+- doc/engine/old_attributes.md
+- doc/engine/script.md
+- doc/engine/text.md
+- doc/filters/coffee.md
+- doc/filters/erb.md
+- doc/filters/javascript.md
+- doc/filters/less.md
+- doc/filters/markdown.md
+- doc/filters/plain.md
+- doc/filters/sass.md
+- doc/filters/scss.md
 - hamlit.gemspec
 - lib/hamlit.rb
 - lib/hamlit/attribute.rb
@@ -390,6 +402,7 @@ files:
 - spec/hamlit/filters/javascript_spec.rb
 - spec/hamlit/filters/less_spec.rb
 - spec/hamlit/filters/markdown_spec.rb
+- spec/hamlit/filters/plain_spec.rb
 - spec/hamlit/filters/ruby_spec.rb
 - spec/hamlit/filters/sass_spec.rb
 - spec/hamlit/filters/scss_spec.rb
@@ -504,6 +517,7 @@ test_files:
 - spec/hamlit/filters/javascript_spec.rb
 - spec/hamlit/filters/less_spec.rb
 - spec/hamlit/filters/markdown_spec.rb
+- spec/hamlit/filters/plain_spec.rb
 - spec/hamlit/filters/ruby_spec.rb
 - spec/hamlit/filters/sass_spec.rb
 - spec/hamlit/filters/scss_spec.rb
@@ -573,4 +587,3 @@ test_files:
 - spec/rails/vendor/assets/javascripts/.keep
 - spec/rails/vendor/assets/stylesheets/.keep
 - spec/spec_helper.rb
-has_rdoc: