faml 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7f71b5e360cafa8cef276e06dbc8c8b0c2214bb
-  data.tar.gz: b94247f91e3508b3261686ad678eb539cf535ea5
+  metadata.gz: 467a84dc8e9b891942ce31fc121c273080fcc72a
+  data.tar.gz: 9523d713adcd1dc6daf5dd384cf74fc26e5be883
 SHA512:
-  metadata.gz: 2aa2f8a5e0e40444fa7c87d1f864fe0ba713b7f2a76ddcc722635233a43a43a8b20ad480f599636a2f85f84a0018ba0adf912f0b2399f537b8c95ae0af26552c
-  data.tar.gz: e11276dff335fe35d1c95753539ea45be0500e09ff030a616d53b587b6cc5570869cc40ad0247f33c8deaefd0c764e9a8c1a424ae522faf87f50712e1a62087a
+  metadata.gz: a2f64b49c6b59166fc97eab6078a4a0e529ed9c0b9fa45257891606c0c49582b100d08fd64e38e5ef0bf9c2aa689e79888db4381ddc5ce119268163f6c647c9f
+  data.tar.gz: 9ddc8674331446ae2459eeeb0360f924d383f88b2cbdef065a47a765f420d3ae9e6ebee590ca241db3e3ae02a958903082818eb38700d7872ed5c792bd894d42

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.1 (2015-11-18)
+- Fix id ordering of object reference
+    - https://github.com/eagletmt/faml/issues/33
+
 ## 0.5.0 (2015-11-17)
 - Support object reference syntax
     - https://github.com/eagletmt/faml/pull/32

data/ext/attribute_builder/attribute_builder.c

@@ -165,19 +165,28 @@ normalize(VALUE hash)
 }
 
 static void
-merge(VALUE attributes, int argc, VALUE *argv)
+merge_one(VALUE attributes, VALUE arg)
+{
+  VALUE h;
+
+  Check_Type(arg, T_HASH);
+  h = stringify_keys(arg);
+  concat_array_attribute(attributes, h, rb_const_get(rb_mAttributeBuilder, id_class));
+  concat_array_attribute(attributes, h, rb_const_get(rb_mAttributeBuilder, id_id));
+  normalize(h);
+  rb_funcall(attributes, id_merge_bang, 1, h);
+}
+
+static void
+merge(VALUE attributes, VALUE object_ref, int argc, VALUE *argv)
 {
   int i;
 
   for (i = 0; i < argc; i++) {
-    VALUE h;
-
-    Check_Type(argv[i], T_HASH);
-    h = stringify_keys(argv[i]);
-    concat_array_attribute(attributes, h, rb_const_get(rb_mAttributeBuilder, id_class));
-    concat_array_attribute(attributes, h, rb_const_get(rb_mAttributeBuilder, id_id));
-    normalize(h);
-    rb_funcall(attributes, id_merge_bang, 1, h);
+    merge_one(attributes, argv[i]);
+  }
+  if (!NIL_P(object_ref)) {
+    merge_one(attributes, object_ref);
   }
 }
 
@@ -253,17 +262,18 @@ build_attribute(VALUE buf, VALUE attr_quote, int is_html, VALUE key, VALUE value
 static VALUE
 m_build(int argc, VALUE *argv, RB_UNUSED_VAR(VALUE self))
 {
-  VALUE attr_quote, attributes, keys, buf;
+  VALUE attr_quote, object_ref, attributes, keys, buf;
   int is_html;
   long len, i;
 
-  rb_check_arity(argc, 2, UNLIMITED_ARGUMENTS);
+  rb_check_arity(argc, 3, UNLIMITED_ARGUMENTS);
   attr_quote = argv[0];
   is_html = RTEST(argv[1]);
+  object_ref = argv[2];
   attributes = rb_hash_new();
   rb_hash_aset(attributes, rb_const_get(rb_mAttributeBuilder, id_id), rb_ary_new());
   rb_hash_aset(attributes, rb_const_get(rb_mAttributeBuilder, id_class), rb_ary_new());
-  merge(attributes, argc-2, argv+2);
+  merge(attributes, object_ref, argc-3, argv+3);
 
   keys = rb_funcall(attributes, id_keys, 0);
   rb_funcall(keys, id_sort_bang, 0);

data/incompatibilities/README.md

@@ -1,7 +1,7 @@
 # Incompatibilities
 ## Versions
 - Haml 4.0.7
-- Faml 0.5.0
+- Faml 0.5.1
 - Hamlit 1.7.2
 
 ## Table of contents

data/incompatibilities/spec/render/attribute_spec.md

@@ -513,3 +513,21 @@
 
 ```
 
+# [./spec/render/attribute_spec.rb:227](../../../spec/render/attribute_spec.rb#L227)
+## Input
+```haml
+%span#baz[Faml::TestStruct.new(123)]{id: "foo"} hello
+```
+
+## Faml, Haml
+```html
+<span class='faml_test_struct' id='baz_foo_faml_test_struct_123'>hello</span>
+
+```
+
+## Hamlit
+```html
+<span id='baz'>[Faml::TestStruct.new(123)]{id: "foo"} hello</span>
+
+```
+

data/lib/faml/attribute_compiler.rb

@@ -0,0 +1,98 @@
+require_relative 'attribute_optimizer'
+require_relative 'object_ref'
+
+module Faml
+  class AttributeCompiler
+    def compile(ast)
+      if !ast.object_ref && ast.attributes.empty?
+        return compile_static_id_and_class(ast.static_id, ast.static_class)
+      end
+
+      unless ast.object_ref
+        attrs = try_optimize_attributes(ast.attributes, ast.static_id, ast.static_class)
+        if attrs
+          line_count = ast.attributes.count("\n")
+          return [:multi, [:html, :attrs, *attrs]].concat([[:newline]] * line_count)
+        end
+      end
+
+      compile_slow_attributes(ast.attributes, ast.static_id, ast.static_class, ast.object_ref)
+    end
+
+    private
+
+    def compile_static_id_and_class(static_id, static_class)
+      [:html, :attrs].tap do |html_attrs|
+        unless static_class.empty?
+          html_attrs << [:haml, :attr, 'class', [:static, static_class]]
+        end
+        unless static_id.empty?
+          html_attrs << [:haml, :attr, 'id', [:static, static_id]]
+        end
+      end
+    end
+
+    def try_optimize_attributes(text, static_id, static_class)
+      static_attributes, dynamic_attributes = AttributeOptimizer.new.try_optimize(text, static_id, static_class)
+      if static_attributes
+        (static_attributes.keys + dynamic_attributes.keys).sort.flat_map do |k|
+          if static_attributes.key?(k)
+            compile_static_attribute(k, static_attributes[k])
+          else
+            compile_dynamic_attribute(k, dynamic_attributes[k])
+          end
+        end
+      end
+    end
+
+    def compile_static_attribute(key, value)
+      if value.is_a?(Hash) && key == 'data'
+        data = AttributeBuilder.normalize_data(value)
+        data.keys.sort.map do |k|
+          compile_static_simple_attribute("data-#{k}", data[k])
+        end
+      else
+        [compile_static_simple_attribute(key, value)]
+      end
+    end
+
+    def compile_static_simple_attribute(key, value)
+      case
+      when value == true
+        [:haml, :attr, key, [:multi]]
+      when value == false || value.nil?
+        [:multi]
+      else
+        [:haml, :attr, key, [:static, Temple::Utils.escape_html(value)]]
+      end
+    end
+
+    def compile_dynamic_attribute(key, value)
+      [[:haml, :attr, key, [:dvalue, value]]]
+    end
+
+    def compile_slow_attributes(text, static_id, static_class, object_ref)
+      h = {}
+      unless static_class.empty?
+        h[:class] = static_class.split(/ +/)
+      end
+      unless static_id.empty?
+        h[:id] = static_id
+      end
+
+      codes = []
+      if object_ref
+        codes << "::Faml::ObjectRef.render(#{object_ref})"
+      else
+        codes << 'nil'
+      end
+      unless h.empty?
+        codes << h.inspect
+      end
+      unless text.empty?
+        codes << text
+      end
+      [:haml, :attrs, codes.join(', ')]
+    end
+  end
+end

data/lib/faml/attribute_optimizer.rb

@@ -0,0 +1,100 @@
+require_relative 'error'
+require_relative 'ruby_syntax_checker'
+require_relative 'static_hash_parser'
+
+module Faml
+  class AttributeOptimizer
+    def try_optimize(text, static_id, static_class)
+      parser = StaticHashParser.new
+      unless parser.parse("{#{text}}")
+        assert_valid_ruby_code!(text)
+        return [nil, nil]
+      end
+
+      static_attributes, dynamic_attributes = build_optimized_attributes(parser, static_id, static_class)
+      if optimizable?(text, static_attributes, dynamic_attributes)
+        [static_attributes, dynamic_attributes]
+      else
+        [nil, nil]
+      end
+    end
+
+    private
+
+    def assert_valid_ruby_code!(text)
+      RubySyntaxChecker.new("call(#{text})", '(faml)').parse
+      true
+    rescue RubySyntaxChecker::Error
+      raise UnparsableRubyCode.new("Unparsable Ruby code is given to attributes: #{text}", nil)
+    end
+
+    def build_optimized_attributes(parser, static_id, static_class)
+      static_attributes = build_optimized_static_attributes(parser, static_id, static_class)
+      dynamic_attributes = build_optimized_dynamic_attributes(parser, static_attributes)
+      if dynamic_attributes
+        [static_attributes, dynamic_attributes]
+      else
+        [nil, nil]
+      end
+    end
+
+    def build_optimized_static_attributes(parser, static_id, static_class)
+      static_attributes = {}
+      parser.static_attributes.each do |k, v|
+        static_attributes[k.to_s] = v
+      end
+
+      class_list = Array(static_attributes.delete('class')).select { |v| v }.flat_map { |c| c.to_s.split(/ +/) }
+      unless static_class.empty?
+        class_list.concat(static_class.split(/ +/))
+      end
+      unless class_list.empty?
+        static_attributes['class'] = class_list.uniq.sort.join(' ')
+      end
+
+      id_list = Array(static_attributes.delete('id')).select { |v| v }
+      unless static_id.empty?
+        id_list = [static_id].concat(id_list)
+      end
+      unless id_list.empty?
+        static_attributes['id'] = id_list.join('_')
+      end
+
+      static_attributes
+    end
+
+    def build_optimized_dynamic_attributes(parser, static_attributes)
+      dynamic_attributes = {}
+      parser.dynamic_attributes.each do |k, v|
+        k = k.to_s
+        if static_attributes.key?(k)
+          if StaticHashParser::SPECIAL_ATTRIBUTES.include?(k)
+            # XXX: Quit optimization
+            return nil
+          end
+        end
+        dynamic_attributes[k] = v
+      end
+      dynamic_attributes
+    end
+
+    def optimizable?(text, static_attributes, dynamic_attributes)
+      if static_attributes.nil?
+        return false
+      end
+
+      if dynamic_attributes.key?('data')
+        # XXX: Quit optimization...
+        return false
+      end
+
+      if text.include?("\n") && !dynamic_attributes.empty?
+        # XXX: Quit optimization to keep newlines
+        # https://github.com/eagletmt/faml/issues/18
+        return false
+      end
+
+      true
+    end
+  end
+end

data/lib/faml/compiler.rb

@@ -1,20 +1,15 @@
 require 'ripper'
 require 'temple'
 require 'haml_parser/ast'
+require_relative 'attribute_compiler'
 require_relative 'error'
 require_relative 'filter_compilers'
 require_relative 'helpers'
-require_relative 'object_ref'
 require_relative 'rails_helpers'
-require_relative 'ruby_syntax_checker'
-require_relative 'static_hash_parser'
 require_relative 'text_compiler'
 
 module Faml
   class Compiler < Temple::Parser
-    class UnparsableRubyCode < Error
-    end
-
     DEFAULT_AUTO_CLOSE_TAGS = %w[
       area base basefont br col command embed frame hr img input isindex keygen
       link menuitem meta param source track wbr
@@ -182,7 +177,7 @@ module Faml
         :haml, :tag,
         ast.tag_name,
         self_closing?(ast),
-        compile_attributes(ast.attributes, ast.static_id, ast.static_class, ast.object_ref),
+        AttributeCompiler.new.compile(ast),
       ]
 
       if ast.oneline_child
@@ -224,168 +219,6 @@ module Faml
       ast.nuke_inner_whitespace || options[:preserve].include?(ast.tag_name)
     end
 
-    def compile_attributes(text, static_id, static_class, object_ref)
-      if !object_ref && text.empty?
-        return compile_static_id_and_class(static_id, static_class)
-      end
-
-      unless object_ref
-        attrs = try_optimize_attributes(text, static_id, static_class)
-        if attrs
-          line_count = text.count("\n")
-          return [:multi, [:html, :attrs, *attrs]].concat([[:newline]] * line_count)
-        end
-      end
-
-      # Slow version
-
-      h = {}
-      unless static_class.empty?
-        h[:class] = static_class.split(/ +/)
-      end
-      unless static_id.empty?
-        h[:id] = static_id
-      end
-
-      codes = []
-      unless h.empty?
-        codes << h.inspect
-      end
-      if object_ref
-        codes << "::Faml::ObjectRef.render(#{object_ref})"
-      end
-      unless text.empty?
-        codes << text
-      end
-      [:haml, :attrs, codes.join(', ')]
-    end
-
-    def compile_static_id_and_class(static_id, static_class)
-      [:html, :attrs].tap do |html_attrs|
-        unless static_class.empty?
-          html_attrs << [:haml, :attr, 'class', [:static, static_class]]
-        end
-        unless static_id.empty?
-          html_attrs << [:haml, :attr, 'id', [:static, static_id]]
-        end
-      end
-    end
-
-    def try_optimize_attributes(text, static_id, static_class)
-      parser = StaticHashParser.new
-      unless parser.parse("{#{text}}")
-        assert_valid_ruby_code!(text)
-        return nil
-      end
-
-      static_attributes, dynamic_attributes = build_optimized_attributes(parser, static_id, static_class)
-      if static_attributes.nil?
-        return nil
-      end
-
-      if dynamic_attributes.key?('data')
-        # XXX: Quit optimization...
-        return nil
-      end
-
-      if text.include?("\n") && !dynamic_attributes.empty?
-        # XXX: Quit optimization to keep newlines
-        # https://github.com/eagletmt/faml/issues/18
-        return nil
-      end
-
-      (static_attributes.keys + dynamic_attributes.keys).sort.flat_map do |k|
-        if static_attributes.key?(k)
-          compile_static_attribute(k, static_attributes[k])
-        else
-          compile_dynamic_attribute(k, dynamic_attributes[k])
-        end
-      end
-    end
-
-    def assert_valid_ruby_code!(text)
-      RubySyntaxChecker.new("call(#{text})", '(faml)').parse
-      true
-    rescue RubySyntaxChecker::Error
-      raise UnparsableRubyCode.new("Unparsable Ruby code is given to attributes: #{text}", nil)
-    end
-
-    def build_optimized_attributes(parser, static_id, static_class)
-      static_attributes = build_optimized_static_attributes(parser, static_id, static_class)
-      dynamic_attributes = build_optimized_dynamic_attributes(parser, static_attributes)
-      if dynamic_attributes
-        [static_attributes, dynamic_attributes]
-      else
-        [nil, nil]
-      end
-    end
-
-    def build_optimized_static_attributes(parser, static_id, static_class)
-      static_attributes = {}
-      parser.static_attributes.each do |k, v|
-        static_attributes[k.to_s] = v
-      end
-
-      class_list = Array(static_attributes.delete('class')).select { |v| v }.flat_map { |c| c.to_s.split(/ +/) }
-      unless static_class.empty?
-        class_list.concat(static_class.split(/ +/))
-      end
-      unless class_list.empty?
-        static_attributes['class'] = class_list.uniq.sort.join(' ')
-      end
-
-      id_list = Array(static_attributes.delete('id')).select { |v| v }
-      unless static_id.empty?
-        id_list = [static_id].concat(id_list)
-      end
-      unless id_list.empty?
-        static_attributes['id'] = id_list.join('_')
-      end
-
-      static_attributes
-    end
-
-    def build_optimized_dynamic_attributes(parser, static_attributes)
-      dynamic_attributes = {}
-      parser.dynamic_attributes.each do |k, v|
-        k = k.to_s
-        if static_attributes.key?(k)
-          if StaticHashParser::SPECIAL_ATTRIBUTES.include?(k)
-            # XXX: Quit optimization
-            return nil
-          end
-        end
-        dynamic_attributes[k] = v
-      end
-      dynamic_attributes
-    end
-
-    def compile_static_attribute(key, value)
-      if value.is_a?(Hash) && key == 'data'
-        data = AttributeBuilder.normalize_data(value)
-        data.keys.sort.map do |k|
-          compile_static_simple_attribute("data-#{k}", data[k])
-        end
-      else
-        [compile_static_simple_attribute(key, value)]
-      end
-    end
-
-    def compile_static_simple_attribute(key, value)
-      case
-      when value == true
-        [:haml, :attr, key, [:multi]]
-      when value == false || value.nil?
-        [:multi]
-      else
-        [:haml, :attr, key, [:static, Temple::Utils.escape_html(value)]]
-      end
-    end
-
-    def compile_dynamic_attribute(key, value)
-      [[:haml, :attr, key, [:dvalue, value]]]
-    end
-
     def compile_script(ast)
       sym = unique_name
       temple = [:multi]

data/lib/faml/error.rb

@@ -7,4 +7,7 @@ module Faml
       @lineno = lineno
     end
   end
+
+  class UnparsableRubyCode < Error
+  end
 end

data/lib/faml/version.rb

@@ -1,3 +1,3 @@
 module Faml
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/spec/rails/spec/requests/faml_spec.rb

@@ -84,7 +84,7 @@ RSpec.describe 'Faml with Rails', type: :request do
       end
     end
 
-    describe Faml::Compiler::UnparsableRubyCode do
+    describe Faml::UnparsableRubyCode do
       it 'has proper backtrace' do
         expect { get '/books/unparsable' }.to raise_error { |e|
           expect(e.backtrace[0]).to end_with('app/views/books/unparsable.html.haml:2')

data/spec/render/attribute_spec.rb

@@ -102,7 +102,7 @@ HAML
   end
 
   it 'raises error when unparsable Ruby code is given' do
-    expect { render_string('%span{x ==== 2}') }.to raise_error(Faml::Compiler::UnparsableRubyCode)
+    expect { render_string('%span{x ==== 2}') }.to raise_error(Faml::UnparsableRubyCode)
   end
 
   context 'with xhtml format' do
@@ -223,5 +223,9 @@ HAML
     it 'renders id and class attribute with haml_object_ref' do
       expect(render_string('%span[Faml::TestRefStruct.new(123)] hello')).to eq("<span class='faml_test' id='faml_test_123'>hello</span>\n")
     end
+
+    it 'renders id in correct order' do
+      expect(render_string('%span#baz[Faml::TestStruct.new(123)]{id: "foo"} hello')).to eq("<span class='faml_test_struct' id='baz_foo_faml_test_struct_123'>hello</span>\n")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faml
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -350,6 +350,8 @@ files:
 - incompatibilities/spec/render/silent_script_spec.md
 - incompatibilities/spec/render/unescape_spec.md
 - lib/faml.rb
+- lib/faml/attribute_compiler.rb
+- lib/faml/attribute_optimizer.rb
 - lib/faml/cli.rb
 - lib/faml/compiler.rb
 - lib/faml/engine.rb