hash_to_struct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8606f1e55e6fbabe1ccb0d02f70688025b87aed05490ba221896605c92d31402
+  data.tar.gz: 5d51c847d87d7c96dfd8938301c68effa74e51bc450094447c35b8beddab8096
+SHA512:
+  metadata.gz: 61ffa8d5725f6552e0b35174d69d9e566693c736c1e695b682643613ca3a0a0b8c4976f2d54e54c043c42a9e0993855f2155aff7a077e6f05ac99f051e72d2dc
+  data.tar.gz: 9c8bc999bc6e71ca6b76ccdf0f0093aaf75301a89507b1da41f10e4216dadae9e32eb6c23113848888af25741457ff4eac2d50fb0abaa242a192017054c89342

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+.byebug_history
+.ruby-gemset
+.ruby-version
+Gemfile.lock

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+## 0.1.0 (2022-01-17)

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hash_to_struct.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Andrew Bohush
+
+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,83 @@
+# HashToStruct
+
+It enables recursive conversion of ruby Hash to Struct-like object and back.
+
+Stop thinking about symbols vs strings when accessing values in your hash. Simply call a method.
+
+It is built on top of standard `Struct` and `OpenStruct` classes with all their features preserved while adding a few on top for conveniences like handling nested hashes/arrays, unified constructor interface, immutability.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hash_to_struct'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hash_to_struct
+
+## Usage
+
+`Struct` based conversion:
+
+```ruby
+struct = HashToStruct.struct({q: 1})
+
+struct.q # => 1
+struct[:x] # => NameError: no member 'x' in struct
+```
+
+`OpenStruct` based conversion:
+
+```ruby
+ostruct = HashToStruct.ostruct({q: 1})
+
+ostruct.q # => 1
+ostruct[:x] = 5
+ostruct.x # => 5
+```
+
+Convert back to `Hash`:
+
+```ruby
+ostruct.to_h # => { :q => 1, :x => 5 }
+```
+
+Recursive conversion:
+
+```ruby
+struct = HashToStruct.struct({q: 1, w: { e: 2 }})
+
+struct.q.w.e # => 2
+```
+**Note!** It will only convert objects of type Hash, not Hash derivatives or some acting like Hash.
+
+Recursive conversions inside `Array`:
+
+```ruby
+struct = HashToStruct.struct({q: 1, w: [{ e: 2 }]}, including_arrays: true)
+
+struct.q.w.first.e # => 2
+```
+**Note!** It will only iterate over objects of type Array, not Array derivatives or other enumerables.
+
+Make immutable:
+```ruby
+struct = HashToStruct.struct({q: 1}, immutable: true)
+
+struct.q = 2 # => FrozenError: can't modify frozen #<struct q=1>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/a-bohush/hash_to_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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/hash_to_struct.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/hash_to_struct/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_to_struct"
+  spec.version       = HashToStruct::VERSION
+  spec.authors       = ["Andrew Bohush"]
+  spec.email         = ["a.bohush01@gmail.com"]
+
+  spec.summary       = "It enables recursive conversion of ruby Hash to Struct-like object and back."
+  spec.description   = "It is built on top of standard `Struct` and `OpenStruct` classes with all their features preserved while adding a few on top for conveniences like handling nested hashes/arrays, unified constructor interface, immutability."
+  spec.homepage      = "https://github.com/a-bohush/hash_to_struct.git"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/a-bohush/hash_to_struct/blob/main/CHANGELOG.md"
+  spec.extra_rdoc_files = ['README.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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  # spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/hash_to_struct/open_struct_builder.rb

@@ -0,0 +1,15 @@
+require 'ostruct'
+
+module HashToStruct
+  class OpenStructBuilder
+    class << self
+      def struct_class
+        ::OpenStruct
+      end
+
+      def build(hash)
+        struct_class.new(hash)
+      end
+    end
+  end
+end

data/lib/hash_to_struct/struct.rb

@@ -0,0 +1,54 @@
+require 'delegate'
+
+module HashToStruct
+  class Struct < SimpleDelegator
+    def initialize(
+          hash,
+          builder_class: HashToStruct::StructBuilder,
+          immutable: false,
+          including_arrays: false
+        )
+      @options = {
+        builder_class: builder_class,
+        immutable: immutable,
+        including_arrays: including_arrays
+      }
+      __setobj__(to_struct(hash))
+      freeze if immutable
+    end
+
+    def to_h
+      to_hash
+    end
+
+    private
+
+    def to_struct(hash)
+      h = hash.each_key.each_with_object({}) do |key, h|
+        create_new = -> (hv) { self.class.new(hv, **@options) }
+        h[key] = case
+                 when hash[key].class == Hash
+                   create_new.call(hash[key])
+                 when @options[:including_arrays] && hash[key].class == Array
+                   hash[key].map(&create_new)
+                 else
+                   hash[key]
+                 end
+      end
+      @options[:builder_class].build(h)
+    end
+
+    def to_hash
+      __getobj__.to_h.tap do |h|
+        h.keys.each do |key|
+          h[key] = case
+                   when h[key].is_a?(self.class) then h[key].to_h
+                   when h[key].class == Array then h[key].map(&:to_h)
+                   else
+                     h[key]
+                   end
+        end
+      end
+    end
+  end
+end

data/lib/hash_to_struct/struct_builder.rb

@@ -0,0 +1,14 @@
+module HashToStruct
+  class StructBuilder
+    class << self
+      def struct_class
+        ::Struct
+      end
+
+      def build(hash)
+        s = struct_class.new(nil, *hash.keys)
+        s.new(*hash.values_at(*hash.keys))
+      end
+    end
+  end
+end

data/lib/hash_to_struct/version.rb

@@ -0,0 +1,3 @@
+module HashToStruct
+  VERSION = "0.1.0"
+end

data/lib/hash_to_struct.rb

@@ -0,0 +1,20 @@
+require "hash_to_struct/version"
+require "hash_to_struct/struct_builder"
+require "hash_to_struct/struct"
+
+module HashToStruct
+  class << self
+    def build(h, **opts)
+      HashToStruct::Struct.new(h, **opts)
+    end
+
+    def struct(hash, **opts)
+      build(hash, **opts.merge({builder_class: HashToStruct::StructBuilder}))
+    end
+
+    def ostruct(hash, **opts)
+      require 'hash_to_struct/open_struct_builder'
+      build(hash, **opts.merge({builder_class: HashToStruct::OpenStructBuilder}))
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: hash_to_struct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Bohush
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: It is built on top of standard `Struct` and `OpenStruct` classes with
+  all their features preserved while adding a few on top for conveniences like handling
+  nested hashes/arrays, unified constructor interface, immutability.
+email:
+- a.bohush01@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash_to_struct.gemspec
+- lib/hash_to_struct.rb
+- lib/hash_to_struct/open_struct_builder.rb
+- lib/hash_to_struct/struct.rb
+- lib/hash_to_struct/struct_builder.rb
+- lib/hash_to_struct/version.rb
+homepage: https://github.com/a-bohush/hash_to_struct.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/a-bohush/hash_to_struct.git
+  source_code_uri: https://github.com/a-bohush/hash_to_struct.git
+  changelog_uri: https://github.com/a-bohush/hash_to_struct/blob/main/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: It enables recursive conversion of ruby Hash to Struct-like object and back.
+test_files: []