xmlhasher 1.0.4 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0141c719c75bbae939e900964c22fc208f9dd1edcd5043d7dfa3ea1191a41d50
-  data.tar.gz: 4c598efe5871498e9fea2a12d9ecd4acd2a930c7a783a13e5b5715f03e8dc881
+  metadata.gz: dbccb044816ec6b39c01401f6e231c95e0c05dcc996b7c3d6983d50e2404ce7a
+  data.tar.gz: 2239c3929c3a49cef296a22cb7a1350cf685857ab646318ef58160fe757886bf
 SHA512:
-  metadata.gz: 81f2afb7c5cb3fa22b51f3567ef84e1c1538a92103f3b1d131ba1d1550f55e7b8e7c7fb18ad506d047cd847d5cff9b13a3bf73b60cbcaeb9d06b0a7eeb182388
-  data.tar.gz: 51242da088ffc005df4db1769582fc1a1ac7adbb7756ff9ecefa0212d54eee3ea45b30804758b230a72f824a9334034adeaa397e7d05978a0a38ac320f56f150
+  metadata.gz: 782e471f68ed17c0f676df8c7c83fb3ea2902e3767063db261e66d0782ab8536f36a596246a8170866e45545bdc587c590a1fd3a197d0c52de9512b973a8f88a
+  data.tar.gz: 65c6f0a2e9343c2e96f2c1905aa69b2efb494e1e1bba2b8318001dc92b6bd85ca849fff66a61669959757acb517ff7b4e45ce057b4209596f8164baaeebfac3b

data/.rubocop.yml

@@ -0,0 +1,30 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 200
+
+Metrics/AbcSize:
+  Max: 42
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/MethodLength:
+  Max: 60
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Style/MissingRespondToMissing:
+  Exclude:
+    - 'lib/xmlhasher.rb'
+
+Naming/VariableNumber:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: <%= ENV['CI'] != 'true' %>

data/.travis.yml

@@ -1,10 +1,10 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.2.3
-  - 2.3.0
   - 2.5.1
+  - 2.6.3
+env:
+  - CI=true
 script:
+  - ./scripts/ci
   - gem build xmlhasher.gemspec
   - gem install xmlhasher-*

data/CHANGELOG.md

@@ -0,0 +1,82 @@
+# Changelog
+
+All changes to the XmlHasher gem are documented here. Releases follow semantic versioning.
+
+## [1.0.7] - 2022-08-04
+
+- Fix deprecation warning: "EscapeUtils.unescape_html is deprecated".
+
+## [1.0.6] - 2021-03-10
+
+- Resolve gem build warnings.
+- Run tests on CI
+- Little refactoring for Node hash builder.
+- Use new ruby style guide and `rubocop` gem.
+
+## [1.0.5] - 2019-06-16
+
+- Updated ox version.
+- Fixed warning for global variable `$INPUT_RECORD_SEPARATOR`.
+- CHANGELOG.md added.
+- Use new ruby style guide and `rubocop` gem.
+- Added transform cache for keys.
+
+## [1.0.4] - 2018-09-20
+
+- Added `rake benchmark` command.
+- Enabled CDATA parsing.
+- Cleanup travis config.
+- Updated ox version.
+
+## [1.0.3] - 2018-09-20
+
+- Updated ruby version requirement.
+- Fix deprecation warning on SimpleCov::Formatter::MultiFormatter use.
+- Update dependencies.
+
+## [1.0.2] - 2016-02-20
+
+- Cleaned up support environments.
+- Updated ruby version requirement.
+
+## [1.0.1] - 2016-02-20
+
+- Bumped OX and escape_utils gem dependency versions.
+
+
+## [1.0.0] - 2016-02-20
+
+- Small changes in README.md.
+- Removed roby-head from Travis - too unstable.
+- Fixed ruby 2.2+ issue with single node parsing.
+
+## [0.0.6] - 2013-09-09
+
+- Added script for benchmarks.
+- Added 'string_keys' option to keep keys at Strings vs Symbols.
+
+## [0.0.5] - 2013-04-24
+
+- Test release (CI).
+
+## [0.0.4] - 2013-04-24
+
+- Fixed mixed children array detection.
+- Enable Coveralls.
+- Add more examples and license into README.md
+
+## [0.0.3] - 2013-04-24
+
+- Added escape method for attributes and dependency from `escape_utils` gem.
+- Some fixes for node children parsing.
+- Added more tests.
+
+## [0.0.2] - 2013-04-24
+
+- Some fixes for node children parsing.
+- Add more tests.
+- Updated gem description.
+
+## [0.0.1] - 2013-04-24
+
+- The first implementation of the XML parser.

data/Gemfile

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
+gem 'rubocop', require: false if ENV['CI']
+
 group :test do
+  gem 'coveralls', require: false
   gem 'minitest'
+  gem 'simplecov', require: false
   gem 'test-unit'
-  gem 'simplecov', :require => false
-  gem 'coveralls', :require => false
-end
+end

data/README.md

@@ -19,6 +19,10 @@ or add it to your Gemfile like this:
 gem 'xmlhasher'
 ```
 
+## Release Notes
+
+See [CHANGELOG.md](CHANGELOG.md)
+
 ## Usage
 
 ```ruby
@@ -40,7 +44,7 @@ end
 # alternatively, specify configuration options when instantiating a Parser
 parser = XmlHasher::Parser.new(
   :snakecase => true,
-  :ignore_namespaces => true
+  :ignore_namespaces => true,
   :string_keys => false
 )
 
@@ -82,7 +86,7 @@ Note: benchmarks were generated on a 2015 Macbook Pro using Ruby 2.5.1
 
 ## Requirements
 
-* Ruby 1.9.3 or higher
+* Ruby 2.0.0 or higher
 
 ## Copyright
 Copyright (c) 2013 Gene Drabkin.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
@@ -7,9 +9,9 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
-desc "Run the benchmarks"
+desc 'Run the benchmarks'
 task :benchmark do
-  system("ruby", File.join(File.dirname(__FILE__), "benchmark", "benchmark.rb"))
+  system('ruby', File.join(File.dirname(__FILE__), 'benchmark', 'benchmark.rb'))
 end
 
-task :default => :test
+task default: :test

data/benchmark/benchmark.rb

@@ -1,4 +1,6 @@
-$:.push File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __dir__)
 
 require 'benchmark'
 require 'xmlhasher'
@@ -28,7 +30,6 @@ rescue LoadError
   puts "libxml gem in not installed, run 'gem install libxml-ruby'"
 end
 
-
 def benchmark(runs, xml)
   label_width = 25 # needs to be >= any label's size
 
@@ -53,7 +54,7 @@ def benchmark(runs, xml)
     end
 
     x.report 'nori' do
-      runs.times { Nori.new(:advanced_typecasting => false).parse(xml) }
+      runs.times { Nori.new(advanced_typecasting: false).parse(xml) }
     end
 
     x.report 'xmlhasher' do
@@ -63,7 +64,7 @@ def benchmark(runs, xml)
 end
 
 puts 'Converting small xml from text to Hash:'
-benchmark(100, File.read(File.expand_path('../../test/fixtures/institution.xml', __FILE__)))
+benchmark(100, File.read(File.expand_path('../test/fixtures/institution.xml', __dir__)))
 puts 'Converting large xml from file to Hash:'
-benchmark(5, File.read(File.expand_path('../../test/fixtures/institutions.xml', __FILE__)))
+benchmark(5, File.read(File.expand_path('../test/fixtures/institutions.xml', __dir__)))
 puts

data/bin/rake

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #
@@ -7,11 +8,10 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("rake", "rake")
+load Gem.bin_path('rake', 'rake')

data/lib/xmlhasher/configurable.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 module XmlHasher
   module Configurable
-
     attr_writer :snakecase, :ignore_namespaces, :string_keys
 
-    KEYS = [:snakecase, :ignore_namespaces, :string_keys]
+    KEYS = %i[snakecase ignore_namespaces string_keys].freeze
 
     def configure
       yield self
@@ -13,8 +14,9 @@ module XmlHasher
     private
 
     def options
-      XmlHasher::Configurable::KEYS.inject({}) { |hash, key| hash[key] = instance_variable_get(:"@#{key}"); hash }
+      XmlHasher::Configurable::KEYS.each_with_object({}) do |key, hash|
+        hash[key] = instance_variable_get(:"@#{key}")
+      end
     end
-
   end
 end

data/lib/xmlhasher/handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ox'
 require 'escape_utils'
 
@@ -6,6 +8,9 @@ module XmlHasher
     def initialize(options = {})
       @options = options
       @stack = []
+      @transform_cache = {}
+
+      super()
     end
 
     def to_hash
@@ -17,9 +22,9 @@ module XmlHasher
     end
 
     def attr(name, value)
-      unless ignore_attribute?(name)
-        @stack.last.attributes[transform(name)] = escape(value) unless @stack.empty?
-      end
+      return if ignore_attribute?(name) || @stack.empty?
+
+      @stack.last.attributes[transform(name)] = escape(value)
     end
 
     def text(value)
@@ -30,7 +35,7 @@ module XmlHasher
       @stack.last.text = escape(str)
     end
 
-    def end_element(name)
+    def end_element(_name)
       if @stack.size == 1
         @hash = @stack.pop.to_hash
       else
@@ -42,14 +47,19 @@ module XmlHasher
     private
 
     def transform(name)
+      return @transform_cache[name] if @transform_cache[name]
+
+      orig_name = name
+
       name = name.to_s.split(':').last if @options[:ignore_namespaces]
       name = Util.snakecase(name) if @options[:snakecase]
-      name = name.to_sym unless @options[:string_keys]
+      name = @options[:string_keys] ? name.to_s : name.to_sym
+      @transform_cache[orig_name] = name
       name
     end
 
     def escape(value)
-      EscapeUtils.unescape_html(value)
+      CGI.unescapeHTML(value)
     end
 
     def ignore_attribute?(name)

data/lib/xmlhasher/node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module XmlHasher
   class Node
     attr_accessor :name, :attributes, :children, :text
@@ -9,20 +11,36 @@ module XmlHasher
     end
 
     def to_hash
-      h = {}
-      if text && !text.empty?
-        h[name] = text
-      else
-        h[name] = attributes.inject({}) { |r, (key, value)| r[key] = value if !value.nil? && !value.to_s.empty?; r }
-        if children.size == 1
-          h[name].merge!(children.first.to_hash)
-        else
-          h[name].merge!(children.group_by { |c| c.name }.inject({}) { |r, (k, v)| v.length == 1 ? r.merge!(v.first.to_hash) : r[k] = v.map { |c| c.to_hash[c.name] }; r })
+      node_content = content
+      { name => node_content.empty? ? nil : node_content }
+    end
+
+    private
+
+    def content
+      return text if text && !text.empty?
+
+      attributes_to_hash.merge(children_to_hash)
+    end
+
+    def attributes_to_hash
+      attributes.each_with_object({}) do |(key, value), data|
+        next if value.nil? || value.to_s.empty?
+
+        data[key] = value
+      end
+    end
+
+    def children_to_hash
+      return children.first.to_hash if children.size == 1
+
+      children.group_by(&:name).each_with_object({}) do |(key, nodes), data|
+        next data.merge!(nodes.first.to_hash) if nodes.length == 1
+
+        data[key] = nodes.map do |node|
+          node.to_hash[node.name]
         end
       end
-      h[name] = nil if h[name].empty?
-      h
     end
   end
 end
-

data/lib/xmlhasher/parser.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'stringio'
 
 module XmlHasher
   class Parser
-
     def initialize(options = {})
       @options = options
     end

data/lib/xmlhasher/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module XmlHasher
   module Util
     def self.snakecase(str)

data/lib/xmlhasher/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module XmlHasher
-  VERSION = '1.0.4'
+  VERSION = '1.0.7'
 end

data/lib/xmlhasher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xmlhasher/configurable'
 require 'xmlhasher/handler'
 require 'xmlhasher/parser'
@@ -17,9 +19,12 @@ module XmlHasher
 
     def method_missing(method_name, *args, &block)
       return super unless parser.respond_to?(method_name)
+
       parser.send(method_name, *args, &block)
     end
 
+    def respond_to_missing?(method_name, include_private = false)
+      super
+    end
   end
-
 end

data/scripts/ci

@@ -0,0 +1,26 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+init_ruby_version() {
+  echo "Using $(ruby -v)"
+  echo "$(cut -d'@' -f1 <<<"$(rvm current)")" > .ruby-version
+}
+
+run_code_quality_checks() {
+  if [[ "$(rvm current)" != *"2.0.0"* ]]; then
+    bundle exec rubocop .
+  fi
+}
+
+run_tests() {
+  bundle exec rake test
+}
+
+main() {
+  init_ruby_version &&
+    run_code_quality_checks &&
+    run_tests
+}
+
+main

data/xmlhasher.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'xmlhasher/version'
 
@@ -8,25 +9,26 @@ Gem::Specification.new do |spec|
   spec.version       = XmlHasher::VERSION
   spec.authors       = ['Gene Drabkin']
   spec.email         = ['gene.drabkin@gmail.com']
-  spec.description   = %q{Fast XML to Ruby Hash converter}
-  spec.summary       = %q{XmlHasher converts XML to Ruby Hash}
+  spec.description   = 'Fast XML to Ruby Hash converter'
+  spec.summary       = 'XmlHasher converts XML to Ruby Hash'
   spec.homepage      = 'https://github.com/cloocher/xmlhasher'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version     = '>= 1.9.3'
+  spec.required_ruby_version     = Gem::Requirement.new('>= 1.9.3')
   spec.required_rubygems_version = '>= 1.3.6'
 
-  spec.add_dependency 'ox', '~> 2.10.0'
   spec.add_dependency 'escape_utils', '~> 1.2'
+  spec.add_dependency 'ox', '~> 2.11'
 
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'minitest',  '~> 5.10'
-  spec.add_development_dependency 'test-unit', '~> 3.2'
-  spec.add_development_dependency 'simplecov', '~> 0.14.1'
+  spec.add_development_dependency 'bundler', '>= 1.6', '< 3'
   spec.add_development_dependency 'coveralls', '~> 0.8.21'
+  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'simplecov', '~> 0.14.1'
+  spec.add_development_dependency 'test-unit', '~> 3.2'
 end