faml 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 467a84dc8e9b891942ce31fc121c273080fcc72a
-  data.tar.gz: 9523d713adcd1dc6daf5dd384cf74fc26e5be883
+  metadata.gz: 3a3b36d8389b63138cf89889812b0fd7d4534090
+  data.tar.gz: fc0f8be17b23d50a7b921a7d8480a81d35d37bfd
 SHA512:
-  metadata.gz: a2f64b49c6b59166fc97eab6078a4a0e529ed9c0b9fa45257891606c0c49582b100d08fd64e38e5ef0bf9c2aa689e79888db4381ddc5ce119268163f6c647c9f
-  data.tar.gz: 9ddc8674331446ae2459eeeb0360f924d383f88b2cbdef065a47a765f420d3ae9e6ebee590ca241db3e3ae02a958903082818eb38700d7872ed5c792bd894d42
+  metadata.gz: 6894952372619bbb11ce192021df6b7640f0d509eee42f315087dc9009b6800f8f7437e519b1d11d3c93ee2d2bc8f86c8b08bd009ad493500400eab3f9ca7a91
+  data.tar.gz: 19d60336ee8bb7fb09837540de41db71bc3f368e693dcd9d39507aae9888aa49b7523215a2777c1177d178af80434f9448ad607e39280ccd24a992c8a876f38a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.6.0 (2015-11-21)
+- Disable Faml::Helpers by default
+    - https://github.com/eagletmt/faml/pull/35
+    - Set `Faml::Engine.options[:extend_helpers] = true` to enable `preserve` helper method
+
 ## 0.5.1 (2015-11-18)
 - Fix id ordering of object reference
     - https://github.com/eagletmt/faml/issues/33

data/README.md

@@ -80,9 +80,12 @@ is always rendered as
 
 It's equivalent to haml's "ugly" mode.
 
-### No Haml::Helpers except for preserve
-I won't provide helper methods of Haml::Helpers except for `preserve` .
-If you really need other helper methods, please open an issue.
+### No Haml::Helpers by default
+I won't provide helper methods of Haml::Helpers.
+If you really need helper methods, please open an issue.
+
+Only `preserve` helper method is supported by engine option.
+You have to set `Faml::Engine.options[:extend_helpers] = true` to use `preserve` .
 
 ### Others
 If you find other incompatibility, please report it to me :-p.

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.3.0'
+  spec.add_dependency 'haml_parser', '>= 0.4.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.5.1
+- Faml 0.6.0
 - Hamlit 1.7.2
 
 ## Table of contents

data/incompatibilities/spec/render/helpers_spec.md

@@ -1,5 +1,5 @@
 # [./spec/render/helpers_spec.rb:4](../../../spec/render/helpers_spec.rb#L4)
-## Input
+## Input (with options={:extend_helpers=>true})
 ```haml
 %span!= preserve "hello\nworld !"
 ```

data/lib/faml/attribute_compiler.rb

@@ -4,19 +4,25 @@ require_relative 'object_ref'
 module Faml
   class AttributeCompiler
     def compile(ast)
-      if !ast.object_ref && ast.attributes.empty?
+      if !ast.object_ref && !ast.old_attributes && !ast.new_attributes
         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)
+        attrs = try_optimize_attributes(ast.old_attributes, ast.new_attributes, ast.static_id, ast.static_class)
         if attrs
-          line_count = ast.attributes.count("\n")
+          line_count = 0
+          if ast.old_attributes
+            line_count += ast.old_attributes.count("\n")
+          end
+          if ast.new_attributes
+            line_count += ast.new_attributes.count("\n")
+          end
           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)
+      compile_slow_attributes(ast.old_attributes, ast.new_attributes, ast.static_id, ast.static_class, ast.object_ref)
     end
 
     private
@@ -32,8 +38,8 @@ module Faml
       end
     end
 
-    def try_optimize_attributes(text, static_id, static_class)
-      static_attributes, dynamic_attributes = AttributeOptimizer.new.try_optimize(text, static_id, static_class)
+    def try_optimize_attributes(old_attributes, new_attributes, static_id, static_class)
+      static_attributes, dynamic_attributes = AttributeOptimizer.new.try_optimize(old_attributes, new_attributes, static_id, static_class)
       if static_attributes
         (static_attributes.keys + dynamic_attributes.keys).sort.flat_map do |k|
           if static_attributes.key?(k)
@@ -71,7 +77,7 @@ module Faml
       [[:haml, :attr, key, [:dvalue, value]]]
     end
 
-    def compile_slow_attributes(text, static_id, static_class, object_ref)
+    def compile_slow_attributes(old_attributes, new_attributes, static_id, static_class, object_ref)
       h = {}
       unless static_class.empty?
         h[:class] = static_class.split(/ +/)
@@ -89,8 +95,11 @@ module Faml
       unless h.empty?
         codes << h.inspect
       end
-      unless text.empty?
-        codes << text
+      if new_attributes
+        codes << "{#{new_attributes}}"
+      end
+      if old_attributes
+        codes << old_attributes
       end
       [:haml, :attrs, codes.join(', ')]
     end

data/lib/faml/attribute_optimizer.rb

@@ -4,15 +4,15 @@ require_relative 'static_hash_parser'
 
 module Faml
   class AttributeOptimizer
-    def try_optimize(text, static_id, static_class)
+    def try_optimize(old_attributes, new_attributes, static_id, static_class)
       parser = StaticHashParser.new
-      unless parser.parse("{#{text}}")
-        assert_valid_ruby_code!(text)
+      unless parser.parse("{#{new_attributes}#{old_attributes}}")
+        assert_valid_ruby_code!(old_attributes)
         return [nil, nil]
       end
 
       static_attributes, dynamic_attributes = build_optimized_attributes(parser, static_id, static_class)
-      if optimizable?(text, static_attributes, dynamic_attributes)
+      if optimizable?(old_attributes, new_attributes, static_attributes, dynamic_attributes)
         [static_attributes, dynamic_attributes]
       else
         [nil, nil]
@@ -78,7 +78,7 @@ module Faml
       dynamic_attributes
     end
 
-    def optimizable?(text, static_attributes, dynamic_attributes)
+    def optimizable?(old_attributes, new_attributes, static_attributes, dynamic_attributes)
       if static_attributes.nil?
         return false
       end
@@ -88,7 +88,9 @@ module Faml
         return false
       end
 
-      if text.include?("\n") && !dynamic_attributes.empty?
+      old_newline = old_attributes && old_attributes.include?("\n")
+      new_newline = new_attributes && new_attributes.include?("\n")
+      if (old_newline || new_newline) && !dynamic_attributes.empty?
         # XXX: Quit optimization to keep newlines
         # https://github.com/eagletmt/faml/issues/18
         return false

data/lib/faml/cli.rb

@@ -7,22 +7,25 @@ module Faml
 
     desc 'render FILE', 'Render haml template'
     option :format, type: :string, default: :html, desc: 'HTML format'
+    option :extend_helpers, type: :boolean, default: false, desc: 'Extend Faml::Helpers or not'
     def render(file)
-      code = compile_file(file, format: options[:format].to_sym)
+      code = compile_file(file, format: options[:format].to_sym, extend_helpers: options[:extend_helpers])
       puts instance_eval(code, file)
     end
 
     desc 'compile FILE', 'Compile haml template'
     option :format, type: :string, default: :html, desc: 'HTML format'
+    option :extend_helpers, type: :boolean, default: false, desc: 'Extend Faml::Helpers or not'
     def compile(file)
-      puts compile_file(file, format: options[:format].to_sym)
+      puts compile_file(file, format: options[:format].to_sym, extend_helpers: options[:extend_helpers])
     end
 
     desc 'temple FILE', 'Render temple AST'
     option :format, type: :string, default: :html, desc: 'HTML format'
+    option :extend_helpers, type: :boolean, default: false, desc: 'Extend Faml::Helpers or not'
     def temple(file)
       require 'pp'
-      pp Faml::Compiler.new(filename: file, format: options[:format].to_sym).call(parse_file(file))
+      pp Faml::Compiler.new(filename: file, format: options[:format].to_sym, extend_helpers: options[:extend_helpers]).call(parse_file(file))
     end
 
     desc 'stats FILE/DIR ...', 'Show statistics'

data/lib/faml/compiler.rb

@@ -22,6 +22,7 @@ module Faml
       preserve: DEFAULT_PRESERVE_TAGS,
       use_html_safe: false,
       filename: nil,
+      extend_helpers: false,
     )
 
     def initialize(*)
@@ -78,9 +79,12 @@ module Faml
     end
 
     def compile_root(ast)
-      [:multi, [:code, "extend ::#{helper_module.name}"]].tap do |temple|
-        compile_children(ast, temple)
+      temple = [:multi]
+      if options[:extend_helpers]
+        temple << [:code, "extend ::#{helper_module.name}"]
       end
+      compile_children(ast, temple)
+      temple
     end
 
     def helper_module

data/lib/faml/engine.rb

@@ -10,6 +10,7 @@ module Faml
     define_options(
       generator: Temple::Generators::ArrayBuffer,
       filename: nil,
+      extend_helpers: false,
     )
 
     use HamlParser::Parser

data/lib/faml/stats.rb

@@ -105,7 +105,7 @@ module Faml
         return
       end
 
-      if ast.attributes.empty?
+      if !ast.old_attributes && !ast.new_attributes
         if ast.static_class.empty? && ast.static_id.empty?
           info.empty_attribute_count += 1
         else
@@ -113,20 +113,22 @@ module Faml
         end
       else
         static_hash_parser = StaticHashParser.new
-        if static_hash_parser.parse("{#{ast.attributes}}")
+        if static_hash_parser.parse("{#{ast.new_attributes}#{ast.old_attributes}}")
           if static_hash_parser.dynamic_attributes.empty?
             info.static_attribute_count += 1
           else
             if static_hash_parser.dynamic_attributes.key?('data') || static_hash_parser.dynamic_attributes.key?(:data)
               info.dynamic_attribute_with_data_count += 1
-            elsif ast.attributes.include?("\n")
+            elsif ast.old_attributes && ast.old_attributes.include?("\n")
+              info.dynamic_attribute_with_newline_count += 1
+            elsif ast.new_attributes && ast.new_attributes.include?("\n")
               info.dynamic_attribute_with_newline_count += 1
             else
               info.dynamic_attribute_count += 1
             end
           end
         else
-          call_ast = Parser::CurrentRuby.parse("call(#{ast.attributes})")
+          call_ast = Parser::CurrentRuby.parse("call(#{ast.new_attributes}#{ast.old_attributes})")
           if call_ast.type == :send && call_ast.children[0].nil? && call_ast.children[1] == :call && !call_ast.children[3].nil?
             info.multi_attribute_count += 1
           else

data/lib/faml/version.rb

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

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

@@ -60,6 +60,13 @@ RSpec.describe 'Faml with Rails', type: :request do
   end
 
   describe 'preserve helper' do
+    around do |example|
+      extend_helpers = Faml::Engine.options[:extend_helpers]
+      Faml::Engine.options[:extend_helpers] = true
+      example.run
+      Faml::Engine.options[:extend_helpers] = extend_helpers
+    end
+
     it 'returns html_safe string' do
       get '/books/preserve'
       expect(response).to be_ok

data/spec/render/helpers_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 RSpec.describe Faml::Helpers, type: :render do
   it 'has preserve method' do
-    expect(render_string('%span!= preserve "hello\nworld !"')).to eq("<span>hello&#x000A;world !</span>\n")
+    expect(render_string('%span!= preserve "hello\nworld !"', extend_helpers: true)).to eq("<span>hello&#x000A;world !</span>\n")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faml
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-11-21 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.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -516,7 +516,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Faster implementation of Haml template language.