jsonapi-resources-optional_paginators 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d01c0519bdca1e9ae06c94b54f5a2fb24558f521363892e69eb9f1e8a7e3a6a1
+  data.tar.gz: 47aa97a7a99c7cdbaad20152ce743e1e857a78761d47e792998fa62854cf059c
+SHA512:
+  metadata.gz: bf673b3a49af1a409ace776beb1412b4bb8b333e262e7421fadfb2566e10439da6bb2fc311109e8e130eee2ff12601f7f1a18ae245caeb6fb7aff1d47ebf8766
+  data.tar.gz: a73732cb519796d6cd3f2e494e3ae3a72e1cffe05999e08d9b79d2c201b72fe3d8bdfae3a1575fbd5b1d55f2e5d046f604ac8d22ceed243f5fd0e0ec4e908dfb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonapi-resources-optional_paginators.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Josh Justice
+
+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,59 @@
+# JSONAPI::Resources::OptionalPaginators
+
+JSONAPI::Resources paginators that allow returning records unpaginated.
+
+JSONAPI::Resources allows you to configure resources to either have no pagination, or to have a paginator of a certain type. This often works fine. 
+
+But sometimes you may want the option to either paginate or not paginate a resource, depending on the request. For example, in a todo list app, your completed todo list will get longer over time, so you might want to paginate it. But your uncompleted todo list should stay short, so you might want to retrieve all incomplete todos unpaginated.
+
+This gem allows you to make JR paginators optional, so that if you don't pass any `page[]` parameters, all records are returned. This is accomplished with an `OptionalPaginator` class that wraps any other paginator. For convenience, a wrapped version of the built-in `PagedPaginator` is provided as `OptionalPagedPaginator`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi-resources-optional_paginators'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jsonapi-resources-optional_paginators
+
+## Usage
+
+To use the `OptionalPagedPaginator`, configure it as the paginator for a resource or the default paginator for the app:
+
+    JSONAPI.configure do |config|
+      config.default_paginator = :optional_paged
+    end
+    
+To make another paginator class optional, call the `OptionalPaginator.for` method, passing the paginator class to wrap. It returns a new class, so assign it to a constant:
+
+    OptionalOffsetPaginator =
+      JSONAPI::Resources::OptionalPaginators::OptionalPaginator.for(OffsetPaginator)
+    
+Note that the class should not be nested inside a module, so that JR can find the class name based on the symbol passed to the config:
+
+    JSONAPI.configure do |config|
+      config.default_paginator = :optional_offset
+    end
+
+## 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/codingitwrong/jsonapi-resources-optional_paginators.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jsonapi/resources/optional_paginators"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jsonapi-resources-optional_paginators.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/jsonapi/resources/optional_paginators/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jsonapi-resources-optional_paginators'
+  spec.version       = JSONAPI::Resources::OptionalPaginators::VERSION
+  spec.authors       = ['Josh Justice']
+  spec.email         = ['me@codingitwrong.com']
+
+  spec.summary       = 'JR paginators that allow returning records unpaginated.'
+  spec.homepage      = 'https://github.com/CodingItWrong/jsonapi-resources-optional_paginators'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/CodingItWrong/jsonapi-resources-optional_paginators.git'
+
+  # 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.add_runtime_dependency 'jsonapi-resources', ['>= 0']
+end

data/lib/jsonapi/resources/optional_paginators.rb

@@ -0,0 +1,14 @@
+require 'jsonapi/resources/optional_paginators/version'
+
+require_relative 'optional_paginators/null_paginator'
+require_relative 'optional_paginators/optional_paginator'
+require_relative '../../optional_paged_paginator'
+
+module JSONAPI
+  module Resources
+    module OptionalPaginators
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/lib/jsonapi/resources/optional_paginators/null_paginator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  module Resources
+    module OptionalPaginators
+      class NullPaginator < JSONAPI::Paginator
+        def initialize(params); end
+
+        def apply(relation, _order_options)
+          relation
+        end
+
+        def calculate_page_count(_record_count)
+          1
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/resources/optional_paginators/optional_paginator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'null_paginator'
+
+module JSONAPI
+  module Resources
+    module OptionalPaginators
+      class OptionalPaginator < SimpleDelegator
+        class << self
+          attr_accessor :wrapped_class
+
+          def for(paginator_class_argument)
+            Class.new(self).tap do |wrapper_class|
+              wrapper_class.wrapped_class = paginator_class_argument
+            end
+          end
+        end
+
+        attr_reader :delegate
+
+        def self.requires_record_count
+          wrapped_class.requires_record_count
+        end
+
+        def initialize(params)
+          inner_paginator = paginator_for_params(params).new(params)
+          super(inner_paginator)
+        end
+
+        def paginator_for_params(params)
+          if params.nil?
+            NullPaginator
+          else
+            self.class.wrapped_class
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/resources/optional_paginators/version.rb

@@ -0,0 +1,7 @@
+module JSONAPI
+  module Resources
+    module OptionalPaginators
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/optional_paged_paginator.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+OptionalPagedPaginator =
+  JSONAPI::Resources::OptionalPaginators::OptionalPaginator.for(PagedPaginator)

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-resources-optional_paginators
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Justice
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- me@codingitwrong.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonapi-resources-optional_paginators.gemspec
+- lib/jsonapi/resources/optional_paginators.rb
+- lib/jsonapi/resources/optional_paginators/null_paginator.rb
+- lib/jsonapi/resources/optional_paginators/optional_paginator.rb
+- lib/jsonapi/resources/optional_paginators/version.rb
+- lib/optional_paged_paginator.rb
+homepage: https://github.com/CodingItWrong/jsonapi-resources-optional_paginators
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/CodingItWrong/jsonapi-resources-optional_paginators
+  source_code_uri: https://github.com/CodingItWrong/jsonapi-resources-optional_paginators.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: JR paginators that allow returning records unpaginated.
+test_files: []