k_domain 0.0.20 → 0.0.27

data/templates/rails/action_controller.rb

@@ -0,0 +1,301 @@
+# Implement data capture methods for the Rails Action Controller class
+#
+# This Shim will intercept any DSL methods and convert their paramaters into a data hash
+module ActionController
+  extend RubyCodeExtractor::AttachClassInfo
+
+  class Base
+    extend RubyCodeExtractor::BehaviourAccessors
+
+    def self.singleton_class
+      Class.new do
+        def send(*_p, **_o); end
+      end.new
+    end
+
+    def self.class_info
+      return ActionController.class_info if ActionController.class_info
+
+      ActionController.class_info = {
+        class_name: name
+      }
+    end
+
+    def self.after_action(name, **opts)
+      add(:after_action, {
+            name: name,
+            opts: opts
+          })
+    end
+
+    def self.around_action(name, **opts)
+      add(:around_action, {
+            name: name,
+            opts: opts
+          })
+    end
+
+    def self.before_action(name, **opts)
+      add(:before_action, {
+            name: name,
+            opts: opts
+          })
+    end
+
+    def self.prepend_before_action(name, **opts)
+      add(:prepend_before_action, {
+            name: name,
+            opts: opts
+          })
+    end
+
+    def self.skip_before_action(name, **opts)
+      add(:skip_before_action, {
+            name: name,
+            opts: opts
+          })
+    end
+
+    def self.before_filter(name, **opts)
+      add(:before_filter, {
+            name: name,
+            opts: opts
+          })
+    end
+    
+    def self.skip_before_filter(name, **opts)
+      add(:skip_before_filter, {
+            name: name,
+            opts: opts
+          })
+    end
+
+    def self.layout(name, **opts)
+      set(:layout, {
+            name: name,
+            opts: opts
+          })
+    end
+
+    def self.rescue_from(type)#, &block)
+      # block_source = nil
+      # block_source = lambda_source(block, 'default_scope') if block_given?
+
+      add(:rescue_from, {
+            type: type#,
+            # block: block_source
+          })
+    end
+
+    # TODO: https://apidock.com/rails/ActionController/Helpers/ClassMethods/helper_method (MAYBE DEPRECATED?)
+    def self.helper_method(*names)
+      add(:helper_method, {
+            names: names
+          })
+    end
+
+    # TODO: https://apidock.com/rails/ActionController/Helpers/ClassMethods/helper
+    def self.helper(name)
+      add(:helper, {
+            name: name
+          })
+    end
+
+    def self.http_basic_authenticate_with(**opts)
+      set(:http_basic_authenticate_with, {
+            opts: opts
+          })
+    end
+
+    def self.protect_from_forgery(**opts)
+      set(:protect_from_forgery, {
+            opts: opts
+          })
+    end
+  end
+end
+
+# after_action
+# after_filter
+# append_after_action
+# append_after_filter
+# append_around_action
+# append_around_filter
+# append_before_action
+# append_before_filter
+# append_view_path
+# around_action
+# around_filter
+# before_action
+# before_filter
+# controller_name
+# controller_path
+# helper
+# helper_attr
+# helper_method
+# helpers
+# helpers_path
+# hide_action
+# http_basic_authenticate_with
+# layout
+# prepend_after_action
+# prepend_after_filter
+# prepend_around_action
+# prepend_around_filter
+# prepend_before_action
+# prepend_before_filter
+# prepend_view_path
+# protect_from_forgery
+# protected_instance_variables
+# rescue_from
+# reset_callbacks
+# skip_action_callback
+# skip_after_action
+# skip_after_filter
+# skip_around_action
+# skip_around_filter
+# skip_before_action
+# skip_before_filter
+# skip_callback
+# skip_filter
+
+# METHOD LIST - Just from running self.class.methods - Object.methods on a running controller
+# action
+# action_methods
+# add_flash_types
+# after_action
+# after_filter
+# all_helpers_from_path
+# allow_forgery_protection
+# allow_forgery_protection=
+# append_after_action
+# append_after_filter
+# append_around_action
+# append_around_filter
+# append_before_action
+# append_before_filter
+# append_view_path
+# around_action
+# around_filter
+# asset_host
+# asset_host=
+# assets_dir
+# assets_dir=
+# before_action
+# before_filter
+# cache_store
+# cache_store=
+# call
+# clear_action_methods!
+# clear_helpers
+# clear_respond_to
+# config
+# config_accessor
+# configure
+# controller_name
+# controller_path
+# default_asset_host_protocol
+# default_asset_host_protocol=
+# default_static_extension
+# default_static_extension=
+# default_url_options
+# default_url_options=
+# default_url_options?
+# define_callbacks
+# devise_group
+# direct_descendants
+# etag
+# etag_with_template_digest
+# etag_with_template_digest=
+# etag_with_template_digest?
+# etaggers
+# etaggers=
+# etaggers?
+# force_ssl
+# forgery_protection_strategy
+# forgery_protection_strategy=
+# get_callbacks
+# helper
+# helper_attr
+# helper_method
+# helpers
+# helpers_path
+# helpers_path=
+# helpers_path?
+# hidden_actions
+# hidden_actions=
+# hidden_actions?
+# hide_action
+# http_basic_authenticate_with
+# include_all_helpers
+# include_all_helpers=
+# include_all_helpers?
+# inherited
+# internal_methods
+# javascripts_dir
+# javascripts_dir=
+# layout
+# log_process_action
+# log_warning_on_csrf_failure
+# log_warning_on_csrf_failure=
+# logger
+# logger=
+# method_added
+# middleware
+# middleware_stack
+# middleware_stack=
+# middleware_stack?
+# mimes_for_respond_to
+# mimes_for_respond_to=
+# mimes_for_respond_to?
+# modules_for_helpers
+# normalize_callback_params
+# perform_caching
+# perform_caching=
+# prepend_after_action
+# prepend_after_filter
+# prepend_around_action
+# prepend_around_filter
+# prepend_before_action
+# prepend_before_filter
+# prepend_view_path
+# protect_from_forgery
+# protected_instance_variables
+# relative_url_root
+# relative_url_root=
+# request_forgery_protection_token
+# request_forgery_protection_token=
+# rescue_from
+# rescue_handlers
+# rescue_handlers=
+# rescue_handlers?
+# reset_callbacks
+# respond_to
+# responder
+# responder=
+# responder?
+# responders
+# set_callback
+# set_callbacks
+# skip_action_callback
+# skip_after_action
+# skip_after_filter
+# skip_around_action
+# skip_around_filter
+# skip_before_action
+# skip_before_filter
+# skip_callback
+# skip_filter
+# stylesheets_dir
+# stylesheets_dir=
+# supports_path?
+# use
+# use_renderer
+# use_renderers
+# view_cache_dependency
+# view_context_class
+# view_paths
+# view_paths=
+# visible_action?
+# without_modules
+# wrap_parameters

data/templates/{active_record_shims.rb → rails/active_record.rb}

@@ -1,13 +1,11 @@
 module ActiveRecord
-  def self.current_class
-    @current_class ||= nil
-  end
-
-  def self.current_class=(value)
-    @current_class = value
-  end
+  extend RubyCodeExtractor::AttachClassInfo
 
   class Base
+    extend RubyCodeExtractor::BehaviourAccessors
+
+    def self.require(*_p, **_o); end
+
     def self.singleton_class
       Class.new do
         def send(*_p, **_o); end
@@ -15,42 +13,22 @@ module ActiveRecord
     end
 
     def self.class_info
-      return ActiveRecord.current_class if ActiveRecord.current_class
+      return ActiveRecord.class_info if ActiveRecord.class_info
 
-      ActiveRecord.current_class = {
+      ActiveRecord.class_info = {
         class_name: name
       }
     end
 
-    def self.set(key, value)
-      class_info[key] = class_info[key] || {}
-      class_info[key] = value
-    end
+    # -------------------------
+    # Intercept methods
+    # -------------------------
 
-    def self.add(key, value)
-      class_info[key] = class_info[key] || []
-      if value.is_a?(Array)
-        class_info[key] = class_info[key] + value
-      else
-        class_info[key] << value
-      end
-    end
+    def self.clear_active_connections!; end
 
-    def self.custom_set(key, value = {})
-      class_info[:custom] = {} unless class_info[:custom]
-      class_info[:custom][key] = class_info[:custom][key] || {}
-      class_info[:custom][key] = value
-    end
-
-    def self.custom_add(key, value)
-      class_info[:custom] = {} unless class_info[:custom]
-      class_info[:custom][key] = class_info[:custom][key] || []
-      if value.is_a?(Array)
-        class_info[:custom][key] = class_info[:custom][key] + value
-      else
-        class_info[:custom][key] << value
-      end
-    end
+    # -------------------------
+    # Behaviour storage methods
+    # -------------------------
 
     # examples:
     # enum status: { active: 0, archived: 1 }
@@ -133,11 +111,15 @@ module ActiveRecord
     def self.belongs_to(name, on_the_lamb = nil, **opts)
       lamb_source = lambda_source(on_the_lamb, "belongs_to :#{name},")
 
-      add(:belongs_to, {
-            name: name,
-            opts: opts,
-            block: lamb_source
-          })
+      value = {
+        name: name,
+        opts: opts,
+        block: lamb_source
+      }
+
+      value[:opts][:foreign_key] = "#{name}_id" unless value[:opts][:foreign_key]
+
+      add(:belongs_to, value)
     end
 
     def self.has_many(name, on_the_lamb = nil, **opts)

data/templates/ruby_code_extractor/attach_class_info.rb

@@ -0,0 +1,13 @@
+module RubyCodeExtractor
+  # Class Info hash that contains the class name and any other key/values
+  # that could be useful when capturing Class information.
+  module AttachClassInfo
+    def class_info
+      @class_info ||= nil
+    end
+
+    def class_info=(value)
+      @class_info = value
+    end
+  end
+end

data/templates/ruby_code_extractor/behaviour_accessors.rb

@@ -0,0 +1,39 @@
+module RubyCodeExtractor
+  # When you intercept a method call, you can persist the captured paramaters
+  # into a Hash, the Hash Key should be the method name and the value should
+  # be a Hash with captured values.
+  #
+  # Use set/add for standard Rails DSL methods
+  # Use custom_set/custom_add for non standard or 3rd party GEM methods
+  module BehaviourAccessors
+    def set(key, value)
+      class_info[key] = class_info[key] || {}
+      class_info[key] = value
+    end
+
+    def add(key, value)
+      class_info[key] = class_info[key] || []
+      if value.is_a?(Array)
+        class_info[key] = class_info[key] + value
+      else
+        class_info[key] << value
+      end
+    end
+
+    def custom_set(key, value = {})
+      class_info[:custom] = {} unless class_info[:custom]
+      class_info[:custom][key] = class_info[:custom][key] || {}
+      class_info[:custom][key] = value
+    end
+
+    def custom_add(key, value)
+      class_info[:custom] = {} unless class_info[:custom]
+      class_info[:custom][key] = class_info[:custom][key] || []
+      if value.is_a?(Array)
+        class_info[:custom][key] = class_info[:custom][key] + value
+      else
+        class_info[:custom][key] << value
+      end
+    end
+  end
+end

data/templates/sample_config.rb

@@ -0,0 +1,47 @@
+KDomain.configure do |config|
+  config.default_main_key  = nil
+  config.default_traits    = %i[
+    trait1
+    trait2
+    trait3
+  ]
+
+  config.fallback_keys              = %i[
+    name
+    category
+    description
+    global
+    key
+    klass
+    message
+    lead_source
+    body
+    status
+    subject
+  ]
+
+  config.register_entity(:action_log              , main_key: :action)
+  config.register_entity(:backup                  , main_key: :filename)
+  config.register_entity(:campaign_calendar_entry , main_key: :date)
+  config.register_entity(:campaign_count          , main_key: :total_count)
+  config.register_entity(:comment                 , main_key: :title)
+  config.register_entity(:contact_group           , main_key: :email)
+  config.register_entity(:email_alias             , main_key: :email)
+  config.register_entity(:unsubscribe             , main_key: :email)
+  config.register_entity(:email_credential        , main_key: :credentials)
+  config.register_entity(:email_soft_bounce       , main_key: :email_address)
+  config.register_entity(:suppressed_address      , main_key: :email_address)
+  config.register_entity(:email_template_value    , main_key: :value)
+  config.register_entity(:email_validation        , main_key: :address)
+  config.register_entity(:enterprise_togglefield  , main_key: :field)
+  config.register_entity(:event_stat              , main_key: :event_type)
+  config.register_entity(:holiday_date            , main_key: :date)
+  config.register_entity(:job_stat                , main_key: :job_name)
+  config.register_entity(:original_user           , main_key: :target_user_id)
+  config.register_entity(:pending_attachment      , main_key: :file_name)
+  config.register_entity(:sales_base_tax          , main_key: :total)
+  config.register_entity(:shared_user             , main_key: :shared_id)
+  config.register_entity(:task_repeat             , main_key: :repeat_type)
+  config.register_entity(:user                    , main_key: :username)
+  config.register_entity(:token                   , main_key: :gmail_history_id)
+end

data/templates/simple/controller_interceptors.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_domain
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.27
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,6 +74,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".builders/boot.rb"
+- ".builders/generators/configuration_generator.rb"
+- ".builders/run.rb"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -95,32 +98,36 @@ files:
 - hooks/update-version
 - k_domain.gemspec
 - lib/k_domain.rb
+- lib/k_domain/config/_.rb
+- lib/k_domain/config/config.rb
+- lib/k_domain/config/configuration.rb
+- lib/k_domain/domain_model/build_rich_models.rb
 - lib/k_domain/domain_model/load.rb
 - lib/k_domain/domain_model/transform.rb
 - lib/k_domain/domain_model/transform_steps/_.rb
 - lib/k_domain/domain_model/transform_steps/step.rb
-- lib/k_domain/domain_model/transform_steps/step1_attach_db_schema.rb
-- lib/k_domain/domain_model/transform_steps/step2_attach_models.rb
-- lib/k_domain/domain_model/transform_steps/step3_attach_columns.rb
+- lib/k_domain/domain_model/transform_steps/step1_db_schema.rb
+- lib/k_domain/domain_model/transform_steps/step20_dictionary.rb
+- lib/k_domain/domain_model/transform_steps/step2_domain_models.rb
 - lib/k_domain/domain_model/transform_steps/step4_rails_resource_models.rb
-- lib/k_domain/domain_model/transform_steps/step5_rails_models.rb
-- lib/k_domain/domain_model/transform_steps/step6_attach_dictionary.rb
+- lib/k_domain/domain_model/transform_steps/step5_rails_resource_routes.rb
+- lib/k_domain/domain_model/transform_steps/step6_rails_structure_models.rb
+- lib/k_domain/domain_model/transform_steps/step7_rails_structure_controllers.rb
+- lib/k_domain/domain_model/transform_steps/step8_domain_columns.rb
+- lib/k_domain/queries/_.rb
+- lib/k_domain/queries/base_query.rb
+- lib/k_domain/queries/domain_model_query.rb
+- lib/k_domain/rails_code_extractor/_.rb
+- lib/k_domain/rails_code_extractor/extract_controller.rb
 - lib/k_domain/rails_code_extractor/extract_model.rb
 - lib/k_domain/rails_code_extractor/shim_loader.rb
 - lib/k_domain/raw_db_schema/load.rb
 - lib/k_domain/raw_db_schema/transform.rb
 - lib/k_domain/schemas/_.rb
-- lib/k_domain/schemas/database/_.rb
-- lib/k_domain/schemas/database/foreign_key.rb
-- lib/k_domain/schemas/database/index.rb
-- lib/k_domain/schemas/database/schema.rb
-- lib/k_domain/schemas/database/table.rb
+- lib/k_domain/schemas/database.rb
 - lib/k_domain/schemas/dictionary.rb
-- lib/k_domain/schemas/domain/_.rb
-- lib/k_domain/schemas/domain/domain.rb
+- lib/k_domain/schemas/domain.rb
 - lib/k_domain/schemas/domain/erd_file.rb
-- lib/k_domain/schemas/domain/models/column.rb
-- lib/k_domain/schemas/domain/models/model.rb
 - lib/k_domain/schemas/domain/old/belongs_to.rb
 - lib/k_domain/schemas/domain/old/column_old.rb
 - lib/k_domain/schemas/domain/old/domain_statistics.rb
@@ -137,14 +144,22 @@ files:
 - lib/k_domain/schemas/domain/old/statistics.rb
 - lib/k_domain/schemas/domain/old/validate.rb
 - lib/k_domain/schemas/domain/old/validates.rb
-- lib/k_domain/schemas/domain_model.rb
+- lib/k_domain/schemas/domain_types.rb
 - lib/k_domain/schemas/investigate.rb
+- lib/k_domain/schemas/main_dataset.rb
 - lib/k_domain/schemas/rails_resource.rb
 - lib/k_domain/schemas/rails_structure.rb
 - lib/k_domain/version.rb
-- templates/active_record_shims.rb
-- templates/fake_module_shims.rb
+- templates/custom/action_controller.rb
+- templates/custom/controller_interceptors.rb
+- templates/custom/model_interceptors.rb
 - templates/load_schema.rb
+- templates/rails/action_controller.rb
+- templates/rails/active_record.rb
+- templates/ruby_code_extractor/attach_class_info.rb
+- templates/ruby_code_extractor/behaviour_accessors.rb
+- templates/sample_config.rb
+- templates/simple/controller_interceptors.rb
 homepage: http://appydave.com/gems/k-domain
 licenses:
 - MIT
@@ -160,14 +175,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: K Domain builds complex domain schemas by combining the database schema with

data/lib/k_domain/domain_model/transform_steps/step2_attach_models.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-# Loop through the db_schema tables and build up a
-# basic model for each table
-class Step2AttachModels < KDomain::DomainModel::Step
-  # Map database schema to domain model
-  def call
-    raise 'ERD path not supplied' if opts[:erd_path].nil?
-
-    # Schema is re-shaped into a format designed for domain modeling
-    domain[:models] = database_tables.map { |table| model(table) }
-  end
-
-  def model(table)
-    table_name = table[:name].to_s
-    model_name = table_name.singularize
-
-    {
-      name: model_name,
-      name_plural: table_name, # need to check if this is correct as I know it is wrong for account_history_datum
-      table_name: table_name,
-      pk: primary_key(table),
-      erd_location: location(table_name, model_name),
-      statistics: {},                                   # Load in future step
-      columns: []                                       # Load in future step
-    }
-  end
-
-  def primary_key(table)
-    {
-      name: table[:primary_key],
-      type: table[:primary_key_type],
-      exist: !table[:primary_key].nil?
-    }
-  end
-
-  # Location of source code
-  def location(table_name, model_name)
-    file_normal = File.join(opts[:erd_path], "#{model_name}.rb")
-    file_custom = File.join(opts[:erd_path], "#{table_name}.rb")
-    file_exist  = true
-    state = []
-
-    if File.exist?(file_normal)
-      file = file_normal
-      state.push(:has_ruby_model)
-    elsif File.exist?(file_custom)
-      file = file_custom
-      state.push(:has_ruby_model)
-      state.push(:nonconventional_name)
-    else
-      file = ''
-      file_exist = false
-    end
-
-    {
-      file: file,
-      exist: file_exist,
-      state: state                      # display_state: state.join(' ')
-    }
-  end
-end