cloudxls 0.4.0 → 0.5.0

data/lib/cloudxls/core_ext.rb

@@ -0,0 +1,106 @@
+# Object#as_csv ensures that object formats are written the same across ruby
+# versions.
+#
+# If an object is known to have issues cross-platform #as_json returns the
+# desired string.
+#
+# Example:
+#
+#      DateTime.now.as_csv # => "2012-12-24T12:30:01.000+0000"
+#      5.as_csv            # => 5
+#      (0.0/0.0).as_csv    # => "#DIV/0!"
+#
+
+class Time
+  def as_csv(options = nil)
+    strftime(CloudXLS::DATETIME_FORMAT)
+  end
+end
+
+class DateTime
+  def as_csv(options = nil)
+    strftime(CloudXLS::DATETIME_FORMAT)
+  end
+end
+
+class String
+  def as_csv(options = nil)
+    self
+  end
+end
+
+class Date
+  def as_csv(options = nil)
+    strftime(CloudXLS::DATE_FORMAT)
+  end
+end
+
+class NilClass
+  def as_csv(options = nil)
+    nil
+  end
+end
+
+class FalseClass
+  def as_csv(options = nil)
+    false
+  end
+end
+
+class TrueClass
+  def as_csv(options = nil)
+    true
+  end
+end
+
+class Symbol
+  def as_csv(options = nil)
+    to_s
+  end
+end
+
+class Numeric
+  def as_csv(options = nil)
+    self
+  end
+end
+
+class Float
+  # Encoding Infinity or NaN to JSON should return "null". The default returns
+  # "Infinity" or "NaN" which breaks parsing the JSON. E.g. JSON.parse('[NaN]').
+  def as_csv(options = nil) #:nodoc:
+    finite? ? self : "#DIV/0!"
+  end
+end
+
+class Regexp
+  def as_csv(options = nil)
+    to_s
+  end
+end
+
+module Enumerable
+  def as_csv(options = nil)
+    to_a.as_json(options)
+  end
+end
+
+class Range
+  def as_csv(options = nil)
+    to_s
+  end
+end
+
+class Array
+  def as_csv(options = nil)
+    map do |val|
+      val.as_csv(options)
+    end
+  end
+end
+
+class Object
+  def as_csv(options = nil)
+    to_s
+  end
+end

data/lib/cloudxls/csv_writer.rb

@@ -1,108 +1,139 @@
 require 'csv'
 
 module CloudXLS
-  class CSVWriter
-    DATETIME_FORMAT = "%FT%T.%L%z".freeze
-    DATE_FORMAT = "%F".freeze
+  DATETIME_FORMAT = "%FT%T.%L%z".freeze
+  DATE_FORMAT = "%F".freeze
+
+  # Wrapper around stdlib CSV methods.
+  #
+  class CSV
+    def self.generate_line(arr, options = nil)
+      ::CSV.generate_line(arr.as_csv, options)
+    end
+  end
 
+
+  class CSVWriter
     # Generates CSV string.
     #
-    # @param [Array<String/Symbol>] columns
+    # @param [Enumerable] scope
     #   Method/attribute keys to for the export.
     #
+    # @option opts [String] :encoding ("UTF-8")
+    #    Charset encoding of output.
+    #
+    # @option opts [Boolean] :skip_headers (false)
+    #    Do not output headers if first element is an ActiveRecord object.
+    #
+    # @option opts [Array]   :only     same as #as_json
+    # @option opts [Array]   :except   same as #as_json
+    # @option opts [Array]   :methods  same as #as_json
+    #
     # @return [String]
     #   The full CSV as a string. Titleizes *columns* for the header.
     #
-    def self.text(scope, options = {})
-      columns = options[:columns]
+    def self.text(scope, opts = {})
+      encoding     = opts.delete(:encoding)     || "UTF-8"
+      skip_headers = opts.delete(:skip_headers) || false
 
-      str = ::CSV.generate do |csv|
+      str = ::CSV.generate(:encoding => encoding) do |csv|
 
-        if options[:skip_headers] != true
-          if scope.respond_to?(:column_names)
-            columns ||= scope.column_names
-          end
-          if columns
-            csv << csv_titles(columns, :titleize)
+        enum_method = scope_enumerator(scope)
+        scope.send(enum_method) do |record|
+
+          if skip_headers == false && !record.is_a?(Array)
+            titles = CloudXLS::Util.titles_for_serialize_options(record, opts)
+            csv << titles.map(&:titleize)
+            skip_headers = true
           end
-        end
 
-        enum = scope_enumerator(scope)
-        scope.send(enum) do |record|
-          csv << csv_row(record, columns)
+          csv << record.as_csv(opts)
         end
       end
       str.strip!
+      str
     end
 
+
+    # Generates Enumerator for streaming response.
+    #
     # Example
     #
-    #     Post.csv_enumerator(Post.all, [:title, :author, :published_at])
+    #     def index
+    #       # setup headers...
+    #       stream = CloudXLS::CSVWriter.csv_enumerator(Post.all, only: [:title, :author])
+    #       self.response_body = stream
+    #     end
     #
-    # @param [ActiveRecord::Scope] scope
-    #   An activerecord scope object for the records to be exported.
-    #   Example: Post.all.limit(500).where(author: "foo")
+    # Same options and parameters as #text.
     #
     # @return [Enumerator] enumerator to use for streaming response.
     #
     def self.enumerator(scope, options = {})
-      columns = options[:columns]
-
-      Enumerator.new do |row|
-        if options[:skip_headers] != true
-          if scope.respond_to?(:column_names)
-            columns ||= scope.column_names
-          end
-          if columns
-            row << csv_titles(columns, :titleize).to_csv
-          end
-        end
-
-        enum = scope_enumerator(scope)
-        scope.send(enum) do |record|
-          row << csv_row(record, columns).to_csv
-        end
-      end
-    end
+      encoding     = options.delete(:encoding)     || "UTF-8"
+      skip_headers = options.delete(:skip_headers) || false
 
-  private
+      Enumerator.new do |stream|
+        enum_method = scope_enumerator(scope)
 
+        scope.send(enum_method) do |record|
+          if !skip_headers && !record.is_a?(Array)
+            titles = CloudXLS::Util.titles_for_serialize_options(record, options)
+            stream << titles.map(&:titleize).to_csv
+            skip_headers = true
+          end
 
-    def self.csv_row(obj, columns = [])
-      if obj.is_a?(Array)
-        obj.map{ |el| encode_for_csv(el) }
-      else
-        columns.map do |key|
-          encode_for_csv(obj.send(key))
+          stream << record.as_csv(options).to_csv
         end
       end
     end
 
 
-    def self.encode_for_csv(val)
-      case val
-      when DateTime,Time then val.strftime(DATETIME_FORMAT)
-      when Date          then val.strftime(DATE_FORMAT)
+    def self.scope_enumerator(scope)
+      if (scope.respond_to?(:arel) &&
+          scope.arel.orders.blank? &&
+          scope.arel.taken.blank?)
+        :find_each
       else
-        val
+        :each
       end
     end
+  end
+end
 
-    def self.csv_titles(column_names, strategy = :titleize)
-      column_names.map do |c|
-        title = c.to_s
-        title = title.send(strategy) if title.respond_to?(strategy)
-        title
+module CloudXLS
+  class Util
+    # Column and method-names of a model that correspond to the values from
+    # a #as_json/#as_csv call. In the same order.
+    #
+    # Example
+    #
+    #     CloudXLS::Util.titles_for_serialize_options(Post.new, only: [:author, :title], method: [:slug])
+    #     # => ['title', 'author', 'slug']
+    #
+    def self.titles_for_serialize_options(record, options = nil)
+      options ||= {}
+
+      attribute_names = record.attributes.keys
+      if only = options[:only]
+        arr = []
+        Array(only).map(&:to_s).each do |key|
+          arr.push(key) if attribute_names.include?(key)
+        end
+        attribute_names = arr
+      elsif except = options[:except]
+        attribute_names -= Array(except).map(&:to_s)
       end
-    end
 
-
-    def self.scope_enumerator(scope)
-      if scope.respond_to?(:find_each)
-        :find_each
-      else
-        :each
+      Array(options[:methods]).each do |m|
+        m = m.to_s
+        if record.respond_to?(m)
+          unless attribute_names.include?(m)
+            attribute_names.push(val)
+          end
+        end
       end
+      attribute_names
     end
   end
-end
+end

data/lib/cloudxls/version.rb

@@ -1,3 +1,3 @@
 module CloudXLS
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/cloudxls.rb

@@ -2,10 +2,12 @@ require 'cgi'
 require 'set'
 require 'openssl'
 require 'json'
+require 'date'
 require 'rest_client'
 require 'multi_json'
 
 require 'cloudxls/version'
+require 'cloudxls/core_ext'
 require 'cloudxls/csv_writer'
 
 module CloudXLS

data/spec/csv_writer_spec.rb

@@ -44,43 +44,4 @@ describe "CloudXLS::CSVWriter" do
       expect( @writer.text([[-1.0,0.0,1.0,1_000_000.0,1.234567]]) ).to eq('-1.0,0.0,1.0,1000000.0,1.234567')
     end
   end
-
-  # describe "#text with AR" do
-  #   before do
-  #     Post.delete_all
-  #     @post = Post.create(
-  #       :title           => "hello world",
-  #       :visits          => 12_032,
-  #       :conversion_rate => 0.24,
-  #       :published_on    => Date.new(2013,12,24),
-  #       :expired_at      => DateTime.new(2013,12,25,12,30,30),
-  #       :unix_timestamp  => DateTime.new(2013,12,25,12,30,30),
-  #       :published       => false)
-  #   end
-
-  #   it "given no records should just return titles" do
-  #     Post.delete_all
-  #     expect( @writer.text(Post.all, :columns => [:title, :visits]) ).to eq("Title,Visits")
-  #   end
-
-  #   it "should work with a Post.all" do
-  #     expect( @writer.text(Post.all, :columns => [:title, :visits]) ).to eq("Title,Visits\nhello world,12032")
-  #   end
-
-  #   it "should work with a Post.limit" do
-  #     expect( @writer.text(Post.limit(10), :columns => [:title, :visits]) ).to eq("Title,Visits\nhello world,12032")
-  #   end
-
-  #   it "should work with a Post.all.to_a" do
-  #     expect( @writer.text(Post.all.to_a, :columns => [:title, :visits]) ).to eq("Title,Visits\nhello world,12032")
-  #   end
-
-  #   it "should write xmlschema for DateTime" do
-  #     expect( @writer.text(Post.all, :columns => [:expired_at]) ).to eq("Expired At\n2013-12-25T12:30:30.000+0000")
-  #   end
-
-  #   it "should write YYYY-MM-DD for Date" do
-  #     expect( @writer.text(Post.all, :columns => [:published_on]) ).to eq("Published On\n2013-12-24")
-  #   end
-  # end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudxls
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-20 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -110,6 +110,7 @@ files:
 - Rakefile
 - cloudxls.gemspec
 - lib/cloudxls.rb
+- lib/cloudxls/core_ext.rb
 - lib/cloudxls/csv_writer.rb
 - lib/cloudxls/version.rb
 - lib/data/ca-certificates.txt