static_association 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9070d8b187c9b04c979f3f77244f5f0aff54bc9
-  data.tar.gz: 3a95140244d4d5413d29b86b517f847177a03182
+  metadata.gz: dd88c2ff7fc56c68c7afb52e5ecc34d05d00ff06
+  data.tar.gz: 247e7c6ec09c4aeabc7405caa0af4895ea2527c2
 SHA512:
-  metadata.gz: 11a3e13c6693ec96763180f4f1e7feff0d41bb6b8fd0ea8bac6f662c21cc23df81b1d2aa16e3107f887d44df54da0ab5be89e66d3e7b44b3f5dda73c94373d4b
-  data.tar.gz: cc67b525ced9dce9f6b56ec235b955c7a140cf98639738451f1d4ec95285db2e5e42e65e880bd3b1f717a6c9fbb8ffd1d4a00f5d90c96435c7d069ac79125af1
+  metadata.gz: 2430eb60d4dfee691c90cceb8607ed4021ab21fbee8918a13d53ef2acb1ae4e628957717ddb005df1676037de734968d3a97b0e2fd59fccb8e4369057a89e075
+  data.tar.gz: 2a5e771bb651c00f24068ce82e5b10307b2a7c4d7ce6729f50e329424adfc2772aa61c99a2c4fd5094575b7aec91fe97b13032485cbed1d12daf3ba3d4becfe5

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+*.gemfile.lock
 *.rbc
 .bundle
 .config
@@ -15,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/bundle

data/.travis.yml

@@ -1,20 +1,17 @@
 language: ruby
 install: bundle install
+sudo: false
 script:
  - bundle exec rake
 rvm:
-  - 2.0.0
+  - 2.2
+  - 2.1
+  - 2.0
   - 1.9.3
-  - 1.9.2
-  - 1.8.7
 gemfile:
   - gemfiles/3.0.gemfile
   - gemfiles/3.1.gemfile
   - gemfiles/3.2.gemfile
   - gemfiles/4.0.gemfile
-matrix:
-  exclude:
-    - rvm: 1.8.7
-      gemfile: gemfiles/4.0.gemfile
-    - rvm: 1.9.2
-      gemfile: gemfiles/4.0.gemfile
+  - gemfiles/4.1.gemfile
+  - gemfiles/4.2.gemfile

data/Appraisals

@@ -15,3 +15,11 @@ end
 appraise "4.0" do
   gem "activesupport", "4.0"
 end
+
+appraise "4.1" do
+  gem "activesupport", "4.1"
+end
+
+appraise "4.2" do
+  gem "activesupport", "4.2"
+end

data/README.md

@@ -1,14 +1,16 @@
 # StaticAssociation
 
-Adds basic ActiveRecord like associations to static data.
+[![Build Status](https://travis-ci.org/New-Bamboo/static_association.png?branch=master)](https://travis-ci.org/New-Bamboo/static_association)
 
-This has been extracted from ProjectsDB and Hotleads, see the `BudgetCategory`, `Project` and `ArchiveReason`, `Lead` classes respectively for examples.
+Adds basic ActiveRecord-like associations to static data.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'static_association'
+```ruby
+gem 'static_association'
+```
 
 And then execute:
 
@@ -24,25 +26,33 @@ Or install it yourself as:
 
 Create your static association class:
 
-    class Days
-      include StaticAssociation
+```ruby
+class Day
+  include StaticAssociation
 
-      attr_accessor :name
+  attr_accessor :name
 
-      record id: 0 do |day|
-        day.name = :monday
-      end
-    end
+  record id: 0 do |day|
+    day.name = :monday
+  end
+end
+```
 
 Calling `record` will allow you to create an instance of this static model, a unique id is mandatory. The newly created object is yielded to the passed block.
 
-The `Days` class will gain an `all` and `find` method.
+The `Day` class will gain an `all` and `find` method.
 
 ### Associations
 
 Currently just a 'belongs to' association can be created. This behaviour can be mixed into an `ActiveRecord` model:
 
-    belongs_to_static :day
+```ruby
+class Event < ActiveRecord::Base
+  extend StaticAssociation::AssociationHelpers
+
+  belongs_to_static :day
+end
+```
 
 This assumes your model has a field `day_id`.
 

data/gemfiles/3.0.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "i18n"
 gem "activesupport", "3.0"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/3.1.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "i18n"
 gem "activesupport", "3.1"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/3.2.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "activesupport", "3.2"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/4.0.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "activesupport", "4.0"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "4.1"
+
+gemspec :path => "../"

data/gemfiles/4.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "4.2"
+
+gemspec :path => "../"

data/lib/static_association.rb

@@ -1,6 +1,5 @@
 require 'static_association/version'
 require 'active_support/concern'
-require 'active_support/ordered_hash'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/string/inflections'
@@ -22,10 +21,10 @@ module StaticAssociation
   module ClassMethods
     include Enumerable
 
-    delegate :each, :to => :all
+    delegate :each, to: :all
 
     def index
-      @index ||= ActiveSupport::OrderedHash.new
+      @index ||= {} 
     end
 
     def all
@@ -33,26 +32,31 @@ module StaticAssociation
     end
 
     def find(id)
-      raise RecordNotFound unless index.has_key?(id)
+      find_by_id(id) or raise RecordNotFound
+    end
+
+    def find_by_id(id)
       index[id]
     end
 
-    def record(settings)
+    def record(settings, &block)
       settings.assert_valid_keys(:id)
       id = settings.fetch(:id)
       raise DuplicateID if index.has_key?(id)
       record = self.new(id)
-      yield(record) if block_given?
+      record.instance_exec(record, &block) if block_given?
       index[id] = record
     end
   end
 
   module AssociationHelpers
-    def belongs_to_static(name)
+    def belongs_to_static(name, opts = {})
+      class_name = opts.fetch(:class_name, name.to_s.camelize)
+
       self.send(:define_method, name) do
         begin
           foreign_key = self.send("#{name}_id")
-          name.to_s.camelize.constantize.find(foreign_key) if foreign_key
+          class_name.constantize.find(foreign_key) if foreign_key
         rescue RecordNotFound
           nil
         end

data/lib/static_association/version.rb

@@ -1,3 +1,3 @@
 module StaticAssociation
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/spec_helper.rb

@@ -4,14 +4,12 @@
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-require 'rubygems'
 require 'bundler/setup'
 
+require 'rspec/its'
+
 require 'static_association'
 
 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
   config.order = 'random'
 end

data/spec/static_association_spec.rb

@@ -15,8 +15,8 @@ describe StaticAssociation do
   describe ".record" do
     it "should add a record" do
       expect {
-        DummyClass.record :id => 1 do |c|
-          c.name = 'asdf'
+        DummyClass.record id: 1 do
+          self.name = 'asdf'
         end
       }.to change(DummyClass, :count).by(1)
     end
@@ -24,20 +24,31 @@ describe StaticAssociation do
     context "id uniqueness" do
       it "should raise an error with a duplicate id" do
         expect {
-          DummyClass.record :id => 1 do |c|
-            c.name = 'asdf'
+          DummyClass.record id: 1 do
+            self.name = 'asdf'
           end
 
-          DummyClass.record :id => 1 do |c|
-            c.name = 'asdf'
+          DummyClass.record id: 1 do
+            self.name = 'asdf'
           end
         }.to raise_error(StaticAssociation::DuplicateID)
       end
     end
 
-    context "sets up the instance" do
-      subject { 
-        DummyClass.record :id => 1 do |c|
+    context "sets up the instance using self" do
+      subject {
+        DummyClass.record id: 1 do
+          self.name = 'asdf'
+        end
+      }
+
+      its(:id) { should == 1 }
+      its(:name) { should == 'asdf' }
+    end
+
+    context "sets up the instance using the object passed in" do
+      subject {
+        DummyClass.record id: 1 do |c|
           c.name = 'asdf'
         end
       }
@@ -46,8 +57,9 @@ describe StaticAssociation do
       its(:name) { should == 'asdf' }
     end
 
+
     context "without a block" do
-      subject { DummyClass.record :id => 1 }
+      subject { DummyClass.record id: 1 }
 
       its(:id) { should == 1 }
       its(:name) { should be_nil }
@@ -56,31 +68,47 @@ describe StaticAssociation do
     context "asserting valid keys" do
       it "should raise an error" do
         expect {
-          DummyClass.record :id => 1, :foo => :bar
+          DummyClass.record id: 1, foo: :bar
         }.to raise_error(ArgumentError)
       end
     end
   end
 
-  describe ".find" do
+  describe "finders" do
     before do
-      DummyClass.record :id => 1 do |c|
-        c.name = 'asdf'
+      DummyClass.record id: 1 do
+        self.name = 'asdf'
       end
     end
 
-    context "record exists" do
-      subject { DummyClass.find(1) }
+    describe ".find" do
+      context "record exists" do
+        subject { DummyClass.find(1) }
 
-      it { should be_kind_of(DummyClass) }
-      its(:id) { should == 1 }
+        it { should be_kind_of(DummyClass) }
+        its(:id) { should == 1 }
+      end
+
+      context "record does not exist" do
+        it "should raise a StaticAssociation::RecordNotFoundError" do
+          expect {
+            DummyClass.find(:not_in_the_index)
+          }.to raise_error(StaticAssociation::RecordNotFound)
+        end
+      end
     end
 
-    context "record does not exist" do
-      it "should raise a StaticAssociation::RecordNotFoundError" do
-        expect {
-          DummyClass.find(:not_in_the_index)
-        }.to raise_error(StaticAssociation::RecordNotFound)
+    describe ".find_by_id" do
+      context "record exists" do
+        subject { DummyClass.find_by_id(1) }
+
+        it { should be_kind_of(DummyClass) }
+        its(:id) { should == 1 }
+      end
+
+      context "record does not exist" do
+        subject { DummyClass.find_by_id(:not_in_the_index) }
+        it { should be_nil }
       end
     end
   end
@@ -88,9 +116,11 @@ describe StaticAssociation do
   describe ".belongs_to_static" do
     class AssociationClass
       attr_accessor :dummy_class_id
-      
+      attr_accessor :dodo_class_id
+
       extend StaticAssociation::AssociationHelpers
       belongs_to_static :dummy_class
+      belongs_to_static :dodo_class, class_name: 'DummyClass'
     end
 
     let(:associated_class) { AssociationClass.new }
@@ -101,5 +131,12 @@ describe StaticAssociation do
       }
       associated_class.dummy_class
     end
+
+    it "creates a different reader method that uses the specified class when finding static asssociation" do
+      expect {
+        DummyClass.should_receive(:find)
+      }
+      associated_class.dodo_class
+    end
   end
 end

data/static_association.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{StaticAssociation adds a simple enum type that can act like an ActiveRecord association for static data.}
   spec.summary       = %q{ActiveRecord like associations for static data}
   spec.license       = "MIT"
+  spec.homepage      = "https://github.com/New-Bamboo/static_association"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -20,7 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activesupport", ">= 3.0.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "appraisal"
 end

metadata

@@ -1,83 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: static_association
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Oliver Nightingale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !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: appraisal
   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: StaticAssociation adds a simple enum type that can act like an ActiveRecord
@@ -88,27 +102,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - gemfiles/3.0.gemfile
-- gemfiles/3.0.gemfile.lock
 - gemfiles/3.1.gemfile
-- gemfiles/3.1.gemfile.lock
 - gemfiles/3.2.gemfile
-- gemfiles/3.2.gemfile.lock
 - gemfiles/4.0.gemfile
-- gemfiles/4.0.gemfile.lock
+- gemfiles/4.1.gemfile
+- gemfiles/4.2.gemfile
 - lib/static_association.rb
 - lib/static_association/version.rb
 - spec/spec_helper.rb
 - spec/static_association_spec.rb
 - static_association.gemspec
-homepage: 
+homepage: https://github.com/New-Bamboo/static_association
 licenses:
 - MIT
 metadata: {}
@@ -118,17 +130,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.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: ActiveRecord like associations for static data

data/gemfiles/3.0.gemfile.lock

@@ -1,36 +0,0 @@
-PATH
-  remote: /Users/olivernightingale/code/static_association
-  specs:
-    static_association (0.0.1)
-      activesupport (>= 3.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (3.0.0)
-    appraisal (0.5.2)
-      bundler
-      rake
-    diff-lcs (1.2.4)
-    i18n (0.6.5)
-    rake (10.1.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.3)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (= 3.0)
-  appraisal
-  bundler (~> 1.3)
-  i18n
-  rake
-  rspec
-  static_association!

data/gemfiles/3.1.gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: /Users/olivernightingale/code/static_association
-  specs:
-    static_association (0.0.1)
-      activesupport (>= 3.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (3.1.0)
-      multi_json (~> 1.0)
-    appraisal (0.5.2)
-      bundler
-      rake
-    diff-lcs (1.2.4)
-    i18n (0.6.5)
-    multi_json (1.8.0)
-    rake (10.1.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.3)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (= 3.1)
-  appraisal
-  bundler (~> 1.3)
-  i18n
-  rake
-  rspec
-  static_association!

data/gemfiles/3.2.gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: /Users/olivernightingale/code/static_association
-  specs:
-    static_association (0.0.1)
-      activesupport (>= 3.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (3.2.0)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    appraisal (0.5.2)
-      bundler
-      rake
-    diff-lcs (1.2.4)
-    i18n (0.6.5)
-    multi_json (1.8.0)
-    rake (10.1.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.3)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (= 3.2)
-  appraisal
-  bundler (~> 1.3)
-  rake
-  rspec
-  static_association!

data/gemfiles/4.0.gemfile.lock

@@ -1,46 +0,0 @@
-PATH
-  remote: /Users/olivernightingale/code/static_association
-  specs:
-    static_association (0.0.1)
-      activesupport (>= 3.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (4.0.0)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    appraisal (0.5.2)
-      bundler
-      rake
-    atomic (1.1.13)
-    diff-lcs (1.2.4)
-    i18n (0.6.5)
-    minitest (4.7.5)
-    multi_json (1.8.0)
-    rake (10.1.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.3)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    thread_safe (0.1.2)
-      atomic
-    tzinfo (0.3.37)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (= 4.0)
-  appraisal
-  bundler (~> 1.3)
-  rake
-  rspec
-  static_association!