all_sorts 1.0.1 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e8e78771d7c698a747fc9c85467c43332a9d116
-  data.tar.gz: 96ba32ab8ddbd71d0eae9487c629dd9b58e586c9
+  metadata.gz: 3bbf496efe8c26bad0c458f9d917e0d121f57003
+  data.tar.gz: 9a796dfbd02841780f6e90918bd3296246359e19
 SHA512:
-  metadata.gz: 24ee1d1020242db15d2dba0b95d6b9c41d1c266f5d66709bd12dbc04daeb6f652171e7df42d0b821140e6ce832cb6f15c70e81e9c7cdb62b7f4d41386a05d6ed
-  data.tar.gz: f625eff266d758752ba2beaf980340f81d88915a14b1ff38bb4af808a599c33206dd2479867a5e964b2ce135904103dca95d31d9798d98b5d98474dd9ab8a8da
+  metadata.gz: 415cd8bc9cbb96a9ec26874a020623897482693fb6b515966166c3ffab1b4b94d0aedb9b9df5d24deabe2298ce2fd576427b2e8913a4e4b3d62b2998c60b2e02
+  data.tar.gz: 40a6c0f3294a10194e05a72a9ff43201a2f75b796778d9709a82357e88ab3ca2648d753c19878f210e74a22fd79ec034375c109de5f208f7f0099660b7937af0

data/README.md

@@ -13,7 +13,7 @@ gem install all_sorts
 ## Usage
 All Sorts was originally developed to fill the need of being able to
 sort by one or multiple columns passed in the URL, however it works with
-ActiveRecord and basically takes in a hash.  This gem adds a ".sort" method
+ActiveRecord and basically takes in a hash.  Included as a concern, this gem adds a ".sort" method
 to ActiveRecord which basically does some clever stuff by looking at the
 hash keys, creates a string by which to sort results, and calls ".order"
 with that string.
@@ -21,13 +21,30 @@ with that string.
 It also adds a ".sortable_fields" method for you to limit by which fields
 the records may be ordered.
 
+### Globally
+Adds .sort, .sortable_fields methods to all of you models
+Somewhere in your apps bootstrap/startup code:
+
+``` ruby
+ActiveRecord::Base.include(AllSorts)
+```
+
+### Locally (in a model)
+Adds .sort, .sortable_fields methods to only the User model
+
+``` ruby
+class User < ActiveRecord::Base
+	include AllSorts
+end
+```
+
 ## URL Examples
 * http://whatever.com/wherever/?sort_name=asc
 * http://whatever.com/wherever/?sort_1_name=asc
 * http://whatever.com/wherever/?sort_1_name=asc&sort_2_salary=desc
 
 ## Model
-In the model you can limit which fields are filterable. This is optional. If this isn't in your model, all fields are filterable.
+In the model you can limit which fields are sortable. This is optional. If this isn't in your model, all fields are sortable.
 ``` ruby
 class User < ActiveRecord::Base
   sortable_fields :name, :salary

data/Rakefile

@@ -1,18 +1,2 @@
-#!/usr/bin/env rake
+require "bundler/gem_tasks"
 
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-task :test => :spec
-
-require 'yard'
-namespace :doc do
-  YARD::Rake::YardocTask.new do |task|
-    task.files   = ['LICENSE.md', 'lib/**/*.rb']
-    task.options = ['--markup', 'markdown']
-  end
-end

data/all_sorts.gemspec

@@ -1,26 +1,30 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/all_sorts/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'all_sorts/version'
 
-Gem::Specification.new do |gem|
-  gem.name        = 'all_sorts'
-  gem.version     = AllSorts::VERSION
-  gem.author      = "Phil Spitler"
-  gem.email       = 'pspitler@gmail.com'
-  gem.homepage    = 'https://github.com/philspitler/allsorts'
-  gem.summary     = 'A DSL for sorting active record results based on hash keys with the term _sort_ in them.'
-  gem.description = ''
+Gem::Specification.new do |spec|
+  spec.name          = "all_sorts"
+  spec.version       = AllSorts::VERSION
+  spec.authors       = ["Phil Spitler"]
+  spec.email         = ["pspitler@gmail.com"]
+  spec.summary       = 'A DSL for sorting active record results based on a hash with keys with the term sort_ in them.'
+  spec.description   = ""
+  spec.homepage      = "http://sproutkey.com"
+  spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
-  gem.require_paths = ['lib']
+  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"]
 
-  gem.add_development_dependency 'maruku', '~> 0.6'
-  gem.add_development_dependency 'rake', '~> 0.9'
-  gem.add_development_dependency 'rspec', '~> 2.6'
-  gem.add_development_dependency 'simplecov', '~> 0.4'
-  gem.add_development_dependency 'yard', '~> 0.7'
-  gem.add_development_dependency 'sqlite3'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bond"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "factory_girl", "~> 4.0"
 
-  gem.add_dependency 'activerecord', '>= 3.0.1'
+  spec.add_dependency "activerecord"
 end

data/lib/all_sorts.rb

@@ -1,32 +1,34 @@
 require 'active_record'
 
 module AllSorts
-  attr_accessor :sortable_fields
-  def sort(params)
+  extend ActiveSupport::Concern
 
-    #remove non filter params
-    params.delete_if { |key, value| key.to_s.index('sort_').nil? }
-    keys = params.keys.sort
-    #params.keys.sort_by {|s| s.to_s}.map {|key| [key, params[key]] }
+  module ClassMethods
+    def sortable_fields(*fields)
+      @sortable_fields = fields
+    end
+
+    def sort(params)
 
-    sorters = []
+      #remove non filter params
+      params.delete_if { |key, value| key.to_s.index('sort_').nil? }
+      keys = params.keys.sort
+      #params.keys.sort_by {|s| s.to_s}.map {|key| [key, params[key]] }
 
-    keys.each do |key, value|
-      keysplit = key.to_s.split('_')
-      unless @sortable_fields and not @sortable_fields.include?(keysplit.last.to_sym)
-        if column_names.include?(keysplit.last)
-          sorters << "#{keysplit.last} #{params[key]}"
+      sorters = []
+
+      keys.each do |key, value|
+        keysplit = key.to_s.split('_')
+        unless @sortable_fields and not @sortable_fields.include?(keysplit.last.to_sym)
+          if column_names.include?(keysplit.last)
+            sorters << "#{keysplit.last} #{params[key]}"
+          end
         end
       end
+
+      order(sorters)
     end
 
-    order(sorters)
   end
 
-
-  def sortable_fields(*fields)
-    @sortable_fields = fields
-  end
 end
-
-ActiveRecord::Base.extend AllSorts

data/lib/all_sorts/version.rb

@@ -1,3 +1,3 @@
 module AllSorts
-  VERSION = "1.0.1"
+  VERSION = "2.0"
 end

data/spec/all_sorts_spec.rb

@@ -1,47 +1,32 @@
-require 'helper'
-require 'finders/activerecord_test_connector'
-ActiverecordTestConnector.setup
+require 'spec_helper'
+require 'support/active_record'
 
 describe AllSorts do
-  extend ActiverecordTestConnector::FixtureSetup
-  fixtures :users
-  fixtures :posts
-
   it "sorts by a single field" do
-    posts = Post.sort({'sort_title' => 'desc'}).all
-    post_ids = posts.map do |post|
-      post.id
-    end
-    post_ids.should == [3, 2, 1]
+    expected_posts = Post.all.order('title desc')
+    posts = Post.all.sort({'sort_title' => 'desc'})
+    posts.should == expected_posts
 
-    posts = Post.sort({'sort_title' => 'asc'}).all
-    post_ids = posts.map do |post|
-      post.id
-    end
-    post_ids.should == [1, 2, 3]
+    expected_posts = Post.all.order('title asc')
+    posts = Post.all.sort({'sort_title' => 'asc'})
+    posts.should == expected_posts
   end
 
   it "ignores fields not in sortable_fields if sortable_fields is set" do
-    posts = Post.sort({'sort_body' => 'desc'}).all
-    post_ids = posts.map do |post|
-      post.id
-    end
-    post_ids.should == [1, 2, 3]
+    expected_posts = Post.all
+    posts = Post.all.sort({'sort_body' => 'desc'})
+    posts.should == expected_posts
   end
 
   it "sorts by multiple fields" do
+    expected_users = User.all.order('name asc, salary desc')
     users = User.sort({'sort_1_name' => 'asc', 'sort_2_salary' => 'desc'}).all
-    user_ids = users.map do |user|
-      user.id
-    end
-    user_ids.should == [1, 3, 2, 13, 12]
+    users.should == expected_users
   end
 
   it "ignores fields that don't make sense" do
+    expected_users = User.all.order('name asc')
     users = User.sort({'sort_1_name' => 'asc', 'sort_2_blah' => 'desc'}).all
-    user_ids = users.map do |user|
-      user.id
-    end
-    user_ids.should == [1, 2, 3, 13, 12]
+    users.should == expected_users
   end
 end

data/spec/factories.rb

@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  factory :user do
+    name { (0...16).map { ('a'..'z').to_a[rand(26)] }.join }
+    salary { rand(100000) }
+    bonus { rand(2) == 0 ? false : true }
+  end
+
+  factory :post do
+    sequence(:title) { |n| "Post #{n} title" }
+    sequence(:body) { |n| "Post #{n} body" }
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'simplecov'
+SimpleCov.add_filter '.bundle'
+SimpleCov.start
+require 'all_sorts'
+require 'factory_girl'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.include FactoryGirl::Syntax::Methods
+  #config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/active_record.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+load "spec/db/schema.rb"
+
+FactoryGirl.find_definitions
+
+class User < ActiveRecord::Base
+  include AllSorts
+end
+
+class Post < ActiveRecord::Base
+  include AllSorts
+  sortable_fields :title, :published_at
+end
+
+FactoryGirl.create_list(:user, 12)
+FactoryGirl.create_list(:post, 3)

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: all_sorts
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: '2.0'
 platform: ruby
 authors:
 - Phil Spitler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-24 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: maruku
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: bond
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -94,22 +94,37 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '0'
 description: ''
-email: pspitler@gmail.com
+email:
+- pspitler@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -118,7 +133,6 @@ files:
 - ".gemtest"
 - ".gitignore"
 - ".rspec"
-- ".yardopts"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -127,15 +141,13 @@ files:
 - lib/all_sorts.rb
 - lib/all_sorts/version.rb
 - spec/all_sorts_spec.rb
-- spec/finders/activerecord_test_connector.rb
-- spec/fixtures/post.rb
-- spec/fixtures/posts.yml
-- spec/fixtures/schema.rb
-- spec/fixtures/user.rb
-- spec/fixtures/users.yml
-- spec/helper.rb
-homepage: https://github.com/philspitler/allsorts
-licenses: []
+- spec/db/schema.rb
+- spec/factories.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: http://sproutkey.com
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -156,15 +168,11 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A DSL for sorting active record results based on hash keys with the term
-  _sort_ in them.
+summary: A DSL for sorting active record results based on a hash with keys with the
+  term sort_ in them.
 test_files:
 - spec/all_sorts_spec.rb
-- spec/finders/activerecord_test_connector.rb
-- spec/fixtures/post.rb
-- spec/fixtures/posts.yml
-- spec/fixtures/schema.rb
-- spec/fixtures/user.rb
-- spec/fixtures/users.yml
-- spec/helper.rb
-has_rdoc: 
+- spec/db/schema.rb
+- spec/factories.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb

data/.yardopts

@@ -1,3 +0,0 @@
---markup markdown
--
-LICENSE.md

data/spec/finders/activerecord_test_connector.rb

@@ -1,104 +0,0 @@
-require 'active_record'
-require 'active_record/version'
-require 'active_record/fixtures'
-require 'active_support/multibyte' # needed for Ruby 1.9.1
-
-$query_count = $query_sql = nil
-
-module ActiverecordTestConnector
-  extend self
-  
-  attr_accessor :able_to_connect
-  attr_accessor :connected
-
-  FIXTURES_PATH = File.expand_path('../../fixtures', __FILE__)
-
-  # Set our defaults
-  self.connected = false
-  self.able_to_connect = true
-
-  def setup
-    unless self.connected || !self.able_to_connect
-      setup_connection
-      load_schema
-      add_load_path FIXTURES_PATH
-      self.connected = true
-    end
-  rescue Exception => e  # errors from ActiveRecord setup
-    $stderr.puts "\nSkipping ActiveRecord tests: #{e}\n\n"
-    self.able_to_connect = false
-  end
-
-  private
-  
-  def add_load_path(path)
-    dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
-    dep.autoload_paths.unshift path
-  end
-
-  def setup_connection
-    ActiveRecord::Base.establish_connection(
-      :adapter => "sqlite3",
-      :database => ":memory:"
-    )
-    prepare ActiveRecord::Base.connection
-  end
-
-  def load_schema
-    ActiveRecord::Base.silence do
-      ActiveRecord::Migration.verbose = false
-      load File.join(FIXTURES_PATH, 'schema.rb')
-    end
-  end
-
-  def prepare(conn)
-    class << conn
-      IGNORED_SQL = /^(?:PRAGMA|SELECT (?:currval|CAST|@@IDENTITY|@@ROWCOUNT)|SHOW FIELDS)\b/
-
-      def execute_with_counting(sql, name = nil, &block)
-        if $query_count and IGNORED_SQL !~ sql
-          $query_count += 1
-          $query_sql << sql
-        end
-        execute_without_counting(sql, name, &block)
-      end
-
-      alias_method_chain :execute, :counting
-    end
-  end
-  
-  module FixtureSetup
-    def fixtures(*tables)
-      table_names = tables.map { |t| t.to_s }
-
-      fixtures = Fixtures.create_fixtures ActiverecordTestConnector::FIXTURES_PATH, table_names
-      @@loaded_fixtures = {}
-      @@fixture_cache = {}
-
-      unless fixtures.nil?
-        if fixtures.instance_of?(Fixtures)
-          @@loaded_fixtures[fixtures.table_name] = fixtures
-        else
-          fixtures.each { |f| @@loaded_fixtures[f.table_name] = f }
-        end
-      end
-
-      table_names.each do |table_name|
-        define_method(table_name) do |*fixtures|
-          @@fixture_cache[table_name] ||= {}
-
-          instances = fixtures.map do |fixture|
-            if @@loaded_fixtures[table_name][fixture.to_s]
-              @@fixture_cache[table_name][fixture] ||= @@loaded_fixtures[table_name][fixture.to_s].find
-            else
-              raise StandardError, "No fixture with name '#{fixture}' found for table '#{table_name}'"
-            end
-          end
-
-          instances.size == 1 ? instances.first : instances
-        end
-      end
-    end
-  end
-end
-

data/spec/fixtures/post.rb

@@ -1,3 +0,0 @@
-class Post < ActiveRecord::Base
-  sortable_fields :title, :published_at
-end

data/spec/fixtures/posts.yml

@@ -1,16 +0,0 @@
-post1:
-  id: 1
-  title: "Post 1 title"
-  body: "Post 1 body"
-
-post2:
-  id: 2
-  title: "Post 2 title"
-  body: "Post 2 body"
-
-post3:
-  id: 3
-  title: "Post 3 title"
-  body: "Post 3 body"
-
-

data/spec/fixtures/user.rb

@@ -1,2 +0,0 @@
-class User < ActiveRecord::Base
-end

data/spec/fixtures/users.yml

@@ -1,30 +0,0 @@
-adam:
-  id: 1
-  name: Adam
-  salary: 80000
-  bonus: true
-
-dave1:
-  id: 2
-  name: Dave
-  salary: 9000
-  bonus: true
-
-dave2:
-  id: 3
-  name: Dave
-  salary: 70000
-  bonus: true
-
-admin:
-  id: 12
-  name: admin
-  salary: 10000
-  bonus: false
-
-goofy:
-  id: 13
-  name: Goofy
-  salary: 11000
-  bonus: false
-

data/spec/helper.rb

@@ -1,6 +0,0 @@
-$:.unshift File.expand_path('..', __FILE__)
-$:.unshift File.expand_path('../../lib', __FILE__)
-require 'simplecov'
-SimpleCov.start
-require 'all_sorts'
-require 'rspec'