k_domain 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a69b94955a43f91d71e034b94a5caf0d3fdbb7b130c480d4eabc45818bbe2262
-  data.tar.gz: 0f4a126ee7c9bed5d99ac7449e5f97ec558030b126dbaa3c6194cdb5ce8430bd
+  metadata.gz: 92aebc822bef5bff0524221c4ca53f3bccdf4f3b4a134c2bcdd207f7c58e5609
+  data.tar.gz: db850d6a8d98ee6a5fd77f1cfe5a9e87d5da262ebec598c84f8ca70b3fb5a1cb
 SHA512:
-  metadata.gz: 3a7a877e80c9f23cdb93ab7952e027bdddc89bd6e888212c6fc0622cc0d5ae6d9b73e3e9651949ecd1afa2f1323e6446045f579cb6e83c030c5d8d711979deaa
-  data.tar.gz: 434275e01ec2308d4a1407f5e8bd7ab9ec9708218510b6a719c144e2d9b6abb7e2caafa67efc617ac33295cd276c2326ccd961468ee4870b38266ef1b1295296
+  metadata.gz: d31d1bd2e461d1a86b938eb043c9dda1c5f553e3a8a1ddd759e0ff24b349da2100f934feb0ac8b001da137086862145aa575be1a2b32a6070f1f82b5ff63a837
+  data.tar.gz: acd57f1f859401f1d0ff8f39fc7cc3eb69ee128a0c91b94f5ce92bb275ff82924663ce00beb58a25c19752934e2ccc70f1cf04a83e1b8de429e70bd403fb48eb

data/.rubocop.yml

@@ -6,7 +6,26 @@ AllCops:
   NewCops: enable
   Exclude:
     - "_/**/*"
-    - "spec/samples/**/*"
+    - "spec/sample_input/**/*"
+    - "spec/sample_output/**/*"
+    - "lib/k_domain/raw_db_schema/template.rb"
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - "lib/k_domain/domain_model/transform_steps/*.rb"
+    - "lib/k_domain/domain_model/dtos/entity.rb"
+
+Metrics/AbcSize:
+  Exclude:
+    - "lib/k_domain/domain_model/transform_steps/*.rb"
+    - "lib/k_domain/domain_model/dtos/rails_model.rb"
+    - "lib/k_domain/domain_model/dtos/entity.rb"
+    - "lib/k_domain/domain_model/dtos/column_old.rb"
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - "lib/k_domain/domain_model/transform_steps/*.rb"
+    - "lib/k_domain/domain_model/dtos/entity.rb"
 
 Metrics/BlockLength:
   Exclude:
@@ -34,12 +53,17 @@ Metrics/BlockLength:
 
 Metrics/MethodLength:
   Max: 25
+  Exclude:
+    - "lib/k_domain/domain_model/transform_steps/*.rb"
+    - "lib/k_domain/domain_model/dtos/rails_model.rb"
 
 Layout/LineLength:
   Max: 200
   # Ignores annotate output
   IgnoredPatterns: ['\A# \*\*']
   IgnoreCopDirectives: true
+  Exclude:
+    - "lib/k_domain/domain_model/transform_steps/*.rb"
 
 Lint/UnusedMethodArgument:
   AllowUnusedKeywordArguments: true
@@ -77,6 +101,12 @@ Lint/AmbiguousBlockAssociation:
 Style/AccessorGrouping:
   Enabled: false
 
+Style/FormatStringToken:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
 Layout/SpaceBeforeComma:
   Enabled: false
 # My Preferences - End

data/STORIES.md

@@ -8,9 +8,13 @@ As an Application Developer, I need a rich and configurable ERD schema, so I can
 
 ### Stories next on list
 
-As a Developer, I can DO_SOMETHING, so that I QUALITY_OF_LIFE
+As a Developer, I can print any of the domain structures, so that I can visually my domain
 
-- Subtask
+- Hook up log.structure
+
+As a Developer, I can customize domain configuration, so that I can have opinions about names and types
+
+- Handle traits
 
 ## Stories and tasks
 

data/k_domain.gemspec

@@ -38,5 +38,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   # spec.extensions    = ['ext/k_domain/extconf.rb']
 
+  spec.add_dependency 'activesupport'   , '~> 6'
+  spec.add_dependency 'dry-struct', '~> 1'
   spec.add_dependency 'k_log' , '~> 0.0.0'
 end

data/lib/k_domain/domain_model/dtos/_.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# log.warn 'models->domain' if AppDebug.require?
+
+require_relative './dictionary/dictionary'
+require_relative './investigate/issue'
+require_relative './investigate/investigate'
+require_relative './models/column'
+require_relative './models/model'
+require_relative './domain'
+require_relative './schema'
+
+# require_relative './helper/domain_config'
+# require_relative './helper/main_key'
+# require_relative './helper/traits'
+
+# require_relative './belongs_to'
+# require_relative './domain_statistics'
+# # require_relative './domain_mapper'
+# require_relative './entity'
+# require_relative './entity_statistics'
+# require_relative './foreign_key'
+# require_relative './has_and_belongs_to_many'
+# require_relative './has_many'
+# require_relative './has_one'
+# require_relative './name_options'
+# require_relative './rails_model'
+# require_relative './related_entity'
+# require_relative './statistics'
+# require_relative './validate'
+# require_relative './validates'
+
+module KDomain
+  module DomainModel
+    RUBY_TYPE = {
+      text: 'String',
+      string: 'String',
+      primary_key: 'Integer', # this could be GUID in future
+      foreign_key: 'Integer', # this could be GUID in future
+      integer: 'Integer',
+      bigint: 'Integer',
+      bigserial: 'Integer',
+      boolean: 'Boolean',
+      float: 'Float',
+      decimal: 'Decimal',
+      datetime: 'DateTime',
+      date: 'DateTime',
+      json: 'Hash',
+      jsonb: 'Hash',
+      hstore: 'Hash'
+    }.freeze
+
+    CSHARP_TYPE = {
+      string: 'string',
+      text: 'string', # NEED TO DEAL WITH THIS BETTER
+      integer: 'int',
+      bigint: 'int',
+      bigserial: 'long',
+      boolean: 'bool',
+      decimal: 'decimal',
+      float: 'double',
+      datetime: 'DateTime',
+      date: 'DateTime',
+      json: 'object',
+      jsonb: 'object',
+      hstore: 'object'
+    }.freeze
+
+    # this is used by the ruby migration files
+    DB_TYPE = {
+      boolean: 'boolean',
+      primary_key: 'integer',
+      foreign_key: 'integer',
+      integer: 'integer',
+      bigint: 'integer',
+      bigserial: 'bigserial',
+      decimal: 'decimal',
+      float: 'float',
+      datetime: 'datetime',
+      date: 'date',
+      text: 'text',
+      string: 'string',
+      json: 'json',
+      jsonb: 'jsonb',
+      hstore: 'hstore'
+    }.freeze
+  end
+end

data/lib/k_domain/domain_model/dtos/belongs_to.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module KDomain
+  module DomainModel
+    class BelongsTo
+      KEYS = %i[a_lambda polymorphic class_name foreign_key primary_key inverse_of with_deleted code_duplicate].freeze
+
+      attr_accessor :name
+
+      attr_accessor :model_name
+      attr_accessor :model_name_plural
+
+      attr_accessor :a_lambda
+      attr_accessor :polymorphic
+      attr_accessor :class_name
+      attr_accessor :foreign_key
+      attr_accessor :primary_key
+      attr_accessor :inverse_of
+      attr_accessor :with_deleted
+
+      attr_accessor :related_entity
+      attr_accessor :code_duplicate
+    end
+  end
+end

data/lib/k_domain/domain_model/dtos/column_old.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+module KDomain
+  module DomainModel
+    class ColumnOld
+      # DONE
+      RUBY_TYPE = {
+        string: 'String',
+        text: 'String',
+        primary_key: 'Integer', # this could be GUID in future
+        foreign_key: 'Integer', # this could be GUID in future
+        integer: 'Integer',
+        boolean: 'Boolean',
+        float: 'Float',
+        decimal: 'Decimal',
+        datetime: 'DateTime',
+        date: 'DateTime',
+        json: 'Hash',
+        jsonb: 'Hash',
+        hstore: 'Hash'
+      }.freeze
+
+      # DONE
+      CSHARP_TYPE = {
+        string: 'string',
+        text: 'string', # NEED TO DEAL WITH THIS BETTER
+        integer: 'int',
+        boolean: 'bool',
+        decimal: 'decimal',
+        float: 'double',
+        datetime: 'DateTime',
+        date: 'DateTime',
+        json: 'object',
+        jsonb: 'object',
+        hstore: 'object'
+      }.freeze
+
+      # this is used by the ruby migration files
+      # DONE
+      DB_TYPE = {
+        boolean: 'boolean',
+        primary_key: 'integer',
+        foreign_key: 'integer',
+        integer: 'integer',
+        decimal: 'decimal',
+        float: 'float',
+        datetime: 'datetime',
+        date: 'date',
+        text: 'text',
+        string: 'string',
+        json: 'json',
+        jsonb: 'jsonb',
+        hstore: 'hstore'
+      }.freeze
+
+      SIMPLE_ATTRIBS = %i[
+        name
+        name_plural
+        type
+        structure_type
+        foreign_key?
+        foreign_table
+        foreign_id
+      ].freeze
+
+      DETAILED_ATTRIBS = SIMPLE_ATTRIBS + %i[
+        title
+        required
+        reference_type
+        db_type
+        ruby_type
+        csharp_type
+        format_type
+        description
+        belongs_to
+      ]
+
+      EXTRA_ATTRIBS = DETAILED_ATTRIBS + %i[
+        precision
+        scale
+        default
+        null
+        limit
+        array
+      ]
+
+      # Name of the column
+      attr_accessor :name
+
+      # Name of the column in plural form
+      attr_accessor :name_plural
+
+      attr_accessor :type
+
+      # Human readable title
+      attr_accessor :title
+
+      # true
+      attr_accessor :required
+
+      attr_accessor :structure_type # :data, :foreign_key, :timestamp
+      attr_accessor :reference_type
+
+      # 'references' if foreign key, 'primary_key' if primary key, will map_from_type(type)) |
+      # attr_accessor :db_type
+
+      attr_accessor :format_type
+      attr_accessor :description
+
+      attr_accessor :foreign_key
+      alias foreign_key? foreign_key
+      attr_accessor :foreign_table
+      attr_accessor :belongs_to
+      # this may not always be accurate, should support override
+      attr_accessor :foreign_id
+      alias reference_table foreign_id
+
+      # Extra DB attributes
+      attr_accessor :precision
+      attr_accessor :scale
+      attr_accessor :default
+      attr_accessor :null
+      alias nullable null
+      attr_accessor :limit
+      attr_accessor :array
+
+      def format_default
+        return '' if default.nil?
+        return "\"#{default}\"" if default.is_a?(String)
+
+        #  || default.is_a?(Symbol)
+        default.to_s
+      end
+
+      def format_null
+        null.nil? ? '' : null.to_s
+      end
+
+      def format_array
+        array.nil? ? '' : array.to_s
+      end
+
+      # DONE
+      def db_type
+        return @db_type if defined? @db_type
+
+        @db_type = DB_TYPE[type] || '******'
+      end
+
+      # DONE
+      def ruby_type
+        return @ruby_type if defined? @ruby_type
+
+        @ruby_type = RUBY_TYPE[type] || '******'
+      end
+
+      # DONE
+      def csharp_type
+        return @csharp_type if defined? @csharp_type
+
+        @csharp_type = CSHARP_TYPE[type] || '******'
+      end
+
+      def debug(*flags)
+        debug_simple    if flags.include?(:simple)
+        debug_detailed  if flags.include?(:detailed)
+        debug_extra     if flags.include?(:extra)
+      end
+
+      private
+
+      def debug_simple
+        log.kv 'name'             , name
+        log.kv 'name_plural'      , name_plural
+        log.kv 'type'             , type
+        log.kv 'structure_type'   , structure_type
+      end
+
+      def debug_detailed
+        debug_simple
+        log.kv 'title'            , title
+        log.kv 'required'         , required
+        log.kv 'reference_type'   , reference_type
+        log.kv 'db_type'          , db_type
+        log.kv 'ruby_type'        , ruby_type
+        log.kv 'csharp_type'      , csharp_type
+        log.kv 'format_type'      , format_type
+        log.kv 'description'      , description
+
+        log.kv 'foreign_key?'     , foreign_key?
+        log.kv 'foreign_table'    , foreign_table
+        log.kv 'belongs_to'       , belongs_to
+        log.kv 'foreign_id'       , foreign_id
+      end
+
+      def debug_extra
+        debug_detailed
+
+        log.kv 'precision'        , precision
+        log.kv 'scale'            , scale
+        log.kv 'default'          , default
+        log.kv 'null'             , null
+        log.kv 'limit'            , limit
+        log.kv 'array'            , array
+      end
+    end
+
+    # ---------------------------------------------
+    # Available column keys that can be mapped from
+    # ---------------------------------------------
+    # name
+    # name_plural
+    # type
+    # foreign_key?
+    # foreign_table
+    # structure_type
+    # precision
+    # scale
+    # default
+    # null
+    # limit
+    # array
+    # belongs_to
+  end
+end

data/lib/k_domain/domain_model/dtos/dictionary/dictionary.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Domain class holds a dictionary entry
+module KDomain
+  module DomainModel
+    class Dictionary < Dry::Struct
+      attribute :name                 , Types::Strict::String
+      attribute :type                 , Types::Strict::String
+      attribute :label                , Types::Strict::String
+      attribute :segment              , Types::Strict::String
+      attribute :models               , Types::Strict::Array
+      attribute :model_count          , Types::Strict::Integer
+      attribute :types               , Types::Strict::Array
+      attribute :type_count          , Types::Strict::Integer
+    end
+  end
+end

data/lib/k_domain/domain_model/dtos/domain.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Domain class holds a list of the entities
+module KDomain
+  module DomainModel
+    class Domain < Dry::Struct
+      attribute :models               , Types::Strict::Array.of(KDomain::DomainModel::Model)
+      attribute :dictionary           , Types::Strict::Array.of(KDomain::DomainModel::Dictionary)
+    end
+  end
+end

data/lib/k_domain/domain_model/dtos/domain_statistics.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Rails model represents information that is found the model.rb class in the rails project
+module KDomain
+  module DomainModel
+    class DomainStatistics
+      attr_reader :domain
+      attr_accessor :column_counts
+      attr_accessor :code_counts
+      attr_accessor :code_dsl_counts
+      attr_accessor :data_counts
+      attr_accessor :issues
+
+      def initialize(domain)
+        @domain = domain
+        # @column_counts = OpenStruct.new(meta[:column_counts])
+        # @code_counts = OpenStruct.new(meta[:code_counts])
+        # @code_dsl_counts = OpenStruct.new(meta[:code_dsl_counts])
+        # @data_counts = OpenStruct.new(meta[:data_counts])
+        # @issues = meta[:issues]
+      end
+
+      def print
+        log.warn('Statistics ::')
+        log.kv('Database Entities', domain.entities.length)
+      end
+    end
+  end
+end