active_model_exporters 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 03178fbe3efee04338ae0b983c1735ab8210bbae
-  data.tar.gz: 5c817ded73966c108483d1b9267a27118b952603
+SHA256:
+  metadata.gz: a2668e81feb94e20b496c164c3685971953f0144819230cb81b0d42e00b6d3ab
+  data.tar.gz: 3dd86e1588cd35816828a6657c14d118cfceede16bb47c462e5e40f6902a8ec0
 SHA512:
-  metadata.gz: 8fbf388b7903dedf9b430f5f132182f8ed31ce941de76fd08fd1990dd0a8bd2304e2b96ea099942c7faaa67c562e54b6d268c0d3040bb89405f9a4b41ae600f9
-  data.tar.gz: bdc49d7d07bf6bafa4a6454d9ff7e2ca292e196891a6f86463b6ed0bfaff370abf576211a5106fe9591285bd4cb286366d1d7de313ce6e7f295ad937e88fa7dd
+  metadata.gz: 9e608871ec7e7170ba105ffd70e54f55d543cee670d4fa744f1b0b64f185a995d6fa394ebd79c91de4a30889b906156f54d6d163e16370f8e02094fb6f540730
+  data.tar.gz: 40652890a32acdbb4f25fe434b531d406ad356f32917066e2ca068e22878b35e35f8039dd3cdbec5863ac7b91f5024ac15d1adaafaadc5eb421f2f72a0c0a94e

data/.gitignore

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

data/.travis.yml

@@ -1,7 +1,20 @@
+cache: bundler
 language: ruby
+
 rvm:
-  - 2.0.0
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-  - ruby-head
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
+
+before_install:
+  - gem install bundler -v 2.0.2
+
+gemfile:
+  - gemfiles/rails_5.2.gemfile
+  - gemfiles/rails_6.0.gemfile
+  - gemfiles/rails_6.1.gemfile
+
+matrix:
+  allow_failures:
+    - gemfile: gemfiles/rails_5.2.gemfile
+      rvm: 3.0.0

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'rails-5.2' do
+  gem 'rails', '~> 5.2.0'
+end
+
+appraise 'rails-6.0' do
+  gem 'rails', '~> 6.0.0'
+end
+
+appraise 'rails-6.1' do
+  gem 'rails', '~> 6.1.0'
+end

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # CHANGELOG
 
+### Version 0.5.2
+* Add rails version supported 6.
+* Minimum ruby version supported 2.6.X.
+* Remove support for ruby 2.4.X.
+* Avoid defining new methods in exporter.
+* Update code base to use bundler 2.X.X.
+
+### Version 0.5.1
+* Add rails version supported 5.2.X.
+* Minimum ruby version supported 2.5.0.
+
+### Version 0.5.0
+* Rails versions supported 4.X.X and 5.X.X.
+* Minimum ruby version supported 2.2.2.
+
+### Version 0.4.1
+* Improvements: Moving dependecies to .gemspec
+
 ### Version 0.4.0
 * Ruby ~> 1.9.3 is not longer supported.
 * activemodel version dependency >= 4.0.
@@ -8,10 +26,10 @@
 * Adding support to export a single resource.
 
 ### Version 0.3.1
-* Fixing errors with rails 4.2+.
+* Fixing errors with rails 4.2.X.
 
 ### Version 0.3.0
-* Adding support to rails 4.2+.
+* Adding support to rails 4.2.X.
 
 ### Version 0.2.0
 * Using I18n translations in file headers.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alejandrodevs@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +1,2 @@
 source 'https://rubygems.org'
-
 gemspec
-gem 'coveralls', require: false
-gem 'rails'
-gem 'sqlite3'

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2014 Alejandro Gutiérrez
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2019 Alejandro Gutiérrez
 
-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:
+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 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.
+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

@@ -1,22 +1,28 @@
 # ActiveModel::Exporters
-[![Build Status](https://travis-ci.org/alejandrodevs/active_model_exporters.png?branch=master)](https://travis-ci.org/alejandrodevs/active_model_exporters) [![Coverage Status](https://coveralls.io/repos/github/alejandrodevs/active_model_exporters/badge.svg?branch=master)](https://coveralls.io/github/alejandrodevs/active_model_exporters?branch=master)
+[![Build Status](https://travis-ci.com/alejandrodevs/active_model_exporters.svg?branch=master)](https://travis-ci.org/alejandrodevs/active_model_exporters) [![Coverage Status](https://coveralls.io/repos/github/alejandrodevs/active_model_exporters/badge.svg?branch=master)](https://coveralls.io/github/alejandrodevs/active_model_exporters?branch=master)
 
-`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).
+`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:
+Add this line to your application's Gemfile:
+
 ```ruby
 gem 'active_model_exporters'
 ```
-Run the bundle command to install it.
 
-## Getting started
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model_exporters
+
+## Usage
 
 Generate an exporter in `app/exporters/post_exporter.rb`:
+
 ```ruby
 class PostExporter < ActiveModel::Exporter
   attributes :id, :title, :content
@@ -24,6 +30,7 @@ end
 ```
 
 In your controller:
+
 ```ruby
 class PostsController < ApplicationController
   def index
@@ -38,26 +45,34 @@ end
 ```
 
 ### Custom exporter
+
 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
 class UserExporter < ActiveModel::Exporter
   attributes :first_name, :last_name, :full_name
@@ -71,7 +86,9 @@ end
 ### Exporter scope
 
 #### 1. Default scope
+
 As `ActiveModel::Serializers` does, you can access to the current user via `scope`.
+
 ```ruby
 class UserExporter < ActiveModel::Exporter
   attributes :name, :email
@@ -83,13 +100,17 @@ 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
@@ -101,8 +122,9 @@ end
 ```
 
 ### Filter attributes
-As `ActiveModel::Serializers` does, you can reject some attributes
-according to your business rules:
+
+As `ActiveModel::Serializers` does, you can reject some attributes according to your business rules:
+
 ```ruby
 class UserExporter < ActiveModel::Exporter
   attributes :name, :email, :address
@@ -116,13 +138,27 @@ class UserExporter < ActiveModel::Exporter
   end
 end
 ```
+
 Rejected attributes will be blank in the downloaded file.
 
 ### Headers
+
 `ActiveModel::Exporters` uses I18n translations in file headers.
 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/alejandrodevs/active_model_exporters. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
 
-Thank you!
+Everyone interacting in the ActiveModel::Exporters project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alejandrodevs/active_model_exporters/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,9 +1,10 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-Rake::TestTask.new do |t|
+Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 task default: :test

data/active_model_exporters.gemspec

@@ -1,6 +1,5 @@
-# coding: utf-8
-
-$:.unshift File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'active_model/exporter/version'
 
 Gem::Specification.new do |spec|
@@ -8,17 +7,30 @@ Gem::Specification.new do |spec|
   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.description   = 'A simple way to export data in Rails.'
   spec.homepage      = 'https://github.com/alejandrodevs/active_model_exporters'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/LICENSE.txt"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'appraisal', '~> 2.4'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
 
-  spec.add_dependency 'activemodel', '>= 4.0'
-  spec.add_development_dependency 'rails', '>= 4.0'
+  spec.add_dependency 'rails', '>= 5.2'
 end