filter_fu 0.5.0 → 0.6.0

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+gem 'sqlite3-ruby', :require => 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    filter_fu (0.6.0)
+      rails (~> 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.1)
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    haml (2.2.24)
+    hanna (0.1.12)
+      haml (~> 2.2.8)
+      rake (~> 0.8.2)
+      rdoc (~> 2.3.0)
+    i18n (0.5.0)
+    mail (2.2.12)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rdoc (2.3.0)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    rspec-rails (2.2.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.2.0)
+    sqlite3-ruby (1.3.2)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+    webrat (0.7.2)
+      nokogiri (>= 1.2.0)
+      rack (>= 1.0)
+      rack-test (>= 0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (>= 4.3.2)
+  filter_fu!
+  hanna (>= 0.1.12)
+  rails (~> 3.0.0)
+  rspec (~> 2.0)
+  rspec-rails (~> 2.0)
+  sqlite3-ruby
+  webrat (>= 0.7.2)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Benedikt Deicke
+Copyright (c) 2009, 2010 Benedikt Deicke
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,6 +1,6 @@
 = filter_fu
 
-This Ruby on Rails plugin adds a filtered_by method to your models. It accepts a hash of filters that are applied using named_scopes. In addition the plugin adds some view helpers to easily build filter forms.
+This Ruby on Rails plugin adds a <tt>.filtered_by</tt> method to your models. It accepts a hash of filters that are applied using scopes. In addition the plugin adds some view helpers to easily build filter forms.
 
 == Install
 
@@ -8,15 +8,17 @@ You can install filter_fu as a gem or as a rails plugin.
 
 === Install as gem
 
-Add this line to your <tt>config/environment.rb</tt> and run <tt>rake gems:install</tt>
+To install the filter_fu gem, simply add it to your Gemfile:
 
-  config.gem 'filter_fu', :source => 'http://www.gemcutter.org'
-  
-=== Install as plugin
+  gem 'filter_fu'
 
-Run this command in your currrent project's +RAILS_ROOT+
+In order to get the latest development version of filter_fu:
 
-  ./script/plugin install git://github.com/benedikt/filter_fu.git
+  gem 'filter_fu', :git => 'git://github.com/benedikt/filter_fu.git'
+
+and run
+
+  bundle install
 
 == Usage
 
@@ -24,52 +26,65 @@ Run this command in your currrent project's +RAILS_ROOT+
 
 To enable filter_fu on a model, simply add one line to its definition:
 
-  class Project
+  class Project < ActiveRecord::Base
     filter_fu
   end
-  
+
 Let's say you don't want your Projects list filtered by its +hidden+ column. You can easly
 tell filter_fu to ignore certian named scopes or columns:
-  
-  class Project
+
+  class Project < ActiveRecord::Base
     filter_fu :except => [:hidden]
   end
 
-Of course this also works the other way round using the <tt>:only</tt> option to only allow filtering 
+Of course this also works the other way round using the <tt>:only</tt> option to only allow filtering
 for the given named scopes or columns:
 
-  class Project
+  class Project < ActiveRecord::Base
     filter_fu :only => [:starts_on, :ends_on]
   end
-  
+
 Once you enabled filter_fu on your model it provides a filtered_by method.
 
   Project.filtered_by(params[:filter])
   Project.filtered_by(params[:filter]).some.named_scopes
-  Project.some.other.named_scopes.filtered_by(params[:filter])
-  
+  Project.some.other.scopes.filtered_by(params[:filter])
+
 
 === Helper
 
 filter_fu comes with helpers to simplify the generation of filter forms:
 
-  <% filter_form do |f| %>
+  <%= filter_form do |f| %>
     # f is a ActionView::Helpers::FormBuilder
   <% end %>
 
 You can also specify a name for the filter (Default is <tt>:filter</tt>). This way you're able to have multiple filters on the same page.
 
-  <% filter_form_for(:product_filter) do |f| %>
+  <%= filter_form_for(:product_filter) do |f| %>
     # f is a ActionView::Helpers::FormBuilder
-  <% end %>  
+  <% end %>
 
-filter_fu will automatically include all other parameters for the current page (ie. pagination parameters) within the form. 
+filter_fu will automatically include all other parameters for the current page (ie. pagination parameters) within the form.
 If you wish to explicitly exclude some you can do this by passing an array as :ignore_parameters option.
 
-  <% filter_form_for(:product_filter, :ignore_parameters => [:page]) do |f| %>
+  <%= filter_form_for(:product_filter, :ignore_parameters => [:page]) do |f| %>
     # f is a ActionView::Helpers::FormBuilder
   <% end %>
 
+It's possible to add default values for <tt>:ignore_parameters</tt>. Simply add something like this to your initializers:
+
+  config.filter_fu.ignore_parameters = [:param_to_ignore]
+
+== Known issues
+
+See http://github.com/benedikt/filter_fu/issues
+
+== Repository
+
+See http://github.com/benedikt/filter_fu and feel free to fork it!
+
+
 == Copyright
 
-Copyright (c) 2009 Benedikt Deicke. See LICENSE for details.
+Copyright (c) 2009, 2010 Benedikt Deicke. See LICENSE for details.

data/Rakefile

@@ -1,60 +1,33 @@
-require 'rubygems'
-require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'hanna/rdoctask'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "filter_fu"
-    gem.summary = %Q{Filter ActiveRecord models using named_scopes}
-    gem.description = %Q{This Ruby on Rails plugin adds a filtered_by method to your models. It accepts a hash of filters that are applied using named_scopes. In addition the plugin adds some view helpers to easily build filter forms.}
-    gem.email = "benedikt@synatic.net"
-    gem.homepage = "http://github.com/benedikt/filter_fu"
-    gem.authors = ["Benedikt Deicke"]
-    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
+spec = Gem::Specification.load("filter_fu.gemspec")
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_opts = ['--options', 'spec/spec.opts']
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
+RSpec::Core::RakeTask.new
+task :default => :spec
 
-namespace :spec do 
-  Spec::Rake::SpecTask.new(:rcov) do |spec|
-    spec.libs << 'lib'
-    spec.pattern = 'spec/**/*_spec.rb'
-    spec.rcov = true
-    spec.rcov_opts = ["--exclude", "^/,^spec/"]
-  end
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "#{spec.name} #{spec.version}"
+  rdoc.options += spec.rdoc_options
+  rdoc.rdoc_files.include(spec.extra_rdoc_files)
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
 
-  Spec::Rake::SpecTask.new(:doc) do |spec|
-    spec.libs << 'lib' << 'spec'
-    spec.spec_opts = ["--color", "--format", "specdoc"]
-    spec.pattern = 'spec/**/*_spec.rb'
+desc "Generates a sandbox Rails app for testing"
+namespace :spec do
+  task "sandbox" do
+    system "mkdir -p tmp/ && bundle exec rails new tmp/sandbox --skip-gemfile"
   end
 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
+desc "Build the .gem file"
+task :build do
+  system "gem build #{spec.name}.gemspec"
+end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "filter_fu #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('LICENSE*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc "Push the .gem file to rubygems.org"
+task :release => :build do
+  system "gem push #{spec.name}-#{spec.version}.gem"
 end

data/lib/filter_fu/active_record.rb

@@ -1,34 +1,31 @@
 module FilterFu
   module ActiveRecord
-    
-    def self.included(base) # :nodoc:
-      base.extend(ClassMethods)
-    end
-    
+    extend ActiveSupport::Concern
+
     module ClassMethods
-      
+
       VALID_FILTER_OPTIONS = [:only, :except]
-      
+
       def filter_fu(opts = {})
         opts = opts.symbolize_keys!
         opts.each_key { |option| raise "Invalid filter_fu option: #{option}" unless VALID_FILTER_OPTIONS.include?(option) }
         raise "Use either :only or :except as a filter_fu option." if opts.has_key?(:only) && opts.has_key?(:except)
-        
+
         opts[:only]   = [opts[:only]].flatten.collect(&:to_sym) if opts[:only]
         opts[:except] = [opts[:except]].flatten.collect(&:to_sym) if opts[:except]
-        
+
         @filter_options = opts
-        
+
         extend SingletonMethods
       end
-      
+
     end
-    
+
     module SingletonMethods
-      
+
       def filtered_by(filter)
         return scoped({}) if !filter || filter.empty?
-                
+
         filter.inject(self) do |memo, (scope, arg)|
           scope = scope.to_sym
           next if protected?(scope)
@@ -39,14 +36,14 @@ module FilterFu
           end
         end || scoped({})
       end
-      
+
       private
-      
+
       def build_anonymous_scope(scope, arg)
         return {} unless column_names.include?(scope.to_s) && !arg.blank?
         { :conditions => { scope => arg } }
       end
-      
+
       def protected?(scope)
         if @filter_options.has_key?(:only)
           return !@filter_options[:only].include?(scope)
@@ -55,8 +52,8 @@ module FilterFu
         end
         return false
       end
-      
+
     end
-    
+
   end
-end
+end

data/lib/filter_fu/view_helper.rb

@@ -1,50 +1,63 @@
 require 'ostruct'
 
 module FilterFu
+
+  class FilterModel < OpenStruct
+    extend ActiveModel::Naming
+    extend ActiveModel::Translation
+
+    def initialize(*args)
+      super
+    end
+  end
+
   module ViewHelper
-    
+
     def self.included(base) # :nodoc:
       base.send :include, InstanceMethods
     end
-    
+
     module InstanceMethods
-      
+
       def filter_form_for(*args, &block)
         raise ArgumentError, 'Missing block' unless block_given?
-        
+
         opts = args.extract_options!
         name = (args.first || :filter).to_sym
-        
+
         opts[:ignore_parameters] ||= []
-        opts[:ignore_parameters] += [:controller, :action, name]
-        
+        opts[:ignore_parameters] += FilterFu.ignore_parameters + [:controller, :action, name]
+        opts[:ignore_parameters].uniq!
+
         opts[:html] ||= {}
         opts[:html][:method] ||= :get
-                
-        form_for(name, OpenStruct.new(params[name]), opts) do |f|
+        opts[:as] = name
+        opts[:url] = {}
+
+        form_for(FilterFu::FilterModel.new(params[name]), opts) do |f|
           hidden_fields_for(params, opts)
           block.call(f)
         end
       end
       alias_method :filter_form, :filter_form_for
-      
+
       private
-      
+
       def hidden_fields_for(params, opts, prefix = nil)
-        params.each_pair do |k, v| 
+        params.each_pair do |k, v|
           next if opts[:ignore_parameters].include?(k.to_sym)
-          
+
           k = "[#{k}]" if prefix
-          
+
           if v.kind_of?(Hash)
             hidden_fields_for(v, opts, "#{prefix}#{k}")
-          else 
-            concat(hidden_field_tag("#{prefix}#{k}", v)) 
+          else
+            concat(hidden_field_tag("#{prefix}#{k}", v))
           end
         end
       end
-      
+
     end
-    
+
   end
-end
+end

data/lib/filter_fu.rb

@@ -1,4 +1,20 @@
-%w(active_record view_helper).each { |file| require File.join(File.dirname(__FILE__), 'filter_fu', file) }
+require 'filter_fu/active_record'
+require 'filter_fu/view_helper'
 
-ActiveRecord::Base.send :include, FilterFu::ActiveRecord
-ActionView::Base.send   :include, FilterFu::ViewHelper
+module FilterFu
+  mattr_accessor :ignore_parameters
+  @@ignore_parameters = []
+
+  class Railtie < Rails::Railtie
+    config.filter_fu = FilterFu
+
+    initializer "filter_fu.initialize" do |app|
+      ::ActiveRecord::Base.send :include, FilterFu::ActiveRecord if defined? ::ActiveRecord::Base
+      ::ActionView::Base.send   :include, FilterFu::ViewHelper if defined? ::ActionView::Base
+    end
+  end
+
+  def self.configure
+    yield self
+  end
+end