sortable-model 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,6 +1,33 @@
 = sortable-model
 
-Description goes here.
+Sortable-model provides a DSL for creating named scopes that order the object in question based
+on its own attributes or those of its associations. It also provides a method for calling those
+scopes that allows the values to come directly from params without the risk of arbitrary code execution.
+
+Examples:
+
+# Schema:
+# Student: id (primary key), name (string), :major (string)
+# Papers: id (primary key), student_id (int), title (string), grade (int)
+
+class Student < ActiveRecord::Base
+  
+  has_many :papers
+
+  sortable_model
+
+  can_sort_by :name 
+    #=> student.sorted_by(:name) is students ordered by name DESC
+    #=> student.sorted_by(:name, true) is students ordered by name ASC
+  can_sort_by :grades, :papers => :grade
+    #=> student.sorted_by(:grades) is student ordered by the grades of her papers DESC
+  can_sort_by :something_complicated, lambda { |stdnt|
+    # some code that returns an order hash
+  }
+    #=> This one is really just a named scope that can use the sorted_by sanitizing method
+end
+
+The #sorted_by method takes either strings or symbols for the name of the sorter.
 
 == Note on Patches/Pull Requests
  
@@ -14,4 +41,4 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2010 Jon Distad. See LICENSE for details.
+Copyright (c) 2010 EdgeCase LLC. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/sortable-model.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sortable-model}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["EdgeCase LLC"]
+  s.date = %q{2010-02-03}
+  s.description = %q{Sortable-model provides a DSL for creating named scopes that order the object in question based
+on its own attributes or those of its associations. It also provides a method for calling those
+scopes that allows the values to come directly from params without the risk of arbitrary code execution.
+}
+  s.email = %q{github@edgecase.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sortable-model.rb",
+     "sortable-model.gemspec",
+     "spec/sortable-model_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/edgecase/sortable-model}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{DSL for generating ordering named-scopes for ActiveRecord models}
+  s.test_files = [
+    "spec/sortable-model_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sortable-model
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - EdgeCase LLC
@@ -43,6 +43,7 @@ files:
 - Rakefile
 - VERSION
 - lib/sortable-model.rb
+- sortable-model.gemspec
 - spec/sortable-model_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb