nori 2.3.0 → 2.4.0

data/.travis.yml

@@ -2,12 +2,8 @@
 language: "ruby"
 script: "bundle exec rake"
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
   - 2.0
-  - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
-  - ree
+  - rbx

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2.4.0 (2014-04-19)
+
+* Change: Dropped support for ruby 1.8, rubinius and ree
+
+* Feature: Added `:convert_attributes` feature similar to `:convert_tags_to`
+
+* Feature: Added `:convert_dashes_to_underscore` option
+
 # 2.3.0 (2013-07-26)
 
 * Change: `Nori#find` now ignores namespace prefixes in Hash keys it is searching through.

data/Gemfile

@@ -1,2 +1,9 @@
 source 'https://rubygems.org'
 gemspec
+
+platform :rbx do
+  gem 'json'
+  gem 'racc'
+  gem 'rubysl'
+  gem 'rubinius-coverage'
+end

data/README.md

@@ -67,3 +67,21 @@ parser = Nori.new(:convert_tags_to => lambda { |tag| tag.snakecase.to_sym })
 xml = '<userResponse><accountStatus>active</accountStatus></userResponse>'
 parser.parse(xml)  # => { :user_response => { :account_status => "active" }
 ```
+
+Dashes and underscores
+----------------------
+
+Nori will automatically convert dashes in tag names to underscores.
+For example:
+
+```ruby
+parser = Nori.new
+parser.parse('<any-tag>foo bar</any-tag>')  # => { "any_tag" => "foo bar" }
+```
+
+You can control this behavior with the `:convert_dashes_to_underscores` option:
+
+```ruby
+parser = Nori.new(:convert_dashes_to_underscores => false)
+parser.parse('<any-tag>foo bar</any-tag>') # => { "any-tag" => "foo bar" }
+```

data/lib/nori.rb

@@ -5,7 +5,7 @@ require "nori/xml_utility_node"
 class Nori
 
   def self.hash_key(name, options = {})
-    name = name.tr("-", "_")
+    name = name.tr("-", "_") if options[:convert_dashes_to_underscores]
     name = name.split(":").last if options[:strip_namespaces]
     name = options[:convert_tags_to].call(name) if options[:convert_tags_to].respond_to? :call
     name
@@ -18,7 +18,9 @@ class Nori
       :strip_namespaces             => false,
       :delete_namespace_attributes  => false,
       :convert_tags_to              => nil,
+      :convert_attributes_to        => nil,
       :advanced_typecasting         => true,
+      :convert_dashes_to_underscores => true,
       :parser                       => :nokogiri
     }
 
@@ -45,12 +47,17 @@ class Nori
   end
 
   private
-
   def load_parser(parser)
     require "nori/parser/#{parser}"
     Parser.const_get PARSERS[parser]
   end
 
+  # Expects a +block+ which receives a tag to convert.
+  # Accepts +nil+ for a reset to the default behavior of not converting tags.
+  def convert_tags_to(reset = nil, &block)
+    @convert_tag = reset || block
+  end
+
   def validate_options!(available_options, options)
     spurious_options = options - available_options
 

data/lib/nori/core_ext/hash.rb

@@ -16,9 +16,7 @@ class Nori
       #   }.to_params
       #     #=> "name=Bob&address[city]=Ruby Central&address[phones][]=111-111-1111&address[phones][]=222-222-2222&address[street]=111 Ruby Ave."
       def to_params
-        params = self.map { |k, v| normalize_param(k,v) }.join
-        params.chop! # trailing &
-        params
+        map { |k, v| normalize_param(k,v) }.flatten.join('&')
       end
 
       # @param key<Object> The key for the param.
@@ -26,30 +24,15 @@ class Nori
       #
       # @return <String> This key value pair as a param
       #
-      # @example normalize_param(:name, "Bob Jones") #=> "name=Bob%20Jones&"
+      # @example normalize_param(:name, "Bob Jones") #=> "name=Bob%20Jones"
       def normalize_param(key, value)
-        param = ''
-        stack = []
-
         if value.is_a?(Array)
-          param << value.map { |element| normalize_param("#{key}[]", element) }.join
+          normalize_array_params(key, value)
         elsif value.is_a?(Hash)
-          stack << [key,value]
+          normalize_hash_params(key, value)
         else
-          param << "#{key}=#{URI.encode(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}&"
-        end
-
-        stack.each do |parent, hash|
-          hash.each do |key, value|
-            if value.is_a?(Hash)
-              stack << ["#{parent}[#{key}]", value]
-            else
-              param << normalize_param("#{parent}[#{key}]", value)
-            end
-          end
+          normalize_simple_type_params(key, value)
         end
-
-        param
       end
 
       # @return <String> The hash as attributes for an XML tag.
@@ -63,6 +46,28 @@ class Nori
         end.join(' ')
       end
 
+      private
+
+      def normalize_simple_type_params(key, value)
+        ["#{key}=#{encode_simple_value(value)}"]
+      end
+
+      def normalize_array_params(key, array)
+        array.map do |element|
+          normalize_param("#{key}[]", element)
+        end
+      end
+
+      def normalize_hash_params(key, hash)
+        hash.map do |nested_key, element|
+          normalize_param("#{key}[#{nested_key}]", element)
+        end
+      end
+
+      def encode_simple_value(value)
+        URI.encode(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      end
+
     end
   end
 end

data/lib/nori/core_ext/string.rb

@@ -5,9 +5,9 @@ class Nori
       # Returns the String in snake_case.
       def snakecase
         str = dup
-        str.gsub! /::/, '/'
-        str.gsub! /([A-Z]+)([A-Z][a-z])/, '\1_\2'
-        str.gsub! /([a-z\d])([A-Z])/, '\1_\2'
+        str.gsub!(/::/, '/')
+        str.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        str.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
         str.tr! ".", "_"
         str.tr! "-", "_"
         str.downcase!

data/lib/nori/version.rb

@@ -1,5 +1,3 @@
 class Nori
-
-  VERSION = "2.3.0"
-
+  VERSION = "2.4.0"
 end

data/lib/nori/xml_utility_node.rb

@@ -85,6 +85,11 @@ class Nori
       @options = options
       @name = Nori.hash_key(name, options)
 
+      if converter = options[:convert_attributes_to]
+        intermediate = attributes.map {|k, v| converter.call(k, v) }.flatten
+        attributes = Hash[*intermediate]
+      end
+
       # leave the type alone if we don't know what it is
       @type = self.class.available_typecasts.include?(attributes["type"]) ? attributes.delete("type") : attributes["type"]
 
@@ -238,16 +243,17 @@ class Nori
       attributes.merge!(:type => @type ) if @type
       "<#{name}#{attributes.to_xml_attributes}>#{@nil_element ? '' : inner_html}</#{name}>"
     end
-
     alias to_s to_html
 
   private
-
     def try_to_convert(value, &block)
       block.call(value)
     rescue ArgumentError
       value
     end
-  end
 
+    def strip_namespace(string)
+      string.split(":").last
+    end
+  end
 end

data/nori.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.license = "MIT"
 
   s.add_development_dependency "rake",     "~> 10.0"
-  s.add_development_dependency "nokogiri", ">= 1.4.0", "< 1.6"
+  s.add_development_dependency "nokogiri", ">= 1.4.0"
   s.add_development_dependency "rspec",    "~> 2.12"
 
   s.files         = `git ls-files`.split("\n")

data/spec/nori/api_spec.rb

@@ -162,6 +162,14 @@ describe Nori do
     end
   end
 
+  context "#parse with :convert_dashes_to_underscores" do
+    it "can be configured to skip dash to underscope conversion" do
+      xml = '<any-tag>foo bar</any-tag'
+      hash = nori(:convert_dashes_to_underscores => false).parse(xml)
+      hash.should == {'any-tag' => 'foo bar'}
+    end
+  end
+
   def nori(options = {})
     Nori.new(options)
   end

data/spec/nori/nori_spec.rb

@@ -460,6 +460,17 @@ describe Nori do
         end
       end
 
+      context "with convert_attributes_to set to a custom formula" do
+        it "alters attributes and values" do
+          converter = lambda {|key, value| ["#{key}_k", "#{value}_v"] }
+          xml = <<-XML
+            <user name="value"><age>21</age></user>
+          XML
+
+          parse(xml, :convert_attributes_to => converter).should == {'user' => {'@name_k' => 'value_v', 'age' => '21'}}
+        end
+      end
+
       it "should handle a single record from_xml with attributes other than type (ActiveSupport Compatible)" do
         topic_xml = <<-EOT
         <rsp stat="ok">
@@ -600,15 +611,15 @@ describe Nori do
         parse(product_xml)["product"].should == expected_product_hash
       end
 
-      it "should handle unescaping from xml (ActiveResource Compatible)" #do
-#        xml_string = '<person><bare-string>First &amp; Last Name</bare-string><pre-escaped-string>First &amp;amp; Last Name</pre-escaped-string></person>'
-#        expected_hash = {
-#          'bare_string'        => 'First & Last Name',
-#          'pre_escaped_string' => 'First &amp; Last Name'
-#        }
-#
-#        parse(xml_string)['person'].should == expected_hash
-#      end
+      it "should handle unescaping from xml (ActiveResource Compatible)" do
+       xml_string = '<person><bare-string>First &amp; Last Name</bare-string><pre-escaped-string>First &amp;amp; Last Name</pre-escaped-string></person>'
+       expected_hash = {
+         'bare_string'        => 'First & Last Name',
+         'pre_escaped_string' => 'First &amp; Last Name'
+       }
+
+       parse(xml_string)['person'].should == expected_hash
+     end
 
       it "handle an empty xml string" do
         parse('').should == {}
@@ -623,8 +634,7 @@ describe Nori do
   end
 
   def parse(xml, options = {})
-    defaults = { :parser => parser }
+    defaults = {:parser => parser}
     Nori.new(defaults.merge(options)).parse(xml)
   end
-
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: nori
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
+  prerelease: 
 platform: ruby
 authors:
 - Daniel Harrington
@@ -10,11 +11,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-26 00:00:00.000000000 Z
+date: 2014-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,6 +24,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -29,26 +32,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -56,6 +56,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -97,26 +98,27 @@ files:
 homepage: https://github.com/savonrb/nori
 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'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: nori
-rubygems_version: 2.0.6
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: XML to Hash translator
 test_files:
 - spec/nori/api_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 7a4585ff58e2073a1108c7961be22c7f3caf5c80
-  data.tar.gz: b9ab6223657d1839d7a2e4553b7d5a84452bf4c7
-SHA512:
-  metadata.gz: 432b9de3992b4d4b16a6bfa2fa2e222dbaf11f478ebac4e1f73f8c565ff8d30952a03ee65d6bdd224fb409c82972340ed25817110aeb6ec396974ff50cb11709
-  data.tar.gz: aae0fa14740a20a9f4e5419261a22ad4733da0a2b841e56dbc080bad205f7bfc98a386bb4cf674d8457e20b6e1b7a6c38af9ee4f76b64fb14cd04d4ee1e6d1a5