relational_exporter 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27528505c9ae963ac90a8dec1a21aadba17fecd7
-  data.tar.gz: e84bb8298c019cc46dca592d3da020bf03f6c564
+  metadata.gz: 8c1b454011ca52b5ec7122722273f8503e1bd55a
+  data.tar.gz: 3c8f0d8b4371f5177d4b04b46debd9ef0df49287
 SHA512:
-  metadata.gz: 12fc7ca1f8478f07f1c76f23fa05e91a4d89620f9656ab72d133c768c2b5e5cc8fbe8397f3e2742a9f35b47ef3e7cf28d271205334df573c8aacbb8f7201ae01
-  data.tar.gz: 202c03846dcc21b7cd8f0c367d6ff841c346cc6cd5e8f6f79af0834966f0ee06a5e8d9fad5aa50e04f7d72ce22b0ea4a62b746863f4f022a96813e366a0e41a8
+  metadata.gz: 5ce81c194f3d0168cdf9dd88ba22f35e8a1909e269d925a2b560b302f3930054ca0c505d7f975ad50e52988c6cd7ea0880ddd1870e0a5f912a628428500e9890
+  data.tar.gz: 3db2e8d53cfe005eadf99f53034d50a325f0b1c4d477fd7999fae25f3019f77f5225f86854f9190c41398a21736b21af75d8c4ddee571dc36041659298ff0fa6

data/README.md

@@ -4,8 +4,8 @@ A gem to make it easy to export data from relational databases. RelationalExport
 
 ## TODO
 
+* Add concurrency for faster exports
 * Support multiple formats (currently only CSV)
-* Integrate serializers of some sort
 * Improve DSL
 * Clean up the code
 
@@ -89,6 +89,30 @@ Or install it yourself as:
   end
 ```
 
+## Support for Active Model Serializers
+
+Install the [`active_model_serializers`](https://github.com/rails-api/active_model_serializers) gem in your application to take advantage of easy serialization. For CSV exports, `relational_exporter` will look for a serializer when rendering the CSV row. If your serializer implements the `self.csv_header_prefix_for_key(key)` method, `relational_exporter` will use that method to determine the column header for a given model attribute.
+
+Example:
+
+```ruby
+class PersonSerializer < ActiveModel::Serializer
+  attributes :id, :name, :brother_name
+
+  def self.csv_header_prefix_for_key(key)
+    key == :brother_name ? '' : 'Person'
+  end
+end
+```
+
+Would generate a CSV header row like:
+
+```
+PersonId,PersonName,BrotherName
+```
+
+Notice how the 'BrotherName' is not prefixed with 'Person'
+
 ## Contributing
 
 1. Fork it

data/lib/relational_exporter.rb

@@ -58,7 +58,7 @@ module RelationalExporter
 
             # Add main record headers
             serialized_attributes(single).each do |field, value|
-              header_row << [main_klass.to_s.underscore, field].join('_').classify if csv.header_row?
+              header_row << csv_header_prefix_for_key(main_klass, field) if csv.header_row?
               row << value
             end
 
@@ -101,7 +101,7 @@ module RelationalExporter
 
                 max_associated.times do |i|
                   fields.each do |field|
-                    header_row << [association_klass.to_s.underscore, i+1, field].join('_').classify
+                    header_row << csv_header_prefix_for_key(association_klass, field, i+1)
                   end
                 end
               end
@@ -121,28 +121,36 @@ module RelationalExporter
 
     private
 
+    def csv_header_prefix_for_key(klass, key, index=nil)
+      if klass.respond_to?(:active_model_serializer) && !klass.active_model_serializer.nil? && klass.active_model_serializer.respond_to?(:csv_header_prefix_for_key)
+        header_prefix = klass.active_model_serializer.csv_header_prefix_for_key key.to_sym
+      else
+        header_prefix = klass.to_s
+      end
+
+      header_prefix + index.to_s + key.to_s.classify
+    end
+
     def serialized_attributes(object)
-      return nil if object.nil?
+      return {} if object.nil?
 
       klass, model = object.is_a?(Class) ? [object, object.first] : [object.class, object]
 
       return {} if model.nil?
 
       if model.respond_to?(:active_model_serializer) && !model.active_model_serializer.nil?
-        serialized = model.active_model_serializer.new(model).as_json(root: false) rescue nil
-      # elsif defined?(BaseSerializer)
-        # serialized = BaseSerializer.new(model).as_json(root: false) rescue nil
+        serialized = model.active_model_serializer.new(model).as_json(root: false)
       end
 
       serialized = model.attributes if serialized.nil?
       serialized
     end
 
-    def get_row_arr(records, fields, max_count=1, &block)
+    def get_row_arr(records, fields, max_count, &block)
       max_count.times do |i|
-        record = serialized_attributes records[i]
+        record = records[i].nil? ? {} : serialized_attributes(records[i])
         fields.each do |field|
-          val = record[field] rescue nil
+          val = record[field]
           yield val
         end
       end

data/lib/relational_exporter/version.rb

@@ -1,3 +1,3 @@
 module RelationalExporter
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relational_exporter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andrew Hammond
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-04 00:00:00.000000000 Z
+date: 2014-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie