redinger-hashdown 0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/CHANGELOG

@@ -0,0 +1,2 @@
+== 0.1.1
+* gemified by Christopher Redinger

data/README.rdoc

@@ -0,0 +1,58 @@
+= hashdown
+
+http://github.com/rubysolo/hashdown
+
+== DESCRIPTION:
+
+hashdown is a super lightweight rails plugin that adds hash-style lookups and option lists (for generating dropdowns) to ActiveRecord models
+
+== EXAMPLE:
+
+Given the following class definition:
+
+  class State < ActiveRecord::Base
+    finder :abbreviation
+    selectable
+  end
+
+You can look up states via their abbreviations like so:
+
+  @colorado = State[:CO]
+
+These types of reference data models are often something you need to populate a select list on your form, so hashdown includes a handy method to generate your option list:
+
+  <%= form.select :state_id, State.select_options %>
+
+This is roughly equivalent to the following implementation:
+
+  class State < ActiveRecord::Base
+    validates_uniqueness_of :abbreviation
+
+    def self.[](state_code)
+      find_by_abbreviation(state_code)
+    end
+
+    def self.select_options
+      find(:all).map{|s| [s.name, s.id] }
+    end
+  end
+
+...except it adds ActiveSupport caching for speedy lookups.
+
+== COMING SOON:
+
+* configuration for key / value generation
+  * app level
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright © 2008-2009 Solomon White
+
+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,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hashdown"
+    gem.summary = %Q{hash-style lookups and option lists}
+    gem.description = %Q{hashdown is a super lightweight rails plugin that adds hash-style lookups and option lists (for generating dropdowns) to ActiveRecord models}
+    gem.email = "redinger@gmail.com"
+    gem.homepage = "http://github.com/redinger/hashdown"
+    gem.authors = ["Solomon White", "Christopher Redinger"]
+    gem.add_development_dependency "rspec"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hashdown #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 1
+:major: 0

data/hashdown.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hashdown}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Solomon White", "Christopher Redinger"]
+  s.date = %q{2009-09-24}
+  s.description = %q{hashdown is a super lightweight rails plugin that adds hash-style lookups and option lists (for generating dropdowns) to ActiveRecord models}
+  s.email = %q{redinger@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "hashdown.gemspec",
+     "init.rb",
+     "lib/finder.rb",
+     "lib/hashdown.rb",
+     "lib/selectable.rb",
+     "rails/init.rb",
+     "spec/finder_spec.rb",
+     "spec/fixtures/currencies.yml",
+     "spec/fixtures/states.yml",
+     "spec/selectable_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/redinger/hashdown}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{hash-style lookups and option lists}
+  s.test_files = [
+    "spec/finder_spec.rb",
+     "spec/selectable_spec.rb",
+     "spec/spec_helper.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<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'hashdown'

data/lib/finder.rb

@@ -0,0 +1,28 @@
+module Rubysolo # :nodoc:
+  module Hashdown
+
+    module Finder
+      def self.included(base)
+        base.instance_eval do
+          validates_uniqueness_of finder_attribute
+
+          cattr_accessor :cache_store
+          self.cache_store ||= ActiveSupport::Cache::MemoryStore.new
+
+          def self.[](token)
+            cache_store.fetch("[]:#{token}", :force => Rubysolo::Hashdown.force_cache_miss?) {
+              returning find(:first, :conditions => { finder_attribute => token.to_s}) do |record|
+                raise "Could not find #{self.class_name} with #{finder_attribute} '#{token}'" unless record
+              end
+            }
+          end
+        end
+      end
+
+      def is?(token)
+        self[self.class.finder_attribute] == token.to_s
+      end
+    end # Finder
+
+  end
+end

data/lib/hashdown.rb

@@ -0,0 +1,44 @@
+require 'activesupport' unless defined? ActiveSupport
+require 'activerecord'  unless defined? ActiveRecord
+require 'finder'
+require 'selectable'
+
+module Rubysolo # :nodoc:
+  module Hashdown
+    def self.included(base) # :nodoc:
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def finder(attr_name)
+        class << self
+          attr_accessor :finder_attribute
+        end
+        self.finder_attribute = attr_name
+
+        self.send :include, Finder
+      end
+
+      def selectable(options={})
+        class << self
+          attr_accessor :selectable_options
+        end
+        self.selectable_options = options
+
+        self.send :include, Selectable
+      end
+    end
+
+    private
+
+    def self.force_cache_miss?
+      defined?(Rails) && Rails.env.test?
+    end
+
+
+  end # Hashdown
+end # Rubysolo
+
+ActiveRecord::Base.class_eval do
+  include Rubysolo::Hashdown
+end

data/lib/selectable.rb

@@ -0,0 +1,44 @@
+module Rubysolo # :nodoc:
+  module Hashdown
+
+    module Selectable
+      def self.included(base)
+        base.instance_eval do
+          cattr_accessor :cache_store
+          self.cache_store ||= ActiveSupport::Cache::MemoryStore.new
+
+          def self.select_options(*args)
+            cache_store.fetch("select_options:#{args.hash}", :force => Rubysolo::Hashdown.force_cache_miss?) {
+              options = args.extract_options!
+              options[:value] ||= args.shift || selectable_options[:value]
+
+              [:display_name, :name].each {|sym| options[:value] ||= sym if instance_methods.include?(sym.to_s) || has_column?(sym) } unless options[:value]
+              raise "#{self} does not respond to :display_name or :name.  Please specify a value method." unless options[:value]
+
+              options[:key] ||= args.shift || selectable_options[:key]
+              options[:key] ||= :id
+
+              find_options = scope(:find) || {}
+              find_options[:order] = options[:order] if options.has_key?(:order)
+              find_options[:order] ||= options[:value] if has_column?(options[:value])
+
+              find(:all, find_options).map{|record| record.to_pair(options[:key], options[:value]) }
+            }.dup
+          end
+
+          def self.has_column?(column_name)
+            columns.map{|c| c.name }.include?(column_name.to_s)
+          end
+        end
+      end
+
+      def to_pair(key_generator, val_generator)
+        key = key_generator.respond_to?(:call) ? key_generator.call(self) : self.send(key_generator)
+        val = val_generator.respond_to?(:call) ? val_generator.call(self) : self.send(val_generator)
+
+        [val, key]
+      end
+    end # Selectable
+
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/../init"

data/spec/finder_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "an ActiveRecord model with finder defined" do
+
+  before(:each) do
+    Rails.test_environment = false
+    State.cache_store.clear
+    load_fixtures
+  end
+
+  after(:each) do
+    cleanup_db
+  end
+
+
+  it "should respond to []" do
+    State.should.respond_to? :[]
+  end
+
+  it "should enforce uniqueness of lookup token" do
+    State[:CO].name.should == "Colorado"
+    @state = State.new(:abbreviation => "CO")
+    @state.should_not be_valid
+  end
+
+  it "should support hash-like lookup" do
+    @colorado = State.find_by_name 'California'
+    State[:CA].should == @colorado
+  end
+
+  it "should cache results in memory" do
+    @state = State.create!(:abbreviation => "FL", :name => "Florida")
+    State.expects(:find).once.returns(@state)
+
+    5.times do
+      State[:FL].name.should == "Florida"
+    end
+  end
+
+  it "should force cache miss in Rails test environment" do
+    Rails.test_environment = true
+
+    @state = State.create!(:abbreviation => "FL", :name => "Florida")
+    State.expects(:find).times(5).returns(@state)
+
+    5.times do
+      State[:FL].name.should == "Florida"
+    end
+  end
+end

data/spec/fixtures/currencies.yml

@@ -0,0 +1,15 @@
+pound_sterling:
+  code: GBP
+  name: Pound Sterling
+
+euro:
+  code: EUR
+  name: Euro
+
+us_dollar:
+  code: USD
+  name: US Dollar
+
+renminbi:
+  code: CNY
+  name: Renminbi

data/spec/fixtures/states.yml

@@ -0,0 +1,19 @@
+arizona:
+  name: Arizona
+  abbreviation: AZ
+
+new_york:
+  name: New York
+  abbreviation: NY
+
+california:
+  name: California
+  abbreviation: CA
+
+texas:
+  name: Texas
+  abbreviation: TX
+
+colorado:
+  name: Colorado
+  abbreviation: CO

data/spec/selectable_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "an ActiveRecord model with selectable defined" do
+
+  before(:each) do
+    Rails.test_environment = false
+    State.cache_store.clear
+    load_fixtures
+  end
+
+  after(:each) do
+    cleanup_db
+  end
+
+
+  it "should respond to select_options" do
+    State.should.respond_to? :select_options
+  end
+
+  it "should return options for each record" do
+    State.select_options.length.should == State.count
+    State.select_options.map(&:first).should == ['Arizona','California','Colorado','New York','Texas']
+  end
+
+  it "should respect default scope find options" do
+    Currency.select_options.map(&:first).should == ['Renminbi', 'Euro', 'Pound Sterling', 'US Dollar']
+  end
+
+  it "should allow overriding the key and value generation" do
+    Currency.select_options(:code).map(&:first).should == %w( CNY EUR GBP USD )
+    Currency.select_options(:name, :code).should == [['Renminbi','CNY'],['Euro','EUR'],['Pound Sterling','GBP'],['US Dollar', 'USD']]
+  end
+
+  it "should store results in cache" do
+    @states = State.all
+    State.expects(:find).once.returns(@states)
+
+    5.times do
+      State.select_options.length.should == State.count
+    end
+  end
+
+  it "should force cache miss in Rails test environment" do
+    Rails.test_environment = true
+
+    @states = State.all
+    State.expects(:find).times(5).returns(@states)
+
+    5.times do
+      State.select_options.length.should == State.count
+    end
+  end
+
+  it "should not default non-column ordering" do
+    lambda{ CustomDisplay.select_options }.should_not raise_error
+  end
+
+  it "should accept defaults at the model level" do
+    CustomDisplayDeux.select_options.should == State.select_options(:value => :abbreviation)
+  end
+
+  it "should allow overriding model-level defaults" do
+    CustomDisplayDeux.select_options(:value => :name).should == State.select_options
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'spec'
+begin
+  require 'mocha'
+rescue LoadError
+  require "rubygems"
+  require 'mocha'
+end
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require File.join(File.dirname(__FILE__), '..', 'init')
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.verbose = false
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :states do |t|
+      t.string :name, :abbreviation
+    end
+
+    create_table :currencies do |t|
+      t.string :name, :code
+    end
+  end
+end
+
+def load_fixtures
+  %w( states currencies ).each do |fixture|
+    YAML.load(IO.read(File.dirname(__FILE__) + "/fixtures/#{fixture}.yml")).each do |name, attrs|
+      Object.const_get(fixture.singularize.classify).create!(attrs)
+    end
+  end
+end
+
+setup_db
+
+def cleanup_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.execute("delete from #{table}")
+  end
+end
+
+class Rails
+  cattr_accessor :test_environment
+
+  def self.env
+    self
+  end
+
+  def self.test?
+    @@test_environment
+  end
+end
+
+class State < ActiveRecord::Base
+  finder :abbreviation
+  selectable
+end
+
+class CustomDisplay < ActiveRecord::Base
+  selectable
+  set_table_name 'states'
+
+  def display_name
+    "custom #{name}"
+  end
+end
+
+class CustomDisplayDeux < ActiveRecord::Base
+  selectable :value => :abbreviation
+  set_table_name 'states'
+end
+
+class Currency < ActiveRecord::Base
+  selectable
+  default_scope :order => "code"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: redinger-hashdown
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Solomon White
+- Christopher Redinger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: hashdown is a super lightweight rails plugin that adds hash-style lookups and option lists (for generating dropdowns) to ActiveRecord models
+email: redinger@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- hashdown.gemspec
+- init.rb
+- lib/finder.rb
+- lib/hashdown.rb
+- lib/selectable.rb
+- rails/init.rb
+- spec/finder_spec.rb
+- spec/fixtures/currencies.yml
+- spec/fixtures/states.yml
+- spec/selectable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/redinger/hashdown
+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: hash-style lookups and option lists
+test_files: 
+- spec/finder_spec.rb
+- spec/selectable_spec.rb
+- spec/spec_helper.rb