quacks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb32509485b5d1544468fd3c8b3d2febba4f0bb8
+  data.tar.gz: e089a05755d5f489607f152357ca150510f9f353
+SHA512:
+  metadata.gz: c2cc4349f1c9924a8ec49747995d8134e4c66882e74a68b67f906b9c2b3fd72a295af65475bb622fdde60249aa612f68ca3f58d79b3f569855bf1355ee9e536e
+  data.tar.gz: 1949d819ce3167c0582be5520ba0653f1ec2377ab2dca4b6fdb9a669306dc7d9182c54a316317e0e05ce868b0482c656ddceef6cb44162c9a59be208767edccb

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.15.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 quack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Emric
+
+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,72 @@
+# Quack
+Quack makes ducktyping easy!
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quack
+
+## Usage
+To use Quack you annotate your methods with the `.quacks_like` method.
+
+```ruby
+def add(int_a, int_b)
+  int_a + int_b
+end
+quacks_like :add, :to_i, :to_i
+```
+
+This will automatically convert the arguments if possible:
+
+```ruby
+add('1', 2)
+#=> 3
+```
+
+If the arguments can not be converted an error will be raised:
+```ruby
+add(1, {})
+#=> Quack::SignatureError: `{}` must respond to `to_i`.
+```
+
+You can force symbol arguments to be converted like so:
+```ruby
+def divide(int_a, divisor: 2)
+  int_a / divisor
+end
+quacks_like :divide, :to_i, divisor: :to_f
+```
+
+If you want to add a signature to a class method you use the singleton class:
+```ruby
+class Calculator
+  def self.add(int_a, int_b)
+    int_a + int_b
+  end
+  singleton_class.quacks_like :add, :int_a, :int_b
+end
+```
+
+## 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]/quack.
+
+## 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 "quack"
+
+# 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(__FILE__)

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/quacks.rb

@@ -0,0 +1,16 @@
+require "quacks/version"
+require "quacks/signature"
+require "quacks/default_convertor"
+require "quacks/hash_convertor"
+require "quacks/error"
+require "quacks/signature_error"
+require "quacks/wrong_number_of_arguments_error"
+require "quacks/quackable"
+
+module Quacks
+end
+
+class Object
+  extend Quacks::Quackable
+  singleton_class.extend Quacks::Quackable
+end

data/lib/quacks/default_convertor.rb

@@ -0,0 +1,34 @@
+# Internal: The default convertor class to be used in order to convert a single
+# argument.
+class Quacks::DefaultConvertor
+  attr_reader :conversion_method
+
+  # Internal: Initialize a DefaultConvertor.
+  #
+  # conversion_method - The method to call that does the conversion
+  def initialize(conversion_method)
+    @conversion_method = conversion_method
+  end
+
+  # Internal: Converts the given argument with the conversion method given in the
+  # initializer.
+  #
+  # argument - Any object to convert.
+  #
+  # Returns the converted argument.
+  # Raises Quacks::SignatureError if the argument could not be converted.
+  def convert!(argument)
+    return argument.public_send(conversion_method) if convertable?(argument)
+    raise(Quacks::SignatureError,
+          "`#{argument}` must respond to `#{conversion_method}`")
+  end
+
+  private
+
+  # Internal: Tells whether the provided argument can be converted or not.
+  #
+  # Returns a Bool.
+  def convertable?(argument)
+    argument.respond_to? conversion_method
+  end
+end

data/lib/quacks/error.rb

@@ -0,0 +1,2 @@
+class Quacks::Error < StandardError
+end

data/lib/quacks/hash_convertor.rb

@@ -0,0 +1,32 @@
+# Internal: The convertor class to iterate and convert symbol arguments or
+# hashes.
+class Quacks::HashConvertor
+  attr_reader :conversion_methods
+
+  # Internal: Initialize a HashConvertor.
+  #
+  # conversion_methods - The keywords and conversion methods to be used.
+  def initialize(conversion_methods)
+    @conversion_methods = conversion_methods
+  end
+
+  # Internal: Converts the given symbol arguments with the provided conversion
+  # methods.
+  #
+  # argument_hash - The hash with arguments to convert.
+  #
+  # Examples:
+  #
+  #   convertor = Quacks::HashConvertor.new(word: :to_s, number: :to_i)
+  #   convertor.convert!(word: nil, number: "100")
+  #   #=> { word: "", number: 100 }
+  #
+  # Returns an Hash with the converted arguments.
+  # Raises Quacks::SignatureError if the arguments could not be converted.
+  def convert!(argument_hash)
+      conversion_methods
+        .each_with_object(argument_hash) do |(name, conversion), args|
+      args[name] = Quacks::DefaultConvertor.new(conversion).convert!(args[name])
+    end
+  end
+end

data/lib/quacks/quackable.rb

@@ -0,0 +1,40 @@
+# Public: Concern to be extended in order to enable the quacks like method.
+module Quacks::Quackable
+  # Public: Force the given method to use the given conversions for its
+  # arguments.
+  #
+  # Examples
+  #   class Calculator
+  #     def add(int_a, int_b)
+  #       int_a + int_b
+  #     end
+  #     quacks_like :add, :to_i, :to_i
+  #   end
+  #
+  #   # Supported arguments will be converted accordingly.
+  #   Calculator.new.add(1, '2')
+  #   #=> 3
+  #
+  #   # Unspported arguments will raise an error
+  #   Calculator.new.add(1, {})
+  #   #=> SignatureError: Expected `{}` to respond to `to_i`.
+  #
+  #   # To add signatures to class methods you can use the singleton class.
+  #   class Calculator
+  #     singleton_class.extend(Quacks::Quackable)
+  #
+  #     def self.add(int_a, int_b)
+  #       int_a + int_b
+  #     end
+  #     singleton_class.quacks_like :add, :to_i, :to_i
+  #   end
+  #
+  # Returns the Symbol method name.
+  def quacks_like(method_name, *signature_args)
+    alias_method "orig_#{method_name}", method_name
+    define_method(method_name) do |*args|
+      signature = Quacks::Signature.new(*signature_args)
+      send("orig_#{method_name}", *signature.apply!(*args))
+    end
+  end
+end

data/lib/quacks/signature.rb

@@ -0,0 +1,74 @@
+# Internal: The class responsible for massaging parameters before passing them
+# to the signatured method.
+class Quacks::Signature
+  attr_reader :signature
+
+  # Internal: Initialize a signature object.
+  #
+  # signature - The Symbol or Hash conversion method(s) that depicts this
+  #   signature.
+  def initialize(*signature)
+    @signature = signature
+  end
+
+  # Internal: Convert the given arguments, with the given conversion methods.
+  #
+  # Examples:
+  #
+  #   Quacks::Signature.new(:to_i, bignum: :to_s).apply!('1', 100)
+  #   #=> [1, { bignum: '100' }]
+  #
+  # Returns an Array of arguments.
+  # Raises Quacks::SignatureError if the arguments could not be converted.
+  # Raises Quacks::WrongNumberOfArgumentsError if wrong number of arguments.
+  def apply!(*args)
+    validate args, signature
+    signature.each_with_index.map do |arg_signature, i|
+      convert! args[i], arg_signature
+    end
+  end
+
+  private
+
+  # Internal: Returns a convertor to perform the given conversion.
+  #
+  # conversion - An Hash with conversions or a Symbol conversion.
+  #
+  # Returns a Quacks::HashConvertor or Quacks::DefaultConvertor instance.
+  def convertor_for(conversion)
+    convertor_class(conversion).new(conversion)
+  end
+
+  # Internal: Returns the class to be used for applying the given conversion.
+  #
+  # conversion = An Hash with conversions or a Symbol conversion.
+  def convertor_class(conversion)
+    case conversion
+    when Hash
+      Quacks::HashConvertor
+    else
+      Quacks::DefaultConvertor
+    end
+  end
+
+  # Internal: Converts the given arguments with the given conversion(s).
+  #
+  #
+  # arguments - The Hash symbol arguments or any Object to convert.
+  # conversion = An Hash with conversions or a Symbol conversion.
+  #
+  # Returns the converted argument.
+  def convert!(arguments, conversion)
+    convertor_for(conversion).convert!(arguments)
+  end
+
+  # Internal: Determine if correct number of arguments were given.
+  #
+  # Returns true if correct number of arguments.
+  # Raises Quacks::WrongNumberOfArgumentsError if wrong number of arguments
+  #   given.
+  def validate(arguments, signature)
+    return true if arguments.length == signature.length
+    raise Quacks::WrongNumberOfArgumentsError
+  end
+end

data/lib/quacks/signature_error.rb

@@ -0,0 +1,2 @@
+class Quacks::SignatureError < Quacks::Error
+end

data/lib/quacks/version.rb

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

data/lib/quacks/wrong_number_of_arguments_error.rb

@@ -0,0 +1,2 @@
+class Quacks::WrongNumberOfArgumentsError < ArgumentError
+end

data/quacks.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "quacks/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "quacks"
+  spec.version       = Quacks::VERSION
+  spec.authors       = ["Emric"]
+  spec.email         = ["w.e.w@live.se"]
+
+  spec.summary       = "Add signatures to your methods"
+  spec.homepage      = "http://github.com/istanful/quacks"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: quacks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emric
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: 
+email:
+- w.e.w@live.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/quacks.rb
+- lib/quacks/default_convertor.rb
+- lib/quacks/error.rb
+- lib/quacks/hash_convertor.rb
+- lib/quacks/quackable.rb
+- lib/quacks/signature.rb
+- lib/quacks/signature_error.rb
+- lib/quacks/version.rb
+- lib/quacks/wrong_number_of_arguments_error.rb
+- quacks.gemspec
+homepage: http://github.com/istanful/quacks
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Add signatures to your methods
+test_files: []