cloudxls-rails 0.4.3 → 0.5.0

data/cloudxls-rails.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = CloudXLSRails::VERSION
 
-  gem.add_dependency('cloudxls', '~> 0.4.0')
+  gem.add_dependency('cloudxls', '~> 0.5.0')
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "webmock"

data/lib/cloudxls-rails/activemodel.rb

@@ -0,0 +1,88 @@
+require 'active_model/serialization'
+
+module ActiveModel
+  module Serializers
+    module CSV
+      include ActiveModel::Serialization
+
+      # Returns an array representing the model. Some configuration can be
+      # passed through +options+.
+      #
+      # Without any +options+, the returned Array will include all the model's
+      # attributes.
+      #
+      #     user = User.find(1)
+      #     user.as_csv
+      #     # => [1, "Konata Izumi", 16, "2006-08-01", true]
+      #
+      # The :only and :except options can be used to limit
+      # the attributes included, and work similar to the +attributes+ method.
+      #
+      #     user.as_csv(only: [:id, :name])
+      #     # => [1, "Konata Izumi"]
+      #
+      #     user.as_csv(except: [:id, :created_at, :age])
+      #     # => ["Konata Izumi", true]
+      #
+      # To include the result of some method calls on the model use :methods:
+      #
+      #     user.as_csv(methods: :permalink)
+      #     # => [1, "Konata Izumi", 16, "2006-08-01", true, "1-konata-izumi"]
+      #
+      def as_csv(options = nil)
+        options ||= {}
+
+        attribute_names = attributes.keys
+        if only = options[:only]
+          attribute_names = Array(only).map(&:to_s).select do |key|
+            attribute_names.include?(key)
+          end
+        elsif except = options[:except]
+          attribute_names -= Array(except).map(&:to_s)
+        end
+
+        arr = []
+        attribute_names.each do |n|
+          arr.push(read_attribute_for_serialization(n).as_csv)
+        end
+
+        Array(options[:methods]).each do |m|
+          if respond_to?(m)
+            val = send(m)
+            if idx = attribute_names.index(m.to_s)
+              arr[idx] = val
+            else
+              arr.push(val)
+            end
+          end
+        end
+
+        arr
+      end
+
+    private
+
+      # Hook method defining how an attribute value should be retrieved for
+      # serialization. By default this is assumed to be an instance named after
+      # the attribute. Override this method in subclasses should you need to
+      # retrieve the value for a given attribute differently:
+      #
+      #   class MyClass
+      #     include ActiveModel::Validations
+      #
+      #     def initialize(data = {})
+      #       @data = data
+      #     end
+      #
+      #     def read_attribute_for_serialization(key)
+      #       @data[key]
+      #     end
+      #   end
+      alias :read_attribute_for_serialization :send
+
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveModel::Serializers::CSV)
+

data/lib/cloudxls-rails/activesupport.rb

@@ -0,0 +1,9 @@
+require 'active_support/time_with_zone'
+
+module ActiveSupport
+  class TimeWithZone
+    def as_csv(options = nil)
+      to_datetime.as_csv
+    end
+  end
+end

data/lib/cloudxls-rails/handlers/csv.rb

@@ -33,12 +33,11 @@ end
 
 ActionController::Renderers.add :csv do |scope, options|
   filename = options.fetch(:filename, "data-#{DateTime.now.to_s}.csv")
-  columns  = options[:columns]
 
   if options[:stream]
     CloudXLSRails::CSVResponder.stream!(self, scope, options)
   else # no stream:
-    data = CloudXLS::CSVWriter.text(scope, {:columns => columns})
+    data = CloudXLS::CSVWriter.text(scope, options)
 
     send_data data,
       type: Mime::CSV,

data/lib/cloudxls-rails/handlers/xls.rb

@@ -6,13 +6,12 @@ end
 module CloudXLSRails
   class XLSResponder
     def self.redirect!(controller, scope, options)
-      columns  = options.fetch(:columns, nil)
       xdata = options[:data] || {}
       unless (xdata.has_key?(:text) ||
               xdata.has_key?(:url ) ||
               xdata.has_key?(:file)  )
 
-        xdata[:text] = CloudXLS::CSVWriter.text(scope, {:columns => columns})
+        xdata[:text] = CloudXLS::CSVWriter.text(scope, options)
       end
 
       xopts = {:data => xdata}

data/lib/cloudxls-rails/handlers/xlsx.rb

@@ -6,13 +6,12 @@ end
 module CloudXLSRails
   class XLSXResponder
     def self.redirect!(controller, scope, options)
-      columns  = options.fetch(:columns, nil)
       xdata = options[:data] || {}
       unless (xdata.has_key?(:text) ||
               xdata.has_key?(:url ) ||
               xdata.has_key?(:file)  )
 
-        xdata[:text] = CloudXLS::CSVWriter.text(scope, {:columns => columns})
+        xdata[:text] = CloudXLS::CSVWriter.text(scope, options)
       end
 
       xopts = {:data => xdata}

data/lib/cloudxls-rails/version.rb

@@ -1,3 +1,3 @@
 module CloudXLSRails
-  VERSION = '0.4.3'
+  VERSION = '0.5.0'
 end

data/lib/cloudxls-rails.rb

@@ -2,6 +2,8 @@ require 'cloudxls' # cloudxls gem
 
 require 'action_controller'
 require 'cloudxls-rails/version'
+require 'cloudxls-rails/activesupport'
+require 'cloudxls-rails/activemodel'
 require 'cloudxls-rails/handlers/csv'
 require 'cloudxls-rails/handlers/xls'
 require 'cloudxls-rails/handlers/xlsx'

data/spec/csv_writer_spec.rb

@@ -1,12 +1,58 @@
 require 'spec_helper'
 
+describe CloudXLS::Util do
+  describe "titles_for_serialize_options" do
+    it "should work with a Post.all" do
+      expect( CloudXLS::Util.titles_for_serialize_options(Post.new, :only => "title") ).to eq(["title"])
+    end
+  end
+end
+
 describe "CloudXLS::CSVWriter" do
   before do
     @writer = CloudXLS::CSVWriter
   end
 
   describe "with array" do
-    # spec'ed in cloudlxs-ruby gem
+    it "should not titleize" do
+      expect( @writer.text([['foo','bar'],[1,2]]) ).to eq("foo,bar\n1,2")
+    end
+
+    it "should escape titles" do
+      expect( @writer.text([['bar"baz']]) ).to eq("\"bar\"\"baz\"")
+    end
+
+    it "should escape rows" do
+      expect( @writer.text([['title'],['bar"baz']]) ).to eq("title\n\"bar\"\"baz\"")
+    end
+
+    it "should write YYYY-MM-DD for Date" do
+      expect( @writer.text([[Date.new(2012,12,24)]]) ).to eq("2012-12-24")
+    end
+
+    it "should write xmlschema for DateTime" do
+      # TODO: make UTC consistent
+      expect( DateTime.new(2012,12,24,18,30,5,'+0000').as_csv ).to eq("2012-12-24T18:30:05.000+0000")
+      expect( [DateTime.new(2012,12,24,18,30,5,'+0000')].as_csv ).to eq(["2012-12-24T18:30:05.000+0000"])
+      expect( @writer.text([[DateTime.new(2012,12,24,18,30,5,'+0000')]])             ).to eq("2012-12-24T18:30:05.000+0000")
+      expect( @writer.text([[DateTime.new(2012,12,24,18,30,5,'+0000').to_time.utc]]) ).to eq("2012-12-24T18:30:05.000+0000")
+    end
+
+    it "should write nothing for nil" do
+      expect( @writer.text([[nil,nil]]) ).to eq(",")
+    end
+
+    it "should write \"\" for empty string" do
+      expect( @writer.text([["",""]]) ).to eq('"",""')
+    end
+
+    it "should write integers" do
+      expect( @writer.text([[-1,0,1,1_000_000]]) ).to eq('-1,0,1,1000000')
+    end
+
+    it "should write floats" 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
@@ -22,29 +68,29 @@ describe "CloudXLS::CSVWriter" do
         :published       => false)
     end
 
-    it "given no records should just return titles" do
+    it "given no records returns empty string" do
       Post.delete_all
-      expect( @writer.text(Post.all, :columns => [:title, :visits]) ).to eq("Title,Visits")
+      expect( @writer.text(Post.all, :only => [:title, :visits]) ).to eq("")
     end
 
     it "should work with a Post.all" do
-      expect( @writer.text(Post.all, :columns => [:title, :visits]) ).to eq("Title,Visits\nhello world,12032")
+      expect( @writer.text(Post.all, :only => [: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")
+      expect( @writer.text(Post.limit(10), :only => [: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")
+      expect( @writer.text(Post.all.to_a, :only => [: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")
+      expect( @writer.text(Post.all, :only => [: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")
+      expect( @writer.text(Post.all, :only => [:published_on]) ).to eq("Published On\n2013-12-24")
     end
   end
 end

data/spec/integration_spec.rb

@@ -14,6 +14,13 @@ describe 'Request', :type => :request do
       :published => false)
   end
 
+  it "#as_csv" do
+    expect( @post.as_csv(except: [:unix_timestamp, :created_at, :updated_at]) ).to eq([@post.id, "hello world", 12_032, 0.24, "2013-12-24", "2013-12-25T12:30:30.000+0000", false])
+    expect( @post.as_csv(only: [:title]) ).to eq(["hello world"])
+    expect( @post.as_csv(only: [:title, :visits]) ).to eq(["hello world", 12_032])
+    expect( @post.as_csv(only: [:expired_at]) ).to eq(["2013-12-25T12:30:30.000+0000"])
+  end
+
   it "has a working test_app" do
     visit '/'
     page.should have_content "Users"
@@ -27,6 +34,14 @@ describe 'Request', :type => :request do
     ].join("\n")
   end
 
+  it "/posts/all_columns.csv streams csv" do
+    visit '/posts/all_columns.csv'
+    page.should have_content [
+      "Id,Title,Visits,Conversion Rate,Published On,Expired At,Published,Unix Timestamp,Created At,Updated At",
+      "1,hello world,12032,0.24,2013-12-24,2013-12-25T12:30:30.000+0000,false,2013-12-25T12:30:30.000+0000,#{@post.created_at.as_csv},#{@post.updated_at.as_csv}"
+    ].join("\n")
+  end
+
   it "/posts/stream.csv streams csv" do
     visit '/posts/stream.csv'
     page.should have_content [

data/spec/test_app/app/controllers/posts_controller.rb

@@ -3,19 +3,23 @@ class PostsController < ApplicationController
 
   def index
     respond_with(Post.all,
-      :columns => export_attributes)
+      :only => export_attributes)
+  end
+
+  def all_columns
+    respond_with(Post.all.to_a)
   end
 
   def stream
     respond_with(Post.all,
       :stream => true,
-      :columns => export_attributes)
+      :only => export_attributes)
   end
 
   def stream_with_custom_url
     respond_with(Post.all,
       :stream => "/successful_redirect",
-      :columns => export_attributes)
+      :only => export_attributes)
   end
 
   # Used for stub/mocking a redirect request

data/spec/test_app/config/routes.rb

@@ -3,6 +3,7 @@ TestApp::Application.routes.draw do
     collection do
       get "stream"
       get "stream_with_custom_url"
+      get "all_columns"
     end
   end
   get "successful_redirect" => "posts#successful_redirect"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudxls-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,8 @@ files:
 - Rakefile
 - cloudxls-rails.gemspec
 - lib/cloudxls-rails.rb
+- lib/cloudxls-rails/activemodel.rb
+- lib/cloudxls-rails/activesupport.rb
 - lib/cloudxls-rails/handlers/csv.rb
 - lib/cloudxls-rails/handlers/xls.rb
 - lib/cloudxls-rails/handlers/xlsx.rb