delegate_key 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b13a172ea1a1e209de4d4e64561660ee217d2a0dcebe43db3e80f846d7a7af2
+  data.tar.gz: 6300b0d335bd59bd3db3b27fa7efc303920dbeb1e10f564dfbbc632229326599
+SHA512:
+  metadata.gz: 457b8cdc5a40d4d51923b5f7d3124c1cb76d1dfdfebf86fd6c5557e346bcd454a42a647a5b08a59726cbc527737a37f8773bf95cd71191c486ba8ca8420dbdfc
+  data.tar.gz: 3dc1ce94bf89e6e94436f0bdfefe09acb5f9028641fcaea9bf7ca272084f910842edb3b8458e4338ce2af2484b36008344a6a131bec88b864d556bdf3aa624b1

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+/.config
+/coverage
+/pkg
+/spec/reports
+/spec/examples.txt
+/test/tmp
+/test/version_tmp
+/tmp
+
+/.bundle
+/vendor/bundle
+/lib/bundler/man
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

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 ilyas.garaev@flatstack.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 delegate_key.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ilyas Garaev
+
+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,143 @@
+# DelegateKey
+
+Provides a `delegate_key` class method to easily create methods which return hash value by key.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delegate_key'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delegate_key
+
+## Usage
+
+### Options
+
+- `:to` - specifies the target object;
+
+- `:prefix` - prefixes the new method with the target name or a custom prefix;
+
+- `:private` - if set to true, changes method visibility to private.
+
+`delegate_key` method receives one or more method names (specified as symbols or strings) and the name of the target object via the `:to` option (also a symbol or string).
+
+```ruby
+class Foo
+  delegate_key :key, to: :hash
+
+  def hash
+    { key: "value" }
+  end
+end
+
+Foo.new.key # => "value"
+```
+
+If hash key is a string, use string as argument:
+
+```ruby
+class Foo
+  delegate_key "key", to: :hash
+
+  def hash
+    { "key" => "value" }
+  end
+end
+
+Foo.new.key # => "value"
+
+class Foo
+  delegate_key :key, to: :hash
+
+  def hash
+    { "key" => "value" }
+  end
+end
+
+Foo.new.key # => nil
+```
+
+Multiple delegates to the same target are allowed:
+
+```ruby
+class Foo
+  delegate_key :bar, :baz, to: :hash
+
+  def hash
+    { bar: "value for bar", baz: "value for baz" }
+  end
+end
+
+Foo.new.bar # => "value for bar"
+Foo.new.baz # => "value for baz"
+```
+
+Delegates can optionally be prefixed using the `:prefix` option. If the value is `true`, the delegate methods are prefixed with the name of the object being delegated to.
+
+```ruby
+class Foo
+  delegate_key :key, to: :hash, prefix: true
+
+  def hash
+    { key: "value" }
+  end
+end
+
+Foo.new.hash_key # => "value"
+Foo.new.key # => NoMethodError: undefined method `key' for #<Foo:0x00007fc2452354b0>
+```
+
+It is also possible to supply a custom prefix:
+
+```ruby
+class Foo
+  delegate_key :key, to: :hash, prefix: :custom
+
+  def hash
+    { key: "value" }
+  end
+end
+
+Foo.new.custom_key # => "value"
+```
+
+The delegated methods are public by default. Pass `private: true` to change that.
+
+```ruby
+class Foo
+  delegate_key :key, to: :hash, private: true
+
+  def hash
+    { key: "value" }
+  end
+end
+
+Foo.new.key # => NoMethodError: private method `key' called for #<Foo:0x00007fc24531dd28>
+```
+
+## 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/[USERNAME]/delegate_key. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 DelegateKey project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/delegate_key/blob/master/CODE_OF_CONDUCT.md).

data/bin/ci

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+
+set -e
+
+bin/rspec spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "delegate_key"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+
+set -e
+
+BUNDLE_PATH=".bundle"
+
+bundle check --path $BUNDLE_PATH > /dev/null 2>&1 ||
+  bundle install --path=$BUNDLE_PATH $BUNDLER_ARGS

data/delegate_key.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "delegate_key/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "delegate_key"
+  spec.version       = DelegateKey::VERSION
+  spec.authors       = ["Ilyas Garaev"]
+  spec.email         = ["g.ilyas.ilm@gmail.com"]
+
+  spec.summary       = "Provides a delegate_key class method"
+  spec.description   = "Provides a delegate_key class method to easily create methods which return hash value by key"
+  spec.homepage      = "https://github.com/ilyasgaraev/delegate_key"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.1"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+end

data/lib/delegate_key.rb

@@ -0,0 +1,33 @@
+class Module
+  def delegate_key(*methods, to: nil, prefix: nil, private: nil)
+    unless to
+      raise ArgumentError, "Delegation needs a target. Supply a keyword argument 'to' (e.g. delegate_key :key, to: :hash)."
+    end
+
+    if prefix == true && /^[^a-z_]/.match?(to)
+      raise ArgumentError, "Can only automatically set the delegation prefix when delegating to a method."
+    end
+
+    method_prefix = if prefix
+      "#{prefix == true ? to : prefix}_"
+    else
+      ""
+    end
+
+    location = caller_locations(1, 1).first
+    file, line = location.path, location.lineno
+
+    method_names = methods.map do |method|
+      method_def = [
+        "def #{method_prefix}#{method}",
+        "  #{to}.public_send(:[], #{method.inspect})",
+        "end"
+      ].join ";"
+
+      module_eval(method_def, file, line)
+    end
+
+    private(*method_names) if private
+    method_names
+  end
+end

data/lib/delegate_key/version.rb

@@ -0,0 +1,3 @@
+module DelegateKey
+  VERSION = "1.0.0".freeze
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: delegate_key
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ilyas Garaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-23 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Provides a delegate_key class method to easily create methods which return
+  hash value by key
+email:
+- g.ilyas.ilm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/ci
+- bin/console
+- bin/rspec
+- bin/setup
+- delegate_key.gemspec
+- lib/delegate_key.rb
+- lib/delegate_key/version.rb
+homepage: https://github.com/ilyasgaraev/delegate_key
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides a delegate_key class method
+test_files: []