active_model_exporters 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f372c93931a76bf7ab6d04a611006f79ef7501b5
-  data.tar.gz: 60027e0b93ee046ca7e72f7abc832a31877a01ac
+  metadata.gz: 30a964ee00e6f0e49c06fafa36d234ecc9f0c830
+  data.tar.gz: 4e4ccce791d424d0bc328a8233e3c7b71c624ad8
 SHA512:
-  metadata.gz: 7c2b8f26b473902a504ee2282b03aef6c4fcb1959da569f4a7e9e48708d2343613f9e6bc813d236cad23d8eae751558436e7ac9a73ca5f5a7897beedbcadd13e
-  data.tar.gz: 72db327f1475d63435a5f7035fdc16842c3e2a52288432245d0ddf0b861b43bd0fb614db8cd34a95287db2d7ad70fed7f84f5898ef863ee48f2ec92d06db68eb
+  metadata.gz: d7343fe3ab75b28039cea63a2a46a2cb3c076427ab550c06305fb60a15366a82fd068d02f1d8f1e1c696449f4d3c30123fb83a7f44a560b1e227737e2d539363
+  data.tar.gz: 059e57436e2e4d0fd1ac4fc9f1682d71c87660e5f20261ce192e6076328fd38fafb91082b20d605de7a82f03618eb242c8c20755cb5c531e4527d419861de1c3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+### Version 0.0.5
+* Using send_data method
+* Customizable filename
+* Customizable encode format
+
 ### Version 0.0.4
 * Exporting to XLS format
 
@@ -14,4 +19,4 @@
 ### Version 0.0.1
 * First version
 * Computed properties
-* Customized exporter
+* Customizable exporter

data/README.md

@@ -50,11 +50,24 @@ end
 ```
 
 ### Custom exporter
-To specify a custom exporter for an object, you can do the next in your controller:
+To specify a custom exporter for each object, you can do the next in your controller:
 ```ruby
 render csv: @posts, exporter: OtherPostExporter
 ```
 
+### Custom filename
+By default filename is the pluralized collection type. Example: `posts.xls`.
+To specify another, you can do the next:
+```ruby
+render xls: @posts, filename: 'super_posts.xls'
+```
+
+### Custom encode format
+By default encode format is `iso-8859-1`. You can change it doing the next:
+```ruby
+render csv: @posts, encode: 'UTF-8'
+```
+
 ### Computed properties
 As `ActiveModel::Serializers` does, you can access the object being exported as `object`.
 ```ruby
@@ -84,7 +97,7 @@ end
 #### 2. Explicit scope
 In your controller, include the scope option:
 ```ruby
-render csv: @posts, scope: :current_admin
+render csv: @posts, scope: current_admin
 ```
 
 #### 3. Calling exportation_scope

data/lib/action_controller/exportation/mime_types.rb

@@ -0,0 +1 @@
+Mime::Type.register('application/vnd.ms-excel', :xls)

data/lib/action_controller/exportation/renderers.rb

@@ -0,0 +1,16 @@
+ActiveModel::Exporter::TYPES.each do |type|
+  ActionController::Renderers.add type do |resource, options|
+    method = "to_#{type}".to_sym
+
+    if resource.respond_to?(method)
+      encode = options[:encode] || 'iso-8859-1'
+      mtype  = "Mime::#{type.upcase}".safe_constantize
+      file   = resource.send(method).encode(encode)
+
+      default_options = {type: mtype, disposition: 'attachment'}
+      send_data(file, default_options.merge(options))
+    else
+      resource
+    end
+  end
+end

data/lib/active_model/array_exporter.rb

@@ -16,15 +16,12 @@ module ActiveModel
       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
+          file << exporter_for(object).values
         end
-      end.encode('ISO-8859-1')
+      end
     end
 
     private

data/lib/active_model/exporter/types.rb

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

data/lib/active_model/exporter/version.rb

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

data/lib/active_model_exporters.rb

@@ -7,17 +7,8 @@ require 'active_model/exporter/version'
 
 if defined?(ActionController)
   require 'action_controller/exportation'
-
-  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
+  require 'action_controller/exportation/mime_types'
+  require 'action_controller/exportation/renderers'
 
   ActiveSupport.on_load(:action_controller) do
     include ::ActionController::Exportation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_exporters
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Alejandro Gutiérrez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -54,6 +54,8 @@ files:
 - Rakefile
 - active_model_exporters.gemspec
 - lib/action_controller/exportation.rb
+- lib/action_controller/exportation/mime_types.rb
+- lib/action_controller/exportation/renderers.rb
 - lib/active_model/array_exporter.rb
 - lib/active_model/exporter.rb
 - lib/active_model/exporter/types.rb
@@ -63,7 +65,6 @@ files:
 - 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:
@@ -94,5 +95,4 @@ test_files:
 - 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

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

@@ -1,139 +0,0 @@
-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