xmlhasher 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d51d5ef116a4b3354623bbc37795837110b22d3a
-  data.tar.gz: 16c52567fc5e14ec6dbcff34fbb9a7e3b7ce2517
+SHA256:
+  metadata.gz: bde73682245b3ba9ec69944e0dedb7488786205bf38ccfe6f64ac800fbad0f7b
+  data.tar.gz: cbf2f1830e2a7f649376e30408f78d3ef2f26c0e6cf5b1ec6f76da9ecc0e4764
 SHA512:
-  metadata.gz: 8342953c54eacbdf8cb395e8eb0b3b4c1843b4a4ddc720f238a4cb45f7db2a29802511d7396ebaa147c367b4b14c4fb501118759b270b3be689c9927f7ab000e
-  data.tar.gz: c62782286859b2462d6c061a410f295ca09710d7c642220b2906465ff9691a4ca395e331395cc67502cdb159f9e35ee8e871249e104212ca2963ccb24ef4e63d
+  metadata.gz: '08450792f4de79c0cbd56e20e023739c5c2c095ba355048501912b1736c0efe3f455aa8ff5b880ad177fff7f92863a3bb9358335ed1012ce4f891d0bf51e3979'
+  data.tar.gz: 5373d3fb4e4f0b9644ed80d6d2957576dbfe0e97645f5a54f94e625721bd8142a5b583d0997677869bfd0ac3a1ee8a90ec7bf357532d538141909df09d5f7206

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/.ruby-version

@@ -1 +1 @@
-ruby-2.3.0
+2.5.1

data/.travis.yml

@@ -1,19 +1,10 @@
 language: ruby
-bundler_args: "--without development"
-before_install:
-  - gem install bundler
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - jruby-18mode
-  - jruby-19mode
-  - rbx
-  - rbx-19mode
-  - ree
+  - 2.5.1
+  - 2.6.3
 env:
-  - JRUBY_OPTS="-Xcext.enabled=true"
+  - CI=true
 script:
+  - ./scripts/ci
   - gem build xmlhasher.gemspec
   - gem install xmlhasher-*

data/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+
+All changes to the XmlHasher gem are documented here. Releases follow semantic versioning.
+
+## [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,12 +1,14 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
-gem 'rake'
+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

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
 )
 
@@ -56,34 +60,33 @@ XmlHasher.parse("<tag1><tag2>content</tag2></tag1>")
 ```
 ## Benchmarks
 
-How fast is it?  Try it for yourself - [benchmark.rb](https://github.com/cloocher/xmlhasher/blob/master/benchmark/benchmark.rb)
+How fast is it?  Try it for yourself `rake benchmark`
 
-```
+```sh
 Converting small xml from text to Hash:
-
-                            user     system      total        real
-activesupport(rexml)     0.380000   0.000000   0.380000 (  0.385326)
-activesupport(libxml)    0.060000   0.000000   0.060000 (  0.062008)
-activesupport(nokogiri)  0.090000   0.000000   0.090000 (  0.089466)
-xmlsimple                0.480000   0.010000   0.490000 (  0.490938)
-nori                     0.120000   0.000000   0.120000 (  0.123612)
-xmlhasher                0.010000   0.000000   0.010000 (  0.017366)
+                 user     system      total        real
+activesupport(rexml)     0.196861   0.000692   0.197553 (  0.197756)
+activesupport(libxml)    0.028840   0.000176   0.029016 (  0.029037)
+activesupport(nokogiri)  0.044063   0.000516   0.044579 (  0.044618)
+xmlsimple                0.225291   0.014291   0.239582 (  0.239756)
+nori                     0.048385   0.000379   0.048764 (  0.048806)
+xmlhasher                0.011791   0.000098   0.011889 (  0.011895)
 
 Converting large xml from file to Hash:
+                 user     system      total        real
+activesupport(rexml)    25.891326   0.144542  26.035868 ( 26.052577)
+activesupport(libxml)    3.911317   0.072332   3.983649 (  3.985904)
+activesupport(nokogiri)  6.126251   0.061193   6.187444 (  6.191296)
+xmlsimple               26.128386   0.120480  26.248866 ( 26.265013)
+nori                     6.347459   0.028522   6.375981 (  6.380416)
+xmlhasher                1.738668   0.027549   1.766217 (  1.767256)
 
-                            user     system      total        real
-activesupport(rexml)    57.230000   0.240000  57.470000 ( 57.460510)
-activesupport(libxml)   # Segmentation fault
-activesupport(nokogiri) 12.650000   0.250000  12.900000 ( 12.908073)
-xmlsimple               49.980000   0.160000  50.140000 ( 50.140775)
-nori                    15.590000   0.110000  15.700000 ( 15.697411)
-xmlhasher                4.290000   0.030000   4.320000 (  4.316379)
 ```
-Note: benchmarks were generated on a Macbook Pro using Ruby 1.9.3p392
+Note: benchmarks were generated on a 2015 Macbook Pro using Ruby 2.5.1
 
 ## Requirements
 
-* Ruby 1.8.7 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,4 +9,9 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
-task :default => :test
+desc 'Run the benchmarks'
+task :benchmark do
+  system('ruby', File.join(File.dirname(__FILE__), 'benchmark', 'benchmark.rb'))
+end
+
+task default: :test

data/benchmark/benchmark.rb

@@ -1,95 +1,70 @@
-$:.push File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __dir__)
 
 require 'benchmark'
 require 'xmlhasher'
 begin
   require 'nori'
-rescue
+rescue LoadError
   puts "nori gem in not installed, run 'gem install nori'"
 end
 begin
   require 'active_support/core_ext/hash/conversions'
-rescue
+rescue LoadError
   puts "active_support gem in not installed, run 'gem install activesupport'"
 end
 begin
   require 'xmlsimple'
-rescue
+rescue LoadError
   puts "xmlsimple gem in not installed, run 'gem install xml-simple'"
 end
 begin
   require 'nokogiri'
-rescue
+rescue LoadError
   puts "nokogiri gem in not installed, run 'gem install nokogiri'"
 end
 begin
   require 'libxml'
-rescue
+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
 
-runs = 100
-xml = File.read(File.expand_path('../../test/fixtures/institution.xml', __FILE__))
-puts 'Converting small xml from text to Hash:'
-Benchmark.bm 10 do |x|
-  ActiveSupport::XmlMini.backend = ActiveSupport::XmlMini_REXML
-  x.report 'activesupport(rexml)   ' do
-    runs.times { Hash.from_xml(xml) }
-  end
+  Benchmark.bm(label_width) do |x|
+    ActiveSupport::XmlMini.backend = ActiveSupport::XmlMini_REXML
+    x.report 'activesupport(rexml)' do
+      runs.times { Hash.from_xml(xml) }
+    end
 
-  ActiveSupport::XmlMini.backend = 'LibXML'
-  x.report 'activesupport(libxml)  ' do
-    runs.times { Hash.from_xml(xml) }
-  end
+    ActiveSupport::XmlMini.backend = 'LibXML'
+    x.report 'activesupport(libxml)' do
+      runs.times { Hash.from_xml(xml) }
+    end
 
-  ActiveSupport::XmlMini.backend = 'Nokogiri'
-  x.report 'activesupport(nokogiri)' do
-    runs.times { Hash.from_xml(xml) }
-  end
+    ActiveSupport::XmlMini.backend = 'Nokogiri'
+    x.report 'activesupport(nokogiri)' do
+      runs.times { Hash.from_xml(xml) }
+    end
 
-  x.report 'xmlsimple              ' do
-    runs.times { XmlSimple.xml_in(xml) }
-  end
+    x.report 'xmlsimple' do
+      runs.times { XmlSimple.xml_in(xml) }
+    end
 
-  x.report 'nori                   ' do
-    runs.times { Nori.new(:advanced_typecasting => false).parse(xml) }
-  end
+    x.report 'nori' do
+      runs.times { Nori.new(advanced_typecasting: false).parse(xml) }
+    end
 
-  x.report 'xmlhasher              ' do
-    runs.times { XmlHasher.parse(xml) }
+    x.report 'xmlhasher' do
+      runs.times { XmlHasher.parse(xml) }
+    end
   end
 end
 
-puts
-runs = 5
-path = File.expand_path('../../test/fixtures/institutions.xml', __FILE__)
+puts 'Converting small xml from text to Hash:'
+benchmark(100, File.read(File.expand_path('../test/fixtures/institution.xml', __dir__)))
 puts 'Converting large xml from file to Hash:'
-Benchmark.bm 5 do |x|
-  ActiveSupport::XmlMini.backend = ActiveSupport::XmlMini_REXML
-  x.report 'activesupport(rexml)   ' do
-    runs.times { Hash.from_xml(File.new(path)) }
-  end
-
-  ActiveSupport::XmlMini.backend = 'LibXML'
-  x.report 'activesupport(libxml)  ' do
-    #runs.times { Hash.from_xml(File.new(path)) } # Segmentation fault
-  end
-
-  ActiveSupport::XmlMini.backend = 'Nokogiri'
-  x.report 'activesupport(nokogiri)' do
-    runs.times { Hash.from_xml(File.new(path)) }
-  end
-
-  x.report 'xmlsimple              ' do
-    runs.times { XmlSimple.xml_in(path) }
-  end
-
-  x.report 'nori                   ' do
-    runs.times { Nori.new(:advanced_typecasting => false).parse(File.new(path).read) } # Nori doesn't support reading from a stream, load the file in memory
-  end
-
-  x.report 'xmlhasher              ' do
-    runs.times { XmlHasher.parse(File.new(path)) }
-  end
-end
+benchmark(5, File.read(File.expand_path('../test/fixtures/institutions.xml', __dir__)))
+puts

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

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/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