k_domain 0.0.23 → 0.0.26

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

@@ -5,6 +5,14 @@ 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"
@@ -17,35 +25,27 @@ module KDomain
           attribute :array                , Types::Strict::Bool.optional.default(nil)     #  null
 
           # Calculated value
-          attribute :structure_type       , Types::Coercible::Symbol #
-          # attribute :foreign_key          , Types::Strict::Bool.optional.default(nil)     #
-          # attribute :foreign_table        , Types::Strict::String                         #
-          # attribute :foreign_table_plural , Types::Strict::String                         #
+          attribute :structure_type       , Types::Coercible::Symbol
 
-          # def data_column
-          #   @columns_data ||= structure_type?(:data)
-          # end
-
-          # def structure_type?(*structure_types)
-          #   structure_types.include?(column.structure_type)
-          # end
+          # 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 = DB_TYPE[type] || '******'
+            @db_type = KDomain::Schemas::DB_TYPE[type] || '******'
           end
 
           def ruby_type
             return @ruby_type if defined? @ruby_type
 
-            @ruby_type = RUBY_TYPE[type] || '******'
+            @ruby_type = KDomain::Schemas::RUBY_TYPE[type] || '******'
           end
 
           def csharp_type
             return @csharp_type if defined? @csharp_type
 
-            @csharp_type = CSHARP_TYPE[type] || '******'
+            @csharp_type = KDomain::Schemas::CSHARP_TYPE[type] || '******'
           end
         end
 
@@ -64,6 +64,9 @@ module KDomain
         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
@@ -72,35 +75,24 @@ module KDomain
           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 ||= MainKey.lookup(name, columns_data)
+          @main_key ||= config.main_key || KDomain.configuration.fallback_key(columns_data)
         end
 
         def traits
-          @traits ||= Traits.lookup(name)
+          config.traits
         end
 
-        # def where()
-        # end
-
-        # def columns_where()
-        # end
-
-        # Column filters
-
         def columns_data
           @columns_data ||= columns_for_structure_types(:data)
         end
 
-        # def columns_data_optional
-        #   @columns_data_optional ||= columns_for_structure_types(:data).select { |c| true }
-        # end
-
-        # def columns_data_required
-        #   @columns_data_required ||= columns_for_structure_types(:data).select { |c| false }
-        # end
-
         def columns_primary
           @columns_primary ||= columns_for_structure_types(:primary_key)
         end
@@ -109,6 +101,10 @@ module KDomain
           @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
@@ -118,7 +114,7 @@ module KDomain
         end
 
         def columns_virtual
-          @columns_virtual ||= columns_for_structure_types(:timestamp, :deleted_at)
+          @columns_virtual ||= columns_for_structure_types(:foreign_type, :timestamp, :deleted_at)
         end
 
         def columns_data_foreign
@@ -132,12 +128,12 @@ module KDomain
         alias rows_fields_and_pk columns_data_primary
 
         def columns_data_virtual
-          @columns_data_virtual ||= columns_for_structure_types(:data, :timestamp, :deleted_at)
+          @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, :timestamp, :deleted_at)
+          @columns_data_foreign_virtual ||= columns_for_structure_types(:data, :foreign_key, :foreign_type, :timestamp, :deleted_at)
         end
 
         private
@@ -148,7 +144,6 @@ module KDomain
       end
 
       attribute :models , Types::Strict::Array.of(KDomain::Schemas::Domain::Model)
-      # attribute :erd_files            , Types::Strict::Array.of(KDomain::DomainModel::ErdFile)
     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_structure.rb

@@ -51,6 +51,16 @@ module KDomain
         attribute :attr_accessor?             , Types::Array.of(Types::Strict::String)
         attribute :attr_reader?               , Types::Array.of(Types::Strict::String)
         attribute :attr_writer?               , Types::Array.of(Types::Strict::String)
+
+        # Not sure if I need to do a behaviours by column names
+        # def belongs_to_by(foreign_key: )
+        # end
+        # def has_one_by(foreign_key: )
+        # end
+        # def has_many_by(foreign_key: )
+        # end
+        # def has_and_belongs_to_many_to_by(foreign_key: )
+        # end
       end
 
       class Method < Dry::Struct

data/lib/k_domain/version.rb

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

data/lib/k_domain.rb

@@ -5,6 +5,7 @@ require 'dry-struct'
 require 'k_log'
 require 'peeky'
 require 'k_domain/version'
+require 'k_domain/config/_'
 require 'k_domain/schemas/_'
 require 'k_domain/raw_db_schema/transform'
 require 'k_domain/raw_db_schema/load'
@@ -19,6 +20,8 @@ require 'k_domain/rails_code_extractor/_'
 # end
 
 module KDomain
+  extend KDomain::Config
+
   # raise KDomain::Error, 'Sample message'
   class Error < StandardError; 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_domain
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.26
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,8 +74,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".builders/config/_.rb"
-- ".builders/setup.rb"
+- ".builders/boot.rb"
+- ".builders/generators/configuration_generator.rb"
+- ".builders/run.rb"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -97,6 +98,9 @@ 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/load.rb
 - lib/k_domain/domain_model/transform.rb
 - lib/k_domain/domain_model/transform_steps/_.rb
@@ -119,7 +123,6 @@ files:
 - lib/k_domain/schemas/database.rb
 - lib/k_domain/schemas/dictionary.rb
 - lib/k_domain/schemas/domain.rb
-- lib/k_domain/schemas/domain/_.rb
 - lib/k_domain/schemas/domain/erd_file.rb
 - lib/k_domain/schemas/domain/old/belongs_to.rb
 - lib/k_domain/schemas/domain/old/column_old.rb
@@ -138,6 +141,7 @@ files:
 - 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/rails_resource.rb
 - lib/k_domain/schemas/rails_structure.rb
@@ -146,12 +150,11 @@ files:
 - templates/custom/controller_interceptors.rb
 - templates/custom/model_interceptors.rb
 - templates/load_schema.rb
-- templates/old_printspeek_schema copy.rb
-- templates/old_printspeek_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:

data/.builders/config/_.rb

@@ -1,3 +0,0 @@
-puts '_'
-
-#require 'config/_initialize'

data/.builders/setup.rb

@@ -1,30 +0,0 @@
-require 'config/_'
-require_relative "../lib/k_domain"
-
-db_schema_ruby_file = '/Users/davidcruwys/dev/printspeak/printspeak-master/db/schema.rb'
-
-# /Users/davidcruwys/dev/printspeak/printspeak/.builders/config/raw/schema_printspeak.rb
-output_folder = File.expand_path('../.output')
-db_schema_json_file = File.join(output_folder, 'db_schema.json')
-schema_loader_file = File.join(output_folder, 'schema_printspeak.rb')
-
-transformer = KDomain::RawDbSchema::Transform.new(db_schema_ruby_file)
-transformer.template_file = '/Users/davidcruwys/dev/kgems/k_domain/templates/old_printspeek_schema.rb'
-puts db_schema_ruby_file
-puts transformer.template_file
-transformer.call
-transformer.write_json(db_schema_json_file)
-transformer.write_schema_loader(schema_loader_file)
-# transformer.schema
-
-
-# transform = KDomain::DomainModel::Transform.new(
-#   db_schema: db_schema,
-#   target_file: target_file,
-#   target_step_file: target_step_file,
-#   model_path: model_path,
-#   controller_path: controller_path,
-#   route_path: route_path
-# )
-
-puts 'done'