reverse_parameters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa58db49022971f0474e8045c170be870c93a9b2
+  data.tar.gz: 4bd18676e3a56614f6895f4e9750d638beb1a7b2
+SHA512:
+  metadata.gz: b799b83b393c0b48548b4dc108f17e3e95e0660b6a6e06abb59e79312e54e80b26c0384bc489c05fc05e40ff20610835d2130fd90f8d636aa1ffa4f5b4350497
+  data.tar.gz: 8669f5eb1d47e424b29be9cd639ca53846fabb5ba887bcc469d481dabb9ab32b8fb35fa3109d555613f60738106e26cf6fe0a12a3e49b89f3a7f55f0eaa79059

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.6
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dustin Zeisler
+
+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,64 @@
+# ReverseParameters
+
+[![Build Status](https://travis-ci.org/zeisler/reverse_parameters.svg)](https://travis-ci.org/zeisler/reverse_parameters)
+[![Code Climate](https://codeclimate.com/github/zeisler/active_mocker.png)](https://codeclimate.com/github/zeisler/reverse_parameters)
+
+Recreate ruby method signatures using ruby's method to Proc creation `#method(:method_name).parameters`. Use this to dynamically recreate method parameter interfaces. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'reverse_parameters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reverse_parameters
+
+## Usage
+
+```ruby
+require 'reverse_parameters'
+
+def example_method(named_param:)
+end
+
+parameters = method(:example_method).parameters
+  #=> [[:keyreq, :named_param]]
+    
+# Method arguments are the real values passed to (and received by) the function.
+ReverseParameters.arguments(parameters).to_s
+  #=> "named_param: named_param"
+    
+# Method parameters are the names listed in the function definition.
+ReverseParameters.parameters(parameters).to_s
+  #=> "named_param:"
+```
+
+## Limitations
+
+Since it is not possible to get the default values using `Proc#parameters` any optional will default to nil. 
+There are no consistent of ways of accurately obtaining that what the optional default value is. 
+Since this library's focus is to recreate the public API of a ruby method a default values lies in the private implementation and is out of scope. 
+
+## 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]/reverse_parameters. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,3 @@
+class ReverseParameters
+  VERSION = "0.1.0"
+end

data/lib/reverse_parameters.rb

@@ -0,0 +1,94 @@
+require "reverse_parameters/version"
+
+class ReverseParameters
+
+  def initialize(input)
+    if input.respond_to?(:to_proc)
+      @params = input.to_proc.parameters
+    elsif input.respond_to?(:to_ary)
+      @params = input.to_ary
+    else
+      raise ArgumentError.new("Input must be an Array of parameters or a Proc object.")
+    end
+  end
+
+  # Method parameters are the names listed in the function definition.
+  def parameters
+    Parameters.new(params)
+  end
+
+  # Method arguments are the real values passed to (and received by) the function.
+  def arguments
+    Arguments.new(params)
+  end
+
+  private
+  attr_reader :params
+
+  class BaseCollection
+    include Enumerable
+
+    def initialize(collection)
+      @collection = collection.map{|state, name| item_class.new(state: state, name: name)}
+    end
+
+    def each(&block)
+      @collection.send(:each, &block)
+    end
+
+    def to_s
+      to_a.join(', ')
+    end
+
+    def to_a
+      map(&:to_s)
+    end
+
+    class Item
+      def initialize(name:, state:)
+        @name  = name
+        @state = state
+      end
+      attr_reader :name, :state
+    end
+  end
+
+  class Arguments < BaseCollection;
+    class Arg < BaseCollection::Item
+      def to_s
+        case state
+          when :key, :keyreq
+            "#{name}: #{name}"
+          else
+            name
+        end.to_s
+      end
+    end
+
+    def item_class
+      Arguments::Arg
+    end
+  end
+  class Parameters < BaseCollection;
+    class Param < BaseCollection::Item
+      def to_s
+        case state
+          when :req
+            name
+          when :rest
+            "*#{name}"
+          when :opt
+            "#{name}=nil"
+          when :keyreq
+            "#{name}:"
+          when :key
+            "#{name}: nil"
+        end.to_s
+      end
+    end
+
+    def item_class
+      Parameters::Param
+    end
+  end
+end

data/reverse_parameters.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reverse_parameters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reverse_parameters"
+  spec.version       = ReverseParameters::VERSION
+  spec.authors       = ["Dustin Zeisler"]
+  spec.email         = ["dustin@zeisler.net"]
+
+  spec.summary       = %q{Recreate ruby method signatures.}
+  spec.description   = %q{Recreate ruby method signatures using ruby's method to Proc creation #method(:method_name).parameters. Use this to dynamically recreate method interfaces.}
+  spec.homepage      = "https://github.com/zeisler/reverse_parameters"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.1'
+
+  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 "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: reverse_parameters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dustin Zeisler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-29 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 'Recreate ruby method signatures using ruby''s method to Proc creation
+  #method(:method_name).parameters. Use this to dynamically recreate method interfaces.'
+email:
+- dustin@zeisler.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/reverse_parameters.rb
+- lib/reverse_parameters/version.rb
+- reverse_parameters.gemspec
+homepage: https://github.com/zeisler/reverse_parameters
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Recreate ruby method signatures.
+test_files: []