xtj 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bffd71e881a2d7876585c478e6d4c4808302275eb852a18dbee7dedeb26c798e
+  data.tar.gz: b88148ec4ecb2734b4cc0c03238e149ab2b00de7300657d4462f548f5825c570
+SHA512:
+  metadata.gz: b239afa2eee385bcaf6315622ffaf3bd9fa19141b5636c24aa949c840d106c2afd521991684e57c0674c2a9768603be0c703019323668864ca762efda1731ca8
+  data.tar.gz: 5b895fbda18c6f876be16e89850fbb473a58db673253a35d0e91b7c18089427758d73cea474c749e574099fc9b4429871e2746dc4f39b750d9d4a6665dfcf1f5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - Gemfile
+    - '*.gemspec'
+    - 'spec/**/*_spec.rb'
+    - 'vendor/**/*'
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+before_install: gem install bundler -v 1.17.2
+script:
+  - bundle exec rspec spec
+  - bundle exec rubocop

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at grzegorz.jakubiak@outlook.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in xtj.gemspec
+gemspec
+
+gem 'sorbet', :group => :development
+gem 'sorbet-runtime'
+
+group :lint do
+  gem 'rubocop', '~> 0.74.0', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    XTJ (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.3)
+    parallel (1.17.0)
+    parser (2.6.4.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    sorbet (0.4.4723)
+      sorbet-static (= 0.4.4723)
+    sorbet-runtime (0.4.4723)
+    sorbet-static (0.4.4723-universal-darwin-14)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  XTJ!
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.74.0)
+  sorbet
+  sorbet-runtime
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Grzegorz Jakubiak
+
+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,54 @@
+# XTJ
+
+[![Build Status](https://travis-ci.org/grzegorz-jakubiak/xtj.svg?branch=master)](https://travis-ci.org/grzegorz-jakubiak/xtj)
+
+Allows for conversion of an `XML` file into Ruby `Hash` or `JSON`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xtj'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xtj
+
+## Usage
+
+```ruby
+require 'xtj'
+
+xml_document = XTJ::Document.new(<xml_document_string>)
+
+file = File.new(<xml_document_path>)
+xml_document = XTJ::Document.new(file)
+
+xml_document.to_hash
+xml_document.to_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 tags, 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/[USERNAME]/xtj. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 the XTJ project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/xtj/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'xtj'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xtj/handlers/xml_handler.rb

@@ -0,0 +1,47 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'rexml/sax2listener'
+
+module XTJ
+  module Handlers
+    class XMLHandler
+      include REXML::SAX2Listener
+      include XTJ::Tags
+      attr_reader :xml_hash
+
+      def initialize
+        @xml_hash = {}
+        @stack = []
+      end
+
+      def start_element(_uri, _localname, qname, attributes)
+        prefixed_attributes = attributes
+                              .transform_keys { |key| "_#{key}".to_sym }
+        element = XMLTag.new(tag: qname.to_sym, attributes: prefixed_attributes)
+        @stack.prepend(element)
+      end
+
+      def end_element(_uri, _localname, _qname)
+        if @stack.length > 1
+          child = @stack.shift
+          parent = @stack.shift
+          parent.add_to_attributes(child.tag, child.attributes)
+          @stack.prepend(parent)
+        else
+          element = @stack.shift
+          @xml_hash[element.tag] = element.attributes
+        end
+      end
+
+      def characters(text)
+        return if text.strip.empty?
+        raise REXML::ParseException, 'Invalid XML' if @stack.empty?
+
+        element = @stack.shift
+        element.attributes[:@text] = text
+        @stack.prepend(element)
+      end
+    end
+  end
+end

data/lib/xtj/tags/xml_tag.rb

@@ -0,0 +1,29 @@
+# typed: true
+# frozen_string_literal: true
+
+module XTJ
+  module Tags
+    class XMLTag
+      extend T::Sig
+      attr_reader :tag, :attributes
+
+      sig { params(tag: Symbol, attributes: Hash).void }
+      def initialize(tag:, attributes:)
+        @tag = tag
+        @attributes = attributes
+      end
+
+      sig { params(tag: Symbol, attributes: Hash).void }
+      def add_to_attributes(tag, attributes)
+        if @attributes[tag].nil?
+          @attributes[tag] = attributes
+        elsif @attributes[tag].is_a?(Array)
+          @attributes[tag] << attributes
+        else
+          same_tags = [@attributes[tag]]
+          @attributes[tag] = same_tags << attributes
+        end
+      end
+    end
+  end
+end

data/lib/xtj/version.rb

@@ -0,0 +1,6 @@
+# typed: strong
+# frozen_string_literal: true
+
+module XTJ
+  VERSION = '0.1.0'
+end

data/lib/xtj.rb

@@ -0,0 +1,39 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative 'xtj/version'
+require_relative 'xtj/tags/xml_tag'
+require_relative 'xtj/handlers/xml_handler'
+require 'rexml/parsers/sax2parser'
+require 'json'
+
+module XTJ
+  class Document
+    extend T::Sig
+
+    def initialize(xml_document)
+      @document = xml_document
+    end
+
+    sig { returns(Hash) }
+    def to_hash
+      @to_hash ||= parse
+    end
+
+    sig { params(_args: T.untyped).returns(String) }
+    def to_json(*_args)
+      to_hash.to_json
+    end
+
+    private
+
+    sig { returns(Hash) }
+    def parse
+      parser = REXML::Parsers::SAX2Parser.new(@document)
+      handler = Handlers::XMLHandler.new
+      parser.listen(handler)
+      parser.parse
+      handler.xml_hash
+    end
+  end
+end

data/sorbet/config

@@ -0,0 +1,2 @@
+--dir
+.