rice_cooker 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d94102d915bb79855a772a3a7ba515a73c74e873
+  data.tar.gz: 5e987147d9dd89a7f2274d406f5387e9382baf52
+SHA512:
+  metadata.gz: b47b99cc9fd08a3292249bb9597f6399718fc1c1ae256eafc832f34ac4db32ef34cb29d21d412b271955c3fce26e04b9ac79724fa111f5d2a14e50837bb701c4
+  data.tar.gz: 6899285ae631cda10affd5238a392f16aac98781ab09c3ebd6fe82c8302da038c112b02e200f333e086c2b45a55d7024a0cff14a25c8c399768aecd7268c1c7b

data/.gitignore

@@ -0,0 +1,51 @@
+
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+

data/.rubocop.yml

@@ -0,0 +1,22 @@
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+
+Metrics/ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 300
+
+Metrics/ModuleLength:
+  CountComments: false  # count full line comments?
+  Max: 300
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 20

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.2.0
+  - 2.3.0
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in rice_cooker.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,224 @@
+PATH
+  remote: .
+  specs:
+    rice_cooker (0.1.0)
+      actionpack (~> 5.0.0, < 5.1)
+      has_scope (~> 0.7.0, >= 0.6.0)
+      rails (~> 5.0.0, < 5.1)
+      railties (~> 5.0.0, < 5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.0)
+      actionpack (= 5.0.0)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.0)
+      actionpack (= 5.0.0)
+      actionview (= 5.0.0)
+      activejob (= 5.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.0)
+      actionview (= 5.0.0)
+      activesupport (= 5.0.0)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.0)
+      activesupport (= 5.0.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.0)
+      activesupport (= 5.0.0)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0)
+      activesupport (= 5.0.0)
+    activerecord (5.0.0)
+      activemodel (= 5.0.0)
+      activesupport (= 5.0.0)
+      arel (~> 7.0)
+    activesupport (5.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.0.0)
+    ast (2.3.0)
+    benchmark-ips (2.6.1)
+    builder (3.2.2)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    database_cleaner (1.5.3)
+    derailed (0.1.0)
+      derailed_benchmarks
+    derailed_benchmarks (1.3.1)
+      benchmark-ips (~> 2)
+      get_process_mem (~> 0)
+      heapy (~> 0)
+      memory_profiler (~> 0)
+      rack (>= 1)
+      rake (> 10, < 12)
+      thor (~> 0.19)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    factory_girl (4.7.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.7.0)
+      factory_girl (~> 4.7.0)
+      railties (>= 3.0.0)
+    faker (1.6.1)
+      i18n (~> 0.5)
+    get_process_mem (0.2.1)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    has_scope (0.7.0)
+      actionpack (>= 4.1, < 5.1)
+      activesupport (>= 4.1, < 5.1)
+    heapy (0.1.2)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    memory_profiler (0.9.6)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    nio4r (1.2.1)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    pkg-config (1.1.7)
+    power_assert (0.3.0)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.0)
+      actioncable (= 5.0.0)
+      actionmailer (= 5.0.0)
+      actionpack (= 5.0.0)
+      actionview (= 5.0.0)
+      activejob (= 5.0.0)
+      activemodel (= 5.0.0)
+      activerecord (= 5.0.0)
+      activesupport (= 5.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.1)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6.0)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rails-perftest (0.0.6)
+    railties (5.0.0)
+      actionpack (= 5.0.0)
+      activesupport (= 5.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.1.0)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-activemodel-mocks (1.0.3)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      rspec-mocks (>= 2.99, < 4.0)
+    rspec-core (3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.40.0)
+      parser (>= 2.3.1.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-prof (0.15.8)
+    ruby-progressbar (1.8.1)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sprockets (3.6.3)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.1.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    stackprof (0.2.9)
+    test-unit (3.1.3)
+      power_assert
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.1.0)
+    websocket-driver (0.6.4)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  derailed
+  factory_girl_rails (~> 4.0)
+  faker (= 1.6.1)
+  mocha (= 1.1.0)
+  pry
+  rails-perftest (= 0.0.6)
+  rice_cooker!
+  rspec
+  rspec-activemodel-mocks
+  rspec-rails
+  rubocop (~> 0.40.0)
+  ruby-prof (= 0.15.8)
+  simplecov (= 0.11.1)
+  sqlite3
+  stackprof
+  test-unit (= 3.1.3)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 André Aubin
+
+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,38 @@
+# Rice Cooker
+
+[![Build Status](https://travis-ci.com/lambda2/rice_cooker.svg?token=zsj9q6JjpQd8brNcmt9S&branch=master)](https://travis-ci.com/lambda2/rice_cooker)
+
+Handle sort, filters, searches, and ranges on Rails collections.
+
+-------------------
+
+## Installation
+
+In your `Gemfile`:
+
+```ruby
+gem 'rice_cooker'
+```
+
+Then, in your controllers
+
+```ruby
+
+class UsersController < ActionController::Base
+
+  # Will handle sorting with the 'sort' parameter.
+  sorted
+
+  # Will handle filtering with the 'filter[]' parameter.
+  filtered
+
+  # Will handle range-ing with the 'range[]' parameter.
+  ranged
+
+  def index
+    @users = apply_scopes(User).all
+    render json: @users
+  end
+end
+
+```

data/Rakefile

@@ -0,0 +1,28 @@
+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    = 'RiceCooker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/rice_cooker/filter.rb

@@ -0,0 +1,97 @@
+require 'active_support'
+
+module RiceCooker
+  module Filter
+    extend ActiveSupport::Concern
+
+    FILTER_PARAM = :filter
+
+    module ClassMethods
+      include Helpers
+
+      def filtered(additional_filtering_params = {})
+        cattr_accessor :filtering_keys
+        cattr_accessor :custom_filters
+
+        resource_class ||= controller_resource_class(self)# unless respond_to?(:resource_class)
+
+        # On normalize tout ca
+        additional_filtering_params = format_additional_param(additional_filtering_params, 'filtering')
+
+        # On recupere tous les filtres autorisés
+        allowed_keys = (filterable_fields_for(resource_class) + additional_filtering_params.keys)
+
+        # On fait une sorte de *register_bool_filter* sur tous les champs *_at
+        additional = (filterable_fields_for(resource_class) - [:created_at, :updated_at])
+                     .select { |e| e =~ /_at$/ }
+                     .select { |e| additional_filtering_params[e.to_s.gsub(/_at$/, '')].nil? }
+
+        additional.each do |fi|
+          name = fi.to_s.gsub(/_at$/, '')
+
+          if fi.to_sym == :begin_at
+            db_field = "#{resource_class.quoted_table_name}.\"#{fi}\""
+            additional_filtering_params[:future] = {
+              proc: -> (value) { value.first == 'true' ? where("#{db_field} >= ?", Time.zone.now) : where("#{db_field} < ?", Time.zone.now) },
+              all: %w(true false),
+              description: "Return only #{resource_class.to_s.underscore.humanize.downcase.pluralize} which begins in the future"
+            }
+            allowed_keys << :future
+          else
+            additional_filtering_params[name.to_sym] = {
+              proc: -> (value) { value.first == 'true' ? where.not(fi => nil) : where(fi => nil) },
+              all: %w(true false),
+              description: "Return only #{name} #{resource_class.to_s.underscore.humanize.downcase.pluralize}"
+            }
+            allowed_keys << name
+          end
+        end
+
+        # On recupere le default
+        self.filtering_keys = allowed_keys
+        self.custom_filters = additional_filtering_params
+
+        has_scope :filter, type: :hash, only: [:index] do |_controller, scope, value|
+          params = parse_filtering_param(value, filtering_keys)
+          scope = apply_filter_to_collection(scope, params, custom_filters)
+          scope
+        end
+      end
+
+      #
+      # Ajoute un filtre custom
+      #
+      # name: le nom du filtre custom (ex: with_mark)
+      # proc: le filtre, prend un arg `val` qui est un tableau des args du filtre
+      # all: l'ensemble des valeurs acceptées pour le filtre. Laisser nil ou [] pour tout accepter
+      # description: La description dans la doc
+      #
+      def register_filter(name, proc, all = nil, description = nil)
+        raise "A '#{name}' filter already exists for class #{self.class}" unless custom_filters[name].nil?
+        custom_filters[name] = {
+          proc: proc,
+          all: all || [],
+          description: description || ''
+        }
+        filtering_keys << name
+      end
+
+      #
+      # Raccourci pour un filtre custom qui va filtrer si un champ est nil ou non.
+      #
+      # name: le nom du filtre custom (ex: with_mark)
+      # field: le champ a filtrer sur `nil` ou pas `nil` (ex: final_mark)
+      # description: La description dans la doc
+      #
+      def register_bool_filter(name, field, description = nil)
+        raise "A '#{name}' filter already exists for class #{self.class}" unless custom_filters[name].nil?
+        custom_filters[name] = {
+          proc: -> (value) { value.first == 'true' ? where.not(field => nil) : where(field => nil) },
+          all: %w(true false),
+          description: description || "Return only #{resource_class.to_s.underscore.humanize.downcase.pluralize} with a #{field}"
+        }
+        filtering_keys << name
+      end
+    end
+  end
+end