dachsfisch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bddbcd258c840e0622575978329494dc4a597b6903a24fa178d927697f64a6f
+  data.tar.gz: 42d8a736a7c7fe52749ab10a2d11341635d4709d1f6e6fd96f39b67d01eab649
+SHA512:
+  metadata.gz: a1a06034a4aba42b83dc18d43e964421c971e0b881b326075fb5760499fb97cc81c73f534154a008d2e2eee47c71badacff20f455c3980212fea58e1e6fb8c6f
+  data.tar.gz: '09f10e321376aa8480b97d3763443a3e10ba1e8024256e546aaa194f178bb4ac5acabc418e46da7f2af382b40a977af61e9ed50256f78f0fe4ed66122063ec1c'

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop/layout.yml

@@ -0,0 +1,39 @@
+# layout cop settings
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: true
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+#
+# There are good reasons for key as well as table style.
+#
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Exclude:
+    - "spec/**/*"
+  Max: 140
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space

data/.rubocop/lint.yml

@@ -0,0 +1,13 @@
+# lint cop settings
+
+#
+# False positives:
+#   * expect { something }.to change { something } often triggers this
+#
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/**/*'

data/.rubocop/metrics.yml

@@ -0,0 +1,31 @@
+# metric cop settings
+
+Metrics/BlockLength:
+  Exclude:
+    # Common files with e.g. block based DSLs
+    - "spec/**/*"
+    - "**/*.rake"
+    - "Rakefile"
+    - "Guardfile"
+    - "**/*/Rakefile"
+    - 'dachsfisch.gemspec'
+  Max: 50
+
+Metrics/ClassLength:
+  Max: 150
+
+#
+# Often used as a proxy for complexity in a method, but causes many false
+# positives, e.g. when generating large, but simple, hashes.
+# We want to rely on CyclomaticComplexity instead.
+#
+Metrics/MethodLength:
+  Enabled: true
+  Max: 20
+
+#
+# This seems to be the cop that is closest to what we're interested in, which
+# is the kind of complexity that usually surfaces in deep nesting.
+#
+Metrics/CyclomaticComplexity:
+  Enabled: true

data/.rubocop/rails.yml

@@ -0,0 +1,4 @@
+# rails cop settings
+
+Rails:
+  Enabled: true

data/.rubocop/rspec.yml

@@ -0,0 +1,24 @@
+# rspec cop settings
+
+RSpec:
+  Include:
+    - "spec/**/*_spec.rb"
+    - "spec/spec_helper.rb"
+    - "spec/dachsfisch_spec.rb"
+
+#
+# Too stupid. There are also views, templates, request specs etc.
+#
+RSpec/DescribeClass:
+  Exclude:
+    - "spec/custom_matchers/*"
+
+RSpec/MultipleExpectations:
+  Exclude:
+    - "spec/custom_matchers/*"
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 5

data/.rubocop/style.yml

@@ -0,0 +1,74 @@
+# style cop settings
+
+#
+# Nein. Period. Try to keep it English, but there *will* references using
+# unicode characters.
+#
+Style/AsciiComments:
+  Enabled: false
+
+#
+# Both styles or mixtures are reasonable
+#
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  Enabled: false
+
+#
+# Maybe a bit uncommon for new devs and often results in heavily indented code
+# blocks.
+#
+Style/ConditionalAssignment:
+  Enabled: false
+
+#
+# Would be better but unlikely...
+#
+Style/Documentation:
+  Enabled: false
+
+#
+# Okay for conditions, but false positive in return statements (e.g. APIs)
+#
+Style/DoubleNegation:
+  Enabled: false
+
+#
+# Our default string token has the '%{value}' format
+#
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+#
+# Far to often easy to read without.
+#
+Style/GuardClause:
+  Enabled: false
+
+#
+# IfUnlessModifier has no own line length but we do not want it to force 120
+# chars long modifiers just because we allow a few long lines.
+#
+Style/IfUnlessModifier:
+  Enabled: false
+
+#
+# Well, we do this. To often to disable them. Studid.
+#
+Style/MultilineBlockChain:
+  Enabled: false
+
+#Style/NumericPredicate:
+#  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+inherit_from:
+  - .rubocop/layout.yml
+  - .rubocop/lint.yml
+  - .rubocop/metrics.yml
+  - .rubocop/rspec.yml
+  - .rubocop/style.yml
+
+AllCops:
+  TargetRubyVersion: 3.2
+  UseCache: True
+  NewCops: enable
+  Exclude:
+    - 'bin/*'
+    - 'vendor/**/*'
+    # Ignore local files for faster processing
+    - 'tmp/**/*'
+    - 'out/**/*'
+    - 'coverage/**/*'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+sebastian.serth@hpi.de.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dachsfisch.gemspec
+gemspec
+
+gem 'equivalent-xml'
+gem 'pry'
+gem 'rake'
+gem 'rspec'
+gem 'rspec-github'
+gem 'rubocop'
+gem 'rubocop-performance'
+gem 'rubocop-rspec'
+gem 'simplecov'

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    dachsfisch (0.1.0)
+      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)
+    equivalent-xml (0.6.0)
+      nokogiri (>= 1.4.3)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    mini_portile2 (2.8.4)
+    nokogiri (1.15.4)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-github (2.4.0)
+      rspec-core (~> 3.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      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)
+      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.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.19.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.23.2)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    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_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dachsfisch!
+  equivalent-xml
+  pry
+  rake
+  rspec
+  rspec-github
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  simplecov
+
+BUNDLED WITH
+   2.4.19

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Karol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# Dachsfisch
+
+[![Build Status](https://github.com/openHPI/dachsfisch/workflows/CI/badge.svg)](https://github.com/openHPI/dachsfisch/actions?query=workflow%3ACI)
+[![codecov](https://codecov.io/gh/openHPI/dachsfisch/branch/main/graph/badge.svg?token=K267SFJO7S)](https://codecov.io/gh/openHPI/dachsfisch)
+
+This gem offers a Ruby implementation of the [BadgerFish standard](http://www.sklar.com/badgerfish/), a set of rules for converting documents between the XML and JSON format. This gem supports conversion in both directions, specifically XML-to-JSON and JSON-to-XML.
+
+The rules for converting XML documents to JSON using Badgerfish are:
+
+- Element names become object properties.
+- Text content of elements goes in the `$` property of an object.
+- Nested elements become nested properties.
+- Multiple elements at the same level become array elements.
+- Attributes go in properties whose names begin with `@`.
+- Active namespaces for an element go in the element's `@xmlns` property.
+- The default namespace URI goes in `@xmlns.$`.
+- Other namespaces go in other properties of `@xmlns`.
+- Elements with namespace prefixes become object properties, too.
+- The `@xmlns` property goes only in objects relative to the tag where namespace was declared.
+- Text fragments in mixed contents (tags and text) become properties named `$1`, `$2`, etc.
+- Comment tags, similar to text fragments, become properties named `!1`, `!2`, etc.
+- 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/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dachsfisch', github: 'openHPI/dachsfisch'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Note: Removing support for ancient Ruby or Rails versions will not result in a new major. Please be extra careful when using ancient Ruby or Rails versions and updating gems.
+
+## Usage
+
+Based on the desired conversion, use one of the following classes. In both cases, the input is expected to be a valid string.
+
+### XML-to-JSON
+
+```ruby
+xml = '<alice>bob</alice>'
+json = Dachsfisch::XML2JSONConverter.perform(xml: xml)
+```
+
+### JSON-to-XML
+
+```ruby
+json = '{ "alice": { "$" : "bob" } }'
+xml = Dachsfisch::JSON2XMLConverter.perform(json: json)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/openHPI/dachsfisch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/openHPI/dachsfisch/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in this project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/openHPI/dachsfisch/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+To receive fixes for security vulnerabilities it is required to always upgrade to the latest version of dachsfisch. 
+See https://github.com/openHPI/dachsfisch/releases for the latest version.
+
+## Reporting a Vulnerability
+
+If you have found a vulnerability or you are uncertain whether what you have discovered is a vulnerability,
+please send an email to sebastian.serth@hpi.de ([GPG Key](https://github.com/mrserth.gpg)).
+
+If you have a patch for the issue please use `git format-patch` and attach it to the email. Please do not open an issue or 
+pull request on GitHub as that may disclose sensitive details around the vulnerability.

data/dachsfisch.gemspec

@@ -0,0 +1,32 @@
+# 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

data/lib/dachsfisch/converter_base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Dachsfisch
+  class ConverterBase
+    def self.perform(**)
+      new(**).execute
+    end
+  end
+end

data/lib/dachsfisch/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Dachsfisch
+  class DachsfischError < StandardError; end
+  class InvalidJSONInputError < DachsfischError; end
+  class InvalidXMLInputError < DachsfischError; end
+end

data/lib/dachsfisch/json2_xml_converter.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Dachsfisch
+  class JSON2XMLConverter < ConverterBase
+    def initialize(json:)
+      super()
+      @json_hash = JSON.parse json
+    rescue TypeError, JSON::ParserError => e
+      raise InvalidJSONInputError.new(e.message)
+    end
+
+    def execute
+      fragment = Nokogiri::XML::DocumentFragment.new(Nokogiri::XML::Document.new)
+
+      Nokogiri::XML::Builder.with fragment do |xml|
+        add_element xml, @json_hash
+      end
+      fragment.elements.deconstruct.map(&:to_xml).join("\n")
+    end
+
+    private
+
+    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?('@')
+      end
+    end
+
+    def add_node(xml, key, element)
+      case element
+        when Hash
+          node = xml.send(key) { add_element(xml, element) }
+          handle_attribute_and_namespaces(node, element)
+        when Array
+          element.each do |sub_element|
+            add_node xml, key, sub_element
+          end
+        else
+          add_text_node(xml, element, key[0])
+      end
+    end
+
+    def handle_attribute_and_namespaces(node, element)
+      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.
+            node["xmlns#{namespace_key == '$' ? '' : ":#{namespace_key}"}"] = namespace
+          end
+        else
+          node[attribute_key.delete_prefix('@')] = element[attribute_key]
+        end
+      end
+    end
+
+    def add_text_node(xml, element, type)
+      case type
+        when '!'
+          xml.comment element
+        when '#'
+          xml.cdata element
+        when '$'
+          xml.text element
+      end
+    end
+  end
+end

data/lib/dachsfisch/version.rb

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

data/lib/dachsfisch/xml2_json_converter.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Dachsfisch
+  class XML2JSONConverter < ConverterBase
+    def initialize(xml:)
+      super()
+      @fragment = Nokogiri::XML::DocumentFragment.parse(xml)
+      raise InvalidXMLInputError.new('input empty') if xml.nil? || xml.empty?
+      raise InvalidXMLInputError.new(@fragment.errors) if @fragment.errors.length.positive?
+    end
+
+    def execute
+      result = {}
+      @fragment.elements.deconstruct.each do |root|
+        result[node_name(root)] = extract_node(root)
+      end
+      result.to_json
+    end
+
+    private
+
+    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
+      hash
+    end
+
+    def handle_content(hash, child)
+      case child.class.to_s # use string representation because CData inherits Text
+        when 'Nokogiri::XML::Text'
+          add_text_with_custom_key(hash, child, '$')
+        when 'Nokogiri::XML::Comment'
+          add_text_with_custom_key(hash, child, '!', strip_text: false)
+        when 'Nokogiri::XML::CDATA'
+          add_text_with_custom_key(hash, child, '#', strip_text: false)
+        else
+          add_value_to_hash(hash, child)
+      end
+    end
+
+    def add_text_with_custom_key(hash, child, base_key, strip_text: true)
+      value = strip_text ? child.text.strip : child.text
+      return if value.empty? && strip_text
+
+      child_key = next_key_index hash, base_key
+      hash[child_key] = value
+    end
+
+    def add_value_to_hash(hash, child)
+      child_key = node_name(child)
+      existing_value = hash[child_key]
+      new_value = extract_node(child)
+
+      if existing_value.nil?
+        hash[child_key] = new_value
+      elsif existing_value.is_a? Array
+        existing_value << new_value
+      else
+        hash[child_key] = [existing_value, new_value]
+      end
+    end
+
+    def node_name(node)
+      node.namespace&.prefix.nil? ? node.name : "#{node.namespace.prefix}:#{node.name}"
+    end
+
+    def handle_attributes(hash, node)
+      node.attribute_nodes.each do |attribute|
+        hash["@#{attribute.name}"] = attribute.value
+      end
+    end
+
+    def add_namespaces_to_active_namespaces(node)
+      node.namespaces.transform_keys {|k| convert_namespace_key(k) }
+    end
+
+    def convert_namespace_key(key)
+      return '$' if key == 'xmlns'
+
+      key.delete_prefix 'xmlns:'
+    end
+
+    def next_key_index(hash, base_key)
+      key_count = hash.keys.count {|k| k.start_with? base_key }
+
+      "#{base_key}#{key_count + 1}"
+    end
+  end
+end

data/lib/dachsfisch.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'json'
+
+require 'dachsfisch/version'
+require 'dachsfisch/converter_base'
+require 'dachsfisch/xml2_json_converter'
+require 'dachsfisch/json2_xml_converter'
+require 'dachsfisch/errors'
+
+module Dachsfisch
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: dachsfisch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karol
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Implements a bidirectional converter for XML and JSON based on the badgerfish-specification
+email:
+- git@koehn.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop/layout.yml"
+- ".rubocop/lint.yml"
+- ".rubocop/metrics.yml"
+- ".rubocop/rails.yml"
+- ".rubocop/rspec.yml"
+- ".rubocop/style.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- SECURITY.md
+- dachsfisch.gemspec
+- lib/dachsfisch.rb
+- lib/dachsfisch/converter_base.rb
+- lib/dachsfisch/errors.rb
+- lib/dachsfisch/json2_xml_converter.rb
+- lib/dachsfisch/version.rb
+- lib/dachsfisch/xml2_json_converter.rb
+homepage: https://github.com/openHPI/dachsfisch
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.15
+signing_key:
+specification_version: 4
+summary: Badgerfish implementation
+test_files: []