find_by_sql_paginately 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 648580d321387b2b926a9eb2aebda5a8250b46a7
+  data.tar.gz: 151f803bd0ab6a69a1d3c9b52374be719f0d322d
+SHA512:
+  metadata.gz: e57e90c493eea03d2d74262cb6e8391f0f88cdbef86621743552460ce22ac42ee9870bcdadcb7d507d351070b839413a93eb33e11a3fc26c22ef58d6616b1564
+  data.tar.gz: 9835c91757817ffefea0fd6a1ed03052a516e933084f296d19ca325cd1f27ba7e328d352c8d373f20c858fe844d98eeee4fc27c6897f11b5745b364957a285d1

data/.gitignore

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

data/.travis.yml

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

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 james@rubify.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

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in find_by_sql_paginately.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 james
+
+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,75 @@
+# FindBySqlPaginately
+
+This gem is to add extra parameters to Rails original method ``find_by_sql`` so that developers like us can do pagination without so much hassle of manipulating the SQL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'find_by_sql_paginately', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install find_by_sql_paginately
+
+## Usage
+
+With this gem install you can run the normal ``find_by_sql`` but with extra parameters per_page and page like below. Note that, there would be 3 extra methods ``total_pages``, ``total_count``, ``page`` that you can used to faciliate the pagination rendering.
+
+```ruby
+users = User.find_by_sql('SELECT * FROM users', per_page: 10, page: 1)
+# => First page of 10 users will be returned
+
+users.total_pages
+# => Total Pages
+users.total_count
+# => Total Records
+users.page
+# => Current Page
+```
+
+You also can run the SQL with variable replacement like followings:
+
+```ruby
+users =
+  User
+  .find_by_sql(
+    ['SELECT * FROM users WHERE id > ?', 1],
+    per_page: 10,
+    page: 1
+  )
+
+# OR
+
+users =
+  User
+  .find_by_sql(
+    ['SELECT * FROM users WHERE id > :id', { id: 1 }],
+    per_page: 10,
+    page: 1
+  )
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/jameshuynhfind_by_sql_paginately. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FindBySqlPaginately project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/find_by_sql_paginately/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "find_by_sql_paginately"
+
+# 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/find_by_sql_paginately.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'find_by_sql_paginately/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'find_by_sql_paginately'
+  spec.version       = FindBySqlPaginately::VERSION
+  spec.authors       = ['james']
+  spec.email         = ['james@rubify.com']
+
+  spec.summary       = %(Add pagination to original Rails find_by_sql function)
+  spec.description   = %(Add pagination to original Rails find_by_sql function)
+  spec.homepage      = 'http://jameshuynh.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/find_by_sql_paginately.rb

@@ -0,0 +1,89 @@
+# rubocop:disable Eval
+# rubocop:disable MethodLength
+# rubocop:disable AbcSize
+# rubocop:disable ParameterLists
+require 'find_by_sql_paginately/version'
+
+module FindBySqlPaginately
+  module ActiveRecordExtension
+    def self.prepended(base)
+      class << base
+        prepend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def find_by_sql(
+        sql,
+        binds = [],
+        preparable: nil,
+        per_page: 4_294_967_296, # 2 ** 32
+        page: 1,
+        &block
+      )
+        sanitize_sql = sanitize_sql(sql)
+        final_sql = if per_page == 4_294_967_296
+                      sanitize_sql
+                    else
+                      %(
+                        SELECT * FROM (#{sanitize_sql}) AS paginateable
+                        LIMIT #{per_page}
+                        OFFSET #{(page - 1) * per_page}
+                      )
+                    end
+
+        records = super(
+          final_sql, binds, preparable: preparable, &block
+        )
+
+        kclass = to_s
+        records.instance_eval do
+          eval <<-RUBY, nil, __FILE__, __LINE__ + 1
+            def sql
+              "#{sanitize_sql}"
+            end
+
+            def page
+              "#{page}".to_i
+            end
+
+            def per_page
+              "#{per_page}".to_i
+            end
+
+            def kclass
+              "#{kclass}"
+            end
+          RUBY
+        end
+
+        records.instance_eval do
+          def total_pages
+            @total_pages ||= (total_count * 1.0 / per_page).ceil.to_i
+          end
+
+          def total_count
+            return @total_count if @total_count
+
+            count_sql = %(
+              SELECT COUNT(*) AS count FROM (#{sql}) AS paginateable
+            )
+
+            @total_count ||=
+              kclass
+              .constantize
+              .find_by_sql(count_sql)
+              .first
+              .count
+          end
+        end
+
+        records
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  ::ActiveRecord::Base.send :prepend, FindBySqlPaginately::ActiveRecordExtension
+end

data/lib/find_by_sql_paginately/version.rb

@@ -0,0 +1,3 @@
+module FindBySqlPaginately
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: find_by_sql_paginately
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- james
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Add pagination to original Rails find_by_sql function
+email:
+- james@rubify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- find_by_sql_paginately.gemspec
+- lib/find_by_sql_paginately.rb
+- lib/find_by_sql_paginately/version.rb
+homepage: http://jameshuynh.com
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Add pagination to original Rails find_by_sql function
+test_files: []
+has_rdoc: