seamusabshere-csv_bootstrap 0.1.0

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,45 @@
+= csv_bootstrap
+
+  class FuelType
+    csv_bootstrap :url => 'http://spreadsheets.google.com/pub?key=p70r3FHguhimIdBKyVz3iPA'
+  end
+
+This will bootstrap your ActiveRecord model with sheet 1 of the Google Docs spreadsheet.
+
+  >> FuelType.bootstrap!
+  => true
+
+You can specify other sheets (starts at 1):
+
+  class FuelType
+    csv_bootstrap :url => 'http://spreadsheets.google.com/pub?key=p70r3FHguhimIdBKyVz3iPA',
+                    :sheet => 1
+  end
+
+The gem will always request the CSV-formatted version of the document in question.
+
+== Spreadsheet structure
+
+The first column is always the key.
+
+All of the other columns will be included as attributes, based on the column headers.
+
+  name          emission_factor   units
+  coal          5246.89           lbs/short ton
+  natural gas   1.25              pounds / therm (nat gas)
+  fuel oil      22.51             lbs/gallon
+
+would generate
+
+  a = FuelType.find_or_create_by_name('coal')
+  a.update_attributes(:name => 'coal', :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 = FuelType.find_or_create_by_name('fuel oil')
+  a.update_attributes(:name => 'coal', :emission_factor => '22.51', :units => 'lbs/gallon')
+
+== 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_bootstrap"
+    gem.summary = %Q{TODO}
+    gem.email = "seamus@abshere.net"
+    gem.homepage = "http://github.com/seamusabshere/csv_bootstrap"
+    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_bootstrap #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

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

data/lib/csv_bootstrap.rb

@@ -0,0 +1,108 @@
+require 'rubygems'
+require 'fastercsv'
+require 'open-uri'
+require 'active_support'
+
+class CsvBootstrap
+  attr_accessor :url, :target_class_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))
+    end
+    true
+  end
+  
+  private
+  
+  def initialize(options = {})
+    @sheet = interpret_sheet(options[:sheet])
+    @url = interpret_url(options[:url])
+    @target_class_name = options[:target_class_name]
+    @key_sprintf = options[:key_sprintf] || '%s'
+  end
+
+  def dictionary_loaded?
+    !dictionary.nil?
+  end
+  
+  def load_dictionary
+    self.dictionary = {}
+    open(url) do |data|
+      FasterCSV.parse(data, :headers => :first_row) do |row|
+        self.width ||= row.fields.size
+        self.key_name ||= row.headers[0].to_sym
+        self.headers ||= row.headers
+        next if row.fields[0].blank?
+        key = interpret_key(row.fields[0])
+        dictionary[key] = interpret_columns(row.fields[0..width])
+      end
+    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
+      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
+  
+  def interpret_columns(columns)
+    memo = {}
+    columns.each_with_index do |column, index|
+      # puts "memo.merge!(headers[#{index}].to_sym => column) as memo.merge!(#{headers[index].to_sym} => #{column})"
+      memo.merge!(headers[index].to_sym => column)
+    end
+    memo
+  end
+  
+  def target_class
+    target_class_name.constantize
+  end
+end
+
+module ActiveRecord
+  module CsvBootstrapExt
+    def self.included(klass)
+      klass.class_eval do
+        self.class_inheritable_accessor :csv_bootstraps
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def csv_bootstrap(options = {})
+        self.csv_bootstraps ||= []
+        options[:target_class_name] ||= self.class_name
+        csv_bootstraps << CsvBootstrap.new(options)
+      end
+      
+      def clear_bootstraps
+        self.csv_bootstraps = []
+      end
+      
+      def bootstrap!
+        csv_bootstraps.each { |b| b.bootstrap! }
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::CsvBootstrapExt

data/test/csv_bootstrap_ext_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class CsvBootstrapExtTest < Test::Unit::TestCase
+  def setup
+    CsvBootstrapTestHelper.setup_database
+  end
+  
+  def teardown
+    Scrum.clear_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!)
+  end
+
+  def test_should_set_options
+    options = { :target_class_name => 'Scrum', :url => CSV_URL, :sheet => 1 }
+    CsvBootstrap.expects(:new).with(options)
+    Scrum.csv_bootstrap options
+  end
+  
+  def test_should_bootstrap
+    Scrum.csv_bootstrap :url => CSV_URL
+    CsvBootstrap.any_instance.expects(:bootstrap!)
+    Scrum.bootstrap!
+  end
+end

data/test/csv_bootstrap_test.rb

@@ -0,0 +1,46 @@
+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)
+  end
+  
+  def teardown
+    Scrum.clear_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
+  end
+  
+  def test_should_set_url
+    bootstrap = CsvBootstrap.new(:target_class_name => 'Scrum', :url => CSV_URL)
+    assert_equal bootstrap.url, CSV_URL
+  end
+  
+  def test_should_set_and_modify_gdocs_url
+    assert_equal @bootstrap.url, GDOCS_URL + '&output=csv&gid=0'
+  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')
+    end
+  end
+
+  def test_should_bootstrap_keys
+    Scrum.expects(:find_or_create_by_name).at_least_once.returns(Scrum.new)
+    @bootstrap.bootstrap!
+  end
+  
+  def test_should_bootstrap_values
+    Scrum.any_instance.expects(:update_attributes).at_least_once
+    @bootstrap.bootstrap!
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,64 @@
+module CsvBootstrapTestHelper
+  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_bootstrap'
+  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 :scrums do |t|
+        t.string :name
+        t.string :emission_factor
+        t.string :units
+        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
+
+CsvBootstrapTestHelper.start
+
+class Scrum < ActiveRecord::Base; end
+
+GDOCS_URL = 'http://spreadsheets.google.com/pub?key=p70r3FHguhimIdBKyVz3iPA'
+CSV_URL = 'http://static.brighterplanet.com/science/data/transport/air/iata_codes-bts_aircraft_types.csv'

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: seamusabshere-csv_bootstrap
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+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
+- VERSION.yml
+- lib/csv_bootstrap.rb
+- test/csv_bootstrap_ext_test.rb
+- test/csv_bootstrap_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/seamusabshere/csv_bootstrap
+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_bootstrap_ext_test.rb
+- test/csv_bootstrap_test.rb
+- test/test_helper.rb