filternator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d22429121aad479f8d792514084bd1c8acfe74d
+  data.tar.gz: 8838cee850318633224c5ab008bfef59ea9eccf2
+SHA512:
+  metadata.gz: 9e9cf6ad40c9615dde262f23ca9ee377fd6f160db9cb2435ecbb900257df7c55f2151b9fd474c83f5c7e28241356687f102f07d0cb430272980a3f8e6f77d648
+  data.tar.gz: 7ff7ae605d2af28ba557f6a4c97ab8d18c63530b5903b4c38f9d5bdd4773dbf153b6422f7f56bec01df5e8a3f3de0b28b6c59c6ba85ab4a5dcf47565efade4b0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in filternator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+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.md

@@ -0,0 +1,192 @@
+# Filternator
+
+A very basic gem for generating JSON responses for collections.
+
+Currently supported:
+
+* Pagination (via will_paginate)
+* Simple Filters
+
+Not supported:
+
+* Combining multiple filters
+* Filters with parameters
+
+We use this gem in production, but it's uses are very specific to what we use. YMMV.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'filternator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install filternator
+
+## Usage
+
+Given a model:
+
+``` ruby
+class User < ActiveRecord::Base
+
+  def self.all_filters
+    %w(all paying beta_users)
+  end
+
+  def self.paying
+    where(paying: true)
+  end
+
+  def self.beta_users
+    where(beta: true)
+  end
+
+  def self.visible
+    where(visible: true)
+  end
+
+end
+```
+
+Then you can create a filter in the controller:
+
+``` ruby
+def index
+  render json: filter.apply(params)
+end
+
+private
+
+def filter
+  Filternator.new(scope: User.visible)
+end
+```
+
+And you can execute it, like this:
+
+``` ruby
+get :index, filter: "all", "page" => 2
+expect(response.body).to eq({
+  users: [
+    {
+      id:     31,
+      email:  "jennifer@example.org"
+      # etc...
+    }
+  },
+  meta: {
+    filters: ["all", "paying", "beta_users"],
+    applied_filter: "all",
+    pagination: {
+      total:        31,
+      total_pages:  2,
+      first_page:   false,
+      last_page:    true,
+      # and some more
+    }
+  }
+}.to_json)
+```
+
+### Pagination
+
+You can pass the pagination options directly into will_paginate's view helper.
+
+``` erb
+<%= will_paginate OpenStruct.new(@user_response.body["meta"]["pagination"]) %>
+```
+
+(you should probably clean this up, but you get the point)
+
+### Stats
+
+You can also generate an overview of the counts of each filter.
+
+``` ruby
+# in your controller
+def stats
+  render json: filter.stats
+end
+```
+
+Then the output looks something like this:
+
+``` ruby
+get :stats
+expect(response.body).to eq({
+  all:         31,
+  paying:      4,
+  beta_users:  13,
+}.to_json)
+```
+
+## Configuration
+
+There are a bunch of ways to configure the filter.
+
+### Presenters
+
+Use a presenter to change the output of the collection, by giving something that
+can be mapped on each item.
+
+``` ruby
+UserDecorator = Struct.new(:user) do
+
+  def self.to_proc
+    method(:new).to_proc
+  end
+
+  def as_json(*)
+    { name: user.name, email: user.email }
+  end
+
+end
+
+filter = Filternator.new(scope: User, presenter: UserDecorator)
+```
+
+### Scope name
+
+By default, the name of the results is the plural of the model's name. You can
+change it by providing the `:scope_name` option.
+
+``` ruby
+filter = Filternator.new(scope: User.admins, scope_name: "administrators")
+```
+
+### All filters
+
+In the example mentioned above, I defined the list of available methods on the
+class. You can also change the available filters per filterer, by supplying the
+`:all_filters` option.
+
+``` ruby
+# prohibits the access to the `paying`-scope.
+filter  = Filternator.new(scope: User, all_filters: %w(all beta_users))
+```
+
+### Default filter
+
+Note for ActiveRecord 3: `all` will not return a scope, but an array and will
+not work. You use `.scoped` instead. You can also override `.all` to return
+`.scoped`, but that might break some of your code. If you choose a different
+name than `all`, you need to specify it, and allow it with `all_filters`.
+
+``` ruby
+filter = Filternator.new(scope: User, default_filter: "scoped", all_filters: %w(scoped other))
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = "spec"
+    t.rspec_opts = "--format progress"
+  end
+rescue LoadError
+  task :spec do
+    puts "RSpec not installed"
+    exit 1
+  end
+end
+
+task :default => %w(spec)

data/filternator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filternator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "filternator"
+  spec.version       = Filternator::VERSION
+  spec.authors       = ["iain"]
+  spec.email         = ["iain@iain.nl"]
+  spec.description   = %q{A very basic gem for generating JSON responses for collections.}
+  spec.summary       = %q{A very basic gem for generating JSON responses for collections.}
+  spec.homepage      = "https://github.com/yourkarma/filternator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 3.1"
+  spec.add_dependency "will_paginate", ">= 3.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/filternator/apply_filter.rb

@@ -0,0 +1,60 @@
+require "forwardable"
+
+module Filternator
+  class ApplyFilter
+    extend Forwardable
+
+    attr_reader :filterer, :params
+
+    def initialize(filterer, params)
+      @filterer = filterer
+      @params = params
+    end
+
+    def_delegators :filterer, :scope_name, :scope, :all_filters, :presenter, :default_filter
+
+    def as_json(*args)
+      {
+        scope_name => presenters.as_json(*args),
+        :meta => {
+          :filters        => all_filters,
+          :applied_filter => filter,
+          :pagination     => pagination.as_json,
+        },
+      }
+    end
+
+    def count
+      filtered_scope.count
+    end
+
+    def presenters
+      paginated_scope.map(&presenter)
+    end
+
+    def pagination
+      Pagination.new(paginated_scope)
+    end
+
+    def paginated_scope
+      filtered_scope.paginate(page: params[:page])
+    end
+
+    def filter
+      params[:filter].presence || default_filter
+    end
+
+    def filtered_scope
+      if valid_filter?
+        scope.public_send(filter)
+      else
+        scope
+      end
+    end
+
+    def valid_filter?
+      filter.present? && all_filters.include?(filter)
+    end
+
+  end
+end

data/lib/filternator/filter.rb

@@ -0,0 +1,33 @@
+module Filternator
+  class Filter
+
+    attr_reader :scope, :scope_name, :presenter, :all_filters, :default_filter
+
+    def initialize(options = {})
+      @scope          = options.fetch(:scope)
+      @scope_name     = options.fetch(:scope_name)     { derive_scope_name }
+      @presenter      = options.fetch(:presenter)      { null_presenter }
+      @all_filters    = options.fetch(:all_filters)    { scope.all_filters }
+      @default_filter = options.fetch(:default_filter) { "all" }
+    end
+
+    def stats
+      Hash[ all_filters.map { |filter| [ filter, apply(filter: filter).count ] } ]
+    end
+
+    def apply(params)
+      ApplyFilter.new(self, params)
+    end
+
+    private
+
+    def derive_scope_name
+      scope.model_name.element.pluralize
+    end
+
+    def null_presenter
+      lambda { |item| item }
+    end
+
+  end
+end

data/lib/filternator/pagination.rb

@@ -0,0 +1,25 @@
+module Filternator
+  class Pagination
+
+    attr_reader :scope
+
+    def initialize(scope)
+      @scope = scope
+    end
+
+    def as_json(*)
+      {
+        total:          scope.total_entries,
+        total_pages:    scope.total_pages,
+        first_page:     scope.current_page == 1,
+        last_page:      scope.next_page.blank?,
+        current_page:   scope.current_page,
+        previous_page:  scope.previous_page,
+        next_page:      scope.next_page,
+        out_of_bounds:  scope.out_of_bounds?,
+        offset:         scope.offset
+      }
+    end
+
+  end
+end

data/lib/filternator/version.rb

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

data/lib/filternator.rb

@@ -0,0 +1,12 @@
+require "filternator/version"
+require "filternator/filter"
+require "filternator/apply_filter"
+require "filternator/pagination"
+
+module Filternator
+
+  def self.new(options = {})
+    Filter.new(options)
+  end
+
+end

data/spec/integration_spec.rb

@@ -0,0 +1,66 @@
+require "filternator"
+require "active_record"
+require "will_paginate/active_record"
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Migration.create_table :widgets do |t|
+  t.string :state, null: false
+end
+
+class Widget < ActiveRecord::Base
+  def self.all_filters
+    %w(all busy)
+  end
+  scope :busy, -> { where state: "busy" }
+end
+
+describe Filternator do
+
+  before do
+    Widget.delete_all
+  end
+
+  example "a basic filter" do
+    Widget.create! id: 1, state: "idle"
+    Widget.create! id: 2, state: "busy"
+    filter = Filternator.new(scope: Widget)
+    result = filter.apply(filter: "busy")
+    expect(result.as_json).to eq(
+      {
+        "widgets" => [{
+          "id" => 2,
+          "state" => "busy",
+        }],
+        meta: {
+          filters: %w(all busy),
+          applied_filter: "busy",
+          pagination: {
+            total:          1,
+            total_pages:    1,
+            first_page:     true,
+            last_page:      true,
+            current_page:   1,
+            previous_page:  nil,
+            next_page:      nil,
+            out_of_bounds:  false,
+            offset:         0,
+          }
+        }
+      }
+    )
+  end
+
+  example "stats" do
+    Widget.create! id: 1, state: "idle"
+    Widget.create! id: 2, state: "busy"
+    filter = Filternator.new(scope: Widget)
+    expect(filter.stats).to eq(
+      {
+        "all" => 2,
+        "busy" => 1,
+      }
+    )
+  end
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: filternator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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
+  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'
+description: A very basic gem for generating JSON responses for collections.
+email:
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- filternator.gemspec
+- lib/filternator.rb
+- lib/filternator/apply_filter.rb
+- lib/filternator/filter.rb
+- lib/filternator/pagination.rb
+- lib/filternator/version.rb
+- spec/integration_spec.rb
+homepage: https://github.com/yourkarma/filternator
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A very basic gem for generating JSON responses for collections.
+test_files:
+- spec/integration_spec.rb