k_domain 0.0.14 → 0.0.23

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/rails/active_record.rb

@@ -0,0 +1,348 @@
+module ActiveRecord
+  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 ActiveRecord.class_info if ActiveRecord.class_info
+
+      ActiveRecord.class_info = {
+        class_name: name
+      }
+    end
+
+    # -------------------------
+    # Intercept methods
+    # -------------------------
+
+    def self.clear_active_connections!; end
+
+    # -------------------------
+    # Behaviour storage methods
+    # -------------------------
+
+    # examples:
+    # enum status: { active: 0, archived: 1 }
+    # enum status: [:active, :archived]
+    # enum status: [:active, :archived], _suffix: true
+    # enum comments_status: [:active, :inactive], _prefix: :comments
+    def self.enum(**opts)
+      add(:enum, opts)
+    end
+
+    # def self.attr_accessor(*args)
+    #   args.each do |arg|
+    #     self.class_eval("def #{arg};@#{arg};end")
+    #     self.class_eval("def #{arg}=(val);@#{arg}=val;end")
+    #   end
+    # end
+    # def self.attr_reader(*args)
+    #   args.each do |arg|
+    #     self.class_eval("def #{arg};@#{arg};end")
+    #   end
+    # end
+    # def self.attr_writer(*args)
+    #   args.each do |arg|
+    #     self.class_eval("def #{arg};@#{arg};end")
+    #     self.class_eval("def #{arg}=(val);@#{arg}=val;end")
+    #   end
+    # end
+  
+    def self.attr_accessor(*names)
+      super(*names)
+      add(:attr_accessor, names)
+    end
+
+    def self.attr_reader(*names)
+      super(*names)
+      add(:attr_reader, names)
+    end
+
+    def self.attr_writer(*names)
+      super(*names)
+      add(:attr_writer, names)
+    end
+
+    def self.lambda_source(a_lambda, prefix = nil)
+      return nil unless a_lambda
+
+      puts 'NOT A LAMBDA' unless a_lambda.is_a?(Proc)
+
+      result = a_lambda&.source&.strip
+      result = result&.delete_prefix(prefix) if prefix
+      result&.strip
+    end
+
+    # examples
+    # default_scope where(:published => true) # NOT supported
+    # default_scope { where(:published_at => Time.now - 1.week) }
+    # default_scope -> { order(:external_updated_at) }
+    # default_scope -> { where(:published => true) }, all_queries: true
+    def self.default_scope(**opts, &block)
+      block_source = nil
+      block_source = lambda_source(block, 'default_scope') if block_given?
+
+      set(:default_scope, opts.merge(block: block_source))
+    end
+
+    # examples
+    # scope :red, where(:color => 'red') # NOT SUPPORTED
+    # scope :dry_clean_only, joins(:washing_instructions).where('washing_instructions.dry_clean_only = ?', true) # NOT SUPPORTED
+    #
+    def self.scope(name, on_the_lamb = nil, **opts)
+      lamb_source = lambda_source(on_the_lamb, "scope :#{name},")
+
+      add(:scopes, {
+            name: name,
+            opts: opts,
+            block: lamb_source
+          })
+    end
+
+    def self.belongs_to(name, on_the_lamb = nil, **opts)
+      lamb_source = lambda_source(on_the_lamb, "belongs_to :#{name},")
+
+      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)
+      lamb_source = lambda_source(on_the_lamb, "has_many :#{name},")
+
+      add(:has_many, {
+            name: name,
+            opts: opts,
+            block: lamb_source
+          })
+    end
+
+    def self.has_one(name, on_the_lamb = nil, **opts)
+      lamb_source = lambda_source(on_the_lamb, "has_one :#{name},")
+
+      add(:has_one, {
+            name: name,
+            opts: opts,
+            block: lamb_source
+          })
+    end
+
+    def self.has_and_belongs_to_many(name, on_the_lamb = nil, **opts)
+      lamb_source = lambda_source(on_the_lamb, "has_and_belongs_to_many :#{name},")
+
+      add(:has_and_belongs_to_many, {
+            name: name,
+            opts: opts,
+            block: lamb_source
+          })
+    end
+
+    def self.validate(*names, **opts, &block)
+      block_source = nil
+      block_source = lambda_source(block, 'validate') if block_given?
+
+      add(:validate, {
+            names: names,
+            opts: opts,
+            block: block_source
+          })
+    end
+
+    def self.validates(name, **opts)
+      add(:validates, {
+            name: name,
+            opts: opts
+          })
+    end
+
+    def self.alias_attribute(left, right)
+      add(:alias_attribute, {
+            left: left,
+            right: right
+          })
+    end
+
+    def self.before_create(name)
+      add(:before_create, {
+            name: name
+          })
+    end
+
+    def self.before_save(name)
+      add(:before_save, {
+            name: name
+          })
+    end
+
+    def self.before_destroy(name)
+      add(:before_destroy, {
+            name: name
+          })
+    end
+
+    def self.before_validation(name = nil, &block)
+      block_source = nil
+      block_source = lambda_source(block, 'before_validation') if block_given?
+
+      add(:before_validation, {
+            name: name,
+            block: block_source
+          })
+    end
+
+    def self.after_create(name)
+      add(:after_create, {
+            name: name
+          })
+    end
+
+    def self.after_save(name)
+      add(:after_save, {
+            name: name
+          })
+    end
+
+    def self.after_destroy(name = nil, &block)
+      block_source = nil
+      block_source = lambda_source(block, 'after_destroy') if block_given?
+
+      add(:after_destroy, {
+            name: name,
+            block: block_source
+          })
+    end
+
+    def self.after_commit(name)
+      add(:after_commit, {
+            name: name
+          })
+    end
+
+    def self.accepts_nested_attributes_for(name, **opts)
+      add(:accepts_nested_attributes_for, {
+            name: name,
+            opts: opts
+          })
+    end
+
+    def self.has_secure_token(name)
+      add(:has_secure_token, {
+            name: name
+          })
+    end
+
+    # CAN THESE BE AUTOMATED LIKE INCLUDE MODULES
+    def self.establish_connection(connection)
+      class_info[:establish_connection] = connection
+    end
+
+    def self.store_accessor(*names)
+      class_info[:store_accessor] = *names
+    end
+
+    def self.table_name=(table_name)
+      class_info[:table_name] = table_name
+    end
+
+    def self.primary_key=(primary_key)
+      class_info[:primary_key] = primary_key
+    end
+
+    def self.require(require)
+      add(:require, require)
+    end
+
+    def self.devise(*names)
+      add(:devise, names)
+    end
+
+    def self.pg_search_scope(name, **opts)
+      custom_set(:pg_search_scope, {
+                   name: name,
+                   opts: opts
+                 })
+    end
+
+    def self.acts_as_readable(**opts)
+      custom_set(:acts_as_readable, {
+                   opts: opts
+                 })
+    end
+
+    def self.acts_as_reader
+      custom_set(:acts_as_reader, {})
+    end
+
+    def self.acts_as_commentable
+      custom_set(:acts_as_commentable, {})
+    end
+
+    def self.acts_as_list(**opts)
+      custom_set(:acts_as_list, {
+                   opts: opts
+                 })
+    end
+
+    def self.has_paper_trail
+      custom_set(:has_paper_trail)
+    end
+
+    def self.validates_uniqueness_of(name, **opts)
+      custom_set(:validates_uniqueness_of, {
+                   name: name,
+                   opts: opts
+                 })
+    end
+
+    def self.validates_presence_of(name, **opts)
+      custom_set(:validates_presence_of, {
+                   name: name,
+                   opts: opts
+                 })
+    end
+
+    def self.validates_length_of(name, **opts)
+      custom_set(:validates_length_of, {
+                   name: name,
+                   opts: opts
+                 })
+    end
+
+    def self.attr_encrypted(name, **opts)
+      custom_set(:attr_encrypted, {
+                   name: name,
+                   opts: opts
+                 })
+    end
+
+    def self.validates_confirmation_of(name, **opts)
+      custom_set(:validates_confirmation_of, {
+                   name: name,
+                   opts: opts
+                 })
+    end
+
+    def self.with_options(opts, &block)
+      block_source = nil
+      block_source = lambda_source(block) if block_given?
+
+      custom_add(:with_options, {
+                   opts: opts,
+                   block: block_source
+                 })
+    end
+  end
+end

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