opulent 1.7.11 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5061edc74c0c9ad804658154bdee2efdd687b79
-  data.tar.gz: 95b9f64915a291a6aabcd7fba53315a1af05771e
+  metadata.gz: 76bdc4c7325218912ef5e71007f9d64f7342b0e9
+  data.tar.gz: 79d52447ddcbaa17c138998e278a270febf2cff5
 SHA512:
-  metadata.gz: ff8c1d53cd325d895f3b097be0a8ac18399e731bb4228a4637b3015dceedef319868ddecc5b8436d87edd2bea80ce6d72dcbfc672447781cc0639e9b61da097f
-  data.tar.gz: 3b7275cc1d75e2238967445d7a9765447fc5534b0cad6e79fa92f4d1118650cae30972b9ac33e5ffb35cd60337e4cde0fb54410215b876065e96b3ecfe4363eb
+  metadata.gz: ad0e14bd3dddc7e32ebcabcccf0696aed4cdfd79e790cdd65f866c967d3559b2da7ace8c21ce0b25a5dfe28f5dc32c3247b0d13b83d583c7a65049685971279f
+  data.tar.gz: d0ecfc90dfb792a0410fc50d7b44d6bfec78eb135b19edf6e0abdbbbc10548e0edf3d93bede9bd48225e80c4273d63cbe4a614997bc4d0b714244471fff92085

data/benchmarks/data-attribute/view.haml

@@ -1,3 +1,3 @@
 - var = {a: 1, b: 2}
-%div(data: {a: 1, b: 2})
+%div{:data => {a: 1, b: 2}}
 %div(ng: var)

data/benchmarks/methods/view.op

@@ -1,4 +1,4 @@
-/ - 10.times do |i|
-div id="test-#{i}"
-div(id="test".upcase)
-div(id="TEST".downcase)
+- 10.times do |i|
+  div id="test-#{i}"
+  div(id="test".upcase)
+  div(id="TEST".downcase)

data/benchmarks/run-benchmarks.rb

@@ -43,6 +43,7 @@ class Benchmarks
     haml_ugly.def_method(context, :run_haml_ugly)
     context.instance_eval %{
       def run_opulent_ugly; #{Opulent.new(@opulent_code).src}; end
+      def run_opulent_pretty; #{Opulent.new(@opulent_code, pretty: true).src}; end
       def run_erb; #{ERB.new(@erb_code).src}; end
       def run_erubis; #{Erubis::Eruby.new(@erb_code).src}; end
       def run_fast_erubis; #{Erubis::FastEruby.new(@erb_code).src}; end
@@ -50,10 +51,11 @@ class Benchmarks
       def run_slim_ugly; #{Slim::Engine.new.call @slim_code}; end
     }
 
-    bench(:compiled, 'opulent')     { context.run_opulent_ugly }
     bench(:compiled, 'erb')         { context.run_erb }
     bench(:compiled, 'erubis')      { context.run_erubis }
     bench(:compiled, 'fast erubis') { context.run_fast_erubis }
+    bench(:compiled, 'opulent pretty')     { context.run_opulent_pretty }
+    bench(:compiled, 'opulent ugly')     { context.run_opulent_ugly }
     bench(:compiled, 'slim pretty') { context.run_slim_pretty }
     bench(:compiled, 'slim ugly')   { context.run_slim_ugly }
     bench(:compiled, 'haml pretty') { context.run_haml_pretty }
@@ -61,7 +63,8 @@ class Benchmarks
   end
 
   def init_tilt_benches
-    tilt_opulent     = Opulent::Template.new() { @opulent_code }
+    tilt_opulent_ugly     = Opulent::Template.new() { @opulent_code }
+    tilt_opulent_pretty     = Opulent::Template.new(pretty: true) { @opulent_code }
     tilt_erb         = Tilt::ERBTemplate.new { @erb_code }
     tilt_erubis      = Tilt::ErubisTemplate.new { @erb_code }
     tilt_haml_pretty = Tilt::HamlTemplate.new(format: :html5) { @haml_code }
@@ -71,9 +74,10 @@ class Benchmarks
 
     context = Context.new
 
-    bench(:tilt, 'opulent')     { tilt_opulent.render(context) }
     bench(:tilt, 'erb')         { tilt_erb.render(context) }
     bench(:tilt, 'erubis')      { tilt_erubis.render(context) }
+    bench(:tilt, 'opulent pretty')     { tilt_opulent_pretty.render(context) }
+    bench(:tilt, 'opulent ugly')     { tilt_opulent_ugly.render(context) }
     bench(:tilt, 'slim pretty') { tilt_slim_pretty.render(context) }
     bench(:tilt, 'slim ugly')   { tilt_slim_ugly.render(context) }
     bench(:tilt, 'haml pretty') { tilt_haml_pretty.render(context) }
@@ -84,10 +88,11 @@ class Benchmarks
     context  = Context.new
     context_binding = context.instance_eval { binding }
 
-    bench(:parsing, 'opulent')     { Opulent.new(@opulent_code).render(context) }
     bench(:parsing, 'erb')         { ERB.new(@erb_code).result(context_binding) }
     bench(:parsing, 'erubis')      { Erubis::Eruby.new(@erb_code).result(context_binding) }
     bench(:parsing, 'fast erubis') { Erubis::FastEruby.new(@erb_code).result(context_binding) }
+    bench(:parsing, 'opulent pretty')     { Opulent.new(@opulent_code, pretty: true).render(context) }
+    bench(:parsing, 'opulent ugly')     { Opulent.new(@opulent_code).render(context) }
     bench(:parsing, 'slim pretty') { Slim::Template.new(pretty: true) { @slim_code }.render(context) }
     bench(:parsing, 'slim ugly')   { Slim::Template.new { @slim_code }.render(context) }
     bench(:parsing, 'haml pretty') { Haml::Engine.new(@haml_code, format: :html5).render(context) }
@@ -139,8 +144,8 @@ Compiled Tilt benchmark: Template is compiled with Tilt, which gives a more
     compilation.)
 
 Parsing benchmark: Template is parsed every time.
-    This is not the recommended way to use the template engine
-    and Slim is not optimized for it. Activate this benchmark with 'rake bench slow=1'.
+    This is not the recommended way to use the template engine because
+    performance is greatly increased when reusing the compiled source code.
 "
   end
 

data/lib/opulent/compiler.rb

@@ -42,7 +42,7 @@ module Opulent
       @inline_node = Settings::INLINE_NODE
 
       # Initialize amble object
-      @template = [[:preamble]]
+      @template = []
 
       # Incrmental counters
       @current_variable_count = 0
@@ -54,13 +54,15 @@ module Opulent
       # from the current branch level
       @node_stack = []
 
-      # The sibling stack keeps track of the sibling count from the current
-      # branch level being generated
-      @sibling_stack = []
-
       # Whenever we enter a definition compilation, add the provided blocks to
       # the current block stack. When exiting a definition, remove blocks.
       @block_stack = []
+
+      # Remember last compiled node, required for pretty printing purposes
+      @sibling_stack = [[[:root, nil]]]
+
+      # Set parent node, required for pretty printing
+      @parent_stack = []
     end
 
     # Compile input nodes, replace them with their definitions and
@@ -73,8 +75,7 @@ module Opulent
       @generator = ''
       @definitions = definitions
 
-      # Set initial parent, from which we start generating code
-      @sibling_stack << root_node[@children].size
+      @template << [:preamble]
 
       # Write all node definitions as method defs
       @definitions.each do |_, node|

data/lib/opulent/compiler/buffer.rb

@@ -59,6 +59,20 @@ module Opulent
       @template[-1][1] = @template[-1][1][0..-1 - n] if @template[-1][0] == type
     end
 
+    # Remove last n characters from the most recent template item
+    #
+    # @param type [Symbol] Remove only if last buffer part is of this type
+    # @param n [Fixnum] Number of characters to be removed
+    #
+    def buffer_remove_trailing_whitespace(type = :freeze)
+      if @template[-1][0] == type
+        n = @template[-1][1][/\s$/]
+        return if n.nil?
+
+        @template[-1][1] = @template[-1][1][0..-1 - n.size]
+      end
+    end
+
     # Turn call node attributes into a hash string
     #
     # @param attributes [Array] Array of node attributes

data/lib/opulent/compiler/eval.rb

@@ -23,11 +23,9 @@ module Opulent
       buffer_eval node[@value]
 
       # If the node has children, evaluate each one of them
-      if node[@children]
-        node[@children].each do |child|
-          root child, indent + @settings[:indent]
-        end
-      end
+      node[@children].each do |child|
+        root child, indent + @settings[:indent]
+      end if node[@children]
 
       # Check if the node is actually a block expression
       buffer_eval 'end' if node[@value] =~ Settings::END_INSERTION

data/lib/opulent/compiler/node.rb

@@ -9,10 +9,25 @@ module Opulent
     # @param indent [Fixnum] Size of the indentation to be added
     #
     def node(node, indent)
-      indentation = ' ' * indent
+      # Pretty print
+      if @settings[:pretty]
+        indentation = ' ' * indent
+        inline = Settings::INLINE_NODE.include? node[@value]
+
+        if inline
+          if @sibling_stack[-1][-1][0] == :plain
+            buffer_remove_trailing_whitespace
+          end
+        else
+          buffer_freeze indentation
+        end
+
+        @sibling_stack[-1] << [node[@type], node[@value]]
+        @sibling_stack << [[node[@type], node[@value]]]
+      end
 
       # Add the tag opening, with leading whitespace to the code buffer
-      buffer_freeze ' ' if node[@options][:leading_whitespace]
+      buffer_freeze ' ' if node[@options][:leading_whitespace] 
       buffer_freeze "<#{node[@value]}"
 
       # Evaluate node extension in the current context
@@ -28,7 +43,6 @@ module Opulent
 
       # Evaluate and generate node attributes, then process each one to
       # by generating the required attribute code
-      # attributes = {}
       buffer_attributes node[@options][:attributes],
                         extension
 
@@ -38,18 +52,54 @@ module Opulent
       if node[@options][:self_enclosing]
         # If the tag is self enclosing, it cannot have any child elements.
         buffer_freeze '>'
+
+        # Pretty print
+        buffer_freeze "\n" if @settings[:pretty]
+
+        # If we mistakenly add children to self enclosing nodes,
+        # process each child element as if it was correctly indented
+        # node[@children].each do |child|
+        #   root child, indent + @settings[:indent]
+        # end
       else
         # Set tag ending code
         buffer_freeze '>'
 
+        # Pretty print
+        if @settings[:pretty]
+          buffer_freeze "\n" if node[@children].size > 0 and !inline
+        end
+
         # Process each child element recursively, increasing indentation
         node[@children].each do |child|
           root child, indent + @settings[:indent]
         end
 
+        # Pretty print
+        if @settings[:pretty]
+          if node[@children].size > 1 &&
+            (@sibling_stack[-1][-1][0] == :plain ||
+              Settings::INLINE_NODE.include?(@sibling_stack[-1][-1][1]))
+            buffer_freeze "\n"
+          end
+
+          if node[@children].size > 0 and !inline
+            buffer_freeze indentation
+          end
+        end
+
         # Set tag closing code
         buffer_freeze "</#{node[@value]}>"
         buffer_freeze ' ' if node[@options][:trailing_whitespace]
+
+        # Pretty print
+        if @settings[:pretty]
+          buffer_freeze "\n" unless inline
+        end
+      end
+
+      if @settings[:pretty]
+        @sibling_stack.pop
       end
     end
   end

data/lib/opulent/compiler/text.rb

@@ -8,8 +8,27 @@ module Opulent
     # @param indent [Fixnum] Size of the indentation to be added
     #
     def plain(node, indent)
+      # Text value
       value = node[@options][:value]
 
+      # Pretty print
+      if @settings[:pretty]
+        indentation = ' ' * indent
+        inline = @sibling_stack[-1][-1][0] == :node &&
+                 Settings::INLINE_NODE.include?(@sibling_stack[-1][-1][1])
+
+        # Add current node to the siblings stack
+        @sibling_stack[-1] << [node[@type], node[@value]]
+
+        # If we have a text on multiple lines and the text isn't supposed to be
+        # inline, indent all the lines of the text
+        if !inline || value.split("\n").size > 1
+          value.gsub!(/^(?!$)/, indentation)
+        else
+          value.strip!
+        end
+      end
+
       # Leading whitespace
       buffer_freeze ' ' if node[@options][:leading_whitespace]
 
@@ -23,6 +42,11 @@ module Opulent
 
       # Trailing whitespace
       buffer_freeze ' ' if node[@options][:trailing_whitespace]
+
+      # Pretty print
+      if @settings[:pretty]
+        buffer_freeze "\n" unless inline
+      end
     end
   end
 end

data/lib/opulent/filters.rb

@@ -47,7 +47,7 @@ module Opulent
           @loaded = true
         rescue LoadError
           # Error output with filter name and installation instructions
-          Compiler.error :filter_load, @name, install_error
+          Logger.error :compile, :filter_load, @name, install_error
         end
       end
 

data/lib/opulent/settings.rb

@@ -60,7 +60,7 @@ module Opulent
     # Set defaults as initial settings
     #
     def initialize
-      @settings = DEFAULTS
+      @settings = DEFAULTS.clone
     end
 
     # Get an option at runtime
@@ -94,8 +94,6 @@ module Opulent
     # @param opts [Hash] Option extension hash
     #
     def update_settings(opts)
-      @settings = DEFAULTS
-
       opts.each do |key, value|
         @settings[key] = value
       end

data/lib/opulent/version.rb

@@ -1,4 +1,4 @@
 # @Opulent
 module Opulent
-  VERSION = '1.7.11'
+  VERSION = '1.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opulent
 version: !ruby/object:Gem::Version
-  version: 1.7.11
+  version: 1.8.0
 platform: ruby
 authors:
 - Alex Grozav
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler