resource-struct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07376a21fe1fd7e877cdd8755e5a269e8336d1ac9906cf046e2aa39947938117
+  data.tar.gz: 070d252877489353d147fc93ee84d3ab0e74608f24d82d6d08163e9acd65c97f
+SHA512:
+  metadata.gz: b72654d78fbdb3df534c058a4e1df047f0ed8c40a063dbfc77ff869b8123d370f34277878354fe5d537802637fec52490d89374428e1bd5a937455bf59b4f0a1
+  data.tar.gz: c3673ddd8220bc52a130ccfd5a512dd1f03dd3c7bfcadde3d28b075ba6b2619f2d8bfa346c853fbe20103ae35630cc6f8a6224bd6d67335a0a31ec63a16abfea

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - lib/resource-struct.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-12-14
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in resource-struct.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    resource-struct (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  rake (~> 13.0)
+  resource-struct!
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.2.33

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Alex Riedler
+
+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,39 @@
+# Resource::Struct
+
+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/resource/struct`. 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 'resource-struct'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install resource-struct
+
+## 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 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/[USERNAME]/resource-struct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "resource/struct"
+
+# 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/resource-struct.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "resource_struct"

data/lib/resource_struct/firm_struct.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module ResourceStruct
+  #
+  # FirmStruct provides a struct by which accessing undefined fields raises a MethodMissing error.
+  # This protects against accessing fields that are not present in API Responses.
+  #
+  # If you need to check whether a field exists in an api response, you can via name? methods.
+  #
+  # struct = FirmStruct.new({ "foo" => 1, "bar" => [{ "baz" => 2 }, 3] })
+  #
+  # struct.foo? # => true
+  # struct.brr? # => false
+  # struct.foo # => 1
+  # struct.bar # => [FirmStruct<{ "baz" => 2 }>, 3]
+  # struct.brr # => NoMethodError
+  # struct[:foo] # => 1
+  # struct[:brr] # => nil
+  # struct[:bar, 0, :baz] # => 2
+  # struct[:bar, 0, :brr] # => nil
+  #
+  class FirmStruct
+    def initialize(hash)
+      raise ::ArgumentError, "first argument must be a Hash, found #{hash.class.name}" unless hash.is_a?(Hash)
+
+      @hash = hash
+      @ro_struct = {}
+    end
+
+    def method_missing(name, *args, &blk)
+      return self[name] if ___key?(name)
+      return !!self[___convert_key(name[...-1])] if name.end_with?("?")
+
+      super
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      ___key?(name) || name.end_with?("?") || super
+    end
+
+    def to_h
+      @hash.to_h
+    end
+
+    def to_hash
+      @hash.to_hash
+    end
+
+    def inspect
+      "#{self.class.name}<#{@hash.inspect}>"
+    end
+
+    def to_s
+      @hash.to_s
+    end
+
+    def ==(other)
+      @hash == other.instance_variable_get(:@hash)
+    end
+
+    def [](key, *sub_keys)
+      ckey = ___convert_key(key)
+
+      result =
+        if @ro_struct.key?(ckey)
+          @ro_struct[ckey]
+        else
+          @ro_struct[ckey] = ___convert_value(@hash[ckey])
+        end
+
+      return result if sub_keys.empty?
+
+      return unless result
+
+      raise TypeError, "#{result.class.name} does not have #dig method" unless result.respond_to?(:dig)
+
+      result.dig(*sub_keys)
+    end
+    alias dig []
+
+    private
+
+    def ___convert_value(value)
+      case value
+      when ::Array
+        value.map { |v| ___convert_value(v) }.freeze
+      when Hash
+        self.class.new(value)
+      else
+        value
+      end
+    end
+
+    def ___key?(key)
+      @hash.key?(___convert_key(key))
+    end
+
+    def ___convert_key(key)
+      key.is_a?(::Symbol) ? key.to_s : key
+    end
+  end
+end

data/lib/resource_struct/loose_struct.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module ResourceStruct
+  #
+  # LooseStruct provides a struct by which accessing undefined fields returns nil
+  #
+  # struct = LooseStruct.new({ "foo" => 1, "bar" => [{ "baz" => 2 }, 3] })
+  #
+  # struct.foo? # => true
+  # struct.brr? # => false
+  # struct.foo # => 1
+  # struct.bar # => [LooseStruct<{ "baz" => 2 }>, 3]
+  # struct.brr # => nil
+  # struct[:foo] # => 1
+  # struct[:brr] # => nil
+  # struct[:bar, 0, :baz] # => 2
+  # struct[:bar, 0, :brr] # => nil
+  #
+  class LooseStruct
+    def initialize(hash)
+      raise ::ArgumentError, "first argument must be a Hash, found #{hash.class.name}" unless hash.is_a?(Hash)
+
+      @hash = hash
+      @ro_struct = {}
+    end
+
+    def method_missing(name, *_args)
+      return self[name] if ___key?(name)
+      return !!self[___convert_key(name[...-1])] if name.end_with?("?")
+
+      nil
+    end
+
+    def respond_to_missing?(_name, _include_private = false)
+      true
+    end
+
+    def to_h
+      @hash.to_h
+    end
+
+    def to_hash
+      @hash.to_hash
+    end
+
+    def inspect
+      "#{self.class.name}<#{@hash.inspect}>"
+    end
+
+    def to_s
+      @hash.to_s
+    end
+
+    def ==(other)
+      @hash == other.instance_variable_get(:@hash)
+    end
+
+    def [](key, *sub_keys)
+      ckey = ___convert_key(key)
+
+      result =
+        if @ro_struct.key?(ckey)
+          @ro_struct[ckey]
+        else
+          @ro_struct[ckey] = ___convert_value(@hash[ckey])
+        end
+
+      return result if sub_keys.empty?
+
+      return unless result
+
+      raise TypeError, "#{result.class.name} does not have #dig method" unless result.respond_to?(:dig)
+
+      result.dig(*sub_keys)
+    end
+    alias dig []
+
+    private
+
+    def ___convert_value(value)
+      case value
+      when ::Array
+        value.map { |v| ___convert_value(v) }.freeze
+      when Hash
+        self.class.new(value)
+      else
+        value
+      end
+    end
+
+    def ___key?(key)
+      @hash.key?(___convert_key(key))
+    end
+
+    def ___convert_key(key)
+      key.is_a?(::Symbol) ? key.to_s : key
+    end
+  end
+end

data/lib/resource_struct/version.rb

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

data/lib/resource_struct.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "resource_struct/version"
+
+module ResourceStruct
+  class Error < StandardError; end
+end
+
+require_relative "resource_struct/firm_struct"
+require_relative "resource_struct/loose_struct"

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: resource-struct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Riedler
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-16 00:00:00.000000000 Z
+dependencies: []
+description: Openstruct like access without all the headaches of Hash method overrides
+  etc...
+email:
+- alex@riedler.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/resource-struct.rb
+- lib/resource_struct.rb
+- lib/resource_struct/firm_struct.rb
+- lib/resource_struct/loose_struct.rb
+- lib/resource_struct/version.rb
+homepage: https://github.com/AlexRiedler/resource-struct
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/AlexRiedler/resource-struct
+  source_code_uri: https://github.com/AlexRiedler/resource-struct
+  changelog_uri: https://raw.githubusercontent.com/AlexRiedler/resource-struct/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Ruby structs for resource responses
+test_files: []