first_of 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfa6409aeab593f113e0a33c7101b4436e48a376
+  data.tar.gz: 7819687d70b99d685eb4b558a2650849250f6df5
+SHA512:
+  metadata.gz: 520d9061901771af7850f611e2696376a090447d6a236f6dc6d28819a176d00924ccb7c0b4b520990e1e37e9bed6a1fc3d8cb982b352874d8fb79787990202ac
+  data.tar.gz: 0b218207ef65993a280fa96b1ffc79728350a954ab43075214165c6fd9747c47cfcd4d9896f80457ecf5c8e400065593ec1ed62301914cfe2d3a472125a87661

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.ruby-*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Dewitt
+
+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,29 @@
+# FirstOf
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'first_of'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install first_of
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run specs (default)"
+task :default => :spec
+
+Dir["lib/tasks/**/*.rake"].each { |ext| load ext } if defined?(Rake)

data/first_of.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'first_of/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "first_of"
+  spec.version       = FirstOf::VERSION
+  spec.authors       = ["Brandon Dewitt"]
+  spec.email         = ["brandonsdewitt@gmail.com"]
+  spec.description   = %q{ prioritize values of fallback methods }
+  spec.summary       = %q{ first_of allows you to setup a method that falls back to the next prioritized value
+                           if the first and subsequent return objects are not present.  To be used in situations
+                           where multiple values are "valid" but have a priority of when to use each value }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "activesupport"
+  spec.add_dependency "try_chain"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/first_of/core_ext/object/first_of.rb

@@ -0,0 +1,5 @@
+require 'first_of'
+
+class Object
+  include ::FirstOf
+end

data/lib/first_of/version.rb

@@ -0,0 +1,3 @@
+module FirstOf
+  VERSION = "0.0.1"
+end

data/lib/first_of.rb

@@ -0,0 +1,81 @@
+require "first_of/version"
+
+require "try_chain"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/array/extract_options"
+require "active_support/core_ext/object/try"
+
+module FirstOf
+
+  # Should take arguments:
+  # first_of(:symbol1, :symbol2) # will return first respond to and present
+  # first_of([:symbol1, :symbol2]) # will return value if try_chain(:symbol1, :symbol2) present
+  # first_of(1 => :symbol1, 2 => :symbol2) # will prioritize trying by key and return first present
+  # first_of(1 => :symbol1, 2 => lambda { _call }) # will prioritize and only execute callable if first not present
+  # first_of(1 => [:symbol1, :symbol2], 2 => -> { _call }) # will prioritize and execute try_chain on first and call 2nd if first not present
+  # first_of(1 => :symbol1, 2 => 4) # will prioritize and return value (4) if first not present
+  # first_of(lambda { _call }, 1 => :symbol1, 2 => :symbol2)
+  def first_of(*args)
+    extract_hash = args.extract_options!        
+
+    # Don't care if the hash is empty or not because of #each call
+    sorted_keys = extract_hash.keys.sort
+    sorted_keys.each do |key|
+      args << extract_hash[key]
+    end
+
+    args.each do |argument|
+      if argument.respond_to?(:call)
+        value = argument.call
+      else
+        value = _extract_from_message_chain(argument) # calls try_chain if array, or try if symbol, or returns value
+      end
+
+      return value if _valid_value?(value) # return value if found
+    end
+
+    return nil
+  end
+
+  def first_of!(*args)
+    extract_hash = args.extract_options!        
+
+    # Don't care if the hash is empty or not because of #each call
+    sorted_keys = extract_hash.keys.sort
+    sorted_keys.each do |key|
+      args << extract_hash[key]
+    end
+
+    args.each do |argument|
+      if argument.respond_to?(:call)
+        value = argument.call
+      else
+        value = _extract_from_message_chain(argument, :try_chain!, :proxy_try_chain!) # calls try_chain if array, or try if symbol, or returns value
+      end
+
+      return value if _valid_value?(value) # return value if found
+    end
+
+    return nil
+  end
+
+  private
+
+  def _extract_from_message_chain(methods_or_value, try_method = :try_chain, proxy_try_method = :proxy_try_chain)
+    case methods_or_value
+    when Symbol, Array then
+      if self.respond_to?(:try_chain)
+        self.__send__(try_method, *methods_or_value)
+      else
+        ::TryChain.__send__(proxy_try_method, self, *methods_or_value)
+      end
+    else
+      methods_or_value
+    end
+  end
+
+  def _valid_value?(value)
+    value.present? || [true, false].include?(value)
+  end
+
+end

data/spec/first_of_spec.rb

@@ -0,0 +1,208 @@
+require 'spec_helper'
+
+describe ::FirstOf do
+  class SpecObject
+    include ::FirstOf
+
+    def callable; return lambda { "here" }; end
+    def nothing; nil; end
+    def selfie; self; end
+    def something; true; end
+    def symbol; :symbol; end
+  end
+
+  context "#first_of" do
+    context ":symbol, :symbol args" do
+      it "returns the first symbolized argument that the object responds_to if the result is present" do
+        test = SpecObject.new
+        test.first_of(:something, :nothing).should be_true
+      end
+
+      it "returns the second symbolized argument that the object responds_to if the first is not present" do
+        test = SpecObject.new
+        test.first_of(:nothing, :something).should be_true
+      end
+
+      it "returns a symbol if the first present value is a symbol" do
+        test = SpecObject.new
+        test.first_of(:nothing, :symbol).should eq(:symbol)
+      end
+
+      it "does not throw an exception if the object does not respond to the symbol" do
+        test = SpecObject.new
+        expect { test.first_of(:nothing, :what) }.to_not raise_error
+      end
+    end
+
+    context "[:symbol :symbol]" do
+      it "returns the first symbolized argument that the object responds_to if the result is present" do
+        test = SpecObject.new
+        test.first_of([:selfie, :nothing]).should be_nil
+      end
+
+      it "returns the second symbolized argument that the object responds_to if the first is not present" do
+        test = SpecObject.new
+        test.first_of([:selfie, :something]).should be_true
+      end
+
+      it "returns a symbol if the first present value is a symbol" do
+        test = SpecObject.new
+        test.first_of([:selfie, :symbol]).should eq(:symbol)
+      end
+
+      it "does not throw an exception if the object does not respond to the symbol" do
+        test = SpecObject.new
+        expect { test.first_of([:selfie, :what]) }.to_not raise_error
+      end
+    end
+
+    context "lambda {}, :symbol" do
+      it "returns the first symbolized argument that the object responds_to if the result is present" do
+        test = SpecObject.new
+        test.first_of( -> { nil }, :nothing).should be_nil
+      end
+
+      it "returns the second symbolized argument that the object responds_to if the first is not present" do
+        test = SpecObject.new
+        test.first_of( -> { nil }, :something).should be_true
+      end
+
+      it "returns a symbol if the first present value is a symbol" do
+        test = SpecObject.new
+        test.first_of( -> { :symbol }, nil).should eq(:symbol)
+      end
+
+      it "does not throw an exception if the object does not respond to the symbol" do
+        test = SpecObject.new
+        expect { test.first_of( -> { nil }, :what) }.to_not raise_error
+      end
+    end
+
+    context "2 => :symbol, 1 => :symbol" do
+      it "prioritizes the return value by the hash key" do
+        test = SpecObject.new
+        test.first_of(2 => :selfie, 1 => :symbol).should eq(:symbol)
+      end
+
+      it "does not return the first hash key if not present" do
+        test = SpecObject.new
+        test.first_of(2 => :symbol, 1 => nil).should eq(:symbol)
+      end
+
+      it "returns a symbol if the first present value is a lambda that returns a symbol" do
+        test = SpecObject.new
+        test.first_of(1 => lambda { :selfie }, 2 => :symbol).should eq(:selfie)
+      end
+
+      it "does not throw an exception if the object does not respond to the symbol" do
+        test = SpecObject.new
+        expect { test.first_of(2 => :selfie, 1 => :what) }.to_not raise_error
+      end
+    end
+
+    context "lambda {}, 2 => :symbol, 1 => :symbol" do
+      it "prioritizes the lambda over the return value by the hash key" do
+        test = SpecObject.new
+        test.first_of(lambda { :lambda }, 2 => :selfie, 1 => :symbol).should eq(:lambda)
+      end
+    end
+  end
+
+  context "#first_of!" do
+    context ":symbol, :symbol args" do
+      it "returns the first symbolized argument that the object responds_to if the result is present" do
+        test = SpecObject.new
+        test.first_of!(:something, :nothing).should be_true
+      end
+
+      it "returns the second symbolized argument that the object responds_to if the first is not present" do
+        test = SpecObject.new
+        test.first_of!(:nothing, :something).should be_true
+      end
+
+      it "returns a symbol if the first present value is a symbol" do
+        test = SpecObject.new
+        test.first_of!(:nothing, :symbol).should eq(:symbol)
+      end
+
+      it "throws an exception if the object does not respond to the symbol" do
+        test = SpecObject.new
+        expect { test.first_of!(:nothing, :what) }.to raise_error
+      end
+    end
+
+    context "[:symbol :symbol]" do
+      it "returns the first symbolized argument that the object responds_to if the result is present" do
+        test = SpecObject.new
+        test.first_of!([:selfie, :nothing]).should be_nil
+      end
+
+      it "returns the second symbolized argument that the object responds_to if the first is not present" do
+        test = SpecObject.new
+        test.first_of!([:selfie, :something]).should be_true
+      end
+
+      it "returns a symbol if the first present value is a symbol" do
+        test = SpecObject.new
+        test.first_of!([:selfie, :symbol]).should eq(:symbol)
+      end
+
+      it "throws an exception if the object does not respond to the symbol" do
+        test = SpecObject.new
+        expect { test.first_of!([:selfie, :what]) }.to raise_error
+      end
+    end
+
+    context "lambda {}, :symbol" do
+      it "returns the first symbolized argument that the object responds_to if the result is present" do
+        test = SpecObject.new
+        test.first_of!( -> { nil }, :nothing).should be_nil
+      end
+
+      it "returns the second symbolized argument that the object responds_to if the first is not present" do
+        test = SpecObject.new
+        test.first_of!( -> { nil }, :something).should be_true
+      end
+
+      it "returns a symbol if the first present value is a symbol" do
+        test = SpecObject.new
+        test.first_of!( -> { :symbol }, nil).should eq(:symbol)
+      end
+
+      it "throws an exception if the object does not respond to the symbol" do
+        test = SpecObject.new
+        expect { test.first_of!( -> { nil }, :what) }.to raise_error
+      end
+    end
+
+    context "2 => :symbol, 1 => :symbol" do
+      it "prioritizes the return value by the hash key" do
+        test = SpecObject.new
+        test.first_of!(2 => :selfie, 1 => :symbol).should eq(:symbol)
+      end
+
+      it "does not return the first hash key if not present" do
+        test = SpecObject.new
+        test.first_of!(2 => :symbol, 1 => nil).should eq(:symbol)
+      end
+
+      it "returns a symbol if the first present value is a lambda that returns a symbol" do
+        test = SpecObject.new
+        test.first_of!(1 => lambda { :selfie }, 2 => :symbol).should eq(:selfie)
+      end
+
+      it "throws an exception if the object does not respond to the symbol" do
+        test = SpecObject.new
+        expect { test.first_of!(2 => :selfie, 1 => :what) }.to raise_error
+      end
+    end
+
+    context "lambda {}, 2 => :symbol, 1 => :symbol" do
+      it "prioritizes the lambda over the return value by the hash key" do
+        test = SpecObject.new
+        test.first_of!(lambda { :lambda }, 2 => :selfie, 1 => :symbol).should eq(:lambda)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler'
+
+::Bundler.require(:default, :development, :test)

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: first_of
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Dewitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: try_chain
+  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
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rake
+  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: 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'
+description: ' prioritize values of fallback methods '
+email:
+- brandonsdewitt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- first_of.gemspec
+- lib/first_of.rb
+- lib/first_of/core_ext/object/first_of.rb
+- lib/first_of/version.rb
+- spec/first_of_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: first_of allows you to setup a method that falls back to the next prioritized
+  value if the first and subsequent return objects are not present.  To be used in
+  situations where multiple values are "valid" but have a priority of when to use
+  each value
+test_files:
+- spec/first_of_spec.rb
+- spec/spec_helper.rb