hopsoft-acts-as-lookup 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.idea
+project_settings.xml
+Project_Default.xml

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nathan Hopkins
+
+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

@@ -0,0 +1,4 @@
+ActsAsLookup
+============
+
+Description goes here

data/README.rdoc

@@ -0,0 +1,18 @@
+= hopsoft_acts_as_lookup
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Nathan Hopkins. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hopsoft-acts-as-lookup"
+    gem.summary = "Lookup tables made easy for ActiveRecord"
+    gem.description = "Powerful lookup table behavior added to ActiveRecord."
+    gem.email = "natehop@gmail.com"
+    gem.homepage = "http://github.com/hopsoft/acts_as_lookup"
+    gem.authors = ["Nathan Hopkins"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hopsoft_acts_as_lookup #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/acts_as_lookup.gemspec

@@ -0,0 +1,15 @@
+require 'rake'
+
+Gem::Specification.new do |spec|
+  spec.version = '0.1.0'
+  spec.name = 'hopsoft-acts-as-lookup'
+  spec.summary = 'Lookup tables made easy for ActiveRecord'
+  spec.description = <<-DESC
+    Powerful lookup table behavior added to ActiveRecord.
+  DESC
+  spec.authors = ['Nathan Hopkins']
+  spec.email = ['natehop@gmail.com']
+  spec.bindir = 'bin'
+  spec.files = FileList['lib/*.rb', 'lib/**/*.rb', 'bin/*'].to_a
+end
+

data/hopsoft-acts-as-lookup.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hopsoft-acts-as-lookup}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Hopkins"]
+  s.date = %q{2009-10-21}
+  s.description = %q{Powerful lookup table behavior added to ActiveRecord.}
+  s.email = %q{natehop@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_lookup.gemspec",
+     "hopsoft-acts-as-lookup-0.1.0.gem",
+     "hopsoft-acts-as-lookup.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/hopsoft/acts_as_lookup.rb",
+     "tasks/acts_as_lookup_tasks.rake",
+     "test/acts_as_lookup_test.rb",
+     "test/helper.rb",
+     "test/test_hopsoft_acts_as_lookup.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/hopsoft/acts_as_lookup}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Lookup tables made easy for ActiveRecord}
+  s.test_files = [
+    "test/acts_as_lookup_test.rb",
+     "test/helper.rb",
+     "test/test_hopsoft_acts_as_lookup.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+require 'hopsoft/acts_as_lookup'
+ActiveRecord::Base.include(Hopsoft::ActsAsLookup)

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/hopsoft/acts_as_lookup.rb

@@ -0,0 +1,287 @@
+require 'activerecord'
+
+# This plugin allows you to painlessly move away from column based lookups to normalized lookup tables.
+#
+# Simply add "acts_as_lookup" to your lookup table models.
+#
+# The assumed schema inclueds a "name" column which is used as the "key column".
+# The "key column" is the column that holds the values that are used to key off of.
+# The "key column" allows you to code against expected values in the database
+# rather than hard coding with primary key values.
+#
+# This is generally safe considering that lookup data is relatively static.
+#
+# Consider the following schema:
+# ----------------------------------------------------
+# addresses
+#  * id
+#  * street
+#  * state_id
+#  * zip
+#
+# states
+#  * id
+#  * name => "UT, GA, IL, etc..."
+#  * description
+# ----------------------------------------------------
+#
+# Here are some examples of what this plugin provides when working with a lookup table directly:
+#
+# Obtain id from a lookup table like so:
+#  utah_id = State.ut(:id)
+#
+# Obtain the description like so:
+#  utah_desc = State.ut(:description)
+#
+# The real power comes with models that contain "belongs_to" relationships to parents that act_as_lookup.
+# These models implicitly mixin some additional behavior that make working with lookup tables
+# as simple as using columns directly on the table itself.
+#
+# For example:
+#
+# You can select with the following syntax:
+#  Address.find_by_state("UT")
+#
+# You can also assign like so:
+#  addr = Address.new
+#  addr.state = "UT"
+#
+# If a state with "UT" doesn't exist in the states table, one will be implicitly created.
+# The requirement being that the model validates correctly.  In this case only a name is assigned.
+module Hopsoft
+  module ActsAsLookup
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      # Adds lookup table behavior to a model.
+      def acts_as_lookup(options={})
+        @key_column = options[:key_column] || :name
+        include Hopsoft::ActsAsLookup::IsLookup::InstanceMethods
+        extend Hopsoft::ActsAsLookup::IsLookup::StaticMethods
+        init
+      end
+
+      # Used to implicitly mixin additional behavior for models that contain "belongs_to"
+      # relationships to lookup tables.
+      def belongs_to(association_id, options={})
+        result = super
+
+        begin
+          parent_model_name = options[:class_name] || association_id.to_s.camelize
+          parent_model = Object.const_get(parent_model_name)
+          parent_acts_as_lookup = defined?(parent_model.key_column)
+
+          # only add the behavior for belongs_to relationships where the parent implements "acts_as_lookup".
+          if parent_acts_as_lookup
+            @lookup_models ||= []
+            @lookup_models << parent_model
+
+            unless @lookup_behavior_added
+              include Hopsoft::ActsAsLookup::UsesLookups::InstanceMethods
+              extend Hopsoft::ActsAsLookup::UsesLookups::StaticMethods
+              @lookup_behavior_added = true
+            end
+          end
+        rescue
+          puts("LookupTables plugin error!  Unable to override belongs_to for '#{parent_model_name}'!\n#{$!}")
+        end
+
+        result
+      end
+    end
+
+    # This module is implicitly mixed into any models that specify "belongs_to" using an "acts_as_lookup" model.
+    # Provides some helpful tools for selecting and assigning values for lookup tables.
+    # See the plugin description for more details.
+    module UsesLookups
+
+      # Add class methods here
+      module StaticMethods
+        attr_reader :lookup_models
+
+        def method_missing(name, *args)
+          if name =~ /^find_by_/i && args && args.length == 1
+            @lookup_models.each do |model|
+              attribute_name = model.table_name.singularize
+
+              if name =~ /#{attribute_name}$/i
+                # if we get here, assume a lookup is being performed
+                return lookup_parent(model, args[0])
+              end
+            end
+          end
+
+          super
+        end
+
+        private
+
+        # Attempts to find a parent record based on the passed value.
+        # The parent model must implement "acts_as_lookup" for this method to work as expected.
+        #
+        # Exmaple:
+        #  Message.find_by_message_status :pending
+        def lookup_parent(parent_model, value)
+          value = value.to_s.downcase.gsub(/ /, "_")
+          return send("find_by_#{parent_model.table_name.singularize}_id", parent_model.send(value, :id))
+        end
+
+      end
+
+      # Add instance methods here
+      module InstanceMethods
+
+      end
+
+    end
+
+    module IsLookup
+
+      # Add class methods here
+      module StaticMethods
+        attr_reader :key_column
+
+        def method_missing(name, *args)
+
+          if args && args.length == 1
+            column_name = args[0].to_s.downcase
+
+            if column_name =~ /^object$/
+              return get_record(name)
+            else
+              if @lookup_columns.include?(column_name)
+                # once here we are assuming they are performing a lookup
+                return get_column_value(name, column_name)
+              end
+            end
+          end
+
+          return super
+        end
+
+        # Gets a column's value from an "acts_as_lookup" model.
+        #
+        # ===Params
+        # * *value* - The "key column" value to find.
+        # * *column_name* - The column's name to return a value for.
+        def get_column_value(value, column_name)
+          record = get_record(value)
+          return record.attributes[column_name] if record
+          return nil
+        end
+
+        # Gets an ActiveRecord object from an "acts_as_lookup" model.
+        #
+        # ===Params
+        # * *value* - The "key column" value to find.
+        def get_record(value)
+          value = value.to_s.downcase.gsub(/_/, " ")
+          finder_method = "find_by_#{@key_column}"
+          item = send(finder_method, value)
+          item
+        end
+
+        # Initializes the plugin.
+        def init
+          @lookup_columns = new.attributes.keys.map {|attr_name| attr_name.downcase.gsub(/ /, "_") }
+          @lookup_columns << "id"
+        end
+
+      end
+
+      # Add instance methods here
+      module InstanceMethods
+
+        def to_s
+          return name
+        end
+
+        def ==(value)
+          return name == value if value.is_a?(String)
+          return name == value.to_s if value.is_a?(Symbol)
+          return id == value.id if self.class == value.class
+          return self.object_id == value.object_id
+        end
+
+        def =~(value)
+          return name =~ value if value.is_a?(Regexp)
+          return name =~ /#{value}/i if value.is_a?(String)
+          return name =~ /#{value.to_s}/i if value.is_a?(Symbol)
+          return false
+        end
+
+      end
+
+    end
+
+  end
+end
+
+module ActiveRecord
+  class Migration
+
+    # Migration helper for creating a standardized lookup table.
+    def self.create_lookup_table(name)
+      create_table name do |t|
+        # lookup columns
+        t.column :name, :string, :limit => 50, :null => false
+        t.column :description, :text
+        t.column :enabled, :boolean, :default => true, :null => false
+        t.column :sort_order, :integer, :default => 0, :null => false
+      end rescue
+      add_index(name, :name, :unique => true)
+    end
+
+  end
+
+  module Associations
+    class BelongsToAssociation
+      alias :orig_replace :replace
+
+      # Overriding "replace" to allow implicit lookup table insertions.
+      # The assumption being that the only required field is the specified "key column" or
+      # in other words the column whose value we use to key off of.
+      def replace(record)
+        if record.is_a?(Symbol) || record.is_a?(String)
+          value = record.to_s
+          attribute_name = proxy_reflection.table_name.singularize
+          lookup_models = proxy_owner.class.lookup_models
+
+          lookup_models.each do |model|
+            if attribute_name =~ /^#{model.table_name.singularize}$/i
+              record = model.get_record(value)
+
+              if record.nil?
+                new_record = model.new(model.key_column.to_sym => value)
+                record = new_record if new_record.save
+              end
+
+              break
+            end
+          end
+
+        end
+
+        return orig_replace(record)
+      end
+
+    end
+  end
+end
+
+module ApplicationHelper
+  def select_from_lookup(table, options = {})
+    if table.is_a?(Symbol) || table.is_a?(String)
+      model = Object.const_get(table.to_s.classify)
+      field ||= options[:field] || "name"
+      collection = model.send(:find, :all)
+      default ||= options[:value] || nil
+      choices = options_from_collection_for_select(collection, "name", field, default)
+      select_tag table, choices, options
+    end
+  end
+end

data/tasks/acts_as_lookup_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_lookup do
+#   # Task goes here
+# end

data/test/acts_as_lookup_test.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+
+class ActsAsLookupTest < Test::Unit::TestCase
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'hopsoft_acts_as_lookup'
+
+class Test::Unit::TestCase
+end

data/test/test_hopsoft_acts_as_lookup.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestHopsoftActsAsLookup < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: hopsoft-acts-as-lookup
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nathan Hopkins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-21 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Powerful lookup table behavior added to ActiveRecord.
+email: natehop@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_lookup.gemspec
+- hopsoft-acts-as-lookup-0.1.0.gem
+- hopsoft-acts-as-lookup.gemspec
+- init.rb
+- install.rb
+- lib/hopsoft/acts_as_lookup.rb
+- tasks/acts_as_lookup_tasks.rake
+- test/acts_as_lookup_test.rb
+- test/helper.rb
+- test/test_hopsoft_acts_as_lookup.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/hopsoft/acts_as_lookup
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Lookup tables made easy for ActiveRecord
+test_files: 
+- test/acts_as_lookup_test.rb
+- test/helper.rb
+- test/test_hopsoft_acts_as_lookup.rb