scope_filters 0.0.2

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Patrick Klingemann
+
+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,28 @@
+= scope_filters
+
+A simple Rails plugin the takes creates generates filter links for a model/resource in a view.
+
+== 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.
+
+== How to use
+
+1. add 'gem 'scope_filters' to your Gemfile
+2. in an erb view do:
+
+<%= filter_links('ModelName') %>
+
+optionally, you may include additional HTTP parameters which should be included in the generated urls by passing a hash as the second argument, like so:
+
+<%= filter_links('ModelName', { :search_term => 'guyute' }) %>
+
+== Copyright
+
+Copyright (c) 2010 Patrick Klingemann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "scope_filters"
+    gem.summary = %Q{Chainable, Toggleable Resource Filters for ActiveRecord Models}
+    gem.description = %Q{A Rails plugin that facilitates the creation of toggleable, chainable filter links in collection views, based on defined scopes.}
+    gem.email = "patrick.klingemann@gmail.com"
+    gem.homepage = "http://github.com/pklingem/scope_filters"
+    gem.authors = ["Patrick Klingemann"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scope_filters #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/app/views/scope_filters/_filter_links.html.erb

@@ -0,0 +1,10 @@
+<ul class="filter-links">
+  <% model_class.scopes.keys.each do |scope| %>
+    <% scope_name = scope.to_s %>
+    <% if applied_scopes.include?(scope_name) %>
+      <li class="scope-applied"><%= link_to(scope_name.titleize, remove_scope_path(scope_name, additional_params)) %></li>
+    <% else %>
+      <li><%= link_to(scope_name.titleize, apply_scope_path(scope_name, additional_params)) %></li>
+    <% end %>
+  <% end %>
+</ul>

data/lib/scope_filters.rb

@@ -0,0 +1,5 @@
+require "active_record" 
+require "scope_filters/extensions" 
+
+ActiveRecord::Base.class_eval { include ScopeFilters::Extensions::ActiveRecord }
+ActionView::Base.send :include, ScopeFilters::Extensions::ScopeFiltersHelper 

data/lib/scope_filters/extensions.rb

@@ -0,0 +1,80 @@
+module ScopeFilters
+  module Extensions
+    
+    module ActiveRecord
+      def self.included(base)
+        base.class_eval do
+          def self.apply_scopes(scopes_hash)
+            scoped_relation = select('*')
+            return scoped_relation if scopes_hash.nil?
+            scopes_array = scopes_hash.keys.collect {|scope| scope.to_sym}
+            (scopes_array & scopes.keys).each do |scope|
+              scoped_relation = scoped_relation.send(scope)
+            end
+            return scoped_relation
+          end
+        end
+      end
+    end
+
+    module ScopeFiltersHelper 
+      def filter_links(model = nil, additional_params = {})
+        case model
+        when nil
+          model_name = @controller.controller_name.titleize
+        when String, Symbol, Class
+          model_name = model.to_s
+        else
+          raise ArgumentError, "incorrect model object"
+        end
+#       render 'scope_filters/filter_links', :model_class => model_name.constantize, :additional_params => additional_params
+        filter_links_markup(model_name.constantize, additional_params)
+      end
+      
+      def filter_links_markup(model_class, additional_params)
+        content_tag(:ul, :class => 'filter-links') do
+          model_class.scopes.keys.collect do |scope|
+            filter_link(scope.to_s, additional_params)
+          end.join('')
+        end
+      end
+
+      def filter_link(scope_name, additional_params)
+        if applied_scopes.include?(scope_name)
+          content_tag(:li, :class => 'scope-applied') do
+            link_to(scope_name.titleize, remove_scope_path(scope_name, additional_params))
+          end
+        else
+          content_tag(:li) do
+            link_to(scope_name.titleize, apply_scope_path(scope_name, additional_params))
+          end
+        end
+      end
+      def applied_scopes_hash
+        params[:scopes].nil? ? {} : params[:scopes].reject {|key, value| false}
+      end
+
+      def applied_scopes
+        applied_scopes_hash.keys
+      end
+      
+      def params_for_remove_scope_path(scope_name)
+        params_with_removed_scope = {}
+        params_with_removed_scope[:scopes] = applied_scopes_hash.reject {|key, value| key == scope_name} unless applied_scopes_hash.empty?
+        params_with_removed_scope.delete(:scopes) if params_with_removed_scope[:scopes].empty?
+        return params_with_removed_scope
+      end
+
+      def remove_scope_path(scope_name, additional_params = {})
+        request_parameters = params_for_remove_scope_path(scope_name).merge(additional_params)
+        "#{request.path}#{request_parameters.empty? ? '' : '?'}#{request_parameters.to_query}"
+      end
+      
+      def apply_scope_path(scope_name, additional_params = {})
+        request_parameters = { :scopes => applied_scopes_hash.merge({scope_name => nil}) }.merge(additional_params)
+        "#{request.path}?#{request_parameters.to_query}"
+      end
+    end
+
+  end
+end

data/scope_filters.gemspec

@@ -0,0 +1,56 @@
+# 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{scope_filters}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Patrick Klingemann"]
+  s.date = %q{2010-10-22}
+  s.description = %q{A Rails plugin that facilitates the creation of toggleable, chainable filter links in collection views, based on defined scopes.}
+  s.email = %q{patrick.klingemann@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "app/views/scope_filters/_filter_links.html.erb",
+     "lib/scope_filters.rb",
+     "lib/scope_filters/extensions.rb",
+     "scope_filters.gemspec",
+     "test/helper.rb",
+     "test/test_scope_filters.rb"
+  ]
+  s.homepage = %q{http://github.com/pklingem/scope_filters}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Chainable, Toggleable Resource Filters for ActiveRecord Models}
+  s.test_files = [
+    "test/test_scope_filters.rb",
+     "test/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::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

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 'scope_filters'
+
+class Test::Unit::TestCase
+end

data/test/test_scope_filters.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestScopeFilters < 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,93 @@
+--- !ruby/object:Gem::Specification 
+name: scope_filters
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Patrick Klingemann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  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: A Rails plugin that facilitates the creation of toggleable, chainable filter links in collection views, based on defined scopes.
+email: patrick.klingemann@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- app/views/scope_filters/_filter_links.html.erb
+- lib/scope_filters.rb
+- lib/scope_filters/extensions.rb
+- scope_filters.gemspec
+- test/helper.rb
+- test/test_scope_filters.rb
+has_rdoc: true
+homepage: http://github.com/pklingem/scope_filters
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Chainable, Toggleable Resource Filters for ActiveRecord Models
+test_files: 
+- test/test_scope_filters.rb
+- test/helper.rb