filterrific 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jo Hund
+
+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,17 @@
+= filterrific
+
+Add filter controls to your ActiveRecord lists and persist filter settings via session or DB.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jo Hund. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "filterrific"
+    gem.summary = %Q{Add filter controls to your ActiveRecord lists and persist filter settings via session or DB}
+    gem.description = %Q{Add filter controls to your ActiveRecord lists and persist filter settings via session or DB}
+    gem.email = "jhund@clearcove.ca"
+    gem.homepage = "http://github.com/jhund/filterrific"
+    gem.authors = ["Jo Hund"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # 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: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/design/ideas.txt

@@ -0,0 +1,102 @@
+Glean specific code from these projects:
+
+20100224 CVIMS
+201001   cando
+201001   PTS
+201001   Quentin-rails-backend
+         stratadocs (list starts with self as AR proxy)
+
+MODEL
+=====
+
+filterrific do
+  associations do
+    person # creates a scope for filterrific
+    state, :default => [1,2,3,4], :label => "Publishing state", :as => :select, :multiple => 4
+  end
+  
+  scopes do
+    active_only, :default => true # refers to already defined scope
+    sorted_by, :default => "created_at_desc"
+  end
+  
+  persist_in_session false # overrides global filterrific settings
+end
+
+Only filters defined in filterrific will be exposed via URL. Other scopes will not be accessible
+
+view
+(skip these for now?)
+apply all relevant options from formtastic
+integrate with formtastic?
+
+
+
+CONTROLLER
+==========
+
+def index
+  init_filterrific(Publication, :publications_list)
+  @publications = Publication.filterrific(@filter_options).paginate...
+  ...
+end
+
+def init_filterrific(klass, scope = nil)
+  scope_name ||= klass.to_s.underscore # use resource class name as default scope name
+  filter_options_hash = params[:filter_options]
+  filter_options_hash ||= session[scope_name]  if filterrific.persist_in_session
+  @filter_options = Filterrific.new(Publication, params[:filter_options])
+  session[scope_name] = @filter_options.to_hash   if filterrific.persist_in_session # (store sanitized options). Maybe just define marshal dump? skip to_hash
+end
+  
+  
+Filterrific CONFIG
+==================
+
+Settings:
+* persist_in_session
+
+
+
+SAVED SEARCHES
+==============
+
+See cando for implementation
+
+
+
+
+CONTENT FOR README
+==================
+
+
+
+
+This Rails plugin makes it super simple to add filtering to your rails list views.
+
+Some of the features:
+---------------------
+
+* RESTful
+* conditions, sorting, maybe grouping?
+* works with pagination
+* settings can be persisted in session or via database for saved searches
+* works with ActiveRecord
+* gets along well with will_paginate
+
+Possibilities:
+-------------
+
+* integrate with thinking_sphinx
+* integrate with formtastic
+* integrate with will_paginate
+* integrate with make_resourceful
+
+Here is how it works:
+---------------------
+
+Filterrific relies heavily on scopes. Each filter dimension has its own scope. Filterrific makes it
+easy to shuttle user settings to your controllers and models for queries, and back to the views.
+
+
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'filterrific'
+
+class Test::Unit::TestCase
+end

data/test/test_filterrific.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestFilterrific < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: filterrific
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Jo Hund
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Add filter controls to your ActiveRecord lists and persist filter settings via session or DB
+email: jhund@clearcove.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- design/ideas.txt
+- lib/filterrific.rb
+- test/helper.rb
+- test/test_filterrific.rb
+has_rdoc: true
+homepage: http://github.com/jhund/filterrific
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Add filter controls to your ActiveRecord lists and persist filter settings via session or DB
+test_files: 
+- test/helper.rb
+- test/test_filterrific.rb