k_domain 0.0.16 → 0.0.26

data/lib/k_domain/raw_db_schema/transform.rb

@@ -7,16 +7,29 @@
 # builds the hash
 module KDomain
   module RawDbSchema
+    # class TransformFilter
+    #   attr_accessor :take
+    #   def initialize(take: :all)
+    #     @take = take
+    #   end
+    # end
+
     class Transform
       include KLog::Logging
 
       attr_reader :source_file
-      attr_reader :template_file
+      attr_accessor :template_file
       attr_reader :schema_loader
+      attr_reader :filter
 
-      def initialize(source_file)
+      # @param [String] source_file Rails Schema file
+      # @param [OpenStruct] filter Settings for filtering data before transformation, this is useful during debugging
+      # examples
+      #   filter = os(run: 1, tables: os(offset: 10, limit: 10))
+      def initialize(source_file, filter)
         @source_file = source_file
         @template_file = KDomain::Gem.resource('templates/load_schema.rb')
+        @filter = filter
       end
 
       def call
@@ -24,6 +37,7 @@ module KDomain
         # log.kv 'template_file', template_file
         # log.kv 'source_file?', File.exist?(source_file)
         # log.kv 'template_file?', File.exist?(template_file)
+
         log.error "Template not found: #{template_file}" unless File.exist?(template_file)
 
         content = File.read(source_file)
@@ -72,11 +86,22 @@ module KDomain
 
         loader = LoadSchema.new
         loader.load_schema
-        loader.schema
+
+        apply_filter(loader.schema)
       rescue StandardError => e
         log.exception(e)
       end
       # rubocop:enable Security/Eval
+
+      # rubocop:disable Metrics/AbcSize
+      def apply_filter(schema)
+        return schema unless filter.active == 1
+
+        schema[:tables] = schema[:tables].slice(filter.table.offset, filter.table.limit) || [] if filter.table.offset.is_a?(Integer) && filter.table.limit.is_a?(Integer)
+
+        schema
+      end
+      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/k_domain/schemas/_.rb

@@ -7,9 +7,12 @@ module Types
 end
 
 require_relative 'rails_resource'
+require_relative 'rails_structure'
 require_relative 'investigate'
-require_relative 'database/_'
+require_relative 'database'
 require_relative 'dictionary'
-require_relative 'domain/_'
+require_relative 'domain_types'
+require_relative 'domain'
+require_relative 'domain_model'
 
-require_relative './domain_model'
+# require_relative './domain_model'

data/lib/k_domain/schemas/database.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# KDomain::Schemas::Domain::Column
+# KDomain::Schemas::Domain::Model
+
+module KDomain
+  module Schemas
+    class Database < Dry::Struct
+      class ForeignKey < Dry::Struct
+        attribute :left                 , Types::Strict::String
+        attribute :right                , Types::Strict::String
+        attribute :name?                , Types::Strict::String.optional.default(nil)
+        attribute :on_update?           , Types::Strict::String.optional.default(nil)
+        attribute :on_delete?           , Types::Strict::String.optional.default(nil)
+        attribute :column?              , Types::Strict::String.optional.default(nil)
+      end
+
+      class Index < Dry::Struct
+        attribute :name                 , Types::Strict::String
+        attribute :fields               , Types::Nominal::Any.optional.default('xxxxx1')
+        attribute :using                , Types::Nominal::String
+        attribute :order?               , Types::Nominal::Hash
+        attribute :where?               , Types::Nominal::Any.optional.default(nil)
+        attribute :unique?              , Types::Nominal::Any.optional.default(nil)
+      end
+
+      class View < Dry::Struct
+        attribute :name                 , Types::Strict::String
+        attribute :materialized         , Types::Strict::Bool
+        attribute :sql_definition       , Types::Nominal::String
+      end
+
+      class Table < Dry::Struct
+        class RailsSchema < Dry::Struct
+          attribute :primary_key          , Types::Nominal::Any.optional.default(nil)
+          attribute :id                   , Types::Nominal::Any.optional.default(nil)
+          attribute :force                , Types::Nominal::Any.optional.default(nil)
+        end
+
+        class Column < Dry::Struct
+          attribute :name                 , Types::Strict::String
+          attribute :type                 , Types::Strict::String
+          attribute :precision?           , Types::Strict::Integer.optional.default(nil)
+          attribute :scale?               , Types::Strict::Integer.optional.default(nil)
+          attribute :default?             , Types::Nominal::Any.optional.default(nil)
+          attribute :array?               , Types::Strict::Bool.optional.default(nil)
+          attribute :null?                , Types::Strict::Bool.optional.default(nil)
+          attribute :limit?               , Types::Strict::Integer.optional.default(nil)
+        end
+
+        attribute :name                   , Types::Strict::String
+        attribute :primary_key            , Types::Strict::String.optional.default(nil)
+        attribute :primary_key_type       , Types::Strict::String.optional.default(nil)
+        attribute :id?                    , Types::Nominal::Any.optional.default(nil)
+        attribute :columns                , Types::Strict::Array.of(KDomain::Schemas::Database::Table::Column)
+        attribute :indexes                , Types::Strict::Array.of(KDomain::Schemas::Database::Index)
+        attribute :rails_schema           , KDomain::Schemas::Database::Table::RailsSchema
+      end
+
+      class DbInfo < Dry::Struct
+        attribute :type                 , Types::Strict::String
+        attribute :version              , Types::Nominal::Any.optional.default(nil)
+        attribute :extensions           , Types::Strict::Array
+      end
+
+      class UniqueKey < Dry::Struct
+        attribute :type                 , Types::Strict::String
+        attribute :category             , Types::Strict::String.optional
+        attribute :key                  , Types::Strict::String
+        attribute :keys                 , Types::Strict::Array
+      end
+
+      class Meta < Dry::Struct
+        attribute :rails                , Types::Strict::Integer
+        attribute :db_info              , KDomain::Schemas::Database::DbInfo
+        attribute :unique_keys          , Types::Strict::Array.of(KDomain::Schemas::Database::UniqueKey)
+      end
+
+      attribute :tables               , Types::Strict::Array.of(KDomain::Schemas::Database::Table)
+      attribute :foreign_keys?        , Types::Strict::Array.of(KDomain::Schemas::Database::ForeignKey)
+      attribute :indexes?             , Types::Strict::Array.of(KDomain::Schemas::Database::Index)
+      attribute :views?               , Types::Strict::Array.of(KDomain::Schemas::Database::View)
+      attribute :meta                 , KDomain::Schemas::Database::Meta
+    end
+  end
+end

data/lib/k_domain/schemas/domain/erd_file.rb

@@ -1,82 +1,83 @@
 # frozen_string_literal: true
+# # frozen_string_literal: true
 
-# Domain class holds a list of the entities
-module KDomain
-  module DomainModel
-    # rubocop:disable Metrics/BlockLength
-    class ErdFile < Dry::Struct
-      attribute :name                         , Types::Strict::String
-      attribute :name_plural                  , Types::Strict::String
-      attribute :dsl_file                     , Types::Strict::String
+# # Domain class holds a list of the entities
+# module KDomain
+#   module DomainModel
+#
+#     class ErdFile < Dry::Struct
+#       attribute :name                         , Types::Strict::String
+#       attribute :name_plural                  , Types::Strict::String
+#       attribute :dsl_file                     , Types::Strict::String
 
-      attribute? :source                      , Dry::Struct.optional.default(nil) do
-        attribute :ruby                       , Types::Strict::String
-        attribute :public                     , Types::Strict::String.optional.default(nil)
-        attribute :private                    , Types::Strict::String.optional.default(nil)
+#       attribute? :source                      , Dry::Struct.optional.default(nil) do
+#         attribute :ruby                       , Types::Strict::String
+#         attribute :public                     , Types::Strict::String.optional.default(nil)
+#         attribute :private                    , Types::Strict::String.optional.default(nil)
 
-        attribute? :all_methods               , Dry::Struct.optional.default(nil) do
-          attribute? :klass                   , Types::Strict::Array do
-            attribute :name                   , Types::Strict::String
-            attribute :scope                  , Types::Strict::String # .optional.default(nil)
-            attribute :class_method           , Types::Strict::Bool
-            attribute :arguments              , Types::Strict::String
-          end
-          attribute? :instance                , Types::Strict::Array do
-            attribute :name                   , Types::Strict::String
-            attribute :scope                  , Types::Strict::String # .optional.default(nil)
-            attribute :class_method           , Types::Strict::Bool
-            attribute :arguments              , Types::Strict::String
-          end
-          attribute? :instance_public         , Types::Strict::Array do
-            attribute :name                   , Types::Strict::String
-            attribute :scope                  , Types::Strict::String # .optional.default(nil)
-            attribute :class_method           , Types::Strict::Bool
-            attribute :arguments              , Types::Strict::String
-          end
-          attribute? :instance_private        , Types::Strict::Array do
-            attribute :name                   , Types::Strict::String
-            attribute :scope                  , Types::Strict::String # .optional.default(nil)
-            attribute :class_method           , Types::Strict::Bool
-            attribute :arguments              , Types::Strict::String
-          end
-        end
-      end
-      attribute? :dsl                       , Dry::Struct.optional.default(nil) do
-        attribute :default_scope            , Types::Strict::String.optional.default(nil)
+#         attribute? :all_methods               , Dry::Struct.optional.default(nil) do
+#           attribute? :klass                   , Types::Strict::Array do
+#             attribute :name                   , Types::Strict::String
+#             attribute :scope                  , Types::Strict::String # .optional.default(nil)
+#             attribute :class_method           , Types::Strict::Bool
+#             attribute :arguments              , Types::Strict::String
+#           end
+#           attribute? :instance                , Types::Strict::Array do
+#             attribute :name                   , Types::Strict::String
+#             attribute :scope                  , Types::Strict::String # .optional.default(nil)
+#             attribute :class_method           , Types::Strict::Bool
+#             attribute :arguments              , Types::Strict::String
+#           end
+#           attribute? :instance_public         , Types::Strict::Array do
+#             attribute :name                   , Types::Strict::String
+#             attribute :scope                  , Types::Strict::String # .optional.default(nil)
+#             attribute :class_method           , Types::Strict::Bool
+#             attribute :arguments              , Types::Strict::String
+#           end
+#           attribute? :instance_private        , Types::Strict::Array do
+#             attribute :name                   , Types::Strict::String
+#             attribute :scope                  , Types::Strict::String # .optional.default(nil)
+#             attribute :class_method           , Types::Strict::Bool
+#             attribute :arguments              , Types::Strict::String
+#           end
+#         end
+#       end
+#       attribute? :dsl                       , Dry::Struct.optional.default(nil) do
+#         attribute :default_scope            , Types::Strict::String.optional.default(nil)
 
-        attribute? :scopes                  , Types::Strict::Array do
-          attribute :name                   , Types::Strict::String
-          attribute :scope                  , Types::Strict::String # .optional.default(nil)
-        end
-        attribute? :belongs_to              , Types::Strict::Array do
-          attribute :name                   , Types::Strict::String
-          attribute :options                , Types::Strict::Hash.optional.default({}.freeze)
-          attribute :raw_options            , Types::Strict::String
-        end
-        attribute? :has_one                 , Types::Strict::Array do
-          attribute :name                   , Types::Strict::String
-          attribute :options                , Types::Strict::Hash.optional.default({}.freeze)
-          attribute :raw_options            , Types::Strict::String
-        end
-        attribute? :has_many                , Types::Strict::Array do
-          attribute :name                   , Types::Strict::String
-          attribute :options                , Types::Strict::Hash.optional.default({}.freeze)
-          attribute :raw_options            , Types::Strict::String
-        end
-        attribute? :has_and_belongs_to_many , Types::Strict::Array do
-          attribute :name                   , Types::Strict::String
-          attribute :options                , Types::Strict::Hash.optional.default({}.freeze)
-          attribute :raw_options            , Types::Strict::String
-        end
-        attribute? :validate_on             , Types::Strict::Array do
-          attribute :line                   , Types::Strict::String
-        end
-        attribute? :validates_on            , Types::Strict::Array do
-          attribute :name                   , Types::Strict::String
-          attribute :raw_options            , Types::Strict::String
-        end
-      end
-    end
-    # rubocop:enable Metrics/BlockLength
-  end
-end
+#         attribute? :scopes                  , Types::Strict::Array do
+#           attribute :name                   , Types::Strict::String
+#           attribute :scope                  , Types::Strict::String # .optional.default(nil)
+#         end
+#         attribute? :belongs_to              , Types::Strict::Array do
+#           attribute :name                   , Types::Strict::String
+#           attribute :options                , Types::Strict::Hash.optional.default({}.freeze)
+#           attribute :raw_options            , Types::Strict::String
+#         end
+#         attribute? :has_one                 , Types::Strict::Array do
+#           attribute :name                   , Types::Strict::String
+#           attribute :options                , Types::Strict::Hash.optional.default({}.freeze)
+#           attribute :raw_options            , Types::Strict::String
+#         end
+#         attribute? :has_many                , Types::Strict::Array do
+#           attribute :name                   , Types::Strict::String
+#           attribute :options                , Types::Strict::Hash.optional.default({}.freeze)
+#           attribute :raw_options            , Types::Strict::String
+#         end
+#         attribute? :has_and_belongs_to_many , Types::Strict::Array do
+#           attribute :name                   , Types::Strict::String
+#           attribute :options                , Types::Strict::Hash.optional.default({}.freeze)
+#           attribute :raw_options            , Types::Strict::String
+#         end
+#         attribute? :validate_on             , Types::Strict::Array do
+#           attribute :line                   , Types::Strict::String
+#         end
+#         attribute? :validates_on            , Types::Strict::Array do
+#           attribute :name                   , Types::Strict::String
+#           attribute :raw_options            , Types::Strict::String
+#         end
+#       end
+#     end
+#     # rubocop:enable Metrics/BlockLength
+#   end
+# end

data/lib/k_domain/schemas/domain.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+# Domain class holds a list of the entities
+module KDomain
+  module Schemas
+    class Domain < Dry::Struct
+      class Model < Dry::Struct
+        class Relationship < KDomain::Schemas::RailsStructure::NameOptsType
+          attribute :relation_type , Types::Coercible::Symbol
+
+          def to_s
+            "#{relation_type}: :#{name} fk: #{opts[:foreign_key]}"
+          end
+        end
+
+        class Column < Dry::Struct
+          attribute :name                 , Types::Strict::String                         #  "source_account_id"
+          attribute :name_plural          , Types::Strict::String                         #  "source_account_ids"
+          attribute :type                 , Types::Coercible::Symbol                      #  "integer"
+          attribute :precision            , Types::Strict::Integer.optional.default(nil)  #  null
+          attribute :scale                , Types::Strict::Integer.optional.default(nil)  #  null
+          attribute :default              , Types::Nominal::Any.optional.default(nil)     #  null
+          attribute :null                 , Types::Nominal::Any.optional.default(nil)     #  null
+          attribute :limit                , Types::Strict::Integer.optional.default(nil)  #  null
+          attribute :array                , Types::Strict::Bool.optional.default(nil)     #  null
+
+          # Calculated value
+          attribute :structure_type       , Types::Coercible::Symbol
+
+          # Any column may have a bunch of related models using various relationship types (belong_to, has_one, has_many etc...)
+          attr_accessor :relationships
+
+          def db_type
+            return @db_type if defined? @db_type
+
+            @db_type = KDomain::Schemas::DB_TYPE[type] || '******'
+          end
+
+          def ruby_type
+            return @ruby_type if defined? @ruby_type
+
+            @ruby_type = KDomain::Schemas::RUBY_TYPE[type] || '******'
+          end
+
+          def csharp_type
+            return @csharp_type if defined? @csharp_type
+
+            @csharp_type = KDomain::Schemas::CSHARP_TYPE[type] || '******'
+          end
+        end
+
+        class Pk < Dry::Struct
+          attribute :name               , Types::Strict::String.optional.default(nil)
+          attribute :type               , Types::Strict::String.optional.default(nil)
+          attribute :exist              , Types::Strict::Bool
+        end
+
+        attribute :name                 , Types::Strict::String
+        attribute :name_plural          , Types::Strict::String
+        attribute :table_name           , Types::Strict::String
+        # Model type - :entity, :basic_user, :admin_user, possibly: m2m, agg_root
+        attribute :type                 , Types::Strict::Symbol.optional.default(:entity)
+        attribute :pk                   , KDomain::Schemas::Domain::Model::Pk
+        attribute :columns              , Types::Strict::Array.of(KDomain::Schemas::Domain::Model::Column)
+        attribute :file                 , Types::Strict::String.optional.default(nil)
+
+        # Link <KDomain::Schemas::RailsStructure::Model> to the domain model
+        attr_accessor :rails_model
+
+        def ruby?
+          file && File.exist?(file)
+        end
+
+        def pk?
+          pk.exist
+        end
+
+        # Custom model configurations such as main_key and traits
+        def config
+          @config ||= KDomain.configuration.find_model(name.to_sym)
+        end
+
+        # If filled in, the model has a main field that is useful for rendering and may be used for unique constraint, may also be called display_name
+        def main_key
+          @main_key ||= config.main_key || KDomain.configuration.fallback_key(columns_data)
+        end
+
+        def traits
+          config.traits
+        end
+
+        def columns_data
+          @columns_data ||= columns_for_structure_types(:data)
+        end
+
+        def columns_primary
+          @columns_primary ||= columns_for_structure_types(:primary_key)
+        end
+
+        def columns_foreign
+          @columns_foreign ||= columns_for_structure_types(:foreign_key)
+        end
+
+        def columns_foreign_type
+          @columns_foreign_type ||= columns_for_structure_types(:foreign_type)
+        end
+
+        def columns_timestamp
+          @columns_data_timestamp ||= columns_for_structure_types(:timestamp)
+        end
+
+        def columns_deleted_at
+          @columns_data_deleted_at ||= columns_for_structure_types(:deleted_at)
+        end
+
+        def columns_virtual
+          @columns_virtual ||= columns_for_structure_types(:foreign_type, :timestamp, :deleted_at)
+        end
+
+        def columns_data_foreign
+          @columns_data_foreign ||= columns_for_structure_types(:data, :foreign_key)
+        end
+        alias rows_fields_and_fk columns_data_foreign
+
+        def columns_data_primary
+          @columns_data_primary ||= columns_for_structure_types(:data, :primary_key)
+        end
+        alias rows_fields_and_pk columns_data_primary
+
+        def columns_data_virtual
+          @columns_data_virtual ||= columns_for_structure_types(:data, :foreign_type, :timestamp, :deleted_at)
+        end
+        alias rows_fields_and_virtual columns_data_virtual
+
+        def columns_data_foreign_virtual
+          @columns_data_foreign_virtual ||= columns_for_structure_types(:data, :foreign_key, :foreign_type, :timestamp, :deleted_at)
+        end
+
+        private
+
+        def columns_for_structure_types(*structure_types)
+          columns.select { |column| structure_types.include?(column.structure_type) }
+        end
+      end
+
+      attribute :models , Types::Strict::Array.of(KDomain::Schemas::Domain::Model)
+    end
+  end
+end

data/lib/k_domain/schemas/domain_model.rb

@@ -4,11 +4,12 @@
 module KDomain
   module Schemas
     class DomainModel < Dry::Struct
-      attribute :domain         , KDomain::DomainModel::Domain
-      attribute :database       , KDomain::Database::Schema
-      attribute :dictionary     , KDomain::Schemas::Dictionary
-      attribute :rails_resource , KDomain::Schemas::RailsResource
-      attribute :investigate    , KDomain::Schemas::Investigate
+      attribute :domain           , KDomain::Schemas::Domain
+      attribute :database         , KDomain::Schemas::Database
+      attribute :dictionary       , KDomain::Schemas::Dictionary
+      attribute :rails_resource   , KDomain::Schemas::RailsResource
+      attribute :rails_structure  , KDomain::Schemas::RailsStructure
+      attribute :investigate      , KDomain::Schemas::Investigate
     end
   end
 end

data/lib/k_domain/schemas/{domain/_.rb → domain_types.rb}

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 
-# log.warn 'models->domain' if AppDebug.require?
-
-require_relative './models/column'
-require_relative './models/model'
-require_relative './erd_file'
-require_relative './domain'
-
 module KDomain
-  module DomainModel
+  module Schemas
     RUBY_TYPE = {
       text: 'String',
       string: 'String',

data/lib/k_domain/schemas/rails_resource.rb

@@ -3,13 +3,50 @@
 # Domain class holds a dictionary entry
 module KDomain
   module Schemas
+    # Route related files
+    module Types
+      include Dry.Types()
+
+      Verb      = Strict::String.enum('', 'GET', 'PATCH', 'POST', 'PUT', 'DELETE')
+    end
+
+    class Route < Dry::Struct
+      attribute :name                 , Types::String
+      attribute :controller_name      , Types::String
+      attribute :controller_path      , Types::String
+      attribute :controller_namespace , Types::String
+      attribute :controller_file      , Types::String
+      attribute :controller_exist     , Types::Bool
+      attribute :action               , Types::String.optional
+      attribute :uri_path             , Types::String
+      attribute :mime_match           , Types::String
+      attribute :verbs                , Types.Array(Types::Verb)
+      attribute :file                 , Types::String
+      attribute :exist                , Types::Bool
+      attribute :duplicate_verb       , Types::Bool
+    end
+
+    # Model related files
+    class Model < Dry::Struct
+      attribute :model_name         , Types::String
+      attribute :table_name         , Types::String
+      attribute :file               , Types::String
+      attribute :exist              , Types::Bool
+      attribute :state              , Types::String
+    end
+
     class RailsResource < Dry::Struct
-      attribute :models               , Types::Strict::Array do
-        attribute :model_name         , Types::Strict::String
-        attribute :table_name         , Types::Strict::String
-        attribute :file               , Types::Strict::String
-        attribute :exist              , Types::Strict::Bool
-        attribute :state              , Types::Strict::String
+      attribute :models, Types.Array(Model)
+      attribute :routes, Types.Array(Route)
+
+      # def find_route(name)
+      #   name = name.to_s
+      #   routes.find { |route| route.name.to_s == name }
+      # end
+
+      def find_model(name)
+        name = name.to_s
+        models.find { |model| model.model_name.to_s == name }
       end
     end
   end