innetra-acts_as_seekable 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Gustavo Adrian Ortiz Monroy
+
+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/Manifest

@@ -0,0 +1,6 @@
+MIT-LICENSE
+init.rb
+Rakefile
+README.rdoc
+lib/active_record/acts/seekable.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,74 @@
+ActsAsSeekable
+==============
+
+This plugin allows you to make your models seekable (searchable) by combining
+filter params with order and search params. The values in the order and search params
+will be used as lambda values for ordered_by and search named_scopes. Values in the
+filter param will be treated as named_scopes. Since this plugin works based on
+named_scopes, it will add an all_records and ordered_by named_scope to all models that have acts_as_seekable in them, you must create your own search named_scope for the seek (search) functionality to work and aditional named_scope for each filter you want.
+When sending the filter param to the seek method, it is very important that you have
+a named_scope called like the value of the parameter, or else it wont work.
+You can specify if your seach will be paginated or not, it will use mislav-will_paginate
+plugin to perform pagination, if you don't that gem installed acts_as_seekable
+will ingnore the :paginate param.
+
+
+Example
+=======
+
+  Example with mislav-will_paginate:
+
+    acts_as_seekable :paginate => true
+          or
+    acts_as_seekable :paginate => :true
+          or
+    acts_as_seekable :paginate => "true"
+
+    named_scope :search, lambda { |search| conditions.... }
+
+
+  ----------------------------------------------------------------
+
+  Example without mislav-will_paginate:
+
+    acts_as_seekable   #short way
+          or
+    acts_as_seekable :paginate => false #long way
+          or
+    acts_as_seekable :paginate => :false #long way
+          or
+    acts_as_seekable :paginate => "false" #long way
+
+    named_scope :search, lambda { |search| conditions.... }
+
+
+  -----------------------------------------------------------------
+
+For a full example of an application working with acts_as_seekable visit
+ http://github.com/gusortiz/acts_as_seekable_example
+
+Copyright (c) 2009 Gustavo Adrian Ortiz Monroy, released under the MIT license
+
+MIT license
+===========
+
+Copyright (c) 2009 Gustavo Adrian Ortiz Monroy
+
+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/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('acts_as_seekable', '0.1.0') do |e|
+  e.description    = "Seekable (search) functionality for Rails applications"
+  e.url            = "http://github.com/innetra/acts_as_seekable"
+  e.author         = "Gus Ortiz"
+  e.email          = "guspidey@gmail.com"
+  e.ignore_pattern = ["tmp/*", "script/*"]
+  e.development_dependencies = []
+end

data/acts_as_seekable.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_seekable}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gus Ortiz"]
+  s.date = %q{2009-05-18}
+  s.description = %q{Seekable (search) functionality for Rails applications}
+  s.email = %q{guspidey@gmail.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/active_record/acts/seekable.rb"]
+  s.files = ["MIT-LICENSE", "init.rb", "Rakefile", "README.rdoc", "lib/active_record/acts/seekable.rb", "Manifest", "acts_as_seekable.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/innetra/acts_as_seekable}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Acts_as_seekable", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{acts_as_seekable}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Seekable (search) functionality for Rails applications}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,3 @@
+$:.unshift "#{File.dirname(__FILE__)}/lib"
+require 'active_record/acts/seekable'
+ActiveRecord::Base.class_eval { include ActiveRecord::Acts::Seekable }

data/lib/active_record/acts/seekable.rb

@@ -0,0 +1,50 @@
+# ActsAsSeekable
+module ActiveRecord
+  module Acts
+    module Seekable
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+
+        attr_accessor :config
+
+        def acts_as_seekable(options = {})
+          self.config = { :paginate => false }
+          self.config.update(options) if options.is_a?(Hash)
+          self.config[:paginate] = eval(config[:paginate].to_s) if config[:paginate].is_a?(Symbol)
+          self.config[:paginate] = eval(config[:paginate]) if config[:paginate].is_a?(String)
+          class_eval <<-EOV
+            include ActiveRecord::Acts::Seekable::ClassMethods
+            named_scope :all_records
+            named_scope :ordered_by, lambda { |order| { :order => order }}
+          EOV
+        end
+
+        def seek(params = {})
+          to_eval = "#{name}.all_records" if !params[:filter]
+
+          if scope = params[:filter]
+            to_eval = "#{name}.#{params[:filter]}" if scopes.has_key?(scope.to_sym)
+          end
+
+          if !params[:search].blank? && scopes.has_key?(:search)
+            to_eval << ".search('#{params[:search]}')"
+          end
+
+          to_eval << ".ordered_by('#{params[:order]}')" if params[:order]
+
+          if eval("#{name}.method_defined?(:paginate)") && config[:paginate] == true
+            to_eval << ".paginate(:page => params[:page],
+              :per_page => params[:per_page] || 5)"
+          end
+
+          eval(to_eval)
+        end
+
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: innetra-acts_as_seekable
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gus Ortiz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-18 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Seekable (search) functionality for Rails applications
+email: guspidey@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/active_record/acts/seekable.rb
+files: 
+- MIT-LICENSE
+- init.rb
+- Rakefile
+- README.rdoc
+- lib/active_record/acts/seekable.rb
+- Manifest
+- acts_as_seekable.gemspec
+has_rdoc: true
+homepage: http://github.com/innetra/acts_as_seekable
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Acts_as_seekable
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: acts_as_seekable
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Seekable (search) functionality for Rails applications
+test_files: []
+