speaky_csv 0.0.1

data/spec/active_record_import_spec.rb

@@ -0,0 +1,338 @@
+require 'spec_helper'
+require 'support/active_record'
+
+describe SpeakyCsv::ActiveRecordImport, :db do
+  let(:presenter_klass) { Class.new SpeakyCsv::Base }
+
+  let(:io) { StringIO.new }
+  subject { presenter_klass.new.active_record_importer io, Book }
+
+  def record
+    unless defined? @record
+      records = subject.to_a
+      expect(records.length).to be <= 1
+      @record = records.first
+    end
+
+    @record
+  end
+
+  context 'with fields' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field :id, :name, :author, :_destroy
+        end
+      end
+    end
+
+    context 'and csv has a new record' do
+      let(:io) do
+        StringIO.new <<-CSV
+id,name,author
+,Big Fiction,Sneed
+        CSV
+      end
+
+      it 'returns new record' do
+        expect(record.attributes).to include('name' => 'Big Fiction',
+                                             'author' => 'Sneed')
+        expect(record).to be_new_record
+      end
+    end
+
+    context 'and csv has no changes' do
+      let!(:book) { Book.create! id: 1, name: 'Big Fiction', author: 'Sneed' }
+
+      let(:io) do
+        StringIO.new <<-CSV
+id,name,author
+1,Big Fiction,Sneed
+        CSV
+      end
+
+      it 'returns clean record' do
+        expect(record.attributes).to include('id' => 1,
+                                             'name' => 'Big Fiction',
+                                             'author' => 'Sneed')
+        expect(record).to_not be_changed
+      end
+    end
+
+    context 'and csv has changes' do
+      let!(:book) { Book.create! id: 1, name: 'Big Fiction', author: 'Sneed' }
+
+      let(:io) do
+        StringIO.new <<-CSV
+id,name,author
+1,Wee Little Fiction,Sneed
+        CSV
+      end
+
+      it 'returns dirty record' do
+        expect(record.name).to eq 'Wee Little Fiction'
+        expect(record).to be_changed # not saved yet
+      end
+    end
+
+    context 'and csv has a destroy' do
+      let!(:book) { Book.create! id: 1, name: 'Big Fiction', author: 'Sneed' }
+
+      let(:io) do
+        StringIO.new <<-CSV
+id,_destroy
+1,true
+        CSV
+      end
+
+      it 'returns record marked for destruction' do
+        expect(record).to be_marked_for_destruction
+      end
+    end
+  end
+
+  context 'with custom primary_key' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.primary_key = :name
+          d.field :author
+        end
+      end
+    end
+
+    let!(:book) { Book.create! id: 1, name: 'Big Fiction', author: 'Sneed' }
+
+    let(:io) do
+      StringIO.new <<-CSV
+name,author
+Big Fiction,Sneed
+      CSV
+    end
+
+    it 'finds by primary key' do
+      expect(record).to eq book
+    end
+  end
+
+  context 'and no record with primary key exists' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field :id
+        end
+      end
+    end
+
+    let(:io) do
+      StringIO.new <<-CSV
+id,name,author
+1,Big Fiction,Sneed
+      CSV
+    end
+
+    it 'returns an error' do
+      expect(subject.to_a).to eq []
+      expect(subject.errors[:row_2]).to be_present
+    end
+  end
+
+  context 'when record doesnt have defined attribute' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field :id, :whats_this
+        end
+      end
+    end
+
+    let!(:book) { Book.create! id: 1, name: 'Big Fiction', author: 'Sneed' }
+
+    let(:io) do
+      StringIO.new <<-CSV
+id,whats_this
+1,unknown
+      CSV
+    end
+
+    it 'adds an error' do
+      expect(record).to eq book
+      expect(subject.errors[:row_2]).to be_present
+    end
+  end
+
+  context 'with has_many field' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field :id
+          d.has_many 'reviews' do |r|
+            r.field :id, :tomatoes, :publication, :_destroy
+          end
+        end
+      end
+    end
+
+    let!(:book) { Book.create! id: 1 }
+
+    def actual_review
+      unless defined? @review
+        expect(record.reviews.length).to be <= 1
+        @review = record.reviews.first
+      end
+
+      @review
+    end
+
+    context 'and csv has new associated record' do
+      let(:io) do
+        StringIO.new <<-CSV
+id
+1,review_0_tomatoes,99,review_0_publication,Post
+        CSV
+      end
+
+      it 'builds new record' do
+        expect(actual_review.attributes).to include('book_id' => 1,
+                                                    'tomatoes' => 99,
+                                                    'publication' => 'Post')
+        expect(actual_review).to be_new_record
+      end
+    end
+
+    context 'and csv has unchanged associated record' do
+      let(:io) do
+        StringIO.new <<-CSV
+id
+1,review_0_id,1,review_0_tomatoes,99,review_0_publication,Post
+        CSV
+      end
+
+      let!(:review) { Review.create! id: 1, book: book, tomatoes: 99, publication: 'Post' }
+
+      it 'returns clean record' do
+        expect(actual_review).to_not be_changed
+      end
+    end
+
+    context 'and csv changes associated record' do
+      let(:io) do
+        StringIO.new <<-CSV
+id
+1,review_0_id,1,review_0_tomatoes,80,review_0_publication,Post
+        CSV
+      end
+
+      let!(:review) { Review.create! id: 1, book: book, tomatoes: 99, publication: 'Post' }
+
+      it 'returns clean record' do
+        expect(actual_review.tomatoes).to eq 80
+        expect(actual_review).to be_changed
+      end
+    end
+    context 'and csv destroys associated record' do
+      let(:io) do
+        StringIO.new <<-CSV
+id
+1,review_0_id,1,review_0__destroy,true
+        CSV
+      end
+
+      let!(:review) { Review.create! id: 1, book: book, tomatoes: 99, publication: 'Post' }
+
+      it 'marks record for destruction' do
+        expect(actual_review).to be_marked_for_destruction
+      end
+    end
+  end
+
+  it "should fail when all headers aren't to the left"
+  it 'should ignore undefined variable columns'
+  it 'should fail when variable columns not pair up correctly'
+
+  describe 'batch behavior' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field :id, :name, :author, :_destroy
+        end
+      end
+    end
+
+    let!(:book1) { Book.create! id: 1, name: 'Big Fiction', author: 'Sneed' }
+    let!(:book2) { Book.create! id: 2, name: 'Big NonFiction', author: 'Sneed' }
+    let!(:book3) { Book.create! id: 3, name: 'The Last Goodbye', author: 'Sneed' }
+
+    let(:io) do
+      StringIO.new <<-CSV
+id,name,author,_destroy
+,Natty,Sneed
+1,Big Fiction,Sneed
+2,Wee Little NonFiction,Sneed
+3,,,true
+      CSV
+    end
+
+    def expect_changes_to_be_correct
+      records = subject.to_a
+
+      aggregate_failures 'changes' do
+        expect(records.length).to eq 4
+        new_one = records.find(&:new_record?)
+        expect(new_one.attributes).to include('name' => 'Natty',
+                                              'author' => 'Sneed')
+        book1 = records.find { |b| b.id == 1 }
+        expect(book1).to_not be_changed
+
+        book2 = records.find { |b| b.id == 2 }
+        expect(book2.attributes).to include('name' => 'Wee Little NonFiction',
+                                            'author' => 'Sneed')
+        expect(book2).to be_changed
+
+        book3 = records.find { |b| b.id == 3 }
+        expect(book3).to be_marked_for_destruction
+      end
+    end
+
+    context 'when batch size is less than csv size' do
+      before do
+        stub_const 'SpeakyCsv::ActiveRecordImport::QUERY_BATCH_SIZE', 2
+      end
+
+      it 'works' do
+        expect_changes_to_be_correct
+      end
+    end
+
+    context 'when batch size is same as csv size' do
+      before do
+        stub_const 'SpeakyCsv::ActiveRecordImport::QUERY_BATCH_SIZE', 4
+      end
+
+      it 'works' do
+        expect_changes_to_be_correct
+      end
+    end
+
+    context 'when batch size is greater than as csv size' do
+      before do
+        stub_const 'SpeakyCsv::ActiveRecordImport::QUERY_BATCH_SIZE', 6
+      end
+
+      it 'works' do
+        expect_changes_to_be_correct
+      end
+    end
+  end
+
+  context 'when csv is invalid' do
+    before do
+      allow(CSV).to receive(:new).and_raise(CSV::MalformedCSVError)
+    end
+
+    it 'adds an error' do
+      expect(subject.to_a).to eq []
+      expect(subject.errors[:csv]).to be_present
+    end
+  end
+end

data/spec/attr_import_spec.rb

@@ -0,0 +1,205 @@
+require 'spec_helper'
+
+describe SpeakyCsv::AttrImport do
+  let(:presenter_klass) { Class.new SpeakyCsv::Base }
+
+  let(:io) { StringIO.new }
+  subject { presenter_klass.new.attr_importer io }
+
+  context 'with fields' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field 'name', 'author'
+        end
+      end
+    end
+
+    let(:io) do
+      StringIO.new <<-CSV
+name,author
+Big Fiction,Sneed
+True story,Honest Abe
+      CSV
+    end
+
+    it 'should return a data structure' do
+      expect(subject.to_a).to eq([
+        { 'name' => 'Big Fiction', 'author' => 'Sneed' },
+        { 'name' => 'True story', 'author' => 'Honest Abe' }
+      ])
+    end
+  end
+
+  context 'with export_only field' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field :id
+          d.field :name, export_only: true
+        end
+      end
+    end
+
+    let(:io) do
+      StringIO.new <<-CSV
+id,name
+22,Big Fiction
+      CSV
+    end
+
+    it 'should exclude field' do
+      expect(subject.to_a).to eq([{'id' => '22'}])
+    end
+  end
+
+  context 'with unknown field' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field 'name'
+        end
+      end
+    end
+
+    let(:io) do
+      StringIO.new <<-CSV
+name,setting
+Big Fiction,Chicago
+True story,NYC
+      CSV
+    end
+
+    it 'should ignores it' do
+      expect(subject.to_a).to eq([
+        { 'name' => 'Big Fiction' },
+        { 'name' => 'True story' }
+      ])
+    end
+  end
+
+  context 'with has_many fields' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field 'name', 'author'
+          d.has_many 'reviews' do |r|
+            r.field :tomatoes, :publication
+          end
+        end
+      end
+    end
+
+    let(:io) do
+      StringIO.new <<-CSV
+name,author,,,,,,,,
+Big Fiction,Sneed,review_0_tomatoes,99,review_0_publication,Post,review_1_tomatoes,15,review_1_publication,Daily
+True story,Honest Abe,review_0_tomatoes,50,review_0_publication,Daily
+      CSV
+    end
+
+    it 'should return attrs' do
+      expect(subject.to_a).to eq([
+        {
+          'name' => 'Big Fiction',
+          'author' => 'Sneed',
+          'reviews' => [
+            { 'tomatoes' => '99', 'publication' => 'Post' },
+            { 'tomatoes' => '15', 'publication' => 'Daily' }
+          ]
+        },
+        {
+          'name' => 'True story',
+          'author' => 'Honest Abe',
+          'reviews' => [
+            { 'tomatoes' => '50', 'publication' => 'Daily' }
+          ]
+        }
+      ])
+    end
+  end
+
+  context 'with export_only has_many field' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field :id
+          d.has_many :reviews do |r|
+            r.field :tomatoes, export_only: true
+          end
+        end
+      end
+    end
+
+    let(:io) do
+      StringIO.new <<-CSV
+id
+22,reviews_0_tomatoes,99
+      CSV
+    end
+
+    it 'should exclude field' do
+      expect(subject.to_a).to eq([{ 'id' => '22' }])
+    end
+  end
+
+  context 'with unknown has_many' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field 'name'
+        end
+      end
+    end
+
+    let(:io) do
+      StringIO.new <<-CSV
+name
+Big Fiction,sales_0_count,99,sales_0_period,Q1
+      CSV
+    end
+
+    it 'should ignore it' do
+      expect(subject.to_a).to eq([{ 'name' => 'Big Fiction' }])
+    end
+  end
+
+  context 'with unknown has_many field' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field 'name'
+          d.has_many 'reviews' do |r|
+            r.field :tomatoes
+          end
+        end
+      end
+    end
+
+    let(:io) do
+      StringIO.new <<-CSV
+name
+Big Fiction,review_0_tomatoes,99,review_0_auther,Meanie
+      CSV
+    end
+
+    it 'should ignore it' do
+      expect(subject.to_a).to eq [{ 'name' => 'Big Fiction', 'reviews' => [{ 'tomatoes' => '99' }] }]
+    end
+  end
+
+  context 'when csv is invalid' do
+    before do
+      allow(CSV).to receive(:new).and_raise(CSV::MalformedCSVError)
+    end
+
+    it 'adds an error' do
+      expect(subject.to_a).to eq []
+      expect(subject.errors[:csv]).to be_present
+    end
+  end
+
+  it "should fail when all headers aren't to the left"
+  it 'should ignore undefined variable columns'
+  it 'should fail when variable columns not pair up correctly'
+end

data/spec/base_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe SpeakyCsv::Base do
+  describe 'define_csv_fields' do
+    let(:parent_klass) { Class.new SpeakyCsv::Base }
+    let(:child_klass) { Class.new parent_klass }
+
+    context 'when parent class has config' do
+      before do
+        parent_klass.class_eval do
+          define_csv_fields do |d|
+            d.field :name
+            d.has_many :reviews do |r|
+              r.field :tomatoes
+            end
+          end
+        end
+      end
+
+      it 'inherits it for child' do
+        expect(child_klass.csv_field_builder.fields).to eq [:name]
+        expect(child_klass.csv_field_builder.has_manys.keys).to eq [:reviews]
+        expect(child_klass.csv_field_builder.has_manys[:reviews].fields).to eq [:tomatoes]
+      end
+
+      context 'and child adds to it' do
+        before do
+          child_klass.class_eval do
+            define_csv_fields do |d|
+              d.field :author
+              d.has_many :sales do |s|
+                s.field :period
+              end
+              d.has_many :reviews do |r|
+                r.field :publication
+              end
+            end
+          end
+        end
+
+        it 'adds it to child' do
+          expect(child_klass.csv_field_builder.fields).to eq [:name, :author]
+          expect(child_klass.csv_field_builder.has_manys.keys.sort).to eq [:reviews, :sales].sort
+          expect(child_klass.csv_field_builder.has_manys[:reviews].fields).to eq [:tomatoes, :publication]
+          expect(child_klass.csv_field_builder.has_manys[:sales].fields).to eq [:period]
+        end
+
+        it 'doesnt change parents config' do
+          expect(parent_klass.csv_field_builder.fields).to_not include :author
+          expect(parent_klass.csv_field_builder.has_manys.keys).to_not include :sales
+          expect(parent_klass.csv_field_builder.has_manys[:reviews].fields).to_not include :publication
+        end
+      end
+    end
+  end
+end