seamusabshere-csv_bootstrap 0.1.0 → 0.1.1

data/README.rdoc

@@ -13,7 +13,7 @@ You can specify other sheets (starts at 1):
 
   class FuelType
     csv_bootstrap :url => 'http://spreadsheets.google.com/pub?key=p70r3FHguhimIdBKyVz3iPA',
-                    :sheet => 1
+                  :sheet => 1
   end
 
 The gem will always request the CSV-formatted version of the document in question.
@@ -32,13 +32,13 @@ All of the other columns will be included as attributes, based on the column hea
 would generate
 
   a = FuelType.find_or_create_by_name('coal')
-  a.update_attributes(:name => 'coal', :emission_factor => '5246.89', :units => 'lbs/short ton')
+  a.update_attributes(:emission_factor => '5246.89', :units => 'lbs/short ton')
 
   a = FuelType.find_or_create_by_name('natural gas')
-  a.update_attributes(:name => 'coal', :emission_factor => '1.25', :units => 'pounds / therm (nat gas)')
+  a.update_attributes(:emission_factor => '1.25', :units => 'pounds / therm (nat gas)')
 
   a = FuelType.find_or_create_by_name('fuel oil')
-  a.update_attributes(:name => 'coal', :emission_factor => '22.51', :units => 'lbs/gallon')
+  a.update_attributes(:emission_factor => '22.51', :units => 'lbs/gallon')
 
 == Copyright
 

data/VERSION.yml

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

data/lib/csv_bootstrap.rb

@@ -4,25 +4,39 @@ require 'open-uri'
 require 'active_support'
 
 class CsvBootstrap
-  attr_accessor :url, :target_class_name, :key_sprintf, :sheet # set in options
+  attr_accessor :url, :klass_name, :key_sprintf, :sheet # set in options
   attr_accessor :key_name, :headers, :dictionary, :width
   
   def bootstrap!
     load_dictionary unless dictionary_loaded?
     dictionary.each do |k, v|
-      instance_of_target_class = target_class.send("find_or_create_by_#{key_name}", v[key_name])
-      instance_of_target_class.update_attributes(v.except(key_name))
+      instance_of_klass = klass_name.constantize.send("find_or_create_by_#{key_name}", v[key_name])
+      instance_of_klass.update_attributes(v.except(key_name))
     end
     true
   end
   
   private
   
-  def initialize(options = {})
-    @sheet = interpret_sheet(options[:sheet])
-    @url = interpret_url(options[:url])
-    @target_class_name = options[:target_class_name]
+  def initialize(klass_name, options = {})
+    @klass_name = klass_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 class name.' if klass_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?
@@ -31,7 +45,7 @@ class CsvBootstrap
   
   def load_dictionary
     self.dictionary = {}
-    open(url) do |data|
+    open(interpret_url(url)) do |data|
       FasterCSV.parse(data, :headers => :first_row) do |row|
         self.width ||= row.fields.size
         self.key_name ||= row.headers[0].to_sym
@@ -43,15 +57,8 @@ class CsvBootstrap
     end
   end
   
-  def interpret_sheet(sheet)
-    sheet.to_i >= 1 ? sheet.to_i - 1 : 0
-  end
-  
   def interpret_url(url)
-    if url.include?('spreadsheets.google.com')
-      if /\&gid=(.*)(\&|$)/.match(url)
-        raise "Your Google Docs URL includes a sheet number (&gid=#{$1}). Please remove it and set the sheet with :sheet => #{$1.to_i + 1}"
-      end
+    if google_docs_spreadsheet_url?(url)
       url = url.gsub(/\&output=.*(\&|$)/, '')
       url << "&output=csv&gid=#{sheet}"
     end
@@ -73,9 +80,6 @@ class CsvBootstrap
     memo
   end
   
-  def target_class
-    target_class_name.constantize
-  end
 end
 
 module ActiveRecord
@@ -90,15 +94,15 @@ module ActiveRecord
     module ClassMethods
       def csv_bootstrap(options = {})
         self.csv_bootstraps ||= []
-        options[:target_class_name] ||= self.class_name
-        csv_bootstraps << CsvBootstrap.new(options)
+        klass_name = options.delete(:klass_name) || self.class_name
+        csv_bootstraps << CsvBootstrap.new(klass_name, options)
       end
       
-      def clear_bootstraps
+      def clear_csv_bootstraps
         self.csv_bootstraps = []
       end
       
-      def bootstrap!
+      def csv_bootstrap!
         csv_bootstraps.each { |b| b.bootstrap! }
       end
     end

data/test/csv_bootstrap_ext_test.rb

@@ -6,25 +6,25 @@ class CsvBootstrapExtTest < Test::Unit::TestCase
   end
   
   def teardown
-    Scrum.clear_bootstraps
+    Scrum.clear_csv_bootstraps
     CsvBootstrapTestHelper.teardown_database
   end
 
   def test_should_mixin_methods
     assert Scrum.respond_to?(:csv_bootstrap)
-    assert Scrum.respond_to?(:clear_bootstraps)
-    assert Scrum.respond_to?(:bootstrap!)
+    assert Scrum.respond_to?(:clear_csv_bootstraps)
+    assert Scrum.respond_to?(:csv_bootstrap!)
   end
 
-  def test_should_set_options
-    options = { :target_class_name => 'Scrum', :url => CSV_URL, :sheet => 1 }
-    CsvBootstrap.expects(:new).with(options)
+  def test_should_configure_bootstrap
+    options = { :url => CSV_URL, :sheet => 1 }
+    CsvBootstrap.expects(:new).with('Scrum', options)
     Scrum.csv_bootstrap options
   end
   
   def test_should_bootstrap
     Scrum.csv_bootstrap :url => CSV_URL
-    CsvBootstrap.any_instance.expects(:bootstrap!)
-    Scrum.bootstrap!
+    Scrum.csv_bootstraps.first.expects(:bootstrap!)
+    Scrum.csv_bootstrap!
   end
 end

data/test/csv_bootstrap_test.rb

@@ -3,34 +3,39 @@ require 'test_helper'
 class CsvBootstrapTest < Test::Unit::TestCase
   def setup
     CsvBootstrapTestHelper.setup_database
-    @bootstrap = CsvBootstrap.new(:target_class_name => 'Scrum', :url => GDOCS_URL, :sheet => 1)
+    @bootstrap = CsvBootstrap.new('Scrum', :url => GDOCS_URL, :sheet => 1)
   end
   
   def teardown
-    Scrum.clear_bootstraps
+    Scrum.clear_csv_bootstraps
     CsvBootstrapTestHelper.teardown_database
   end
   
-  def test_should_have_target_class_name
-    assert_equal @bootstrap.target_class_name, 'Scrum'
-  end
-  
-  def test_should_have_zero_based_sheet
-    assert_equal @bootstrap.sheet, 0
+  def test_should_set_klass_name
+    assert_equal 'Scrum', @bootstrap.klass_name
   end
   
   def test_should_set_url
-    bootstrap = CsvBootstrap.new(:target_class_name => 'Scrum', :url => CSV_URL)
-    assert_equal bootstrap.url, CSV_URL
+    assert_equal GDOCS_URL, @bootstrap.url
+  end
+
+  def test_should_set_zero_based_sheet
+    assert_equal 0, @bootstrap.sheet
   end
   
-  def test_should_set_and_modify_gdocs_url
-    assert_equal @bootstrap.url, GDOCS_URL + '&output=csv&gid=0'
+  def test_should_interpret_gdocs_urls
+    assert_equal GDOCS_URL + '&output=csv&gid=0', @bootstrap.send(:interpret_url, @bootstrap.url)
   end
   
   def test_should_raise_if_gdocs_url_includes_gid
     assert_raise RuntimeError do
-      CsvBootstrap.new(:target_class_name => 'Scrum', :url => GDOCS_URL + '&gid=1')
+      CsvBootstrap.new('Scrum', :url => GDOCS_URL + '&gid=1')
+    end
+  end
+
+  def test_should_raise_if_sheet_option_set_on_non_gdocs_url
+    assert_raise RuntimeError do
+      CsvBootstrap.new('Scrum', :url => CSV_URL, :sheet => 1)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: seamusabshere-csv_bootstrap
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Seamus Abshere