will_sortate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f48de9d7ed4b92ac456067cc0b01ef5cdda21f9a
+  data.tar.gz: cc86dd749e8a0cce28b0385c686710a24ee95965
+SHA512:
+  metadata.gz: e0082bf82a6e413a20c4f8b958ccc642459f4713c39083f80374b31108987831aa811ff44031c314559b7f3d2ff09da00e8104a7f68f862f4dd732a45dd4659e
+  data.tar.gz: 81cbcab6d67c98e38dddc9fe4a186fd2949b16e5b2b44746448c8356dbcc6dcbf17ee2f74a8322bc3196216d9a4a1b7a28dda6423a040fb56b6c8ee38ae3e9bc

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nicola Racco
+
+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,57 @@
+# WillSortate
+
+will_sortate is [will\_paginate](https://github.com/mislav/will_paginate) for sorting. It helps you manage the sorting of an ActiveRecord dataset.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'will_sortate'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install will_sortate
+
+## Usage
+
+### In your controller
+
+```ruby
+    @products = Product.sortate(params[:sort], 'my_field_asc')
+```
+
+The first param given to the `sortate` named scope is the sort argument, while the second param is the default sort argument.
+
+The sort argument indicates the column and order direction, so `my_field_asc` will do an `ORDER BY my_field ASC`
+
+### In your views
+
+```erb
+    <%= sortate_link_to @shorties, :my_field, options %>
+```
+
+The options argument is optional and will be passed to the underlying link_to. In addition you can pass in the options hash:
+
+- `default_sort_order`: the default sort order to use (`asc` or `desc`).
+
+E.g.:
+
+```erb
+    <%= sortate_link_to @shorties, :my_field, class: 'sort_link', default_sort_order: 'desc' %>
+```
+
+## TODO
+
+Tests!
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/will_sortate.rb

@@ -0,0 +1,5 @@
+module WillSortate
+end
+
+require 'rails'
+require 'will_sortate/railtie'

data/lib/will_sortate/helpers/action_view_extension.rb

@@ -0,0 +1,18 @@
+require 'will_sortate/helpers/sorter_helper'
+module WillSortate
+  module ActionViewExtension
+    def sortate_link_to *args, &block
+      if block_given?
+        collection, field, options = args[0], args[1], args[2]
+      else
+        block = proc { args[0].to_s }
+        collection, field, options = args[1], args[2], args[3]
+      end
+      helper = SorterHelper.new :collection         => collection,
+                                :sort_field         => field,
+                                :default_sort_order => options.try(:delete, :default_sort_order),
+                                :params             => params
+      link_to url_for(helper.params), options, &block
+    end
+  end
+end

data/lib/will_sortate/helpers/sorter_helper.rb

@@ -0,0 +1,22 @@
+module WillSortate
+  class SorterHelper
+    def initialize args
+      @collection = args[:collection]
+      @sort_field = args[:sort_field]
+      @default_sort_order = args[:default_sort_order] || 'asc'
+      @params = args[:params]
+    end
+
+    def next_sort_order
+      if @collection.sortated_field == @sort_field.to_s
+        @collection.sortated_order == 'asc' && 'desc' || 'asc'
+      else
+        @default_sort_order
+      end
+    end
+
+    def params
+      @params.merge sort: "#{@sort_field}_#{next_sort_order}"
+    end
+  end
+end

data/lib/will_sortate/models/active_record_extension.rb

@@ -0,0 +1,18 @@
+require 'will_sortate/models/active_record_model_extension'
+
+module WillSortate
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    included do
+      # Future subclasses will pick up the model extension
+      class << self
+        def inherited_with_will_sortate(kls) #:nodoc:
+          inherited_without_will_sortate kls
+          kls.send(:extend, WillSortate::ActiveRecordModelExtension)
+        end
+        alias_method_chain :inherited, :will_sortate
+      end
+    end
+  end
+end

data/lib/will_sortate/models/active_record_model_extension.rb

@@ -0,0 +1,14 @@
+module WillSortate
+  module ActiveRecordModelExtension
+    attr_reader :sortated_field, :sortated_order
+
+    def sortate order_by, default_order_by
+      regexp = /(\w+)_(asc|desc)$/
+      md = order_by.try(:match, regexp) || default_order_by.match(regexp)
+      raise "OrderBy argument has to be specified in the format :field_:direction" unless md
+
+      @sortated_field, @sortated_order = md[1], md[2]
+      order("#{sortated_field} #{sortated_order}")
+    end
+  end
+end

data/lib/will_sortate/railtie.rb

@@ -0,0 +1,15 @@
+module WillSortate
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'will_sortate' do |_app|
+      ActiveSupport.on_load(:active_record) do
+        require 'will_sortate/models/active_record_extension'
+        ActiveRecord::Base.send :include, WillSortate::ActiveRecordExtension
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        require 'will_sortate/helpers/action_view_extension'
+        ::ActionView::Base.send :include, WillSortate::ActionViewExtension
+      end
+    end
+  end
+end

data/lib/will_sortate/version.rb

@@ -0,0 +1,3 @@
+module WillSortate
+  VERSION = "0.0.1"
+end

data/will_sortate.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'will_sortate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "will_sortate"
+  spec.version       = WillSortate::VERSION
+  spec.authors       = ["Nicola Racco"]
+  spec.email         = ["nicola@mikamai.com"]
+  spec.description   = %q{WillSortate is a sorting engine for Rails 3, useful to give your views the power to sort collections}
+  spec.summary       = %q{A sorting engine plugin for Rails 3}
+  spec.homepage      = "https://github.com/mikamai/kaminari"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'rails', '>= 3.0.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: will_sortate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicola Racco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: WillSortate is a sorting engine for Rails 3, useful to give your views
+  the power to sort collections
+email:
+- nicola@mikamai.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/will_sortate.rb
+- lib/will_sortate/helpers/action_view_extension.rb
+- lib/will_sortate/helpers/sorter_helper.rb
+- lib/will_sortate/models/active_record_extension.rb
+- lib/will_sortate/models/active_record_model_extension.rb
+- lib/will_sortate/railtie.rb
+- lib/will_sortate/version.rb
+- will_sortate.gemspec
+homepage: https://github.com/mikamai/kaminari
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A sorting engine plugin for Rails 3
+test_files: []