objectize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c6d460e1bba365ba6ca8feaf05c5f169a6ea311bb083dbec0cb0eca14bad228
+  data.tar.gz: b50f428ece6080e328300d986b504d9f79982104c21e5f30c1769ab1073298d3
+SHA512:
+  metadata.gz: 2f59e3e82119475a24ac36e1b4638720c9bb70355cbe258d7867d8bad88e444ebb615f52446daaf3b5a03529c82572c8211da469b1c39142b07936a5598ec344
+  data.tar.gz: 7e77899a7840e5d2be877c17d128bce87a9a366ec977a5ef13f28c67cbeb62ab9e37e947e3e6d0c270debe0a530a84e4e031c523f977f8aabd81b98da925fda7

data/.irbrc

@@ -0,0 +1,4 @@
+require 'awesome_print'
+AwesomePrint.irb!
+
+IRB.conf[:USE_AUTOCOMPLETE] = false

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,104 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-rubycw
+  - standard
+  - standard-custom
+  - standard-performance
+
+inherit_gem:
+  standard: config/base.yml
+  standard-performance: config/base.yml
+  standard-custom: config/base.yml
+  syntax_tree: config/rubocop.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'bin/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+
+Bundler/OrderedGems:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 100
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+Metrics/ClassLength:
+  Max: 250
+Metrics/MethodLength:
+  Max: 30
+  Exclude:
+    - 'spec/**/*'
+Metrics/ModuleLength:
+  Max: 250
+  Exclude:
+    - 'spec/**/*'
+Metrics/ParameterLists:
+  Max: 3
+  CountKeywordArgs: false
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/AnyInstance:
+  Enabled: false
+RSpec/BeEq:
+  Enabled: false
+RSpec/ContextWording:
+  Prefixes:
+    - when
+RSpec/DescribedClass:
+  EnforcedStyle: explicit
+RSpec/EmptyLineAfterFinalLet:
+  Enabled: false
+RSpec/ExampleLength:
+  Max: 30
+RSpec/ImplicitExpect:
+  EnforcedStyle: should
+RSpec/ImplicitSubject:
+  Enabled: false
+RSpec/IndexedLet:
+  Max: 2
+RSpec/MatchArray:
+  Enabled: false
+RSpec/MessageChain:
+  Enabled: false
+RSpec/MissingExampleGroupArgument:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/NestedGroups:
+  Max: 6
+RSpec/VerifiedDoubles:
+  Enabled: false
+RSpec/VoidExpect:
+  Exclude:
+    - 'spec/support/*'
+
+Style/ClassMethodsDefinitions:
+  Enabled: true
+Style/CollectionMethods:
+  Enabled: true
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: true
+Style/GlobalStdStream:
+  Enabled: false
+Style/GlobalVars:
+  Enabled: false
+Style/RescueStandardError:
+  EnforcedStyle: explicit
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+Style/UnlessLogicalOperators:
+  Enabled: true
+  EnforcedStyle: forbid_logical_operators

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.3.2

data/.streerc

@@ -0,0 +1,9 @@
+--print-width=100
+--plugins=plugin/single_quotes,plugin/disable_auto_ternary
+
+--ignore-files='log/**'
+--ignore-files='node_modules/**'
+--ignore-files='package.json'
+--ignore-files='tmp/**'
+--ignore-files='vendor/**'
+--ignore-files='**/*.json*'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-15
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jerome Dalbert
+
+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,51 @@
+# Objectize
+
+This gem converts hashes into objects, so you can do `my_object.a.b.c`
+instead of `my_hash['a']['b']['c']`. It works with deeply nested hashes and
+arrays.
+
+This can be useful for API responses and other nested data.
+
+## Installation
+
+Install the gem globally:
+
+```
+gem install objectize
+```
+
+Or add this line to your Gemfile:
+
+```ruby
+gem 'objectize'
+```
+
+and run `bundle install`.
+
+## Usage
+
+```ruby
+my_object = Objectize.to_object(a: { b: { c: 'foo' } })
+my_object.a.b.c #=> 'foo'
+```
+
+To revert an objectized element back to a basic type, you can do:
+
+```ruby
+my_hash = Objectize.to_basic_type(my_object)
+my_hash['a']['b']['c'] #=> 'foo'
+```
+
+## 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/jeromedalbert/objectize. 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/jeromedalbert/objectize/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Objectize project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jeromedalbert/objectize/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+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/lib/objectize/version.rb

@@ -0,0 +1,3 @@
+module Objectize
+  VERSION = '0.1.0'
+end

data/lib/objectize.rb

@@ -0,0 +1,37 @@
+require 'hashie'
+require_relative 'objectize/version'
+
+module Objectize
+  module_function
+
+  # Converts a hash or array of hashes into an object.
+  #
+  #   my_object = Objectize.to_object(a: { b: { c: 'foo' } })
+  #   my_object.a.b.c #=> 'foo'
+  def to_object(element)
+    case element
+    when Hash
+      Hashie::Mash.new(element)
+    when Array
+      element.map { |sub_element| to_object(sub_element) }
+    else
+      element
+    end
+  end
+
+  # Converts an objectized element back to a basic type (i.e. a hash or an
+  # array of hashes)
+  #
+  #   my_hash = Objectize.to_basic_type(my_object)
+  #   my_hash['a']['b']['c'] #=> 'foo'
+  def to_basic_type(element)
+    case element
+    when Hashie::Mash
+      element.to_hash
+    when Array
+      element.map { |sub_element| to_basic_type(sub_element) }
+    else
+      element
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: objectize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jerome Dalbert
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Transforms hashes into objects. Check documentation at https://github.com/jeromedalbert/objectize.
+email:
+- jerome.dalbert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".irbrc"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".streerc"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/objectize.rb
+- lib/objectize/version.rb
+homepage: https://github.com/jeromedalbert/objectize
+licenses: []
+metadata:
+  homepage_uri: https://github.com/jeromedalbert/objectize
+  source_code_uri: https://github.com/jeromedalbert/objectize
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.15
+signing_key:
+specification_version: 4
+summary: Transforms hashes into objects.
+test_files: []