k_domain 0.0.20 → 0.0.23

data/templates/old_printspeek_schema.rb

@@ -0,0 +1,233 @@
+class LoadSchema
+  attr_reader :schema
+
+  # XMEN
+  def initialize
+    @unique_keys = {}
+    @current_table = nil
+    @rails_version = 4
+    @schema = {
+      tables: [],
+      foreign_keys: [],
+      indexes: [],
+      views: [],
+      meta: {
+        rails: @rails_version,
+        db_info: {
+          type: 'postgres',
+          version: nil,         # TODO
+          extensions: []
+        },
+        unique_keys: []
+      }
+    }
+  end
+
+  # ----------------------------------------------------------------------
+  # Inject start
+  # original file: {{source_file}}
+  # ----------------------------------------------------------------------
+  def load_schema
+{{rails_schema}}
+  end
+
+  # ----------------------------------------------------------------------
+  # original file: {{source_file}}
+  # Inject end
+  # ----------------------------------------------------------------------
+
+  def write_json(file)
+    schema[:meta][:rails] = @rails_version
+    File.write(file, JSON.pretty_generate(schema))
+  end
+
+  # This is the rails timestamp and will be replaced by the action rails version
+  def load(version:)
+    start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    # puts 'about to load'
+    yield if block_given?
+
+    schema[:meta][:rails] = @rails_version
+
+    sort
+    # code to time
+
+    # log.kv 'extensions', schema[:db_info][:extensions].length
+    # log.kv 'tables', schema[:tables].length
+    # log.kv 'indexes', schema[:indexes].length  
+    # # a low foreign_keys count is indicative of not using SQL referential integrity
+    # log.kv 'foreign_keys', schema[:foreign_keys].length
+    # log.kv 'Time Taken', (finish - start)
+
+    # puts schema[:db_info][:extensions]
+    # print_unique_keys(type: :foreign_keys, title: 'unique options for foreign_keys')
+    # print_unique_keys(type: :columns, title: 'unique options for columns')
+    # print_unique_keys(type: :fields, category: :integer , title: 'unique options for column - integer')
+    # print_unique_keys(type: :fields, category: :decimal , title: 'unique options for column - decimal')
+    # print_unique_keys(type: :fields, category: :string  , title: 'unique options for column - string')
+    # print_unique_keys(type: :fields, category: :datetime, title: 'unique options for column - datetime')
+    # print_unique_keys(type: :fields, category: :date    , title: 'unique options for column - date')
+    # print_unique_keys(type: :fields, category: :text    , title: 'unique options for column - text')
+    # print_unique_keys(type: :fields, category: :boolean , title: 'unique options for column - boolean')
+    # print_unique_keys(type: :fields, category: :jsonb   , title: 'unique options for column - jsonb')
+    # print_unique_keys(type: :fields, category: :hstore  , title: 'unique options for column - hstore')
+    # print_unique_keys(type: :fields, category: :float   , title: 'unique options for column - float')
+  end
+
+  def enable_extension(name)
+    # puts "enable_extension(#{name})"
+    schema[:meta][:db_info][:extensions] << name
+  end
+
+  def create_table(name, **opts)
+    id = opts[:id]
+    primary_key = opts[:primary_key] || (id == false ? nil : "id")
+    primary_key_type = if id == false
+                         nil
+                       elsif id.nil?
+                         "bigint"
+                       else
+                         id
+                       end
+
+    @current_table = {
+      name: name,
+      primary_key: primary_key,                           # infer the actual value that should be in the database
+      primary_key_type: primary_key_type,                 # infer the actual value that should be in the database
+      columns: [],
+      indexes: [],
+      rails_schema: {                                     # as reported by the rails schema
+        primary_key: opts[:primary_key],
+        id: id,
+        force: opts[:force]
+      }
+    }
+    # schema[:tables][name] = @current_table
+    schema[:tables] << @current_table
+    
+    yield(self) if block_given?
+  end
+
+  def add_field(name, type, **opts)
+    # puts "add_field(#{name}, #{type})"
+    row = { name: name, type: type, **opts }
+    @current_table[:columns] << row
+
+    add_unique_keys(row.keys, type: :columns)
+    add_unique_keys(row.keys, type: :fields, category: type)
+  end
+
+  def add_index(name, fields, **opts)
+    # puts "add_index(#{name})"
+    row = { name: name, fields: fields, **opts }
+    @current_table[:indexes] << row
+    schema[:indexes] << row
+    add_unique_keys(row.keys, type: :indexes)
+  end
+
+  # This method was introduced onto the schema in rails 5
+  def index(fields, **opts)
+    @rails_version = 5
+    name = opts[:name]
+    opts.delete(:name)
+    add_index(name, fields, **opts)
+  end
+
+  def create_view(name, **opts)
+    row = { name: name, **opts }
+    schema[:views] << row
+    add_unique_keys(row.keys, type: :views)
+  end
+
+  def add_foreign_key(left_table, right_table, **opts)
+    # puts "add_foreign_key(#{left_table}, #{right_table})"
+    row = { left: left_table, right: right_table, **opts }
+    schema[:foreign_keys] << row
+    add_unique_keys(row.keys, type: :foreign_keys)
+  end
+
+  def add_unique_keys(keys, type:, category: nil)
+    key = [type, category, keys.join('-')].compact.join('|')
+    return if @unique_keys.key?(key)
+
+    @unique_keys[key] = key
+    schema[:meta][:unique_keys] << { type: type, category: category, key: keys.join(','), keys: keys }
+  end
+
+  def print_unique_keys(type:, category: nil, title: )
+    log.section_heading(title)
+
+    filter_key_infos = schema[:meta][:unique_keys].select { |key_info| key_info[:type] == type && (category.nil? || key_info[:category] == category) }
+
+    # log.kv 'all', filter_key_infos.flat_map { |key_info| key_info[:keys] }.uniq, 50
+
+    filter_key_infos.each do |key_info|
+      log.kv key_info[:key], key_info[:keys], 50
+    end
+  end
+
+  def integer(name, **opts)
+    add_field(name, :integer, **opts)
+  end
+
+  def bigint(name, **opts)
+    add_field(name, :bigint, **opts)
+  end
+
+  def decimal(name, **opts)
+    add_field(name, :decimal, **opts)
+  end
+
+  def string(name, **opts)
+    add_field(name, :string, **opts)
+  end
+
+  def datetime(name, **opts)
+    add_field(name, :datetime, **opts)
+  end
+
+  def date(name, **opts)
+    add_field(name, :date, **opts)
+  end
+
+  def text(name, **opts)
+    add_field(name, :text, **opts)
+  end
+
+  def boolean(name, **opts)
+    add_field(name, :boolean, **opts)
+  end
+
+  def jsonb(name, **opts)
+    add_field(name, :jsonb, **opts)
+  end
+
+  def hstore(name, **opts)
+    add_field(name, :hstore, **opts)
+  end
+
+  def float(name, **opts)
+    add_field(name, :float, **opts)
+  end
+
+  def sort
+    schema[:indexes].sort_by! { |i| i[:name] }
+    schema[:tables].each { |table| table[:indexes].sort_by! { |i| i[:name] } }
+
+    # Insert a key that represents all unique keys, and then sort
+    unique_keys_per_group = schema[:meta][:unique_keys]
+      .group_by { |key_info| [key_info[:type], key_info[:category]] }
+      .map do |group, values|
+        all_keys = values.flat_map { |key_info| key_info[:keys] }.uniq
+        { 
+          type: group[0],
+          category: group[01],
+          key: 'all',
+          keys: all_keys
+        }
+      end
+
+    schema[:meta][:unique_keys].concat(unique_keys_per_group)
+    schema[:meta][:unique_keys].sort! { |a,b| ([a[:type], a[:category],a[:key]] <=> [b[:type], b[:category],b[:key]]) }
+  end
+end

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,9 @@
 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.singleton_class
       Class.new do
         def send(*_p, **_o); end
@@ -15,42 +11,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
-
-    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
+    # -------------------------
+    # Intercept methods
+    # -------------------------
 
-    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.clear_active_connections!; 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 +109,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/simple/controller_interceptors.rb

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