hash_param 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fa41452500af1f6485cf963eddba85b8b136480
+  data.tar.gz: 092c5a37c775949c30911a7a5f5f663bc1ec6da0
+SHA512:
+  metadata.gz: 9a2ab5099f422e870b06826926a4259af2b2688882fca1122fddad9c86cf9e6bd5cf3e13c1c694aa44d14d80a2a10a1e4bad003ce8565204f7814d81fcea0978
+  data.tar.gz: ee4207b9b643940dfcc2d9d95c217aff7fdc10ce861dc6ab182f2729e2e91541b8af4b00d195e4d6b09b967cb65cc8db2ed298a2b60cff16a3ef6ca262f0e737

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mike A. Owens
+
+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,95 @@
+# hash_param
+
+hash_param is an library that converts functions that take a single "data"
+argument Hash into a function that takes named, formal parameters.  This allows
+APIs like ActionCable to be a little easier to work with.
+
+For example, it can turn this:
+
+```ruby
+class ChatChannel < ApplicationCable::Channel
+  def send_message(data)
+    chat_id = data['chat_id']
+    author_id = data['author_id']
+    body = data['body']
+    # ...
+  end
+
+  def typing_status(data)
+    chat_id = data['chat_id']
+    user_id = data['user_id']
+    status = data['status'] || 'typing'
+    # ...
+  end
+end
+```
+
+into this:
+
+```ruby
+class ChatChannel < ApplicationCable::Channel
+  hash_param :send_message, :typing_status
+
+  def send_message(chat_id, author_id, body)
+    # ...
+  end
+
+  def typing_status(chat_id, user_id, status = 'typing')
+    # ...
+  end
+end
+```
+
+It does this by looking at your method signature and filling in parameters by
+name from the data object.  It plays nice with default parameters, keyword
+arguments, both optional and required, `*rest` and `**kwrest` parameters.
+
+After named positional arguments, `hash_param` will try to fill named keyword
+arguments, then will send the rest to `**kwrest` if listed, and lastly, will
+send whats left of the data object to `*args`.  In practice, this means you'll
+never get values in both `*args` and `**kwrest`.
+
+`*args` parameters keep the string key names, while `**kwrest` hashes get their
+keys converted into symbols.  If there are no values to pass to `*args`, you'll
+get an empty list, not a list containing an empty Hash.
+
+If the argument list cannot be satisfied, `ArgumentError` is raised.  Extraneous
+properties sent to the method are ignored if not consumed through the argument
+list.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hash_param'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_param
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` 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/metermd/hash_param.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hash_param"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hash_param.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_param/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_param"
+  spec.version       = HashParam::VERSION
+  spec.authors       = ["Mike A. Owens"]
+  spec.email         = ["mike@meter.md"]
+
+  spec.summary       = %q{Automatically extracts Hash parameters into formal parameters}
+  spec.homepage      = "https://github.com/metermd/hash_param"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/hash_param/version.rb

@@ -0,0 +1,3 @@
+module HashParam
+  VERSION = "0.0.2"
+end

data/lib/hash_param.rb

@@ -0,0 +1,96 @@
+require 'hash_param/version'
+
+module HashParam
+  def self.included(cls)
+    cls.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def hash_param(*method_names)
+      method_names.each do |method_name|
+        visibility = instance_method_visibility(method_name)
+        hidden_name = "#{method_name}_before_hash_param"
+
+        alias_method hidden_name, method_name
+        private hidden_name
+
+        define_method(method_name) do |*args|
+          hash_param_dispatch(hidden_name, *args)
+        end
+
+        # We set the new wrapping method's visibility to what the original was.
+        send(visibility, method_name)
+      end
+    end
+
+    private
+    # This determines the visibility of an instance method, e.g.,
+    # Object.instance_method_visibility(:object_id) => :public
+    def instance_method_visibility(method_name)
+      return :public    if public_instance_methods.include?(method_name)
+      return :protected if protected_instance_methods.include?(method_name)
+      return :private   if private_instance_methods.include?(method_name)
+      fail NoMethodError, "Cannot access visibility of #{name}\##{method_name}"
+    end
+  end
+
+  private
+  def hash_param_dispatch(method_name, data)
+    args, kwargs, rest_index, has_kwrest = [], {}, nil, nil
+    public_method_name = method_name
+
+    method(method_name).parameters.each.with_index do |(type, name), i|
+      key_name = name.to_s
+      exists = data.key?(key_name)
+      value = exists ? data.delete(key_name) : nil
+
+      case type
+        when :req
+          fail ArgumentError, "#{public_method_name}: required argument " +
+                              "`#{name}' not present" unless exists
+          args.push(value)
+
+        when :opt
+          args.push(value) if exists
+
+        when :keyreq
+          fail ArgumentError, "#{public_method_name}: required keyword argument " +
+                              "`#{name}' not present" unless exists
+          kwargs[name] = value
+
+        when :key
+          kwargs[name] = value if exists
+
+        when :rest
+          # If data happens to contain a key with the same name as the rest arg,
+          # we still want it to show up string-ized, so we put back the value
+          # we deleted earlier.
+          data[key_name] = value if exists
+          rest_index = i
+
+        when :keyrest
+          # Because keyrest supercedes rest, we add this to kwargs if the
+          # data hash happened to contain a key named the same as the keyrest
+          # argument name.
+          kwargs[name] = value if exists
+          has_kwrest = true
+
+        else
+          fail ArgumentError, "#{public_method_name}: cannot dispatch " +
+                              "argument `#{name}', (type: #{type}) from Hash"
+      end
+    end
+
+    if has_kwrest
+      kwargs.merge!(data.map { |k,v| [k.to_sym, v] }.to_h)
+    elsif rest_index
+      args[rest_index, 0] = data unless data.empty?
+    end
+
+    if kwargs.empty?
+      send(method_name, *args)
+    else
+      send(method_name, *args, **kwargs)
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: hash_param
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mike A. Owens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: 
+email:
+- mike@meter.md
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hash_param.gemspec
+- lib/hash_param.rb
+- lib/hash_param/version.rb
+homepage: https://github.com/metermd/hash_param
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Automatically extracts Hash parameters into formal parameters
+test_files: []