active_model_exporters 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84de92b3db98397f7183d12a226532ca12ec0bda
-  data.tar.gz: abd93136ae604559252ec400d2c2a50763e97f69
+  metadata.gz: f372c93931a76bf7ab6d04a611006f79ef7501b5
+  data.tar.gz: 60027e0b93ee046ca7e72f7abc832a31877a01ac
 SHA512:
-  metadata.gz: a3bdd3fe7121e68e29cc4f9bdf25df780c7ffd321f48f0e8642b449f74efa7d749aca74e32e570e4302dd1e383fa23306d4606a1e4006ca3b34ff3259209de1f
-  data.tar.gz: 9e44063c9a4293d361c0068c8e52d214257fe659f97925f354744bafd3e678230d48b9786c8666767e57beaab1d3bc71c6fe5d60b3f6909e5312656ecf27f7f5
+  metadata.gz: 7c2b8f26b473902a504ee2282b03aef6c4fcb1959da569f4a7e9e48708d2343613f9e6bc813d236cad23d8eae751558436e7ac9a73ca5f5a7897beedbcadd13e
+  data.tar.gz: 72db327f1475d63435a5f7035fdc16842c3e2a52288432245d0ddf0b861b43bd0fb614db8cd34a95287db2d7ad70fed7f84f5898ef863ee48f2ec92d06db68eb

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+### Version 0.0.4
+* Exporting to XLS format
+
 ### Version 0.0.3
 * Adding filter method
 

data/README.md

@@ -31,6 +31,7 @@ class PostsController < ApplicationController
 
     respond_to do |format|
       format.csv { render csv: @posts }
+      format.xls { render xls: @posts }
     end
   end
 end
@@ -39,7 +40,7 @@ end
 Or:
 ```ruby
 class PostsController < ApplicationController
-  respond_to :csv
+  respond_to :csv, :xls
 
   def index
     @posts = Post.all

data/lib/action_controller/exportation.rb

@@ -13,9 +13,11 @@ module ActionController
       end
     end
 
-    def _render_option_csv(resource, options)
-      exporter = build_exporter(resource, options)
-      exporter ? super(exporter, options) : super
+    ActiveModel::Exporter::TYPES.each do |type|
+      define_method "_render_option_#{type}" do |resource, options|
+        exporter = build_exporter(resource, options)
+        exporter ? super(exporter, options) : super
+      end
     end
 
     private

data/lib/active_model/array_exporter.rb

@@ -4,17 +4,27 @@ module ActiveModel
 
     def initialize(collection, options = {})
       @collection = collection
-      @scope      = options[:scope]
-      @exporter   = options[:exporter]
+      @scope      = options.delete(:scope)
+      @exporter   = options.delete(:exporter)
     end
 
     def to_csv
-      CSV.generate do |file|
+      generate_file
+    end
+
+    def to_xls
+      generate_file(col_sep: "\t")
+    end
+
+    alias :to_xlsx :to_xls
+
+    def generate_file(options = {})
+      CSV.generate(options) do |file|
         collection.each do |object|
           exporter = exporter_for(object)
           file << exporter.values
         end
-      end
+      end.encode('ISO-8859-1')
     end
 
     private

data/lib/active_model/exporter/types.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  class Exporter
+    TYPES = [:csv, :xls, :xlsx]
+  end
+end

data/lib/active_model/exporter/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   class Exporter
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/lib/active_model_exporters.rb

@@ -1,15 +1,22 @@
 require 'csv'
 require 'active_model'
 require 'active_model/exporter'
+require 'active_model/exporter/types'
 require 'active_model/array_exporter'
 require 'active_model/exporter/version'
 
 if defined?(ActionController)
   require 'action_controller/exportation'
 
-  ActionController::Renderers.add :csv do |csv, options|
-    self.content_type ||= Mime::CSV
-    csv.respond_to?(:to_csv) ? csv.to_csv : csv
+  Mime::Type.register('application/vnd.ms-excel', :xls)
+  Mime::Type.register('application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', :xlsx)
+
+  ActiveModel::Exporter::TYPES.each do |type|
+    ActionController::Renderers.add type do |resource, options|
+      method = "to_#{type}".to_sym
+      self.content_type ||= "Mime::#{type.upcase}".safe_constantize
+      resource.respond_to?(method) ? resource.send(method) : resource
+    end
   end
 
   ActiveSupport.on_load(:action_controller) do

data/test/integration/action_controller/exportation/csv_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 module ActionController
-  module Exportation
+  module Exportation::CSV
     class ImplicitExporterTest < ActionController::TestCase
       class TestsController < ActionController::Base
         def render_using_implicit_exporter

data/test/integration/action_controller/exportation/xls_test.rb

@@ -0,0 +1,139 @@
+require 'test_helper'
+
+module ActionController
+  module Exportation::XLS
+    class ImplicitExporterTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_implicit_exporter
+          render xls: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1'),
+            User.new(first_name: 'Foo2', last_name: 'Bar2'),
+            User.new(first_name: 'Foo3', last_name: 'Bar3')
+          ]
+        end
+      end
+
+      tests TestsController
+
+      def test_render_using_implicit_exporter
+        get :render_using_implicit_exporter
+        assert_equal 'application/vnd.ms-excel', @response.content_type
+        assert_equal "Foo1\tBar1\tFoo1-Bar1\n"\
+                     "Foo2\tBar2\tFoo2-Bar2\n"\
+                     "Foo3\tBar3\tFoo3-Bar3\n", @response.body
+      end
+    end
+
+    class ExplicitExporterTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_explicit_exporter
+          render xls: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ], exporter: FancyUserExporter
+        end
+      end
+
+      tests TestsController
+
+      def test_render_using_explicit_exporter
+        get :render_using_explicit_exporter
+        assert_equal 'application/vnd.ms-excel', @response.content_type
+        assert_equal "Foo1\tBar1\n", @response.body
+      end
+    end
+
+    class ImplicitExportationScopeTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_implicit_exportation_scope
+          render xls: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ]
+        end
+
+        private
+
+        def current_user
+          'current_user'
+        end
+      end
+
+      tests TestsController
+
+      def test_render_using_implicit_exportation_scope
+        get :render_using_implicit_exportation_scope
+        assert_equal 'application/vnd.ms-excel', @response.content_type
+        assert_equal "Foo1\tBar1\tFoo1-Bar1-current_user\n", @response.body
+      end
+    end
+
+    class ExplicitExportationScopeTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_explicit_exportation_scope
+          render xls: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ], scope: current_admin
+        end
+
+        private
+
+        def current_admin
+          'current_admin'
+        end
+      end
+
+      tests TestsController
+
+      def test_render_using_explicit_exportation_scope
+        get :render_using_explicit_exportation_scope
+        assert_equal 'application/vnd.ms-excel', @response.content_type
+        assert_equal "Foo1\tBar1\tFoo1-Bar1-current_admin\n", @response.body
+      end
+    end
+
+    class CallingExportationScopeTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        exportation_scope :current_admin
+
+        def render_calling_exportation_scope
+          render xls: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ]
+        end
+
+        private
+
+        def current_admin
+          'current_admin'
+        end
+      end
+
+      tests TestsController
+
+      def test_render_calling_exportation_scope
+        get :render_calling_exportation_scope
+        assert_equal 'application/vnd.ms-excel', @response.content_type
+        assert_equal "Foo1\tBar1\tFoo1-Bar1-current_admin\n", @response.body
+      end
+    end
+
+    class UsingFilterAttributesTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_filter_attributes
+          render xls: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1', email: 'FooBar1'),
+            User.new(first_name: 'Foo2', last_name: 'Bar2', email: 'FooBar2')
+          ], exporter: FilterUserExporter
+        end
+      end
+
+      tests TestsController
+
+      def test_render_using_filter_attributes
+        get :render_using_filter_attributes
+        assert_equal 'application/vnd.ms-excel', @response.content_type
+        assert_equal "Foo1\t\tFooBar1\n"\
+                     "Foo2\tBar2\tFooBar2\n", @response.body
+      end
+    end
+  end
+end

data/test/integration/action_controller/exportation/xlsx_test.rb

@@ -0,0 +1,139 @@
+require 'test_helper'
+
+module ActionController
+  module Exportation::XLSX
+    class ImplicitExporterTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_implicit_exporter
+          render xlsx: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1'),
+            User.new(first_name: 'Foo2', last_name: 'Bar2'),
+            User.new(first_name: 'Foo3', last_name: 'Bar3')
+          ]
+        end
+      end
+
+      tests TestsController
+
+      def test_render_using_implicit_exporter
+        get :render_using_implicit_exporter
+        assert_equal 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', @response.content_type
+        assert_equal "Foo1\tBar1\tFoo1-Bar1\n"\
+                     "Foo2\tBar2\tFoo2-Bar2\n"\
+                     "Foo3\tBar3\tFoo3-Bar3\n", @response.body
+      end
+    end
+
+    class ExplicitExporterTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_explicit_exporter
+          render xlsx: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ], exporter: FancyUserExporter
+        end
+      end
+
+      tests TestsController
+
+      def test_render_using_explicit_exporter
+        get :render_using_explicit_exporter
+        assert_equal 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', @response.content_type
+        assert_equal "Foo1\tBar1\n", @response.body
+      end
+    end
+
+    class ImplicitExportationScopeTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_implicit_exportation_scope
+          render xlsx: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ]
+        end
+
+        private
+
+        def current_user
+          'current_user'
+        end
+      end
+
+      tests TestsController
+
+      def test_render_using_implicit_exportation_scope
+        get :render_using_implicit_exportation_scope
+        assert_equal 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', @response.content_type
+        assert_equal "Foo1\tBar1\tFoo1-Bar1-current_user\n", @response.body
+      end
+    end
+
+    class ExplicitExportationScopeTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_explicit_exportation_scope
+          render xlsx: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ], scope: current_admin
+        end
+
+        private
+
+        def current_admin
+          'current_admin'
+        end
+      end
+
+      tests TestsController
+
+      def test_render_using_explicit_exportation_scope
+        get :render_using_explicit_exportation_scope
+        assert_equal 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', @response.content_type
+        assert_equal "Foo1\tBar1\tFoo1-Bar1-current_admin\n", @response.body
+      end
+    end
+
+    class CallingExportationScopeTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        exportation_scope :current_admin
+
+        def render_calling_exportation_scope
+          render xlsx: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ]
+        end
+
+        private
+
+        def current_admin
+          'current_admin'
+        end
+      end
+
+      tests TestsController
+
+      def test_render_calling_exportation_scope
+        get :render_calling_exportation_scope
+        assert_equal 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', @response.content_type
+        assert_equal "Foo1\tBar1\tFoo1-Bar1-current_admin\n", @response.body
+      end
+    end
+
+    class UsingFilterAttributesTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_filter_attributes
+          render xlsx: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1', email: 'FooBar1'),
+            User.new(first_name: 'Foo2', last_name: 'Bar2', email: 'FooBar2')
+          ], exporter: FilterUserExporter
+        end
+      end
+
+      tests TestsController
+
+      def test_render_using_filter_attributes
+        get :render_using_filter_attributes
+        assert_equal 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', @response.content_type
+        assert_equal "Foo1\t\tFooBar1\n"\
+                     "Foo2\tBar2\tFooBar2\n", @response.body
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_exporters
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alejandro Gutiérrez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -56,11 +56,14 @@ files:
 - lib/action_controller/exportation.rb
 - lib/active_model/array_exporter.rb
 - lib/active_model/exporter.rb
+- lib/active_model/exporter/types.rb
 - lib/active_model/exporter/version.rb
 - lib/active_model_exporters.rb
 - test/fixtures/exporters.rb
 - test/fixtures/models.rb
 - test/integration/action_controller/exportation/csv_test.rb
+- test/integration/action_controller/exportation/xls_test.rb
+- test/integration/action_controller/exportation/xlsx_test.rb
 - test/test_helper.rb
 homepage: https://github.com/alejandrogutierrez/active_model_exporters
 licenses:
@@ -90,4 +93,6 @@ test_files:
 - test/fixtures/exporters.rb
 - test/fixtures/models.rb
 - test/integration/action_controller/exportation/csv_test.rb
+- test/integration/action_controller/exportation/xls_test.rb
+- test/integration/action_controller/exportation/xlsx_test.rb
 - test/test_helper.rb