hexp 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe165e0149eb663683b10c6bbea75d2e594171c2
-  data.tar.gz: d0678b856d53b37e98652d7a987ced5be71ae220
+  metadata.gz: 45fe82cfc464b888c41d8b632a929f6074d9b1cb
+  data.tar.gz: 9a015de7db34bd56cadf8304a940d51fea9f6d9e
 SHA512:
-  metadata.gz: 19bf3b836ac3a73e7b033d9e75c3323f85813660d56624b9f704b3d60c0ae74563c95ad6a64d77f6419330ce2592e4cecae4981e713e740ccb5e70545d37dc40
-  data.tar.gz: 7188623fe858bfe9c84f1c6c4c83061e6535cfae4bcd1558b7296d489116e4190f4a93ab5745b12fc24e18e45e48a98bbfb19749ef60a7978b3bd0ffb168899e
+  metadata.gz: ef380c391229dcb9716d9472882714ded77f5c3e0169f8ff98312a5e23bd1b61e3caed513f0e2c561e86b9e399b94ee88d0fbd7606f1ee83b353884199cff596
+  data.tar.gz: 29570e22c84b840bd04429ca27f5dc9535e3e4b080007ffda9e80f9472b61ae476ca1a4a036600c8db6f6cd9921a2be0cd44dc8c394505b7a5642874b6148454

data/.travis.yml

@@ -19,3 +19,4 @@ matrix:
     - rvm: jruby
     - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: rbx

data/Changelog.md

@@ -2,6 +2,16 @@
 
 [full diff](http://github.com/plexus/hexp/compare/v0.4.2...master)
 
+### v0.4.3
+
+Performance improvements
+
+* Introduce MutableTreeWalk to speed up css selection
+* Drop Adamantium. This means we have less of a guarantee of deep
+  immutability, but it does speed things up
+* Prevent type coercion from happening if inputs are already valid
+* Raise an exception when a node's tag is not a Symbol
+
 ### v0.4.2
 
 * Added Hexp::List#append

data/README.md

@@ -12,7 +12,7 @@
 
 # Hexp
 
-**Hexp** (pronounced [ˈɦækspi:]) is a DOM API for Ruby. It lets you treat HTML in your applications as objects, instead of strings. It is a standalone, framework independent library. You can use it to build full web pages, or to clean up your helpers and presenters.
+**Hexp** (pronounced [ˈɦækspi:]) is a DOM API for Ruby. It lets you treat HTML in your applications as objects, instead of strings. It is a standalone, framework independent library. You can use it to build full web pages, or just to clean up your helpers and presenters.
 
 ## Fundamentals
 

data/Rakefile

@@ -48,6 +48,7 @@ task :default => :mutant
 
 task :mutant do
   pattern = ENV.fetch('PATTERN', 'Hexp*')
-  result  = Mutant::CLI.run(%w[-Ilib -rhexp --use rspec --score 100] + [pattern])
+  opts    = ENV.fetch('MUTANT_OPTS', '').split(' ')
+  result  = Mutant::CLI.run(%w[-Ilib -rhexp --use rspec --score 100] + opts + [pattern])
   fail unless result == Mutant::CLI::EXIT_SUCCESS
 end

data/hexp.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'sass', '~> 3.2.19'
   gem.add_runtime_dependency 'nokogiri', '~> 1.6'
-  gem.add_runtime_dependency 'adamantium', '~> 0.2'
   gem.add_runtime_dependency 'equalizer', '~> 0.0'
   gem.add_runtime_dependency 'concord', '~> 0.0'
 

data/lib/hexp.rb

@@ -4,7 +4,6 @@ require 'pathname'
 
 require 'nokogiri'
 require 'sass'
-require 'adamantium'
 require 'equalizer'
 require 'concord'
 
@@ -126,3 +125,4 @@ require 'hexp/h'
 
 require 'hexp/builder'
 require 'hexp/unparser'
+require 'hexp/mutable_tree_walk'

data/lib/hexp/css_selector.rb

@@ -4,7 +4,6 @@ module Hexp
     #
     module Members
       include Equalizer.new(:members)
-      include Adamantium
 
       extend Forwardable
       def_delegator :@members, :empty?
@@ -106,6 +105,12 @@ module Hexp
             sequence.head_matches?(element)
         end
       end
+
+      def matches_path?(path)
+        members.any? do |sequence|
+          sequence.matches_path?(path)
+        end
+      end
     end
 
     # A single CSS sequence like 'div span .foo'
@@ -124,6 +129,24 @@ module Hexp
         members.first.matches?(element)
       end
 
+      # Warning: Highly optimized cryptic code
+      def matches_path?(path)
+        return false if path.length < members.length
+        return false unless members.last.matches?(path.last)
+
+        path_idx = path.length    - 2
+        mem_idx  = members.length - 2
+
+        until path_idx < mem_idx || mem_idx == -1
+          if members[mem_idx].matches?(path[path_idx])
+            mem_idx -= 1
+          end
+          path_idx -= 1
+        end
+
+        mem_idx == -1
+      end
+
       # Drop the first element of this Sequence
       #
       # This returns a new Sequence, with one member less.

data/lib/hexp/list.rb

@@ -2,8 +2,6 @@ module Hexp
   # A list of nodes
   #
   class List < DelegateClass(Array)
-    include Adamantium
-
     # Create new Hexp::List
     #
     # @example
@@ -14,7 +12,11 @@ module Hexp
     #
     # @api public
     def initialize(nodes)
-      super nodes.to_ary.map(&Node::Normalize.method(:coerce_node)).freeze
+      if nodes.instance_of?(List)
+        super(nodes.__getobj__).freeze
+      else
+        super nodes.to_ary.map(&Node::Normalize.method(:coerce_node)).freeze
+      end
     end
 
     # Convenience constructor

data/lib/hexp/mutable_tree_walk.rb

@@ -0,0 +1,79 @@
+module Hexp
+  class MutableTreeWalk
+    attr_reader :root, :path, :result
+
+    def initialize(root)
+      @root = root
+      @path = [root]
+      @replacements = [{}]
+      @result = nil
+    end
+
+    def next!
+      return if end?
+      if current.children.any?
+        @path << current.children.first
+        @replacements << {}
+      elsif @path.length == 1
+        @result = @path.pop
+      else
+        backtrack_and_right!
+      end
+    end
+
+    def backtrack_and_right!
+      while at_rightmost_child?
+        @path.pop
+        handle_replacements!
+        if @path.length == 1 #back at start, we're done
+          @result = @path.pop
+          return
+        end
+      end
+      go_right!
+    end
+
+    def replace!(val)
+      @replacements.last[current_idx] = val
+    end
+
+    def handle_replacements!
+      replacements = @replacements.pop
+      return if replacements.empty?
+      new_children = [*current.children]
+      replacements.each do |idx, val|
+        new_children[idx..idx] = val
+      end
+      new_node = current.set_children(new_children)
+      if @path.length == 1
+        @path = [new_node]
+      else
+        @replacements.last[current_idx] = new_node
+      end
+    end
+
+    def at_rightmost_child?
+      current.equal? parent.children.last
+    end
+
+    def go_right!
+      @path[-1] = parent.children[current_idx + 1]
+    end
+
+    def current_idx
+      parent.children.find_index { |ch| current.equal?(ch) }
+    end
+
+    def parent
+      @path[-2]
+    end
+
+    def current
+      @path.last
+    end
+
+    def end?
+      @path.empty?
+    end
+  end
+end

data/lib/hexp/node.rb

@@ -53,14 +53,12 @@ module Hexp
   #
   class Node
     include Concord::Public.new(:tag, :attributes, :children)
-    include Adamantium
     extend Forwardable
 
     include Hexp::Node::Attributes
     include Hexp::Node::Children
 
     alias attrs attributes
-    memoize :class_list
 
     # The HTML tag of this node
     #
@@ -125,7 +123,19 @@ module Hexp
     # @api public
     #
     def initialize(*args)
-      super(*Normalize.new(args).call)
+      tag_ok   = args[0].instance_of?(Symbol)
+      raise "The tag of node should be a Symbol" unless tag_ok
+
+      attrs_ok = args[1].instance_of?(Hash) &&
+                 args[1].all? {|k,v| k.instance_of?(String) && v.instance_of?(String) }
+
+      if attrs_ok && args[2].instance_of?(List)
+        super(args[0], args[1], args[2])
+      elsif attrs_ok && args[2].instance_of?(Array)
+        super(args[0], args[1], List.new(args[2]))
+      else
+        super(*Normalize.new(args).call)
+      end.freeze
     end
 
     # Standard hexp coercion protocol, return self

data/lib/hexp/node/attributes.rb

@@ -88,7 +88,7 @@ module Hexp
       #
       # @api public
       def class_list
-        (attr('class') || '').split(' ')
+        @class_list ||= (attr('class') || '').split(' ')
       end
 
       # Remove a CSS class from this element

data/lib/hexp/node/css_selection.rb

@@ -73,10 +73,15 @@ module Hexp
       def each(&block)
         return to_enum(:each) unless block_given?
 
-        @node.children.each do |child|
-          next_selection_for(child).each(&block)
+        walk = MutableTreeWalk.new(@node)
+
+        until walk.end?
+          if comma_sequence.matches_path?(walk.path)
+            yield walk.current
+          end
+          walk.next!
         end
-        yield @node if node_matches?
+
         self
       end
 
@@ -91,14 +96,16 @@ module Hexp
       def rewrite(&block)
         return @node if @node.text?
 
-        new_node = H[
-          @node.tag,
-          @node.attributes,
-          @node.children.flat_map do |child|
-            next_selection_for(child).rewrite(&block)
+        walk = MutableTreeWalk.new(@node)
+
+        until walk.end?
+          if comma_sequence.matches_path?(walk.path)
+            walk.replace!(block.call(walk.current))
           end
-        ]
-        node_matches? ? block.call(new_node) : new_node
+          walk.next!
+        end
+
+        walk.result
       end
 
       private
@@ -131,49 +138,6 @@ module Hexp
         comma_sequence.matches?(@node)
       end
 
-      # Consume the matching part of the comma sequence, return the rest
-      #
-      # Returns a new comma sequence with the parts removed that have been
-      # consumed by matching against this node. If no part matches, returns nil.
-      #
-      # @return [Hexp::CssSelector::CommaSequence]
-      #
-      # @api private
-      def next_comma_sequence
-        @next_comma_sequence ||= CssSelector::CommaSequence.new(consume_matching_heads)
-      end
-
-      # Recurse down a child down, passing in the remaining part of the selector
-      #
-      # @param [Hexp::Node] child
-      #   One of the children of the node in this selection object
-      #
-      # @return [Hexp::Node::CssSelection]
-      #
-      # @api private
-      def next_selection_for(child)
-        self.class.new(child, next_comma_sequence)
-      end
-
-      # For each sequence in the comma sequence, remove the head if it matches
-      #
-      # For example, if this node is a `H[:div]`, and the selector is
-      # `span.foo, div a[:href]`, then the result of this method will be
-      # `span.foo, a[:href]`. This can then be used to match any child nodes.
-      #
-      # @return [Hexp::CssSelector::CommaSequence]
-      #
-      # @api private
-      def consume_matching_heads
-        comma_sequence.members.flat_map do |sequence|
-          if sequence.head_matches? @node
-            [sequence, sequence.drop_head]
-          else
-            [sequence]
-          end
-        end.reject(&:empty?)
-      end
-
     end
   end
 end

data/lib/hexp/node/normalize.rb

@@ -43,6 +43,7 @@ module Hexp
       #
       # @api private
       def normalized_attributes
+        return attributes if attributes.all? {|k,v| k.instance_of?(String) && v.instance_of?(String) }
         Hash[*
           attributes.flat_map do |key, value|
             [key, value].map(&:to_s)
@@ -56,10 +57,12 @@ module Hexp
       #
       # @api private
       def children
-        children = @raw.drop(1)
-        children = children.drop(1)      if children.first.instance_of?(Hash)
-        children = children.first.to_ary if children.first.respond_to?(:to_ary)
-        children
+        start = @raw[1].instance_of?(Hash) ? 2 : 1
+        if @raw[start].respond_to?(:to_ary)
+          @raw[start].to_ary
+        else
+          @raw.drop(start)
+        end
       end
 
       # Normalize the third element of a hexp node, the list of children
@@ -68,7 +71,11 @@ module Hexp
       #
       # @api private
       def normalized_children
-        Hexp::List[* children ]
+        if children.instance_of?(Hexp::List)
+          children
+        else
+          Hexp::List.new( children )
+        end
       end
 
       def self.coerce_node(node)

data/lib/hexp/text_node.rb

@@ -7,8 +7,6 @@ module Hexp
   # converted to `TextNode` instances, so there is usually no reason to instantiate
   # these yourself.
   class TextNode < DelegateClass(String)
-    include Adamantium
-
     # Inspect the TextNode
     #
     # This delegates to the underlying String, making it

data/lib/hexp/version.rb

@@ -1,3 +1,3 @@
 module Hexp
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

data/spec/unit/hexp/mutable_tree_walk_spec.rb

@@ -0,0 +1,72 @@
+RSpec.describe Hexp::MutableTreeWalk do
+
+  let(:node) { H[:ul, H[:p, [H[:li, 'foo', 'boo'], H[:li, 'bar']]]] }
+  let(:walk) { Hexp::MutableTreeWalk.new(node) }
+
+  it 'should start at the root' do
+    expect(walk.current).to eql node
+  end
+
+  it 'should not have a parent at the root' do
+    expect(walk.parent).to be_nil
+  end
+
+  it 'should descend to the children' do
+    walk.next!
+    expect(walk.current).to eql  H[:p, [H[:li, ["foo", "boo"]], H[:li, ["bar"]]]]
+  end
+
+  it 'should go depth first' do
+    2.times { walk.next! }
+    expect(walk.current).to eql  H[:li, 'foo', 'boo']
+  end
+
+  it 'should also do text nodes' do
+    3.times { walk.next! }
+    expect(walk.current).to eq 'foo'
+  end
+
+  it 'should go left to right' do
+    4.times { walk.next! }
+    expect(walk.current).to eq 'boo'
+  end
+
+  it 'should go back up and right' do
+    5.times { walk.next! }
+    expect(walk.current).to eql H[:li, 'bar']
+  end
+
+  it 'should finish on nil' do
+    7.times { walk.next! }
+    expect(walk.current).to be_nil
+    expect(walk.end?).to be true
+  end
+
+  it 'stays at the end' do
+    8.times { walk.next! }
+    expect(walk.end?).to be true
+  end
+
+  it 'should allow replacements' do
+    2.times { walk.next! }
+    walk.replace! H[:foo]
+    6.times { walk.next! }
+    expect(walk.result).to eql H[:ul, H[:p, H[:foo], H[:li, 'bar']]]
+  end
+
+  it 'should allow replacements' do
+    7.times do
+      walk.next!
+      if !walk.end? && !walk.current.text? && walk.current.tag?(:li)
+        walk.replace! H[:span, walk.current]
+      end
+    end
+
+    expect(walk.result).to eql H[:ul,
+                                 H[:p,
+                                   H[:span, H[:li, 'foo', 'boo']],
+                                   H[:span, H[:li, 'bar']]]]
+  end
+
+
+end

data/spec/unit/hexp/node/css_selection_spec.rb

@@ -18,7 +18,7 @@ describe Hexp::Node::CssSelection do
       let(:hexp) { H[:span, {id: 'span-1'}, H[:span, id: 'span-2']] }
 
       it 'should match all nodes of that tag' do
-        expect(selection.to_a).to eq [ H[:span, id: 'span-2'], hexp ]
+        expect(selection.to_a).to eq [ hexp, H[:span, id: 'span-2'] ]
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexp
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-04 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: adamantium
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: equalizer
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +179,7 @@ files:
 - lib/hexp/errors.rb
 - lib/hexp/h.rb
 - lib/hexp/list.rb
+- lib/hexp/mutable_tree_walk.rb
 - lib/hexp/node.rb
 - lib/hexp/node/attributes.rb
 - lib/hexp/node/children.rb
@@ -222,6 +209,7 @@ files:
 - spec/unit/hexp/dsl_spec.rb
 - spec/unit/hexp/h_spec.rb
 - spec/unit/hexp/list_spec.rb
+- spec/unit/hexp/mutable_tree_walk_spec.rb
 - spec/unit/hexp/node/attr_spec.rb
 - spec/unit/hexp/node/attributes_spec.rb
 - spec/unit/hexp/node/children_spec.rb
@@ -280,6 +268,7 @@ test_files:
 - spec/unit/hexp/dsl_spec.rb
 - spec/unit/hexp/h_spec.rb
 - spec/unit/hexp/list_spec.rb
+- spec/unit/hexp/mutable_tree_walk_spec.rb
 - spec/unit/hexp/node/attr_spec.rb
 - spec/unit/hexp/node/attributes_spec.rb
 - spec/unit/hexp/node/children_spec.rb