rice_cooker 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a537052d811fede0e84637be8497871f89e955a0
-  data.tar.gz: cc809d71a92d3b9aabc1f5aec1de7c1d4c992e1c
+  metadata.gz: febeec59cbb060cf35bb66891a2c3017876f6263
+  data.tar.gz: 80ec86ea16fc1496809c648789e937e7592332a0
 SHA512:
-  metadata.gz: 22c64cc42d6241c67efd4c58c4fc16a04b6af6cb82e9f63dcc260090156ddc8d16a1cfc08cf82ba7ca9460e76d3d636070cd938bdb0c7ca0a9a0336445d69c71
-  data.tar.gz: 78f86bfc3828d68ee06f706473758eda96100a7e48e16a8b9b8062738cb048c6f91c7b56dcfe9b7e3171390b84d8b54d1b35732a26e1967901d25db82b916807
+  metadata.gz: 0b54debc8ddc3c88ae32a8b2eff042e4c1fa14bd73b6ccbc9ac32b0e2bb8c95b26db833186eadee1ac80639dad42037b69940cc4a7e4121f0c58272941525897
+  data.tar.gz: 3d46fbf0f23c24ef4afa1c01e72612a843f8b28cdc10db72ac5d8d4d39558cb9f2b7c2090d0d1ca952e02b97adb37a28edfedf159fdc90b5247a9eb620b72e2a

data/.gitignore

@@ -49,3 +49,4 @@ bower.json
 # Ignore Byebug command history file.
 .byebug_history
 
+*.gem

data/Gemfile

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

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    rice_cooker (0.1.0)
-      actionpack (~> 5.0.0, < 5.1)
+    rice_cooker (0.1.3)
+      actionpack (>= 4.2.0, < 5.1)
       has_scope (~> 0.7.0, >= 0.6.0)
-      rails (~> 5.0.0, < 5.1)
-      railties (~> 5.0.0, < 5.1)
+      rails (>= 4.2.0, < 5.1)
+      railties (>= 4.2.0, < 5.1)
 
 GEM
   remote: https://rubygems.org/
@@ -49,21 +49,10 @@ GEM
       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)
@@ -74,20 +63,17 @@ GEM
       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)
@@ -130,7 +116,6 @@ GEM
       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)
@@ -186,7 +171,6 @@ GEM
       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)
@@ -203,12 +187,10 @@ PLATFORMS
 
 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
@@ -217,7 +199,6 @@ DEPENDENCIES
   ruby-prof (= 0.15.8)
   simplecov (= 0.11.1)
   sqlite3
-  stackprof
   test-unit (= 3.1.3)
 
 BUNDLED WITH

data/lib/rice_cooker/class_methods.rb

@@ -0,0 +1,57 @@
+require 'active_support'
+
+module RiceCooker
+  module ClassMethods
+    protected
+
+    def initialize_model_class!
+      # First priority is the namespaced model, e.g. User::Group
+      self.resource_model ||= begin
+        namespaced_class = name.sub(/Controller$/, '').singularize
+        namespaced_class.constantize
+      rescue NameError
+        nil
+      end
+
+      # Second priority is the top namespace model, e.g. EngineName::Article for EngineName::Admin::ArticlesController
+      self.resource_model ||= begin
+        namespaced_classes = name.sub(/Controller$/, '').split('::')
+        namespaced_class = [namespaced_classes.first, namespaced_classes.last].join('::').singularize
+        namespaced_class.constantize
+      rescue NameError
+        nil
+      end
+
+      # Third priority the camelcased c, i.e. UserGroup
+      self.resource_model ||= begin
+        camelcased_class = name.sub(/Controller$/, '').gsub('::', '').singularize
+        camelcased_class.constantize
+      rescue NameError
+        nil
+      end
+
+      # Otherwise use the Group class, or fail
+      self.resource_model ||= begin
+        class_name = controller_name.classify
+        class_name.constantize
+      rescue NameError => e
+        raise unless e.message.include?(class_name)
+        nil
+      end
+
+      # We prevent for creating a resource wich is not a model
+      if self.resource_model
+        begin
+          self.resource_model = nil unless self.resource_model < ActiveRecord::Base
+        rescue
+          nil
+        end
+      end
+    end
+
+    def inherited(base) #:nodoc:
+      super(base)
+      base.send :initialize_model_class!
+    end
+  end
+end

data/lib/rice_cooker/filter.rb

@@ -13,16 +13,14 @@ module RiceCooker
         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)
+        allowed_keys = (filterable_fields_for(resource_model) + 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])
+        additional = (filterable_fields_for(resource_model) - [:created_at, :updated_at])
                      .select { |e| e =~ /_at$/ }
                      .select { |e| additional_filtering_params[e.to_s.gsub(/_at$/, '')].nil? }
 
@@ -30,18 +28,18 @@ module RiceCooker
           name = fi.to_s.gsub(/_at$/, '')
 
           if fi.to_sym == :begin_at
-            db_field = "#{resource_class.quoted_table_name}.\"#{fi}\""
+            db_field = "#{resource_model.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"
+              description: "Return only #{resource_model.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}"
+              description: "Return only #{name} #{resource_model.to_s.underscore.humanize.downcase.pluralize}"
             }
             allowed_keys << name
           end
@@ -88,7 +86,7 @@ module RiceCooker
         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}"
+          description: description || "Return only #{resource_model.to_s.underscore.humanize.downcase.pluralize} with a #{field}"
         }
         filtering_keys << name
       end

data/lib/rice_cooker/helpers.rb

@@ -20,50 +20,6 @@ module RiceCooker
   module Helpers
     extend ActiveSupport::Concern
 
-    # From https://github.com/josevalim/inherited_resources/blob/master/lib/inherited_resources/class_methods.rb#L315
-    def controller_resource_class(controller)
-      detected_resource_class = nil
-
-      if controller.respond_to? :name
-        detected_resource_class ||= begin
-          namespaced_class = controller.name.sub(/Controller$/, '').singularize
-          namespaced_class.constantize
-        rescue NameError
-          nil
-        end
-
-        # Second priority is the top namespace model, e.g. EngineName::Article for EngineName::Admin::ArticlesController
-        detected_resource_class ||= begin
-          namespaced_classes = controller.name.sub(/Controller$/, '').split('::')
-          namespaced_class = [namespaced_classes.first, namespaced_classes.last].join('::').singularize
-          namespaced_class.constantize
-        rescue NameError
-          nil
-        end
-
-        # Third priority the camelcased c, i.e. UserGroup
-        detected_resource_class ||= begin
-          camelcased_class = controller.name.sub(/Controller$/, '').gsub('::', '').singularize
-          camelcased_class.constantize
-        rescue NameError
-          nil
-        end
-
-      elsif controller.respond_to? :controller_name
-        # Otherwise use the Group class, or fail
-        detected_resource_class ||= begin
-          class_name = controller.controller_name.classify
-          class_name.constantize
-        rescue NameError => e
-          raise unless e.message.include?(class_name)
-          nil
-        end
-      else
-        detected_resource_class = nil
-      end
-      detected_resource_class
-    end
-
     # Overridable method for available sortable fields
     def sortable_fields_for(model)
       if model.respond_to?(:sortable_fields)
@@ -102,11 +58,11 @@ module RiceCooker
       return {} unless sorting_param.present?
 
       sorting_params = CSV.parse_line(URI.unescape(sorting_param)).collect do |sort|
-        if sort.start_with?('-')
-          sorting_param = { field: sort[1..-1].to_s.to_sym, direction: :desc}
-        else
-          sorting_param = { field: sort.to_s.to_sym, direction: :asc}
-        end
+        sorting_param = if sort.start_with?('-')
+                          { field: sort[1..-1].to_s.to_sym, direction: :desc }
+                        else
+                          { field: sort.to_s.to_sym, direction: :asc }
+                        end
 
         check_sorting_param(model, sorting_param)
         sorting_param
@@ -253,7 +209,6 @@ module RiceCooker
       raise InvalidRangeException, "Attributes #{🔞.map(&:to_s).to_sentence} doesn't exists or aren't rangeables. Available ranges are: #{allowed.to_sentence}" if 🔞.any?
     end
 
-
     def apply_range_to_collection(collection, ranged_params, additional = {})
       return collection if collection.nil?
 

data/lib/rice_cooker/range.rb

@@ -13,13 +13,11 @@ module RiceCooker
         cattr_accessor :ranged_keys
         cattr_accessor :custom_ranges
 
-        resource_class ||= controller_resource_class(self) unless respond_to?(:resource_class)
-
         # On normalize tout ca
         additional_ranged_params = format_additional_param(additional_ranged_params, 'ranged')
 
         # On recupere tous les filtres autorisés
-        allowed_keys = (rangeable_fields_for(resource_class) + additional_ranged_params.keys)
+        allowed_keys = (rangeable_fields_for(resource_model) + additional_ranged_params.keys)
 
         # On recupere le default
         self.ranged_keys = allowed_keys

data/lib/rice_cooker/sort.rb

@@ -21,28 +21,27 @@ module RiceCooker
         cattr_accessor :default_order
         cattr_accessor :sorted_keys
 
-        resource_class ||= controller_resource_class(self) unless respond_to?(:resource_class)
-
-        return unless sorted_keys.nil? || resource_class.nil?
+        return unless sorted_keys.nil? || resource_model.nil?
 
         default_sorting_params = { default_sorting_params => :asc } if default_sorting_params.is_a? Symbol
 
         # On recupere le default
         self.default_order = default_sorting_params
-        self.sorted_keys = (resource_class.respond_to?(:sortable_fields) ? resource_class.sortable_fields : [])
+        self.sorted_keys = (resource_model.respond_to?(:sortable_fields) ? resource_model.sortable_fields : [])
         default_sort = param_from_defaults(default_sorting_params)
 
         has_scope :sort, default: default_sort, only: [:index] do |controller, scope, value|
-          if controller.params[SORT_PARAM].present?
-            scope = apply_sort_to_collection(scope, parse_sorting_param(value, resource_class))
-          else
-            scope = apply_sort_to_collection(scope, default_sorting_params)
-          end
+          scope = if controller.params[SORT_PARAM].present?
+                    apply_sort_to_collection(scope, parse_sorting_param(value, resource_model))
+                  else
+                    apply_sort_to_collection(scope, default_sorting_params)
+                  end
           scope
         end
 
       rescue NoMethodError => e
         "Just wanna die ⚓️ #{e}"
+        super
       end
     end
   end

data/lib/rice_cooker/version.rb

@@ -1,3 +1,3 @@
 module RiceCooker
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

data/lib/rice_cooker.rb

@@ -1,17 +1,29 @@
 require 'action_controller'
 
 module RiceCooker
-  autoload :Helpers,  'rice_cooker/helpers'
-  autoload :Filter,   'rice_cooker/filter'
-  autoload :Sort,     'rice_cooker/sort'
-  autoload :Range,    'rice_cooker/range'
-  autoload :VERSION,  'rice_cooker/version'
+  autoload :Helpers,      'rice_cooker/helpers'
+  autoload :ClassMethods, 'rice_cooker/class_methods'
+  autoload :Filter,       'rice_cooker/filter'
+  autoload :Sort,         'rice_cooker/sort'
+  autoload :Range,        'rice_cooker/range'
+  autoload :VERSION,      'rice_cooker/version'
 end
 
 module ActionController
   class Base
-    include RiceCooker::Sort
-    include RiceCooker::Filter
-    include RiceCooker::Range
+    def self.rice_cooked(base)
+      base.class_eval do
+        include RiceCooker::Sort
+        include RiceCooker::Filter
+        include RiceCooker::Range
+        extend  RiceCooker::ClassMethods
+
+        class_attribute :resource_model, instance_writer: false
+
+        protected :resource_model
+      end
+    end
+
+    rice_cooked(self)
   end
 end

data/rice_cooker.gemspec

@@ -30,13 +30,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'mocha', '1.1.0'
   s.add_development_dependency 'ruby-prof', '0.15.8'
   s.add_development_dependency 'test-unit', '3.1.3'
-  s.add_development_dependency 'rails-perftest', '0.0.6'
   s.add_development_dependency 'simplecov', '0.11.1'
   s.add_development_dependency 'factory_girl_rails', '~> 4.0'
   s.add_development_dependency 'database_cleaner'
   s.add_development_dependency 'faker', '1.6.1'
   s.add_development_dependency 'pry'
-  s.add_development_dependency 'derailed'
-  s.add_development_dependency 'stackprof'
   s.add_development_dependency 'rubocop', '~> 0.40.0'
 end

data/spec/range/range_spec.rb

@@ -90,20 +90,19 @@ RSpec.describe RiceCooker::Range do
       # Desc ranged
       expect do
         apply_range_to_collection(@collection, login: %w(aaubin qbollach andre),
-                                                                   id: ['74'])
+                                               id: ['74'])
       end.to raise_error(RiceCooker::InvalidRangeValueException)
     end
   end
 
   describe 'Must apply custom ranges to given collection' do
-
     it 'Default null ranged' do
       ranged_collection = apply_range_to_collection(@collection, {}, @test_range)
       expect(ranged_collection.to_sql).to match(/^((?!WHERE).)*$/)
     end
 
     it 'Default ranged' do
-      ranged_collection = apply_range_to_collection(@collection, {between_the_letter: ['a', 'b']}, @test_range)
+      ranged_collection = apply_range_to_collection(@collection, { between_the_letter: %w(a b) }, @test_range)
       expect(ranged_collection.to_sql).to match(/WHERE/)
       expect(ranged_collection.to_sql).to match(/BETWEEN/)
     end
@@ -111,9 +110,9 @@ RSpec.describe RiceCooker::Range do
     it 'Double ranged' do
       # Desc ranged
       ranged_collection = apply_range_to_collection(@collection, {
-        between_the_letter: ['a', 'b'],
-        not_between_the_letter: ['x', 'z']
-      }, @test_range)
+                                                      between_the_letter: %w(a b),
+                                                      not_between_the_letter: %w(x z)
+                                                    }, @test_range)
       expect(ranged_collection.to_sql).to match(/WHERE/)
       expect(ranged_collection.to_sql).to match(/first_name BETWEEN 'a' AND 'b'/)
       expect(ranged_collection.to_sql).to match(/AND \(first_name NOT BETWEEN 'x' AND 'z'\)/)
@@ -121,10 +120,8 @@ RSpec.describe RiceCooker::Range do
 
     it 'Multiple ranged' do
       # Desc ranged
-      ranged_collection = apply_range_to_collection(@collection, {
-        login: ['aaubin', 'qbollach'],
-        id: ['74', '76']
-      })
+      ranged_collection = apply_range_to_collection(@collection, login: %w(aaubin qbollach),
+                                                                 id: %w(74 76))
       expect(ranged_collection.to_sql).to match(/WHERE/)
       expect(ranged_collection.to_sql).to match(/BETWEEN 'aaubin' AND 'qbollach'/)
       expect(ranged_collection.to_sql).to match(/\) AND \(/)
@@ -136,75 +133,71 @@ RSpec.describe RiceCooker::Range do
       expect do
         apply_range_to_collection(
           @collection,
-          {sorted: ['true', 'baguette']},
-          format_additional_param({sorted: [-> (v, w) { v }, ['true', 'false', 'maybe']]}, 'ranged')
+          { sorted: %w(true baguette) },
+          format_additional_param({ sorted: [-> (v, _w) { v }, %w(true false maybe)] }, 'ranged')
         )
       end.to raise_error(RiceCooker::InvalidRangeValueException)
     end
   end
 
   describe 'Additional params must be correctly formated' do
-
     it 'No additional params' do
       formated = format_additional_param({}, 'ranged')
       expect(formated).to be_eql({})
     end
 
     it 'Already correctly formatted additional params' do
-      p = {range: {
+      p = { range: {
         proc: @proc,
         all: [1, 2, 3],
         description: 'A good filter'
-      }}
+      } }
       formated = format_additional_param(p, 'ranged')
       expect(formated).to be_eql(p)
     end
 
     it 'Missing description additional params' do
-      p = {filter: {
+      p = { filter: {
         proc: @proc,
         all: [1, 2, 3]
-      }}
-      expected = {filter: {
+      } }
+      expected = { filter: {
         proc: @proc,
         all: [1, 2, 3],
         description: ''
-      }}
+      } }
       formated = format_additional_param(p, 'ranged')
       expect(formated).to be_eql(expected)
     end
 
     it 'Only proc additional params' do
-
-      p = {filter: @proc}
-      expected = {filter: {
+      p = { filter: @proc }
+      expected = { filter: {
         proc: @proc,
         all: [],
         description: ''
-      }}
+      } }
       formated = format_additional_param(p, 'ranged')
       expect(formated).to be_eql(expected)
     end
 
     it 'Array with proc and all additional params' do
-
-      p = {filter: [@proc, @all]}
-      expected = {filter: {
+      p = { filter: [@proc, @all] }
+      expected = { filter: {
         proc: @proc,
         all: @all,
         description: ''
-      }}
+      } }
       formated = format_additional_param(p, 'ranged')
       expect(formated).to be_eql(expected)
     end
 
     it 'Multiple, std + Array with proc and all additional params' do
-
       p = {
         tata: @proc,
-        toto: {proc: @proc, all: [1, 2]},
+        toto: { proc: @proc, all: [1, 2] },
         filter: [@proc, @all],
-        tutu: {proc: @proc, description: 'Buuuuh'}
+        tutu: { proc: @proc, description: 'Buuuuh' }
       }
       expected = {
         tata: {
@@ -231,7 +224,6 @@ RSpec.describe RiceCooker::Range do
       formated = format_additional_param(p, 'ranged')
       expect(formated).to be_eql(expected)
     end
-
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rice_cooker
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Andre Aubin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-05 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -188,20 +188,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.1.3
-- !ruby/object:Gem::Dependency
-  name: rails-perftest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.0.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -272,34 +258,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: derailed
-  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: stackprof
-  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -330,6 +288,7 @@ files:
 - README.md
 - Rakefile
 - lib/rice_cooker.rb
+- lib/rice_cooker/class_methods.rb
 - lib/rice_cooker/filter.rb
 - lib/rice_cooker/helpers.rb
 - lib/rice_cooker/range.rb