scope_filters 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +5 -0
- data/.gitignore +21 -0
- data/LICENSE +20 -0
- data/README.rdoc +28 -0
- data/Rakefile +53 -0
- data/VERSION +1 -0
- data/app/views/scope_filters/_filter_links.html.erb +10 -0
- data/lib/scope_filters.rb +5 -0
- data/lib/scope_filters/extensions.rb +80 -0
- data/scope_filters.gemspec +56 -0
- data/test/helper.rb +10 -0
- data/test/test_scope_filters.rb +7 -0
- metadata +93 -0
data/.document
ADDED
data/.gitignore
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 Patrick Klingemann
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
= scope_filters
|
2
|
+
|
3
|
+
A simple Rails plugin the takes creates generates filter links for a model/resource in a view.
|
4
|
+
|
5
|
+
== Note on Patches/Pull Requests
|
6
|
+
|
7
|
+
* Fork the project.
|
8
|
+
* Make your feature addition or bug fix.
|
9
|
+
* Add tests for it. This is important so I don't break it in a
|
10
|
+
future version unintentionally.
|
11
|
+
* Commit, do not mess with rakefile, version, or history.
|
12
|
+
(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)
|
13
|
+
* Send me a pull request. Bonus points for topic branches.
|
14
|
+
|
15
|
+
== How to use
|
16
|
+
|
17
|
+
1. add 'gem 'scope_filters' to your Gemfile
|
18
|
+
2. in an erb view do:
|
19
|
+
|
20
|
+
<%= filter_links('ModelName') %>
|
21
|
+
|
22
|
+
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:
|
23
|
+
|
24
|
+
<%= filter_links('ModelName', { :search_term => 'guyute' }) %>
|
25
|
+
|
26
|
+
== Copyright
|
27
|
+
|
28
|
+
Copyright (c) 2010 Patrick Klingemann. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "scope_filters"
|
8
|
+
gem.summary = %Q{Chainable, Toggleable Resource Filters for ActiveRecord Models}
|
9
|
+
gem.description = %Q{A Rails plugin that facilitates the creation of toggleable, chainable filter links in collection views, based on defined scopes.}
|
10
|
+
gem.email = "patrick.klingemann@gmail.com"
|
11
|
+
gem.homepage = "http://github.com/pklingem/scope_filters"
|
12
|
+
gem.authors = ["Patrick Klingemann"]
|
13
|
+
gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
|
14
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
15
|
+
end
|
16
|
+
Jeweler::GemcutterTasks.new
|
17
|
+
rescue LoadError
|
18
|
+
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
19
|
+
end
|
20
|
+
|
21
|
+
require 'rake/testtask'
|
22
|
+
Rake::TestTask.new(:test) do |test|
|
23
|
+
test.libs << 'lib' << 'test'
|
24
|
+
test.pattern = 'test/**/test_*.rb'
|
25
|
+
test.verbose = true
|
26
|
+
end
|
27
|
+
|
28
|
+
begin
|
29
|
+
require 'rcov/rcovtask'
|
30
|
+
Rcov::RcovTask.new do |test|
|
31
|
+
test.libs << 'test'
|
32
|
+
test.pattern = 'test/**/test_*.rb'
|
33
|
+
test.verbose = true
|
34
|
+
end
|
35
|
+
rescue LoadError
|
36
|
+
task :rcov do
|
37
|
+
abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
task :test => :check_dependencies
|
42
|
+
|
43
|
+
task :default => :test
|
44
|
+
|
45
|
+
require 'rake/rdoctask'
|
46
|
+
Rake::RDocTask.new do |rdoc|
|
47
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
48
|
+
|
49
|
+
rdoc.rdoc_dir = 'rdoc'
|
50
|
+
rdoc.title = "scope_filters #{version}"
|
51
|
+
rdoc.rdoc_files.include('README*')
|
52
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
53
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.0.2
|
@@ -0,0 +1,10 @@
|
|
1
|
+
<ul class="filter-links">
|
2
|
+
<% model_class.scopes.keys.each do |scope| %>
|
3
|
+
<% scope_name = scope.to_s %>
|
4
|
+
<% if applied_scopes.include?(scope_name) %>
|
5
|
+
<li class="scope-applied"><%= link_to(scope_name.titleize, remove_scope_path(scope_name, additional_params)) %></li>
|
6
|
+
<% else %>
|
7
|
+
<li><%= link_to(scope_name.titleize, apply_scope_path(scope_name, additional_params)) %></li>
|
8
|
+
<% end %>
|
9
|
+
<% end %>
|
10
|
+
</ul>
|
@@ -0,0 +1,80 @@
|
|
1
|
+
module ScopeFilters
|
2
|
+
module Extensions
|
3
|
+
|
4
|
+
module ActiveRecord
|
5
|
+
def self.included(base)
|
6
|
+
base.class_eval do
|
7
|
+
def self.apply_scopes(scopes_hash)
|
8
|
+
scoped_relation = select('*')
|
9
|
+
return scoped_relation if scopes_hash.nil?
|
10
|
+
scopes_array = scopes_hash.keys.collect {|scope| scope.to_sym}
|
11
|
+
(scopes_array & scopes.keys).each do |scope|
|
12
|
+
scoped_relation = scoped_relation.send(scope)
|
13
|
+
end
|
14
|
+
return scoped_relation
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
module ScopeFiltersHelper
|
21
|
+
def filter_links(model = nil, additional_params = {})
|
22
|
+
case model
|
23
|
+
when nil
|
24
|
+
model_name = @controller.controller_name.titleize
|
25
|
+
when String, Symbol, Class
|
26
|
+
model_name = model.to_s
|
27
|
+
else
|
28
|
+
raise ArgumentError, "incorrect model object"
|
29
|
+
end
|
30
|
+
# render 'scope_filters/filter_links', :model_class => model_name.constantize, :additional_params => additional_params
|
31
|
+
filter_links_markup(model_name.constantize, additional_params)
|
32
|
+
end
|
33
|
+
|
34
|
+
def filter_links_markup(model_class, additional_params)
|
35
|
+
content_tag(:ul, :class => 'filter-links') do
|
36
|
+
model_class.scopes.keys.collect do |scope|
|
37
|
+
filter_link(scope.to_s, additional_params)
|
38
|
+
end.join('')
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
def filter_link(scope_name, additional_params)
|
43
|
+
if applied_scopes.include?(scope_name)
|
44
|
+
content_tag(:li, :class => 'scope-applied') do
|
45
|
+
link_to(scope_name.titleize, remove_scope_path(scope_name, additional_params))
|
46
|
+
end
|
47
|
+
else
|
48
|
+
content_tag(:li) do
|
49
|
+
link_to(scope_name.titleize, apply_scope_path(scope_name, additional_params))
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
def applied_scopes_hash
|
54
|
+
params[:scopes].nil? ? {} : params[:scopes].reject {|key, value| false}
|
55
|
+
end
|
56
|
+
|
57
|
+
def applied_scopes
|
58
|
+
applied_scopes_hash.keys
|
59
|
+
end
|
60
|
+
|
61
|
+
def params_for_remove_scope_path(scope_name)
|
62
|
+
params_with_removed_scope = {}
|
63
|
+
params_with_removed_scope[:scopes] = applied_scopes_hash.reject {|key, value| key == scope_name} unless applied_scopes_hash.empty?
|
64
|
+
params_with_removed_scope.delete(:scopes) if params_with_removed_scope[:scopes].empty?
|
65
|
+
return params_with_removed_scope
|
66
|
+
end
|
67
|
+
|
68
|
+
def remove_scope_path(scope_name, additional_params = {})
|
69
|
+
request_parameters = params_for_remove_scope_path(scope_name).merge(additional_params)
|
70
|
+
"#{request.path}#{request_parameters.empty? ? '' : '?'}#{request_parameters.to_query}"
|
71
|
+
end
|
72
|
+
|
73
|
+
def apply_scope_path(scope_name, additional_params = {})
|
74
|
+
request_parameters = { :scopes => applied_scopes_hash.merge({scope_name => nil}) }.merge(additional_params)
|
75
|
+
"#{request.path}?#{request_parameters.to_query}"
|
76
|
+
end
|
77
|
+
end
|
78
|
+
|
79
|
+
end
|
80
|
+
end
|
@@ -0,0 +1,56 @@
|
|
1
|
+
# Generated by jeweler
|
2
|
+
# DO NOT EDIT THIS FILE DIRECTLY
|
3
|
+
# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
|
4
|
+
# -*- encoding: utf-8 -*-
|
5
|
+
|
6
|
+
Gem::Specification.new do |s|
|
7
|
+
s.name = %q{scope_filters}
|
8
|
+
s.version = "0.0.2"
|
9
|
+
|
10
|
+
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
|
+
s.authors = ["Patrick Klingemann"]
|
12
|
+
s.date = %q{2010-10-22}
|
13
|
+
s.description = %q{A Rails plugin that facilitates the creation of toggleable, chainable filter links in collection views, based on defined scopes.}
|
14
|
+
s.email = %q{patrick.klingemann@gmail.com}
|
15
|
+
s.extra_rdoc_files = [
|
16
|
+
"LICENSE",
|
17
|
+
"README.rdoc"
|
18
|
+
]
|
19
|
+
s.files = [
|
20
|
+
".document",
|
21
|
+
".gitignore",
|
22
|
+
"LICENSE",
|
23
|
+
"README.rdoc",
|
24
|
+
"Rakefile",
|
25
|
+
"VERSION",
|
26
|
+
"app/views/scope_filters/_filter_links.html.erb",
|
27
|
+
"lib/scope_filters.rb",
|
28
|
+
"lib/scope_filters/extensions.rb",
|
29
|
+
"scope_filters.gemspec",
|
30
|
+
"test/helper.rb",
|
31
|
+
"test/test_scope_filters.rb"
|
32
|
+
]
|
33
|
+
s.homepage = %q{http://github.com/pklingem/scope_filters}
|
34
|
+
s.rdoc_options = ["--charset=UTF-8"]
|
35
|
+
s.require_paths = ["lib"]
|
36
|
+
s.rubygems_version = %q{1.3.7}
|
37
|
+
s.summary = %q{Chainable, Toggleable Resource Filters for ActiveRecord Models}
|
38
|
+
s.test_files = [
|
39
|
+
"test/test_scope_filters.rb",
|
40
|
+
"test/helper.rb"
|
41
|
+
]
|
42
|
+
|
43
|
+
if s.respond_to? :specification_version then
|
44
|
+
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
|
45
|
+
s.specification_version = 3
|
46
|
+
|
47
|
+
if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
|
48
|
+
s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
|
49
|
+
else
|
50
|
+
s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
|
51
|
+
end
|
52
|
+
else
|
53
|
+
s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
data/test/helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,93 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: scope_filters
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
hash: 27
|
5
|
+
prerelease: false
|
6
|
+
segments:
|
7
|
+
- 0
|
8
|
+
- 0
|
9
|
+
- 2
|
10
|
+
version: 0.0.2
|
11
|
+
platform: ruby
|
12
|
+
authors:
|
13
|
+
- Patrick Klingemann
|
14
|
+
autorequire:
|
15
|
+
bindir: bin
|
16
|
+
cert_chain: []
|
17
|
+
|
18
|
+
date: 2010-10-22 00:00:00 -04:00
|
19
|
+
default_executable:
|
20
|
+
dependencies:
|
21
|
+
- !ruby/object:Gem::Dependency
|
22
|
+
name: thoughtbot-shoulda
|
23
|
+
prerelease: false
|
24
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
hash: 3
|
30
|
+
segments:
|
31
|
+
- 0
|
32
|
+
version: "0"
|
33
|
+
type: :development
|
34
|
+
version_requirements: *id001
|
35
|
+
description: A Rails plugin that facilitates the creation of toggleable, chainable filter links in collection views, based on defined scopes.
|
36
|
+
email: patrick.klingemann@gmail.com
|
37
|
+
executables: []
|
38
|
+
|
39
|
+
extensions: []
|
40
|
+
|
41
|
+
extra_rdoc_files:
|
42
|
+
- LICENSE
|
43
|
+
- README.rdoc
|
44
|
+
files:
|
45
|
+
- .document
|
46
|
+
- .gitignore
|
47
|
+
- LICENSE
|
48
|
+
- README.rdoc
|
49
|
+
- Rakefile
|
50
|
+
- VERSION
|
51
|
+
- app/views/scope_filters/_filter_links.html.erb
|
52
|
+
- lib/scope_filters.rb
|
53
|
+
- lib/scope_filters/extensions.rb
|
54
|
+
- scope_filters.gemspec
|
55
|
+
- test/helper.rb
|
56
|
+
- test/test_scope_filters.rb
|
57
|
+
has_rdoc: true
|
58
|
+
homepage: http://github.com/pklingem/scope_filters
|
59
|
+
licenses: []
|
60
|
+
|
61
|
+
post_install_message:
|
62
|
+
rdoc_options:
|
63
|
+
- --charset=UTF-8
|
64
|
+
require_paths:
|
65
|
+
- lib
|
66
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
67
|
+
none: false
|
68
|
+
requirements:
|
69
|
+
- - ">="
|
70
|
+
- !ruby/object:Gem::Version
|
71
|
+
hash: 3
|
72
|
+
segments:
|
73
|
+
- 0
|
74
|
+
version: "0"
|
75
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
76
|
+
none: false
|
77
|
+
requirements:
|
78
|
+
- - ">="
|
79
|
+
- !ruby/object:Gem::Version
|
80
|
+
hash: 3
|
81
|
+
segments:
|
82
|
+
- 0
|
83
|
+
version: "0"
|
84
|
+
requirements: []
|
85
|
+
|
86
|
+
rubyforge_project:
|
87
|
+
rubygems_version: 1.3.7
|
88
|
+
signing_key:
|
89
|
+
specification_version: 3
|
90
|
+
summary: Chainable, Toggleable Resource Filters for ActiveRecord Models
|
91
|
+
test_files:
|
92
|
+
- test/test_scope_filters.rb
|
93
|
+
- test/helper.rb
|