hash_with_dot_access 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3851671767e52da2777731df70b4a480f35b3c3a748c252017c55775ac28cf8
+  data.tar.gz: e332a15a45541e8ed07ae2af6a95268b537df5b82028d794729b39ba2f995784
+SHA512:
+  metadata.gz: 0c9b5a2ad6e68ead89fbdcde10a1228193fe5fcd00f1f84f3eac26465e189675f47de19d4e87ecb5cc298629731f664f24f5f8ab9e3fa10e33d29c0f055b19aa
+  data.tar.gz: b3c7e8d97b4d586276fa7376cfc9326923c0e2ba5ec7b344f9adc85bb7fdc0ad4af4666283df0b5898077721b093f0d252a4d4e95e4d1159f7900cd2ceafb152

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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
+[jared@whitefusion.io](mailto:jared@whitefusion.io). 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://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hash_with_dot_access.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    hash_with_dot_access (1.0.0)
+      activesupport (>= 5.0.0, < 7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    rake (12.3.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  hash_with_dot_access!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present Jared White and Bridgetown contributors
+
+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,100 @@
+# Hash with Dot Access
+
+Rails' ActiveSupport gem provides `HashWithIndifferentAccess` which allows you to access hash keys with either strings or symbols. This gem provides `HashWithDotAccess` which subclasses `HashWithIndifferentAccess` and allows you to access or set those keys using dot access (aka methods). It utilizes `method_missing` to access key data if available, and you can also set data using `keyname=`.
+
+## Example
+
+```ruby
+require "hash_with_dot_access"
+ 
+hsh = HashWithDotAccess::Hash.new({a: 1, b: 2, c: "abc"})
+# => {"a"=>1, "b"=>2, "c"=>"abc"}
+
+hsh.a
+# => 1
+
+hsh.c
+# => "abc"
+
+hsh.d = "Indeed!"
+hsh.d
+# => "Indeed!"
+
+hsh[:d]
+# => "Indeed!"
+
+hsh["d"]
+# => "Indeed!"
+
+hsh2 = {test: "dot access"}.with_dot_access
+hsh2.test
+# => "dot access"
+
+## Nested hashes work too! Pairs nicely with lonely operator: &.
+
+nested = {a: 1, b: {c: 3}}.with_dot_access
+nested.b.c
+# => 3
+
+nested&.d&.e&.f
+# => nil
+
+## You can also set default return values when key is missing
+
+hsh = {a: 1, b: 2}.with_dot_access
+hsh.default = 0
+hsh.a
+# => 1
+hsh.x
+# => 0
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+$ bundle add hash_with_dot_access
+```
+
+Then simply require `hash_with_dot_access`:
+
+```ruby
+require "hash_with_dot_access"
+```
+
+## Caveats
+
+As with any Ruby object which provides arbitrary data through dynamic method calls, you may encounter collisions between your key names and existing `Hash` methods. For example:
+
+```ruby
+hsh = {each: "this won't work!"}.with_dot_access
+hsh.each
+# => #<Enumerator: {"each"=>"this won't work!"}:each>
+#
+# Uh oh!
+```
+
+Of course, the easy fix is to simply use standard ways of accessing hash data in these cases:
+
+```ruby
+hsh = {each: "this will work!"}.with_dot_access
+hsh[:each]
+# => "this will work!"
+```
+
+## Development
+
+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/bridgetownrb/hash_with_dot_access.
+
+## 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 Hash with Dot Access project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bridgetownrb/hash_with_dot_access/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/hash_with_dot_access.gemspec

@@ -0,0 +1,24 @@
+require_relative "lib/hash_with_dot_access/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_with_dot_access"
+  spec.version       = HashWithDotAccess::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+
+  spec.summary       = %q{Subclass of HashWithIndifferentAccess which provides dot access via method_missing}
+  spec.homepage      = "https://github.com/bridgetownrb/hash_with_dot_access"
+  spec.license       = "MIT"
+
+  # 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_runtime_dependency "activesupport",     [">= 5.0.0", "< 7.0"]
+  
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.0"
+end

data/lib/hash_with_dot_access.rb

@@ -0,0 +1,60 @@
+require "active_support/core_ext/hash/indifferent_access"
+
+module HashWithDotAccess
+  class Hash < ActiveSupport::HashWithIndifferentAccess
+    def respond_to_missing?(key, *)
+      return true if "#{key}".end_with?("=")
+
+      key?[key]
+    end
+
+    def method_missing(key, *args)
+      if "#{key}".end_with?("=")
+        self["#{key}".chop] = args.first
+      elsif self.key?(key)
+        self[key]
+      else
+        default
+      end
+    end
+
+    def update(other_hash)
+      if other_hash.is_a? HashWithDotAccess::Hash
+        super(other_hash)
+      else
+        other_hash.to_hash.each_pair do |key, value|
+          if block_given? && key?(key)
+            value = yield(convert_key(key), self[key], value)
+          end
+          regular_writer(convert_key(key), convert_value(value))
+        end
+        self
+      end
+    end
+
+    private
+
+    def convert_value(value, options = {}) # :doc:
+      if value.is_a? ::Hash
+        if options[:for] == :to_hash
+          value.to_hash
+        else
+          value.with_dot_access
+        end
+      elsif value.is_a?(Array)
+        if options[:for] != :assignment || value.frozen?
+          value = value.dup
+        end
+        value.map! { |e| convert_value(e, options) }
+      else
+        value
+      end
+    end
+  end
+end
+
+class Hash
+  def with_dot_access
+    HashWithDotAccess::Hash.new(self)
+  end
+end

data/lib/hash_with_dot_access/version.rb

@@ -0,0 +1,3 @@
+module HashWithDotAccess
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: hash_with_dot_access
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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'
+description: 
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash_with_dot_access.gemspec
+- lib/hash_with_dot_access.rb
+- lib/hash_with_dot_access/version.rb
+homepage: https://github.com/bridgetownrb/hash_with_dot_access
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Subclass of HashWithIndifferentAccess which provides dot access via method_missing
+test_files: []