sort_it_out 0.9.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/Histroy.txt

@@ -0,0 +1,4 @@
+= 0.9.0 2009-11-15
+
+* Ported from a lib in a project to this Gem.
+* No tests yet.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jason Harrelson
+
+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.rdoc

@@ -0,0 +1,76 @@
+= guilded
+
+http://github.com/midas/sort_it_out
+
+
+== DESCRIPTION
+
+Easily add sorting functionality to your Rails controller actions in a clean manner.
+
+
+== FEATURES
+
+* Specify that your controller should resolve the order clause from the params.
+* Configure a default field to sort by if no sorting params are passed in.
+* Map order requests to one or more other field names.  Useful for aggregated fields, etc.
+
+
+== REQUIREMENTS
+
+* Rails >= 2.3
+
+
+== INSTALL
+
+  gem sources -a http://gemcutter.org
+  sudo gem install sort_it_out
+
+
+== USAGE
+
+Add to the Rails environment file:
+
+  config.gem "sort_it_out", :source => 'http://gemcutter.org'
+
+Simplest case:
+
+  class UsersController< ApplicationController
+    sortable
+
+    def index
+      User.find( :all, :order => @order ) # @order is set up by sort_it_out
+      ...
+    end
+  end
+
+In the previous example a before filter is run that will set up an @order variable containing a SQL fragment 
+for the order clause.  The order clause will be set up from the parameters :order and :direction.
+
+More complex case:
+
+  
+  class UsersController< ApplicationController
+    sortable :default => :name, :map => { :name => [:name_last, :name_first, :name_middle] }
+
+    def index
+      User.find( :all, :order => @order ) # @order is set up by sort_it_out
+      ...
+    end
+  end
+
+In the previous example a default field to sort by is configured.  Thus, if there is no :order param, the 
+default field is used.  There is also a map set up.  If the :order param is :name, then the order clause will 
+be built using the name_last, name_first and name_middle fields.
+
+
+== LICENSE
+
+Copyright (c) 2009 C. Jason Harrelson (midas)
+
+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/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sort_it_out"
+    gem.summary = %Q{Easily apply sorting to your Rails controller actions.}
+    gem.description = %Q{Easily apply sorting to your Rails controller actions.}
+    gem.email = "jason@lookforwardenterprises.com"
+    gem.homepage = "http://github.com/midas/sort_it_out"
+    gem.authors = ["Jason Harrelson"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sort_it_out #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.0

data/lib/sort_it_out/sortable.rb

@@ -0,0 +1,38 @@
+module SortItOut
+  module Sortable
+   
+    def self.included( base )
+      base.extend( ActMethods )
+    end
+
+    module ActMethods
+      def sortable( options={} )
+        unless included_modules.include? InstanceMethods
+          include InstanceMethods
+          before_filter :resolve_sort
+          class_inheritable_accessor :options
+        end
+
+        self.options = options
+      end
+    end
+
+    module InstanceMethods
+      def resolve_sort
+        order = params[:order]
+        order = params[:order] = self.options[:default] unless order
+        params[:direction] = 'ASC' unless params[:direction]
+        @order = order.nil? ? "" : resolve_order_clause( order, params[:direction] )
+      end
+
+      protected
+
+      def resolve_order_clause( order, dir="ASC" )
+        translated = self.options[:map][order.to_sym]
+        order = translated unless translated.nil?
+        return order.is_a?( Array ) ? order.map { |field| "#{field} #{dir}" }.join( ", " ) : "#{order} #{dir}"
+      end
+    end
+     
+  end
+end

data/lib/sort_it_out.rb

@@ -0,0 +1,10 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'sort_it_out/sortable.rb'
+
+module SortItOut
+  VERSION = '0.9.0'
+end
+
+ActionController::Base.send( :include, SortItOut::Sortable ) if defined?( ActionController::Base )

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/sort_it_out.rb'}"
+puts "Loading sort_it_out gem"
+exec "#{irb} #{libs} --simple-prompt"

data/sort_it_out.gemspec

@@ -0,0 +1,57 @@
+# 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{sort_it_out}
+  s.version = "0.9.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jason Harrelson"]
+  s.date = %q{2009-11-15}
+  s.description = %q{Easily apply sorting to your Rails controller actions.}
+  s.email = %q{jason@lookforwardenterprises.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Histroy.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sort_it_out.rb",
+     "lib/sort_it_out/sortable.rb",
+     "script/console",
+     "sort_it_out.gemspec",
+     "spec/sort_it_out_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/midas/sort_it_out}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Easily apply sorting to your Rails controller actions.}
+  s.test_files = [
+    "spec/sort_it_out_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>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/spec/sort_it_out_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SortItOut" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'sort_it_out'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: sort_it_out
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-15 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Easily apply sorting to your Rails controller actions.
+email: jason@lookforwardenterprises.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Histroy.txt
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sort_it_out.rb
+- lib/sort_it_out/sortable.rb
+- script/console
+- sort_it_out.gemspec
+- spec/sort_it_out_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/midas/sort_it_out
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Easily apply sorting to your Rails controller actions.
+test_files: 
+- spec/sort_it_out_spec.rb
+- spec/spec_helper.rb