active_model_exporters 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0e8ae9df112adf65da8eaff2d6a8c45ab29c70a
+  data.tar.gz: 55d33fe90283de2aa7a5ec73769c1383908b1bdc
+SHA512:
+  metadata.gz: eabf725f796afc1a2f8a0fbf72b863fe1a15e553a3a23a25c78317bb1a3b996c46f0617e4d94fb82e9ba9609f91107fb82fd7a4b327bd5d1bd8de4fd2ee4ee20
+  data.tar.gz: c374e7f6852fdd95422dc9eb895174ef00766856e2b1ff1e1f7ab830be499175e947f7c1baedb82432be811c09049451f4c94ebcd5e53744ad8850cf8daf2756

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# CHANGELOG
+
+### Version 0.0.1
+* First version
+* Computed properties
+* Customized exporter

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'coveralls', require: false
+gem 'rails'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alejandro Gutiérrez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# ActiveModel::Exporters
+[![Build Status](https://travis-ci.org/alejandrogutierrez/active_model_exporters.png?branch=master)](https://travis-ci.org/alejandrogutierrez/active_model_exporters) [![Coverage Status](https://coveralls.io/repos/alejandrogutierrez/active_model_exporters/badge.png)](https://coveralls.io/r/alejandrogutierrez/active_model_exporters)
+
+`ActiveModel::Exporters` aims to provide an easy way to export
+collections of `ActiveModel` or `ActiveRecord` objects.
+It's based on object-oriented development and inspired on
+[active_model_serializers](https://github.com/rails-api/active_model_serializers).
+
+## Installation
+
+Add this line to your Gemfile:
+```ruby
+gem 'active_model_exporters'
+```
+Run the bundle command to install it.
+
+## Getting started
+
+Generate an exporter in `app/exporters/post_exporter.rb`:
+```ruby
+class PostExporter < ActiveModel::Exporter
+  attributes :id, :name, :email
+end
+```
+
+In your controller:
+```ruby
+class PostsController < ApplicationController
+  def index
+    @posts = Post.all
+
+    respond_to do |format|
+      format.csv { render csv: @posts }
+    end
+  end
+end
+```
+
+### Custom exporter
+To specify a custom exporter for an object, you can do the next:
+```ruby
+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
+
+  def full_name
+    "#{object.name} #{object.last_name}"
+  end
+end
+```
+
+## 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.
+
+Thank you :heart:

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test

data/active_model_exporters.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+$:.unshift File.expand_path("../lib", __FILE__)
+require 'active_model/exporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_model_exporters'
+  spec.version       = ActiveModel::Exporter::VERSION
+  spec.authors       = ['Alejandro Gutiérrez']
+  spec.email         = ['alejandrodevs@gmail.com']
+  spec.description   = 'A simple way to export data in Rails.'
+  spec.summary       = 'A simple way to export data in Rails.'
+  spec.homepage      = 'https://github.com/alejandrogutierrez/active_model_exporters'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'activemodel', '>= 3.2'
+  spec.add_development_dependency 'rails', '>= 3.2'
+end

data/lib/action_controller/exportation.rb

@@ -0,0 +1,28 @@
+module ActionController
+  module Exportation
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_exportation_scope
+      self._exportation_scope = :current_user
+    end
+
+    module ClassMethods
+      def exportation_scope(scope)
+        self._exportation_scope = scope
+      end
+    end
+
+    def _render_option_csv(resource, options)
+      exporter = build_exporter(resource, options)
+      exporter ? super(exporter, options) : super
+    end
+
+    private
+
+    def build_exporter(resource, options)
+      exporter = ActiveModel::Exporter.exporter_for(resource)
+      exporter.new(resource, options) if exporter
+    end
+  end
+end

data/lib/active_model/array_exporter.rb

@@ -0,0 +1,26 @@
+module ActiveModel
+  class ArrayExporter
+    attr_reader :collection, :exporter
+
+    def initialize(collection, options = {})
+      @collection = collection
+      @exporter   = options[:exporter]
+    end
+
+    def to_csv
+      CSV.generate do |file|
+        collection.each do |object|
+          exporter = exporter_for(object)
+          file << exporter.values
+        end
+      end
+    end
+
+    private
+
+    def exporter_for(object)
+      exporter_class = exporter || Exporter.exporter_for(object)
+      exporter_class.new(object)
+    end
+  end
+end

data/lib/active_model/exporter/version.rb

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

data/lib/active_model/exporter.rb

@@ -0,0 +1,41 @@
+module ActiveModel
+  class Exporter
+    class << self
+      attr_accessor :_attributes
+
+      def inherited(base)
+        base._attributes = (_attributes || []).dup
+      end
+
+      def attributes(*attrs)
+        @_attributes.concat(attrs)
+
+        attrs.each do |attr|
+          define_method(attr) do
+            object.send(attr)
+          end unless method_defined?(attr)
+        end
+      end
+
+      def exporter_for(resource)
+        if resource.respond_to?(:to_ary)
+          ArrayExporter
+        else
+          "#{resource.class.name}Exporter".safe_constantize
+        end
+      end
+    end
+
+
+    attr_accessor :object, :attributes
+
+    def initialize(object, options = {})
+      @object = object
+      @attributes = self.class._attributes.dup
+    end
+
+    def values
+      attributes.map { |attr| send(attr) }
+    end
+  end
+end

data/lib/active_model_exporters.rb

@@ -0,0 +1,18 @@
+require 'csv'
+require 'active_model'
+require 'active_model/exporter'
+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
+  end
+
+  ActiveSupport.on_load(:action_controller) do
+    include ::ActionController::Exportation
+  end
+end

data/test/fixtures/exporters.rb

@@ -0,0 +1,11 @@
+class UserExporter < ActiveModel::Exporter
+  attributes :first_name, :last_name, :full_name
+
+  def full_name
+    "#{object.first_name}-#{object.last_name}"
+  end
+end
+
+class FancyUserExporter < ActiveModel::Exporter
+  attributes :first_name, :last_name
+end

data/test/fixtures/models.rb

@@ -0,0 +1,6 @@
+class Model < OpenStruct
+  include ActiveModel
+end
+
+class User < Model
+end

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

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+module ActionController
+  module Exportation
+    class CSVTest < 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
+          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
+
+        def export_to_csv_with_other_exporter
+          render csv: [
+            User.new(first_name: 'Foo1', last_name: 'Bar1')
+          ], exporter: FancyUserExporter
+        end
+      end
+
+      tests TestsController
+
+      def test_export_to_csv
+        get :export_to_csv
+        assert_equal 'text/csv', @response.content_type
+        assert_equal "Foo1,Bar1,Foo1-Bar1\n", @response.body
+      end
+
+      def test_export_multiple_to_csv
+        get :export_multiple_to_csv
+        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
+
+      def test_export_to_csv_with_other_exporter
+        get :export_to_csv_with_other_exporter
+        assert_equal 'text/csv', @response.content_type
+        assert_equal "Foo1,Bar1\n", @response.body
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'ostruct'
+require 'action_controller'
+require 'active_model_exporters'
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/pride'
+require 'fixtures/models'
+require 'fixtures/exporters'
+
+module TestHelper
+  Routes = ActionDispatch::Routing::RouteSet.new
+  Routes.draw do
+    get ':controller(/:action(/:id))'
+    get ':controller(/:action)'
+  end
+
+  ActionController::Base.send(:include, Routes.url_helpers)
+end
+
+class ActionController::TestCase
+  def setup
+    @routes = TestHelper::Routes
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: active_model_exporters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alejandro Gutiérrez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A simple way to export data in Rails.
+email:
+- alejandrodevs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_model_exporters.gemspec
+- lib/action_controller/exportation.rb
+- lib/active_model/array_exporter.rb
+- lib/active_model/exporter.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/test_helper.rb
+homepage: https://github.com/alejandrogutierrez/active_model_exporters
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple way to export data in Rails.
+test_files:
+- test/fixtures/exporters.rb
+- test/fixtures/models.rb
+- test/integration/action_controller/exportation/csv_test.rb
+- test/test_helper.rb