kaminari-mandatory_ordering 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08f862a65011bcd30349ee2d7cf90df4c1805d2e
+  data.tar.gz: 70c3466b658d90215de5a5537e1d1af12382642b
+SHA512:
+  metadata.gz: cd18bc69cc6844f7c56452ec180a2e04d453312e58ad1179eea67dae42193c1705879d743f47d44ba0b33972db4d9475266c955d311113be9ce8a2bdaaaa4da4
+  data.tar.gz: 24be08e162d660a28a264967011a6d1a7ba3184a0a72d26a52457cc4970c534da633633d9c9d42ec54217ccb3d9f6b288b6acac67759ceafe3a5ca3954d67ef9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 2.0
+
+Metrics/LineLength:
+  Max: 145
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kaminari-mandatory_ordering.gemspec
+gemspec

data/README.md

@@ -0,0 +1,38 @@
+# Kaminari::MandatoryOrdering
+
+Makes sure ActiveRecord collections paged over by `kaminari` are ordered.
+
+Forgetting to set order clause when loading records from database in pages can lead to duplicate or missing entries. This gem forces you not to make that mistake.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kaminari-mandatory_ordering'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kaminari-mandatory_ordering
+
+## Usage
+
+Look for `Kaminari::MandatoryOrdering::Error` exceptions, add order clauses to queries causing them.
+
+Disable (for example, in production environment) by setting `disable_mandatory_ordering = true` value in `kaminari` configuration block.
+
+## 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/tmikoss/kaminari-mandatory_ordering.
+

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 'kaminari/mandatory_ordering'
+
+# 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

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/kaminari-mandatory_ordering.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kaminari/mandatory_ordering/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kaminari-mandatory_ordering'
+  spec.version       = Kaminari::MandatoryOrdering::VERSION
+  spec.authors       = ['Toms Mikoss']
+  spec.email         = ['toms.mikoss@gmail.com']
+
+  spec.summary       = 'Makes sure ActiveRecord collections paged over by kaminari are ordered'
+  spec.homepage      = 'https://github.com/tmikoss/kaminari-mandatory_ordering'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'kaminari', '>= 1.0'
+  spec.add_dependency 'activerecord', '>= 4.0'
+  spec.add_dependency 'activesupport', '>= 4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'sqlite3', '>= 1.3'
+end

data/lib/kaminari/mandatory_ordering/active_record_extension.rb

@@ -0,0 +1,22 @@
+require 'kaminari/mandatory_ordering/active_record_model_extension'
+
+module Kaminari
+  module MandatoryOrdering
+    module ActiveRecordExtension
+      extend ActiveSupport::Concern
+
+      included do
+        descendants.each do |klass|
+          klass.send(:prepend, Kaminari::MandatoryOrdering::ActiveRecordModelExtension)
+        end
+      end
+
+      module ClassMethods
+        def inherited(klass)
+          super
+          klass.send(:prepend, Kaminari::MandatoryOrdering::ActiveRecordModelExtension)
+        end
+      end
+    end
+  end
+end

data/lib/kaminari/mandatory_ordering/active_record_model_extension.rb

@@ -0,0 +1,21 @@
+module Kaminari
+  module MandatoryOrdering
+    module ActiveRecordModelExtension
+      extend ActiveSupport::Concern
+
+      def self.prepended(klass)
+        return if Kaminari.config.disable_mandatory_ordering
+
+        original = klass.method(Kaminari.config.page_method_name)
+
+        klass.define_singleton_method(Kaminari.config.page_method_name) do |number|
+          if all.values.fetch(:order, []).none?
+            raise Kaminari::MandatoryOrdering::Error
+          else
+            original.call(number)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kaminari/mandatory_ordering/error.rb

@@ -0,0 +1,6 @@
+module Kaminari
+  module MandatoryOrdering
+    class Error < RuntimeError
+    end
+  end
+end

data/lib/kaminari/mandatory_ordering/version.rb

@@ -0,0 +1,5 @@
+module Kaminari
+  module MandatoryOrdering
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/kaminari/mandatory_ordering.rb

@@ -0,0 +1,11 @@
+require 'kaminari'
+require 'active_support/lazy_load_hooks'
+require 'kaminari/mandatory_ordering/version'
+require 'kaminari/mandatory_ordering/error'
+require 'kaminari/mandatory_ordering/active_record_extension'
+
+module Kaminari
+  module MandatoryOrdering
+    ::ActiveRecord::Base.send :include, Kaminari::MandatoryOrdering::ActiveRecordExtension
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: kaminari-mandatory_ordering
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toms Mikoss
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- toms.mikoss@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kaminari-mandatory_ordering.gemspec
+- lib/kaminari/mandatory_ordering.rb
+- lib/kaminari/mandatory_ordering/active_record_extension.rb
+- lib/kaminari/mandatory_ordering/active_record_model_extension.rb
+- lib/kaminari/mandatory_ordering/error.rb
+- lib/kaminari/mandatory_ordering/version.rb
+homepage: https://github.com/tmikoss/kaminari-mandatory_ordering
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Makes sure ActiveRecord collections paged over by kaminari are ordered
+test_files: []