eitil 1.4.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2b711724f69a784e0bc3c374d20fc69a333d7aaf13d14b385eda5e4555f7460
-  data.tar.gz: 77634b67694ccc4b3491c3109f9f8ce09fb076f7a501bc5bbfee852703b51487
+  metadata.gz: f5c9cca8a4db961ae507f9326d97344ccb4de0c92b6c5104b1736b37e10c8498
+  data.tar.gz: 5ab03a4673c04380440686de8b702ab6e9f241240cdff749d1ddcf85a753c660
 SHA512:
-  metadata.gz: 4cdd22e13e5bfb4225187171da7bb0f4fb600c35b72dd007f0bbada16e0d2f349ad97b1c8355aa5e89cd4a6b42b9776027232f278a97aa5e91a2a6bfa5de7922
-  data.tar.gz: f3084558965176db0aceebb82e218b6dde618e57ab6cb6ab768a9b5f9a36d98f657d28967d08ddcfe5928dc8529382a6971bc1a94a4bc179f4e15c32167dceb1
+  metadata.gz: 62c4d31b23148b143ec87613f8b7e102db21d44709904449c85d938ebfd8b4fe7997814ecb96921ca73964d02aa1354d5214c9534faa6c7ef204c47259f35275
+  data.tar.gz: e7b017c534422ecd3b5f4e648def6197817094e7a40a313c4eaebe7794cffd183be51efe7670629044db372fe6a0e8d3c86c2587233b469df990a9b429c70146

data/README.md

@@ -12,7 +12,6 @@ Our gem currently exists of five seperate layers (Railties), which can be integr
 
 - EitilCore, [docs](/eitil_core) > extends the core classes of Ruby and rails.
 - EitilSupport, [docs](/eitil_support) > provides utility through stand-alone classes and modules.
-- EitilWrapper, [docs](/eitil_wrapper) > wraps core rails operations with extended utilities – such as routing, jobs and decoraters.
 - EitilStore, [docs](/eitil_store) > stores data in containers, such as Regexp instances.
 - EitilIntegrate, [docs](/eitil_integrate) > provides seamless integrations with select gems and API's, through helper methods stored in PORO's. 
 

data/eitil_integrate/lib/eitil_integrate/application_exporter/lookups.rb

@@ -10,7 +10,7 @@ module EitilIntegrate::RubyXL
     class << self
 
       def exporter_paths
-        EitilSupport::Directory.files('app/exporters/exporters').select { |path| path.end_with? '_exporter.rb' }
+        EitilSupport::Directory.files('app/views/exporters/exporters').select { |path| path.end_with? '_exporter.rb' }
       end
 
       def exporter_names

data/lib/eitil/railtie.rb

@@ -6,7 +6,7 @@
 module Eitil
   
   Root   = Gem.loaded_specs['eitil']&.full_gem_path
-  Layers = %w( eitil_core eitil_support eitil_wrapper eitil_store eitil_integrate )
+  Layers = %w( eitil_core eitil_support eitil_store eitil_integrate )
   ApplicationRecordModules = []
 
 end
@@ -45,10 +45,9 @@ module Eitil
         yield Eitil
       end
 
-      config_path = Rails.root + 'config/initializers/eitil.rb'
+      config_path = Rails.root + 'config/initializers/internal_engines/eitil.rb'
     
       if File.exists? config_path
-        puts "Loading Eitil config from #{config_path}..."
         load config_path
       else
         puts "Eitil config not found at #{config_path}, resorting to defaults..."

data/lib/eitil/version.rb

@@ -1,5 +1,5 @@
 module Eitil
   
-  VERSION = '1.4.1'
+  VERSION = '2.0.3'
   
 end

data/spec/dummy_app/app/controllers/application_controller.rb

@@ -1,5 +1,3 @@
 class ApplicationController < ActionController::Base
 
-  include EitilWrapper::ControllerDecorator
-
 end

data/spec/dummy_app/app/controllers/users_controller.rb

@@ -3,37 +3,6 @@ class UsersController < ApplicationController
   before_action :set_user, only: [:show, :edit, :update, :destroy]
 
 
-  # ---
-  # Tests for EitilWrapper::Decorator
-
-  before_action :set_user, only: [:decorator_a, :decorator_b, :decorator_c, :decorator_d]
-
-  # default
-  def decorator_a
-    hash = decorate(@user)
-    render json: hash
-  end
-
-  # specific dec_method
-  def decorator_b
-    hash = decorate(@user, dec_method: :first_and_last_name)
-    render json: hash
-  end
-
-  # post request, with 'isWeb' and 'isMobile' params
-  def decorator_c
-    hash = decorate(@user)
-    render json: hash
-  end
-
-  # specific dec_class
-  def decorator_d
-    hash = decorate(@user, dec_class: :Application, dec_method: :timestamps)
-    render json: hash
-  end
-
-  # ---
-
 
 
   # GET /users

data/spec/dummy_app/config/routes.rb

@@ -4,9 +4,4 @@ Rails.application.routes.draw do
   resources :addresses
   resources :users
 
-  get  'users/:id/decorator_a' => 'users#decorator_a'
-  get  'users/:id/decorator_b' => 'users#decorator_b'
-  post 'users/:id/decorator_c' => 'users#decorator_c'
-  get  'users/:id/decorator_d' => 'users#decorator_d'
-
 end

data/spec/spec_helper.rb

@@ -8,13 +8,11 @@ require 'eitil'
 
 require "eitil_core/railtie"
 require "eitil_integrate/railtie"
-require "eitil_wrapper/railtie"
 # require "eitil_store/railtie"
 # require "eitil_support/railtie"
 
 require "eitil_core"
 require "eitil_integrate"
-require "eitil_wrapper"
 # require "eitil_store"
 # require "eitil_support"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eitil
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Jurriaan Schrofer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -271,27 +271,6 @@ files:
 - eitil_support/lib/eitil_support/stacktrace/audit.rb
 - eitil_support/lib/eitil_support/stacktrace/call.rb
 - eitil_support/lib/eitil_support/stacktrace/stack.rb
-- eitil_wrapper/README.md
-- eitil_wrapper/lib/eitil_wrapper.rb
-- eitil_wrapper/lib/eitil_wrapper/callbacks.rb
-- eitil_wrapper/lib/eitil_wrapper/callbacks/helper_methods.rb
-- eitil_wrapper/lib/eitil_wrapper/decorators.rb
-- eitil_wrapper/lib/eitil_wrapper/decorators/application_decorator.rb
-- eitil_wrapper/lib/eitil_wrapper/decorators/controller_decorator.rb
-- eitil_wrapper/lib/eitil_wrapper/jobs.rb
-- eitil_wrapper/lib/eitil_wrapper/jobs/new_job.rb
-- 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
 - lib/eitil.rb
 - lib/eitil/all.rb
 - lib/eitil/railtie.rb
@@ -309,9 +288,6 @@ files:
 - spec/dummy_app/app/controllers/addresses_controller.rb
 - spec/dummy_app/app/controllers/application_controller.rb
 - spec/dummy_app/app/controllers/users_controller.rb
-- spec/dummy_app/app/decorators/address_decorator.rb
-- spec/dummy_app/app/decorators/application_decorator.rb
-- spec/dummy_app/app/decorators/user_decorator.rb
 - spec/dummy_app/app/helpers/addresses_helper.rb
 - spec/dummy_app/app/helpers/application_helper.rb
 - spec/dummy_app/app/helpers/users_helper.rb
@@ -444,7 +420,6 @@ files:
 - spec/eitil_integrate/application_exporter/auto_sum_spec.rb
 - spec/eitil_integrate/application_exporter/initialize_spec.rb
 - spec/eitil_wrapper/callbacks/helper_methods_spec.rb
-- spec/eitil_wrapper/decorators/decorators_spec.rb
 - spec/eitil_wrapper/jobs/single_method_job_spec.rb
 - spec/eitil_wrapper/routes/extended_resources_spec.rb
 - spec/eitil_wrapper/scopes/default_scopes_spec.rb

data/eitil_wrapper/README.md

@@ -1,309 +0,0 @@
-
-
-
-# EitilWrapper
-
-EitilWrapper wraps core rails operations with extended utilities – such as routing, jobs and decoraters.
-
-
-
-
-
-
-## EitilWrapper::Callbacks
-
-```ruby
-
-require "eitil_wrapper/callbacks"
-
-```
-
-Callback helper methods are created for use within a model's callbacks. You can use them as callback conditionals, e.g. "after_save :do_this, if :doing_became_true". Which scopes are generated depends on the datatype of a column. The methods currently generated are:
-
-```ruby
-# require "eitil_wrapper/callbacks/helper_methods"
-
-# columns of datatype: boolean
-.{column_name}_became_true
-.{column_name}_becomes_true
-.{column_name}_to_true # works for both become and became
-
-.{column_name}_became_false
-.{column_name}_becomes_false
-.{column_name}_to_false # works for both become and became
-```
-
-
-
-
-
-## EitilWrapper::Decorators
-
-```ruby
-
-require "eitil_wrapper/decorators"
-
-```
-
-The Eitil decorator wrappers help you to standardize the calling of the right decorator method from within your controller action. Basically it provides you with a decorate macro in each controller.
-
-```ruby
-decorate(dec_item, dec_method: nil, dec_class: nil, **dec_kwargs)
-```
-
-- dec_item is the instance that will be decorated
-- dec_method enabled you to set the desired decorator method. If not provided, it will look into the request params: if params["isMobile"] is present it will call .app, if params["isWeb"] is present it will call :app. If neither is provided in the params, it will call the default method :base.
-- dec_class enables you to overwrite the decorator class that will be called. If not provided, the decorator class will be inferred from the instance model's classname (User => UserDecorator).
-- dec_kwargs enables you to provide additional arguments, which will be passed to your decorator method.
-
-
-### Configuration
-
-1. Your decorator classes should inherit from EitilWrapper::ApplicationDecorator.
-2. Your controllers should inherit the module EitilWrapper::ControllerDecorator, through inclusion in a superclass.
-3. If you set controller ivars for each request, you can make them available in your decorators by providing Eitil with the names of your ivars as an array of symbols:
-
-```ruby
-# initializers/eitil.rb
-
-Eitil.set_config do |config|
-  config.controller_ivars = [:user, :env]
-end
-```
-
-
-
-
-
-## EitilWrapper::Jobs
-
-```ruby
-
-require "eitil_wrapper/jobs"
-
-```
-
-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_now macro defines a new :method_job_now method, which performs in the foreground.
-
-```ruby
-# require "eitil_wrapper/jobs/new_job"
-
-new_job(_method, *args, **kwargs)
-# assuming a method :hello_world, call as: new_job :hello_world
-# => defines :hello_world_job
-```
-
-```ruby
-# require "eitil_wrapper/jobs/new_job_now"
-
-new_job_now(_method, *args, **kwargs)
-# assuming a method :hello_world, call as: new_job_now :hello_world
-# => defines :hello_world_job_now
-```
-
-
-
-
-
-## EitilWrapper::Routes
-
-```ruby
-
-require "eitil_wrapper/routes"
-
-```
-
-The Eitil router wrapper enables you to easily create new routes that can be shared among controllers. In that sense, it is as a custom extension of the built-in resourceful routes.
-
-### New route
-
-The first macro, .new_route, enables you to create new route objects which may be called and used by different controllers.
-
-```ruby
-# require "eitil_wrapper/routes/extended_resources"
-
-new_route(verb, _method, action, scope)
-# call as: new_route :post, :attachment, "add_attachment", :member
-```
-
-- verb refers to the http_verb, e.g. :put.
-- method refers to the given http method (e.g. 'users/:id'). Additionally, this is the name you will refer to in order to include the route into a controller. Therefore the argument should be unique among all other routes.
-- action refers to the controller action to which you want to redirect to request, e.g. :update_user.
-- scope refers to the url and can be set to either :member or :collection.
-
-### Add route
-
-The second macro, extended_resources, enables you to create all standard resources for a controller and add your own standardized routes. This macro works the same as the built-in :resources, except that you can pass more arguments to only: [], which adds the routes to your controller.
-
-```ruby
-# require "eitil_wrapper/routes/extended_resources"
-
-extended_resources(controller, **kwargs)
-# call as: extended_resources :posts, only: [:create, :update, :attachment]
-```
-
-
-
-
-
-## EitilWrapper::Records
-
-```ruby
-
-# include all below EitilWrapper::Records helpers through:
-require "eitil_wrapper/records"
-
-```
-
-### Scopes
-
-```ruby
-
-require "eitil_wrapper/records/scopes"
-
-```
-
-Scopes are generated through the columns of your model's database table. Which scopes are generated depends on the datatype of a column. For example, if your User model with table users has a column is_manager, a scope :is_manager_true is generated for your User model. A scope method is defined only if it does not already responds to another method of the same name. The scopes generated are:
-
-```ruby
-# require "eitil_wrapper/scopes/default_scopes"
-
-# columns of datatype: boolean
-.{column_name}_true
-.{column_name}_false
-
-# columns of datatype: datetime
-.{column_name}_today      
-.{column_name}_past       
-.{column_name}_future             
-.{column_name}_on_date(date)    
-.{column_name}_before_date(date)
-.{column_name}_after_date(date) 
-.{column_name}_between_dates(start_date, end_date)
-
-# columns of datatype: date
-.{column_name}_today      
-.{column_name}_past       
-.{column_name}_future             
-.{column_name}_on_date(date)    
-.{column_name}_before_date(date)
-.{column_name}_after_date(date) 
-.{column_name}_between_dates(start_date, end_date)
-
-# columns of datatype: integer
-.{column_name}_equal_to(number)      
-.{column_name}_lower_than(number)
-.{column_name}_higher_than(number)
-.{column_name}_between(min, max)
-
-# 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
-.{column_name}_sum_i # sum and map to integer
-.{column_name}_sum_f # sum and map to float
-.{column_name}_sum_d # sum and map to decimal
-
-# 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
-```
-
-
-
-## EitilWrapper::RequestLogger
-
-```ruby
-
-require "eitil_wrapper/request_logger"
-
-```
-
-The RequestLogger wrapper logs request params in /log/request_logger.log, which offers the opportunity to pry into webhooks while developing. In order to track a controller, simply add the following. This calls a background job which writes to the file.
-
-```ruby
-
-include EitilWrapper::RequestLogger::ControllerMixin
-before_action :log_request
-
-```
-
-
-
-
-

data/eitil_wrapper/lib/eitil_wrapper/callbacks/helper_methods.rb

@@ -1,118 +0,0 @@
-
-# require "eitil_wrapper/callbacks/helper_methods"
-
-# require "eitil_wrapper/railtie" to run the dynamic dispatch as an init hook during boot
-require "eitil_wrapper/railtie"
-
-require "eitil_core/argument_helpers/all_args_to_ivars"
-
-module EitilWrapper
-  module Callbacks
-    module HelperMethods
-
-      Eitil::ApplicationRecordModules << self
-
-      def inherited(subclass)
-        super
-        return if Eitil.skip_callback_helper_methods_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_callback_helper_methods
-
-        rescue => e
-          puts "callback helper methods failed for #{subclass} because of #{e.class} and '#{e.to_s.split(' ').first}'"
-      end
-
-      def use_eitil_callback_helper_methods  
-        return if abstract_class?  
-        create_eitil_boolean_callback_helper_methods
-      end
-
-      def columns_of_type(data_type)
-        columns_hash.select { |column,v| v.sql_type_metadata.type == data_type }
-      end
-
-      def create_eitil_boolean_callback_helper_methods
-        columns = columns_of_type :boolean
-        columns&.each do |column_name, eitil_object|
-        
-          # truthy methods
-          create_eitil_became_true_callback_helper column_name
-          create_eitil_becomes_true_callback_helper column_name
-          create_eitil_to_true_callback_helper column_name
-
-          # falsy methods
-          create_eitil_became_false_callback_helper column_name
-          create_eitil_becomes_false_callback_helper column_name
-          create_eitil_to_false_callback_helper column_name
-
-        end
-      end
-
-      def create_eitil_became_true_callback_helper(column_name)
-        method_name = "#{column_name}_became_true"
-
-        define_method(method_name) do
-          _changes = previous_changes[column_name]
-          _changes && !_changes[0] && _changes[1]
-        end
-      end
-
-      def create_eitil_becomes_true_callback_helper(column_name)
-        method_name = "#{column_name}_becomes_true"
-
-        define_method(method_name) do
-          _changes = changes[column_name]
-          _changes && !_changes[0] && _changes[1]
-        end 
-      end
-
-      def create_eitil_to_true_callback_helper(column_name)
-        method_name    = "#{column_name}_to_true"
-        becomes_method = "#{column_name}_becomes_true"
-        became_method  = "#{column_name}_became_true"
-
-        define_method(method_name) do
-          return send(becomes_method) if changes&.present?
-          return send(became_method)  if previous_changes&.present?
-        end 
-      end
-
-      def create_eitil_became_false_callback_helper(column_name)
-        method_name = "#{column_name}_became_false"
-
-        define_method(method_name) do
-          _changes = previous_changes[column_name]
-          _changes && _changes[0] && !_changes[1]
-        end
-      end
-
-      def create_eitil_becomes_false_callback_helper(column_name)
-        method_name = "#{column_name}_becomes_false"
-
-        define_method(method_name) do
-          _changes = changes[column_name]
-          _changes && _changes[0] && !_changes[1]
-        end 
-      end
-
-      def create_eitil_to_false_callback_helper(column_name)
-        method_name    = "#{column_name}_to_false"
-        becomes_method = "#{column_name}_becomes_false"
-        became_method  = "#{column_name}_became_false"
-
-        define_method(method_name) do
-          return send(becomes_method) if changes&.present?
-          return send(became_method)  if previous_changes&.present?
-        end 
-      end
-
-    end
-  end
-end

data/eitil_wrapper/lib/eitil_wrapper/callbacks.rb

@@ -1,2 +0,0 @@
-
-require "eitil_wrapper/callbacks/helper_methods"

data/eitil_wrapper/lib/eitil_wrapper/decorators/application_decorator.rb

@@ -1,22 +0,0 @@
-
-require "active_model/railtie"
-
-module EitilWrapper
-  class ApplicationDecorator
-
-    include ActiveModel::Model
-
-    def initialize(attributes={}, **kwargs)      
-      super attributes
-      all_kwargs_to_ivars binding
-    end
-
-    def self.method_missing(method_name, *args, **kwargs)
-      if %i$ web app $.include?(method_name.to_sym)
-        kwargs.any? ? send(:base, *args, **kwargs) : send(:base, *args)
-      end
-      super
-    end
-
-  end
-end