arity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 351129da5280429ffcbd59db97d3e63e5fefa318
+  data.tar.gz: 2c6909a6ef229c5fcc696cf25ceef7e822cf3f07
+SHA512:
+  metadata.gz: 7f36e9e56e66ea4f7e9d124ce1ba8fcabc238358a9ed29d87f4e8e1f8a56ddc34d162f971a46e9d21f571f92c76cc1abe63ac9ab8342284d58d7a0bc767ea92e
+  data.tar.gz: 3959f8ceb2c80f0bb9cf960b41668678dfea2c84d5e7c08a352d7a146d276cce96d6622529b584a3d48bc821c78a32404c9e2c6265ed698cda6bab1fad8e4c83

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Feldman
+
+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,45 @@
+# Arity
+
+Logic to determine when Ruby functions can be called.
+
+## Installation
+
+Add `gem 'arity'` to your Gemfile.
+
+## Usage
+```ruby
+function = Arity::Function.make(some_callable)
+# note the use of .make versus .new
+# some_callable should respond to :call
+# otherwise, .make will raise an Arity::NotCallableError
+# to avoid raising, pass {silent: true} to .make and it will return nil instead
+```
+```ruby
+function.arity
+# delegates to Ruby's built-in arity logic
+```
+```ruby
+function.takes?(arg_count: 3, keywords: [:things])
+# determines if the supplied method parameter structure is valid.
+```
+```ruby
+function.runnable?('thing-1','thing-2','thing-3', things: 3)
+# computes the parameter structure and delegates to .takes?
+```
+```ruby
+function.run('thing-1','thing-2','thing-3', things: 3)
+# calls .call on the callable with the supplied parameters
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fledman/arity.
+
+## 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/arity.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "arity"
+  spec.version       = Arity::VERSION
+  spec.authors       = ["David Feldman"]
+  spec.email         = ["dbfeldman@gmail.com"]
+
+  spec.summary       = "logic regarding function arity"
+  spec.description   = "logic to determine when Ruby functions can be called"
+  spec.homepage      = "https://github.com/fledman/arity"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "arity"
+
+require "pry"
+require "irb"
+
+IRB.start

data/bin/setup

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

data/lib/arity.rb

@@ -0,0 +1,3 @@
+require "arity/version"
+require "arity/errors"
+require "arity/function"

data/lib/arity/errors.rb

@@ -0,0 +1,4 @@
+module Arity
+  class NotCallableError < StandardError; end
+  class UnknownParameterTypeError < StandardError; end
+end

data/lib/arity/function.rb

@@ -0,0 +1,106 @@
+module Arity
+  class Function
+
+    attr_reader :callable
+
+    private_class_method :new
+
+    def self.make(fn, silent: false)
+      return new(fn) if fn.respond_to?(:call)
+      return if silent
+      raise NotCallableError, "function is not callable: #{fn.inspect}"
+    end
+
+    def initialize(fn)
+      @callable = unwrap_function(fn)
+    end
+
+    def arity
+      callable.arity
+    end
+
+    def signature
+      @signature ||= compute_signature
+    end
+
+    def takes?(arg_count:, keywords:)
+      bad_param('arg_count', 'an int', arg_count) if !arg_count.is_a?(Integer)
+      bad_param('keywords', 'an array', keywords) if !keywords.is_a?(Array)
+
+      return false if arg_count < signature[:min_args]
+
+      if signature[:max_args] > -1
+        return false if arg_count > signature[:max_args]
+      end
+
+      missing = signature[:required_keys] - keywords
+      return false if !missing.empty?
+
+      return true if signature[:any_key]
+
+      extra_keys = keywords - signature[:required_keys] \
+                            - signature[:optional_keys]
+      extra_keys.empty?
+    end
+
+    def runnable?(*args, **opts)
+      takes?(arg_count: args.size, keywords: opts.keys)
+    end
+
+    def run(*args, **opts)
+      args.push(opts) unless opts.empty?
+      callable.call(*args)
+    end
+
+    private
+
+    def unwrap_function(fn)
+      fn.respond_to?(:arity) ? fn : fn.method(:call)
+    end
+
+    def unknown_parameter_type!(type, name)
+      msg  = "do not known how to parse the function signature"
+      msg += " for type #{type.inspect} with parameter #{name.inspect}"
+      msg += "; please file an issue at https://www.github.com/fledman/arity"
+      raise UnknownParameterTypeError, msg
+    end
+
+    def bad_param(name, type, value)
+      raise ArgumentError, "#{name} must be #{type}, got: #{value.inspect}"
+    end
+
+    def compute_signature
+      splat = false
+      { min_args: 0,
+        max_args: 0,
+        required_keys: [],
+        optional_keys: [],
+        any_key: false
+      }.tap do |signature|
+        callable.parameters.each do |type,name|
+          case type
+          when :req
+            signature[:min_args] += 1
+            signature[:max_args] += 1
+          when :opt
+            signature[:max_args] += 1
+          when :rest
+            splat = true
+          when :key
+            signature[:optional_keys] << name
+          when :keyreq
+            signature[:required_keys] << name
+          when :keyrest
+            signature[:any_key] = true
+          else
+            unknown_parameter_type!(type, name)
+          end
+        end
+        signature[:max_args] = -1 if splat
+        signature[:required_keys].freeze
+        signature[:optional_keys].freeze
+      end.freeze
+    end
+
+  end
+end

data/lib/arity/version.rb

@@ -0,0 +1,3 @@
+module Arity
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: arity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Feldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-10 00:00:00.000000000 Z
+dependencies:
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: logic to determine when Ruby functions can be called
+email:
+- dbfeldman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arity.gemspec
+- bin/console
+- bin/setup
+- lib/arity.rb
+- lib/arity/errors.rb
+- lib/arity/function.rb
+- lib/arity/version.rb
+homepage: https://github.com/fledman/arity
+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.8
+signing_key: 
+specification_version: 4
+summary: logic regarding function arity
+test_files: []