eitil 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0a89a4609655c28ab6ee41d45b0c74d34b47d31cef1f494b0d942717cdf5371
-  data.tar.gz: 905882089b4723ee74710f4877eaecc612ac35c75b9ea954efd9edeb656d8cda
+  metadata.gz: fd9d35211d3f61c2a37a33f09bb080fc91801591270c9fabdb199d1abb6b3f5d
+  data.tar.gz: 7e8d7a580c60fe77661a0bfd276c02e55936d870103a66b15f6ebb4090c914e8
 SHA512:
-  metadata.gz: 8d395e454f20dffb4d7f4a5b9d77944fdbb4603013e5c562ad09d4768642a5df4b98fe8b2e6a10510535b0428aa6f506edab944a787954a8847cac27480df4da
-  data.tar.gz: c117f0a635d79282a6b7d54dd72a71de77d054c209f25b3c4cd76aae7469320af507c1f35f25b6770041b7b3fbfe3198b9c193c2bec8ed51acf6115a4f75ddcf
+  metadata.gz: c686f8f249fcf7d3418571d9f62adde2403e7a2d4f45a435d9c61455afdaed354332a80f88f4b7e587e9c96e690a27dc10fae81fbb61d2a452c9631525736d18
+  data.tar.gz: 5c0c96c615314e07fe44514bd34d5298592f47a3fe4b1fc1f63555fa3acb8d72cb8db04e124259ce44873ae58def846cdd67c48e79504f5cee09251686cf04cf

data/eitil_wrapper/README.md

@@ -150,11 +150,20 @@ extended_resources(controller, **kwargs)
 
 
 
-## EitilWrapper::Scopes
+## EitilWrapper::Records
 
 ```ruby
 
-require "eitil_wrapper/scopes"
+# include all below EitilWrapper::Records helpers through:
+require "eitil_wrapper/records"
+
+```
+
+### Scopes
+
+```ruby
+
+require "eitil_wrapper/records/scopes"
 
 ```
 
@@ -175,8 +184,6 @@ Scopes are generated through the columns of your model's database table. Which s
 .{column_name}_before_date(date)
 .{column_name}_after_date(date) 
 .{column_name}_between_dates(start_date, end_date)
-.{column_name}_oldest_first
-.{column_name}_newest_first
 
 # columns of datatype: date
 .{column_name}_today      
@@ -186,27 +193,93 @@ Scopes are generated through the columns of your model's database table. Which s
 .{column_name}_before_date(date)
 .{column_name}_after_date(date) 
 .{column_name}_between_dates(start_date, end_date)
-.{column_name}_oldest_first
-.{column_name}_newest_first
 
 # columns of datatype: integer
 .{column_name}_equal_to(number)      
 .{column_name}_lower_than(number)
 .{column_name}_higher_than(number)
 .{column_name}_between(min, max)
-.{column_name}_ascending
-.{column_name}_descending
 
 # columns of datatype: float
 .{column_name}_equal_to(number)      
 .{column_name}_lower_than(number)
 .{column_name}_higher_than(number)
 .{column_name}_between(min, max)
+```
+
+### Sorts
+
+
+```ruby
+
+require "eitil_wrapper/records/sorts"
+
+```
+
+Sorts are generated through the columns of your model's database table. Which sorts are generated depends on the datatype of a column. A sort method is defined only if it does not already responds to another method of the same name. The sorts generated are:
+
+```ruby
+# require "eitil_wrapper/scopes/default_scopes"
+
+# columns of datatype: datetime
+.{column_name}_oldest_first
+.{column_name}_newest_first
+
+# columns of datatype: date
+.{column_name}_oldest_first
+.{column_name}_newest_first
+
+# columns of datatype: integer
+.{column_name}_ascending
+.{column_name}_descending
+
+# columns of datatype: float
 .{column_name}_ascending
 .{column_name}_descending
 ```
 
 
+### Calculators
+
+
+```ruby
+
+require "eitil_wrapper/records/calculators"
+
+```
+
+Calculators are generated through the columns of your model's database table. Which calculators are generated depends on the datatype of a column. A calculator method is defined only if it does not already responds to another method of the same name. The calculators generated are:
+
+```ruby
+# require "eitil_wrapper/scopes/default_scopes"
+
+# columns of datatype: array (serialized)
+.{column_name}_sum # returns all uniq elements in a new, single array
+
+# columns of datatype: integer
+.{column_name}_max
+.{column_name}_min
+.{column_name}_sum
+.{column_name}_avg
+
+# columns of datatype: float
+.{column_name}_max
+.{column_name}_min
+.{column_name}_sum
+.{column_name}_avg
+
+# columns of datatype: decimal
+.{column_name}_max
+.{column_name}_min
+.{column_name}_sum
+.{column_name}_avg
+
+# columns of datatype: bigint
+.{column_name}_max
+.{column_name}_min
+.{column_name}_sum
+.{column_name}_avg
+```
 
 
 

data/eitil_wrapper/lib/eitil_wrapper/railtie.rb

@@ -7,9 +7,16 @@ module EitilWrapper
 
     initializer "my_railtie.configure_rails_initialization", options: :after do |app|
 
+      if Object.const_defined?('EitilWrapper::Records::DefaultCalculators')
+        ::ApplicationRecord.send(:extend, EitilWrapper::Records::DefaultCalculators)
+      end
+
+      if Object.const_defined?('EitilWrapper::Records::DefaultScopes')
+        ::ApplicationRecord.send(:extend, EitilWrapper::Records::DefaultScopes)
+      end
 
-      if Object.const_defined?('EitilWrapper::Scopes::DefaultScopes')
-        ::ApplicationRecord.send(:extend, EitilWrapper::Scopes::DefaultScopes)
+      if Object.const_defined?('EitilWrapper::Records::DefaultSorts')
+        ::ApplicationRecord.send(:extend, EitilWrapper::Records::DefaultSorts)
       end
 
       if Object.const_defined?('EitilWrapper::Callbacks::HelperMethods')

data/eitil_wrapper/lib/eitil_wrapper/records/default_calculators.rb

@@ -0,0 +1,102 @@
+
+# require "eitil_wrapper/records/default_calculators"
+
+# require "eitil_wrapper/railtie" to run the dynamic dispatch as an init hook during boot
+require "eitil_wrapper/railtie"
+
+module EitilWrapper
+  module Records
+    module DefaultCalculators
+
+      Eitil::ApplicationRecordModules << self
+
+      SharableNumberCalculators = -> (_class, column) {
+        _class.eitil_calculator :"#{column}_max", -> { _class.maximum(column) }
+        _class.eitil_calculator :"#{column}_min", -> { _class.minimum(column) }
+        _class.eitil_calculator :"#{column}_sum", -> { _class.sum(column) }
+        _class.eitil_calculator :"#{column}_avg", -> { _class.average(column) }
+      }
+
+      SharableIterableCalculators = -> (_class, column) {   
+        _class.eitil_calculator :"#{column}_sum", -> { _class.pluck(column).flatten!.uniq! }
+      }
+
+      def inherited(subclass)
+        super
+        return if Eitil.skip_default_calculators_for_models.include?(subclass.to_s.to_sym)
+        
+        # Set the proper table_names for namespaced models. Without setting this,
+        # Rails run into problems due to the fact that the first call to the model's
+        # constant triggers this initializer first, and only thereafter the model file 
+        # which sets the correct table_name through a macro.
+        
+        namespaced_class    = subclass.to_s.include?('::')
+        subclass.table_name = subclass.to_s.gsub('::', '_').downcase.pluralize if namespaced_class
+
+        subclass.use_eitil_calculators
+
+        rescue => e
+          puts "default calculators failed for #{subclass} because of #{e.class} and '#{e.to_s.split(' ').first}'"
+      end
+
+      def use_eitil_calculators 
+        return if abstract_class?
+        
+        # text[]           is postgresql's datatype for serialized arrays
+        # numeric          is postgresql's datatype for decimals
+        # double precision is postgresql's datatype for floats
+
+
+        %w[integer bigint double\ precision numeric].each do |_type| 
+          send :"create_eitil_#{_type.gsub(' ','_')}_calculators"
+        end
+
+        create_array_calculators
+      end
+
+      def eitil_calculator(_name, _proc)
+        # skip calculator methods for primary and foreign key columns
+        return if _name.to_s =~ /^id_[a-z]{1,}$/ || _name.to_s =~ /_id_[a-z]{1,}$/
+        
+        define_singleton_method(_name) { _proc.call } unless respond_to? _name
+      end
+    
+      def calculator_columns_of_type(data_type)
+        columns_hash.select { |column,v| v.sql_type == data_type }
+      end
+
+      def create_eitil_integer_calculators
+        calculator_columns_of_type("integer")&.map do |column, object|
+          SharableNumberCalculators.call self, column
+        end
+      end
+
+      def create_eitil_bigint_calculators
+        calculator_columns_of_type("bigint")&.map do |column, object|
+          SharableNumberCalculators.call self, column
+        end
+      end
+
+      def create_eitil_double_precision_calculators
+        calculator_columns_of_type("double\ precision")&.map do |column, object|
+          SharableNumberCalculators.call self, column
+        end
+      end
+
+      def create_eitil_numeric_calculators
+        calculator_columns_of_type("numeric")&.map do |column, object|
+          SharableNumberCalculators.call self, column
+        end
+      end
+
+      def create_array_calculators
+        columns = columns_hash.select { |column,v| v.sql_type == "text" && v.default == "{}" }
+        columns&.map do |column, object|
+          SharableIterableCalculators.call self, column
+        end
+      end
+            
+    end
+  end
+end
+

data/eitil_wrapper/lib/eitil_wrapper/{scopes → records}/default_scopes.rb

@@ -1,11 +1,11 @@
 
-# require "eitil_wrapper/scopes/default_scopes"
+# require "eitil_wrapper/records/default_scopes"
 
 # require "eitil_wrapper/railtie" to run the dynamic dispatch as an init hook during boot
 require "eitil_wrapper/railtie"
 
 module EitilWrapper
-  module Scopes
+  module Records
     module DefaultScopes
 
       Eitil::ApplicationRecordModules << self
@@ -19,9 +19,6 @@ module EitilWrapper
         _class.eitil_scope :"#{column}_before_date",    -> (date) { where("#{column} = ?", date) }
         _class.eitil_scope :"#{column}_after_date",     -> (date) { where("#{column} = ?", date) }
         _class.eitil_scope :"#{column}_between_dates",  -> (from, till) { where("#{column} >= ? and #{column} <= ?", from, till) }
-
-        _class.eitil_scope :"#{column}_oldest_first",   -> { order("#{column} ASC") }
-        _class.eitil_scope :"#{column}_newest_first",   -> { order("#{column} DESC") }
       }
 
       SharableNumScopes = -> (_class, column) {
@@ -29,9 +26,6 @@ module EitilWrapper
         _class.eitil_scope :"#{column}_lower_than",     -> (number) { where("#{column} = <", number) }
         _class.eitil_scope :"#{column}_higher_than",    -> (number) { where("#{column} = >", number) }
         _class.eitil_scope :"#{column}_between",        -> (min, max) { where("#{column} >= ? and #{column} <= ?", min, max) }
-
-        _class.eitil_scope :"#{column}_ascending",      -> { order("#{column} ASC") }
-        _class.eitil_scope :"#{column}_descending",     -> { order("#{column} DESC") }
       }
 
       def inherited(subclass)
@@ -42,6 +36,7 @@ module EitilWrapper
         # Rails run into problems due to the fact that the first call to the model's
         # constant triggers this initializer first, and only thereafter the model file 
         # which sets the correct table_name through a macro.
+        
         namespaced_class    = subclass.to_s.include?('::')
         subclass.table_name = subclass.to_s.gsub('::', '_').downcase.pluralize if namespaced_class
 
@@ -61,6 +56,7 @@ module EitilWrapper
       end
     
       def columns_of_type(data_type)
+        binding.pry if $pry
         columns_hash.select { |column,v| v.sql_type_metadata.type == data_type }
       end
 
@@ -97,4 +93,4 @@ module EitilWrapper
             
     end
   end
-end
+end

data/eitil_wrapper/lib/eitil_wrapper/records/default_sorts.rb

@@ -0,0 +1,80 @@
+# require "eitil_wrapper/records/default_sorts"
+
+# require "eitil_wrapper/railtie" to run the dynamic dispatch as an init hook during boot
+require "eitil_wrapper/railtie"
+
+
+module EitilWrapper
+  module Records
+    module DefaultSorts
+
+      Eitil::ApplicationRecordModules << self
+
+      SharableDateSorts = -> (_class, column) {
+        _class.eitil_sort :"#{column}_oldest_first", -> { _class.order("#{column} ASC") }
+        _class.eitil_sort :"#{column}_newest_first", -> { _class.order("#{column} DESC") }
+      }
+
+      SharableNumSorts = -> (_class, column) {
+        _class.eitil_sort :"#{column}_ascending",    -> { _class.order("#{column} ASC") }
+        _class.eitil_sort :"#{column}_descending",   -> { _class.order("#{column} DESC") }
+      }
+
+      def inherited(subclass)
+        super
+        return if Eitil.skip_default_sorts_for_models.include?(subclass.to_s.to_sym)
+        
+        # Set the proper table_names for namespaced models. Without setting this,
+        # Rails run into problems due to the fact that the first call to the model's
+        # constant triggers this initializer first, and only thereafter the model file 
+        # which sets the correct table_name through a macro.
+        
+        namespaced_class    = subclass.to_s.include?('::')
+        subclass.table_name = subclass.to_s.gsub('::', '_').downcase.pluralize if namespaced_class
+
+        subclass.use_eitil_sorts
+
+        rescue => e
+          puts "default sorts failed for #{subclass} because of #{e.class} and '#{e.to_s.split(' ').first}'"
+      end
+
+      def use_eitil_sorts  
+        return if abstract_class?
+        %i[datetime date integer float].each { |_type| send :"create_eitil_#{_type}_sorts" }
+      end
+
+      def eitil_sort(_name, _proc)
+        define_singleton_method(_name) { _proc.call } unless respond_to? _name 
+      end
+    
+      def sort_columns_of_type(data_type)
+        columns_hash.select { |column,v| v.sql_type_metadata.type == data_type }
+      end
+
+      def create_eitil_datetime_sorts
+        columns_of_type(:datetime)&.map do |column, object|
+          SharableDateSorts.call self, column
+        end
+      end
+
+      def create_eitil_date_sorts
+        columns_of_type(:date)&.map do |column, object|
+          SharableDateSorts.call self, column
+        end
+      end
+
+      def create_eitil_integer_sorts
+        columns_of_type(:integer)&.map do |column, object|
+          SharableNumSorts.call self, column
+        end
+      end
+
+      def create_eitil_float_sorts
+        columns_of_type(:float)&.map do |column, object|
+          SharableNumSorts.call self, column
+        end
+      end
+
+    end
+  end
+end

data/eitil_wrapper/lib/eitil_wrapper/records.rb

@@ -0,0 +1,4 @@
+
+require "eitil_wrapper/records/default_scopes"
+require "eitil_wrapper/records/default_calculators"
+require "eitil_wrapper/records/default_sorts"

data/eitil_wrapper/lib/eitil_wrapper.rb

@@ -2,7 +2,7 @@
 require "eitil_wrapper"
 
 require "eitil_wrapper/jobs"
-require "eitil_wrapper/scopes"
+require "eitil_wrapper/records"
 require "eitil_wrapper/routes"
 require "eitil_wrapper/callbacks"
 require "eitil_wrapper/decorators"

data/lib/eitil/railtie.rb

@@ -31,10 +31,14 @@ module Eitil
 
       Eitil.mattr_accessor :controller_ivars, 
                            :skip_default_scopes_for_models,
+                           :skip_default_calculators_for_models,
+                           :skip_default_sorts_for_models,
                            :skip_callback_helper_methods_for_models
 
-      Eitil.controller_ivars ||= []
-      Eitil.skip_default_scopes_for_models ||= []
+      Eitil.controller_ivars                        ||= []
+      Eitil.skip_default_scopes_for_models          ||= []
+      Eitil.skip_default_calculators_for_models     ||= []
+      Eitil.skip_default_sorts_for_models           ||= []
       Eitil.skip_callback_helper_methods_for_models ||= []
 
       def Eitil.set_config(&block)

data/lib/eitil/version.rb

@@ -1,5 +1,5 @@
 module Eitil
   
-  VERSION = '1.3.5'
+  VERSION = '1.3.6'
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eitil
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors:
 - Jurriaan Schrofer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -284,13 +284,15 @@ files:
 - eitil_wrapper/lib/eitil_wrapper/jobs/new_job_now.rb
 - eitil_wrapper/lib/eitil_wrapper/jobs/single_method_job.rb
 - eitil_wrapper/lib/eitil_wrapper/railtie.rb
+- eitil_wrapper/lib/eitil_wrapper/records.rb
+- eitil_wrapper/lib/eitil_wrapper/records/default_calculators.rb
+- eitil_wrapper/lib/eitil_wrapper/records/default_scopes.rb
+- eitil_wrapper/lib/eitil_wrapper/records/default_sorts.rb
 - eitil_wrapper/lib/eitil_wrapper/request_logger.rb
 - eitil_wrapper/lib/eitil_wrapper/request_logger/controller_mixin.rb
 - eitil_wrapper/lib/eitil_wrapper/request_logger/logger_job.rb
 - eitil_wrapper/lib/eitil_wrapper/routes.rb
 - eitil_wrapper/lib/eitil_wrapper/routes/extended_resources.rb
-- eitil_wrapper/lib/eitil_wrapper/scopes.rb
-- eitil_wrapper/lib/eitil_wrapper/scopes/default_scopes.rb
 - lib/eitil.rb
 - lib/eitil/all.rb
 - lib/eitil/railtie.rb
@@ -470,7 +472,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Eitil (eitje utility) never stops increasing your life's efficacy and productivity,

data/eitil_wrapper/lib/eitil_wrapper/scopes.rb

@@ -1,2 +0,0 @@
-
-require "eitil_wrapper/scopes/default_scopes"