hexp 0.2.0 → 0.3.0

data/lib/hexp/node/rewriter.rb

@@ -8,10 +8,26 @@ module Hexp
     class Rewriter
       include Hexp
 
+      # Initialize a rewriter with the node to operate on, and the action
+      #
+      # @param [Hexp::Node] node
+      #   The root node of the tree to be altered
+      # @param [Proc] block
+      #   The action to perform on each node
+      #
+      # @api public
       def initialize(node, block)
         @node, @block = node, block
       end
 
+      # Implicit Hexp conversion protocol
+      #
+      # A {Rewriter} is lazy, only when one of the {Hexp::DSL} methods is used,
+      # does the rewriting happen.
+      #
+      # @return [Hexp::Node]
+      #
+      # @api public
       def to_hexp
         @hexp ||= H[
           @node.tag,
@@ -24,16 +40,25 @@ module Hexp
 
       # Helper for rewrite
       #
-      # @param blk [Proc] the block for rewriting
       # @return [Array<Hexp::Node>]
-      # @api private
       #
+      # @api private
       def rewrite_children
         @node.children
-          .flat_map {|child| child.rewrite &@block   }
+          .flat_map {|child| child.rewrite(&@block)   }
           .flat_map {|child| coerce_rewrite_response(@block.(child.to_hexp, @node)) || [child] }
       end
 
+      # Turn the response of a rewrite operation into something value
+      #
+      # The response can be a list of nodes, or a single node. If the response is
+      # `nil`, that is interpreted as removing the node.
+      #
+      # @param [nil,#to_hexp,#to_str,#to_ary] response
+      #
+      # @return [Array<Hexp::Node>]
+      #
+      # @api private
       def coerce_rewrite_response(response)
         return [] if response.nil?
 

data/lib/hexp/node/{selector.rb → selection.rb}

@@ -1,6 +1,6 @@
 module Hexp
   class Node
-    # Select nodes from a Hexp tree
+    # Subset of nodes from a Hexp tree
     #
     # This is what is backing the {Hexp::Node#select} method. It serves a double
     # purpose. At it's core it's an Enumerable for iterating over nodes that
@@ -17,13 +17,32 @@ module Hexp
     #   # stick all links inside a <span class="link> ... </span>
     #   hexp.select {|el| el.tag == 'a' }.wrap(:span, class: 'link')
     #
-    class Selector
+    class Selection
       include Enumerable
 
+      # Initialize a selection with the root node, and the selection block used
+      # as the filtering criterion
+      #
+      # @param [Hexp::Node] node
+      #   The root of the tree to select in
+      #
+      # @param [Proc] block
+      #   A block that for a given node returns a truthy or falsey value
+      #
+      # @api private
       def initialize(node, block)
         @node, @select_block = node, block
       end
 
+      # Replace matching nodes
+      #
+      # Analogues to the main {Hexp::Node#rewrite} operation.
+      #
+      # @yieldparam [Hexp::Node]
+      #
+      # @return [Hexp::Node]
+      #
+      # @api public
       def rewrite(&block)
         @node.rewrite do |node, parent|
           if @select_block.(node)
@@ -34,18 +53,45 @@ module Hexp
         end
       end
 
+      # Set an attribute on all matching nodes
+      #
+      # @param [#to_s] name
+      #   The attribute name
+      # @param [#to_s] value
+      #   The attribute value
+      #
+      # @return [Hexp::Node]
+      #   The new tree
+      #
+      # @api public
       def attr(name, value)
         rewrite do |node|
           node.attr(name, value)
         end
       end
 
+      # Wrap each matching node in a specific node
+      #
+      # @param [Symbol] tag
+      #   The tag of the wrapping node
+      # @paeam [Hash] attributes
+      #   The attributes of the node
+      #
+      # @return [Hexp::Node]
+      #   The new tree of nodes
+      #
+      # @api public
       def wrap(tag, attributes = {})
         rewrite do |node|
           H[tag, attributes, [node]]
         end
       end
 
+      # Yield each matching node
+      #
+      # @yieldparam [Hexp::Node]
+      #
+      # @api public
       def each(&block)
         return to_enum(:each) unless block_given?
 

data/lib/hexp/nokogiri/reader.rb

@@ -10,7 +10,7 @@ module Hexp
       # @api public
       #
       def call(node)
-        return node.text if node.text?
+        return node.text if node.text? || node.cdata?
 
         unless node.attributes.empty?
           attrs = node.attributes.map do |key, value|
@@ -19,7 +19,7 @@ module Hexp
           attrs = Hash[attrs]
         end
 
-        recurse = ->(node) { call(node) }
+        recurse = ->(next_node) { call(next_node) }
         H[node.name.to_sym, attrs, node.children.map(&recurse)]
       end
     end

data/lib/hexp/text_node.rb

@@ -140,7 +140,7 @@ module Hexp
     end
 
     def select(&block)
-      Node::Selector.new(self, block)
+      Node::Selection.new(self, block)
     end
   end
 end

data/lib/hexp/version.rb

@@ -1,3 +1,3 @@
 module Hexp
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/unit/hexp/css_selector/universal_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe  Hexp::CssSelector::Universal do
+  it 'should match everything' do
+    expect(subject.matches? H[:section]).to be_true
+  end
+end

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

@@ -63,4 +63,16 @@ describe Hexp::Node::Domize do
 
     it { should_not dom_eq(dom) }
   end
+
+  context 'with the :html5 option' do
+    let(:hexp) { Hexp::Node[:html] }
+
+    it 'should set a HTML5 style doctype' do
+      dtd = hexp.to_dom(html5: true).children.first
+      expect(dtd).to be_a Nokogiri::XML::DTD
+      expect(dtd.name).to be_nil
+      expect(dtd.external_id).to be_nil
+      expect(dtd.system_id).to be_nil
+    end
+  end
 end

data/spec/unit/hexp/node/{selector_spec.rb → selection_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-describe Hexp::Node::Selector do
-  subject(:selector) { Hexp::Node::Selector.new(hexp, block) }
+describe Hexp::Node::Selection do
+  subject(:selection) { Hexp::Node::Selection.new(hexp, block) }
   let(:yielded_elements) { [] }
   let(:block) { proc {|el| yielded_elements << el } }
   let(:hexp) { H[:div, [[:span]]] }
@@ -10,7 +10,7 @@ describe Hexp::Node::Selector do
     let(:block) { proc {|el| el.tag == :span} }
 
     it 'should enumerate elements for which the block returns trueish' do
-      expect(selector.to_a).to eq [H[:span]]
+      expect(selection.to_a).to eq [H[:span]]
     end
   end
 
@@ -18,7 +18,7 @@ describe Hexp::Node::Selector do
     let(:block) { proc {|el| el.tag == :span} }
 
     it 'should perform them on elements that match' do
-      expect(selector.attr('class', 'matched').to_hexp).to eq(
+      expect(selection.attr('class', 'matched').to_hexp).to eq(
         H[:div, [[:span, {class: 'matched'}]]]
       )
     end
@@ -28,7 +28,7 @@ describe Hexp::Node::Selector do
       let(:block) { proc {|el| el.tag == :a} }
 
       it 'should be able to wrap element' do
-        expect(selector.wrap(:li).to_hexp).to eq(
+        expect(selection.wrap(:li).to_hexp).to eq(
            H[:ul, [[:li, H[:a, href: 'foo']], [:li, H[:a, href: 'bar']]]]
         )
       end
@@ -39,7 +39,7 @@ describe Hexp::Node::Selector do
       let(:block) { proc {|el| el.tag == :a} }
 
       it 'should work on matching elements, and skip the rest' do
-        expect(selector.rewrite{ H[:br] }.to_hexp).to eq H[:ul, [[:br], [:span]]]
+        expect(selection.rewrite{ H[:br] }.to_hexp).to eq H[:ul, [[:br], [:span]]]
       end
     end
   end
@@ -49,12 +49,12 @@ describe Hexp::Node::Selector do
 
     it 'should be lazy' do
       expect(block).to_not receive(:call)
-      selector
+      selection
     end
 
     it 'should yield the root element when realized' do
       expect(block).to receive(:call).once.with(H[:div])
-      selector.each {}
+      selection.each {}
     end
   end
 
@@ -65,7 +65,7 @@ describe Hexp::Node::Selector do
           [:span, "world"]]]}
 
     it 'should traverse the whole tree once, depth-first' do
-      selector.each {}
+      selection.each {}
       expect(yielded_elements).to eq [
         Hexp::TextNode.new("hello"),
         H[:span, "hello"],

data/spec/unit/hexp/parse_spec.rb

@@ -20,4 +20,14 @@ describe Hexp, 'parse' do
   it 'should parse attributes' do
     expect(Hexp.parse('<a href="pretty">Ciao Bella</a>')).to eq H[:a, {href: 'pretty'}, 'Ciao Bella']
   end
+
+  it 'should parse style tags' do
+    expect(Hexp.parse('<html><head><style type="text/css">h1 {font-weigth: 400;}</style></head></html>')).to eq(
+      H[:html,
+        H[:head,
+          H[:style, {type: 'text/css'}, 'h1 {font-weigth: 400;}']
+        ]
+      ]
+    )
+  end
 end

metadata

@@ -1,112 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: hexp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Arne Brasseur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-18 00:00:00.000000000 Z
+date: 2014-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: sass
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
-  prerelease: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: nokogiri
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-  prerelease: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: ice_nine
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.8'
-  prerelease: false
+        version: '0.9'
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: equalizer
-  type: :runtime
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
-  prerelease: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: rake
-  type: :development
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.1'
-  prerelease: false
 - !ruby/object:Gem::Dependency
+  prerelease: false
   name: rspec
-  type: :development
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
   prerelease: false
+  name: benchmark_suite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: HTML expressions
 email:
 - arne@arnebrasseur.net
@@ -117,14 +118,15 @@ extra_rdoc_files:
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - Changelog.md
 - Gemfile
 - Gemfile.devtools
 - Gemfile.lock
-- LICENSE.md
+- LICENSE
 - README.md
 - Rakefile
-- SPEC.md
+- bench/node/rewrite_bench.rb
 - config/devtools.yml
 - config/flay.yml
 - config/flog.yml
@@ -157,13 +159,12 @@ files:
 - lib/hexp/node/normalize.rb
 - lib/hexp/node/pp.rb
 - lib/hexp/node/rewriter.rb
-- lib/hexp/node/selector.rb
+- lib/hexp/node/selection.rb
 - lib/hexp/nokogiri/equality.rb
 - lib/hexp/nokogiri/reader.rb
 - lib/hexp/sass/selector_parser.rb
 - lib/hexp/text_node.rb
 - lib/hexp/version.rb
-- notes
 - spec/integration/literal_syntax_spec.rb
 - spec/shared_helper.rb
 - spec/spec_helper.rb
@@ -174,6 +175,7 @@ files:
 - spec/unit/hexp/css_selector/element_spec.rb
 - spec/unit/hexp/css_selector/parser_spec.rb
 - spec/unit/hexp/css_selector/simple_sequence_spec.rb
+- spec/unit/hexp/css_selector/universal_spec.rb
 - spec/unit/hexp/dsl_spec.rb
 - spec/unit/hexp/h_spec.rb
 - spec/unit/hexp/list_spec.rb
@@ -186,7 +188,7 @@ files:
 - spec/unit/hexp/node/normalize_spec.rb
 - spec/unit/hexp/node/pp_spec.rb
 - spec/unit/hexp/node/rewrite_spec.rb
-- spec/unit/hexp/node/selector_spec.rb
+- spec/unit/hexp/node/selection_spec.rb
 - spec/unit/hexp/node/text_spec.rb
 - spec/unit/hexp/node/to_dom_spec.rb
 - spec/unit/hexp/node/to_hexp_spec.rb
@@ -199,33 +201,26 @@ files:
 homepage: https://github.com/plexus/hexp
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1985616243020717322
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1985616243020717322
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: HTML expressions
 test_files:
 - spec/integration/literal_syntax_spec.rb
@@ -238,6 +233,7 @@ test_files:
 - spec/unit/hexp/css_selector/element_spec.rb
 - spec/unit/hexp/css_selector/parser_spec.rb
 - spec/unit/hexp/css_selector/simple_sequence_spec.rb
+- spec/unit/hexp/css_selector/universal_spec.rb
 - spec/unit/hexp/dsl_spec.rb
 - spec/unit/hexp/h_spec.rb
 - spec/unit/hexp/list_spec.rb
@@ -250,7 +246,7 @@ test_files:
 - spec/unit/hexp/node/normalize_spec.rb
 - spec/unit/hexp/node/pp_spec.rb
 - spec/unit/hexp/node/rewrite_spec.rb
-- spec/unit/hexp/node/selector_spec.rb
+- spec/unit/hexp/node/selection_spec.rb
 - spec/unit/hexp/node/text_spec.rb
 - spec/unit/hexp/node/to_dom_spec.rb
 - spec/unit/hexp/node/to_hexp_spec.rb