seamusabshere-csv_dictionary 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Seamus Abshere
+
+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.rdoc

@@ -0,0 +1,7 @@
+= csv_dictionary
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Seamus Abshere. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "csv_dictionary"
+    gem.summary = %Q{TODO}
+    gem.email = "seamus@abshere.net"
+    gem.homepage = "http://github.com/seamusabshere/csv_dictionary"
+    gem.authors = ["Seamus Abshere"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "csv_dictionary #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/csv_dictionary.rb

@@ -0,0 +1,236 @@
+require 'rubygems'
+require 'fastercsv'
+require 'open-uri'
+require 'active_support'
+
+class CsvDictionary
+  attr_accessor :url, :key_sprintf, :key_name, :sheet # set in options
+  attr_accessor :dictionary, :value_name
+
+  def replace_attributes!(attributes)
+    load_dictionary unless dictionary_loaded?
+    attributes[value_name] = lookup(attributes[key_name])
+    attributes.delete(key_name)
+  end
+
+  def lookup(key)
+    load_dictionary unless dictionary_loaded?
+    dictionary[interpret_key(key)]
+  rescue
+    nil
+  end
+
+  private
+
+  def initialize(key_name, options = {})
+    @key_name = key_name
+    @sheet = options[:sheet] ? options[:sheet] - 1 : nil
+    @key_sprintf = options[:key_sprintf] || '%s'
+    @url = options[:url]
+    validate
+  end
+
+  def validate
+    raise 'Please specify a key name.' if key_name.blank?
+    raise 'Please specify a url.' if url.blank?
+    raise ':sheet option is only supported for Google Docs Spreadsheet URLs.' if not sheet.nil? and not google_docs_spreadsheet_url?(url)
+    if google_docs_spreadsheet_url?(url) and /\&gid=(.*)(\&|$)/.match(url)
+      raise "Your Google Docs Spreadsheet URL includes a sheet number (&gid=#{$1}). Please remove it and set the sheet with :sheet => #{$1.to_i + 1}"
+    end
+  end
+    
+  def google_docs_spreadsheet_url?(url)
+    url.include?('spreadsheets.google.com')
+  end
+
+  def dictionary_loaded?
+    !dictionary.nil?
+  end
+
+  def load_dictionary
+    self.dictionary = {}
+    open(interpret_url(url)) do |data|
+      FasterCSV.parse(data, :headers => :first_row) do |row|
+        self.value_name ||= row.headers[1].to_sym
+        next if row.fields[0..1].any? { |c| c.blank? }
+        key = interpret_key(row.fields[0])
+        value = row.fields[1].to_s.strip
+        dictionary[key] = value
+      end
+    end
+  end
+
+  def interpret_url(url)
+    if google_docs_spreadsheet_url?(url)
+      url = url.gsub(/\&output=.*(\&|$)/, '')
+      url << "&output=csv&gid=#{sheet}"
+    end
+    url
+  end
+
+  def interpret_key(k)
+    k = k.to_s.strip
+    k = k.to_i if /\%[0-9\.]*d/.match(key_sprintf)
+    key_sprintf % k
+  end
+end
+
+module ActiveRecord
+  module CsvDictionaryExt
+    def self.included(klass)
+      klass.class_eval do
+        self.class_inheritable_accessor :csv_dictionaries
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def csv_dictionary(key_name, options = {})
+        class_eval { @old_method_missing = instance_method(:method_missing) }
+        self.csv_dictionaries ||= {}
+        csv_dictionaries[key_name] = CsvDictionary.new(key_name, options)
+        extend InstanceMethods
+      end
+
+      def clear_csv_dictionaries
+        self.csv_dictionaries = {}
+      end
+
+      def replace_csv_dictionary_attributes!(attributes)
+        csv_dictionaries.values.each { |d| d.replace_attributes!(attributes) }
+      end
+    end
+
+    module InstanceMethods
+      def all_attributes_or_csv_dictionary_attributes_exists?(attribute_names)
+        attribute_names = expand_attribute_names_for_aggregates(attribute_names)
+        attribute_names.all? { |name| column_methods_hash.include?(name.to_sym) or csv_dictionaries.has_key?(name.to_sym) }
+      end
+      
+      # like Rails 2.3.2
+      # copied from http://github.com/rails/rails/raw/dd2eb1ea7c34eb6496feaf7e42100f37a8dae76b/activerecord/lib/active_record/base.rb
+      def method_missing_with_csv_dictionary_attributes(method_id, *arguments, &block)
+        if match = DynamicFinderMatch.match(method_id)
+          attribute_names = match.attribute_names
+          return method_missing_without_csv_dictionary_attributes(method_id, arguments, block) unless all_attributes_or_csv_dictionary_attributes_exists?(attribute_names)
+          if match.finder?
+            finder = match.finder
+            bang = match.bang?
+            # def self.find_by_login_and_activated(*args)
+            #   options = args.extract_options!
+            #   attributes = construct_attributes_from_arguments(
+            #     [:login,:activated],
+            #     args
+            #   )
+            # 
+            #   replace_csv_dictionary_attributes!(attributes) # ADDED BY SEAMUS
+            # 
+            #   finder_options = { :conditions => attributes }
+            #   validate_find_options(options)
+            #   set_readonly_option!(options)
+            #
+            #   if options[:conditions]
+            #     with_scope(:find => finder_options) do
+            #       find(:first, options)
+            #     end
+            #   else
+            #     find(:first, options.merge(finder_options))
+            #   end
+            # end
+            self.class_eval %{
+              def self.#{method_id}(*args)
+                options = args.extract_options!
+                attributes = construct_attributes_from_arguments(
+                [:#{attribute_names.join(',:')}],
+                args
+                )
+            
+                replace_csv_dictionary_attributes!(attributes) 
+              
+                finder_options = { :conditions => attributes }
+                validate_find_options(options)
+                set_readonly_option!(options)
+
+                #{'result = ' if bang}if options[:conditions]
+                  with_scope(:find => finder_options) do
+                    find(:#{finder}, options)
+                  end
+                else
+                  find(:#{finder}, options.merge(finder_options))
+                end
+                #{'result || raise(RecordNotFound, "Couldn\'t find #{name} with #{attributes.to_a.collect {|pair| "#{pair.first} = #{pair.second}"}.join(\', \')}")' if bang}
+              end
+            }, __FILE__, __LINE__
+            send(method_id, *arguments)
+          elsif match.instantiator?
+            instantiator = match.instantiator
+            # def self.find_or_create_by_user_id(*args)
+            #   guard_protected_attributes = false
+            #
+            #   if args[0].is_a?(Hash)
+            #     guard_protected_attributes = true
+            #     attributes = args[0].with_indifferent_access
+            #     find_attributes = attributes.slice(*[:user_id])
+            #   else
+            #     find_attributes = attributes = construct_attributes_from_arguments([:user_id], args)
+            #   end
+            # 
+            #   replace_csv_dictionary_attributes!(attributes) # ADDED BY SEAMUS
+            #   replace_csv_dictionary_attributes!(find_attributes) # ADDED BY SEAMUS
+            #
+            #   options = { :conditions => find_attributes }
+            #   set_readonly_option!(options)
+            #
+            #   record = find(:first, options)
+            #
+            #   if record.nil?
+            #     record = self.new { |r| r.send(:attributes=, attributes, guard_protected_attributes) }
+            #     yield(record) if block_given?
+            #     record.save
+            #     record
+            #   else
+            #     record
+            #   end
+            # end
+            self.class_eval %{
+              def self.#{method_id}(*args)
+                guard_protected_attributes = false
+
+                if args[0].is_a?(Hash)
+                  guard_protected_attributes = true
+                  attributes = args[0].with_indifferent_access
+                  find_attributes = attributes.slice(*[:#{attribute_names.join(',:')}])
+                  replace_csv_dictionary_attributes!(attributes)
+                  replace_csv_dictionary_attributes!(find_attributes)
+                else
+                  find_attributes = attributes = construct_attributes_from_arguments([:#{attribute_names.join(',:')}], args)
+                  replace_csv_dictionary_attributes!(attributes) # only have to do this once, since find_attributes.object_id == attributes.object_id
+                end
+
+                options = { :conditions => find_attributes }
+                set_readonly_option!(options)
+
+                record = find(:first, options)
+
+                if record.nil?
+                  record = self.new { |r| r.send(:attributes=, attributes, guard_protected_attributes) }
+                  #{'yield(record) if block_given?'}
+                  #{'record.save' if instantiator == :create}
+                  record
+                else
+                  record
+                end
+              end
+            }, __FILE__, __LINE__
+            send(method_id, *arguments, &block)
+          end
+        else
+          method_missing_without_csv_dictionary_attributes(method_id, arguments, block)
+        end
+      end
+      alias_method_chain :method_missing, :csv_dictionary_attributes
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::CsvDictionaryExt

data/test/csv_dictionary_ext_test.rb

@@ -0,0 +1,82 @@
+require 'test_helper'
+
+class CsvDictionaryExtTest < Test::Unit::TestCase
+  def setup
+    CsvDictionaryTestHelper.setup_database
+  end
+  
+  def teardown
+    Aircraft.clear_csv_dictionaries
+    CsvDictionaryTestHelper.teardown_database
+  end
+  
+  # sanity check
+  def test_should_have_dictionary_value_name
+    assert_nothing_raised do
+      Aircraft.new.brighter_planet_aircraft_class_code
+    end
+  end
+  
+  # sanity check
+  def test_should_not_have_dictionary_key_name
+    assert_raise NoMethodError do
+      Aircraft.new.bts_aircraft_type
+    end
+  end
+  
+  def test_should_mixin_methods
+    assert Aircraft.respond_to?(:csv_dictionary)
+    assert Aircraft.respond_to?(:clear_csv_dictionaries)
+    assert Aircraft.respond_to?(:replace_csv_dictionary_attributes!)
+  end
+  
+  def test_should_not_affect_other_activerecord_models
+    Aircraft.csv_dictionary :bts_aircraft_type, :url => CSV_URL
+    assert Hash === Aircraft.csv_dictionaries
+    assert NilClass === Scrum.csv_dictionaries
+  end
+  
+  def test_should_configure_csv_dictionary
+    key_name = :bts_aircraft_type
+    options = { :url => GDOCS_URL, :sheet => 1 }
+    CsvDictionary.expects(:new).with(key_name, options)
+    Aircraft.csv_dictionary key_name, options
+  end
+  
+  def test_should_replace_attributes
+    Aircraft.csv_dictionary :bts_aircraft_type, :url => CSV_URL
+    Aircraft.csv_dictionaries[:bts_aircraft_type].expects(:replace_attributes!)
+    Aircraft.replace_csv_dictionary_attributes!({})
+  end
+  
+  def test_should_recognize_dynamic_finders
+    fixture = Aircraft.find_or_create_by_brighter_planet_aircraft_class_code('SJ')
+    Aircraft.csv_dictionary :bts_aircraft_type, :url => CSV_URL
+    Aircraft.csv_dictionaries[:bts_aircraft_type].expects(:lookup).with('103').returns('SJ').times(4)
+    assert_equal fixture, Aircraft.find_by_bts_aircraft_type('103')
+    assert_equal fixture, Aircraft.find_by_bts_aircraft_type_and_brighter_planet_aircraft_class_code('103', 'SJ')
+    assert_equal [fixture], Aircraft.find_all_by_bts_aircraft_type('103')
+    assert_equal [fixture], Aircraft.find_all_by_bts_aircraft_type_and_brighter_planet_aircraft_class_code('103', 'SJ')
+  end
+  
+  def test_should_recognize_dynamic_initializers
+    fixture = Aircraft.find_or_create_by_brighter_planet_aircraft_class_code('SJ')
+    Aircraft.csv_dictionary :bts_aircraft_type, :url => CSV_URL
+    Aircraft.csv_dictionaries[:bts_aircraft_type].expects(:lookup).with('103').returns('SJ').twice
+    assert_equal fixture, Aircraft.find_or_create_by_bts_aircraft_type('103')
+    assert_equal fixture, Aircraft.find_or_create_by_bts_aircraft_type_and_brighter_planet_aircraft_class_code('103', 'SJ')
+  end
+  
+  def test_should_not_recognize_bad_dynamic_finders
+    Aircraft.csv_dictionary :bts_aircraft_type, :url => CSV_URL
+    assert_raise NoMethodError do
+      Aircraft.find_or_create_by_foobar('X')
+    end
+    assert_raise NoMethodError do
+      Aircraft.find_or_create_by_foobar_and_id('X', 'Y')
+    end
+    assert_raise NoMethodError do
+      Aircraft.find_or_create_by_foobar_and_bts_aircraft_type('X', 'Y')
+    end
+  end
+end

data/test/csv_dictionary_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+class CsvDictionaryTest < Test::Unit::TestCase
+  def setup
+    CsvDictionaryTestHelper.setup_database
+    @dictionary = CsvDictionary.new(:bts_aircraft_type, :url => GDOCS_URL, :sheet => 1)
+  end
+
+  def teardown
+    Aircraft.clear_csv_dictionaries
+    CsvDictionaryTestHelper.teardown_database
+  end
+
+  def test_should_set_key_name
+    assert_equal :bts_aircraft_type, @dictionary.key_name
+  end
+
+  def test_should_set_url
+    dictionary = CsvDictionary.new(:bts_aircraft_type, :url => CSV_URL)
+    assert_equal CSV_URL, dictionary.url
+  end
+
+  def test_should_interpret_gdocs_urls
+    assert_equal GDOCS_URL + '&output=csv&gid=0', @dictionary.send(:interpret_url, @dictionary.url)
+  end
+
+  def test_should_raise_if_gdocs_url_includes_gid
+    assert_raise RuntimeError do
+      CsvDictionary.new(:bts_aircraft_type, :url => GDOCS_URL + '&gid=1')
+    end
+  end
+  
+  def test_should_raise_if_sheet_option_set_on_non_gdocs_url
+    assert_raise RuntimeError do
+      CsvDictionary.new(:bts_aircraft_type, :url => CSV_URL, :sheet => 1)
+    end
+  end
+
+  def test_should_set_default_sheet
+    assert_equal 0, @dictionary.sheet
+  end
+    
+  def test_should_replace_attributes
+    attributes = { :bts_aircraft_type => '103' }
+    @dictionary.expects(:lookup).with('103').returns('SJ')
+    @dictionary.replace_attributes!(attributes)
+    assert_equal({ :brighter_planet_aircraft_class_code => 'SJ' }, attributes)
+  end
+  
+  # real http call
+  def test_should_set_value_name_after_dictionary_loaded
+    @dictionary.send(:load_dictionary)
+    assert_equal :brighter_planet_aircraft_class_code, @dictionary.value_name
+  end
+  
+  # real http call
+  def test_should_lookup
+    assert_equal 'SJ', @dictionary.lookup('103')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,71 @@
+module CsvDictionaryTestHelper
+  VENDOR_RAILS = File.expand_path('../../../../rails', __FILE__)
+  OTHER_RAILS = File.expand_path('../../../rails', __FILE__)
+  PLUGIN_ROOT = File.expand_path('../../', __FILE__)
+
+  def self.rails_directory
+    if File.exist?(VENDOR_RAILS)
+      VENDOR_RAILS
+    elsif File.exist?(OTHER_RAILS)
+      OTHER_RAILS
+    end
+  end
+
+  def self.load_dependencies
+    if rails_directory
+      $:.unshift(File.join(rails_directory, 'activesupport', 'lib'))
+      $:.unshift(File.join(rails_directory, 'activerecord', 'lib'))
+    else
+      require 'rubygems' rescue LoadError
+    end
+
+    require 'active_record'
+    require 'test/unit'
+    require 'mocha'
+
+    $LOAD_PATH.unshift(File.dirname(__FILE__))
+    $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+    require 'csv_dictionary'
+  end
+
+  def self.configure_database
+    ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+    ActiveRecord::Migration.verbose = false
+  end
+
+  def self.setup_database
+    ActiveRecord::Schema.define do
+      create_table :aircraft do |t|
+        t.string :brighter_planet_aircraft_class_code
+        t.timestamps
+      end
+      create_table :scrums do |t|
+        t.string :name
+        t.timestamps
+      end
+    end
+  end
+
+  def self.teardown_database
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  def self.start
+    load_dependencies
+    configure_database
+  end
+end
+
+CsvDictionaryTestHelper.start
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.uncountable('aircraft')
+end
+
+class Aircraft < ActiveRecord::Base; end
+class Scrum < ActiveRecord::Base; end
+
+GDOCS_URL = 'http://spreadsheets.google.com/pub?key=p70r3FHguhimD8YmyA34RdA'
+CSV_URL = 'http://static.brighterplanet.com/science/data/transport/air/bts_aircraft_types-brighter_planet_aircraft_classes.csv'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: seamusabshere-csv_dictionary
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: seamus@abshere.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/csv_dictionary.rb
+- test/csv_dictionary_ext_test.rb
+- test/csv_dictionary_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/seamusabshere/csv_dictionary
+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.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/csv_dictionary_ext_test.rb
+- test/csv_dictionary_test.rb
+- test/test_helper.rb