filterrific 1.0.1 → 1.1.0

data/doc/todo.md

@@ -1,21 +0,0 @@
-To make it work on Rails 3.1:
-
-* follow kaminari gem for recipe
-* implement new model api
-* leave view and controller as is
-* bump version to 1.0.0 (not backwards compatible)
-
-Later:
-* build filterrific-recipes on github wiki
-* update readme
-* update view and controller apis
-
-
-# Implementation Plan for Filterrific
-
-## Version 0.1.0: Rebuild current Rails2 functionality
-
-## Add DSL and scope generator
-## Write specs (http://avdi.org/devblog/2011/04/07/rspec-is-for-the-literate/ also read comments about be_...!)
-## Add Filterrific form builder
-

data/doc/workflow.md

@@ -1,17 +0,0 @@
-# Workflow to Maintain This Gem
-
-1. Update code and commit it.
-2. Bump the version with one of the rake tasks:
-   * `rake version:bump:patch` 1.5.3 -> 1.5.4
-   * `rake version:bump:minor` 1.5.3 -> 1.6.0
-   * `rake version:bump:major` 1.5.3 -> 2.0.0
-   * `rake version:write MAJOR=2 MINOR=3 PATCH=6` 1.5.3 -> 2.3.6
-3. Add entry to CHANGELOG:
-   * h1 for major release
-   * h2 for minor release
-   * h3 for patch release
-4. Release it.
-   * `rake release`
-   * Optionally release it to Rubyforge: `rake rubyforge:release`
-   * Optionally release it to Gemcutter: `rake gemcutter:release`
-5. Rinse and repeat

data/filterrific.gemspec

@@ -1,75 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{filterrific}
-  s.version = "1.0.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jo Hund"]
-  s.date = %q{2011-11-09}
-  s.description = %q{
-      The Rails User Interface solution for filtering your ActiveRecord lists:
-
-      * Built from the ground up for Rails3
-      * Build filter forms with ease
-      * Filter ActiveRecord lists using AR scopes
-      * Shuttle filter parameters from view to controller to model in a RESTful way
-      * Auto-generate scopes for AR associations (Planned)
-      * Form builder for filter UI forms (Planned)
-    }
-  s.email = %q{jhund@clearcove.ca}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.rdoc"
-  ]
-  s.files = [
-    "CHANGELOG.md",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "doc/Overview diagram.graffle/QuickLook/Preview.pdf",
-    "doc/Overview diagram.graffle/QuickLook/Thumbnail.tiff",
-    "doc/Overview diagram.graffle/data.plist",
-    "doc/Overview diagram.graffle/image1.tiff",
-    "doc/development_notes/api_design.txt",
-    "doc/development_notes/controller_api.txt",
-    "doc/development_notes/model_api.rb",
-    "doc/development_notes/view_api.txt",
-    "doc/documentation.md",
-    "doc/ideas.txt",
-    "doc/todo.md",
-    "doc/workflow.md",
-    "filterrific.gemspec",
-    "lib/filterrific.rb",
-    "lib/filterrific/model_mixin.rb",
-    "lib/filterrific/param_set.rb",
-    "lib/filterrific/railtie.rb",
-    "lib/filterrific/view_helpers.rb",
-    "test/helper.rb",
-    "test/test_filterrific.rb"
-  ]
-  s.homepage = %q{http://github.com/jhund/filterrific}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
-  s.summary = %q{The Rails User Interface solution for filtering your ActiveRecord lists.}
-
-  if s.respond_to? :specification_version then
-    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"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-    else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0"])
-  end
-end
-

data/lib/filterrific/model_mixin.rb

@@ -1,48 +0,0 @@
-module Filterrific::ModelMixin
-    
-  def self.included(base)
-    base.send :extend, ClassMethods
-  end
-
-  module ClassMethods
-
-    # Adds filterrific behavior to class when called like so:
-    # 
-    # filterrific(
-    #   :defaults => { :sorted_by => "created_at_asc" },
-    #   :scope_names => [:sorted_by, :search_query, :with_state]
-    # )
-    #
-    def filterrific(options = {})
-      # send :include, InstanceMethods
-      cattr_accessor :default_filterrific_params
-      cattr_accessor :filterrific_scope_names
-      self.default_filterrific_params = (options[:defaults] || {}).stringify_keys
-      self.filterrific_scope_names = (options[:scope_names] || []).map { |e| e.to_s }
-    end
-
-    # Returns AR relation based on given filterrific_param_set.
-    #
-    # ModelClass.filterrific_find(@filterrific_param_set)
-    #
-    def filterrific_find(filterrific_param_set)
-      unless filterrific_param_set.is_a?(Filterrific::ParamSet)
-        raise(ArgumentError, "Invalid Filterrific::ParamSet: #{ filterrific_param_set.inspect }")
-      end
-
-      # set initial ar_proxy to including class
-      ar_proxy = self
-      
-      # apply filterrific params
-      self.filterrific_scope_names.each do |scope_name|
-        scope_param = filterrific_param_set.send(scope_name)
-        next if scope_param.blank? # skip blank scope_params
-        ar_proxy = ar_proxy.send(scope_name, scope_param)
-      end
-
-      ar_proxy
-    end
-
-  end
-
-end

data/lib/filterrific/railtie.rb

@@ -1,25 +0,0 @@
-require 'filterrific'
-require 'rails'
-
-module Filterrific
-
-  class Railtie < Rails::Railtie
-    
-    initializer "filterrific.model_mixin" do |app|
-      require 'filterrific/model_mixin'
-      ActiveRecord::Base.send(:include, Filterrific::ModelMixin)
-      require 'filterrific/param_set'
-    end
-    
-    initializer "filterrific.view_helpers" do |app|
-      require 'filterrific/view_helpers'
-      ActionView::Base.send(:include, Filterrific::ViewHelpers)
-    end
-    
-    # to_prepare block is executed once in production and before each request in development
-    # config.to_prepare do
-    # end
-
-  end
-  
-end

data/lib/filterrific/view_helpers.rb

@@ -1,35 +0,0 @@
-module Filterrific::ViewHelpers
-
-  # renders javascript to observe filter form
-  def observe_list_options_filter(options = {})
-    # default options
-    options = {
-      :form_id => 'list_options_filter',
-      :method => :get,
-      :live_field_ids => [],
-      :url => url_for(:controller => controller.controller_path, :action => controller.action_name)
-    }.merge(options)
-    # observe the entire form regularly (triggers e.g. when a select option is clicked)
-    # observe_form(
-    #   options[:form_id],
-    #   :function => observer_ajax_javascript(options, 'value'),
-    #   :frequency => 0.5
-    # )
-  end
-
-  def render_list_options_spinner
-    %(<span id="list_options_spinner" class="spinner" style="display:none;"> </span>)
-  end
-
-private
-
-  def observer_ajax_javascript(options, parameters_to_be_submitted)
-    # options = {
-    #   :with => parameters_to_be_submitted,
-    #   :loading => "$('#list_options_spinner').show()",
-    #   :complete => "$('#list_options_spinner').hide()"
-    # }.merge(options)
-    # remote_function(options)
-  end
-
-end

data/test/helper.rb

@@ -1,10 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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