active_model_exporters 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa0b27aca8f2ae7ea3c947b3ba0b7c757acbf006
-  data.tar.gz: b39a7542040b7dbbf246eaa3151247567b8ce035
+  metadata.gz: 84de92b3db98397f7183d12a226532ca12ec0bda
+  data.tar.gz: abd93136ae604559252ec400d2c2a50763e97f69
 SHA512:
-  metadata.gz: 536d772d63c5341f6729ba1c7084aa1eea74f379a73759620c064f7640010ac95f9f36b8fd28137f14f12f3df6ca27beb035ccf1861af68cdc0ecd150d439138
-  data.tar.gz: 396b4cff045ae6de02a669d5a47d782c3e060214ee265752461dfeb91978f0fee1f48e4e8a39b18b34b184a8b037040bdb81959928b5fe8db77c8d2b9e428e6e
+  metadata.gz: a3bdd3fe7121e68e29cc4f9bdf25df780c7ffd321f48f0e8642b449f74efa7d749aca74e32e570e4302dd1e383fa23306d4606a1e4006ca3b34ff3259209de1f
+  data.tar.gz: 9e44063c9a4293d361c0068c8e52d214257fe659f97925f354744bafd3e678230d48b9786c8666767e57beaab1d3bc71c6fe5d60b3f6909e5312656ecf27f7f5

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+### Version 0.0.3
+* Adding filter method
+
 ### Version 0.0.2
 * Default current_user scope
 * Explicit exportation scope

data/README.md

@@ -75,7 +75,7 @@ class UserExporter < ActiveModel::Exporter
   attributes :name, :email
 
   def email
-    object.name unless scope.admin?
+    object.email unless scope.admin?
   end
 end
 ```
@@ -98,6 +98,25 @@ class PostsController < ApplicationController
 end
 ```
 
+### Filter attributes
+As `ActiveModel::Serializers` does, you can reject some attributes
+according to your business rules:
+```ruby
+class UserExporter < ActiveModel::Exporter
+  attributes :name, :email, :address
+
+  def filter(attrs)
+    if object.admin?
+      attrs - [:address]
+    else
+      attrs
+    end
+  end
+end
+```
+Rejected attributes will be blank in the downloaded file.
+
+
 ## Contributing
 
 New feature or code refactoring? Submit a pull request that implements it. Don't forget to write your tests and include a CHANGELOG with your updates.

data/lib/active_model/exporter.rb

@@ -27,16 +27,26 @@ module ActiveModel
     end
 
 
-    attr_accessor :object, :attributes, :scope
+    attr_accessor :object, :scope
 
     def initialize(object, options = {})
-      @object     = object
-      @scope      = options[:scope]
-      @attributes = self.class._attributes.dup
+      @object = object
+      @scope  = options[:scope]
     end
 
     def values
-      attributes.map { |attr| send(attr) }
+      attrs = filter(attributes)
+      attributes.map { |attr| send(attr) if attrs.include?(attr) }
+    end
+
+    def filter(attrs)
+      attrs
+    end
+
+    private
+
+    def attributes
+      self.class._attributes.dup
     end
   end
 end

data/lib/active_model/exporter/version.rb

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

data/test/fixtures/exporters.rb

@@ -9,3 +9,15 @@ end
 class FancyUserExporter < ActiveModel::Exporter
   attributes :first_name, :last_name
 end
+
+class FilterUserExporter < ActiveModel::Exporter
+  attributes :first_name, :last_name, :email
+
+  def filter(attrs)
+    if object.last_name == 'Bar1'
+      attrs - [:last_name]
+    else
+      attrs
+    end
+  end
+end

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

@@ -115,5 +115,25 @@ module ActionController
         assert_equal "Foo1,Bar1,Foo1-Bar1-current_admin\n", @response.body
       end
     end
+
+    class UsingFilterAttributesTest < ActionController::TestCase
+      class TestsController < ActionController::Base
+        def render_using_filter_attributes
+          render csv: [
+            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 'text/csv', @response.content_type
+        assert_equal "Foo1,,FooBar1\n"\
+                     "Foo2,Bar2,FooBar2\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.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alejandro Gutiérrez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-27 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel