hexp 0.3.3 → 0.4.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd5812a1b6d435382838232f4cec4d2fdb2162d2
-  data.tar.gz: eeff9a4c48a878863a8bc020d4ae37d0dd01d8ee
+  metadata.gz: 7da79589fadbf74a0c0fa19ad9f409ca9f0dc855
+  data.tar.gz: 65e4754146881f1d5a23df35ae4b4f7a964ad886
 SHA512:
-  metadata.gz: dbfde6d4249a6726cc2c492a26b14e2ad79b253844fb813eae65a1fa8eeedac4106a8dcc16155fcbe87312124448e6f6fbfb6078f151cb26eeb01dfbcbe659f1
-  data.tar.gz: 8ad112e34c87099bf467b5fa1e5a6ff5795a8d4494c24f6c2cd8074b8edb87b57dfc3bccc176fc85d20ab0bcac1b4366d0b942acf922f98e348f5c35631e8826
+  metadata.gz: 82271f2b2f56f71a71b2897b3668c7dbb2b8283a73df551d4ad6ae790e2cec806fb6901e6253c300f5bf1d2b7a4244bdbb0fde09cf3faf414df00d3fd6d1cc84
+  data.tar.gz: fd56366470868b9c0df687b945e9da1ce17e2d94fbf81b4be38a454810ca684ba1c1d5bcfcee1f28d8fe80b45320b9072bea9b8ed1269b9e93bf1b3dce0272e0

data/.gitignore

@@ -23,3 +23,4 @@ measurements/report.txt
 
 # Automatic Ruby switching
 .ruby-version
+Gemfile.lock

data/.travis.yml

@@ -1,13 +1,18 @@
+# Currently fails on JRuby, partly due to Nokogiri behaving differently,
+# and partly for some other reason I'm not sure about regarding
+# Hexp::Node::Normalize
 language: ruby
 script: "bundle exec rspec"
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - jruby
+  - jruby-head
   - ruby-head
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
+    - rvm: jruby
     - rvm: ruby-head
     - rvm: jruby-head

data/Changelog.md

@@ -1,5 +1,36 @@
 ### Development
-[full changelog](http://github.com/plexus/hexp/compare/v0.2.0...master)
+
+[full diff](http://github.com/plexus/hexp/compare/v0.3.3...master)
+
+### v0.4.0.beta1
+
+[full diff](http://github.com/plexus/hexp/compare/v0.3.3...v0.4.0.beta1)
+
+* Do our own HTML unparsing, instead of going through Nokogiri,
+  causing a big speed improvement.
+* Make H[] notation more lenient
+  * Make array around list of children optional
+    `H[:p, [H[:span, 'foo'], ' ', H[:span, 'bar']]]` =>
+    `H[:p, H[:span, 'foo'], ' ', H[:span, 'bar']]`
+  * Allow creating node lists without a wrapping node, e.g.
+    `H[H[:span, 'foo'], ' ', H[:span, 'bar']]`
+* Make Hexp::List and Hexp::TextNode respond to to_html
+* Add Hexp::Node#tag? as a complement to Hexp::Node#text?
+
+### v0.3.3
+
+[full diff](http://github.com/plexus/hexp/compare/v0.3.0...v0.3.3)
+
+* Bugfix regarding string values in attribute CSS selectors
+* Update dependencies
+
+### v0.3.0
+
+[full diff](http://github.com/plexus/hexp/compare/v0.2.0...v0.3.0)
+
+* Improved CSS selector support
+* Handle CDATA sections when parsing through Nokogiri
+* Improved documentation
 
 ### v0.2.0
 

data/Gemfile

@@ -1,8 +1,3 @@
 source 'https://rubygems.org'
 
-group :development do
-  gem 'devtools', github: 'rom-rb/devtools'
-  eval File.read('Gemfile.devtools')
-end
-
 gemspec

data/Rakefile

@@ -1,22 +1,19 @@
-require 'devtools'
 require 'rubygems/package_task'
 
-Devtools.init_rake_tasks
-
 # Redefine rake:ci:metrics to disable rubocop, will tackle that laundry list
 # some other time
-namespace :ci do
-  desc 'Run metrics (except mutant, rubocop) and spec'
-  task travis: %w[
-    metrics:coverage
-    spec:integration
-    metrics:yardstick:verify
-    metrics:flog
-    metrics:flay
-  ]
-  # metrics:reek
-  # metrics:rubocop
-end
+# namespace :ci do
+#   desc 'Run metrics (except mutant, rubocop) and spec'
+#   task travis: %w[
+#     metrics:coverage
+#     spec:integration
+#     metrics:yardstick:verify
+#     metrics:flog
+#     metrics:flay
+#   ]
+#   # metrics:reek
+#   # metrics:rubocop
+# end
 
 
 spec = Gem::Specification.load(File.expand_path('../hexp.gemspec', __FILE__))
@@ -45,3 +42,12 @@ task :doc2gh do
   sh "git push origin gh-pages"
   sh "git co master"
 end
+
+require 'mutant'
+task :default => :mutant
+
+task :mutant do
+  pattern = ENV.fetch('PATTERN', 'Hexp*')
+  result  = Mutant::CLI.run(%w[-Ilib -rhexp --use rspec --score 100] + [pattern])
+  fail unless result == Mutant::CLI::EXIT_SUCCESS
+end

data/hexp.gemspec

@@ -19,10 +19,12 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'sass', '~> 3.2.19'
   gem.add_runtime_dependency 'nokogiri', '~> 1.6'
-  gem.add_runtime_dependency 'ice_nine', '~> 0.9'
+  gem.add_runtime_dependency 'adamantium', '~> 0.2'
   gem.add_runtime_dependency 'equalizer', '~> 0.0'
 
-  gem.add_development_dependency 'rake', '~> 10.1'
-  gem.add_development_dependency 'rspec', '~> 2.14'
-  gem.add_development_dependency 'benchmark_suite', '~> 1.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'benchmark_suite'
+  gem.add_development_dependency 'mutant-rspec'
+  gem.add_development_dependency 'rspec-its'
 end

data/lib/hexp.rb

@@ -1,12 +1,15 @@
 require 'delegate'
 require 'forwardable'
+require 'pathname'
 
 require 'nokogiri' # TODO => replace with Builder
 require 'sass'
-require 'ice_nine'
+require 'adamantium'
 require 'equalizer'
 
 module Hexp
+  ROOT = Pathname(__FILE__).dirname.parent
+
   # Inject the Hexp::DSL module into classes that include Hexp
   #
   # @param [Class] klazz
@@ -19,19 +22,6 @@ module Hexp
     klazz.send(:include, Hexp::DSL)
   end
 
-  # Deep freeze an object
-  #
-  # Delegates to IceNine
-  #
-  # @param [Array] args
-  #   arguments to pass on
-  # @return [Object]
-  #
-  # @api private
-  def self.deep_freeze(*args)
-    IceNine.deep_freeze(*args)
-  end
-
   # Variant of ::Array with slightly modified semantics
   #
   # `Array()` is often used to wrap a value in an Array, unless it's already
@@ -134,3 +124,4 @@ require 'hexp/sass/selector_parser'
 require 'hexp/h'
 
 require 'hexp/builder'
+require 'hexp/unparser'

data/lib/hexp/core_ext/nil.rb

@@ -0,0 +1,9 @@
+# This file is *not* loaded by default. You have to explicitly require 'hexp/core_ext/nil'
+
+class NilClass
+  HEXP_NIL = Hexp::TextNode.new('')
+
+  def to_hexp
+    HEXP_NIL
+  end
+end

data/lib/hexp/css_selector.rb

@@ -4,6 +4,7 @@ module Hexp
     #
     module Members
       include Equalizer.new(:members)
+      include Adamantium
 
       extend Forwardable
       def_delegator :@members, :empty?
@@ -19,7 +20,7 @@ module Hexp
       #
       # @api private
       def initialize(members)
-        @members = Hexp.deep_freeze(members)
+        @members = members
       end
 
       # Create a class level collection constructor

data/lib/hexp/h.rb

@@ -1,5 +1,13 @@
 if defined?(::H) && ::H != Hexp::Node
   $stderr.puts "WARN: H is already defined, Hexp H[] shorthand not available"
 else
-  H=Hexp::Node
+  module H
+    def self.[](*args)
+      if args.first.is_a? Symbol
+        Hexp::Node[*args]
+      else
+        Hexp::List[*args]
+      end
+    end
+  end
 end

data/lib/hexp/list.rb

@@ -2,6 +2,7 @@ module Hexp
   # A list of nodes
   #
   class List < DelegateClass(Array)
+    include Adamantium
 
     # Create new Hexp::List
     #
@@ -13,7 +14,7 @@ module Hexp
     #
     # @api public
     def initialize(nodes)
-      super nodes.to_ary.freeze
+      super nodes.to_ary.map(&Node::Normalize.method(:coerce_node)).freeze
     end
 
     # Convenience constructor
@@ -82,5 +83,9 @@ module Hexp
     def eql?(other)
       self == other && self.class == other.class
     end
+
+    def to_html
+      each_with_object('') {|n,s| s << n.to_html}
+    end
   end
 end

data/lib/hexp/node.rb

@@ -53,11 +53,14 @@ module Hexp
   #
   class Node
     include Equalizer.new(:tag, :attributes, :children)
+    include Adamantium
     extend Forwardable
 
     include Hexp::Node::Attributes
     include Hexp::Node::Children
 
+    memoize :class_list
+
     # The HTML tag of this node
     #
     # @example
@@ -146,7 +149,7 @@ module Hexp
     # @api public
     #
     def to_html(options = {})
-      to_dom(options).to_html
+      Unparser.new(options).call(self)
     end
 
     # Convert this node into a Nokogiri Document
@@ -200,6 +203,10 @@ module Hexp
       false
     end
 
+    def tag?(tag)
+      self.tag == tag
+    end
+
     # Return a new node, with a different tag
     #
     # @example
@@ -318,7 +325,7 @@ module Hexp
       # @api private
       #
       def inspect_name
-        if defined?(H) && H == self
+        if defined?(H)
           'H'
         else
           self.name

data/lib/hexp/node/attributes.rb

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

data/lib/hexp/node/children.rb

@@ -72,9 +72,10 @@ module Hexp
       # @return [Hexp::Node]
       #
       # @api public
-      def set_children(new_children)
-        H[tag, attributes, new_children]
+      def content(*args)
+        H[tag, attributes, *args]
       end
+      alias set_children content
 
       # Perform an action on each child node, and replace the node with the result
       #
@@ -94,6 +95,7 @@ module Hexp
         return to_enum(:map_children) unless block_given?
         H[tag, attributes, children.map(&blk)]
       end
+
     end
   end
 end

data/lib/hexp/node/normalize.rb

@@ -11,8 +11,8 @@ module Hexp
       #     Hexp::Node::Normalize.new([:p, {class:'foo'}])
       #
       # @api public
-      def initialize(node)
-        @raw = node
+      def initialize(args)
+        @raw = args
       end
 
       # Normalize to strict hexp nodes, cfr SPEC.md for details
@@ -56,14 +56,10 @@ module Hexp
       #
       # @api private
       def children
-        last = @raw.last
-        if last.respond_to? :to_ary
-          last.to_ary
-        elsif @raw.count < 2 || last.instance_of?(Hash)
-          []
-        else
-          [last]
-        end
+        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
       end
 
       # Normalize the third element of a hexp node, the list of children
@@ -72,24 +68,24 @@ module Hexp
       #
       # @api private
       def normalized_children
-        Hexp::List[*
-          children.map do |child|
-            case child
-            when Hexp::Node, Hexp::TextNode
-              child
-            when String
-              Hexp::TextNode.new(child)
-            when ->(ch) { ch.respond_to? :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.instance_of?(Hexp::TextNode)
-              response
-            when Array
-              Hexp::Node[*child.map(&:freeze)]
-            else
-              raise FormatError, "Invalid value in Hexp literal : #{child.inspect} (#{child.class}) does not implement #to_hexp ; #{children.inspect}"
-            end
-          end
-        ]
+        Hexp::List[* children ]
+      end
+
+      def self.coerce_node(node)
+        case node
+        when Hexp::Node, Hexp::TextNode
+          node
+        when String
+          Hexp::TextNode.new(node)
+        when ->(ch) { ch.respond_to? :to_hexp }
+          response = node.to_hexp
+          raise FormatError, "to_hexp must return a Hexp::Node, got #{response.inspect}" unless response.instance_of?(Hexp::Node) || response.instance_of?(Hexp::TextNode)
+          response
+        when Array
+          Hexp::Node[*node]
+        else
+          raise FormatError, "Invalid value in Hexp literal : #{node.inspect} (#{node.class}) does not implement #to_hexp"
+        end
       end
     end
 

data/lib/hexp/nokogiri/reader.rb

@@ -20,7 +20,7 @@ module Hexp
         end
 
         recurse = ->(next_node) { call(next_node) }
-        H[node.name.to_sym, attrs, node.children.map(&recurse)]
+        H[node.name.to_sym, attrs || {}, node.children.map(&recurse)]
       end
     end
   end

data/lib/hexp/text_node.rb

@@ -7,6 +7,8 @@ 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
@@ -142,5 +144,9 @@ module Hexp
     def select(&block)
       Node::Selection.new(self, block)
     end
+
+    def to_html(opts = {})
+      Unparser.new(opts).call(self)
+    end
   end
 end

data/lib/hexp/unparser.rb

@@ -0,0 +1,73 @@
+module Hexp
+  class Unparser
+    APOS   = ?'.freeze
+    QUOT   = ?".freeze
+    LT     = '<'.freeze
+    GT     = '>'.freeze
+    SPACE  = ' '.freeze
+    EQ     = '='.freeze
+    AMP    = '&'.freeze
+    FSLASH = '/'.freeze
+
+    E_AMP  = '&amp;'.freeze
+    E_APOS = '&#x27;'.freeze
+    E_QUOT = '&quot;'.freeze
+    E_LT   = '&lt;'.freeze
+    E_GT   = '&gt;'.freeze
+
+    ESCAPE_ATTR_APOS = {AMP => E_AMP, APOS => E_APOS}
+    ESCAPE_ATTR_QUOT = {AMP => E_AMP, QUOT => E_QUOT}
+    ESCAPE_TEXT      = {AMP => E_AMP, APOS => E_APOS, QUOT => E_QUOT, LT => E_LT, GT => E_GT}
+
+    ESCAPE_ATTR_APOS_REGEX = Regexp.new("[#{ESCAPE_ATTR_APOS.keys.join}]")
+    ESCAPE_ATTR_QUOT_REGEX = Regexp.new("[#{ESCAPE_ATTR_QUOT.keys.join}]")
+    ESCAPE_TEXT_REGEX      = Regexp.new("[#{ESCAPE_TEXT.keys.join}]")
+
+    DEFAULT_OPTIONS = {
+      encoding: Encoding.default_external
+    }
+
+    def initialize(options)
+      @options = DEFAULT_OPTIONS.merge(options)
+    end
+
+    def call(node)
+      @buffer = String.new.force_encoding(@options[:encoding])
+      add_node(node)
+      @buffer.freeze
+    end
+
+    private
+
+    def add_node(node)
+      if node.text?
+        @buffer << escape_text(node)
+      else
+        add_tag(node.tag, node.attributes, node.children)
+      end
+    end
+
+    def add_tag(tag, attrs, children)
+      @buffer << LT << tag.to_s
+      unless attrs.empty?
+        attrs.each {|k,v| add_attr(k,v)}
+      end
+      @buffer << GT
+      children.each(&method(:add_node))
+      @buffer << LT << FSLASH << tag.to_s << GT
+    end
+
+    def add_attr(key, value)
+      @buffer << SPACE << key << EQ
+      add_attr_value(value)
+    end
+
+    def add_attr_value(value)
+      @buffer << APOS << value.gsub(ESCAPE_ATTR_APOS_REGEX, ESCAPE_ATTR_APOS) << APOS
+    end
+
+    def escape_text(text)
+      text.gsub(ESCAPE_TEXT_REGEX, ESCAPE_TEXT)
+    end
+  end
+end