sortify 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bb9b394d937118fbf5e0f2222d11b5bcaa3d7a8
+  data.tar.gz: b26dde80e4cd1a48a7abcd2e72a01d3a510c08ee
+SHA512:
+  metadata.gz: 0634c7b7de9c65a0a806e47ca830d8d22351e6b8c571b9091637ebc92e90552039be11394df802fe7a9bca6a24bf270a239937367edf61b70d3e317a65a68497
+  data.tar.gz: 7ddab951613d58e7c903852e230ac49b728957545dec41bd27ed8b46576ebea1fb8ab705e70e0a15411740e07265b7f3794db1c8e36c058074a7a5782644c3a6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Melody
+
+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,76 @@
+#Sortify
+[![Build Status](https://travis-ci.org/meltheadorable/sortify.svg)](https://travis-ci.org/meltheadorable/sortify)
+[![Code Climate](https://codeclimate.com/github/meltheadorable/sortify/badges/gpa.svg)](https://codeclimate.com/github/meltheadorable/sortify)
+[![Coverage Status](https://coveralls.io/repos/meltheadorable/sortify/badge.svg?branch=stable)](https://coveralls.io/r/meltheadorable/sortify?branch=stable)
+[![Dependency Status](https://gemnasium.com/meltheadorable/sortify.svg)](https://gemnasium.com/meltheadorable/sortify)
+[![Documentation Status](http://inch-ci.org/github/meltheadorable/sortify.svg?branch=develop)](http://inch-ci.org/github/meltheadorable/sortify)
+
+Sortify helps you handle user-provided sort options in Rails apps.
+
+> #### :warning: **Warning**:
+> Sortify is in the very early stages of development right now, has no tests and could introduce breaking changes. Use at your own risk.
+
+## Getting Started
+
+To get started, add sortify to your gemfile:
+
+`gem 'sortify', github: 'meltheadorable/github', branch: 'develop'`
+
+You can then run `bundle install` to fetch the current development version.
+
+## Usage
+
+Using Sortify is very simple. All you need to do is specify sorting options in your models, then call `sortify` in your controllers naming a sorting option.
+
+### Models
+
+Sortify acts as a wrapper around ActiveRecord scopes, providing a tiny bit of extra functionality to keep track of valid sorting options.
+
+If you don't know what scopes are, [you can read about them here](http://guides.rubyonrails.org/active_record_querying.html#scopes):
+
+First you'll need to extend Sortify, and then you can specify your sort options.
+
+```ruby
+class Item < ActiveRecord::Base
+  extend Sortify # includes the sortify methods in your model
+
+  default_sort_option :most_recent
+  sort_option :most_recent, -> { order(updated_at: :desc) }
+  sort_option :created_first, -> { order(created_at: :asc) }
+end
+```
+
+`sort_option` takes a symbol as a name, and a lambda, exactly like an ActiveRecord scope.
+
+You can optionally provide a `default_sort_option` which specifies which sort to use in the event that the user-specified sort is invalid or absent.
+
+
+### Controllers
+
+For your controllers, Sortify provides the `sortify` method, which takes a string naming one of your sort options as an argument. Because Sortify uses scopes under the hood, it can be chained with other scopes.
+
+> #### :warning: **Warning**:
+> The `sortify` method will raise a `NoMethodError` if it cannot find a sorting option with the name you passed in unless a valid default is specified.
+
+```ruby
+class ItemController < ApplicationController
+  def index
+    @items = Item.sortify("most_recent") # sorts your items by most recent
+    @others = Item.sortify(params[:sort]) # sorts by the method specified in the params
+  end
+end
+```
+
+Because it uses scopes under the hood, Sortify also provides separate methods for your sorting options:
+
+```ruby
+class ItemController < ApplicationController
+  def index
+    @items = Item.created_first # all of your Items, sorted by creation date
+  end
+end
+```
+
+## License
+
+Sortify is released under the [MIT License](LICENSE)

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Sortify'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/sortify.rb

@@ -0,0 +1,36 @@
+module Sortify
+  def sort_option(name, body)
+    @sort_options ||= []
+    name = name.to_sym
+    
+    begin
+      scope name, body
+    rescue ArgumentError => e
+      raise e
+    else
+      @sort_options << name
+    end
+  end
+  
+  def default_sort_option(name)
+    @default_sort_option = name.to_sym
+  end
+  
+  def sort_options
+    return @sort_options
+  end
+
+  def sortify(sort_option)
+    sort_option = sort_option.to_sym
+    
+    if @sort_options.include? sort_option
+      self.send(sort_option)
+    else
+      begin
+        self.send(@default_sort_option)
+      rescue
+        raise NoMethodError, "The default sort option you provided, '#{@default_sort_option.to_s}' does not exist."
+      end
+    end
+  end
+end

data/lib/sortify/version.rb

@@ -0,0 +1,3 @@
+module Sortify
+  VERSION = "0.1.1"
+end

data/lib/tasks/sortify_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sortify do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: sortify
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Melody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: fuubar
+  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: coveralls
+  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: appraisal
+  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'
+description: Sortify acts as a wrapper around ActiveRecord scopes, providing a tiny
+  bit of extra functionality to keep track of valid sorting options and call them
+  from user input.
+email:
+- meltheadorable@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/sortify.rb
+- lib/sortify/version.rb
+- lib/tasks/sortify_tasks.rake
+homepage: https://github.com/meltheadorable/sortify
+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: Sortify helps you handle user-provided sort options in Rails apps.
+test_files: []