faml 0.2.13 → 0.2.14

data/lib/faml/indent_tracker.rb

@@ -3,6 +3,29 @@ require 'faml/error'
 module Faml
   class IndentTracker
     class IndentMismatch < Error
+      attr_reader :current_level, :indent_levels
+
+      def initialize(current_level, indent_levels, lineno)
+        super("Unexpected indent level: #{current_level}: indent_level=#{indent_levels}", lineno)
+        @current_level = current_level
+        @indent_levels = indent_levels
+      end
+    end
+
+    class InconsistentIndent < Error
+      attr_reader :previous_size, :current_size
+
+      def initialize(previous_size, current_size, lineno)
+        super("Inconsistent indentation: #{current_size} spaces used for indentation, but the rest of the document was indented using #{previous_size} spaces.", lineno)
+        @previous_size = previous_size
+        @current_size = current_size
+      end
+    end
+
+    class HardTabNotAllowed < Error
+      def initialize(lineno)
+        super('Indentation with hard tabs are not allowed :-p', lineno)
+      end
     end
 
     def initialize(on_enter: nil, on_leave: nil)
@@ -13,6 +36,9 @@ module Faml
     end
 
     def process(line, lineno)
+      if line =~ /\A\t/
+        raise HardTabNotAllowed.new(lineno)
+      end
       indent, text = split(line)
       indent_level = indent.size
 
@@ -39,17 +65,27 @@ module Faml
       @comment_level = @indent_levels[-2]
     end
 
+    def check_indent_level!(lineno)
+      if @indent_levels.size >= 3
+        previous_size = @indent_levels[-2] - @indent_levels[-3]
+        current_size = @indent_levels[-1] - @indent_levels[-2]
+        if previous_size != current_size
+          raise InconsistentIndent.new(previous_size, current_size, lineno)
+        end
+      end
+    end
+
     private
 
     def track(indent_level, text, lineno)
       if indent_level > @indent_levels.last
-        indent_enter(indent_level, text)
+        indent_enter(indent_level, text, lineno)
       elsif indent_level < @indent_levels.last
         indent_leave(indent_level, text, lineno)
       end
     end
 
-    def indent_enter(indent_level, text)
+    def indent_enter(indent_level, text, lineno)
       unless @comment_level
         @indent_levels.push(indent_level)
         @on_enter.call(indent_level, text)
@@ -73,7 +109,7 @@ module Faml
       end
 
       if indent_level != @indent_levels.last
-        raise IndentMismatch.new("Unexpected indent level: #{indent_level}: indent_level=#{@indent_levels}", lineno)
+        raise IndentMismatch.new(indent_level, @indent_levels.dup, lineno)
       end
     end
   end

data/lib/faml/parser.rb

@@ -186,6 +186,8 @@ module Faml
       end
       if @ast.is_a?(Ast::HamlComment)
         @indent_tracker.enter_comment!
+      else
+        @indent_tracker.check_indent_level!(@line_parser.lineno)
       end
       nil
     end

data/lib/faml/version.rb

@@ -1,3 +1,3 @@
 module Faml
-  VERSION = "0.2.13"
+  VERSION = "0.2.14"
 end

data/spec/render/element_spec.rb

@@ -42,15 +42,6 @@ HAML
 HAML
   end
 
-  it 'raises error if indent is wrong' do
-    expect { render_string(<<HAML) }.to raise_error(Faml::IndentTracker::IndentMismatch)
-%div
-    %div
-      %div
-  %div
-HAML
-  end
-
   it 'parses classes' do
     expect(render_string('%span.foo.bar hello')).to eq(%Q{<span class='foo bar'>hello</span>\n})
   end

data/spec/render/indent_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+RSpec.describe 'Indent', type: :render do
+  it 'raises error if indent is wrong' do
+    expect { render_string(<<HAML) }.to raise_error(Faml::IndentTracker::IndentMismatch) { |e|
+%div
+    %div
+        %div
+  %div
+HAML
+      expect(e.current_level).to eq(2)
+      expect(e.indent_levels).to eq([0])
+      expect(e.lineno).to eq(4)
+    }
+  end
+
+  it 'raises error if the current indent is deeper than the previous one' do
+    expect { render_string(<<HAML) }.to raise_error(Faml::IndentTracker::InconsistentIndent) { |e|
+%div
+  %div
+      %div
+HAML
+      expect(e.previous_size).to eq(2)
+      expect(e.current_size).to eq(4)
+      expect(e.lineno).to eq(3)
+    }
+  end
+
+  it 'raises error if the current indent is shallower than the previous one' do
+    expect { render_string(<<HAML) }.to raise_error(Faml::IndentTracker::InconsistentIndent) { |e|
+%div
+    %div
+      %div
+HAML
+      expect(e.previous_size).to eq(4)
+      expect(e.current_size).to eq(2)
+      expect(e.lineno).to eq(3)
+    }
+  end
+
+  it 'raises error if indented with hard tabs' do
+    expect { render_string(<<HAML) }.to raise_error(Faml::IndentTracker::HardTabNotAllowed)
+%p
+	%a
+HAML
+  end
+end

data/spec/spec_helper.rb

@@ -12,8 +12,21 @@ end
 require 'faml'
 
 module RenderSpecHelper
-  def render_string(str, options = {})
-    eval(Faml::Engine.new(options).call(str))
+  if ENV['GENERATE_INCOMPATIBILITIES'] == '1'
+    require_relative 'support/incompatibilities_generator'
+
+    def render_string(str, options = {})
+      eval(Faml::Engine.new(options).call(str)).tap do |html|
+        IncompatibilitiesGenerator.instance.record(str, options, html, RSpec.current_example)
+      end
+    rescue => e
+      IncompatibilitiesGenerator.instance.record(str, options, e, RSpec.current_example)
+      raise e
+    end
+  else
+    def render_string(str, options = {})
+      eval(Faml::Engine.new(options).call(str))
+    end
   end
 end
 
@@ -44,4 +57,10 @@ RSpec.configure do |config|
   Kernel.srand config.seed
 
   config.include(RenderSpecHelper, type: :render)
+
+  if ENV['GENERATE_INCOMPATIBILITIES'] == '1'
+    config.after :suite do
+      IncompatibilitiesGenerator.instance.write_to('incompatibilities')
+    end
+  end
 end

data/spec/support/incompatibilities_generator.rb

@@ -0,0 +1,132 @@
+require 'pathname'
+require 'singleton'
+require 'hamlit/engine'
+require 'hamlit/version'
+
+class IncompatibilitiesGenerator
+  include Singleton
+
+  class Record < Struct.new(:template, :options, :spec_path, :line_number, :faml_result, :haml_result, :hamlit_result)
+  end
+
+  def initialize
+    @records = []
+  end
+
+  def record(template, options, faml_result, example)
+    m = example.location.match(/\A(.+):(\d+)\z/)
+    @records.push(Record.new(template, options, m[1], m[2].to_i, faml_result, render_haml(template, options), render_hamlit(template, options)))
+  end
+
+  def write_to(markdown_root)
+    markdown_root = Pathname.new(markdown_root)
+
+    incompatibilities = Hash.new { |h, k| h[k] = [] }
+    @records.each do |record|
+      if record.faml_result.is_a?(Exception) && record.haml_result.is_a?(Exception) && record.hamlit_result.is_a?(Exception)
+        # All errored, not an incompatibility.
+      elsif record.faml_result != record.haml_result || record.faml_result != record.hamlit_result || record.haml_result != record.hamlit_result
+        incompatibilities[record.spec_path] << record
+      end
+    end
+
+    incompatibilities.keys.sort.each do |spec_path|
+      path = markdown_path(markdown_root, spec_path)
+      path.parent.mkpath
+      path.open('w') do |f|
+        incompatibilities[spec_path].sort_by(&:line_number).each do |record|
+          render_difference(f, path, record)
+        end
+      end
+    end
+    render_toc(markdown_root, incompatibilities.keys)
+  end
+
+  private
+
+  def render_haml(template, options)
+    obj = Object.new
+    Haml::Engine.new(template, {ugly: true, escape_html: true}.merge(options)).def_method(obj, :haml)
+    obj.haml
+  rescue Exception => e
+    e
+  end
+
+  def render_hamlit(template, options)
+    obj = Object.new
+    obj.instance_eval "def hamlit; #{Hamlit::Engine.new(options).call(template)}; end"
+    obj.hamlit
+  rescue Exception => e
+    e
+  end
+
+  def render_difference(file, path, record)
+    spec_path = Pathname.new(record.spec_path).relative_path_from(path.parent).to_s
+    file.write <<"EOS"
+# [#{record.spec_path}:#{record.line_number}](#{spec_path}#L#{record.line_number})
+## #{render_input_title(record.options)}
+```haml
+#{record.template}
+```
+
+EOS
+    if record.faml_result != record.haml_result && record.faml_result != record.hamlit_result && record.haml_result != record.hamlit_result
+      render_grouped_difference(file, 'Faml' => record.faml_result, 'Haml' => record.haml_result, 'Hamlit' => record.hamlit_result)
+    elsif record.faml_result == record.haml_result
+      render_grouped_difference(file, 'Faml, Haml' => record.faml_result, 'Hamlit' => record.hamlit_result)
+    elsif record.faml_result == record.hamlit_result
+      render_grouped_difference(file, 'Faml, Hamlit' => record.faml_result, 'Haml' => record.haml_result)
+    else
+      render_grouped_difference(file, 'Faml' => record.faml_result, 'Haml, Hamlit' => record.haml_result)
+    end
+  end
+
+  def render_input_title(options)
+    title = 'Input'
+    if !options.empty?
+      title << " (with options=#{options.inspect})"
+    end
+    title
+  end
+
+  def render_grouped_difference(file, grouped_results)
+    grouped_results.each do |title, result|
+      file.write <<"EOS"
+## #{render_section(title, result)}
+```html
+#{result}
+```
+
+EOS
+    end
+  end
+
+  def render_section(title, result)
+    if result.is_a?(Exception)
+      "#{title} (Error)"
+    else
+      title
+    end
+  end
+
+  def markdown_path(markdown_root, spec_path)
+    markdown_root.join(spec_path).sub_ext('.md')
+  end
+
+  def render_toc(markdown_root, spec_paths)
+    toc_path = markdown_root.join('README.md')
+    toc_path.open('w') do |f|
+      f.puts '# Incompatibilities'
+      f.puts '## Versions'
+      f.puts "- Haml #{Haml::VERSION}"
+      f.puts "- Faml #{Faml::VERSION}"
+      f.puts "- Hamlit #{Hamlit::VERSION}"
+      f.puts
+      f.puts '## Table of contents'
+      spec_paths.sort.each do |spec_path|
+        path = markdown_path(markdown_root, spec_path).relative_path_from(markdown_root)
+        f.puts "- [#{path}](#{path})"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faml
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.14
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -298,6 +298,29 @@ files:
 - gemfiles/rails_4.2.gemfile
 - gemfiles/rails_edge.gemfile
 - haml_spec_test.rb
+- incompatibilities/README.md
+- incompatibilities/spec/compiler_newline_spec.md
+- incompatibilities/spec/render/attribute_spec.md
+- incompatibilities/spec/render/comment_spec.md
+- incompatibilities/spec/render/doctype_spec.md
+- incompatibilities/spec/render/element_spec.md
+- incompatibilities/spec/render/filters/cdata_spec.md
+- incompatibilities/spec/render/filters/coffee_spec.md
+- incompatibilities/spec/render/filters/css_spec.md
+- incompatibilities/spec/render/filters/escaped_spec.md
+- incompatibilities/spec/render/filters/javascript_spec.md
+- incompatibilities/spec/render/filters/markdown_spec.md
+- incompatibilities/spec/render/filters/preserve_spec.md
+- incompatibilities/spec/render/filters/sass_spec.md
+- incompatibilities/spec/render/filters/scss_spec.md
+- incompatibilities/spec/render/helpers_spec.md
+- incompatibilities/spec/render/indent_spec.md
+- incompatibilities/spec/render/multiline_spec.md
+- incompatibilities/spec/render/newline_spec.md
+- incompatibilities/spec/render/plain_spec.md
+- incompatibilities/spec/render/sanitize_spec.md
+- incompatibilities/spec/render/silent_script_spec.md
+- incompatibilities/spec/render/unescape_spec.md
 - lib/faml.rb
 - lib/faml/ast.rb
 - lib/faml/cli.rb
@@ -417,6 +440,7 @@ files:
 - spec/render/filters_spec.rb
 - spec/render/haml_comment_spec.rb
 - spec/render/helpers_spec.rb
+- spec/render/indent_spec.rb
 - spec/render/multiline_spec.rb
 - spec/render/newline_spec.rb
 - spec/render/plain_spec.rb
@@ -426,6 +450,7 @@ files:
 - spec/render/silent_script_spec.rb
 - spec/render/unescape_spec.rb
 - spec/spec_helper.rb
+- spec/support/incompatibilities_generator.rb
 - spec/tilt_spec.rb
 homepage: https://github.com/eagletmt/faml
 licenses:
@@ -439,7 +464,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -452,6 +477,29 @@ signing_key:
 specification_version: 4
 summary: Faster implementation of Haml template language.
 test_files:
+- incompatibilities/README.md
+- incompatibilities/spec/compiler_newline_spec.md
+- incompatibilities/spec/render/attribute_spec.md
+- incompatibilities/spec/render/comment_spec.md
+- incompatibilities/spec/render/doctype_spec.md
+- incompatibilities/spec/render/element_spec.md
+- incompatibilities/spec/render/filters/cdata_spec.md
+- incompatibilities/spec/render/filters/coffee_spec.md
+- incompatibilities/spec/render/filters/css_spec.md
+- incompatibilities/spec/render/filters/escaped_spec.md
+- incompatibilities/spec/render/filters/javascript_spec.md
+- incompatibilities/spec/render/filters/markdown_spec.md
+- incompatibilities/spec/render/filters/preserve_spec.md
+- incompatibilities/spec/render/filters/sass_spec.md
+- incompatibilities/spec/render/filters/scss_spec.md
+- incompatibilities/spec/render/helpers_spec.md
+- incompatibilities/spec/render/indent_spec.md
+- incompatibilities/spec/render/multiline_spec.md
+- incompatibilities/spec/render/newline_spec.md
+- incompatibilities/spec/render/plain_spec.md
+- incompatibilities/spec/render/sanitize_spec.md
+- incompatibilities/spec/render/silent_script_spec.md
+- incompatibilities/spec/render/unescape_spec.md
 - spec/compiler_newline_spec.rb
 - spec/rails/Rakefile
 - spec/rails/app/assets/images/.keep
@@ -532,6 +580,7 @@ test_files:
 - spec/render/filters_spec.rb
 - spec/render/haml_comment_spec.rb
 - spec/render/helpers_spec.rb
+- spec/render/indent_spec.rb
 - spec/render/multiline_spec.rb
 - spec/render/newline_spec.rb
 - spec/render/plain_spec.rb
@@ -541,4 +590,5 @@ test_files:
 - spec/render/silent_script_spec.rb
 - spec/render/unescape_spec.rb
 - spec/spec_helper.rb
+- spec/support/incompatibilities_generator.rb
 - spec/tilt_spec.rb