aston 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 825ca0a986669eb04c434775792fadf6f4127f57d82144d4fab9282d2af7e8bd
+  data.tar.gz: d6acd466695b6236f494a9b00c784f0b33a7cf61dafedb8d9d2cf1c610d5e811
+SHA512:
+  metadata.gz: df8dda9a4fe333ebdc535f7cda0369a30be3478dbbc295f093a08797b9ba9345c7226339fdd10957577c1a9b631aae7caf9f62ae249f290f71dce18663c683d8
+  data.tar.gz: b0c056e04628e20b07b9b7346282d55a1e8cef5b250a7751be204d2fb4685f1042e7feb51bf4c58fb98f2e96cf00a431087fce4dbfabed96d1058053466a1909

data/.github/workflows/gem-push.yml

@@ -0,0 +1,50 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    name: Test + Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1 # v1.146.0
+      with:
+        ruby-version: 2.7.8
+
+    - name: Test the Gem
+      run: |
+        bundle
+        bundle exec rake
+
+    # - name: Publish to GPR
+    #   run: |
+    #     mkdir -p $HOME/.gem
+    #     touch $HOME/.gem/credentials
+    #     chmod 0600 $HOME/.gem/credentials
+    #     printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+    #     gem build *.gemspec
+    #     gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+    #   env:
+    #     GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+    #     OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

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 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,14 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-02-07 13:48:55 UTC using RuboCop version 1.60.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'aston.gemspec'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.6
+before_install: gem install bundler -v 2.1.4

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 aleksei.matiushkin@kantox.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aston.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    aston (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amazing_print (1.5.0)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    prop_check (0.18.1)
+      amazing_print (~> 1.2)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aston!
+  prop_check
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Aleksei Matiushkin
+
+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,44 @@
+# Aston
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aston`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aston'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install aston
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/am-kantox/aston. 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/am-kantox/aston/blob/master/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 the Aston project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/am-kantox/aston/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/aston.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/aston/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'aston'
+  spec.version       = Aston::VERSION
+  spec.authors       = ['Aleksei Matiushkin']
+  spec.email         = ['aleksei.matiushkin@kantox.com']
+
+  spec.summary       = 'Helper to produce JSON hashes representing XML'
+  spec.description   = 'Hash/JSON is not isomorphic to XML, unless produced with this library'
+  spec.homepage      = 'https://github.com/am-kantox/aston'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/am-kantox/aston'
+  spec.metadata['changelog_uri'] = 'https://github.com/am-kantox/aston/CHANGELOG.md'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'prop_check'
+  spec.add_development_dependency 'pry'
+end

data/lib/aston/version.rb

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

data/lib/aston.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'aston/version'
+
+# Aston class keeps, modifies, and produces JSON which is isomorphic to XML
+class Aston
+  class Error < StandardError; end
+
+  # Wrapper for attributes
+  class Attributes
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    def []=(key, value)
+      @data[key] = value
+    end
+
+    def to_s
+      @data.map { |k, v| "#{k}='#{v}'" }.join(' ')
+    end
+
+    def ==(other)
+      other.is_a?(Attributes) && @data == other.data
+    end
+
+    def size
+      @data.size
+    end
+  end
+
+  # Wrapper for content
+  class Content
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def <<(elem)
+      @data << elem
+    end
+
+    def [](index)
+      @data[index]
+    rescue StandardError => e
+      raise Error, e
+    end
+
+    def ==(other)
+      other.is_a?(Content) && @data == other.data
+    end
+
+    def size
+      @data.size
+    end
+
+    def to_s
+      @data.map(&:to_s).join("\n")
+    end
+  end
+
+  attr_reader :name, :attributes, :content
+
+  def initialize(name, attributes: {}, content: [])
+    @name = name
+    @attributes = Attributes.new(attributes)
+    @content = Content.new(content)
+  end
+
+  def [](key)
+    @attributes[key]
+  end
+
+  def []=(key, value)
+    @attributes[key] = value
+  end
+
+  def <<(value)
+    @content << value
+  end
+
+  def ==(other)
+    other.is_a?(Aston) && @name == other.name && @attributes == other.attributes && @content == other.content
+  end
+
+  def to_s
+    comment = "<!-- Aston:#{__id__}:#{name} -->"
+    opening = @attributes.data.empty? ? "<#{name}>" : ['<', name, *@attributes].join(' ') << '>'
+    [comment, opening, *@content, "</#{name}>"].join("\n")
+  end
+
+  def paths
+    do_paths([], [])
+  end
+
+  def find(name)
+    @content.data.find { |a| a.is_a?(Aston) && a.name == name }
+  end
+
+  def update_in(path, create_intermediate: true, &_block)
+    yield clamber(path, create_intermediate)
+  rescue StandardError => e
+    raise Error, e
+  end
+
+  def put_attribute(path, name, value, create_intermediate: true)
+    tap { clamber(path, create_intermediate)[name] = value }
+  rescue StandardError => e
+    raise Error, e
+  end
+
+  def put_content(path, aston, create_intermediate: true)
+    tap { clamber(path, create_intermediate) << aston }
+  rescue StandardError => e
+    raise Error, e
+  end
+
+  def get(path, default: nil)
+    path = fix_path(path)
+    path.reduce(self) do |memo, e|
+      current = memo.find(e)
+
+      case current
+      when NilClass then break default
+      when String then current
+      when Aston then current
+      end
+    end
+  end
+
+  protected
+
+  def do_paths(path, acc)
+    content = @content.data.select { |c| c.is_a?(Aston) }
+    return [path + [name]] if content.empty?
+
+    content.map do |e|
+      e.do_paths(path + [name], acc)
+    end.flatten(1)
+  end
+
+  private
+
+  def clamber(path, create_intermediate)
+    fix_path(path).reduce(self) do |memo, e|
+      current = memo.find(e)
+
+      case current
+      when NilClass then create_intermediate ? Aston.new(e).tap { |aston| memo << aston } : break
+      when Aston then current
+      end
+    end
+  end
+
+  def fix_path(path)
+    path = path.split('.') if path.is_a?(String)
+    raise Error, 'Path must be an array' unless path.is_a?(Array)
+
+    path
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: aston
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksei Matiushkin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prop_check
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Hash/JSON is not isomorphic to XML, unless produced with this library
+email:
+- aleksei.matiushkin@kantox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- aston.gemspec
+- lib/aston.rb
+- lib/aston/version.rb
+homepage: https://github.com/am-kantox/aston
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/am-kantox/aston
+  source_code_uri: https://github.com/am-kantox/aston
+  changelog_uri: https://github.com/am-kantox/aston/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Helper to produce JSON hashes representing XML
+test_files: []