csv_model 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2c3dcb21cddf9d14f4d44336770c35d737c4165
-  data.tar.gz: 96510b317ed2ec88d19ad86a51ee15c1b1c5c8ce
+  metadata.gz: e5c7053ec54a07cf27b8e903276c04a728c01511
+  data.tar.gz: fbc25ab237e583a936f6e0e4619c078b966631a8
 SHA512:
-  metadata.gz: 565a7e1407cdcbbedcea280b6cf1cc63e050954275fd87b9c45e6b4073b69463aefc49baa77df3809f134259a69164ca6c95415e877fd8c40e4ed6e1e89a3de9
-  data.tar.gz: 90f26d172765c9b1e28f49cd85045f753c896b41d6ca77fc4fe47e9b9bbe5aa5ba5f0e41cd4225c778eec950eb6df5e4f11af60f1e66fc088e39fd930d82c970
+  metadata.gz: 318238c605891112715aa69677b15f4bcfc6d35c8fcfa3376a1aeccd4e4da2b96059a87df834d167e741b5247998475850c7cfa7caed135b99f976854b5b3130
+  data.tar.gz: 34cddace105c379953649d4a477962d486b2d512558302437189d88335e37490959450fbe7454f5d34b41e41fac944d56bafb561ec21e8f5a83d581b5e9a05fa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    csv_model (0.2.1)
+    csv_model (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,17 +1,71 @@
-csv_model
+CSV Model
 =========
 
 [![Build Status](https://travis-ci.org/Scrimmage/csv_model.svg)](https://travis-ci.org/Scrimmage/csv_model)
 
 [![Code Climate](https://codeclimate.com/github/Scrimmage/csv_model.png)](https://codeclimate.com/github/Scrimmage/csv_model)
 
-TODO: ability to have multiple alternate primary keys
+CSV Model is a bulk import library for ActiveRecord. It parses a CSV into memory, validates the structure, can check for duplicates, and creates or updates the relevant record for each row.
 
-active_record?
 
+Requirements
+------------
 
-gem build csv_model.gemspec
-gem push csv_model-0.2.1.gem
+### Ruby
+
+CSV Model requires Ruby version **>= 2.0.0**
+
+
+Installation
+------------
+
+CSVModel is distributed as a gem, which is how it should be used in your app.
+
+Include the gem in your Gemfile:
+
+```ruby
+gem "csv_model", "~> 1.0"
+```
+
+Or, if you want to get the latest, you can get master from the main repository:
+
+```ruby
+gem "csv_model", :git => "git://github.com/Scrimmage/csv_model.git"
+```
 
-gem install csv_model-0.2.1.gem
-gem uninstall csv_model -v 0.2.0
+
+Example Usage
+-----------
+
+```ruby
+options = {
+  dry_run: is_dry_run?,
+  legal_columns: structure.legal_columns,
+  primary_key: structure.primary_key_columns,
+  required_columns: structure.required_columns,
+  row_model_finder: model_finder,
+  row_model_mapper: model_mapper,
+}
+
+cm = CSVModel::Model.new(data, options)
+
+if cm.structure_valid?
+  puts "Found structural errors: #{csv.structure_errors.inspect}"
+else
+  cm.rows.each do |row|
+    status = row.process_row
+    puts "Found row #{row.key} with status #{status} and errors #{row.errors.inspect}"
+  end
+end
+```
+
+
+Internal Notes
+--------------
+
+Deployment:
+
+```bash
+gem build csv_model.gemspec
+gem push csv_model-x.y.z.gem
+```

data/lib/csv_model/model.rb

@@ -41,8 +41,8 @@ module CSVModel
       header_class.new(row, options)
     end
 
-    def create_row(row)
-      row = row_class.new(header, row, options)
+    def create_row(row, index)
+      row = row_class.new(header, row, index, options)
       row.mark_as_duplicate if is_duplicate_key?(row.key)
       row
     end
@@ -80,7 +80,7 @@ module CSVModel
           # end
 
           if index > 0 
-            @rows << create_row(row)
+            @rows << create_row(row, index)
           end
         end
       rescue CSV::MalformedCSVError => e

data/lib/csv_model/row.rb

@@ -4,14 +4,17 @@ module CSVModel
   class Row
     include Utilities::Options
 
-    attr_reader :data, :header, :marked_as_duplicate
+    attr_reader :data, :header, :model_index, :marked_as_duplicate
 
-    def initialize(header, data, options = {})
+    def initialize(header, data, model_index, options = {})
       @header = header
       @data = data
+      @model_index = model_index
       @options = options
     end
 
+    alias_method :csv_index, :model_index
+
     def index(value)
       index = column_index(value) || value
       data[index] if index.is_a?(Fixnum) && index >= 0
@@ -36,6 +39,14 @@ module CSVModel
       end
     end
 
+    def map_all_attributes(attrs)
+      attrs
+    end
+
+    def map_key_attributes(attrs)
+      attrs
+    end
+
     def marked_as_duplicate?
       !!marked_as_duplicate
     end
@@ -44,6 +55,16 @@ module CSVModel
       @marked_as_duplicate = true
     end
 
+    def process_row
+      return model_instance.status if @processed
+      @processed = true
+
+      model_instance.assign_attributes(all_attributes)
+      model_instance.mark_as_duplicate if marked_as_duplicate?
+      model_instance.save(dry_run: is_dry_run?)
+      model_instance.status
+    end
+
     def status
       model_instance.status
     end
@@ -63,7 +84,7 @@ module CSVModel
     private
 
     def all_attributes
-      @all_attributes ||= column_attributes_with_values(columns)
+      @all_attributes ||= model_mapper.map_all_attributes(column_attributes_with_values(columns))
     end
 
     def columns
@@ -87,41 +108,39 @@ module CSVModel
       option(:dry_run, false)
     end
 
-    def model
-      option(:model)
+    def model_adaptor
+      CSVModel::RowActiveRecordAdaptor
+    end
+
+    def model_finder
+      option(:row_model_finder)
     end
 
     def model_instance
       @model_instance ||= begin
         x = inherit_or_delegate(:find_row_model, key_attributes) 
         x ||= inherit_or_delegate(:new_row_model, key_attributes)
-        x = CSVModel::ObjectWithStatusSnapshot.new(x)
+        x = model_adaptor.new(x)
       end
     end
 
+    def model_mapper
+      option(:row_model_mapper, self)
+    end
+
     def key_attributes
       cols = primary_key_columns.any? ? primary_key_columns : columns
-      @key_attributes ||= column_attributes_with_values(cols)
+      @key_attributes ||= model_mapper.map_key_attributes(column_attributes_with_values(cols))
     end
 
-
     def primary_key_columns
       header.primary_key_columns
     end
 
-    def process_row
-      return if @processed
-      @processed = true
-
-      model_instance.assign_attributes(all_attributes)
-      model_instance.mark_as_duplicate if marked_as_duplicate?
-      model_instance.save(dry_run: is_dry_run?)
-    end
-
     private
 
     def inherit_or_delegate(method, *args)
-      try(method, *args) || model.try(method, *args)
+      try(method, *args) || model_finder.try(method, *args)
     end
 
   end

data/lib/csv_model/{object_with_status_snapshot.rb → row_active_record_adaptor.rb}

@@ -1,7 +1,7 @@
 using CSVModel::Extensions
 
 module CSVModel
-  class ObjectWithStatusSnapshot < SimpleDelegator
+  class RowActiveRecordAdaptor < SimpleDelegator
     include RecordStatus
 
     def assign_attributes(attributes)

data/lib/csv_model/version.rb

@@ -1,3 +1,3 @@
 module CSVModel
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

data/lib/csv_model.rb

@@ -7,10 +7,10 @@ require 'csv_model/record_status'
 require 'csv_model/utilities'
 
 require 'csv_model/column'
-require 'csv_model/row'
 require 'csv_model/header_row'
 require 'csv_model/model'
-require 'csv_model/object_with_status_snapshot'
+require 'csv_model/row'
+require 'csv_model/row_active_record_adaptor'
 require 'csv_model/version'
 
 module CSVModel

data/spec/csv_model/{object_with_status_snapshot_spec.rb → row_active_record_adaptor_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe CSVModel::ObjectWithStatusSnapshot do
+describe CSVModel::RowActiveRecordAdaptor do
   let(:model) { double("model", changed?: false, marked_for_destruction?: false, new_record?: false, valid?: false) }
   let(:subject) { described_class.new(model) }
 

data/spec/csv_model/row_spec.rb

@@ -5,10 +5,11 @@ describe CSVModel::Row do
   let(:header) { double("header") }
   let(:column) { double("column", key: "column one", model_attribute: :column_one, name: "Column One") }
   let(:columns) { [column] }
+  let(:index) { 1 }
   let(:primary_key_columns) { [] }
 
   let(:data) { ["Value One"] }
-  let(:subject) { described_class.new(header, data) }
+  let(:subject) { described_class.new(header, data, index) }
 
   before do
     allow(header).to receive(:columns).and_return(columns)
@@ -17,14 +18,21 @@ describe CSVModel::Row do
     allow(header).to receive(:primary_key_columns).and_return(primary_key_columns)
   end
 
+  describe "#csv_index, #model_index" do
+    it "returns the index the row was instantiated with" do
+      expect(subject.csv_index).to eq(index)
+      expect(subject.model_index).to eq(index)
+    end
+  end
+
   describe "#errors" do
     context "when no errors" do
-      let(:model) { double("model") }
-      let(:subject) { described_class.new(header, data, model: model) }
+      let(:model_finder) { double("model-finder") }
+      let(:subject) { described_class.new(header, data, index, row_model_finder: model_finder) }
       let(:model_instance) { double("model-instance", changed?: false, marked_for_destruction?: false, new_record?: false, valid?: true) }
 
       before do
-        allow(model).to receive(:find_row_model).and_return(model_instance)
+        allow(model_finder).to receive(:find_row_model).and_return(model_instance)
         allow(model_instance).to receive(:save)
       end
 
@@ -45,7 +53,7 @@ describe CSVModel::Row do
       end
 
       context "during a dry-run" do
-        let(:subject) { described_class.new(header, data, dry_run: true) }
+        let(:subject) { described_class.new(header, data, index, dry_run: true) }
 
         it "returns an error" do
           expect(subject.errors).to include("Duplicate row")
@@ -62,13 +70,13 @@ describe CSVModel::Row do
     end
 
     context "when the model instance has errors" do
-      let(:model) { double("model") }
-      let(:subject) { described_class.new(header, data, model: model) }
+      let(:model_finder) { double("model-finder") }
+      let(:subject) { described_class.new(header, data, index, row_model_finder: model_finder) }
       let(:model_instance) { double("model-instance", changed?: false, errors: errors, marked_for_destruction?: false, new_record?: false, valid?: false) }
       let(:errors) { ["Message one", "Message two"] }
 
       before do
-        allow(model).to receive(:find_row_model).and_return(model_instance)
+        allow(model_finder).to receive(:find_row_model).and_return(model_instance)
       end
 
       it "includes the model instance errors" do
@@ -156,6 +164,30 @@ describe CSVModel::Row do
     end
   end
 
+  describe "#process_row" do
+    let(:model_finder) { double("model-finder") }
+    let(:model_instance) { double("model-instance", changed?: true, marked_for_destruction?: false, new_record?: false, valid?: true) }
+    let(:subject) { described_class.new(header, data, index, row_model_finder: model_finder) }
+
+    before do
+      allow(model_finder).to receive(:find_row_model).and_return(model_instance)
+      allow(subject).to receive(:all_attributes).and_return(:all_attributes)
+    end
+
+    it "assigns attributes and saves the model instance" do
+      expect(model_instance).to receive(:assign_attributes).with(:all_attributes).ordered
+      expect(model_instance).to receive(:save)
+      subject.process_row
+    end
+
+    it "only processes a record once" do
+      expect(model_instance).to receive(:assign_attributes).with(:all_attributes).ordered
+      expect(model_instance).to receive(:save)
+      subject.process_row
+      subject.process_row
+    end
+  end
+
   describe "#status" do
     let(:model) { double("model") }
     let(:wrapper) { double("wrapper", status: :some_status) }
@@ -167,7 +199,7 @@ describe CSVModel::Row do
     end
 
     it "is delegates status to the model" do
-      expect(CSVModel::ObjectWithStatusSnapshot).to receive(:new).and_return(wrapper)
+      expect(CSVModel::RowActiveRecordAdaptor).to receive(:new).and_return(wrapper)
       expect(subject.status).to eq(:some_status)
     end
   end
@@ -194,6 +226,19 @@ describe CSVModel::Row do
         expect(subject.send(:all_attributes)).to eq(column_one: "Value One")
       end
 
+      context "with a column mapping" do
+        let(:model_mapper) { double("model-mapper") }
+        let(:subject) { described_class.new(header, data, index, row_model_mapper: model_mapper) }
+
+        before do
+          allow(model_mapper).to receive(:map_all_attributes).with({ column_one: "Value One" }).and_return(mapped_key: "mapped_value")
+        end
+
+        it "maps attributes" do
+          expect(subject.send(:all_attributes)).to eq(mapped_key: "mapped_value")
+        end
+      end
+
       context "with multiple columns" do
         let(:columns) { [
           double("column", key: "column one", model_attribute: :column_one),
@@ -214,8 +259,8 @@ describe CSVModel::Row do
     end
 
     describe "#inherit_or_delegate" do
-      let(:model) { double("model") }
-      let(:subject) { described_class.new(header, data, model: model) }
+      let(:model_finder) { double("model-finder") }
+      let(:subject) { described_class.new(header, data, index, row_model_finder: model_finder) }
 
       it "doesn't respond to inherit_or_delegate" do
         expect(subject.respond_to?(:inherit_or_delegate)).to eq(false)
@@ -233,7 +278,7 @@ describe CSVModel::Row do
       end
 
       it "invokes delegate method if delegate exists and internal method is not defined" do
-        expect(model).to receive(:some_method).with(:multiple, :args).and_return(:some_value)
+        expect(model_finder).to receive(:some_method).with(:multiple, :args).and_return(:some_value)
         expect(subject.send(:inherit_or_delegate, :some_method, :multiple, :args)).to eq(:some_value)
       end
     end
@@ -275,12 +320,25 @@ describe CSVModel::Row do
           expect(subject.send(:key_attributes)).to eq(column_one: "Value One", column_two: "Value Two")
         end
       end
+
+      context "with a column mapping" do
+        let(:model_mapper) { double("model-mapper") }
+        let(:subject) { described_class.new(header, data, index, row_model_mapper: model_mapper) }
+
+        before do
+          allow(model_mapper).to receive(:map_key_attributes).with({ column_one: "Value One" }).and_return(mapped_key: "mapped_value")
+        end
+
+        it "maps attributes" do
+          expect(subject.send(:key_attributes)).to eq(mapped_key: "mapped_value")
+        end
+      end
     end
 
     describe "#model_instance" do
-      let(:model) { double("model") }
+      let(:model_finder) { double("model-finder") }
       let(:model_instance) { double("model-instance") }
-      let(:subject) { described_class.new(header, data, model: model) }
+      let(:subject) { described_class.new(header, data, index, row_model_finder: model_finder) }
 
       before do
         allow(subject).to receive(:key_attributes).and_return(:key_attributes)
@@ -298,7 +356,7 @@ describe CSVModel::Row do
       end
 
       it "tries to find an instance via model#find_row_model when #find_row_model does not exist" do
-        expect(model).to receive(:find_row_model).with(:key_attributes).and_return(model_instance)
+        expect(model_finder).to receive(:find_row_model).with(:key_attributes).and_return(model_instance)
         expect(subject.send(:model_instance)).to eq(model_instance)
       end
 
@@ -313,39 +371,11 @@ describe CSVModel::Row do
       end
 
       it "tries to instantiate a new model via model#new_row_model when a model cannot be found and #new_row_model does not exist" do
-        expect(model).to receive(:find_row_model).with(:key_attributes).and_return(nil)
-        expect(model).to receive(:new_row_model).with(:key_attributes).and_return(model_instance)
+        expect(model_finder).to receive(:find_row_model).with(:key_attributes).and_return(nil)
+        expect(model_finder).to receive(:new_row_model).with(:key_attributes).and_return(model_instance)
         expect(subject.send(:model_instance)).to eq(model_instance)
       end
     end
-
-    describe "#process_row" do
-      let(:model) { double("model") }
-      let(:model_instance) { double("model-instance", changed?: true, marked_for_destruction?: false, new_record?: false, valid?: true) }
-      let(:subject) { described_class.new(header, data, model: model) }
-
-      before do
-        allow(model).to receive(:find_row_model).and_return(model_instance)
-        allow(subject).to receive(:all_attributes).and_return(:all_attributes)
-      end
-
-      it "doesn't respond to process_row" do
-        expect(subject.respond_to?(:process_row)).to eq(false)
-      end
-
-      it "assigns attributes and saves the model instance" do
-        expect(model_instance).to receive(:assign_attributes).with(:all_attributes).ordered
-        expect(model_instance).to receive(:save)
-        subject.send(:process_row)
-      end
-
-      it "only processes a record once" do
-        expect(model_instance).to receive(:assign_attributes).with(:all_attributes).ordered
-        expect(model_instance).to receive(:save)
-        subject.send(:process_row)
-        subject.send(:process_row)
-      end
-    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csv_model
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Chadwick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
+date: 2014-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,15 +73,15 @@ files:
 - lib/csv_model/extensions.rb
 - lib/csv_model/header_row.rb
 - lib/csv_model/model.rb
-- lib/csv_model/object_with_status_snapshot.rb
 - lib/csv_model/record_status.rb
 - lib/csv_model/row.rb
+- lib/csv_model/row_active_record_adaptor.rb
 - lib/csv_model/utilities.rb
 - lib/csv_model/version.rb
 - spec/csv_model/column_spec.rb
 - spec/csv_model/header_row_spec.rb
 - spec/csv_model/model_spec.rb
-- spec/csv_model/object_with_status_snapshot_spec.rb
+- spec/csv_model/row_active_record_adaptor_spec.rb
 - spec/csv_model/row_spec.rb
 - spec/csv_model/utilities_spec.rb
 - spec/spec_helper.rb
@@ -113,7 +113,7 @@ test_files:
 - spec/csv_model/column_spec.rb
 - spec/csv_model/header_row_spec.rb
 - spec/csv_model/model_spec.rb
-- spec/csv_model/object_with_status_snapshot_spec.rb
+- spec/csv_model/row_active_record_adaptor_spec.rb
 - spec/csv_model/row_spec.rb
 - spec/csv_model/utilities_spec.rb
 - spec/spec_helper.rb