rocket_pants-pagination 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f96416f528240deb711e605d8a36c71795d7a0bf
-  data.tar.gz: 0e08dc2ea159c7df7e86ed93668df2f4e562a04d
+  metadata.gz: 0f8806b92d0f6200a0b6c64f4b1a8b70f3118fa6
+  data.tar.gz: 639d41f97e99b961590039c35eb086c0316794f0
 SHA512:
-  metadata.gz: c6f6cbe628734a01f2326d13209f47f8397741be5fe5638ed78c9981682586be9963b4ab72c472af85a2ddd83d304a737e0bb0d0496e8dc6328b9cc8b189d1a9
-  data.tar.gz: b5f74afa335815f0be8fa33b145754649df0e249b15420ff21c6505a64f9ee516f426ec7406e2af6be2b6036601bd97a43022c55c61cf750c12136903c5425fa
+  metadata.gz: bdbc4c91fede1cb1410109686e36a830b17640d2ea659bb294fa0867e42c872c6d2f9f72e19182385ed27afc8348bd85669ddf87acc69edfa56fe5177134bfab
+  data.tar.gz: 1cdd3e3cf10d49ec01258e876536e9032a55c095b1a1a23485198fdd5d182aea627fea58350df2c95a18a1345f76c9bfb90e738f7c296c84b807325f55dfa655

data/.rubocop.yml

@@ -0,0 +1,63 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+   - 'bin/*'
+   - 'db/**/*'
+   - 'vendor/bundle/**/*'
+   - 'spec/spec_helper.rb'
+   - 'spec/rails_helper.rb'
+   - 'spec/support/**/*'
+   - 'spec/dummy/**/*'
+   - 'config/**/*'
+   - 'Rakefile'
+   - 'Gemfile'
+
+Style/Documentation:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+  AllowURI: true
+
+Style/FirstParameterIndentation:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Lint/EndAlignment:
+  AlignWith: variable
+  AutoCorrect: true
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -1,4 +1,10 @@
-language: ruby
 rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.2.0
+  - 2.3.0
+before_install:
+  - gem update --system
+  - gem update bundler
+  - gem cleanup bundler
+branches:
+  only:
+    - master

data/README.md

@@ -1,9 +1,9 @@
 # RocketPants::Pagination
 
-[![Gem Version](https://badge.fury.io/rb/rocket_pants-pagination.svg)](http://badge.fury.io/rb/rocket_pants-pagination)
-[![Build Status](https://travis-ci.org/alessandro1997/rocket_pants-pagination.svg)](https://travis-ci.org/alessandro1997/rocket_pants-pagination)
-[![Dependency Status](https://gemnasium.com/alessandro1997/rocket_pants-pagination.svg)](https://gemnasium.com/alessandro1997/rocket_pants-pagination)
-[![Code Climate](https://codeclimate.com/github/alessandro1997/rocket_pants-pagination/badges/gpa.svg)](https://codeclimate.com/github/alessandro1997/rocket_pants-pagination)
+[![Gem Version](https://img.shields.io/gem/v/rocket_pants-pagination.svg?maxAge=3600&style=flat-square)](https://rubygems.org/gems/rocket_pants-pagination)
+[![Build Status](https://img.shields.io/travis/alessandro1997/rocket_pants-pagination.svg?maxAge=3600&style=flat-square)](https://travis-ci.org/alessandro1997/rocket_pants-pagination)
+[![Dependency Status](https://img.shields.io/gemnasium/alessandro1997/rocket_pants-pagination.svg?maxAge=3600&style=flat-square)](https://gemnasium.com/github.com/alessandro1997/rocket_pants-pagination)
+[![Code Climate](https://img.shields.io/codeclimate/github/alessandro1997/rocket_pants-pagination.svg?maxAge=3600&style=flat-square)](https://codeclimate.com/github/alessandro1997/rocket_pants-pagination)
 
 Pagination support for [RocketPants](https://github.com/Sutto/rocket_pants).
 

data/lib/rocket_pants/pagination.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rocket_pants'
 require 'active_model_serializers'
 require 'will_paginate'
@@ -14,12 +15,11 @@ module RocketPants
   # @author Alessandro Desantis <desa.alessandro@gmail.com>
   #
   module Pagination
-    autoload :SwaggerSchema, 'rocket_pants/pagination/swagger_schema'
-
     #
     # Reserved root keys
     #
-    RESERVED_PAGINATION_KEYS = [:count, :pagination]
+    RESERVED_PAGINATION_KEYS = %i(count pagination).freeze
+    private_constant :RESERVED_PAGINATION_KEYS
 
     #
     # Paginates the given relation.
@@ -47,7 +47,7 @@ module RocketPants
       root_key, collection = extract_pagination_elements_from hash
 
       response = {
-        "#{root_key}" => ActiveModel::ArraySerializer.new(collection),
+        root_key => ActiveModel::Serializer::CollectionSerializer.new(collection),
         count: collection.count,
         pagination: {
           pages: collection.total_pages,
@@ -74,48 +74,26 @@ module RocketPants
     #
     def paginate_and_expose(hash)
       root_key, collection = extract_pagination_elements_from hash
-      expose_with_pagination "#{root_key}" => paginate(collection)
+      expose_with_pagination root_key => paginate(collection)
     end
 
     private
 
-    #
-    # Returns the first pair from the given hash.
-    #
-    # This is used to extract the root key and collection from a hash.
-    #
-    # @param [Hash(Symbol => ActiveRecord::Relation)] a hash with exactly one
-    #   element, its key being the root key and its value a relation
-    #
-    # @return [Array(Symbol, ActiveRecord::Relation)] an array containing a root
-    #   key and a relation
-    #
-    # @raise [ArgumentError] if the hash is malformed
-    #
     def extract_pagination_elements_from(hash)
       validate_pagination_hash! hash
       hash.first
     end
 
-    #
-    # Validates the given hash.
-    #
-    # Ensures that the hash has exactly one element and that the first element's
-    # key is not a reserved one.
-    #
-    # @param [Hash] a hash to validate
-    #
-    # @raise [ArgumentError] if the hash doesn't have exactly 1 element
-    # @raise [ArgumentError] if the first element's key is a reserved one
-    #
     def validate_pagination_hash!(hash)
-      if hash.size != 1
-        raise ArgumentError, "the given hash should contain exactly 1 element (#{hash.size} elements)"
-      end
+      fail(
+        ArgumentError,
+        "The hash should contain exactly 1 element (#{hash.size} given)"
+      ) if hash.size != 1
 
-      if hash.keys.first.to_sym.in?(RESERVED_PAGINATION_KEYS)
-        raise ArgumentError, "the given root key is reserved: #{hash.keys.first}"
-      end
+      fail(
+        ArgumentError,
+        "#{hash.keys.first} is a reserved root key"
+      ) if hash.keys.first.to_sym.in?(RESERVED_PAGINATION_KEYS)
     end
   end
 end

data/lib/rocket_pants/pagination/version.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module RocketPants
   module Pagination
-    VERSION = '1.0.0'
+    VERSION = '2.0.0'
   end
 end

data/rocket_pants-pagination.gemspec

@@ -18,12 +18,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rocket_pants', '~> 1.13'
-  spec.add_dependency 'will_paginate', '~> 3.0'
-  spec.add_dependency 'active_model_serializers', '~> 0.9'
+  spec.add_dependency 'rocket_pants', '~> 1.13.1'
+  spec.add_dependency 'will_paginate', '~> 3.1.0'
+  spec.add_dependency 'active_model_serializers', '~> 0.10.2'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'fuubar'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocket_pants-pagination
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rocket_pants
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 1.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 1.13.1
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.10.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.10.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - desa.alessandro@gmail.com
@@ -117,6 +145,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -125,7 +154,6 @@ files:
 - bin/console
 - bin/setup
 - lib/rocket_pants/pagination.rb
-- lib/rocket_pants/pagination/swagger_schema.rb
 - lib/rocket_pants/pagination/version.rb
 - rocket_pants-pagination.gemspec
 homepage: https://github.com/alessandro1997/rocket_pants-pagination
@@ -148,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Pagination support for RocketPants.

data/lib/rocket_pants/pagination/swagger_schema.rb

@@ -1,53 +0,0 @@
-module RocketPants
-  module Pagination
-    module SwaggerSchema
-      include ::Swagger::Blocks
-
-      swagger_schema :RocketPants_Pagination do
-        key :required, [:pages, :current, :count, :per_page]
-
-        property :pages do
-          key :type, :integer
-          key :format, :int64
-          key :description, 'the number of pages'
-          key :default, 1
-        end
-
-        property :current do
-          key :type, :integer
-          key :format, :int64
-          key :description, 'the number of the current page'
-          key :default, 1
-        end
-
-        property :count do
-          key :type, :integer
-          key :format, :int64
-          key :description, 'the number of total items'
-          key :default, 1
-        end
-
-        property :per_page do
-          key :type, :integer
-          key :format, :int64
-          key :description, 'the number of items per page'
-          key :default, 1
-        end
-
-        property :previous do
-          key :type, :integer
-          key :format, :int64
-          key :description, 'the number of the previous page (if available)'
-          key :default, 1
-        end
-
-        property :next do
-          key :type, :integer
-          key :format, :int64
-          key :description, 'the number of the next page (if available)'
-          key :default, 1
-        end
-      end
-    end
-  end
-end