eitil 0.3.2 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14233b2ffb39a1ca7d1710fd9a57925994d5784e427f8d022d21ceeb02eb2fdf
-  data.tar.gz: c3f42a3bda7b6efd0292f7e3b364ce3595ac023216a3d5d1364d90257828c1a5
+  metadata.gz: 24a0dccf0357bf5e01f41be73b6b1d4c840cbb8efa233ab772ad1c6c8bd94cff
+  data.tar.gz: 7dc80a7a0268a68302fa74ddc1e0f371a83fba8a77dee2cb38a5ad03c08b3688
 SHA512:
-  metadata.gz: 7f0748ebb4cfeb31128024ac32226811205827db8ad381226dd3f04532c6cf2fc700448712e6bd16ba86770574bd161eebb56d6c44b20b03694ed5a0a9160ddc
-  data.tar.gz: 762bca6004ea991b05cad4df3a10f4cf16ba9c3f91e1d2d6b32c29dada7e2a9b7f8a6572d8096c6d53b5e3777a2e802662dab85df49ffecf4083f84b4caeacf8
+  metadata.gz: 6d4a5e8baadfbd18962a5452e42b2051dff922765fbd2a53dcbe15a415a8e805a031efe18defc70d7360f52701d12b2ddcbbc07a96dc8ae2cffd3c33e121a636
+  data.tar.gz: 83a19e9611e3553faf36663b5676c1abb3bc81af22052014cc250f8230665ce36b98a606a4a834923d2c24d81f7c347fa27ab91171a1cd74ca25a871e81d4e7a

data/README.md

@@ -50,15 +50,21 @@ args_to_ivars(binding, *local_vars)
 # sets specified keywords arguments of the method's local binding to instance variables
 # call as: all_args_to_ivars binding :user_id, :user_name
 
-all_kwargs_to_ivars(binding)
+all_kwargs_to_ivars(local_binding, namespace=:kwargs)
 # sets the method's **kwargs argument to instance variables, with each key as the ivar's "@#{name}" and the value as its value
 # call as: kwargs_to_ivars binding
+# the keywords container name can be overwritten, e.g. the common :attributes
 
 set_ivars(*ivars)
 # sets instance variables named @"#{ivar}" for each symbol passed, by invoking send("set_#{ivar}")
 # e.g. set_ivars(:user) sets @user with the value returned by your local method .set_user
 # call as: set_ivars :user, :authentication, :connection
 
+run_validations(*validations)
+# calls a method for each argument, namespaced as "validate_#{argument}"
+# call as: run_validations(:single_receipt, :single_order)
+# => calls #validate_single_receipt and #validate_single_order
+
 safe_send(method, *args, return_value: nil)
 # a safe version of .send, which in case of an error rescues and returns return_value (default: nil) instead
 
@@ -92,6 +98,7 @@ include_concerns_of(*directories, namespace: nil)
 # call as: include_concerns_of :user, :mail 
 # => includes all modules of models/concerns/user/* and models/oncerns/mail/*
 # or call as: include_concerns_of :request_service, namespace: Eivid::Concerns
+# tip: call Class.included_modules to view all included modules 
 ```
 
 
@@ -124,6 +131,14 @@ slice_params(*args)
 self.all_associations
 # returns all associations for a given model
 # call as: Environment.all_associations
+
+self.where_like(_hash)
+# runs .where with your string field made into a wildcard and case insensitive
+# call as: User.where_like(name: 'jurriaan')
+
+self.find_by_like(_hash)
+# runs .find_by with your string field made into a wildcard and case insensitive
+# call as: User.find_by_like(name: 'jurriaan')
 ```
 
 
@@ -170,7 +185,7 @@ decorate(dec_item, dec_method: nil, dec_class: nil, **dec_kwargs)
 # initializers/eitil.rb
 
 Eitil.set_config do |config|
-  config.get_controller_ivars_method = 'API::VerlofVerzoekenController.controller_ivars' # => [:user, :env]
+  config.get_controller_ivars_method = 'API::BaseController.controller_ivars' # => [:user, :env]
 end
 ```
 
@@ -220,14 +235,18 @@ The router wrapper is a single module which is automatically included into your
 
 ### Info
 
-The Eitil jobs wrapper enables you to create perform_later jobs on the fly, without the need to create a new class and file. The macro new_job accepts a :method as argument and defines a new method :method_job. The newly defined :method_job, when called, performs the orginal :method in the background. The new_job macro accepts both instance methods and singleton methods, which are defined within there own method scope.
+The Eitil jobs wrapper enables you to create perform_now and perform_later jobs on the fly, without the need to create a new class and file. The macro new_job accepts a :method as argument and defines a new method :method_job. The newly defined :method_job, when called, performs the orginal :method in the background. The new_job macro accepts both instance methods and singleton methods, which are defined within there own method scope. In contrast, the new_job_debugger macro defines a new :method_job_debugger method, which performs in the foreground.
 
 ### Job Macro
 
 ```ruby
-new_job(_method)
-# assuming a method :print_hello_world, call as: new_job :hello_world
-# => method :hello_world_job
+new_job(_method, *args, **kwargs)
+# assuming a method :hello_world, call as: new_job :hello_world
+# => defines :hello_world_job
+
+new_job_debugger(_method, *args, **kwargs)
+# assuming a method :hello_world, call as: new_job_debugger :hello_world
+# => defines :hello_world_job_debugger
 ```
 
 - method is 
@@ -242,15 +261,7 @@ The new_job macro is monkey patched into Kernel, therefore no configuration is r
 
 ### Info
 
-The Eitil scopes wrapper creates various default scopes for a model, simply through including 'use_eitil_scopes' in the top of your model file, for example:
-
-```ruby
-# models/user.rb
-
-class User < ApplicationRecord
-  use_eitil_scopes
-end
-```
+The Eitil scopes wrapper creates various default scopes for a model.
 
 ### The Scopes
 
@@ -305,3 +316,50 @@ Scopes are generated through the columns of your model's database table. Which s
 Your models should inherit the module Eitil::DefaultScopes through inclusion in a superclass, such as ApplicationRecord.
 
 
+
+# Modules & Classes
+
+
+
+## Eitil::Dir
+
+### Info
+
+The Eitil::Dir module provides methods which help you introspect your Rails project.
+
+### Methods
+
+```ruby
+Eitil::Dir.contents(directory='app')
+# returns all files and subdirectories of a given directory
+
+Eitil::Dir.files(directory='app')
+# returns all files of a given directory
+
+Eitil::Dir.subdirs(directory='app')
+# returns all subdirectories of a given directory
+
+Eitil::Dir.lines(directory='app')
+# returns the total amount of lines of all files of a given directory
+```
+
+
+
+## Eitil::StackTrace
+
+### Info
+
+The two classes Eitil::StackTrace::Stack and Eitil::StackTrace::Call, and the single module Eitil::StackTrace::Audit, provide the utility of easily viewing and storing the current stacktrace anywhere in your code. By initializing stack = Eitil::StackTrace::Stack.new, you can call methods as stack.report (returns the stacktrace as array), stack.show (pretty prints the stacktrace) and stack.find (accepts a block to find a call).
+
+You can also store the stacktrace of a record's update action into its audit. In order to do so, you need 1) to include Eitil::StackTrace::Audit into your model, and 2) add a :stacktrace column to your audits through the following migration.
+
+### Migration
+
+```ruby
+def change
+	add_column :audits, :stacktrace, :text, array: true, default: [] 
+end
+```
+
+
+

data/app/models/eitil/stack_trace/audit.rb

@@ -0,0 +1,15 @@
+module Eitil::StackTrace::Audit
+  extend ActiveSupport::Concern
+  included do
+
+    private
+    
+    after_update :add_stacktrace_to_audit
+
+    def add_stacktrace_to_audit
+      stacktrace = Eitil::StackTrace::Stack.new.report
+      self.audits.last.update(stacktrace: stacktrace)
+    end
+
+  end
+end

data/app/models/eitil/stack_trace/call.rb

@@ -0,0 +1,17 @@
+module Eitil::StackTrace
+  class Call
+
+    attr_reader :program, :line, :meth
+
+    CALL_RE = /(.*):(\d+):in `(.*)'/
+
+    def initialize(string)
+      @program, @line, @meth = CALL_RE.match(string).captures
+    end
+
+    def to_s
+      "#{"#{meth}".ljust(50)} #{"(#{line})".ljust(6)} #{program}"
+    end
+
+  end
+end

data/app/models/eitil/stack_trace/stack.rb

@@ -0,0 +1,28 @@
+module Eitil::StackTrace
+  class Stack
+
+  attr_reader :stack, :backtrace
+
+  def initialize
+    @stack     = caller[1..]
+    @backtrace = stack.map { |call| Eitil::StackTrace::Call.new(call) }
+  end
+
+  def report
+    backtrace.map(&:to_s)
+  end
+
+  def show
+    ap report
+  end
+
+  def find(&block)
+    backtrace.find(&block)
+  end
+
+  def self.parse(array_as_string)
+    array_as_string.sub('[', ' ').reverse.sub(']','').reverse.split(',').flatten
+  end
+
+  end
+end

data/config/initializers/modules/dir.rb

@@ -0,0 +1,21 @@
+module Eitil::Dir
+  class << self
+
+    def contents(directory='app')
+      Dir[File.join(directory, '**', '*')]
+    end
+
+    def files(directory='app')
+      contents(directory).select { |file| File.file?(file) }
+    end
+
+    def subdirs(directory='app')
+      contents(directory).select { |file| File.directory?(file) }
+    end
+
+    def lines(directory='app')
+      files(directory).map { |file| File.open(file).count }.sum
+    end
+
+  end
+end

data/config/initializers/monkeys/application_record.rb

@@ -4,11 +4,24 @@ module ApplicationRecordMonkey
   extend ActiveSupport::Concern 
   included do
 
-    def self.all_associations
-      reflect_on_all_associations.map do |assoc|
-        assoc_type = assoc.association_class.to_s.split('::').last
-        "#{assoc.name} (#{assoc_type})"
+    class << self
+
+      def all_associations
+        reflect_on_all_associations.map do |assoc|
+          { assoc.name => assoc.association_class.to_s.demodulize }
+        end.inject &:merge
+      end
+
+      def where_like(_hash)
+        column, like = _hash.first
+        where("LOWER(#{column}) LIKE ?", "%#{like.downcase}%")
       end
+
+      def find_by_like(_hash)
+        column, like = _hash.first
+        find_by("LOWER(#{column}) LIKE ?", "%#{like.downcase}%")
+      end
+
     end
 
   end

data/config/initializers/monkeys/hash.rb

@@ -8,7 +8,7 @@ class Hash
       return answer if answer
     end
 
-    false
+    nil
   end
 
 end

data/config/initializers/monkeys/kernel.rb

@@ -12,8 +12,8 @@ Kernel.module_eval do
     end
   end
 
-  def all_kwargs_to_ivars(local_binding)
-    local_binding.local_variable_get(:kwargs).each do |name, value|
+  def all_kwargs_to_ivars(local_binding, namespace=:kwargs)
+    local_binding.local_variable_get(namespace).each do |name, value|
       instance_variable_set "@#{name}", value
     end
   end
@@ -24,6 +24,10 @@ Kernel.module_eval do
     end
   end
 
+  def run_validations(*validations)
+    validations.each { |v| eval "validate_#{v}" }
+  end
+
   def safe_call(*args, return_value: nil, &block)
     block.call self, *args
     rescue

data/config/initializers/wrappers/jobs/active_job_macros.rb

@@ -1,18 +1,52 @@
 Kernel.module_eval do
 
-  def new_job(_method)
+  # BEWARE: _self is currently not accepted in perform_later jobs due to serialization errors
+
+  # The cases of 'id' and '_self' both handle instances, with the difference 
+  # being that 'id' works for objects that have a database record, while '_self'
+  # works for non database supported instanes, such as an Exporter instance.
+
+  def new_job(_method, *args, **kwargs)
 
     if instance_methods(false).include? _method
-      define_method "#{_method}_job" do
-        Eitil::SingleMethodJob.perform_later(_class: self.class.to_s, _method: _method.to_s, id: id)
+      define_method "#{_method}_job" do |_self = nil, *args, **kwargs|
+        
+        Eitil::SingleMethodJob.perform_later(
+          *args, _class: self.class.to_s, _method: _method.to_s, id: safe_send(:id), _self: self.to_json, **kwargs
+        )
       end
 
-    elsif singleton_methods(false).include? _method
-      define_singleton_method "#{_method}_job" do
-        Eitil::SingleMethodJob.perform_later(_class: to_s, _method: _method.to_s)
+    elsif singleton_methods(false).include? _method      
+      define_singleton_method "#{_method}_job" do |*args, **kwargs|
+       
+        Eitil::SingleMethodJob.perform_later(
+          *args, _class: to_s, _method: _method.to_s, **kwargs
+        )
       end
-    end  
+    end 
+  end
+
+  # BEWARE: This is an exact copy of the above method, except for .perform_now instead of .perform_later and the method's name.
+  # The reason for not using helper methods is to not unnecessarily fill and potentially fuck up the Kernel environment.
+
+  def new_job_debugger(_method, *args, **kwargs)
 
+    if instance_methods(false).include? _method
+      define_method "#{_method}_job_debugger" do |_self = nil, *args, **kwargs|
+        
+        Eitil::SingleMethodJob.perform_now(
+          *args, _class: self.class.to_s, _method: _method.to_s, id: safe_send(:id), _self: self.to_json, **kwargs
+        )
+      end
+
+    elsif singleton_methods(false).include? _method      
+      define_singleton_method "#{_method}_job_debugger" do |*args, **kwargs|
+       
+        Eitil::SingleMethodJob.perform_now(
+          *args, _class: to_s, _method: _method.to_s, **kwargs
+        )
+      end
+    end 
   end
 
 end

data/config/initializers/wrappers/jobs/single_method_job.rb

@@ -2,9 +2,23 @@ module Eitil
   class SingleMethodJob < ApplicationJob
     queue_as :default
 
-    def perform(_class:, _method:, id: nil)
-      object = id ? _class.constantize.find(id) : _class.constantize
-      object.send _method
+    # BEWARE: _self is currently not accepted in perform_later jobs due to serialization errors
+
+    # The cases of 'id' and '_self' both handle instances, with the difference 
+    # being that 'id' works for objects that have a database record, while '_self'
+    # works for non database supported instanes, such as an Exporter instance.
+
+    def perform(*args, _class:, _method:, id: nil, _self: nil, **kwargs)      
+      object = 
+        if id
+          _class.constantize.find(id)
+        elsif _self
+          _self
+        else
+          _class.constantize
+        end
+
+      object.send _method, *args, **kwargs
     end
   end
 end

data/config/initializers/wrappers/scopes/default_scopes.rb

@@ -2,80 +2,82 @@ module Eitil
   module DefaultScopes
     extend ActiveSupport::Concern
     included do
-      
-      SharableDateScopes = -> (column) {
-        eitil_scope :"#{column}_today",         -> { where("#{column} = ?", Date.today) }
-        eitil_scope :"#{column}_past",          -> { where("#{column} < ?", Date.today) }
-        eitil_scope :"#{column}_future",        -> { where("#{column} > ?", Date.today) }
-        
-        eitil_scope :"#{column}_on_date",       -> (date) { where("#{column} = ?", date) }
-        eitil_scope :"#{column}_before_date",   -> (date) { where("#{column} = ?", date) }
-        eitil_scope :"#{column}_after_date",    -> (date) { where("#{column} = ?", date) }
-        eitil_scope :"#{column}_between_dates", -> (from, till) { where("#{column} >= ? and #{column} <= ?", from, till) }
+      class << self
 
-        eitil_scope :"#{column}_oldest_first",  -> { order("#{column} ASC") }
-        eitil_scope :"#{column}_newest_first",  -> { order("#{column} DESC") }
-      }
+          SharableDateScopes = -> (_class, column) {
+            _class.eitil_scope :"#{column}_today",          -> { where("#{column} = ?", Date.today) }
+            _class.eitil_scope :"#{column}_past",           -> { where("#{column} < ?", Date.today) }
+            _class.eitil_scope :"#{column}_future",         -> { where("#{column} > ?", Date.today) }
+            
+            _class.eitil_scope :"#{column}_on_date",        -> (date) { where("#{column} = ?", date) }
+            _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) }
 
-      SharableNumScopes = -> (column) {
-       eitil_scope :"#{column}_equal_to",       -> (number) { where("#{column} = ?", number) }
-       eitil_scope :"#{column}_lower_than",     -> (number) { where("#{column} = <", number) }
-       eitil_scope :"#{column}_higher_than",    -> (number) { where("#{column} = >", number) }
-       eitil_scope :"#{column}_between",        -> (min, max) { where("#{column} >= ? and #{column} <= ?", min, max) }
+            _class.eitil_scope :"#{column}_oldest_first",   -> { order("#{column} ASC") }
+            _class.eitil_scope :"#{column}_newest_first",   -> { order("#{column} DESC") }
+          }
 
-       eitil_scope :"#{column}_ascending",      -> { order("#{column} ASC") }
-       eitil_scope :"#{column}_descending",     -> { order("#{column} DESC") }
-      }
+          SharableNumScopes = -> (_class, column) {
+            _class.eitil_scope :"#{column}_equal_to",       -> (number) { where("#{column} = ?", number) }
+            _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 << self
+            _class.eitil_scope :"#{column}_ascending",      -> { order("#{column} ASC") }
+            _class.eitil_scope :"#{column}_descending",     -> { order("#{column} DESC") }
+          }
 
-        private
+          def inherited(subclass)
+            super
+            subclass.use_eitil_scopes
+          end
 
-        def use_eitil_scopes  
-          %i[boolean datetime date integer float].each { |_type| send :"create_eitil_#{_type}_scopes" }
-        end
+          def use_eitil_scopes  
+            return if abstract_class?
+            %i[boolean datetime date integer float].each { |_type| send :"create_eitil_#{_type}_scopes" }
+          end
 
-        def eitil_scope(_name, _proc)
-          scope _name, _proc unless respond_to? _name
-        end
-      
-        def columns_of_type(data_type)
-          columns_hash.select { |column,v| v.sql_type_metadata.type == data_type }
-        end
+          def eitil_scope(_name, _proc)
+            scope _name, _proc unless respond_to? _name
+          end
+        
+          def columns_of_type(data_type)
+            columns_hash.select { |column,v| v.sql_type_metadata.type == data_type }
+          end
 
-        def create_eitil_boolean_scopes
-          columns_of_type(:boolean).map do |column, object|      
-            eitil_scope :"#{column}_true",  -> { where(column => true) }
-            eitil_scope :"#{column}_false", -> { where(column => [false, nil]) }
+          def create_eitil_boolean_scopes
+            columns_of_type(:boolean)&.map do |column, object|      
+              eitil_scope :"#{column}_true",     -> { where(column => true) }
+              eitil_scope :"#{column}_false", -> { where(column => [false, nil]) }
+            end
           end
-        end
 
-        def create_eitil_datetime_scopes
-          columns_of_type(:datetime).map do |column, object|
-            SharableDateScopes.call column
+          def create_eitil_datetime_scopes
+            columns_of_type(:datetime)&.map do |column, object|
+              SharableDateScopes.call self, column
+            end
           end
-        end
 
-        def create_eitil_date_scopes
-          columns_of_type(:date).map do |column, object|
-            SharableDateScopes.call column
+          def create_eitil_date_scopes
+            columns_of_type(:date)&.map do |column, object|
+              SharableDateScopes.call self, column
+            end
           end
-        end
 
-        def create_eitil_integer_scopes
-          columns_of_type(:integer).map do |column, object|
-            SharableNumScopes.call column
+          def create_eitil_integer_scopes
+            columns_of_type(:integer)&.map do |column, object|
+              SharableNumScopes.call self, column
+            end
           end
-        end
 
-        def create_eitil_float_scopes
-          columns_of_type(:float).map do |column, object|
-            SharableNumScopes.call column
+          def create_eitil_float_scopes
+            columns_of_type(:float)&.map do |column, object|
+              SharableNumScopes.call self, column
+            end
           end
-        end
 
       end
-
     end
   end
 end

data/lib/eitil/version.rb

@@ -1,3 +1,3 @@
 module Eitil
-  VERSION = '0.3.2'
+  VERSION = '0.3.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eitil
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.7
 platform: ruby
 authors:
 - Jurriaan Schrofer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,10 @@ files:
 - app/jobs/eitil/application_job.rb
 - app/mailers/eitil/application_mailer.rb
 - app/models/eitil/application_record.rb
+- app/models/eitil/stack_trace/audit.rb
+- app/models/eitil/stack_trace/call.rb
+- app/models/eitil/stack_trace/stack.rb
+- config/initializers/modules/dir.rb
 - config/initializers/monkeys/application_controller.rb
 - config/initializers/monkeys/application_record.rb
 - config/initializers/monkeys/date_time.rb