identitee 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9da74fd161fc249437c10e388e20164b4276780e
-  data.tar.gz: fd8111133efc9edc77bfa1e7020b41bbf88f8fca
+  metadata.gz: ad8cee7849af1139f1d5c9b83870d81d17153efc
+  data.tar.gz: 9573dc1aede8998292d61d401cb72a827ef562ef
 SHA512:
-  metadata.gz: dbcf9d2ab80514b2f87de44ac15b3fb6d6c7c57fa6667141ff40eb4cc798b33520fbaed4f5325e836973f2af79177019fa42a15cfca8bb9dfc286888589751ff
-  data.tar.gz: fb2518c7ec141523bb9df7337398096791ebc486af444bf48a64fecadb656150375f26a91985a74a5ae360f172a36eeaab244f22a9263ec45fd06767de6ced48
+  metadata.gz: e8a9d6753888c4bad1fbcbc3b074fd181f7a9f6502c38c89ab23183ae3fd2d6aa63dfc0e986dce42ab1304a7093d4f330e4a19e48b6fe39e7ff3db6cc5fa7a53
+  data.tar.gz: 5c076e87ca24175305cbc56480b5788c50ba389de021a4c8e3e63cc1ec81623335901dc00e1ecc74ed9e3badd02a33a679eff7a6339a7342bf04e61fb86f9654

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -3,5 +3,8 @@ source 'https://rubygems.org'
 gem 'rake'
 gem 'rspec'
 gem 'rb-fsevent', '~> 0.9.1'
-gem 'guard-rspec'
 gem 'coveralls', require: false
+
+group :development do
+  gem 'guard-rspec'
+end

data/README.md

@@ -4,12 +4,13 @@ Provides methods for building and retrieving instances of a class. Identify is i
 
 Many times you might see a database structure that will always remain static until the codebase changes.  This is a headache to seed the proper data for the objects to work.  Instead use identify to write these classes in code.
 
-Likewise, many classes may be constructed that do the same thing... just a little bit differently. Like a use case.  Identitee allows easy retrieval of data.
+Likewise, Identitee extends composition by building objects which behave the same but with different values.
 
 ### Finding
 
 Find an identifiable through the `find_identifiable` (aliased also to find) class method. (See the Basic Example)
 
+```ruby
     class Activity
       include Identitee
 
@@ -26,17 +27,54 @@ Find an identifiable through the `find_identifiable` (aliased also to find) clas
 
     Activity.find_identifiable(:new_activity).title # => "Created something new"
     Activity.find(:new_activity).title # => "Created something new"
+```
+    
+### When not found
 
-### Loading identifiables
+You can set a default in two ways.  First, pass the default as the second parameter to find
+
+```ruby
+    Activity.find("some_unknown_key", NullActivity.new)
+```
+
+If the key is not found, it will use the value passed as the second parameter.
+
+Even more useful way to set a default value is through as block:
+
+```ruby
+    Activity.find("some_unknown_key") do |key|
+      Activity.identify(key)
+    end
+```
+    
+When the key isn't found the block is run with the key passed to it.  Here we are dynamically creating activities when they are not yet defined.  This is great when we want the full power of the instance methods but we are okay with the default configuration (Think NullObject strategy).
+    
+### A Self aware instance
+
+It is handy to have the key we used to identify.  To give your instance objects access to key, include Identitee::IdentifyKey.
 
-Identitee will try to autoload the identifiables if it doesn't already know about them.  By default it will use the pluralize class_name of the identifiable from the folder that the source file is in.  The load path can explicitly be set with the `set_identitee_root` method call.
+```ruby
+    class IdentifyKeyExample
+      include Identitee
+      include IdentifyKey
+    end
+```
+Access it by calling the #key method.
+```ruby
+    example = IdentifyKeyExample.identify 'test_key'
+    example.key
+    # => 'text_key'
+```
+### Loading identifiables
 
+Identitee will try to autoload the identifiables if it doesn't already know about them.  By default it will use the pluralize class_name of the identifiable from the folder that the source file is in.  Other loaders can be added to expose additional paths.
+```ruby
     class LazyLoadingTest
       include Identitee
 
       attr_accessor :successful
 
-      set_identitee_root File.expand_path("../lazy_loading_tests/", __FILE__)
+      add_loader MyLoader.new
 
       def initialize
         @successful = false
@@ -46,6 +84,7 @@ Identitee will try to autoload the identifiables if it doesn't already know abou
         @successful
       end
     end
+```
 
 ## Installation
 
@@ -59,7 +98,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install identify
+    $ gem install identitee
 
 ## Contributing
 

data/lib/identitee/identify/find_alias.rb

@@ -1,8 +1,12 @@
 module Identitee 
   module Identify
     module FindAlias
-      def find candidate_id
-        find_identifiable candidate_id
+      def find candidate_id, default=nil, &block
+        if default.nil?
+          find_identifiable candidate_id, &block
+        else
+          find_identifiable candidate_id, default, &block
+        end
       end
     end
   end

data/lib/identitee/version.rb

@@ -1,3 +1,3 @@
 module Identitee
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/spec/acceptance/alias_find_acceptance_spec.rb

@@ -7,7 +7,7 @@ describe "Can find identifiables using the short hand find" do
 
   it "uses the find alias" do
     test_case = AliasFindingTestCase.identify :test
-    AliasFindingTestCase.find(:test).should eq test_case
+    expect(AliasFindingTestCase.find(:test)).to eq test_case
   end
 
   class OtherFindTestCase
@@ -20,6 +20,19 @@ describe "Can find identifiables using the short hand find" do
   
   it "uses the existing find method" do
     test_case = OtherFindTestCase.identify :test
-    OtherFindTestCase.find(:test).should == "other find test"
+    expect(OtherFindTestCase.find(:test)).to eq "other find test"
+  end
+
+  it "will pass a default value" do
+    oftc = AliasFindingTestCase.find(:test_default, "default")
+    expect(oftc).to eq "default"
+  end
+
+  it "will pass a block value" do
+    oftc = AliasFindingTestCase.find(:test_default) do
+      "default"
+    end
+
+    expect(oftc).to eq "default"
   end
 end

data/spec/acceptance/default_directory_acceptance_spec.rb

@@ -17,7 +17,7 @@ describe "Default the directory to the caller classes directory and the pluraliz
 
   it "lazy loads identifyables" do
     test = DefaultDirectorySetTest.find_identifiable :default_directory_test, nil
-    test.should_not be_nil
-    test.should be_successful
+    expect(test).to_not be_nil
+    expect(test).to be_successful
   end
 end

data/spec/acceptance/force_all_loading_acceptance_spec.rb

@@ -8,6 +8,6 @@ describe "Force all Loading" do
 
   it "loads all the identifiable before calling all" do
     identifiables = LoadingAllTest.find_all_identifiables
-    identifiables.length.should == 2
+    expect(identifiables.length).to eq 2
   end
 end

data/spec/acceptance/lazy_loading_acceptance_spec.rb

@@ -20,7 +20,7 @@ describe "Lazy Loading" do
 
   it "lazy loads identifyables" do
     test = LazyLoadingTest.find_identifiable :autoload_test
-    test.should_not be_nil
-    test.should be_successful
+    expect(test).to_not be_nil
+    expect(test).to be_successful
   end
 end

data/spec/integration/loader_integration_spec.rb

@@ -4,6 +4,6 @@ describe "Loader Integration Test" do
   it "loads a file" do
     identify_root_directory = File.expand_path('../test_files/', __FILE__)
     Identitee::Loader.new(identify_root_directory: identify_root_directory).lazy_load('test_lazy_load')
-    Identitee::Loader.should respond_to :just_created_method
+    expect(Identitee::Loader).to respond_to :just_created_method
   end
 end

data/spec/lib/identitee/identifiables_spec.rb

@@ -2,15 +2,15 @@ require 'spec_helper'
 
 module Identitee
   describe Identifiables do
-    let(:instance) { stub }
+    let(:instance) { double }
     let(:identifiables) { Identifiables.new }
 
     context "when found by key" do
       it "returns the instance" do
-        identifiables.register :foo, stub
+        identifiables.register :foo, double
         identifiables.register :test_id, instance
 
-        identifiables.find(:test_id).should == instance
+        expect(identifiables.find(:test_id)).to eq instance
       end
     end
 
@@ -20,19 +20,19 @@ module Identitee
           "#{id} not found"
         end
 
-        identifiable.should == "foo not found"
+        expect(identifiable).to eq "foo not found"
       end
 
       it "returns the second value if no block given" do
         identifiable = identifiables.find :foo, "Default value"
 
-        identifiable.should == "Default value"
+        expect(identifiable).to eq "Default value"
       end
 
       it "returns the second value if no block given even when that value is nil" do
         identifiable = identifiables.find :foo, nil
 
-        identifiable.should be_nil
+        expect(identifiable).to be_nil
       end
 
       it "raises IdentifiableNotFound if no block or default value" do
@@ -44,14 +44,14 @@ module Identitee
     context "when requesting all the identifiables" do
       it "gives an array of all the known instances" do
         identifiables.register :foo, instance
-        identifiables.all.should == [instance]
+        expect(identifiables.all).to include instance
       end
     end
 
     context "when find the key" do
       it "gives the string identifier for the instance" do
         identifiables.register :foo, instance
-        identifiables.find_key(instance).should eq 'foo'
+        expect(identifiables.find_key(instance)).to eq 'foo'
       end
     end
   end

data/spec/lib/identitee/identify_key_spec.rb

@@ -8,11 +8,11 @@ module Identitee
       add_identifiable_loader Identitee::Loader.new(identify_root_directory: File.expand_path("../loading_all_tests/", __FILE__)) 
     end
 
-    it "should have the key method" do
+    it "has the key method" do
       expect(IdentifyKeyExample.new).to respond_to :key
     end
 
-    it "should return the correct key" do
+    it "returns the correct key" do
       example = IdentifyKeyExample.identify :example_key_test
       expect(example.key).to eq "example_key_test"
     end

data/spec/lib/identitee/identify_spec.rb

@@ -6,7 +6,7 @@ describe Identitee do
       include Identitee
     end
 
-    TestIdentifyInitialize.identify(:test).should be_a TestIdentifyInitialize
+    expect(TestIdentifyInitialize.identify(:test)).to be_a TestIdentifyInitialize
   end
 
   it "registers the identifiable" do
@@ -16,7 +16,7 @@ describe Identitee do
 
     instance = TestIdentifyRegister.identify :test
 
-    TestIdentifyRegister.find_identifiable(:test).should == instance
+    expect(TestIdentifyRegister.find_identifiable(:test)).to eq instance
   end
 
   it "passes extra parameters through to new" do
@@ -31,7 +31,7 @@ describe Identitee do
     end
 
     instance = TestIdentifyMultipleParams.identify :test, "Testing"
-    instance.attrib.should == "Testing"
+    expect(instance.attrib).to eq "Testing"
   end
 
   it "passes the block to the new as well" do
@@ -49,17 +49,17 @@ describe Identitee do
       set_attrib "It ran the block!"
     end
 
-    instance.attrib.should == "It ran the block!"
+    expect(instance.attrib).to eq "It ran the block!"
   end
 
   it "simplifies find_identifiable to find" do
     TestAddingFind = Class.new
 
-    TestAddingFind.should_not respond_to :find
+    expect(TestAddingFind).to_not respond_to :find
 
     TestAddingFind.send(:include, Identitee)
 
-    TestAddingFind.should respond_to :find
+    expect(TestAddingFind).to respond_to :find
   end
 
   it "doesn't symplify find_identifiable when find exists" do
@@ -69,12 +69,12 @@ describe Identitee do
       end
     end
 
-    TestNotReplacingFind.find("something").should == "something"
+    expect(TestNotReplacingFind.find("something")).to eq "something"
 
     TestNotReplacingFind.send(:include, Identitee)
 
-    TestNotReplacingFind.find("something").should == "something"
-    TestNotReplacingFind.find_identifiable("something", "Unknown").should == "Unknown"
+    expect(TestNotReplacingFind.find("something")).to eq "something"
+    expect(TestNotReplacingFind.find_identifiable("something", "Unknown")).to eq "Unknown"
   end
 
   it "finds the key for an identifiable" do
@@ -84,6 +84,6 @@ describe Identitee do
 
     instance = TestFindIdentiteeKey.identify :testing_key
 
-    TestFindIdentiteeKey.find_identifiable_key(instance).should eq 'testing_key'
+    expect(TestFindIdentiteeKey.find_identifiable_key(instance)).to eq 'testing_key'
   end
 end

data/spec/lib/identitee/loader_spec.rb

@@ -4,11 +4,11 @@ module Identitee
   describe Loader do
     context "when source file does not exist" do
       it "fails gracefully by calling block" do
-        loader = Loader.new
-
-        loader.lazy_load('unknown') do
+        result = Loader.new.lazy_load('unknown') do
           "Passing"
-        end.should == "Passing"
+        end
+
+        expect(result).to eq "Passing"
       end
     end
 
@@ -16,9 +16,9 @@ module Identitee
       it "loads the file" do
         loader = Loader.new
 
-        File.stub!(:exists?).with('known.rb').and_return(true)
+        expect(File).to receive(:exists?).with('known.rb').and_return(true)
 
-        loader.should_receive(:force_load).with('known.rb').once
+        expect(loader).to receive(:force_load).with('known.rb').once
 
         loader.lazy_load('known')
       end

data/spec/spec_helper.rb

@@ -4,7 +4,6 @@ Coveralls.wear!
 require 'identitee'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: identitee
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Nate Davis Olds
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies: []
 description: Identifies and stores instances of a class for later loading
 email:
@@ -17,10 +17,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .rspec
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -63,17 +64,17 @@ 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.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: ''