list_controls 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Laurynas Butkus
+
+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

@@ -0,0 +1,62 @@
+list_controls
+=============
+
+Simple list filtering & sorting for Rails controller. 
+
+Plays nicely with SearchLogic.
+
+
+Example
+=======
+
+Controller:
+
+  class ProductsController < ApplicationController
+    
+    can_filter_and_sort
+  
+    def default_filters
+      { 'state' => 'new' } 
+    end
+  
+    def index
+      @products = Product.all :conditions => { :state => @filters.state }
+    end
+  
+  end
+
+  # Note: 
+  #
+  # Sort param stored in @filters.order, example 'ascend_by_title'
+  # Easy use with SearchLogic.
+
+
+View:
+
+  <div id="filters">
+    <%= form_for :filters, @filters, :html => { :method => :get } do |f| %>
+    
+      <%= f.label :state %>
+      <%= f.select :state, states_for_filter %>
+    
+    <% end %>
+  </div>
+
+  <table>
+    <tr>
+      <th><%= sort @filters, :by => :id %></th>
+      <th><%= sort @filters, :by => :title, :as => t(:product_title) %></th>
+      <th><%= sort @filters, :by => :state, :as => t(:state) %></th>
+    </tr>
+    
+    <% for product in @products %>
+      <tr>
+        <td><%= product.id %></td>
+        <td><%= product.title %></td>
+        <td><%= product.state %></td>
+      </tr>
+    <% end %>    
+  </table>
+
+
+Copyright (c) 2009 Laurynas Butkus, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the filter_and_sort plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the filter_and_sort plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FilterAndSort'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/action_controller.rb

@@ -0,0 +1,42 @@
+module ActionController
+  module ListControls
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+      def can_filter_and_sort(options = {})
+        include ActionController::ListControls::InstanceMethods
+        
+        attr_reader :filters
+        
+        before_filter :set_filters
+      end
+    end
+  
+    module InstanceMethods
+      
+      protected
+      
+      def default_filters
+        {}
+      end
+      
+      def set_filters
+        session[:list_controls]||= {}
+        
+        session_store = session[:list_controls][self.class.to_s]||= {}
+        session_store[:filters] ||= default_filters
+        session_store[:filters].merge!(params[:filters] || {})
+        
+        @filters  = session_store[:filters]
+        
+        session[:list_controls][self.class.to_s] = session_store
+      end
+    end
+  
+  end
+end
+
+::ActionController::Base.send(:include, ActionController::ListControls)

data/lib/rails_helpers.rb

@@ -0,0 +1,39 @@
+module ListControls
+  module RailsHelpers
+    def sort(filters, options = {}, html_options = {})
+      options[:params_scope] ||= :filters
+      options[:ascend_scope] ||= "ascend_by_#{options[:by]}"
+      options[:descend_scope] ||= "descend_by_#{options[:by]}"
+      options[:sort_class] ||= 'sort'
+      
+      current_order = filters['order']
+      
+      ascending = current_order == options[:ascend_scope]
+      new_scope = ascending ? options[:descend_scope] : options[:ascend_scope]
+      selected = [options[:ascend_scope], options[:descend_scope]].include?(current_order)
+      
+      css_classes = html_options[:class] ? html_options[:class].split(" ") : []
+
+      if selected
+        if ascending
+          css_classes << options[:sort_class] + "-up"
+        else
+          css_classes << options[:sort_class] + "-down"
+        end
+      else
+        css_classes << options[:sort_class]
+      end
+      
+      html_options[:class] = css_classes.join(" ")
+
+      url_options = {
+        options[:params_scope] => { :order => new_scope }
+      }.deep_merge(options[:params] || {})
+      
+      link_to options[:as] || options[:by], url_for(url_options), html_options
+    end
+  end
+end
+
+::ActionController::Base.helper(ListControls::RailsHelpers)
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: list_controls
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Laurynas Butkus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Simple list filtering & sorting for Rails controller.
+email: laurynas.butkus@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/action_controller.rb
+- lib/rails_helpers.rb
+- README
+- MIT-LICENSE
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/laurynas/list_controls
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: "[none]"
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple list filtering & sorting for Rails controller
+test_files: []
+