dachsfisch 0.2.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b770b4fa107d42b19b2cccbf725b0677d63176f2bae0754e8d3b566b642ab99
-  data.tar.gz: a83446b885e9596e174f79e45337d08f97925f7bcb7ad76d8bbfa74c27a5228c
+  metadata.gz: e0a7f8e368bcd976111c9cb41cb7a2da07b47623fd9ee41d58bdd94aea5fbe75
+  data.tar.gz: 6202fd4795c0e56e438848b76ff7fb18f99f2c011b48b8ffde6ab6772865c2f7
 SHA512:
-  metadata.gz: f15b9899108feb5971a743ac490bd1107849990a7a1381c581ef46e12adabdd484f559a8a099dd13e7e5414a9251c86466a01683376a5f63d920d5c9f4c9ab54
-  data.tar.gz: 2e45884b0a96d04f39b72003e80bed357ea44d8846f470b7a46ef7da4642e29abfb8c28e17e626afd66f5010f6aeb3dede170f702cca5943ee6ae44627f01eaa
+  metadata.gz: 4708dc82596fd1a4d765dd71b58aff4ede991dcae0b26f23c14146425a3fc8576e4dde2713c4f450bd992e7686f2edd994c123e3b316cd34137c4bb93bbb260b
+  data.tar.gz: bc461fcea15fff0d9a7eaf35dd97868471ed129a2fd6843f24abffb6b96970b74a6a9de0d617ed336f6de7e6006c2336d436a5567fe017dd27bf9567e25d8b5a

data/.rubocop.yml

@@ -10,7 +10,7 @@ inherit_from:
   - .rubocop/style.yml
 
 AllCops:
-  TargetRubyVersion: 3.2
+  TargetRubyVersion: 3.3
   UseCache: True
   NewCops: enable
   Exclude:

data/Gemfile

@@ -11,6 +11,7 @@ gem 'rake'
 gem 'rspec'
 gem 'rspec-github'
 gem 'rubocop'
+gem 'rubocop-factory_bot'
 gem 'rubocop-performance'
 gem 'rubocop-rspec'
 gem 'simplecov'

data/Gemfile.lock

@@ -1,86 +1,78 @@
 PATH
   remote: .
   specs:
-    dachsfisch (0.2.0)
+    dachsfisch (1.0.2)
       nokogiri (>= 1.14.1, < 2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    base64 (0.1.1)
     coderay (1.1.3)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    json (2.6.3)
+    json (2.8.1)
     language_server-protocol (3.17.0.3)
-    method_source (1.0.0)
-    mini_portile2 (2.8.4)
-    nokogiri (1.15.4)
+    method_source (1.1.0)
+    mini_portile2 (2.8.7)
+    nokogiri (1.16.7)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    parallel (1.26.3)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.7.1)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
+      rspec-support (~> 3.13.0)
     rspec-github (2.4.0)
       rspec-core (~> 3.0)
-    rspec-mocks (3.12.6)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.56.4)
-      base64 (~> 0.1.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.68.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.19.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.24.0)
-      rubocop (~> 1.33)
-    rubocop-performance (1.19.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.24.1)
-      rubocop (~> 1.33)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
+    rubocop-ast (1.34.1)
+      parser (>= 3.3.1.0)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-performance (1.22.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (3.2.0)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
   ruby
@@ -93,9 +85,10 @@ DEPENDENCIES
   rspec
   rspec-github
   rubocop
+  rubocop-factory_bot
   rubocop-performance
   rubocop-rspec
   simplecov
 
 BUNDLED WITH
-   2.4.19
+   2.5.23

data/README.md

@@ -22,6 +22,8 @@ The rules for converting XML documents to JSON using Badgerfish are:
 - CDATA sections become properties named `#1`, `#2`, etc.
 
 Please see our [examples](spec/support/examples.rb) for more details. Those rules are derived from [this list](http://dropbox.ashlock.us/open311/json-xml/).
+Own additions:
+- The order of nodes gets saved in `@@order` (JSON is unordered per definition)
 
 ## Installation
 
@@ -53,7 +55,7 @@ json = Dachsfisch::XML2JSONConverter.perform(xml: xml)
 ### JSON-to-XML
 
 ```ruby
-json = '{ "alice": { "$" : "bob" } }'
+json = '{ "alice": { "$1": "bob", "@@order": ["$1"] }, "@@order": ["alice"] }'
 xml = Dachsfisch::JSON2XMLConverter.perform(json: json)
 ```
 

data/lib/dachsfisch/json2_xml_converter.rb

@@ -23,8 +23,8 @@ module Dachsfisch
     def add_element(xml, element)
       return unless element.is_a? Hash
 
-      element.each do |key, value|
-        add_node(xml, key, value) unless key.start_with?('@')
+      element['@@order']&.each do |key|
+        add_node(xml, key, element[key]) unless key.start_with?('@')
       end
     end
 
@@ -32,7 +32,7 @@ module Dachsfisch
       case element
         when Hash
           # underscore is used to disambiguate tag names from ruby methods
-          node = xml.send("#{key}_") { add_element(xml, element) }
+          node = xml.send(:"#{key}_") { add_element(xml, element) }
           handle_attribute_and_namespaces(node, element)
         when Array
           element.each do |sub_element|
@@ -44,7 +44,7 @@ module Dachsfisch
     end
 
     def handle_attribute_and_namespaces(node, element)
-      element.keys.filter {|element_key| element_key.start_with?('@') }.each do |attribute_key|
+      element.keys.filter {|element_key| element_key.start_with?(/@[^@]/) }.each do |attribute_key|
         if attribute_key.start_with? '@xmlns'
           element[attribute_key].each do |namespace_key, namespace|
             # add namespace of current scope to node. The root-ns($) gets 'xmlns' as key, named namespaces 'xmlns:name' respectively.

data/lib/dachsfisch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dachsfisch
-  VERSION = '0.2.0'
+  VERSION = '1.0.2'
 end

data/lib/dachsfisch/xml2_json_converter.rb

@@ -14,20 +14,27 @@ module Dachsfisch
       @fragment.elements.deconstruct.each do |root|
         result[node_name(root)] = extract_node(root)
       end
+      add_order_to_hash result
       result.to_json
     end
 
     private
 
+    def add_order_to_hash(hash)
+      return if hash.keys.reject {|key| key.start_with?('@') }.empty?
+
+      hash['@@order'] = hash.keys.reject {|key| key.start_with?('@') }
+    end
+
     def extract_node(node)
       hash = {}
       active_namespaces = add_namespaces_to_active_namespaces(node)
       hash['@xmlns'] = active_namespaces unless active_namespaces.empty?
-
       handle_attributes(hash, node)
       node.children.each do |child|
         handle_content(hash, child)
       end
+      add_order_to_hash hash
       hash
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dachsfisch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Karol
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -52,7 +52,6 @@ files:
 - README.md
 - Rakefile
 - SECURITY.md
-- dachsfisch.gemspec
 - lib/dachsfisch.rb
 - lib/dachsfisch/converter_base.rb
 - lib/dachsfisch/errors.rb
@@ -72,14 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Badgerfish implementation

data/dachsfisch.gemspec

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/dachsfisch/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'dachsfisch'
-  spec.version = Dachsfisch::VERSION
-  spec.authors = ['Karol']
-  spec.email = ['git@koehn.pro']
-
-  spec.summary = 'Badgerfish implementation'
-  spec.description = 'Implements a bidirectional converter for XML and JSON based on the badgerfish-specification'
-  spec.homepage = 'https://github.com/openHPI/dachsfisch'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.2'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
-    end
-  end
-
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) {|f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'nokogiri', '>= 1.14.1', '< 2.0.0'
-
-  spec.metadata['rubygems_mfa_required'] = 'true'
-end