act_as_importable 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Colin Harris
+
+MIT License
+
+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.md

@@ -0,0 +1,39 @@
+# ActAsImportable
+
+Help you easily import models from a CSV file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'act_as_importable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install act_as_importable
+
+## Usage
+
+```ruby
+class User < ActiveRecord::Base
+  act_as_importable
+end
+```
+
+## Test
+
+```shell
+rake
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task :default => :spec

data/act_as_importable.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'act_as_importable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "act_as_importable"
+  gem.version       = ActAsImportable::VERSION
+  gem.authors       = ["Colin Harris"]
+  gem.email         = ["col.w.harris@gmail.com"]
+  gem.description   = %q{Helps import models from CSV files.}
+  gem.summary       = %q{Helps import models from CSV files.}
+  gem.homepage      = "https://github.com/Col/act_as_importable"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activesupport', '~> 3.2.11'
+  gem.add_dependency 'activerecord', '~> 3.2.11'
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sqlite3"
+end

data/lib/act_as_importable.rb

@@ -0,0 +1,10 @@
+require 'act_as_importable/base'
+require 'act_as_importable/config'
+require 'csv'
+
+module ActAsImportable
+  include ActAsImportable::Base
+end
+
+require 'act_as_importable/railtie.rb' if defined?(Rails)
+ActiveRecord::Base.send :include, ActAsImportable::Config

data/lib/act_as_importable/base.rb

@@ -0,0 +1,95 @@
+require 'active_support'
+
+module ActAsImportable::Base
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    ##
+    # Imports a data file into a model
+    # Existing records are found by the :uid.
+    # This can be changed by providing the :unique_identifier option or overriding the default_unique_identifier class method.
+    def import_file(file, options = {})
+      import_text(File.read(file), options)
+    end
+
+    ##
+    # Imports csv text into a model
+    def import_text(text, options = {})
+      csv = ::CSV.parse(text, :headers => true)
+      csv.each do |row|
+        row = row.to_hash.with_indifferent_access
+        import_record(row, options)
+      end
+    end
+
+    def import_record(row, options = {})
+      row = filter_columns(row, options)
+      record = find_existing_record(row, options)
+      remove_unique_identifiers(row, options) if record
+      record ||= self.new()
+      update_associations(record, row)
+      record.update_attributes(row)
+      record.save!
+    end
+
+    def filter_columns(row, options = {})
+      row = row.reject { |key, value| Array(options[:except]).include? key } if options[:except]
+      row = row.select { |key, value| Array(options[:only]).include? key } if options[:only]
+      row
+    end
+
+    def remove_unique_identifiers(row, options = {})
+      Array(options[:unique_identifier]).each do |field|
+        row.delete(field)
+      end
+    end
+
+    ##
+    # Updates any associations specified in the import data.
+    # Associations are specified in the header by separating the association and the field by a '.'
+    def update_associations(existing, row)
+      row.each_key do |key|
+        key = key.to_s
+        if key.include?('.')
+          association_name = key.split('.').first
+          field = key.split('.').last
+          association = self.reflect_on_association(association_name.to_sym)
+          association_value = association.klass.where("#{field} = ?", row[key]).first
+          existing.send("#{association_name}=", association_value) if association_value
+          row.delete(key)
+        end
+      end
+    end
+
+    ##
+    # Fetches the existing record based on the identifier field(s) specified by the :unique_identifier option.
+    # Defaults to the field specified by 'default_unique_identifier'
+    def find_existing_record(row, options = {})
+      return unless options[:unique_identifier]
+      fields = Array(options[:unique_identifier])
+      fields.inject(self.scoped.readonly(false)) { |scope, field|
+        add_scope_for_field(scope, field.to_s, row)
+      }.first
+    end
+
+    ##
+    # Refines an existing scope to include a new field
+    # The field can traverse 'belongs_to' associations by joining the association and field with a '.'
+    # The query value should be found within the hash with the field as the key.
+    # Notes: currently only supports field paths through one association.
+    def add_scope_for_field(scope, field, hash)
+      value = hash[field]
+      return scope unless value
+      if field.include?('.')
+        association = field.split('.').first
+        field_name = field.split('.').last
+        scope.joins(association.to_sym).where("#{association.pluralize}.#{field_name} = ?", value)
+      else
+        scope.where("#{field} = ?", value)
+      end
+    end
+
+  end
+
+end

data/lib/act_as_importable/config.rb

@@ -0,0 +1,11 @@
+require 'active_support'
+
+module ActAsImportable::Config
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def act_as_importable
+      include ActAsImportable::Base
+    end
+  end
+end

data/lib/act_as_importable/version.rb

@@ -0,0 +1,3 @@
+module ActAsImportable
+  VERSION = "0.0.1"
+end

data/spec/act_as_importable/act_as_importable_spec.rb

@@ -0,0 +1,115 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+# create the tables for the tests
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'categories'")
+ActiveRecord::Base.connection.create_table(:categories) do |t|
+  t.string :name
+end
+
+class Category < ActiveRecord::Base
+  has_many :items
+end
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'items'")
+ActiveRecord::Base.connection.create_table(:items) do |t|
+  t.integer :category_id
+  t.string :name
+  t.float :price
+end
+
+class Item < ActiveRecord::Base
+  act_as_importable
+
+  belongs_to :category
+end
+
+describe "an act_as_importable model" do
+
+  before(:each) do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.begin_db_transaction
+  end
+
+  after(:each) do
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+
+  subject { Item }
+
+  it { should respond_to :import_file }
+  it { should respond_to :import_text }
+  it { should respond_to :import_record }
+
+  describe "import csv file" do
+    let(:file) { 'spec/fixtures/items.csv' }
+    it 'should call import_text with context of file' do
+      Item.should_receive(:import_text).with(File.read(file), {})
+      Item.import_file(file)
+    end
+  end
+
+  describe "import csv text" do
+    let(:text) { "name,price\nBeer,2.5\nApple,0.5" }
+    it 'should call import_record with row hashes' do
+      Item.should_receive(:import_record).with({'name' => 'Beer', 'price' => '2.5'}, {}).once
+      Item.should_receive(:import_record).with({'name' => 'Apple', 'price' => '0.5'}, {}).once
+      Item.import_text(text)
+    end
+  end
+
+  describe "import record" do
+    let(:row) { {:name => 'Beer', :price => 2.5} }
+
+    it 'should import an item' do
+      expect { Item.import_record(row) }.to change{Item.count}.by(1)
+    end
+
+    describe "unique identifier" do
+      before :each do
+        @existing_item = Item.create!(:name => 'Beer', :price => 1.0)
+      end
+      it "should update an existing record with matching unique identifier" do
+        Item.import_record(row, :unique_identifier => 'name')
+        @existing_item.reload.price.should == 2.5
+      end
+      it "should not create a new item" do
+        expect { Item.import_record(row, :unique_identifier => 'name') }.to change { Item.count }.by(0)
+      end
+    end
+  end
+
+  describe "import record with association" do
+    let(:row) { {:name => 'Beer', :price => 2.5, 'category.name' => 'Beverage'} }
+    before :each do
+      @category = Category.create!(:name => 'Beverage')
+    end
+    it "should import item with a category" do
+      Item.import_record(row)
+      Item.first.category.should == @category
+    end
+  end
+
+  describe "#filter_columns" do
+    let(:row) { {:name => 'Beer', :price => 2.5} }
+
+    it 'should filter columns when importing each record' do
+      Item.should_receive(:filter_columns).with(row, {}).and_return(row)
+      Item.import_record(row)
+    end
+
+    it "should not modify row if no options provided" do
+      Item.filter_columns(row).should == {:name => 'Beer', :price => 2.5}
+    end
+
+    it "should remove columns specified by the :except option" do
+      Item.filter_columns(row, :except => :price).should == {:name => 'Beer'}
+    end
+
+    it "should remove columns not specified by the :only option" do
+      Item.filter_columns(row, :only => :price).should == {:price => 2.5}
+    end
+  end
+
+end
+

data/spec/fixtures/items.csv

@@ -0,0 +1,3 @@
+name,price,category.name
+Apple,0.5,Food
+Beer,2.5,Beverage

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup(:default, :development)
+
+require 'active_record'
+require 'active_support'
+require 'act_as_importable'
+require 'rspec'
+
+root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+ActiveRecord::Base.establish_connection(
+    :adapter => "sqlite3",
+    :database => "#{root}/db/act_as_importable.db"
+)
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: act_as_importable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Colin Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helps import models from CSV files.
+email:
+- col.w.harris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- act_as_importable.gemspec
+- lib/act_as_importable.rb
+- lib/act_as_importable/base.rb
+- lib/act_as_importable/config.rb
+- lib/act_as_importable/version.rb
+- spec/act_as_importable/act_as_importable_spec.rb
+- spec/fixtures/items.csv
+- spec/spec_helper.rb
+homepage: https://github.com/Col/act_as_importable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Helps import models from CSV files.
+test_files:
+- spec/act_as_importable/act_as_importable_spec.rb
+- spec/fixtures/items.csv
+- spec/spec_helper.rb