speaky_csv 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d017f2f25bab00a7df4f498e877f6ef2ba04a5f9
-  data.tar.gz: 9fda5afbd14f9f576a146e68508f376e0b6b19c2
+  metadata.gz: 7fad11aca11ab34b9b05459bbc6282ec467d060a
+  data.tar.gz: 0beefbd6193709798f83e1c083022514840d65f8
 SHA512:
-  metadata.gz: 3aaa6af2837e4813370d9f3c3b3c1089921e24f4ab4f8f1a12765cc72b22824654945b55fcb8adabfda66986d51eecc6fc54a70e7bc288bb20e3e5dfcd36ce6a
-  data.tar.gz: 4618b193794df6419843ac667126d3bdf3649fa39989d97ddbf3795cfa815ea4a99a0775e58300daee52233f867704520865f210f12e05d0523ceaeab9d6fcc9
+  metadata.gz: 611f717ba2b8539ec43ca525699d92baef358b5950c11d5c6035adba41b2bcd94d3297a42b7a5fb22b92cfc24993e53921d0d0d5c02658416878ca0bb9b88d74
+  data.tar.gz: 3f2dfd7c80f985470eff75bc58745a88b54a43b27f4d214410f870468abc7c908a2c11fc7da88de37ed857452b231462e8b1cf8685de4a6d9f3e28875d269255

data/README.md

@@ -1,9 +1,51 @@
 # Speaky CSV
 
-CSV exporting and importing for ActiveRecord and ActiveModel records.
+CSV imports and exports for ActiveRecord.
 
-Speaky lets the format of csv files to be customized, but it does
-require certain conventions to be followed. At a high level, the csv
+## For example
+
+Lets say there exists a User class:
+
+    # in app/models/user.rb
+    class User < ActiveRecord::Base
+      ...
+    end
+
+Speaky can be used to import and export user records. The definition of
+the csv format could look like this:
+
+    # in app/csv/user_csv.rb
+    class UserCsv < SpeakyCsv::Base
+      define_csv_fields do |config|
+        config.field :id, :email, :roles
+      end
+    end
+
+Now lets import some user records. An import csv will always have an
+initial header row, with each following row representing a user record.
+lets import the following csv file (whitespace for clarity):
+
+    # my_import.csv
+    id, email,              roles
+    22, admin@example.test, admin
+      , newbie@user.test,   user
+
+This file can be imported like this:
+
+    File.open "my_import.csv", "r" do |io|
+      importer = UserCsv.new.active_record_importer io, User
+      importer.each { |user| user.save }
+    end
+
+## Custom CSV formats
+
+Speaky
+
+
+Speaky allows customization of csv files to a degree, but some
+conventions need to be followed.
+
+At a high level, the csv
 ends up looking similar to the way active record data gets serialized
 into form parameters which will be familiar to many rails developers.
 The advantage of this approach is that associated records be imported
@@ -46,6 +88,12 @@ Once the format is defined records can be exported like this:
     $ exporter = UserCsv.new.exporter(User.all)
     $ File.open('users.csv', 'w') { |io| exporter.each { |row| io.write row } }
 
+TODO:
+
+* describe importing to attribute list
+* describe importing to to active records
+* describe how to transform with an enumerator
+
 ## Recommendations
 
 * Add `id` and `_destroy` fields for active record models
@@ -62,6 +110,9 @@ Once the format is defined records can be exported like this:
 * [x] active record import validations
 * [ ] `has_one` associations
 * [ ] required fields (make `lock_version` required for example)
+* [ ] transformations for values via accessors on class
+* [ ] public stable api for csv format definition
+* [ ] assign attrs one at a time so they don't all fail together
 
 ## Contributing
 

data/lib/speaky_csv/active_record_import.rb

@@ -1,6 +1,5 @@
 require 'csv'
 require 'active_record'
-require 'English'
 
 module SpeakyCsv
   # Imports a csv file as unsaved active record instances
@@ -37,6 +36,19 @@ module SpeakyCsv
       @log_output.string
     end
 
+    # Add includes options which will be used when querying records.
+    #
+    # Useful to avoid N+1 type problems. Configured has_manys are automaticaly
+    # included and don't need to be specified here.
+    def includes(options)
+      @includes = options
+    end
+
+    # Add eager_load options which will be used when querying records.
+    def eager_load(options)
+      @eager_load = options
+    end
+
     private
 
     def enumerator
@@ -46,13 +58,14 @@ module SpeakyCsv
       Enumerator.new do |yielder|
         @rx.each_slice(QUERY_BATCH_SIZE) do |rows|
           keys = rows.map { |attrs| attrs[@config.primary_key.to_s] }
-          records = @klass.includes(@config.has_manys.keys)
-                    .where(@config.primary_key => keys)
-                    .inject({}) { |a, e| a[e.send(@config.primary_key).to_s] = e; a }
+          query = @klass.includes(@config.has_manys.keys)
+                  .where(@config.primary_key => keys)
+          query = query.includes(@includes) if @includes
+          query = query.eager_load(@eager_load) if @eager_load
 
-          rows.each do |attrs|
-            row_index += 1
+          records = query.inject({}) { |a, e| a[e.send(@config.primary_key).to_s] = e; a }
 
+          rows.each do |attrs|
             record = if attrs[@config.primary_key.to_s].present?
                        records[attrs[@config.primary_key.to_s]]
                      else
@@ -83,13 +96,17 @@ module SpeakyCsv
               end
             end
 
-            begin
-              record.attributes = attrs
-            rescue ActiveRecord::UnknownAttributeError
-              logger.error "[row #{row_index}] record doesn't respond to some configured fields: #{$ERROR_INFO.message}"
+            attrs.each do |attr, value|
+              writer_method = "#{attr}="
+              if record.respond_to? writer_method
+                record.send writer_method, value
+              else
+                logger.error "[row #{row_index}] record doesn't respond to #{attr.inspect}"
+              end
             end
 
             yielder << record
+            row_index += 1
           end
         end
       end

data/lib/speaky_csv/version.rb

@@ -1,3 +1,3 @@
 module SpeakyCsv
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/active_record_import_spec.rb

@@ -137,7 +137,7 @@ id,name,author
 
     it 'returns an error' do
       subject.to_a
-      expect(subject.log).to match(/\[row 2\]/)
+      expect(subject.log).to match(/\[row 1\]/)
     end
   end
 
@@ -145,7 +145,7 @@ id,name,author
     before do
       presenter_klass.class_eval do
         define_csv_fields do |d|
-          d.field :id, :whats_this
+          d.field :id, :name, :whats_this
         end
       end
     end
@@ -154,14 +154,19 @@ id,name,author
 
     let(:io) do
       StringIO.new <<-CSV
-id,whats_this
-1,unknown
+id,name,whats_this
+1,Huge Fiction,unknown
       CSV
     end
 
     it 'adds an error' do
       expect(record).to eq book
-      expect(subject.log).to match(/\[row 2\]/)
+      expect(subject.log).to match(/\[row 1\]/)
+    end
+
+    it 'assigns other attributes' do
+      expect(record).to eq book
+      expect(record.name).to eq 'Huge Fiction'
     end
   end
 
@@ -423,4 +428,22 @@ hihihi
       end
     end
   end
+
+  context "with includes options" do
+    before { subject.includes :publisher }
+
+    it "loads active records with includes option" do
+      # I don't know how to verify this so I'll just make sure it doesnt crash
+      expect { subject.to_a }.to_not raise_error
+    end
+  end
+
+  context "with includes options" do
+    before { subject.eager_load :publisher }
+
+    it "loads active records with eager_log option" do
+      # I don't know how to verify this so I'll just make sure it doesnt crash
+      expect { subject.to_a }.to_not raise_error
+    end
+  end
 end

data/spec/support/active_record.rb

@@ -10,8 +10,9 @@ ActiveRecord::Base.establish_connection adapter: 'sqlite3',
 
 ActiveRecord::Schema.define do
   create_table :books do |table|
-    table.column :name, :string
     table.column :author, :string
+    table.column :name, :string
+    table.column :publisher_id, :integer
   end
 
   create_table :reviews do |table|
@@ -19,10 +20,15 @@ ActiveRecord::Schema.define do
     table.column :tomatoes, :integer
     table.column :publication, :string
   end
+
+  create_table :publishers do |table|
+    table.column :name, :string
+  end
 end
 
 class Book < ActiveRecord::Base
   has_many :reviews, inverse_of: :book
+  belongs_to :publisher, inverse_of: :books
   accepts_nested_attributes_for :reviews, allow_destroy: true
 end
 
@@ -31,6 +37,10 @@ class Review < ActiveRecord::Base
   accepts_nested_attributes_for :book, allow_destroy: true
 end
 
+class Publisher < ActiveRecord::Base
+  has_many :books, inverse_of: :publisher
+end
+
 RSpec.configure do |config|
   config.before(:suite) do
     DatabaseCleaner.strategy = :transaction

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speaky_csv
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andy Hartford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel