wor-paginate 0.1.4 → 0.1.5a

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ece2d8e06ba836333189b0db686523324723403a7b78e094d4d6d609247f501
-  data.tar.gz: c649acf92be56898747bc758bfb6479ecb82894305fb13f16c28259c0e8b96ac
+  metadata.gz: a7bfb0360345a51c5eb2ab8ed52d90f3dc7032155830e37b48a83e09e049f1fd
+  data.tar.gz: f145fa8f27deb86310b600ff75b2623a620ea7445cfca7f387fabe2dcb000471
 SHA512:
-  metadata.gz: 491c2345cc0add8083d0ef428d70194a180c12c3d4b3298da3c4fcb9cd662477b8bc8e2dc5285e4019bb6b1f7d71608d17ab942cc72f64d1910874741864522a
-  data.tar.gz: 9a6bbee3a30cdee550cb309890fb822c325d77411251fa32aa41b6b9b0962cbf381a83b88d33f91b9f910c6bad5e9b8e3aefe767028a69191ffe16b546b60cb1
+  metadata.gz: 9cfa29bf30aacda22b8f2702018b078de0e1c1631aa5f51366bc69a9d5a2fe7fd74ec2514d44597357fc604912718205b756fe43e5cee68cb01f492659235fa9
+  data.tar.gz: 84576e26892ca4d718084e0d064323a0d46e73e209085409e8f77577f115aac38eb4fb491a05f50a7a95a531e55c0284a218946f0ae303e0151fd126c13e5ce8

data/.travis.yml

@@ -1,20 +1,23 @@
 language: ruby
 rvm:
-  - 2.2.2
-  - 2.3.3
-  - 2.4.0
+  - 2.3.8
+  - 2.4.7
+  - 2.5.6
+  - 2.6.4
   - ruby-head
 
+before_install:
+  - gem install bundler -v 2.0.1
+
 install:
-  - gem install bundler
-  - gem install danger --version '~> 5.0'
-  - bundle install --retry=3
+  - bundle _2.0.1_ install --retry=3
   - bundle exec rake db:migrate RAILS_ENV=test -f spec/dummy/Rakefile
 
-before_script:
-  - danger
-
 script:
   - bundle exec rubocop lib spec --format simple
   - bundle exec rspec
   - bundle exec codeclimate-test-reporter
+
+matrix:
+  allow_failures:
+    - rvm : ruby-head

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Change log
 
+### V0.1.5a
+* [#62](https://github.com/Wolox/wor-paginate/pull/62): Add options in active model serializer - [@blacksam07](https://github.com/blacksam07).
+
+### V0.1.5
+* [#59](https://github.com/Wolox/wor-paginate/pull/59): Add include option to serialize nested models - [@jcgrethe](https://github.com/jcgrethe).
+* [#65](https://github.com/Wolox/wor-paginate/pull/65): Add scope on serializer - [@mtejedorwolox](https://github.com/mtejedorwolox).
+* [#72](https://github.com/Wolox/wor-paginate/pull/72): Update readme and CI fix - [@mnmallea](https://github.com/mnmallea).
+
 ### V0.1.4
 * [#57](https://github.com/Wolox/wor-paginate/pull/57): Update rails max version - [@hdf1986](https://github.com/hdf1986).
 

data/Gemfile

@@ -15,7 +15,7 @@ gemspec
 
 group :development, :test do
   gem 'active_model_serializers', '~> 0.10.0'
-  gem 'bundler', '~> 1.13'
+  gem 'bundler', '~> 2.0.1'
   gem 'byebug', '~> 9.0'
   gem 'codeclimate-test-reporter', '~> 1.0.0'
   gem 'database_cleaner', '~> 1.6.0'
@@ -33,8 +33,3 @@ group :development, :test do
   gem 'webmock', '~> 3.0.0'
   gem 'will_paginate', '~> 3.1.0'
 end
-
-group :test do
-  gem 'danger'
-  gem 'danger-todoist'
-end

data/README.md

@@ -1,9 +1,28 @@
-# Wor::Paginate
+Wor::Paginate
+=============
+
 [![Build Status](https://travis-ci.org/Wolox/wor-paginate.svg?branch=master)](https://travis-ci.org/Wolox/wor-paginate)
 [![Gem Version](https://badge.fury.io/rb/wor-paginate.svg)](https://badge.fury.io/rb/wor-paginate)
-[![Dependency Status](https://gemnasium.com/badges/github.com/Wolox/wor-paginate.svg)](https://gemnasium.com/github.com/Wolox/wor-paginate)
 [![Code Climate](https://codeclimate.com/github/Wolox/wor-paginate/badges/gpa.svg)](https://codeclimate.com/github/Wolox/wor-paginate)
-[![Test Coverage](https://codeclimate.com/github/Wolox/wor-paginate/badges/coverage.svg)](https://codeclimate.com/github/Wolox/wor-paginate/coverage)
+
+# Table of contents
+  - [Description](#description)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Basic usage](#basic-usage)
+    - [Customizing output](#customizing-output)
+      - [Custom serializers](#custom-serializers)
+      - [Custom formatters](#custom-formatters)
+    - [Working with Kaminari or will_paginate](#working-with-kaminari-or-will_paginate)
+    - [Test helpers](#test-helpers)
+  - [Contributing](#contributing)
+  - [Releases](#releases)
+  - [About](#about)
+  - [License](#license)
+
+-----------------------
+
+## Description
 
 Wor::Paginate is a gem for Rails that simplifies pagination, particularly for controller methods, while standardizing JSON output for APIs. It's meant to work both as a standalone pagination gem and as an extra layer over [Kaminari](https://github.com/kaminari/kaminari) and [will_paginate](https://github.com/mislav/will_paginate).
 
@@ -34,7 +53,7 @@ The basic use case is to paginate using default values. This is achieved by incl
     include Wor::Paginate
 
     def index
-        render_paginated DummyModel
+      render_paginated DummyModel
     end
   end
 ```
@@ -57,7 +76,7 @@ The response to the index will then be:
       "name": "i",
       "something": 68
     },
-    ...
+    // ...
     {
       "id": 25,
       "name": "2m",
@@ -85,6 +104,20 @@ render_paginated DummyModel, each_serializer: CustomDummyModelSerializer
 ```
 where the serializer is just an [`ActiveModel::Serializer`](https://github.com/rails-api/active_model_serializers).
 
+#### Custom options
+Using custom options in serializer, example method `current_user`
+```ruby
+render_paginated DummyModel, each_serializer: CustomDummyModelSerializer, current_user: current_user
+```
+In serializer
+```ruby
+class CustomSerializer < ActiveModel::Serializer
+  def method
+    @instance_options[:current_user]
+  end
+end
+```
+
 #### Custom formatters
 A formatter is an object that defines the output of the render_paginated method. In case the application needs a different format for a request, it can be passed to the `render_paginated` method using the `formatter` option:
 ```ruby
@@ -117,25 +150,31 @@ If either Kaminari or will_paginate are required in the project, Wor::Paginate w
 You can use the `be_paginated` matcher to test your endpoints. It also accepts the `with` chain method to receive a formatter.
 
 You only need to add this in your rails_helper.rb
+
 ```ruby
 # spec/rails_helper.rb
 require 'wor/paginate/rspec'
 ```
+
 And in your spec do
 ```ruby
 # spec/controllers/your_controller.rb
 describe YourController do
+  let(:response_body) do
+    ActiveSupport::JSON.decode(response.body) if response.present? && response.body.present?
+  end
+
   describe '#index' do
-    it 'checks that the response keys matches with the default formatter' do
-      get :index
-      expect(response_body(response)).to be_paginated
-    end
+    subject(:http_request) { get :index }
+
+    it { expect(response_body).to be_paginated }
   end
 
   describe '#index_with_custom_formatter' do
+    subject(:http_request) { get :index_custom_formatter }
+
     it 'checks that the response keys matches with the custom formatter' do
-      get :index_custom_formatter
-      expect(response_body(response)).to be_paginated.with(CustomFormatter)
+      expect(response_body).to be_paginated.with(CustomFormatter)
     end
   end
 end
@@ -149,12 +188,25 @@ end
 4. Run rubocop lint (`bundle exec rubocop -R --format simple`)
 5. Run rspec tests (`bundle exec rspec`)
 6. Push your branch (`git push origin my-new-feature`)
-7. Create a new Pull Request
+7. Create a new Pull Request to `master` branch
+
+## Releases
+📢 [See what's changed in a recent version](https://github.com/Wolox/wor-paginate/releases)
 
 ## About ##
 
-This project is maintained by [Hugo Farji](https://github.com/hdf1986), [Ignacio Coluccio](https://github.com/icoluccio), and [Alan Halatian](https://github.com/alanhala). It was written by [Wolox](http://www.wolox.com.ar).
-![Wolox](https://raw.githubusercontent.com/Wolox/press-kit/master/logos/logo_banner.png)
+The current maintainers of this gem are :
+* [Lucas Voboril](https://github.com/lucasVoboril)
+* [Martín Mallea](https://github.com/mnmallea)
+
+This project was developed by:
+* [Hugo Farji](https://github.com/hdf1986)
+* [Ignacio Coluccio](https://github.com/icoluccio)
+* [Alan Halatian](https://github.com/alanhala)
+
+At [Wolox](http://www.wolox.com.ar)
+
+[![Wolox](https://raw.githubusercontent.com/Wolox/press-kit/master/logos/logo_banner.png)](http://www.wolox.com.ar)
 
 ## License
 

data/lib/wor/paginate/formatter.rb

@@ -32,8 +32,9 @@ module Wor
       end
 
       def serialized_content
-        return paginated_content.map { |item| serializer.new(item) } if serializer.present?
-
+        if serializer.present?
+          return paginated_content.map { |item| serializer.new(item, options) }
+        end
         if defined? ActiveModelSerializers::SerializableResource
           ActiveModelSerializers::SerializableResource.new(paginated_content).as_json
         else

data/lib/wor/paginate/paginate.rb

@@ -12,6 +12,8 @@ module Wor
     ].freeze
 
     def render_paginated(content, options = {})
+      return render_paginate_with_include(content, options) if includes?(options)
+
       render json: paginate(content, options)
     end
 
@@ -21,6 +23,10 @@ module Wor
       formatter_class(options).new(adapter, options).format
     end
 
+    def render_paginate_with_include(content, options)
+      render json: paginate(content, options), include: options[:include]
+    end
+
     def formatter_class(options)
       options[:formatter].presence || Formatter
     end
@@ -42,6 +48,10 @@ module Wor
       params[Config.per_page_param].to_i unless params[Config.per_page_param].nil?
     end
 
+    def includes?(options)
+      !options[:include].nil?
+    end
+
     def limit(options)
       [
         Config.max_limit,

data/lib/wor/paginate/version.rb

@@ -1,5 +1,5 @@
 module Wor
   module Paginate
-    VERSION = '0.1.4'.freeze
+    VERSION = '0.1.5a'.freeze
   end
 end

data/pull_request_template.md

@@ -0,0 +1,3 @@
+## Summary
+
+[Change!] Describe your feature, problems you had, notes, improvements and others.

data/wor-paginate.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.version     = Wor::Paginate::VERSION
   s.platform    = Gem::Platform::RUBY
   s.date        = Date.today
-  s.authors     = ["hdf1986", "icoluccio", "alanhala"]
-  s.email       = ["hugo.farji@wolox.com.ar", "ignacio.coluccio@wolox.com.ar", "alan.halatian@wolox.com.ar"]
+  s.authors     = ["icoluccio", "mnmallea", "holywyvern", "lucasVoboril"]
+  s.email       = ["ignacio.coluccio@wolox.com.ar", "martin.mallea@wolox.com.ar", "ramiro.rojo@wolox.com.ar", "lucas.voboril@wolox.com.ar"]
   s.homepage    = "https://github.com/Wolox/wor-paginate"
   s.summary     = "Simplified pagination for Rails API controllers"
   s.description = "Wor::Paginate is a gem for Rails that simplifies pagination, particularly for controller methods, while standardizing JSON output for APIs. It's meant to work both as a standalone pagination gem and as an extra layer over Kaminari and will_paginate"

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: wor-paginate
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5a
 platform: ruby
 authors:
-- hdf1986
 - icoluccio
-- alanhala
+- mnmallea
+- holywyvern
+- lucasVoboril
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2019-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -51,9 +52,10 @@ description: Wor::Paginate is a gem for Rails that simplifies pagination, partic
   work both as a standalone pagination gem and as an extra layer over Kaminari and
   will_paginate
 email:
-- hugo.farji@wolox.com.ar
 - ignacio.coluccio@wolox.com.ar
-- alan.halatian@wolox.com.ar
+- martin.mallea@wolox.com.ar
+- ramiro.rojo@wolox.com.ar
+- lucas.voboril@wolox.com.ar
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -62,7 +64,6 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
-- Dangerfile
 - Gemfile
 - LICENSE.md
 - README.md
@@ -85,6 +86,7 @@ files:
 - lib/wor/paginate/paginate.rb
 - lib/wor/paginate/rspec.rb
 - lib/wor/paginate/version.rb
+- pull_request_template.md
 - wor-paginate.gemspec
 homepage: https://github.com/Wolox/wor-paginate
 licenses:
@@ -101,12 +103,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Simplified pagination for Rails API controllers

data/Dangerfile

@@ -1,69 +0,0 @@
-# Sometimes it's a README fix, or something like that - which isn't relevant for
-# including in a project's CHANGELOG for example
-declared_trivial = github.pr_title.include? "#trivial"
-gemfile_changed = git.deleted_files.include?('Gemfile')
-gemfile_lock_changed = git.deleted_files.include?('Gemfile.lock')
-
-# Make it more obvious that a PR is a work in progress and shouldn't be merged yet
-warn("PR is classed as Work in Progress") if github.pr_title.include? "[WIP]"
-
-# Warn when there is a big PR with more than 500 lines
-warn("Big PR. If it's possible try to reduce this into smaller PR's") if git.lines_of_code > 500
-
-# Warn when a PR is clased as work in progress
-warn "PR is classed as Work in Progress" if github.pr_title.include? "[WIP]"
-
-# Don't let testing shortcuts get into master by accident
-fail("fdescribe left in tests") if `grep -r fdescribe specs/ `.length > 1
-fail("fit left in tests") if `grep -r fit specs/ `.length > 1
-
-# Ensure there's a summary on the pull request description
-fail "Please provide a summary in the Pull Request description" if github.pr_body.length < 5
-
-# Ensures that the PR is mergeable 
-can_merge = github.pr_json["mergeable"]
-fail("This PR cannot be merged yet. Please fix the conflicts with the base branch", sticky: false) unless can_merge
-
-# It fails when TODO's are present
-todoist.message = "Please fix all TODOS"
-todoist.fail_for_todos
-
-# Check for changes in the CHANGELOG.md if the pr isn't trivial
-unless declared_trivial
-  [
-    'CHANGELOG.md'
-  ].each do |file_who_needs_change|
-    fail("#{file_who_needs_change} needs to be changed") unless git.modified_files.include?(file_who_needs_change)
-  end
-end
-# Fails when an important file is deleted or renamed
-[
-  'wor-paginate-gemspec',
-  'README.md',
-  'CHANGELOG.md',
-  '.gitignore',
-  '.travis.yml',
-  '.rubocop.yml'
-].each do |protected_file|
-  fail("#{protected_file} file shouldn't be deleted or renamed") if git.deleted_files.include?(protected_file) || git.renamed_files.include?(protected_file)
-end
-
-# Fails when a dangerous file is uploaded
-[
-  '.ruby-version',
-  'Gemfile.lock',
-].each do |protected_file|
-  fail("#{protected_file} file shouldn't be added") if git.added_files.include?(protected_file)
-end
-
-# Removes placeholder line
-# Danger::Changelog.configure do |config|
-#  config.placeholder_line = nil
-# end
-
-# Check that bundle install where ran
-# if gemfile_changed && !gemfile_lock_changed
-#   message = 'Changes were made to Gemfile, but not to Gemfile.lock';
-#   idea = 'Perhaps you need to run `bundle install`?';
-#   warn(`${message} - <i>${idea}</i>`);
-# end