cassiano-cassiano-model_lookup 0.1.5

data/README.rdoc

@@ -0,0 +1,83 @@
+= ModelLookup
+
+Rails gem that implements the notion of a virtual (transient) lookup table inside Active Record (AR), allowing for the creation of belongs_to and has_many associations between these and physical (persistent) AR entities.
+
+
+== Install
+
+  gem install cassiano-model_lookup --source http://gems.github.com
+
+
+== Usage
+
+Let's assume we want to map the 1 x N association between (US) _States_ and _Customers_:
+
+  class State < ModelLookup
+    set_domain_values [
+      # :id   :name
+      # ----  --------------
+      [ 'CA', 'California'  ],
+      [ 'FL', 'Florida'     ],
+      [ 'GA', 'Georgia'     ],
+      ...
+    ]
+
+    model_lookup_has_many :customers
+  end
+
+  class Customer < ActiveRecord::Base
+    model_lookup_belongs_to :state
+    has_many                :contacts
+
+    validates_presence_of :name, :city, :state
+  end
+
+Now you can do things such as:
+
+  c = Customer.create :name => 'West Inc', :city => 'San Jose', :state => State.find_by_id('CA')
+  => #<Customer id: 1, name: "West Inc", city: "San Jose", state: "CA">  
+
+  c.state    
+  => #<State:0x449ee14 @id="CA", @name="California">
+
+  c.state.name
+  => "California"
+
+  c.state.id
+  => "CA"
+
+  State.all
+  => [#<State:0x449ee14 @id="CA", @name="California">, #<State:0x449ee15 @id="FL", @name="Florida">, 
+      #<State:0x449ee16 @id="GA", @name="Georgia">]
+
+  s = State.first
+  => #<State:0x449ee14 @id="CA", @name="California">
+
+  State.last
+  => #<State:0x449ee16 @id="GA", @name="Georgia">
+
+  s.customers
+  => [#<Customer id: 1, name: "West Inc", city: "San Jose", state: "CA">]
+
+== License
+
+Copyright (C) 2008 Tagview Tecnologia (Cassiano D'Andrea - cassiano.dandrea@tagview.com.br)
+ 
+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/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('cassiano-model_lookup', '0.1.5') do |p|
+  p.description    = "Implements the notion of a virtual (transient) lookup table inside Active Record (AR), allowing for the creation of belongs_to and has_many associations between these and physical (persistent) AR entities"
+  p.url            = "http://github.com/cassiano/model_lookup"
+  p.author         = "Cassiano D'Andrea"
+  p.email          = "cassiano.dandrea@tagview.com.br"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/cassiano-model_lookup.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name = %q{cassiano-model_lookup}
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cassiano D'Andrea"]
+  s.date = %q{2008-11-13}
+  s.description = %q{Implements the notion of a virtual (transient) lookup table inside Active Record (AR), allowing for the creation of belongs_to and has_many associations between these and physical (persistent) AR entities}
+  s.email = %q{cassiano.dandrea@tagview.com.br}
+  s.extra_rdoc_files = ["lib/model_lookup.rb", "README.rdoc"]
+  s.files = ["cassiano-model_lookup.gemspec", "init.rb", "lib/model_lookup.rb", "Manifest", "model_lookup.gemspec", "Rakefile", "README.rdoc"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/cassiano/model_lookup}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Cassiano-model_lookup", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{cassiano-model_lookup}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Implements the notion of a virtual (transient) lookup table inside Active Record (AR), allowing for the creation of belongs_to and has_many associations between these and physical (persistent) AR entities}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,25 @@
+################################################################################
+#
+# Copyright (C) 2008 Tagview Tecnologia (Cassiano D'Andrea - cassiano.dandrea@tagview.com.br)
+#
+# 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.
+#
+################################################################################
+require 'model_lookup'

data/lib/model_lookup.rb

@@ -0,0 +1,227 @@
+################################################################################
+#
+# Copyright (C) 2008 Tagview Tecnologia (Cassiano D'Andrea - cassiano.dandrea@tagview.com.br)
+#
+# 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.
+#
+################################################################################
+# Implements the notion of a virtual (transient) lookup table inside Active Record (AR), allowing for the creation of belongs_to and has_many 
+# associations between these and physical (persistent) AR entities.
+class ModelLookup
+  ################################################################################
+  attr_accessor :id, :name
+  
+  ################################################################################
+  def initialize(id, name)
+    @id   = id
+    @name = name
+  end
+
+  ################################################################################
+  def to_param
+    self.id
+  end
+
+  ################################################################################
+  def ==(another_model_lookup_object)
+    self.id == another_model_lookup_object.id
+  end
+
+  ################################################################################
+  # Class Methods
+  class << self
+    ################################################################################
+    attr_writer :values
+  
+    ################################################################################
+    # Returns *all* instances of the model lookup table.
+    def all(options = {})
+      @all ||= {}
+
+      @all[options.inspect] ||= 
+        returning(@values.map { |v| self.new *v }) do |collection|
+          if options[:order]
+            sort_attr, sort_dir = options[:order].to_s.split
+            
+            asc = !sort_dir || sort_dir.downcase.to_sym == :asc
+      
+            collection.sort! { |a, b| (asc ? a : b).__send__(sort_attr) <=> (asc ? b : a).__send__(sort_attr) }
+          end
+        end  
+    end
+
+    ################################################################################
+    # Returns the *first* instance of a model lookup table.
+    def first(options = {})
+      self.all(options).first
+    end
+
+    ################################################################################
+    # Returns the *last* instance of a model lookup table.
+    def last(options = {})
+      self.all(options).last
+    end
+
+    ################################################################################
+    # Finds a model lookup instance with a given ID. Throws _ActiveRecord::RecordNotFound_ if not found.
+    def find(param)
+      self.all.find { |v| v.to_param == param } || raise(ActiveRecord::RecordNotFound)
+    end
+
+    ################################################################################
+    # Finds a model lookup instance with a given ID. Returns nil if not found.
+    def find_by_id(id)
+      self.all.find { |v| v.id == id }
+    end
+
+    ################################################################################
+    # Finds a model lookup instance with a given name. Returns nil if not found.
+    def find_by_name(name)
+      self.all.find { |v| v.name == name }
+    end
+
+    ################################################################################
+    # Returns a count/size of all model lookup instances.
+    def count
+      self.all.size
+    end
+
+    ################################################################################
+    def model_lookup_has_many(association_id, options = {})
+      begin
+        options.reverse_merge!(
+          :class_name => association_id.to_s.classify.constantize
+        )
+      rescue NameError
+      end
+
+      options[:class_name] = options[:class_name].to_s.constantize if !options[:class_name].is_a?(Class)
+
+      options.reverse_merge!(
+        :foreign_key        => self.to_s.foreign_key,
+        :virtual_attribute  => false
+      )
+      
+      options.reverse_merge!(
+        :method => options[:foreign_key].to_s.sub(/_id$/, '').to_sym
+      )
+      
+      define_method association_id do |*args|
+        finder_options = args[0] || {}
+        
+        finder_options.reverse_merge!(
+          :order      => options[:order],
+          :conditions => options[:conditions],
+          :limit      => options[:limit]
+        )
+      
+        this = self
+
+        options[:class_name].class_eval do
+          with_scope :find => finder_options do
+            if options[:virtual_attribute]
+              if options[:optimal_conditions]
+                self.all :conditions => options[:optimal_conditions].gsub('?', this.id)
+              else
+                self.all.select { |e| e.__send__(options[:foreign_key]) == this.id }
+              end
+            else
+              self.all :conditions => { options[:method] => this.id }
+            end
+          end
+        end
+      end
+    end
+
+    ################################################################################
+    def find_for_lookup_select(options = {}, finder_options = {})
+      self.all finder_options
+    end
+
+    ################################################################################
+    protected
+
+    ################################################################################
+    def set_domain_values(values)
+      @values = values
+    end
+  end
+end
+
+################################################################################
+module ModelLookupAssociations
+  ################################################################################
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  ################################################################################
+  module ClassMethods
+    ################################################################################
+    def model_lookup_belongs_to(association_id, options = {})
+      begin
+        options.reverse_merge!(
+          :class_name => association_id.to_s.classify.constantize
+        )
+      rescue NameError
+      end
+  
+      options[:class_name] = options[:class_name].to_s.constantize if !options[:class_name].is_a?(Class)
+
+      options.reverse_merge!(
+        :foreign_key => association_id.to_s.foreign_key
+      )
+  
+      options.reverse_merge!(
+        :method => options[:foreign_key].to_s.sub(/_id$/, '').to_sym
+      )
+  
+      # Include "referential integrity" validation.
+      self.validates_inclusion_of "#{association_id}_id", :in => options[:class_name].all.map(&:id), :allow_blank => true
+  
+      # Define the getter (making it behave like if it were a proxy association).
+      define_method association_id do
+        association_value = self.__send__ "#{association_id}_id"
+        options[:class_name].find_by_id(association_value) if !association_value.blank?
+      end    
+  
+      # Define the setter.
+      define_method "#{association_id}=" do |new_association_id|
+        self.__send__ "#{association_id}_id=", new_association_id.to_param
+      end    
+  
+      # Define the "foreign key" getter.
+      define_method "#{association_id}_id" do
+        self.read_attribute options[:method]
+      end    
+  
+      # Define the "foreign key" setter.
+      define_method "#{association_id}_id=" do |new_id|
+        self.write_attribute options[:method], new_id
+      end    
+    end
+  end
+end
+
+################################################################################
+class ActiveRecord::Base
+  ################################################################################
+  include ModelLookupAssociations
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: cassiano-cassiano-model_lookup
+version: !ruby/object:Gem::Version 
+  version: 0.1.5
+platform: ruby
+authors: 
+- Cassiano D'Andrea
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-13 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Implements the notion of a virtual (transient) lookup table inside Active Record (AR), allowing for the creation of belongs_to and has_many associations between these and physical (persistent) AR entities
+email: cassiano.dandrea@tagview.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/model_lookup.rb
+- README.rdoc
+files: 
+- cassiano-model_lookup.gemspec
+- init.rb
+- lib/model_lookup.rb
+- Manifest
+- model_lookup.gemspec
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/cassiano/model_lookup
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Cassiano-model_lookup
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: cassiano-model_lookup
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Implements the notion of a virtual (transient) lookup table inside Active Record (AR), allowing for the creation of belongs_to and has_many associations between these and physical (persistent) AR entities
+test_files: []
+