filterer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9c55094d34e875077e3903ba1ed4acbb282d7c9
+  data.tar.gz: 5b92580dcd86e828e61d4f65f0ace15355dce657
+SHA512:
+  metadata.gz: 8e94fc28aba2a14e917d69b0b9c2eb0de0200f4c2e1c7853567d5a5456707147d3cfce297e01a690e30db5934a15bfdd1cc3e7619a7c70aa2ed0603c5f69daed
+  data.tar.gz: c8d31b9d5bcd03cca0e9647317d3a50cdd657f17811bf39fe0debb2640fcf99c830fef4556b86b83a1a997c611b1d3d37b3c22fd5bc9b912d11ef72c53e04d96

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Formbuilder'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'

data/app/helpers/filterer/pagination_helper.rb

@@ -0,0 +1,51 @@
+module Filterer
+  module PaginationHelper
+
+    def render_filterer_pagination(filterer)
+      content_tag(:div, class: 'pagination-wrapper') do
+        content_tag(:ul, class: 'unstyled') do
+          render_filterer_previous_link(filterer) +
+          filterer.paginator.pages.map { |p| render_filterer_page_link(filterer, p) }.join('').html_safe +
+          render_filterer_next_link(filterer)
+        end
+      end
+    end
+
+    private
+    def calculate_filterer_pagination_url(page)
+      url_for(params.merge(page: page))
+    end
+
+    def render_filterer_previous_link(filterer)
+      content_tag(:li, class: filterer.meta[:page] == 1 ? "disabled" : '') do
+        if filterer.meta[:page] == 1
+          content_tag(:span) { '‹' }
+        else
+          content_tag(:a, class: 'pagination-previous',
+                      href: calculate_filterer_pagination_url(filterer.meta[:page] - 1)) { '‹' }
+        end
+      end
+    end
+
+    def render_filterer_next_link(filterer)
+      content_tag(:li, class: filterer.meta[:page] == filterer.meta[:last_page] ? "disabled" : '') do
+        if filterer.meta[:page] == filterer.meta[:last_page]
+          content_tag(:span) { '›' }
+        else
+          content_tag(:a, class: 'pagination-next', href: calculate_filterer_pagination_url(filterer.meta[:page] + 1)) { '›' }
+        end
+      end
+    end
+
+    def render_filterer_page_link(filterer, p)
+      if p == 'break'
+        "<li><span>&hellip;</span></li>"
+      else
+        content_tag(:li, class: p == filterer.meta[:page] ? 'active' : '') do
+          content_tag(:a, href: calculate_filterer_pagination_url(p)) { p.to_s }
+        end
+      end
+    end
+
+  end
+end

data/lib/filterer.rb

@@ -0,0 +1,6 @@
+require 'filterer/engine'
+require 'filterer/base'
+require 'filterer/paginator'
+
+module Filterer
+end

data/lib/filterer/base.rb

@@ -0,0 +1,70 @@
+module Filterer
+  class Base
+
+    attr_accessor :results, :meta, :direction, :sort, :params
+
+    IGNORED_PARAMS = [:page]
+
+    def initialize(params = {}, opts = {})
+      @params, @opts = params, opts
+      setup_meta
+      find_results
+    end
+
+    def paginator
+      @paginator ||= Filterer::Paginator.new(self)
+    end
+
+    def setup_meta
+      @meta = {
+        page: [@params[:page].to_i, 1].max,
+        per_page: 10
+      }
+    end
+
+    def find_results
+      @results = starting_query
+
+      # Add params
+      add_params_to_query
+
+      # Order results
+      order_results
+
+      @meta[:total] = @results.count
+      @meta[:last_page] = [(@meta[:total].to_f / @meta[:per_page]).ceil, 1].max
+      @meta[:page] = [@meta[:last_page], @meta[:page]].min
+
+      return if @opts[:count_only]
+
+      # Add custom meta data if we've defined the method
+      @meta.merge!(self.custom_meta_data) if self.respond_to?(:custom_meta_data)
+
+      @results = @results.limit(@meta[:per_page]).offset((@meta[:page] - 1)*@meta[:per_page])
+    end
+
+    def add_params_to_query
+      @params.reject { |k, v| k.in?(IGNORED_PARAMS) }
+             .select { |k, v| v.present? }
+             .each do |k, v|
+
+        method_name = :"param_#{k}"
+        @results = respond_to?(method_name) ? send(method_name, v) : @results
+      end
+    end
+
+    def order_results
+      # noop
+    end
+
+    def starting_query
+      raise 'You must override this method!'
+    end
+
+    def self.count(params = {}, opts = {})
+      filterer = self.new(params, { count_only: true }.merge(opts))
+      return filterer.meta[:total]
+    end
+
+  end
+end

data/lib/filterer/engine.rb

@@ -0,0 +1,5 @@
+module Filterer
+  class Engine < ::Rails::Engine
+    isolate_namespace Filterer
+  end
+end

data/lib/filterer/paginator.rb

@@ -0,0 +1,51 @@
+module Filterer
+  class Paginator
+
+    attr_reader :pages
+
+    def initialize(searcher)
+      @searcher = searcher
+      return @pages = [1] if @searcher.meta[:last_page] == 1
+      push_default_pages
+      calculate_additional_pages
+      add_breaks
+    end
+
+    def push_default_pages
+      @pages = [1, 2]
+      push_page(@searcher.meta[:last_page], @searcher.meta[:last_page] - 1)
+    end
+
+    def calculate_additional_pages
+      offset = 0
+      current_page = @searcher.meta[:page]
+
+      while @pages.length < 11 && ( (current_page - offset >= 1) || (current_page + offset <= @searcher.meta[:last_page]) ) do
+        push_page(current_page - offset, current_page + offset)
+        offset += 1
+      end
+    end
+
+    def add_breaks
+      pages_without_breaks = @pages.sort
+      pages_with_breaks = []
+
+      pages_without_breaks.each_with_index do |p, i|
+        if pages_without_breaks[i - 1] && (p - pages_without_breaks[i - 1] > 1)
+          pages_with_breaks.push 'break'
+        end
+
+        pages_with_breaks.push p
+      end
+
+      @pages = pages_with_breaks
+    end
+
+    def push_page(*args)
+      args.each do |page|
+        @pages.push(page) unless @pages.include?(page) || (page > @searcher.meta[:last_page]) || (page < 1)
+      end
+    end
+
+  end
+end

data/lib/filterer/version.rb

@@ -0,0 +1,3 @@
+module Filterer
+  VERSION = "0.0.1"
+end

data/lib/tasks/filterer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :filterer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: filterer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Filterer lets your users easily filter results from your ActiveRecord
+  models. What does that mean? Let's imagine a page in your application that lists
+  the results of Person.all. What if you want to let your users filter the results
+  by name? Or email? Or whether or not the Person is an admin? Where does that logic
+  go? One answer could be your controller. That gets ugly fast. Another answer could
+  be in your models. But passing a bunch of query parameters to a model isn't really
+  a good practice either. Enter Filterer.
+email:
+- adam@dobt.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/helpers/filterer/pagination_helper.rb
+- lib/filterer/base.rb
+- lib/filterer/engine.rb
+- lib/filterer/paginator.rb
+- lib/filterer/version.rb
+- lib/filterer.rb
+- lib/tasks/filterer_tasks.rake
+- Rakefile
+homepage: https://github.com/dobtco/filterer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Easily filter results from your ActiveRecord models.
+test_files: []