speaky_csv 0.0.3 → 0.0.5

data/lib/speaky_csv/base.rb

@@ -1,81 +1,17 @@
 module SpeakyCsv
-  # An instance of this class is yielded to the block passed to
-  # define_csv_fields. Used to configure speaky csv.
-  class Builder
-    attr_reader \
-      :export_only_fields,
-      :fields,
-      :has_manys,
-      :has_ones,
-      :primary_key
-
-    def initialize
-      @export_only_fields = []
-      @fields = []
-      @has_manys = {}
-      @has_ones = {}
-      @primary_key = :id
-    end
-
-    # Add one or many fields to the csv format.
-    #
-    # If options are passed, they apply to all given fields.
-    def field(*fields, export_only: false)
-      @fields += fields.map(&:to_sym)
-      @fields.uniq!
-
-      if export_only
-        @export_only_fields += fields.map(&:to_sym)
-        @export_only_fields.uniq!
-      end
-
-      nil
-    end
-
-    # Define a custom primary key. By default an `id` column as used.
-    #
-    # Accepts the same options as #field
-    def primary_key=(name, options = {})
-      field name, options
-      @primary_key = name.to_sym
-    end
-
-    def has_one(name)
-      @has_ones[name.to_sym] ||= self.class.new
-      yield @has_ones[name.to_sym]
-
-      nil
-    end
-
-    def has_many(name)
-      @has_manys[name.to_sym] ||= self.class.new
-      yield @has_manys[name.to_sym]
-
-      nil
-    end
-
-    def dup
-      other = super
-      other.instance_variable_set '@has_manys', @has_manys.deep_dup
-      other.instance_variable_set '@has_ones', @has_ones.deep_dup
-
-      other
-    end
-  end
-
   # Inherit from this class when using SpeakyCsv
   class Base
-    class_attribute :csv_field_builder
-    self.csv_field_builder = Builder.new
+    class_attribute :speaky_csv_config
+    self.speaky_csv_config = Config.new
 
     def self.define_csv_fields
-      self.csv_field_builder = csv_field_builder.deep_dup
-      yield csv_field_builder
+      self.speaky_csv_config = speaky_csv_config.deep_dup
+      yield ConfigBuilder.new(config: speaky_csv_config)
     end
 
     # Return a new exporter instance
     def self.exporter(records_enumerator)
-      Export.new csv_field_builder,
+      Export.new speaky_csv_config,
                  records_enumerator
     end
 
@@ -98,8 +34,8 @@ module SpeakyCsv
     #   end
     # end
     #
-    def attr_importer(input_io)
-      AttrImport.new self.class.csv_field_builder,
+    def self.attr_importer(input_io)
+      AttrImport.new speaky_csv_config,
                      input_io
     end
 
@@ -125,9 +61,9 @@ module SpeakyCsv
     # Optionally an Enumerable instance can be passed instead of an IO
     # instance. The enumerable should return attr hashes. This may be helpful
     # for transforming or chaining Enumerables.
-    def active_record_importer(input_io_or_enumerable, klass)
+    def self.active_record_importer(input_io_or_enumerable, klass)
       ActiveRecordImport.new \
-        self.class.csv_field_builder,
+        speaky_csv_config,
         input_io_or_enumerable,
         klass
     end

data/lib/speaky_csv/config.rb

@@ -0,0 +1,30 @@
+module SpeakyCsv
+  # An instance of this class is yielded to the block passed to
+  # define_csv_fields. Used to configure speaky csv.
+  class Config
+    attr_accessor \
+      :export_only_fields,
+      :fields,
+      :has_manys,
+      :has_ones,
+      :primary_key,
+      :root
+
+    def initialize(root: true)
+      @root = root
+      @export_only_fields = []
+      @fields = []
+      @has_manys = {}
+      @has_ones = {}
+      @primary_key = :id
+    end
+
+    def dup
+      other = super
+      other.instance_variable_set '@has_manys', @has_manys.deep_dup
+      other.instance_variable_set '@has_ones', @has_ones.deep_dup
+
+      other
+    end
+  end
+end

data/lib/speaky_csv/config_builder.rb

@@ -0,0 +1,74 @@
+module SpeakyCsv
+  # An instance of this class is yielded to the block passed to
+  # define_csv_fields. Used to configure speaky csv.
+  class ConfigBuilder
+    attr_reader :config
+
+    def initialize(config: Config.new, root: true)
+      @config = config
+      @config.root = root
+    end
+
+    # Add one or many fields to the csv format.
+    #
+    # If options are passed, they apply to all given fields.
+    def field(*fields, export_only: false)
+      @config.fields += fields.map(&:to_sym)
+      @config.fields.uniq!
+
+      if export_only
+        @config.export_only_fields += fields.map(&:to_sym)
+        @config.export_only_fields.uniq!
+      end
+
+      nil
+    end
+
+    # Define a custom primary key. By default an `id` column as used.
+    #
+    # Accepts the same options as #field
+    def primary_key=(name, options = {})
+      field name, options
+      @config.primary_key = name.to_sym
+    end
+
+    # Define a one to one association. This is also aliased as `belongs_to`. Expects a name and a block to
+    # define the fields on associated record.
+    #
+    # For example:
+    #
+    #   define_csv_fields do |c|
+    #     has_many 'publisher' do |p|
+    #       p.field :id, :name, :_destroy
+    #     end
+    #   end
+    #
+    def has_one(name)
+      @config.root or raise NotImplementedError, "nested associations are not supported"
+      @config.has_ones[name.to_sym] ||= Config.new
+      yield self.class.new config: @config.has_ones[name.to_sym], root: false
+
+      nil
+    end
+    alias :belongs_to :has_one
+
+    # Define a one to many association. Expect a name and a block to
+    # define the fields on associated records.
+    #
+    # For example:
+    #
+    #   define_csv_fields do |c|
+    #     has_many 'reviews' do |r|
+    #       r.field :id, :name, :_destroy
+    #     end
+    #   end
+    #
+    def has_many(name)
+      @config.root or raise NotImplementedError, "nested associations are not supported"
+      @config.has_manys[name.to_sym] ||= Config.new
+      yield self.class.new config: @config.has_manys[name.to_sym], root: false
+
+      nil
+    end
+  end
+end

data/lib/speaky_csv/export.rb

@@ -32,6 +32,7 @@ module SpeakyCsv
 
     def valid_field?(record, field, prefix: nil)
       return true if record.respond_to? field
+      return false if field == :_destroy
 
       error_name = prefix ? "#{prefix}_#{field}" : field
       logger.error "#{error_name} is not a method for class #{record.class}"
@@ -43,8 +44,13 @@ module SpeakyCsv
       return @enumerator if defined? @enumerator
 
       @enumerator = Enumerator.new do |yielder|
+        columns = @config.fields
+        columns += @config.has_ones.flat_map do |name, config|
+          config.fields.map {|f| "#{name}_#{f}" }
+        end
+
         # header row
-        yielder << CSV::Row.new(@config.fields, @config.fields, true).to_csv
+        yielder << CSV::Row.new(columns, columns, true).to_csv
 
         @records_enumerator.each do |record|
           values = @config.fields
@@ -62,6 +68,13 @@ module SpeakyCsv
             end
           end
 
+          @config.has_ones.select { |a| valid_field? record, a }.each do |name, config|
+            has_one_record = record.send name
+            config.fields.select { |f| valid_field? has_one_record, f, prefix: name }.each do |field|
+              row << has_one_record.send(field)
+            end
+          end
+
           yielder << row.to_csv
         end
       end

data/lib/speaky_csv/version.rb

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

data/spec/active_record_import_spec.rb

@@ -5,7 +5,7 @@ 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 }
+  subject { presenter_klass.active_record_importer io, Book }
 
   def record
     unless defined? @record
@@ -119,7 +119,7 @@ Big Fiction,Sneed
     before do
       presenter_klass.class_eval do
         define_csv_fields do |d|
-          d.field :id
+          d.field :id, :name, :author
         end
       end
     end
@@ -170,7 +170,7 @@ id,name,whats_this
     end
   end
 
-  context 'with has_many field' do
+  context 'with has_many association' do
     before do
       presenter_klass.class_eval do
         define_csv_fields do |d|
@@ -255,6 +255,80 @@ id
     end
   end
 
+  context 'with has_one association' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field :id
+          d.has_one 'publisher' do |r|
+            r.field :id, :name, :_destroy
+          end
+        end
+      end
+    end
+
+    let!(:book) { Book.create! id: 1 }
+
+    context 'and csv has new associated record' do
+      let(:io) do
+        StringIO.new <<-CSV
+id,publisher_id,publisher_name
+1,,Dan Blam
+        CSV
+      end
+
+      it 'builds new record' do
+        expect(record.publisher.attributes).to include('id' => nil, 'name' => 'Dan Blam')
+        expect(record.publisher).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 variable columns not pair up correctly'
 
   describe 'batch behavior' do
@@ -368,7 +442,7 @@ hihihi
   end
 
   context 'with enumerator' do
-    subject { presenter_klass.new.active_record_importer enumerator, Book }
+    subject { presenter_klass.active_record_importer enumerator, Book }
 
     before do
       presenter_klass.class_eval do

data/spec/attr_import_spec.rb

@@ -4,7 +4,7 @@ describe SpeakyCsv::AttrImport do
   let(:presenter_klass) { Class.new SpeakyCsv::Base }
 
   let(:io) { StringIO.new }
-  subject { presenter_klass.new.attr_importer io }
+  subject { presenter_klass.attr_importer io }
 
   context 'with fields' do
     before do
@@ -29,6 +29,40 @@ True story,Honest Abe
         { 'name' => 'True story', 'author' => 'Honest Abe' }
       ])
     end
+
+    context "when csv cell is empty" do
+      let(:io) do
+        StringIO.new <<-CSV
+name,author
+,Sneed
+True story,
+        CSV
+      end
+
+      it 'should return nil values' do
+        expect(subject.to_a).to eq([
+          { 'name' => nil, 'author' => 'Sneed' },
+          { 'name' => 'True story', 'author' => nil }
+        ])
+      end
+    end
+
+    context "when a column isn't present" do
+      let(:io) do
+        StringIO.new <<-CSV
+name
+Big Fiction
+True story
+        CSV
+      end
+
+      it 'should not include that field in output' do
+        expect(subject.to_a).to eq([
+          { 'name' => 'Big Fiction' },
+          { 'name' => 'True story' }
+        ])
+      end
+    end
   end
 
   context 'with export_only field' do
@@ -58,7 +92,7 @@ id,name
     end
   end
 
-  context 'with unknown field' do
+  context 'with unknown columns' do
     before do
       presenter_klass.class_eval do
         define_csv_fields do |d|
@@ -127,6 +161,130 @@ True story,Honest Abe,review_0_tomatoes,50,review_0_publication,Daily
         }
       ])
     end
+
+    context 'when csv cell is empty' do
+      let(:io) do
+        StringIO.new <<-CSV
+name,author,,,,,,,,
+Big Fiction,Sneed,review_0_tomatoes,,review_0_publication,,review_1_tomatoes,,review_1_publication
+True story,Honest Abe,review_0_tomatoes,,review_0_publication,,
+        CSV
+      end
+
+      it 'should return nil values' do
+        expect(subject.to_a).to eq([
+          {
+            'name' => 'Big Fiction',
+            'author' => 'Sneed',
+            'reviews' => [
+              { 'tomatoes' => nil, 'publication' => nil },
+              { 'tomatoes' => nil, 'publication' => nil }
+            ]
+          },
+          {
+            'name' => 'True story',
+            'author' => 'Honest Abe',
+            'reviews' => [
+              { 'tomatoes' => nil, 'publication' => nil }
+            ]
+          }
+        ])
+      end
+    end
+  end
+
+  context 'with has_one fields' do
+    before do
+      presenter_klass.class_eval do
+        define_csv_fields do |d|
+          d.field 'name', 'author'
+          d.has_one 'publisher' do |r|
+            r.field :id, :name
+          end
+        end
+      end
+    end
+
+    let(:io) do
+      StringIO.new <<-CSV
+name,author,publisher_id,publisher_name,
+Big Fiction,Sneed,3,Dan Blam
+True story,Honest Abe,50,Burt Bacharach
+      CSV
+    end
+
+    it 'should return attrs' do
+      expect(subject.to_a).to eq([
+        {
+          'name' => 'Big Fiction',
+          'author' => 'Sneed',
+          'publisher' => {
+            'id' => '3', 'name' => 'Dan Blam'
+          },
+        },
+        {
+          'name' => 'True story',
+          'author' => 'Honest Abe',
+          'publisher' => {
+            'id' => '50', 'name' => 'Burt Bacharach'
+          }
+        }
+      ])
+    end
+
+    context 'when csv cell is empty' do
+      let(:io) do
+        StringIO.new <<-CSV
+name,author,publisher_id,publisher_name,
+Big Fiction,Sneed,,Dan Blam
+True story,Honest Abe,50,
+        CSV
+      end
+
+      it 'should return nil values' do
+        expect(subject.to_a).to eq([
+          {
+            'name' => 'Big Fiction',
+            'author' => 'Sneed',
+            'publisher' => {
+              'id' => nil, 'name' => 'Dan Blam'
+            },
+          },
+          {
+            'name' => 'True story',
+            'author' => 'Honest Abe',
+            'publisher' => {
+              'id' => '50', 'name' => nil
+            }
+          }
+        ])
+      end
+    end
+
+    context "when a column isn't present" do
+      let(:io) do
+        StringIO.new <<-CSV
+name,author,publisher_id
+Big Fiction,Sneed,3
+True story,Honest Abe,50
+        CSV
+      end
+
+      it 'should not include that field in output' do
+        expect(subject.to_a).to eq([
+          {
+            'name' => 'Big Fiction',
+            'author' => 'Sneed',
+            'publisher' => { 'id' => '3' },
+          },
+          {
+            'name' => 'True story',
+            'author' => 'Honest Abe',
+            'publisher' => { 'id' => '50' }
+          }
+        ])
+      end
+    end
   end
 
   context 'with export_only has_many field' do