sortable_columns 0.0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+
+spec/internal/db/*.sqlite3
+spec/internal/log/*.log

data/.rspec

@@ -0,0 +1 @@
+--colour

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Brian McNabb
+
+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,47 @@
+= sortable_columns
+
+A clean and lightweight solution for making table columns sortable.
+
+== Features
+
+=== Easy to use
+Just bundle the gem, then your models are ready to be sorted by columns. No configuration required. Don't have to define anything in your models or helpers.
+
+=== Simple scope-based API
+Everything is method chainable.
+
+== Install
+
+Put this line in your Gemfile:
+  gem 'sortable_columns'
+
+Then bundle:
+  % bundle
+
+
+== Usage
+
+=== Query Basics
+
+* the +sort+ scope
+
+  To sort the 'updated_at' column descending from the most recently updated to the oldest (default +column+ is 'created_at' || default +direction+ is 'ascending)
+    User.sort('updated_at', 'descending')
+
+=== Controllers
+
+* the sort parameter is in <tt>params[:sort]</tt>
+
+  Typically, your controller code will look like this:
+    @collection = Resource.sort(params[:sort])
+
+=== Views
+
+* the same old helper method
+
+  Just call the +sortable+ helper:
+    <%= sortable column_name %>
+
+== Copyright
+
+Copyright (c) 2011 Brian McNabb. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/lib/sortable_columns/action_view_extensions/sort_helper.rb

@@ -0,0 +1,13 @@
+module SortableColumns
+  module ActionViewExtensions
+    module SortHelper
+      
+      def sortable(column, title = nil)        
+        title ||= column.titleize
+        css_class = column == params[:column] ? "current #{ params[:direction] }" : nil
+        direction = column == params[:column] && params[:direction] == "asc" ? "desc" : "asc"
+        link_to title, params.merge(column: column, direction: direction), {:class => css_class}
+      end
+    end
+  end
+end

data/lib/sortable_columns/column_sorter.rb

@@ -0,0 +1,30 @@
+module SortableColumns
+  class ColumnSorter
+    attr_reader :resource
+    
+    def initialize(resource)
+      @resource = resource
+    end
+    
+    def column(column=nil)
+      return SortableColumns.config.default_sort_column if column.nil?
+      sanitize_column(column) || SortableColumns.config.default_sort_column
+    end
+    
+    def direction(direction=nil)
+      return SortableColumns.config.default_sort_direction if direction.nil?
+      sanitize_direction(direction) || SortableColumns.config.default_sort_direction
+    end
+    
+    
+    private
+    
+    def sanitize_column(column)
+      return column if @resource.attribute_names.include?(column)
+    end
+    
+    def sanitize_direction(direction)
+      return direction if %w[asc desc].include?(direction)
+    end
+  end
+end

data/lib/sortable_columns/config.rb

@@ -0,0 +1,27 @@
+require 'active_support/configurable'
+
+module SortableColumns
+  # Configures global settings for SortableColumns
+  #   SortableColumns.configure do |config|
+  #     config.default_sort_column = 'created_at'
+  #   end
+  def self.configure(&block)
+    yield @config ||= SortableColumns::Configuration.new
+  end
+
+  # Global settings for SortableColumns
+  def self.config
+    @config
+  end
+
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor :default_sort_column
+    config_accessor :default_sort_direction
+  end
+
+  configure do |config|
+    config.default_sort_column    = 'created_at'
+    config.default_sort_direction = 'desc'
+  end
+end

data/lib/sortable_columns/version.rb

@@ -0,0 +1,3 @@
+module SortableColumns
+  VERSION = "0.0.0.1"
+end

data/lib/sortable_columns.rb

@@ -0,0 +1,10 @@
+require 'action_view'
+require 'sortable_columns/config'
+require 'sortable_columns/column_sorter'
+
+module SortableColumns
+  ActiveSupport.on_load(:action_view) do
+    require 'sortable_columns/action_view_extensions/sort_helper'
+    include SortableColumns::ActionViewExtensions::SortHelper
+  end
+end

data/sortable_columns.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sortable_columns/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sortable_columns"
+  s.version     = SortableColumns::VERSION
+  s.authors     = ["Brian McNabb"]
+  s.email       = ["brian.d.mcnabb@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Make your columns sortable... in a snap!}
+  s.description = %q{'sortable_columns' is a clean and lightweight solution for making table columns sortable.}
+
+  s.rubyforge_project = "sortable_columns"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'combustion', '~> 0.3.1'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'factory_girl_rails'
+end

data/spec/factories.rb

@@ -0,0 +1,6 @@
+Factory.define :user do |f|
+  f.sequence(:name) { |n| "John #{('A'..'Z').to_a[(n/2)]} Doe" }
+  f.bio "I'm a fake user created with Factory_Girl"
+  f.sequence(:age) { |n| "#{n}" }
+  f.sequence(:years_till_retirement) { |n| "#{65 - n}" }
+end

data/spec/internal/app/models/user.rb

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

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define do
+  create_table(:users, :force => true) do |t|
+    t.string :name
+    t.text   :bio
+    t.text   :age
+    t.text   :years_till_retirement
+    t.timestamps
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/model/scopes_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../spec_helper', File.dirname(__FILE__))
+
+shared_examples_for 'default' do
+  its('last.name') { should == 'John A Doe' }
+end
+
+describe SortableColumns::ActiveRecordExtension do
+  before :all do
+    (1..50).each { Factory(:user) }
+  end
+  
+  describe '#sort' do
+    context 'sort without any argument (defaults)' do
+      subject { User.sort }
+      it_should_behave_like 'default'
+    end
+    
+    context 'sort with only column argument passed' do
+      subject { User.sort('years_till_retirement') }
+      its('first.name') { should == 'John A Doe' }
+    end
+    
+    context 'sort with both arguments passed' do
+      subject { User.sort('years_till_retirement', 'asc') }
+      its('last.name') { should == 'John A Doe' }
+    end
+    
+    context 'sort with invalid arguments passed' do
+      subject { User.sort('invalid_column', 'invalid_direction') }
+      it_should_behave_like 'default'
+    end
+  end 
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require :default, :development
+
+require 'capybara/rspec'
+
+Combustion.initialize!
+
+require 'rspec/rails'
+require 'capybara/rails'
+require File.join(File.dirname(__FILE__), 'factories')
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: sortable_columns
+version: !ruby/object:Gem::Version
+  version: 0.0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian McNabb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: &70132009918840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: *70132009918840
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70132009904580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70132009904580
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70132009903040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70132009903040
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70132009901860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70132009901860
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70132009900780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70132009900780
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: &70132009899800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70132009899800
+description: ! '''sortable_columns'' is a clean and lightweight solution for making
+  table columns sortable.'
+email:
+- brian.d.mcnabb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- config.ru
+- lib/sortable_columns.rb
+- lib/sortable_columns/action_view_extensions/sort_helper.rb
+- lib/sortable_columns/column_sorter.rb
+- lib/sortable_columns/config.rb
+- lib/sortable_columns/version.rb
+- sortable_columns.gemspec
+- spec/factories.rb
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/model/scopes_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: sortable_columns
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Make your columns sortable... in a snap!
+test_files:
+- spec/factories.rb
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/model/scopes_spec.rb
+- spec/spec_helper.rb