faml 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f0a4ce48d756e7ce5bc2bfe6f2ee8506c936c13
-  data.tar.gz: a15d13d5b441128441e921c58e71299d938059cc
+  metadata.gz: c7f71b5e360cafa8cef276e06dbc8c8b0c2214bb
+  data.tar.gz: b94247f91e3508b3261686ad678eb539cf535ea5
 SHA512:
-  metadata.gz: 7a7fb11f2ac4d7066de1015abc4a97f5c978a21701ef7e9a151bb3df82ce766fcca7ff1bce41bd6fc4765616db4e336d56da2f4a72b4e2752386650af6e2d591
-  data.tar.gz: 46e713540d00f7f3bc0c6972b6e048f72d0751c1cf10d4a40b31bf7b0d8707b7a0abe618a9f8e997eeca5c89e5d51c955f7b0bd5cd96418ac7d474c6147554de
+  metadata.gz: 2aa2f8a5e0e40444fa7c87d1f864fe0ba713b7f2a76ddcc722635233a43a43a8b20ad480f599636a2f85f84a0018ba0adf912f0b2399f537b8c95ae0af26552c
+  data.tar.gz: e11276dff335fe35d1c95753539ea45be0500e09ff030a616d53b587b6cc5570869cc40ad0247f33c8deaefd0c764e9a8c1a424ae522faf87f50712e1a62087a

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.5.0 (2015-11-17)
+- Support object reference syntax
+    - https://github.com/eagletmt/faml/pull/32
+
 ## 0.4.2 (2015-11-16)
 - Fix CLI slow startup
     - https://github.com/eagletmt/faml/issues/21

data/faml.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency 'escape_utils'
-  spec.add_dependency 'haml_parser', '>= 0.2.0'
+  spec.add_dependency 'haml_parser', '>= 0.3.0'
   spec.add_dependency 'parser'
   spec.add_dependency 'temple', '>= 0.7.0'
   spec.add_dependency 'tilt'

data/incompatibilities/README.md

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

data/incompatibilities/spec/render/attribute_spec.md

@@ -459,3 +459,57 @@
 ...                               ^
 ```
 
+# [./spec/render/attribute_spec.rb:215](../../../spec/render/attribute_spec.rb#L215)
+## Input
+```haml
+%span[Faml::TestStruct.new(123)] hello
+```
+
+## Faml, Haml
+```html
+<span class='faml_test_struct' id='faml_test_struct_123'>hello</span>
+
+```
+
+## Hamlit
+```html
+<span>[Faml::TestStruct.new(123)] hello</span>
+
+```
+
+# [./spec/render/attribute_spec.rb:219](../../../spec/render/attribute_spec.rb#L219)
+## Input
+```haml
+%span[Faml::TestStruct.new(123), :hello] hello
+```
+
+## Faml, Haml
+```html
+<span class='hello_faml_test_struct' id='hello_faml_test_struct_123'>hello</span>
+
+```
+
+## Hamlit
+```html
+<span>[Faml::TestStruct.new(123), :hello] hello</span>
+
+```
+
+# [./spec/render/attribute_spec.rb:223](../../../spec/render/attribute_spec.rb#L223)
+## Input
+```haml
+%span[Faml::TestRefStruct.new(123)] hello
+```
+
+## Faml, Haml
+```html
+<span class='faml_test' id='faml_test_123'>hello</span>
+
+```
+
+## Hamlit
+```html
+<span>[Faml::TestRefStruct.new(123)] hello</span>
+
+```
+

data/lib/faml/compiler.rb

@@ -4,6 +4,7 @@ require 'haml_parser/ast'
 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'
@@ -181,7 +182,7 @@ module Faml
         :haml, :tag,
         ast.tag_name,
         self_closing?(ast),
-        compile_attributes(ast.attributes, ast.static_id, ast.static_class),
+        compile_attributes(ast.attributes, ast.static_id, ast.static_class, ast.object_ref),
       ]
 
       if ast.oneline_child
@@ -223,15 +224,17 @@ module Faml
       ast.nuke_inner_whitespace || options[:preserve].include?(ast.tag_name)
     end
 
-    def compile_attributes(text, static_id, static_class)
-      if text.empty?
+    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
 
-      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)
+      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
@@ -244,13 +247,17 @@ module Faml
         h[:id] = static_id
       end
 
-      t =
-        if h.empty?
-          text
-        else
-          "#{h.inspect}, #{text}"
-        end
-      [:haml, :attrs, t]
+      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)

data/lib/faml/object_ref.rb

@@ -0,0 +1,50 @@
+module Faml
+  module ObjectRef
+    class << self
+      def render(ref = nil, prefix = nil, *)
+        h = {}
+        if ref.nil?
+          return h
+        end
+        c = class_name(ref)
+        i = "#{c}_#{id(ref) || 'new'}"
+        if prefix
+          c = "#{prefix}_#{c}"
+          i = "#{prefix}_#{i}"
+        end
+        { id: i, class: c }
+      end
+
+      private
+
+      def class_name(ref)
+        if ref.respond_to?(:haml_object_ref)
+          ref.haml_object_ref
+        else
+          underscore(ref.class)
+        end
+      end
+
+      def id(ref)
+        if ref.respond_to?(:to_key)
+          key = ref.to_key
+          if key
+            key.join('_')
+          end
+        else
+          ref.id
+        end
+      end
+
+      def underscore(camel_cased_word)
+        word = camel_cased_word.to_s.dup
+        word.gsub!(/::/, '_')
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!('-', '_')
+        word.downcase!
+        word
+      end
+    end
+  end
+end

data/lib/faml/stats.rb

@@ -13,6 +13,7 @@ module Faml
       :dynamic_attribute_with_data_count,
       :dynamic_attribute_with_newline_count,
       :ruby_attribute_count,
+      :object_reference_count,
       :multi_attribute_count,
       :ast_types
     ) do
@@ -99,6 +100,11 @@ module Faml
     end
 
     def collect_attribute_info(info, ast)
+      if ast.object_ref
+        info.object_reference_count += 1
+        return
+      end
+
       if ast.attributes.empty?
         if ast.static_class.empty? && ast.static_id.empty?
           info.empty_attribute_count += 1
@@ -133,7 +139,7 @@ module Faml
     def report_attribute_stats(info)
       static = info.static_attribute_count
       dynamic = info.dynamic_attribute_count + info.dynamic_attribute_with_data_count + info.dynamic_attribute_with_newline_count
-      ruby = info.ruby_attribute_count + info.multi_attribute_count
+      ruby = info.ruby_attribute_count + info.multi_attribute_count + info.object_reference_count
       total = static + dynamic + ruby
       puts 'Attribute stats'
       printf("  Empty attributes: %d\n", info.empty_attribute_count)
@@ -144,6 +150,7 @@ module Faml
       printf("    with newline: %d\n", info.dynamic_attribute_with_newline_count)
       printf("  Ruby attributes: %d (%.2f%%)\n", ruby, ruby * 100.0 / total)
       printf("    with multiple arguments: %d\n", info.multi_attribute_count)
+      printf("    with object reference: %d\n", info.object_reference_count)
     end
 
     def report_ast_stats(info)

data/lib/faml/version.rb

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

data/spec/rails/app/controllers/books_controller.rb

@@ -5,4 +5,8 @@ class BooksController < ApplicationController
   def with_variables
     @book = Book.new(params.permit(:title))
   end
+
+  def object_ref
+    @book = Book.new(id: params[:id])
+  end
 end

data/spec/rails/app/models/book.rb

@@ -1,7 +1,7 @@
 class Book
   include ActiveModel::Model
 
-  attr_accessor :title
+  attr_accessor :id, :title
 
   def to_s
     "<span>#{title}</span>".html_safe

data/spec/rails/app/views/books/object_ref.html.haml

@@ -0,0 +1,2 @@
+%div[@book]
+  %p= @book.title

data/spec/rails/config/routes.rb

@@ -12,5 +12,6 @@ Rails.application.routes.draw do
     get :invalid_interpolation
     get :filter_not_found
     get :filter_invalid_interpolation
+    get :object_ref
   end
 end

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

@@ -45,6 +45,20 @@ RSpec.describe 'Faml with Rails', type: :request do
     expect(response.body).to include('<marquee>escape me</marquee>')
   end
 
+  describe 'object reference' do
+    it 'works with new object' do
+      get '/books/object_ref'
+      expect(response).to be_ok
+      expect(response.body).to include("<div class='book' id='book_new'>")
+    end
+
+    it 'works with id' do
+      get '/books/object_ref', id: 123
+      expect(response).to be_ok
+      expect(response.body).to include("<div class='book' id='book_123'>")
+    end
+  end
+
   describe 'preserve helper' do
     it 'returns html_safe string' do
       get '/books/preserve'

data/spec/render/attribute_spec.rb

@@ -210,4 +210,18 @@ HAML
 %span{key => val}
 HAML
   end
+
+  describe 'object reference' do
+    it 'renders id and class attribute' do
+      expect(render_string('%span[Faml::TestStruct.new(123)] hello')).to eq("<span class='faml_test_struct' id='faml_test_struct_123'>hello</span>\n")
+    end
+
+    it 'renders id and class attribute with prefix' do
+      expect(render_string('%span[Faml::TestStruct.new(123), :hello] hello')).to eq("<span class='hello_faml_test_struct' id='hello_faml_test_struct_123'>hello</span>\n")
+    end
+
+    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
+  end
 end

data/spec/spec_helper.rb

@@ -31,6 +31,15 @@ module RenderSpecHelper
   end
 end
 
+module Faml
+  TestStruct = Struct.new(:id)
+  TestRefStruct = Struct.new(:id) do
+    def haml_object_ref
+      'faml_test'
+    end
+  end
+end
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faml
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-16 00:00:00.000000000 Z
+date: 2015-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -371,6 +371,7 @@ files:
 - lib/faml/helpers.rb
 - lib/faml/html.rb
 - lib/faml/newline.rb
+- lib/faml/object_ref.rb
 - lib/faml/rails_handler.rb
 - lib/faml/rails_helpers.rb
 - lib/faml/railtie.rb
@@ -400,6 +401,7 @@ files:
 - spec/rails/app/views/books/hello.html.haml
 - spec/rails/app/views/books/indent_error.html.haml
 - spec/rails/app/views/books/invalid_interpolation.html.haml
+- spec/rails/app/views/books/object_ref.html.haml
 - spec/rails/app/views/books/preserve.html.haml
 - spec/rails/app/views/books/syntax_error.html.haml
 - spec/rails/app/views/books/unparsable.html.haml
@@ -557,6 +559,7 @@ test_files:
 - spec/rails/app/views/books/hello.html.haml
 - spec/rails/app/views/books/indent_error.html.haml
 - spec/rails/app/views/books/invalid_interpolation.html.haml
+- spec/rails/app/views/books/object_ref.html.haml
 - spec/rails/app/views/books/preserve.html.haml
 - spec/rails/app/views/books/syntax_error.html.haml
 - spec/rails/app/views/books/unparsable.html.haml