nifty-variants 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5574aca0890dc28da6736189ba3a749b06fd1590
+  data.tar.gz: e47d15b310ff5461e757957c82484e16b6db4db9
+SHA512:
+  metadata.gz: 10677127ef34f17ed0c9131bc2bb0cb95ae3bce6289b300792571d7250b509d3330c050d16e0c3b9ccc5fa8cd858a2e2084934efa033221945aecd54486cfa57
+  data.tar.gz: ebd51fefa61f36f74d462cedbd25ce39a2f2f933852f7940ffdb0946eef7d45eb905b65e83a4414c5837dbdb861be293c4b6473eb13e564bd5611772036cb6d1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'generative', '~> 0.2.x', git: 'git@github.com:justincampbell/generative.git'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nate West
+
+MIT License
+
+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,47 @@
+# Nifty::Variants
+
+If you are familiar with variants from a nice language like Haskell try this.
+
+If you don't know what variants are [start here](http://youtu.be/ZQkIWWTygio)
+
+**NOTE** Nifty::Variants makes use of Refinements which weren't introduced until
+Ruby 2.1 and as a result no Ruby below 2.1 is supported. You're welcome to write
+a fancy shim, but I don't recommend it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nifty-variants'
+```
+
+And then execute:
+
+    $ bundle install -j2
+
+## Usage
+
+`nifty-variants` makes use of Refinements which were introduced in Ruby 2.1.
+In order to use it in your class or module simply use it.
+
+```ruby
+class OrderDispatch
+  using Nifty::Variants
+
+  def shipit!(order)
+    cases order,
+      digital: ->(o) { o.email! },
+      delivery: ->(o) { o.deliver! }
+      else: ->(o) { move_to_error_queue(o) }
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/nifty-variants/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,10 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'generative/rake_task'
+
+task(:default).enhance [:spec, :generative]
+
+RSpec::Core::RakeTask.new
+Generative::RakeTask.new
+
+task :default => :spec

data/lib/nifty/variants/version.rb

@@ -0,0 +1,5 @@
+module Nifty
+  module Variants
+    VERSION = "1.0.0"
+  end
+end

data/lib/nifty/variants.rb

@@ -0,0 +1,29 @@
+require "nifty/variants/version"
+
+module Nifty
+  module Variants
+    class NonExhaustiveMatches < StandardError; end
+    class NonVariant < StandardError
+      def initialize(msg="variants looks like [:type, some_obj]")
+        super(msg)
+      end
+    end
+
+    refine Object do
+      def cases(variant, matches)
+        raise NonVariant unless is_variant?(variant)
+        type, *obj = variant
+        m = matches[type]   ||
+            matches[:else]  ||
+            (raise NonExhaustiveMatches, ": #{matches.keys}")
+        m.call(*obj)
+      end
+
+      def is_variant?(variant)
+        return false unless variant.is_a?(Array)
+        type, *rest = variant
+        !rest.empty? && type.is_a?(Symbol)
+      end
+    end
+  end
+end

data/nifty-variants.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nifty/variants/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nifty-variants"
+  spec.version       = Nifty::Variants::VERSION
+  spec.authors       = ["Nate West"]
+  spec.email         = ["natescott.west@gmail.com"]
+  spec.summary       = %q{Variants in Ruby}
+  spec.description   = %q{Variants in Ruby}
+  spec.homepage      = "http://github.com/niftyn8/nifty-variants"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec-core', '~> 3.1.3'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'degenerate'
+end

data/spec/generators/order.rb

@@ -0,0 +1,39 @@
+class OrderDispatch
+  using Nifty::Variants
+
+  def self.send_to(place)
+    place
+  end
+
+  def self.dispatch(order)
+    cases order,
+      pickup: ->(o) { send_to(o.store_id) },
+      digital: ->(o) { send_to(o.email) },
+      delivery: ->(o) { send_to(o.address) },
+      else: ->(o) { raise "Don't know how to handle #{o.type}" }
+  end
+end
+
+class Order
+  attr_reader :type, :address, :email, :store_id
+
+  def initialize(type: :pickup, address: "", email: "", store_id: "")
+    @type = type
+    @address = address
+    @email = email
+    @store_id = store_id
+  end
+
+  def to_variant
+    [type, self]
+  end
+end
+
+Generative.register_generator :order do |_|
+  Order.new(
+            type: [:pickup, :digital, :delivery].sample,
+            address: Generative.generate(:string, limit: 100),
+            email: Generative.generate(:string, limit: 100),
+            store_id: Generative.generate(:integer)
+           )
+end

data/spec/lib/nifty/order_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe Order do
+  describe "#to_variant" do
+    generative do
+      for_every(:order) { generate(:order) }
+
+      it "returns a tuple-like variant" do
+        o = order
+        variant, *obj = o.to_variant
+        expect(variant).to eq o.type
+        expect(*obj).to eq o
+      end
+    end
+  end
+end
+
+RSpec.describe OrderDispatch do
+  describe ".dispatch" do
+    generative do
+      for_every(:order) { generate(:order) }
+
+      let(:method_for) {
+        {
+          pickup: :store_id,
+          digital: :email,
+          delivery: :address
+        }
+      }
+
+      it "returns the proper place" do
+        o = order
+        expected_place = o.send(method_for[o.type])
+
+        expect(OrderDispatch.dispatch(o.to_variant)).to eq expected_place
+      end
+
+      it "raises an exception for unknown order types" do
+        type = generate(:string, limit: 10)
+        expect { OrderDispatch.dispatch([type, order]) }.to raise_error
+      end
+    end
+  end
+end

data/spec/lib/nifty/variants_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+RSpec.describe Nifty::Variants do
+  using Nifty::Variants
+
+  describe "cases" do
+    generative do
+      for_every(:variant) { generate(:variant) }
+      for_every(:nonvariant) { generate(:nonvariant) }
+
+      it "lets you know if your matches aren't exhaustive" do
+        expect {
+          cases variant, {}
+        }.to raise_error(Nifty::Variants::NonExhaustiveMatches)
+      end
+
+      it "can take advantage of an else" do
+        v = variant
+        expect(
+          cases v,
+            else: ->(_) { v.first }
+        ).to eq v.first
+      end
+
+      it "selects the correct variant match" do
+        v = variant
+        expect(
+          cases v,
+            generate(:key) => ->(*_) { false },
+            generate(:key) => ->(*_) { false },
+            v.first => ->(*_) { true }
+        ).to be true
+      end
+    end
+  end
+
+  describe "is_variant?" do
+    generative do
+      for_every(:variant) { generate(:variant) }
+      for_every(:nonvariant) { generate(:nonvariant) }
+
+      it "returns true for valid variants" do
+        expect(is_variant?(variant)).to be true
+      end
+
+      it "returns false of invalid variants" do
+        expect(is_variant?(nonvariant)).to be false
+      end
+    end
+  end
+
+  Generative.register_generator(:key) do |_|
+    Generative.generate(:string, limit: 10).to_sym
+  end
+
+  Generative.register_generator(:variant) do |_|
+    [Generative.generate(:key), Generative.generate(:order)]
+  end
+
+  Generative.register_generator(:nonvariant) do |_|
+    generator = Generative.manager.generators.keys.select { |g|
+      !g.to_s.match(/variant/)
+    }.sample
+
+    Generative.find_and_call(generator, limit: 100)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require_relative '../lib/nifty/variants'
+require 'generative'
+require 'degenerate'
+require 'generators/order'
+require 'pry'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: nifty-variants
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nate West
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.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: degenerate
+  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: Variants in Ruby
+email:
+- natescott.west@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nifty/variants.rb
+- lib/nifty/variants/version.rb
+- nifty-variants.gemspec
+- spec/generators/order.rb
+- spec/lib/nifty/order_spec.rb
+- spec/lib/nifty/variants_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/niftyn8/nifty-variants
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Variants in Ruby
+test_files:
+- spec/generators/order.rb
+- spec/lib/nifty/order_spec.rb
+- spec/lib/nifty/variants_spec.rb
+- spec/spec_helper.rb