static_association 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9070d8b187c9b04c979f3f77244f5f0aff54bc9
+  data.tar.gz: 3a95140244d4d5413d29b86b517f847177a03182
+SHA512:
+  metadata.gz: 11a3e13c6693ec96763180f4f1e7feff0d41bb6b8fd0ea8bac6f662c21cc23df81b1d2aa16e3107f887d44df54da0ab5be89e66d3e7b44b3f5dda73c94373d4b
+  data.tar.gz: cc67b525ced9dce9f6b56ec235b955c7a140cf98639738451f1d4ec95285db2e5e42e65e880bd3b1f717a6c9fbb8ffd1d4a00f5d90c96435c7d069ac79125af1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+install: bundle install
+script:
+ - bundle exec rake
+rvm:
+  - 2.0.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

data/Appraisals

@@ -0,0 +1,17 @@
+appraise "3.0" do
+  gem "i18n"
+  gem "activesupport", "3.0"
+end
+
+appraise "3.1" do
+  gem "i18n"
+  gem "activesupport", "3.1"
+end
+
+appraise "3.2" do
+  gem "activesupport", "3.2"
+end
+
+appraise "4.0" do
+  gem "activesupport", "4.0"
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Oliver Nightingale
+
+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,56 @@
+# StaticAssociation
+
+Adds basic ActiveRecord like associations to static data.
+
+This has been extracted from ProjectsDB and Hotleads, see the `BudgetCategory`, `Project` and `ArchiveReason`, `Lead` classes respectively for examples.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'static_association'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install static_association
+
+## Usage
+
+### Static Models
+
+Create your static association class:
+
+    class Days
+      include StaticAssociation
+
+      attr_accessor :name
+
+      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.
+
+### Associations
+
+Currently just a 'belongs to' association can be created. This behaviour can be mixed into an `ActiveRecord` model:
+
+    belongs_to_static :day
+
+This assumes your model has a field `day_id`.
+
+## 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. Run the tests (`rake`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

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

data/gemfiles/3.0.gemfile

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

data/gemfiles/3.0.gemfile.lock

@@ -0,0 +1,36 @@
+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

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

data/gemfiles/3.1.gemfile.lock

@@ -0,0 +1,38 @@
+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

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

data/gemfiles/3.2.gemfile.lock

@@ -0,0 +1,38 @@
+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

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

data/gemfiles/4.0.gemfile.lock

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

data/lib/static_association.rb

@@ -0,0 +1,66 @@
+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'
+
+module StaticAssociation
+  extend ActiveSupport::Concern
+
+  class DuplicateID < StandardError; end
+  class RecordNotFound < StandardError; end
+
+  attr_reader :id
+
+  private
+
+  def initialize(id)
+    @id = id
+  end
+
+  module ClassMethods
+    include Enumerable
+
+    delegate :each, :to => :all
+
+    def index
+      @index ||= ActiveSupport::OrderedHash.new
+    end
+
+    def all
+      index.values
+    end
+
+    def find(id)
+      raise RecordNotFound unless index.has_key?(id)
+      index[id]
+    end
+
+    def record(settings)
+      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?
+      index[id] = record
+    end
+  end
+
+  module AssociationHelpers
+    def belongs_to_static(name)
+      self.send(:define_method, name) do
+        begin
+          foreign_key = self.send("#{name}_id")
+          name.to_s.camelize.constantize.find(foreign_key) if foreign_key
+        rescue RecordNotFound
+          nil
+        end
+      end
+
+      self.send(:define_method, "#{name}=") do |assoc|
+        self.send("#{name}_id=", assoc.id)
+      end
+    end
+  end
+end

data/lib/static_association/version.rb

@@ -0,0 +1,3 @@
+module StaticAssociation
+  VERSION = "0.0.2"
+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
+require 'rubygems'
+require 'bundler/setup'
+
+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

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'static_association'
+
+describe StaticAssociation do
+
+  class DummyClass
+    include StaticAssociation
+    attr_accessor :name
+  end
+
+  after do
+    DummyClass.instance_variable_set("@index", {})
+  end
+
+  describe ".record" do
+    it "should add a record" do
+      expect {
+        DummyClass.record :id => 1 do |c|
+          c.name = 'asdf'
+        end
+      }.to change(DummyClass, :count).by(1)
+    end
+
+    context "id uniqueness" do
+      it "should raise an error with a duplicate id" do
+        expect {
+          DummyClass.record :id => 1 do |c|
+            c.name = 'asdf'
+          end
+
+          DummyClass.record :id => 1 do |c|
+            c.name = 'asdf'
+          end
+        }.to raise_error(StaticAssociation::DuplicateID)
+      end
+    end
+
+    context "sets up the instance" do
+      subject { 
+        DummyClass.record :id => 1 do |c|
+          c.name = 'asdf'
+        end
+      }
+
+      its(:id) { should == 1 }
+      its(:name) { should == 'asdf' }
+    end
+
+    context "without a block" do
+      subject { DummyClass.record :id => 1 }
+
+      its(:id) { should == 1 }
+      its(:name) { should be_nil }
+    end
+
+    context "asserting valid keys" do
+      it "should raise an error" do
+        expect {
+          DummyClass.record :id => 1, :foo => :bar
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe ".find" do
+    before do
+      DummyClass.record :id => 1 do |c|
+        c.name = 'asdf'
+      end
+    end
+
+    context "record exists" do
+      subject { DummyClass.find(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
+
+  describe ".belongs_to_static" do
+    class AssociationClass
+      attr_accessor :dummy_class_id
+      
+      extend StaticAssociation::AssociationHelpers
+      belongs_to_static :dummy_class
+    end
+
+    let(:associated_class) { AssociationClass.new }
+
+    it "creates reader method that uses the correct singularized class when finding static association" do
+      expect {
+        DummyClass.should_receive(:find)
+      }
+      associated_class.dummy_class
+    end
+  end
+end

data/static_association.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'static_association/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "static_association"
+  spec.version       = StaticAssociation::VERSION
+  spec.authors       = ["Oliver Nightingale"]
+  spec.email         = ["oliver.nightingale1@gmail.com"]
+  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.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", ">= 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "appraisal"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: static_association
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Oliver Nightingale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-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'
+  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: 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
+  association for static data.
+email:
+- oliver.nightingale1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .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
+- lib/static_association.rb
+- lib/static_association/version.rb
+- spec/spec_helper.rb
+- spec/static_association_spec.rb
+- static_association.gemspec
+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: ActiveRecord like associations for static data
+test_files:
+- spec/spec_helper.rb
+- spec/static_association_spec.rb