dux 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d20cd7046baebf04427f80b205d460b4931e6284
+  data.tar.gz: 97250074fa582b00cafce8cb3b3d38fb98be0b50
+SHA512:
+  metadata.gz: 1fc05fe33a193d4a3298aba28c9fa7b7f7a3f63c66d3a02f95acde4545a7fa01ebea4eba930ab419ffbdf6f17e5c7f81e3e9bbd98212387db40a613fbdad4ff0
+  data.tar.gz: f5aab9d54d3ca4c1ce2a2d2f0bd173c5f03a52a29a7dfc52237a820db20b37ce4d6f32f3975288ceb7e02304d1c4e252de62fad3458dc8cbf127e529d5e7f2ad

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.1
+  - ruby-head
+  - rbx-2
+  - jruby-head

data/.yardopts

@@ -0,0 +1,8 @@
+--private
+--protected
+-m markdown
+lib/**/*.rb
+-
+README.md
+CODE_OF_CONDUCT.md
+LICENSE.txt

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+# @markup markdown
+# @title Contributor Code of Conduct
+# 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, 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 dux.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alexa Grey
+
+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,123 @@
+# Dux
+
+A lazy duck-type matching gem that is particularly designed for use in case statements.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dux'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dux
+
+## Usage
+
+Usage is straightforward out of the box:
+
+```ruby
+case foo
+when Dux[:bar] then foo.bar
+when Dux[:baz] then foo.baz
+when Dux[:quux] then foo.quux
+end
+```
+
+It also has some methods for matching against a strict interface:
+
+```ruby
+case foo
+when Dux.all(:bar, :baz) then foo.bar && foo.baz
+when Dux.any(:quux, :bloop) then foo.try(:quux) || foo.try(:bloop)
+end
+```
+
+### Core Extensions
+
+There are a few core extensions available that can be manually enabled.
+
+#### String / Symbol
+
+Strings and symbols can have a `duckify` method added that operates the same
+way as `Dux.[]`:
+
+```ruby
+Dux.extend_strings_and_symbols!
+
+# Or, if you only want to touch one class:
+# Dux.extend_strings!
+# Dux.extend_symbols!
+
+case foo
+when "bar".duckify then foo.bar
+when :baz.duckify then foo.baz
+end
+```
+
+#### Array
+
+There is also the ability to _duckify_ an array of strings or symbols for
+interface matching:
+
+```ruby
+Dux.add_flock_methods!
+
+case foo
+when %i[bar baz].duckify then foo.bar && foo.baz
+when %i[quux bloop].duckify(type: :any) then foo.try(:quux) || foo.try(:bloop)
+end
+```
+
+#### Shorthand
+
+There is an experimental option that uses unary `~` as an alias for `#duckify`.
+
+`Array#~`, `String#~`, and `Symbol#~` are presently not used by Ruby core, but
+other gems might define them.
+
+```ruby
+# Enable per class:
+Dux.array_shorthand!
+Dux.string_shorthand!
+Dux.symbol_shorthand!
+
+case foo
+when ~%i[bar baz] then foo.bar && foo.baz
+when ~:quux then foo.quux
+when ~"bloop" then foo.bloop
+end
+```
+
+#### All core extensions
+To enable all core extensions:
+
+```ruby
+# To enable flock methods and String / Symbol #duckify
+
+Dux.extend_all!
+
+# To enable the above as well as the unary ~ shorthand:
+
+Dux.extend_all! experimental: true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/scryptmouse/dux/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.verbose = false
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', '-', 'README.md', 'LICENSE.txt', 'CODE_OF_CONDUCT.md']
+  t.options = ['--private', '--protected']
+  t.stats_options = ['--list-undoc']
+end
+
+# If you want to make this the default task
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dux/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dux"
+  spec.version       = Dux::VERSION
+  spec.authors       = ["Alexa Grey"]
+  spec.email         = ["devel@mouse.vc"]
+
+  spec.summary       = %q{Lazy duck-type matching}
+  spec.homepage      = "https://github.com/scryptmouse/dux"
+  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.9"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "yard"
+end

data/lib/dux.rb

@@ -0,0 +1,175 @@
+require 'dux/version'
+require 'dux/duckify'
+require 'dux/hacks_like_a_duck'
+require 'dux/flock_methods'
+
+# Super simple duck-type testing.
+module Dux
+  # Methods for generating "interface" checks against an array of symbols
+  FLOCK_TYPES = %i[all any none]
+
+  module_function
+
+  # @param [Symbol] symbol
+  # @param [Boolean] include_all
+  # @return [Proc]
+  def dux(symbol, include_all: false)
+    ->(obj) { obj.respond_to? symbol, include_all }
+  end
+
+  class << self
+    alias_method :[], :dux
+
+    # @param [:all, :any, :none] type
+    # @param [<Symbol, String>] methods
+    # @param [Boolean] include_all
+    # @raise [ArgumentError] on invalid type
+    # @return [<Proc>]
+    def flock(type, *methods, include_all: false)
+      raise ArgumentError, "Invalid flock type: #{type}" unless FLOCK_TYPES.include? type
+
+      __send__ type, methods, include_all: include_all
+    end
+
+    # Creates a lambda that describes a restrictive interface,
+    # wherein the provided object must `respond_to?` *all* of
+    # the methods.
+    #
+    # @param [<Symbol, String>] methods
+    # @param [Boolean] include_all
+    # @return [Proc]
+    def all(*methods, include_all: false)
+      ducks = flockify methods, include_all: include_all
+
+      ->(obj) { ducks.all? { |duck| duck.call obj } }
+    end
+
+    # Creates a lambda that describes a permissive interface,
+    # wherein the provided object must `respond_to?` at least
+    # one of the methods.
+    #
+    # @param [<Symbol>] methods
+    # @param [Boolean] include_all
+    # @return [Proc]
+    def any(*methods, include_all: false)
+      ducks = flockify methods, include_all: include_all
+
+      ->(obj) { ducks.any? { |duck| duck.call obj } }
+    end
+
+    # Creates a lambda that describes a restrictive interface,
+    # wherein the provided object must `respond_to?` *none* of
+    # the methods.
+    #
+    # @param [<Symbol>] methods
+    # @param [Boolean] include_all
+    # @return [Proc]
+    def none(*methods, include_all: false)
+      ducks = flockify methods, include_all: include_all
+
+      ->(obj) { ducks.none? { |duck| duck.call obj } }
+    end
+
+    # @!group Core extensions
+
+    # Enhance `Array` with {Dux::FlockMethods#duckify}
+    #
+    # @return [void]
+    def add_flock_methods!
+
+      Array.prepend Dux::FlockMethods
+
+      return nil
+    end
+
+    # Load all `Dux` core extensions.
+    #
+    # @param [Boolean] experimental whether to load experimental shorthand methods
+    # @return [void]
+    def extend_all!(experimental: false)
+      add_flock_methods!
+      extend_strings_and_symbols!
+
+      return unless experimental
+
+      array_shorthand!
+      string_shorthand!
+      symbol_shorthand!
+    end
+
+    # Enhance `String` with {Dux::Duckify}
+    #
+    # @return [void]
+    def extend_strings!
+      String.prepend Dux::Duckify
+
+      return nil
+    end
+
+    # Enhance `Symbol` with {Dux::Duckify}
+    #
+    # @return [void]
+    def extend_symbols!
+      Symbol.prepend Dux::Duckify
+
+      return nil
+    end
+
+    # Enhance `String` and `Symbol` classes with {Dux::Duckify#duckify}
+    #
+    # @return [void]
+    def extend_strings_and_symbols!
+      extend_strings!
+      extend_symbols!
+
+      return nil
+    end
+
+    # Experimental feature to add unary `~` to `Array`s
+    # for quick usage in case statements.
+    #
+    # @return [void]
+    def array_shorthand!
+      add_flock_methods!
+
+      Array.prepend Dux::HacksLikeADuck
+
+      nil
+    end
+
+    # Experimental feature to add unary `~` to `String`s
+    # for quick usage in case statements.
+    #
+    # @return [void]
+    def string_shorthand!
+      extend_strings!
+      String.prepend Dux::HacksLikeADuck
+
+      nil
+    end
+
+    # Experimental feature to add unary `~` to `Symbol`s
+    # for quick usage in case statements.
+    #
+    # @return [void]
+    def symbol_shorthand!
+      extend_symbols!
+
+      Symbol.prepend Dux::HacksLikeADuck
+
+      return nil
+    end
+
+    # @!endgroup
+
+    protected
+    # @param [<Symbol>] methods
+    # @param [Boolean] include_all
+    # @return [<Proc>]
+    def flockify(methods, include_all: false)
+      methods.flatten.map do |sym|
+        dux sym, include_all: include_all
+      end
+    end
+  end
+end

data/lib/dux/duckify.rb

@@ -0,0 +1,30 @@
+module Dux
+  # Adds a fluent {#duckify} method to classes that include / prepend.
+  #
+  # Non-stringish / symbol classes should override {#for_duckify} to
+  # return a string or symbol.
+  module Duckify
+    # @return [self, String, Symbol]
+    def for_duckify
+      self
+    end
+
+    # @param [Boolean] include_all
+    # @return [Proc]
+    def duckify(include_all: false)
+      dux for_duckify, include_all: include_all
+    end
+
+    class << self
+      # @api private
+      # @param [Class] base
+      # @return [void]
+      def included(base)
+        base.__send__ :include, Dux
+      end
+
+      alias_method :prepended, :included
+      alias_method :extended, :included
+    end
+  end
+end

data/lib/dux/flock_methods.rb

@@ -0,0 +1,12 @@
+module Dux
+  # Can be included on any Array or Array-like (implements `#to_a`)
+  # to grant it a fluent method for generating duck checks.
+  module FlockMethods
+    # @param [:all, :any, :none] type
+    # @param [Boolean] include_all
+    # @return [<Proc>]
+    def duckify(type: :all, include_all: false)
+      Dux.flock type, to_a, include_all: include_all
+    end
+  end
+end

data/lib/dux/hacks_like_a_duck.rb

@@ -0,0 +1,12 @@
+module Dux
+  # Experimental module to grant unary `~` to symbols or strings for duck-checking
+  module HacksLikeADuck
+
+    # Transform into a proc that asks its argument if it responds to `self`
+    #
+    # @return [Proc]
+    def ~
+      duckify
+    end
+  end
+end

data/lib/dux/version.rb

@@ -0,0 +1,4 @@
+module Dux
+  # Gem version.
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: dux
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexa Grey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+- !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: 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: simplecov
+  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: yard
+  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:
+- devel@mouse.vc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dux.gemspec
+- lib/dux.rb
+- lib/dux/duckify.rb
+- lib/dux/flock_methods.rb
+- lib/dux/hacks_like_a_duck.rb
+- lib/dux/version.rb
+homepage: https://github.com/scryptmouse/dux
+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
+signing_key: 
+specification_version: 4
+summary: Lazy duck-type matching
+test_files: []
+has_rdoc: