identitee 0.4.0 → 0.5.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDZmNWUyM2Y2ZGY0MmU4MzEzNDE5MzljZGZkZGQwMGI5ZjU2NzY0OA==
-  data.tar.gz: !binary |-
-    OWZkMzhlZGQ4YzkyNDFmYTU3NmU1YTVkZTE1NjMyNmZlNDYwMDJjOQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    M2M1MTEwNDk0MzkxNjE2M2I0MWJiZWQ2MzExMjczOTM1OGUxNmU4NTUxMDU4
-    NzNkMWQ5MmIyZGM1NzZkODc5YWFhZTVkZTQyYTAyMWJiN2U5MjgwNWMzNzc4
-    YmUxYmIyNGJhZDY2ODM0ZTcwOGYxNDFlNzg2MGFmZDJkNmEyMzU=
-  data.tar.gz: !binary |-
-    NDg2Y2JiZGFmOWMxMGNiMDQwNGM0NDA5ZWM3Mjc2M2IwYzIzMzFjYjliMjI0
-    OWY3Mjk4MDkzYjMwMjM4MDI5YWJhNDMxZWNlMTZmOTIyNTZmNmVmNWVmMTA5
-    NTRmM2M0ZjY2M2RiMjkyZmIyMzk4YjFjOWFmMDA5ZDVhODM1Zjc=
+SHA1:
+  metadata.gz: 6cb24ae4857e7d85789960a9ddaa4878c595378c
+  data.tar.gz: e9d1d745ee288a215cad41b253314a53baceda29
+SHA512:
+  metadata.gz: 17dc8a313f29d6af6c08e17a56bc5ac724d969251cdde10a16f4de9af96bdb5be6f27f3c36d0bd3ebe6f628a2aec59232fdbabff6d3540794e4b902460ced467
+  data.tar.gz: f1cb6f464b16f390eccdc8337913c75d027e967e12d9aa3fe9779a2b89bec4a11508dff765a48c8375e61bcb3f12050dff36cb9595a136380ae8341eb3a9b994

data/.coveralls.yml

@@ -0,0 +1 @@
+service-name: travis-ci

data/Gemfile

@@ -4,3 +4,4 @@ gem 'rake'
 gem 'rspec'
 gem 'rb-fsevent', '~> 0.9.1'
 gem 'guard-rspec'
+gem 'coveralls', require: false

data/README.md

@@ -1,6 +1,6 @@
-# Identitee [![Build Status](https://travis-ci.org/natedavisolds/identitee.png?branch=master)](https://travis-ci.org/natedavisolds/identify) [![Code Climate](https://codeclimate.com/github/natedavisolds/identify.png)](https://codeclimate.com/github/natedavisolds/identify)
+# Identitee [![Gem Version](https://badge.fury.io/rb/identitee.png)](http://badge.fury.io/rb/identitee) [![Build Status](https://travis-ci.org/natedavisolds/identify.png?branch=master)](https://travis-ci.org/natedavisolds/identify) [![Code Climate](https://codeclimate.com/github/natedavisolds/identify.png)](https://codeclimate.com/github/natedavisolds/identify) [![Coverage Status](https://coveralls.io/repos/natedavisolds/identify/badge.png?branch=master)](https://coveralls.io/r/natedavisolds/identify?branch=master)
 
-Provides methods for constructing and retrieving a domain object. Identify is intended to replace persisting data that is tightly couple to domain logic.
+Provides methods for building and retrieving instances of a class. Identify is intended to replace persisting data that is tightly tied to domain logic.
 
 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.
 
@@ -8,7 +8,7 @@ Likewise, many classes may be constructed that do the same thing... just a littl
 
 ### Finding
 
-Find an identifiable through the `find_identifiable` class method. (See the Basic Example)
+Find an identifiable through the `find_identifiable` (aliased also to find) class method. (See the Basic Example)
 
     class Activity
       include Identitee
@@ -25,10 +25,11 @@ Find an identifiable through the `find_identifiable` class method. (See the Basi
     end
 
     Activity.find_identifiable(:new_activity).title # => "Created something new"
+    Activity.find(:new_activity).title # => "Created something new"
 
 ### 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.  The load path can explicitly be set with the `set_identify_root` method call.
+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.
 
     class LazyLoadingTest
       include Identitee

data/ROADMAP.md

@@ -1,5 +1,7 @@
-## ROADMAP
+# ROADMAP
 
+## Needed For 1.0 Release
 - Document a working example
 - Allow for other/additional loaders to be used
-- reduce the number of class methods that identify creates
+- Reduce the number of class methods that identify creates
+- Documentation in code

data/lib/identitee/default_path_builder.rb

@@ -0,0 +1,44 @@
+module Identitee
+  class DefaultPathBuilder
+    def self.to_path call_stack, including_class
+      new(call_stack, including_class).to_path
+    end
+
+    def initialize call_stack, including_class
+      @call_stack = call_stack
+      @including_class = including_class
+    end
+
+    def to_path 
+      [directory_of_caller, pluralized_class_name].join('/')
+    end
+
+    private
+
+    attr_accessor :call_stack, :including_class
+
+    def directory_of_caller 
+      File.dirname most_recent_caller_path_without_line_number
+    end
+
+    def most_recent_caller_path_without_line_number
+      most_recent_caller_path.split(':').first
+    end
+
+    def most_recent_caller_path
+      call_stack.first.to_s
+    end
+
+    def pluralized_class_name
+      including_class_name.gsub(/([A-Z]+)([A-Z])/,'\1_\2').
+        gsub(/([a-z])([A-Z])/,'\1_\2').
+        gsub('/' ,'__').
+        gsub('::','__').
+        downcase + "s"
+    end
+
+    def including_class_name
+      including_class.name.to_s
+    end
+  end
+end

data/lib/identitee/identifiables.rb

@@ -22,6 +22,10 @@ module Identitee
       end
     end
 
+    def find_key instance
+      instances.invert.fetch(instance, nil)
+    end
+
     def all
       instances.values
     end

data/lib/identitee/identify.rb

@@ -18,6 +18,10 @@ module Identitee
       end
     end
 
+    def find_identifiable_key instance
+      identifiables.find_key instance
+    end
+
     def all_identifiables
       load_all_identifiables
       identifiables.all
@@ -27,7 +31,7 @@ module Identitee
       ::Identitee::Loader.new(identify_root_directory: identify_root_directory).load_all
     end
 
-    def set_identify_root path_to_template_root
+    def set_identitee_root path_to_template_root
       @identify_root_directory = path_to_template_root
     end
 

data/lib/identitee/version.rb

@@ -1,3 +1,3 @@
 module Identitee
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/identitee.rb

@@ -1,10 +1,13 @@
 require "identitee/version"
 require "identitee/identify"
+require "identitee/default_path_builder"
 require "identitee/identify/find_alias"
 
 module Identitee
   def self.included base
     base.extend ::Identitee::Identify
-    base.extend ::Identitee::Identify::FindAlias unless method_defined? :find
+    base.extend ::Identitee::Identify::FindAlias unless base.method_defined? :find
+
+    base.set_identitee_root Identitee::DefaultPathBuilder.to_path caller, base
   end
 end

data/spec/acceptance/alias_find_acceptance_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe "Can find identifiables using the short hand find" do
+  class AliasFindingTestCase
+    include Identitee
+  end
+
+  it "uses the find alias" do
+    test_case = AliasFindingTestCase.identify :test
+    AliasFindingTestCase.find(:test).should eq test_case
+  end
+
+  class OtherFindTestCase
+    def self.find echo
+      "other find #{echo}"
+    end
+
+    include Identitee
+  end
+  
+  it "uses the existing find method" do
+    test_case = OtherFindTestCase.identify :test
+    OtherFindTestCase.find(:test).should == "other find test"
+  end
+end

data/spec/acceptance/default_directory_acceptance_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe "Default the directory to the caller classes directory and the pluralized version of the class name" do
+  class DefaultDirectorySetTest
+    include Identitee
+
+    attr_accessor :successful
+
+    def initialize
+      @successful = false
+    end
+
+    def successful?
+      @successful
+    end
+  end
+
+  it "has a identify_root_directory" do
+    DefaultDirectorySetTest.identify_root_directory.should =~ /default_directory_set_tests/
+  end
+
+  it "lazy loads identifyables" do
+    test = DefaultDirectorySetTest.find_identifiable :default_directory_test
+    test.should_not be_nil
+    test.should be_successful
+  end
+end

data/spec/acceptance/default_directory_set_tests/default_directory_test.rb

@@ -0,0 +1,3 @@
+DefaultDirectorySetTest.identify :default_directory_test do
+  @successful = true
+end

data/spec/acceptance/force_all_loading_acceptance_spec.rb

@@ -1,24 +1,13 @@
-require 'identitee'
+require 'spec_helper'
 
 describe "Force all Loading" do
-
-  class LazyLoadingTest
+  class LoadingAllTest
     include Identitee
-
-    attr_accessor :successful
-
-    set_identify_root File.expand_path("../lazy_loading_tests/", __FILE__)
-
-    def initialize
-      @successful = false
-    end
-
-    def successful?
-      @successful
-    end
+    set_identitee_root File.expand_path("../loading_all_tests/", __FILE__)
   end
 
   it "loads all the identifiable before calling all" do
-    LazyLoadingTest.all_identifiables.length.should == 1
+    identifiables = LoadingAllTest.all_identifiables
+    identifiables.length.should == 2
   end
 end

data/spec/acceptance/lazy_loading_acceptance_spec.rb

@@ -1,4 +1,4 @@
-require 'identitee'
+require 'spec_helper'
 
 describe "Lazy Loading" do
 
@@ -7,7 +7,7 @@ describe "Lazy Loading" do
 
     attr_accessor :successful
 
-    set_identify_root File.expand_path("../lazy_loading_tests/", __FILE__)
+    set_identitee_root File.expand_path("../lazy_loading_tests/", __FILE__)
 
     def initialize
       @successful = false

data/spec/acceptance/loading_all_tests/test1.rb

@@ -0,0 +1,2 @@
+LoadingAllTest.identify :test1 do
+end

data/spec/acceptance/loading_all_tests/test2.rb

@@ -0,0 +1,2 @@
+LoadingAllTest.identify :test2 do
+end

data/spec/integration/loader_integration_spec.rb

@@ -1,4 +1,4 @@
-require 'identitee/loader'
+require 'spec_helper'
 
 describe "Loader Integration Test" do
   it "loads a file" do

data/spec/lib/identitee/identifiables_spec.rb

@@ -1,4 +1,4 @@
-require 'identitee/identifiables'
+require 'spec_helper'
 
 module Identitee
   describe Identifiables do
@@ -47,5 +47,12 @@ module Identitee
         identifiables.all.should == [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'
+      end
+    end
   end
 end

data/spec/lib/identitee/identify_spec.rb

@@ -1,4 +1,4 @@
-require 'identitee'
+require 'spec_helper'
 
 describe Identitee do
   it "acts as a constructor" do
@@ -62,7 +62,7 @@ describe Identitee do
     TestAddingFind.should respond_to :find
   end
 
-  it "doesn't symplifies find_identifiable when find exists" do
+  it "doesn't symplify find_identifiable when find exists" do
     TestNotReplacingFind = Class.new do
       def self.find key
         key
@@ -76,4 +76,14 @@ describe Identitee do
     TestNotReplacingFind.find("something").should == "something"
     TestNotReplacingFind.find_identifiable("something").should == "Unknown"
   end
+
+  it "finds the key for an identifiable" do
+    TestFindIdentiteeKey = Class.new do
+      include Identitee
+    end
+
+    instance = TestFindIdentiteeKey.identify :testing_key
+
+    TestFindIdentiteeKey.find_identifiable_key(instance).should eq 'testing_key'
+  end
 end

data/spec/lib/identitee/loader_spec.rb

@@ -1,4 +1,4 @@
-require 'identitee/loader'
+require 'spec_helper'
 
 module Identitee
   describe Loader do
@@ -20,11 +20,7 @@ module Identitee
 
         loader.should_receive(:force_load).with('known.rb').once
 
-        identity = loader.lazy_load('known') do
-          "Failing"
-        end
-
-        identity.should_not == "Failing"
+        loader.lazy_load('known')
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,9 +1,8 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'coveralls'
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: identitee
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Nate Davis Olds
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies: []
 description: Identifies and stores instances of a class for later loading
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
 - .rspec
 - .travis.yml
@@ -28,15 +29,21 @@ files:
 - Rakefile
 - identitee.gemspec
 - lib/identitee.rb
+- lib/identitee/default_path_builder.rb
 - lib/identitee/identifiable_not_found.rb
 - lib/identitee/identifiables.rb
 - lib/identitee/identify.rb
 - lib/identitee/identify/find_alias.rb
 - lib/identitee/loader.rb
 - lib/identitee/version.rb
+- spec/acceptance/alias_find_acceptance_spec.rb
+- spec/acceptance/default_directory_acceptance_spec.rb
+- spec/acceptance/default_directory_set_tests/default_directory_test.rb
 - spec/acceptance/force_all_loading_acceptance_spec.rb
 - spec/acceptance/lazy_loading_acceptance_spec.rb
 - spec/acceptance/lazy_loading_tests/autoload_test.rb
+- spec/acceptance/loading_all_tests/test1.rb
+- spec/acceptance/loading_all_tests/test2.rb
 - spec/integration/loader_integration_spec.rb
 - spec/integration/test_files/test_lazy_load.rb
 - spec/lib/identitee/identifiables_spec.rb
@@ -53,24 +60,29 @@ 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
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: ''
 test_files:
+- spec/acceptance/alias_find_acceptance_spec.rb
+- spec/acceptance/default_directory_acceptance_spec.rb
+- spec/acceptance/default_directory_set_tests/default_directory_test.rb
 - spec/acceptance/force_all_loading_acceptance_spec.rb
 - spec/acceptance/lazy_loading_acceptance_spec.rb
 - spec/acceptance/lazy_loading_tests/autoload_test.rb
+- spec/acceptance/loading_all_tests/test1.rb
+- spec/acceptance/loading_all_tests/test2.rb
 - spec/integration/loader_integration_spec.rb
 - spec/integration/test_files/test_lazy_load.rb
 - spec/lib/identitee/identifiables_spec.rb