hexp 0.0.1.pre3 → 0.0.1.pre4

data/Gemfile

@@ -8,4 +8,3 @@ group :development do
   gem 'json', '~> 1.8.0'
   eval File.read('Gemfile.devtools')
 end
-

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 7
-total_score: 75.0
+total_score: 94.0

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 17.4
+threshold: 29.4

data/config/reek.yml

@@ -51,7 +51,8 @@ NestedIterators:
     - any?
 NilCheck:
   enabled: true
-  exclude: []
+  exclude:
+  - Hexp::Node#rewrite
 RepeatedConditional:
   enabled: true
   exclude: []
@@ -67,8 +68,10 @@ TooManyMethods:
 TooManyStatements:
   enabled: true
   exclude:
-  - each
-  max_statements: 4
+    - each
+    - Hexp::Node#rewrite
+    - Hexp::Node::Normalize#normalized_children
+  max_statements: 5
 UncommunicativeMethodName:
   enabled: true
   exclude: []

data/config/yardstick.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 81
+threshold: 77.5

data/lib/hexp/format_error.rb

@@ -0,0 +1,8 @@
+module Hexp
+  # Raised when trying to stick things inside a Hexp where they don't belong
+  class FormatError < StandardError
+    def initialize(msg = 'You have illegal contents in your Hexp')
+      super
+    end
+  end
+end

data/lib/hexp/node.rb

@@ -39,17 +39,77 @@ module Hexp
     end
 
     def inspect
-      self.class.inspect_name + to_a.reject(&:empty?).inspect
-    end
-
-    def to_a
-      [tag, attributes, children]
+      self.class.inspect_name + [tag, attributes, children ].reject(&:empty?).inspect
     end
 
     def pp
       self.class::PP.new(self).call
     end
 
+    # Rewrite a node tree. Since nodes are immutable, this is the main entry point
+    # for deriving nodes from others.
+    #
+    # Rewrite will pass you each node in the tree, and expects something to replace
+    # it with. A single node, multiple nodes, or no nodes (remove it).
+    #
+    # Rewrite will not pass in the root node, since rewrite always returns a single
+    # node, so it doesn't allow you to replace the root node with zero or multiple
+    # nodes.
+    #
+    # The block can take one or two parameters, the first being the node that is
+    # being replaced, the second (optional) its parent. As a response the block
+    # needs to return one of these
+    #
+    #  * a single Hexp::Node
+    #  * a Hexp::NodeList, or Array of Hexp::Node
+    #  * an Array representation of a Hexp::Node, [:tag, {attributes}, [children]]
+    #  * nil
+    #
+    # The last case (returning nil) means "do nothing", it will simply keep the
+    # currently referenced node where it is. This is very handy when you only want
+    # to act on certain nodes, just return nothing if you want to do nothing.
+    #
+    # Some examples :
+    #
+    # Remove all script tags
+    #
+    #    tree.rewrite{|node| [] if node.tag == :script }
+    #
+    # Wrap each <input> tag into a <p> tag
+    #
+    #    tree.rewrite do |node|
+    #      if node.tag == :input
+    #        [ H[:p, [ child ] ]
+    #      end
+    #    end
+    #
+    # @param blk [Proc] The rewrite action
+    # @return [Hexp::Node] The rewritten tree
+    def rewrite(&blk)
+      return to_enum(:rewrite) unless block_given?
+
+      H[self.tag,
+        self.attributes,
+        self.children.flat_map {|child| child.rewrite(&blk)   }
+                     .flat_map do |child|
+          response = blk.call(child, self)
+          if response.instance_of?(Hexp::Node)
+            [ response ]
+          elsif response.respond_to?(:to_ary)
+            if response.first.instance_of?(Symbol)
+              [ response ]
+            else
+              response
+            end
+          elsif response.nil?
+            [ child ]
+          else
+            raise FormatError, "invalid rewrite response : #{response.inspect}, expected Hexp::Node or Array, got #{response.class}"
+          end
+        end
+      ]
+    end
+
     class << self
       def inspect_name
         if defined?(H) && H == self

data/lib/hexp/node/normalize.rb

@@ -71,13 +71,17 @@ module Hexp
         Hexp::List[*
           children.map do |child|
             case child
+            when Hexp::Node
+              child
             when String, TextNode
               Hexp::TextNode.new(child)
             when Array
               Hexp::Node[*child]
             else
               if child.respond_to? :to_hexp
-                Hexp::Node[*child.to_hexp]
+                response = child.to_hexp
+                raise FormatError, "to_hexp must return a Hexp::Node, got #{response.inspect}" unless response.instance_of?(Hexp::Node)
+                response
               end
             end
           end

data/lib/hexp/version.rb

@@ -1,3 +1,3 @@
 module Hexp
-  VERSION = '0.0.1.pre3'
+  VERSION = '0.0.1.pre4'
 end

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

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+describe Hexp::Node, 'rewrite' do
+  subject { hexp.rewrite(&blk) }
+  let :hexp do
+    H[:div, [
+        [:a],
+        [:p],
+        [:br]
+      ]
+    ]
+  end
+
+  context 'without a block' do
+    let(:blk) { nil }
+
+    it 'returns an Enumerator' do
+      expect(subject).to be_instance_of(Enumerator)
+    end
+  end
+
+  context 'with a block that returns [child]' do
+    let(:blk) { proc {|child, parent| [child] } }
+
+    it 'should return an identical hexp' do
+      expect(subject).to eq(hexp)
+    end
+  end
+
+  context 'with multiple nestings' do
+    let :hexp do
+      H[:span, [super()]]
+    end
+
+    let :blk do
+      proc do |child, parent|
+        @tags << [child.tag, parent.tag]
+      end
+    end
+
+    it 'should traverse depth-first' do
+      @tags = []
+      subject
+      expect(@tags).to eq([[:a, :div], [:p, :div], [:br, :div], [:div, :span]])
+    end
+  end
+
+  context 'when adding nodes' do
+    let :blk do
+      proc do |child, parent|
+        raise 'got my own node back' if child.tag == :blockquote
+        # wrap paragraphs in a <blockquote>
+        if child.tag == :p
+          [:blockquote, [child]]
+        else
+          [child]
+        end
+      end
+    end
+
+    it 'should not pass those nodes again to the block' do
+      subject.should == H[:div, [
+          [:a],
+          [:blockquote, [
+              [:p]
+            ]
+          ],
+          [:br]
+        ]
+      ]
+    end
+  end
+
+  context 'with a one parameter block' do
+    let :hexp do
+      H[:parent, [[:child]]]
+    end
+
+    let :blk do
+      proc do |child|
+        expect(child).to eq(H[:child])
+        [child]
+      end
+    end
+
+    it 'should receive the child node as its argument' do
+      subject
+    end
+  end
+
+  describe 'block response types' do
+    context 'when responding with a single node' do
+      let :blk do
+        proc do |child|
+          H[:br]
+        end
+      end
+
+      it 'should replace the existing node' do
+        expect(subject).to eq H[:div, [ [:br] ]*3 ]
+      end
+    end
+
+    context 'when responding with an array that starts with a Symbol' do
+      let :blk do
+        proc do |child|
+          [:br, {class: 'foo'} ]
+        end
+      end
+
+      it 'should treat it as a node and replace the existing one' do
+        expect(subject).to eq H[:div, [ [:br, {'class' => 'foo'}] ]*3 ]
+      end
+    end
+
+    context 'when responding with nil' do
+      let :blk do
+        proc do |node|
+          [] if node.tag == :a
+        end
+      end
+
+      it 'should keep the original node' do
+        expect(subject).to eq H[:div, [ H[:p], H[:br] ]]
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hexp
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre3
+  version: 0.0.1.pre4
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -86,6 +86,7 @@ files:
 - hexp.gemspec
 - lib/hexp.rb
 - lib/hexp/dom.rb
+- lib/hexp/format_error.rb
 - lib/hexp/h.rb
 - lib/hexp/list.rb
 - lib/hexp/node.rb
@@ -101,7 +102,7 @@ files:
 - spec/unit/hexp/node/domize_spec.rb
 - spec/unit/hexp/node/normalize_spec.rb
 - spec/unit/hexp/node/pp_spec.rb
-- spec/unit/hexp/node/to_a_spec.rb
+- spec/unit/hexp/node/rewrite_spec.rb
 - spec/unit/hexp/node/to_dom_spec.rb
 - spec/unit/hexp/node/to_hexp_spec.rb
 - spec/unit/hexp/node/to_html_spec.rb
@@ -120,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -105489159819991926
+      hash: 3015653127704886975
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -140,7 +141,7 @@ test_files:
 - spec/unit/hexp/node/domize_spec.rb
 - spec/unit/hexp/node/normalize_spec.rb
 - spec/unit/hexp/node/pp_spec.rb
-- spec/unit/hexp/node/to_a_spec.rb
+- spec/unit/hexp/node/rewrite_spec.rb
 - spec/unit/hexp/node/to_dom_spec.rb
 - spec/unit/hexp/node/to_hexp_spec.rb
 - spec/unit/hexp/node/to_html_spec.rb

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

@@ -1,8 +0,0 @@
-require 'spec_helper'
-
-describe Hexp::Node, 'to_a' do
-  subject { object.to_a }
-  let(:object) { Hexp::Node.new(:p, class: 'foo') }
-
-  it { should == [:p, {'class' => 'foo'}, Hexp::List[]] }
-end