active_model_exporters 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0e8ae9df112adf65da8eaff2d6a8c45ab29c70a
-  data.tar.gz: 55d33fe90283de2aa7a5ec73769c1383908b1bdc
+  metadata.gz: fa0b27aca8f2ae7ea3c947b3ba0b7c757acbf006
+  data.tar.gz: b39a7542040b7dbbf246eaa3151247567b8ce035
 SHA512:
-  metadata.gz: eabf725f796afc1a2f8a0fbf72b863fe1a15e553a3a23a25c78317bb1a3b996c46f0617e4d94fb82e9ba9609f91107fb82fd7a4b327bd5d1bd8de4fd2ee4ee20
-  data.tar.gz: c374e7f6852fdd95422dc9eb895174ef00766856e2b1ff1e1f7ab830be499175e947f7c1baedb82432be811c09049451f4c94ebcd5e53744ad8850cf8daf2756
+  metadata.gz: 536d772d63c5341f6729ba1c7084aa1eea74f379a73759620c064f7640010ac95f9f36b8fd28137f14f12f3df6ca27beb035ccf1861af68cdc0ecd150d439138
+  data.tar.gz: 396b4cff045ae6de02a669d5a47d782c3e060214ee265752461dfeb91978f0fee1f48e4e8a39b18b34b184a8b037040bdb81959928b5fe8db77c8d2b9e428e6e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+### Version 0.0.2
+* Default current_user scope
+* Explicit exportation scope
+* Scope calling exportation_scope
+
 ### Version 0.0.1
 * First version
 * Computed properties

data/README.md

@@ -19,7 +19,7 @@ Run the bundle command to install it.
 Generate an exporter in `app/exporters/post_exporter.rb`:
 ```ruby
 class PostExporter < ActiveModel::Exporter
-  attributes :id, :name, :email
+  attributes :id, :title, :content
 end
 ```
 
@@ -36,8 +36,20 @@ class PostsController < ApplicationController
 end
 ```
 
+Or:
+```ruby
+class PostsController < ApplicationController
+  respond_to :csv
+
+  def index
+    @posts = Post.all
+    respond_with @posts
+  end
+end
+```
+
 ### Custom exporter
-To specify a custom exporter for an object, you can do the next:
+To specify a custom exporter for an object, you can do the next in your controller:
 ```ruby
 render csv: @posts, exporter: OtherPostExporter
 ```
@@ -45,11 +57,43 @@ render csv: @posts, exporter: OtherPostExporter
 ### Computed properties
 As `ActiveModel::Serializers` does, you can access the object being exported as `object`.
 ```ruby
-class PostExporter < ActiveModel::Exporter
-  attributes :id, :name, :full_name
+class UserExporter < ActiveModel::Exporter
+  attributes :first_name, :last_name, :full_name
 
   def full_name
-    "#{object.name} #{object.last_name}"
+    "#{object.first_name} #{object.last_name}"
+  end
+end
+```
+
+### Exporter scope
+
+#### 1. Default scope
+As `ActiveModel::Serializers` does, you can access to the current user application via `scope`.
+```ruby
+class UserExporter < ActiveModel::Exporter
+  attributes :name, :email
+
+  def email
+    object.name unless scope.admin?
+  end
+end
+```
+
+#### 2. Explicit scope
+In your controller, include the scope option:
+```ruby
+render csv: @posts, scope: :current_admin
+```
+
+#### 3. Calling exportation_scope
+In your controller, set the exportation scope:
+```ruby
+class PostsController < ApplicationController
+  exportation_scope :current_admin
+
+  def index
+    # Do something...
   end
 end
 ```

data/lib/action_controller/exportation.rb

@@ -20,9 +20,16 @@ module ActionController
 
     private
 
+    def exportation_scope
+      scope = self.class._exportation_scope
+      send(scope) if scope && respond_to?(scope, true)
+    end
+
     def build_exporter(resource, options)
-      exporter = ActiveModel::Exporter.exporter_for(resource)
-      exporter.new(resource, options) if exporter
+      if exporter = ActiveModel::Exporter.exporter_for(resource)
+        options[:scope] ||= exportation_scope
+        exporter.new(resource, options)
+      end
     end
   end
 end

data/lib/active_model/array_exporter.rb

@@ -1,9 +1,10 @@
 module ActiveModel
   class ArrayExporter
-    attr_reader :collection, :exporter
+    attr_reader :collection, :exporter, :scope
 
     def initialize(collection, options = {})
       @collection = collection
+      @scope      = options[:scope]
       @exporter   = options[:exporter]
     end
 
@@ -20,7 +21,7 @@ module ActiveModel
 
     def exporter_for(object)
       exporter_class = exporter || Exporter.exporter_for(object)
-      exporter_class.new(object)
+      exporter_class.new(object, scope: scope)
     end
   end
 end

data/lib/active_model/exporter/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   class Exporter
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

data/lib/active_model/exporter.rb

@@ -27,10 +27,11 @@ module ActiveModel
     end
 
 
-    attr_accessor :object, :attributes
+    attr_accessor :object, :attributes, :scope
 
     def initialize(object, options = {})
-      @object = object
+      @object     = object
+      @scope      = options[:scope]
       @attributes = self.class._attributes.dup
     end
 

data/test/fixtures/exporters.rb

@@ -2,7 +2,7 @@ class UserExporter < ActiveModel::Exporter
   attributes :first_name, :last_name, :full_name
 
   def full_name
-    "#{object.first_name}-#{object.last_name}"
+    "#{object.first_name}-#{object.last_name}#{scope ? "-#{scope}" : ''}"
   end
 end
 

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

@@ -2,23 +2,31 @@ require 'test_helper'
 
 module ActionController
   module Exportation
-    class CSVTest < ActionController::TestCase
+    class ImplicitExporterTest < ActionController::TestCase
       class TestsController < ActionController::Base
-        def export_to_csv
-          render csv: [
-            User.new(first_name: 'Foo1', last_name: 'Bar1')
-          ]
-        end
-
-        def export_multiple_to_csv
+        def render_using_implicit_exporter
           render csv: [
             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 export_to_csv_with_other_exporter
+      def test_render_using_implicit_exporter
+        get :render_using_implicit_exporter
+        assert_equal 'text/csv', @response.content_type
+        assert_equal "Foo1,Bar1,Foo1-Bar1\n"\
+                     "Foo2,Bar2,Foo2-Bar2\n"\
+                     "Foo3,Bar3,Foo3-Bar3\n", @response.body
+      end
+    end
+
+    class ExplicitExporterTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_explicit_exporter
           render csv: [
             User.new(first_name: 'Foo1', last_name: 'Bar1')
           ], exporter: FancyUserExporter
@@ -27,24 +35,84 @@ module ActionController
 
       tests TestsController
 
-      def test_export_to_csv
-        get :export_to_csv
+      def test_render_using_explicit_exporter
+        get :render_using_explicit_exporter
         assert_equal 'text/csv', @response.content_type
-        assert_equal "Foo1,Bar1,Foo1-Bar1\n", @response.body
+        assert_equal "Foo1,Bar1\n", @response.body
+      end
+    end
+
+    class ImplicitExportationScopeTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_implicit_exportation_scope
+          render csv: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ]
+        end
+
+        private
+
+        def current_user
+          'current_user'
+        end
       end
 
-      def test_export_multiple_to_csv
-        get :export_multiple_to_csv
+      tests TestsController
+
+      def test_render_using_implicit_exportation_scope
+        get :render_using_implicit_exportation_scope
         assert_equal 'text/csv', @response.content_type
-        assert_equal "Foo1,Bar1,Foo1-Bar1\n"\
-                     "Foo2,Bar2,Foo2-Bar2\n"\
-                     "Foo3,Bar3,Foo3-Bar3\n", @response.body
+        assert_equal "Foo1,Bar1,Foo1-Bar1-current_user\n", @response.body
+      end
+    end
+
+    class ExplicitExportationScopeTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_explicit_exportation_scope
+          render csv: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ], scope: current_admin
+        end
+
+        private
+
+        def current_admin
+          'current_admin'
+        end
       end
 
-      def test_export_to_csv_with_other_exporter
-        get :export_to_csv_with_other_exporter
+      tests TestsController
+
+      def test_render_using_explicit_exportation_scope
+        get :render_using_explicit_exportation_scope
         assert_equal 'text/csv', @response.content_type
-        assert_equal "Foo1,Bar1\n", @response.body
+        assert_equal "Foo1,Bar1,Foo1-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 csv: [
+            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 'text/csv', @response.content_type
+        assert_equal "Foo1,Bar1,Foo1-Bar1-current_admin\n", @response.body
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_exporters
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alejandro Gutiérrez