dux 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d20cd7046baebf04427f80b205d460b4931e6284
-  data.tar.gz: 97250074fa582b00cafce8cb3b3d38fb98be0b50
+  metadata.gz: 8549a025dd5d4bd0d25700d7155a99ac46d222cc
+  data.tar.gz: 187be7a1fcfa97857bf948f846218131889aa17e
 SHA512:
-  metadata.gz: 1fc05fe33a193d4a3298aba28c9fa7b7f7a3f63c66d3a02f95acde4545a7fa01ebea4eba930ab419ffbdf6f17e5c7f81e3e9bbd98212387db40a613fbdad4ff0
-  data.tar.gz: f5aab9d54d3ca4c1ce2a2d2f0bd173c5f03a52a29a7dfc52237a820db20b37ce4d6f32f3975288ceb7e02304d1c4e252de62fad3458dc8cbf127e529d5e7f2ad
+  metadata.gz: a24dddfbe3465f64ac539c33a38c8369cb854761acaf72616b9c070c6d3b85c92c9b0effc7d022c0477ddd02fc733c9386ea886213a5568bf895fb63b062b9b2
+  data.tar.gz: d5ab3bff61e513d04bef1b78acb5afa218ee8dbd96cf35817913301fd9ada0e8b1ec0be57819b7571bdf593c693855571f9213ec68aa347f92d4a49ce330f241

data/.travis.yml

@@ -1,8 +1,12 @@
 language: ruby
+dist: trusty
+before_install: gem install bundler -v '~> 1.14'
+cache: bundler
 rvm:
-  - 2.0.0
   - 2.1.0
   - 2.2.1
+  - 2.3.0
+  - 2.4.0
   - ruby-head
-  - rbx-2
+  - rbx-3.73
   - jruby-head

data/README.md

@@ -1,4 +1,4 @@
-# Dux
+# Dux [![Build Status](https://travis-ci.org/scryptmouse/dux.svg?branch=master)](https://travis-ci.org/scryptmouse/dux)
 
 A lazy duck-type matching gem that is particularly designed for use in case statements.
 
@@ -114,6 +114,12 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+## Supported Ruby Versions
+
+* MRI 2.1+
+* Rubinius 2.5+
+* jruby-head / 9.0+
+
 ## Contributing
 
 1. Fork it ( https://github.com/scryptmouse/dux/fork )

data/Rakefile

@@ -1,3 +1,4 @@
+require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'yard'
@@ -13,5 +14,4 @@ YARD::Rake::YardocTask.new do |t|
   t.stats_options = ['--list-undoc']
 end
 
-# If you want to make this the default task
 task :default => :spec

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/dux.gemspec

@@ -18,10 +18,14 @@ Gem::Specification.new do |spec|
   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"
+  spec.metadata["yard.run"] = "yri"
+
+  spec.add_dependency "lru_redux"
+
+  spec.add_development_dependency "bundler",    "~> 1.9"
+  spec.add_development_dependency "rspec",      "~> 3.5"
+  spec.add_development_dependency "rake",       "~> 12.0"
+  spec.add_development_dependency "pry",        "~> 0.10.1"
+  spec.add_development_dependency "simplecov",  "~> 0.14.1"
+  spec.add_development_dependency "yard",       "~> 0.9.8"
 end

data/lib/dux.rb

@@ -1,8 +1,17 @@
+require 'delegate'
+
 require 'dux/version'
+require 'dux/inspect_id'
+require 'dux/null_object'
+require 'dux/attempt'
+require 'dux/blankness'
 require 'dux/duckify'
 require 'dux/hacks_like_a_duck'
 require 'dux/flock_methods'
 
+require 'dux/indifferent_string'
+require 'dux/enum'
+
 # Super simple duck-type testing.
 module Dux
   # Methods for generating "interface" checks against an array of symbols
@@ -76,8 +85,7 @@ module Dux
     #
     # @return [void]
     def add_flock_methods!
-
-      Array.prepend Dux::FlockMethods
+      Array.__send__ :prepend, Dux::FlockMethods
 
       return nil
     end
@@ -101,7 +109,7 @@ module Dux
     #
     # @return [void]
     def extend_strings!
-      String.prepend Dux::Duckify
+      String.__send__ :prepend, Dux::Duckify
 
       return nil
     end
@@ -110,7 +118,7 @@ module Dux
     #
     # @return [void]
     def extend_symbols!
-      Symbol.prepend Dux::Duckify
+      Symbol.__send__ :prepend, Dux::Duckify
 
       return nil
     end
@@ -132,7 +140,7 @@ module Dux
     def array_shorthand!
       add_flock_methods!
 
-      Array.prepend Dux::HacksLikeADuck
+      Array.__send__ :prepend, Dux::HacksLikeADuck
 
       nil
     end
@@ -143,7 +151,7 @@ module Dux
     # @return [void]
     def string_shorthand!
       extend_strings!
-      String.prepend Dux::HacksLikeADuck
+      String.__send__ :prepend, Dux::HacksLikeADuck
 
       nil
     end
@@ -155,7 +163,7 @@ module Dux
     def symbol_shorthand!
       extend_symbols!
 
-      Symbol.prepend Dux::HacksLikeADuck
+      Symbol.__send__ :prepend, Dux::HacksLikeADuck
 
       return nil
     end

data/lib/dux/attempt.rb

@@ -0,0 +1,17 @@
+module Dux
+  # `Object#try` for when you don't want ActiveSupport
+  module Attempt
+    # @param [Object] receiver
+    # @param [Symbol] method
+    # @param [<Object>] args
+    # @return [Object]
+    # @return [nil]
+    def attempt(receiver, method, *args, &block)
+      receiver.public_send(method, *args, &block) if receiver.respond_to?(method)
+    end
+
+    extend self
+  end
+
+  extend Attempt
+end

data/lib/dux/blankness.rb

@@ -0,0 +1,38 @@
+module Dux
+  module Blankness
+    WHITESPACE_ONLY = /\A[[:space:]]+\z/
+
+    # Check if a provided object is semantically empty.
+    #
+    # @param [Object] value
+    def blankish?(value)
+      case value
+      when nil, false
+        true
+      when Dux[:nan?]
+        true
+      when String, Symbol
+        value.empty? || value =~ WHITESPACE_ONLY
+      when Dux[:blank?]
+        value.blank?
+      when Hash
+        value.empty?
+      when Array, Enumerable
+        Dux.attempt(value, :empty?) || value.all? { |val| blankish?(val) }
+      when Dux[:empty?]
+        value.empty?
+      else
+        false
+      end
+    end
+
+    # Boolean complement of {#blankish?}
+    #
+    # @param [Object] value
+    def presentish?(value)
+      !blankish?(value)
+    end
+
+    extend self
+  end
+end

data/lib/dux/enum.rb

@@ -0,0 +1,98 @@
+require 'set'
+
+module Dux
+  # A set of strings or symbols (indifferently stored)
+  # that can be used to validate options.
+  #
+  # Supports an optional default for when an invalid
+  # element is fetched to act as a fallback rather
+  # than raising an error.
+  class Enum
+    include Enumerable
+
+    NO_DEFAULT = Dux.null 'Dux::Enum::NO_DEFAULT', purpose: 'When no default has been provided'
+
+    private_constant :NO_DEFAULT
+
+    def initialize(*values, default: NO_DEFAULT, allow_nil: false)
+      @allow_nil = allow_nil
+
+      set_values values
+
+      set_default default
+    end
+
+    def default?
+      @default != NO_DEFAULT
+    end
+
+    def each
+      return enum_for(__method__) unless block_given?
+
+      @values.each do |value|
+        yield value
+      end
+    end
+
+    def fetch(value, fallback: NO_DEFAULT)
+      if include? value
+        value
+      elsif fallback != NO_DEFAULT
+        if valid_fallback?(fallback)
+          fallback
+        else
+          raise InvalidFallback, "Cannot use #{fallback.inspect} as a fallback"
+        end
+      elsif default?
+        @default
+      else
+        raise NotFound, "Invalid enum member: #{value.inspect}"
+      end
+    end
+
+    alias_method :[], :fetch
+
+    def inspect
+      inspection = [
+        @values.to_a.inspect
+      ]
+
+      "Dux::Enum(#{@values.to_a.inspect})"
+    end
+
+    alias_method :has?, :include?
+    alias_method :member?, :include?
+
+    private
+
+    def set_values(values)
+      raise TypeError, "Must provide some values", caller if values.empty?
+
+      @values = values.flatten.map do |value|
+        Dux::IndifferentString.new value
+      end.to_set
+    end
+
+    def valid_fallback?(fallback, default: false)
+      return true if fallback.nil? && @allow_nil
+      return true if include? fallback
+
+      false
+    end
+
+    def set_default(fallback)
+      if valid_fallback?(fallback) || fallback == NO_DEFAULT
+        @default = fallback
+      else
+        raise InvalidFallback, "Cannot set #{fallback.inspect} as default", caller
+      end
+    end
+
+    # Raised when there is no fallback
+    class NotFound < StandardError
+    end
+
+    class InvalidFallback < ArgumentError
+    end
+  end
+end

data/lib/dux/indifferent_string.rb

@@ -0,0 +1,38 @@
+module Dux
+  class IndifferentString < DelegateClass(String)
+    def initialize(stringish)
+      stringified =
+        case stringish
+        when String then stringish
+        when Symbol then stringish.to_s
+        when Dux[:to_str] then stringish.to_str
+        else
+          if Dux.attempt(stringish, :acts_like?, :string)
+            stringish.to_s
+          else
+            raise TypeError, "Not a string or symbol: #{stringish}"
+          end
+        end
+
+      super(stringified)
+    end
+
+    def ==(other)
+      if other.kind_of?(Symbol)
+        self == other.to_s
+      else
+        super
+      end
+    end
+
+    alias_method :eql?, :==
+
+    def ===(other)
+      if other.kind_of?(Symbol)
+        self == other.to_s
+      else
+        super
+      end
+    end
+  end
+end

data/lib/dux/inspect_id.rb

@@ -0,0 +1,16 @@
+module Dux
+  module InspectID
+    # Calculates the id shown in the default
+    # version of `#inspect` methods.
+    #
+    # @param [Object] object
+    # @return [String]
+    def inspect_id(object)
+      "0x%0.14x" % ( object.object_id << 1 )
+    end
+
+    extend self
+  end
+
+  extend InspectID
+end

data/lib/dux/null_object.rb

@@ -0,0 +1,30 @@
+module Dux
+  class NullObject
+    include Dux::InspectID
+
+    attr_reader :name
+    attr_reader :purpose
+
+    # @param [String] name
+    # @param [String] purpose
+    def initialize(name, purpose: 'a null object')
+      @name     = name
+      @purpose  = purpose
+    end
+
+    private
+    def default_name
+      
+    end
+  end
+
+  class << self
+    # @param (@see Dux::NullObject#initialize)
+    # @return [Dux::NullObject]
+    def null_object(name, **options)
+      Dux::NullObject.new(name, **options)
+    end
+
+    alias_method :null, :null_object
+  end
+end

data/lib/dux/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: dux
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexa Grey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-05 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lru_redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -28,72 +42,72 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.8
 description: 
 email:
 - devel@mouse.vc
@@ -111,17 +125,27 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
+- bin/rspec
 - bin/setup
 - dux.gemspec
 - lib/dux.rb
+- lib/dux/attempt.rb
+- lib/dux/blankness.rb
+- lib/dux/duck_type.rb
 - lib/dux/duckify.rb
+- lib/dux/enum.rb
 - lib/dux/flock_methods.rb
 - lib/dux/hacks_like_a_duck.rb
+- lib/dux/indifferent_string.rb
+- lib/dux/inspect_id.rb
+- lib/dux/null_object.rb
 - lib/dux/version.rb
 homepage: https://github.com/scryptmouse/dux
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -138,9 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Lazy duck-type matching
 test_files: []
-has_rdoc: