k_domain 0.0.26 → 0.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86f877b2fd5644c7ebd211c662cb4cd1ff63213dcc3cc588d3485f698a2bc7b9
-  data.tar.gz: 9999ee5fa153fa7c1833cd21a0a5a145cbee4a97cd11284c1bb4440157ae6d0a
+  metadata.gz: 56185cb3b21dcdc594e86e2f90a5700705e308210cf531371d717798ee7762c4
+  data.tar.gz: ec39dc47a6b40b875134431205d7d8da54e83aa7a1818c352dcde485e5f31682
 SHA512:
-  metadata.gz: 013e1f7524e395b9766831786cd1f4052eb6000fd35105c58bfb51869f9d1b93151f3fbc3e8fe349f59dd6819daf7d27e22a05ae5f95fba6826bf61af06eb235
-  data.tar.gz: c56d291ba618e70863e334bca9c1e817da700d6d0769e92ac5fb7d267b1f02068f6d4275e423264147066389d45dca831d3b3878eef45662d0f4ef8457d99e20
+  metadata.gz: 639891b42099979c7955fa0586bc8e408900c97a3b0f4197704dd0f4e05765679b80ba83926c9b3c4307e8154f830ef90a4793097901007b11710f93010e1c04
+  data.tar.gz: 37c2f1076fddfd3c01da39dada2c579f62cda2af50aa1ba0105184c93c9f1442e4ec66d86e154b02d997310ec09d182991e9a054e5e340759bb11eead4d296bb

data/.github/workflows/main.yml

@@ -25,7 +25,9 @@ jobs:
       run: |
         gem install bundler -v 2.2.5
         bundle install
-    - name: Run tests
-      run: bundle exec rspec
     - name: Run rubocop
-      run: bundle exec rubocop
+      run: |
+        bundle exec rubocop -v
+        bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rspec --tag ~skip_on_gha

data/.gitignore

@@ -31,6 +31,7 @@ k_domain.yml
 *.o
 *.a
 mkmf.log
+.vscode
 
 # Ruby Version
 .ruby-version

data/.rubocop.yml

@@ -1,6 +1,6 @@
 # require: rubocop-rake
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   DisplayCopNames: true
   ExtraDetails: true
   NewCops: enable
@@ -10,6 +10,7 @@ AllCops:
     - "templates/**/*"
     - "lib/k_domain/schemas/domain/old/**/*"
     - "spec/k_domain/ruby_loader/**/*"
+    - "hooks/**/*"
 
 Metrics/PerceivedComplexity:
   Exclude:
@@ -68,8 +69,6 @@ Metrics/MethodLength:
 
 Layout/LineLength:
   Max: 200
-  # Ignores annotate output
-  IgnoredPatterns: ['\A# \*\*']
   IgnoreCopDirectives: true
   Exclude:
     - "lib/k_domain/domain_model/transform_steps/*.rb"
@@ -116,6 +115,12 @@ Style/FormatStringToken:
 Style/Documentation:
   Enabled: false
 
+Style/OpenStructUse:
+  Enabled: false
+
 Layout/SpaceBeforeComma:
   Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
 # My Preferences - End

data/Gemfile

@@ -25,7 +25,7 @@ group :development, :test do
 end
 
 # If local dependency
-if ENV['KLUE_LOCAL_GEMS']&.to_s&.downcase == 'true'
+if ENV.fetch('KLUE_LOCAL_GEMS', 'false').downcase == 'true'
   group :development, :test do
     puts 'Using Local GEMs'
     gem 'k_log'                   , path: '../k_log'

data/k_domain.gemspec

@@ -3,7 +3,7 @@
 require_relative 'lib/k_domain/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version  = '>= 2.5'
+  spec.required_ruby_version  = '>= 2.7'
   spec.name                   = 'k_domain'
   spec.version                = KDomain::VERSION
   spec.authors                = ['David Cruwys']

data/lib/k_domain/domain_model/build_rich_models.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Loads the db schema object and works through a series of enrichment steps to
+# that builds the domain modal
+
+module KDomain
+  module DomainModel
+    class BuildRichModels
+      include KLog::Logging
+
+      attr_reader :db_schema
+      attr_reader :target_step_file
+      attr_reader :query
+
+      def initialize(domain_model: , target_folder:)
+        @domain_model   = domain_model
+        @target_folder  = target_folder
+        @query          = KDomain::Queries::DomainModelQuery.new(domain_model)
+      end
+
+      def call
+        FileUtils.mkdir_p(target_folder)
+
+        export_domain_models(query.all.take(3))
+      end
+
+      def export_domain_models(models)
+        models.each do |model|
+          json = JSON.pretty_generate(build_rich_model(model))
+          target_file = File.join(target_folder, model.name + '.json')
+          File.write(target_file, json)
+        end
+      end
+    
+      def build_rich_model(model)
+        {
+          name: model.name,
+          name_plural: model.name_plural,
+          table_name: model.table_name,
+          type: model.type,
+          pk: model.pk.to_h,
+          file: model.file,
+          exist: model.ruby?,
+          main_key: model.main_key,
+          traits: model.traits,
+          columns: {
+            all: model.columns.map(&:to_h),
+            data: model.columns_data.map(&:to_h),
+            primary: model.columns_primary.map(&:to_h),
+            foreign_key: model.columns_foreign_key.map(&:to_h),
+            foreign_type: model.columns_foreign_type.map(&:to_h),
+            timestamp: model.columns_timestamp.map(&:to_h),
+            deleted_at: model.columns_deleted_at.map(&:to_h),
+            virtual: model.columns_virtual.map(&:to_h),
+            data_foreign: model.columns_data_foreign.map(&:to_h),
+            data_primary: model.columns_data_primary.map(&:to_h),
+            data_virtual: model.columns_data_virtual.map(&:to_h),
+            data_foreign_virtual: model.columns_data_foreign_virtual.map(&:to_h)
+          }
+        }
+      end
+    end
+  end
+end

data/lib/k_domain/domain_model/load.rb

@@ -22,8 +22,10 @@ module KDomain
         json = File.read(source_file)
         @raw_data = KUtil.data.json_parse(json, as: :hash_symbolized)
 
-        @data = KDomain::Schemas::DomainModel.new(@raw_data)
+        # This line is slow on big datasets
+        @data = KDomain::Schemas::MainDataset.new(@raw_data)
 
+        # This line is also slow on big datasets
         enrichment
       end
 

data/lib/k_domain/domain_model/transform.rb

@@ -14,17 +14,19 @@ module KDomain
       attr_reader :model_path
       attr_reader :controller_path
       attr_reader :route_path
-      attr_reader :shim_loader
+      attr_reader :model_shim_loader
+      attr_reader :controller_shim_loader
 
       # rubocop:disable Metrics/ParameterLists
-      def initialize(db_schema: , target_file: , target_step_file: , model_path:, route_path:, controller_path:, shim_loader: nil)
-        @db_schema        = db_schema
-        @target_step_file = target_step_file
-        @target_file      = target_file
-        @model_path       = model_path
-        @controller_path  = controller_path
-        @route_path       = route_path
-        @shim_loader      = shim_loader
+      def initialize(db_schema: , target_file: , target_step_file: , model_path:, route_path:, controller_path:, model_shim_loader: nil, controller_shim_loader: nil)
+        @db_schema              = db_schema
+        @target_step_file       = target_step_file
+        @target_file            = target_file
+        @model_path             = model_path
+        @controller_path        = controller_path
+        @route_path             = route_path
+        @model_shim_loader      = model_shim_loader
+        @controller_shim_loader = controller_shim_loader
       end
       # rubocop:enable Metrics/ParameterLists
 
@@ -35,8 +37,8 @@ module KDomain
         valid &&= Step2DomainModels.run(domain_data, model_path: model_path, step_file: step_file('02-domain-model'))
         valid &&= Step4RailsResourceModels.run(domain_data, model_path: model_path, step_file: step_file('04-rails-resource-models'))
         valid &&= Step5RailsResourceRoutes.run(domain_data, route_path: route_path, controller_path: controller_path, step_file: step_file('05-rails-resource-routes'))
-        valid &&= Step6RailsStructureModels.run(domain_data, model_path: model_path, step_file: step_file('06-rails-structure-models'), shim_loader: shim_loader)
-        valid &&= Step7RailsStructureControllers.run(domain_data, controller_path: controller_path, step_file: step_file('07-rails-structure-controllers'), shim_loader: shim_loader)
+        valid &&= Step6RailsStructureModels.run(domain_data, model_path: model_path, step_file: step_file('06-rails-structure-models'), shim_loader: model_shim_loader)
+        valid &&= Step7RailsStructureControllers.run(domain_data, controller_path: controller_path, step_file: step_file('07-rails-structure-controllers'), shim_loader: controller_shim_loader)
         valid &&= Step8DomainColumns.run(domain_data, step_file: step_file('08-domain-columns'))
         valid &&= Step20Dictionary.run(domain_data, step_file: step_file('20-dictionary'))
 

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

@@ -37,6 +37,7 @@ class Step6RailsStructureModels < KDomain::DomainModel::Step
 
   def attach_behavior_and_functions
     rails_structure_models.select { |model| model[:exist] }.each do |model|
+      # puts "model: #{model[:model_name]}"
       model[:behaviours] = extract_behavior(model[:file])
       klass_name = model[:behaviours][:class_name]
       model[:functions] = extract_functions(klass_name)

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

@@ -58,7 +58,10 @@ class Step7RailsStructureControllers < KDomain::DomainModel::Step
   end
 
   def attach_behavior_and_functions
+    rails_structure_controllers.sort_by! { |controller| controller[:full_file] }
+
     rails_structure_controllers.select { |controller| controller[:exist] }.each do |controller|
+      # puts "controller: #{controller[:full_file]}"
       unless File.exist?(controller[:full_file])
         log.error 'Controller apparently exists but no file found, this means that you need re-run rake routes'
         puts controller[:full_file]

data/lib/k_domain/queries/_.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative './base_query'
+require_relative './domain_model_query'

data/lib/k_domain/queries/base_query.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module KDomain
+  module Queries
+    class BaseQuery
+      attr_reader :domain_model
+
+      def initialize(domain_model)
+        @domain_model = domain_model
+      end
+    end
+  end
+end

data/lib/k_domain/queries/domain_model_query.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module KDomain
+  module Queries
+    # Query models found on the domain model
+    # by
+    #   has ruby file
+    #   has primary key
+    #   column count
+    #   data column count
+    #   foreign key column count
+    #   has timestamp (created_at, updated_at) columns
+    #   has created_at
+    #   has updated_at
+    #   has deleted_at
+    #   has polymorphic foreign keys
+    #   has virtual columns
+    #   virtual column filters (token, encrypted_password, etc)
+    class DomainModelQuery < BaseQuery
+      def all
+        domain_model.domain.models
+      end
+
+      def query(**filters)
+        @query = all.clone
+
+        filters.each do |key, value|
+          send("filter_#{key}", value)
+        end
+
+        @query
+      end
+
+      private
+
+      def filter_ruby(value)
+        @query.select! { |model| model.ruby? == value }
+      end
+
+      def filter_pk(value)
+        @query.select! { |model| model.pk.exist? == value }
+      end
+
+      def filter_column_count(block)
+        @query.select! { |model| block.call(model.columns.count) }
+      end
+
+      def filter_data_column_count(block)
+        @query.select! { |model| block.call(model.columns_data.count) }
+      end
+
+      def filter_foreign_key_column_count(block)
+        @query.select! { |model| block.call(model.columns_foreign_key.count) }
+      end
+      alias filter_fk_column_count filter_foreign_key_column_count
+      alias filter_fk_count filter_foreign_key_column_count
+
+      def filter_polymorphic_foreign_key_column_count(block)
+        @query.select! { |model| block.call(model.columns_foreign_type.count) }
+      end
+      alias filter_poly_fk_column_count filter_polymorphic_foreign_key_column_count
+      alias filter_poly_fk_count filter_polymorphic_foreign_key_column_count
+
+      def filter_timestamp(value)
+        @query.select! { |model| (model.columns_timestamp.count == 2) == value }
+      end
+
+      def filter_created_at(value)
+        @query.select! { |model| (model.columns.any? { |column| column.name == 'created_at' } == value) }
+      end
+
+      def filter_updated_at(value)
+        @query.select! { |model| (model.columns.any? { |column| column.name == 'updated_at' } == value) }
+      end
+
+      def filter_deleted_at(value)
+        @query.select! { |model| (model.columns.any? { |column| column.name == 'deleted_at' } == value) }
+      end
+      #   has virtual columns
+      #   virtual column filters (token, encrypted_password, etc)
+
+      # # HELP: this filter affects table rows, eg. if a table has less the 2 columns then include the table
+      # low_column:           -> (model) { model.columns.length < 5 },
+      # suspected_m2m:       -> (model) { model.columns_foreign.length == 2 && model.columns_data.length < 3 },
+      # invalid_types:        -> (model) { model.columns.any? { |c| [c.db_type, c.csharp_type, c.ruby_type].include?('******') } },
+    end
+  end
+end

data/lib/k_domain/rails_code_extractor/shim_loader.rb

@@ -18,8 +18,10 @@ module KDomain
       end
 
       def call
-        # puts shim_files.map { |sf| sf[:file] }
-        shim_files.select { |sf| sf[:exist] }.each { |sf| require sf[:file] }
+        shim_files.select { |sf| sf[:exist] }.each do |sf|
+          require sf[:file]
+        end
+        nil
       end
 
       def register(name, file)

data/lib/k_domain/schemas/_.rb

@@ -13,6 +13,6 @@ require_relative 'database'
 require_relative 'dictionary'
 require_relative 'domain_types'
 require_relative 'domain'
-require_relative 'domain_model'
+require_relative 'main_dataset'
 
 # require_relative './domain_model'

data/lib/k_domain/schemas/domain.rb

@@ -53,6 +53,10 @@ module KDomain
           attribute :name               , Types::Strict::String.optional.default(nil)
           attribute :type               , Types::Strict::String.optional.default(nil)
           attribute :exist              , Types::Strict::Bool
+
+          def exist?
+            exist
+          end
         end
 
         attribute :name                 , Types::Strict::String
@@ -97,7 +101,7 @@ module KDomain
           @columns_primary ||= columns_for_structure_types(:primary_key)
         end
 
-        def columns_foreign
+        def columns_foreign_key
           @columns_foreign ||= columns_for_structure_types(:foreign_key)
         end
 

data/lib/k_domain/schemas/{domain_model.rb → main_dataset.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-# DomainModel holds the entire domain model including database and ancillary information
+# MainDataset holds the entire domain model including database and ancillary information
 module KDomain
   module Schemas
-    class DomainModel < Dry::Struct
+    class MainDataset < Dry::Struct
       attribute :domain           , KDomain::Schemas::Domain
       attribute :database         , KDomain::Schemas::Database
       attribute :dictionary       , KDomain::Schemas::Dictionary

data/lib/k_domain/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KDomain
-  VERSION = '0.0.26'
+  VERSION = '0.0.27'
 end

data/lib/k_domain.rb

@@ -12,7 +12,9 @@ require 'k_domain/raw_db_schema/load'
 require 'k_domain/domain_model/transform'
 require 'k_domain/domain_model/transform_steps/_'
 require 'k_domain/domain_model/load'
+require 'k_domain/domain_model/build_rich_models'
 require 'k_domain/rails_code_extractor/_'
+require 'k_domain/queries/_'
 
 # # This is useful if you want to initialize structures via Hash
 # class SymbolizeStruct < Dry::Struct
@@ -38,7 +40,7 @@ module KDomain
   # Your code goes here...
 end
 
-if ENV['KLUE_DEBUG']&.to_s&.downcase == 'true'
+if ENV.fetch('KLUE_DEBUG', 'false').downcase == 'true'
   namespace = 'KDomain::Version'
   file_path = $LOADED_FEATURES.find { |f| f.include?('k_domain/version') }
   version = KDomain::VERSION.ljust(9)

data/templates/custom/action_controller.rb

@@ -3,34 +3,5 @@ module ActionController
     def self.require(require)
       add(:require, require)
     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
-    # def self.helper_method(*names)
-    #   add(:helper_method, {
-    #         names: names
-    #       })
-    # end
-    # def self.helper(name)
-    #   add(:helper, {
-    #         name: name
-    #       })
-    # end
-    # def self.http_basic_authenticate_with(**opts)
-    #   add(:http_basic_authenticate_with, {
-    #         opts: opts
-    #       })
-    # end
-    # def self.protect_from_forgery(**opts)
-    #   add(:protect_from_forgery, {
-    #         opts: opts
-    #       })
-    # end
   end
 end

data/templates/custom/controller_interceptors.rb

@@ -10,18 +10,14 @@ class Rails
     )
   end
 end
-class RegionConfig
-  def self.require_value(*_p, **_o, &block); end
-end
-
 class ApplicationController < ActionController::Base
+  def self.require(*_p, **_o); end
 end
 
 module Admin
   class BaseController < ActionController::Base
   end
 end
-
 module Api
   module V1
     class BaseController < ActionController::Base
@@ -38,12 +34,18 @@ module Portal
   class BaseController < ApplicationController
   end
 end
-
 module ActiveRecord
   class RecordNotFound
   end
 end
-
+class RegionConfig < ActiveRecord::Base
+  def self.require_value(*_p, **_o, &block)
+    return 'ABC'
+  end
+  def self.get_value
+    return 'ABC'
+  end
+end
 module Aws
   class Credentials
     def initialize(*_p, **_o, &block); end

data/templates/custom/model_interceptors.rb

@@ -41,17 +41,41 @@ module ApiLoggable; end
 module Excludable; end
 module Bookmarkable; end
 module Categorizable; end
-module PgSearch; end
+module PgSearch
+  module Model
+  end
+end
 module Excludable; end
-module JsonbStore; end
+module JsonbStore
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
 
+  module ClassMethods
+    def jsonb_store(*_p, **_o); end
+  end
+end
 module ActionView
   module Helpers
     module NumberHelper
     end
   end
 end
-
+module PrintSpeak
+  class Application
+    def self.google_oath_secret_key
+      'ABC'
+    end
+  end
+end
+class RegionConfig < ActiveRecord::Base
+  def self.require_value(*_p, **_o, &block)
+    'ABC'
+  end
+  def self.get_value
+    return 'ABC'
+  end
+end
 module RailsUpgrade
   def rails4?
     true

data/templates/rails/active_record.rb

@@ -4,6 +4,8 @@ module ActiveRecord
   class Base
     extend RubyCodeExtractor::BehaviourAccessors
 
+    def self.require(*_p, **_o); end
+
     def self.singleton_class
       Class.new do
         def send(*_p, **_o); end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_domain
 version: !ruby/object:Gem::Version
-  version: 0.0.26
+  version: 0.0.27
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,6 +101,7 @@ files:
 - 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
@@ -113,6 +114,9 @@ files:
 - 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
@@ -140,9 +144,9 @@ 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
@@ -171,7 +175,7 @@ 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:
   - - ">="