identitee 0.4.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!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=

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0
+  - jruby-19mode
+  - ruby-head

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'rspec'
+gem 'rb-fsevent', '~> 0.9.1'
+gem 'guard-rspec'

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', :notification => false, :all_on_start => false, :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nate Davis Olds
+
+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,69 @@
+# 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)
+
+Provides methods for constructing and retrieving a domain object. Identify is intended to replace persisting data that is tightly couple 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.
+
+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.
+
+### Finding
+
+Find an identifiable through the `find_identifiable` class method. (See the Basic Example)
+
+    class Activity
+      include Identitee
+
+      attr_reader :title
+
+      def titled title
+        @title = title
+      end
+    end
+
+    Activity.identify :new_activity do
+      titled "Created something new"
+    end
+
+    Activity.find_identifiable(: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.
+
+    class LazyLoadingTest
+      include Identitee
+
+      attr_accessor :successful
+
+      set_identitee_root File.expand_path("../lazy_loading_tests/", __FILE__)
+
+      def initialize
+        @successful = false
+      end
+
+      def successful?
+        @successful
+      end
+    end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'identitee'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install identify
+
+## 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/ROADMAP.md

@@ -0,0 +1,5 @@
+## ROADMAP
+
+- Document a working example
+- Allow for other/additional loaders to be used
+- reduce the number of class methods that identify creates

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/identitee.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'identitee/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "identitee"
+  gem.version       = Identitee::VERSION
+  gem.authors       = ["Nate Davis Olds"]
+  gem.email         = ["nate@davisolds.com"]
+  gem.description   = "Identifies and stores instances of a class for later loading"
+  gem.summary       = ""
+  gem.homepage      = "https://github.com/natedavisolds/identify"
+  gem.licenses      = ["MIT"]
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = []
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ["lib"]
+end

data/lib/identitee/identifiable_not_found.rb

@@ -0,0 +1,4 @@
+module Identitee
+  class IdentifiableNotFound < Exception
+  end
+end

data/lib/identitee/identifiables.rb

@@ -0,0 +1,33 @@
+require 'identitee/identifiable_not_found'
+
+module Identitee
+  class Identifiables
+    def initialize 
+      @instances = {}
+    end
+
+    def register key, instance
+      instances[key.to_s] = instance
+    end
+
+    def find key, *default_values, &block
+      instances.fetch key.to_s do 
+        if block
+          block.call key
+        elsif default_values.length > 0
+          default_values.first
+        else
+          raise ::Identitee::IdentifiableNotFound
+        end
+      end
+    end
+
+    def all
+      instances.values
+    end
+
+    private 
+
+    attr_reader :instances
+  end
+end

data/lib/identitee/identify/find_alias.rb

@@ -0,0 +1,9 @@
+module Identitee 
+  module Identify
+    module FindAlias
+      def find candidate_id
+        find_identifiable candidate_id
+      end
+    end
+  end
+end

data/lib/identitee/identify.rb

@@ -0,0 +1,42 @@
+require "identitee/identifiables"
+require "identitee/loader"
+
+module Identitee
+  module Identify
+    def identify id, *extra_parameters, &block
+      instance = new *extra_parameters
+      instance.instance_eval &block if block_given?
+
+      identifiables.register id, instance
+      instance
+    end
+
+    def find_identifiable candidate_id
+      identifiables.find candidate_id.to_s do
+        ::Identitee::Loader.new(identify_root_directory: identify_root_directory).lazy_load(candidate_id.to_s)
+        identifiables.find candidate_id, "Unknown"
+      end
+    end
+
+    def all_identifiables
+      load_all_identifiables
+      identifiables.all
+    end
+
+    def load_all_identifiables
+      ::Identitee::Loader.new(identify_root_directory: identify_root_directory).load_all
+    end
+
+    def set_identify_root path_to_template_root
+      @identify_root_directory = path_to_template_root
+    end
+
+    def identify_root_directory
+      @identify_root_directory
+    end
+
+    def identifiables
+      @identifiables ||= Identifiables.new
+    end
+  end
+end

data/lib/identitee/loader.rb

@@ -0,0 +1,47 @@
+module Identitee
+  class Loader
+    def initialize options={}
+      @identify_root_directory = options.delete(:identify_root_directory)
+    end
+
+    def lazy_load filename
+      full_path = [identify_root_directory, "#{filename}.rb"].compact.join('/')
+
+      if File.exists? full_path
+        force_load full_path
+      else
+        yield if block_given?
+      end
+    end
+
+    def load_all
+      if not_fully_loaded?
+        force_full_load
+      end
+    end
+
+    private
+
+    attr_reader :identify_root_directory
+
+    def force_full_load
+      @fully_loaded = true
+
+      Dir.glob("#{identify_root_directory}/*.rb").each do |file_name|
+        lazy_load File.basename(file_name, ".*")
+      end
+    end
+
+    def force_load filename
+      load filename.to_s
+    end
+
+    def loaded_already?
+      @fully_loaded == true
+    end
+
+    def not_fully_loaded?
+      not loaded_already?
+    end
+  end
+end

data/lib/identitee/version.rb

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

data/lib/identitee.rb

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

data/spec/acceptance/force_all_loading_acceptance_spec.rb

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

data/spec/acceptance/lazy_loading_acceptance_spec.rb

@@ -0,0 +1,30 @@
+require 'identitee'
+
+describe "Lazy Loading" do
+
+  class LazyLoadingTest
+    include Identitee
+
+    attr_accessor :successful
+
+    set_identify_root File.expand_path("../lazy_loading_tests/", __FILE__)
+
+    def initialize
+      @successful = false
+    end
+
+    def successful?
+      @successful
+    end
+  end
+
+  it "has a identify_root_directory" do
+    LazyLoadingTest.identify_root_directory.should =~ /lazy_loading_tests/
+  end
+
+  it "lazy loads identifyables" do
+    test = LazyLoadingTest.find_identifiable :autoload_test
+    test.should_not be_nil
+    test.should be_successful
+  end
+end

data/spec/acceptance/lazy_loading_tests/autoload_test.rb

@@ -0,0 +1,3 @@
+LazyLoadingTest.identify :autoload_test do
+  @successful = true
+end

data/spec/integration/loader_integration_spec.rb

@@ -0,0 +1,9 @@
+require 'identitee/loader'
+
+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
+  end
+end

data/spec/integration/test_files/test_lazy_load.rb

@@ -0,0 +1,3 @@
+class Identitee::Loader
+  def self.just_created_method; end
+end

data/spec/lib/identitee/identifiables_spec.rb

@@ -0,0 +1,51 @@
+require 'identitee/identifiables'
+
+module Identitee
+  describe Identifiables do
+    let(:instance) { stub }
+    let(:identifiables) { Identifiables.new }
+
+    context "when found by key" do
+      it "returns the instance" do
+        identifiables.register :foo, stub
+        identifiables.register :test_id, instance
+
+        identifiables.find(:test_id).should == instance
+      end
+    end
+
+    context "when not found by key" do
+      it "returns value returned by a given block" do
+        identifiable = identifiables.find(:foo) do |id|
+          "#{id} not found"
+        end
+
+        identifiable.should == "foo not found"
+      end
+
+      it "returns the second value if no block given" do
+        identifiable = identifiables.find :foo, "Default value"
+
+        identifiable.should == "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
+      end
+
+      it "raises IdentifiableNotFound if no block or default value" do
+        expect { identifiables.find(:foo) }
+          .to raise_error Identitee::IdentifiableNotFound
+      end
+    end
+
+    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]
+      end
+    end
+  end
+end

data/spec/lib/identitee/identify_spec.rb

@@ -0,0 +1,79 @@
+require 'identitee'
+
+describe Identitee do
+  it "acts as a constructor" do
+    TestIdentifyInitialize = Class.new do
+      include Identitee
+    end
+
+    TestIdentifyInitialize.identify(:test).should be_a TestIdentifyInitialize
+  end
+
+  it "registers the identifiable" do
+    TestIdentifyRegister = Class.new do
+      include Identitee
+    end
+
+    instance = TestIdentifyRegister.identify :test
+
+    TestIdentifyRegister.find_identifiable(:test).should == instance
+  end
+
+  it "passes extra parameters through to new" do
+    TestIdentifyMultipleParams = Class.new do
+      include Identitee
+
+      attr_reader :attrib
+
+      def initialize attrib
+        @attrib = attrib
+      end
+    end
+
+    instance = TestIdentifyMultipleParams.identify :test, "Testing"
+    instance.attrib.should == "Testing"
+  end
+
+  it "passes the block to the new as well" do
+    TestIdentifyPassingBlock = Class.new do
+      include Identitee
+
+      attr_reader :attrib
+
+      def set_attrib str
+        @attrib = str
+      end
+    end
+
+    instance = TestIdentifyPassingBlock.identify :test do
+      set_attrib "It ran the block!"
+    end
+
+    instance.attrib.should == "It ran the block!"
+  end
+
+  it "simplifies find_identifiable to find" do
+    TestAddingFind = Class.new
+
+    TestAddingFind.should_not respond_to :find
+
+    TestAddingFind.send(:include, Identitee)
+
+    TestAddingFind.should respond_to :find
+  end
+
+  it "doesn't symplifies find_identifiable when find exists" do
+    TestNotReplacingFind = Class.new do
+      def self.find key
+        key
+      end
+    end
+
+    TestNotReplacingFind.find("something").should == "something"
+
+    TestNotReplacingFind.send(:include, Identitee)
+
+    TestNotReplacingFind.find("something").should == "something"
+    TestNotReplacingFind.find_identifiable("something").should == "Unknown"
+  end
+end

data/spec/lib/identitee/loader_spec.rb

@@ -0,0 +1,31 @@
+require 'identitee/loader'
+
+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
+          "Passing"
+        end.should == "Passing"
+      end
+    end
+
+    context "when source file does exist" do
+      it "loads the file" do
+        loader = Loader.new
+
+        File.stub!(:exists?).with('known.rb').and_return(true)
+
+        loader.should_receive(:force_load).with('known.rb').once
+
+        identity = loader.lazy_load('known') do
+          "Failing"
+        end
+
+        identity.should_not == "Failing"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# 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
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: identitee
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Nate Davis Olds
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-08 00:00:00.000000000 Z
+dependencies: []
+description: Identifies and stores instances of a class for later loading
+email:
+- nate@davisolds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- ROADMAP.md
+- Rakefile
+- identitee.gemspec
+- lib/identitee.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/force_all_loading_acceptance_spec.rb
+- spec/acceptance/lazy_loading_acceptance_spec.rb
+- spec/acceptance/lazy_loading_tests/autoload_test.rb
+- spec/integration/loader_integration_spec.rb
+- spec/integration/test_files/test_lazy_load.rb
+- spec/lib/identitee/identifiables_spec.rb
+- spec/lib/identitee/identify_spec.rb
+- spec/lib/identitee/loader_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/natedavisolds/identify
+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: ''
+test_files:
+- spec/acceptance/force_all_loading_acceptance_spec.rb
+- spec/acceptance/lazy_loading_acceptance_spec.rb
+- spec/acceptance/lazy_loading_tests/autoload_test.rb
+- spec/integration/loader_integration_spec.rb
+- spec/integration/test_files/test_lazy_load.rb
+- spec/lib/identitee/identifiables_spec.rb
+- spec/lib/identitee/identify_spec.rb
+- spec/lib/identitee/loader_spec.rb
+- spec/spec_helper.rb