sorted-activerecord 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c21400fbc224e7d0575432c714970ed799cc0d4d
+  data.tar.gz: 1f6e0062fdddf976f0b257becf262f5149cc45dc
+SHA512:
+  metadata.gz: c74ee20c9c63598e6adf5af36d290a8397a0f7d0be20c4c0ed9c558dc92a0fbecabae17d3fbb3f857c79e86fbf6dd0cadd2071764def00ed1b5c2b97b870c1f2
+  data.tar.gz: 6722154d0bfd8fc0ea142602c64caa2e8d786db9fec30c0d7407d3136c012ce6fedfbcf4ea93f3d5e03f6af79f45551349f6a91121ed8f0adec15e256b8ebc55

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.swp
+mkmf.log
+.bin
+.bundle
+.gems

data/.rubocop.yml

@@ -0,0 +1,12 @@
+# Offense count: 5
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 174
+
+# Offense count: 5
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+Style/RegexpLiteral:
+  MaxSlashes: 0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rufus Post
+
+MIT License
+
+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,46 @@
+# Sorted::Activerecord
+
+[![Build Status](https://travis-ci.org/mynameisrufus/sorted-activerecord.svg?branch=master)](https://travis-ci.org/mynameisrufus/sorted-activerecord)
+
+These helpers will let you sort large datasets over many pages (using
+[will_paginate](https://github.com/mislav/will_paginate) or
+[kaminari](https://github.com/amatsuda/kaminari)) without losing state.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sorted-activerecord'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sorted-activerecord
+
+## Usage
+
+Using the `sorted` method with the optional default order argument:
+
+```ruby
+@users = User.sorted(params[:sort], "email ASC").page(params[:page])
+```
+
+A `resorted` method is also available and works the same way as the `reorder` method in Rails.
+It forces the order to be the one passed in:
+
+```ruby
+@users = User.order(:id).sorted(nil, 'name DESC').resorted(params[:sort], 'email ASC')
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sorted-activerecord/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RuboCop::RakeTask.new
+
+task default: %w(rubocop spec)

data/lib/sorted/activerecord/builder.rb

@@ -0,0 +1,23 @@
+require 'sorted'
+
+module Sorted
+  module ActiveRecord
+    Builder = Struct.new(:sort, :order, :quoter) do
+      def uri
+        ::Sorted::URIQuery.parse(sort)
+      end
+
+      def sql
+        ::Sorted::SQLQuery.parse(order)
+      end
+
+      def set
+        uri + (sql - uri)
+      end
+
+      def to_s
+        ::Sorted::SQLQuery.encode(set, quoter)
+      end
+    end
+  end
+end

data/lib/sorted/activerecord/helper.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+require 'active_support/concern'
+require 'sorted/activerecord/builder'
+
+module Sorted
+  module ActiveRecord
+    module Helper
+      extend ActiveSupport::Concern
+      included do
+        def self.sorted(sort, order = nil)
+          quote = ->(frag) { connection.quote_column_name(frag) }
+          builder = ::Sorted::ActiveRecord::Builder.new(sort, order, quote)
+          order(builder.to_s)
+        end
+
+        def self.resorted(sort, order = nil)
+          quote = ->(frag) { connection.quote_column_name(frag) }
+          builder = ::Sorted::ActiveRecord::Builder.new(sort, order, quote)
+          reorder(builder.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/sorted/activerecord/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails'
+require 'rails/railtie'
+require 'sorted/activerecord/helper'
+
+module Sorted
+  module ActiveRecord
+    class Railtie < ::Rails::Railtie
+      config.after_initialize do |_app|
+        ActiveSupport.on_load(:active_record) do
+          include Sorted::ActiveRecord::Helper
+        end
+      end
+    end
+  end
+end

data/lib/sorted/activerecord/version.rb

@@ -0,0 +1,5 @@
+module Sorted
+  module Activerecord
+    VERSION = '0.0.1'
+  end
+end

data/lib/sorted/activerecord.rb

@@ -0,0 +1,2 @@
+require 'sorted/activerecord/version'
+require 'sorted/activerecord/railtie' if defined?(Rails::Railtie)

data/sorted-activerecord.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sorted/activerecord/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sorted-activerecord'
+  spec.version       = Sorted::Activerecord::VERSION
+  spec.authors       = ['Rufus Post']
+  spec.email         = ['Rufus.Post@team.telstra.com']
+  spec.summary       = 'Activerecord scoped for sorted.'
+  spec.description   = 'Allows the use of the sorted gem with Activerecord.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 4.0.0'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'sorted', '~> 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'railties', '>= 4.0.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec'
+  # spec.add_development_dependency 'activerecord-jdbcsqlite3-adapter'
+  spec.add_development_dependency 'sqlite3', '>= 1.3.5'
+end

data/spec/sorted/activerecord_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'active_record'
+require 'sorted/activerecord/helper'
+
+ActiveRecord::Base.send(:include, Sorted::ActiveRecord::Helper)
+
+describe Sorted::ActiveRecord do
+  class SortedActiveRecordTest < ActiveRecord::Base
+    establish_connection adapter: 'sqlite3', database: ':memory:'
+
+    connection.create_table table_name, force: true do |t|
+      t.string :name
+    end
+
+    scope :page, -> { limit(50) }
+  end
+
+  it 'should integrate with ActiveRecord::Base' do
+    expect(SortedActiveRecordTest.respond_to?(:sorted)).to eq(true)
+    expect(SortedActiveRecordTest.respond_to?(:resorted)).to eq(true)
+  end
+
+  it 'should play nice with other scopes' do
+    sql = "SELECT  \"sorted_active_record_tests\".* FROM \"sorted_active_record_tests\" WHERE \"sorted_active_record_tests\".\"name\" = 'bob'  ORDER BY \"name\" ASC LIMIT 50"
+    expect(SortedActiveRecordTest.where(name: 'bob').page.sorted(nil, 'name ASC').to_sql).to eq(sql)
+    expect(SortedActiveRecordTest.page.sorted(nil, 'name ASC').where(name: 'bob').to_sql).to eq(sql)
+  end
+
+  it 'should override the provided order' do
+    sql = "SELECT  \"sorted_active_record_tests\".* FROM \"sorted_active_record_tests\" WHERE \"sorted_active_record_tests\".\"name\" = 'bob'  ORDER BY \"name\" ASC LIMIT 50"
+    expect(SortedActiveRecordTest.page.where(name: 'bob').order(:id).sorted(nil, 'name DESC').resorted(nil, 'name ASC').to_sql).to eq(sql)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: sorted-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rufus Post
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: sorted
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.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: 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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+description: Allows the use of the sorted gem with Activerecord.
+email:
+- Rufus.Post@team.telstra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sorted/activerecord.rb
+- lib/sorted/activerecord/builder.rb
+- lib/sorted/activerecord/helper.rb
+- lib/sorted/activerecord/railtie.rb
+- lib/sorted/activerecord/version.rb
+- sorted-activerecord.gemspec
+- spec/sorted/activerecord_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Activerecord scoped for sorted.
+test_files:
+- spec/sorted/activerecord_spec.rb
+- spec/spec_helper.rb