k_domain 0.0.11 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0641cc1145379d1ba83cad6765dbf85bd50bb40ce69105a977eb9ced5326046
-  data.tar.gz: ac7f352029bcea76171cf87ccf56212e11b3173256519394cc2802e21fd47981
+  metadata.gz: c236bd2b714a21b40f5727765bc2b9c049f0c265e7c592e5864a6a6e34330b37
+  data.tar.gz: 8ecf79ec6e1805ad6660218ac6aa6931ef67a48b3ca56dd339c7a6a0f6c50886
 SHA512:
-  metadata.gz: d2b9ce5ced5669eb620f9c3735fbbaf06e12b6c9f9e5eb6507d3526aefcfe5eb624ce5361a14bc39c2c8449eaa31b3e0caa082b6fca07fba23b166be550fc023
-  data.tar.gz: a22f3ee11a7b7ef9a9793d01237c5e14f0ed89972d91ede7ed87c29c260b57fca1445ea1bac92830d2299767335e49dc41f2f7b6917a7e08ffb5f8383bbf2ed4
+  metadata.gz: 4b3a6c9c9af39c37fdeba462a209a0bd395a72c1887505c0852f1f37a58406c929cc080c63bb9ed5b4de937be51d722e0511a6194d7de389840cb5ca831e7135
+  data.tar.gz: f71d09378bf35ec9146692bd137b02176095ba934fbba711c6204896541af27365aeeeb67997d89d43cea7498f2d7361322cba566dd0c31ed1674fb190656968

data/Rakefile

@@ -26,7 +26,9 @@ task :publish do
   system 'gem build'
   system "gem push #{GEM_NAME}-#{KDomain::VERSION}.gem"
 end
-
+task :build do
+  system 'gem build'
+end
 desc 'Remove old *.gem files'
 task :clean do
   system 'rm *.gem'

data/k_domain.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
       f.match(%r{^(test|spec|features)/})
     end
   end
+  
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']

data/lib/k_domain/domain_model/load.rb

@@ -22,7 +22,7 @@ module KDomain
         json = File.read(source_file)
         data = KUtil.data.json_parse(json, as: :hash_symbolized)
 
-        @data = KDomain::DomainModel::Schema.new(data)
+        @data = KDomain::Schemas::DomainModel.new(data)
       end
     end
   end

data/lib/k_domain/domain_model/transform.rb

@@ -13,7 +13,7 @@ module KDomain
       attr_reader :target_file
       attr_reader :erd_path
 
-      def initialize(db_schema, target_file, target_step_file, erd_path)
+      def initialize(db_schema: , target_file: , target_step_file: , erd_path:)
         @db_schema        = db_schema
         @target_step_file = target_step_file
         @target_file      = target_file
@@ -82,16 +82,18 @@ module KDomain
           domain: {
             models: [],
             erd_files: [],
-            dictionary: []
           },
           rails: {
             models: [],
             controllers: [],
           },
-          rails_files: {
+          rails_resource: {
             models: [],
             controllers: [],
           },
+          dictionary: {
+            items: []
+          },
           database: {
             tables: [],
             indexes: [],

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

@@ -44,22 +44,22 @@ module KDomain
       end
 
       # Rails File Accessor/Helpers
-      def rails_files
-        guard('rails_files is missing') if domain_data[:rails_files].nil?
+      def rails_resource
+        guard('rails_resource is missing') if domain_data[:rails_resource].nil?
 
-        domain_data[:rails_files]
+        domain_data[:rails_resource]
       end
 
-      def rails_files_models
-        rails_files[:models]
+      def rails_resource_models
+        rails_resource[:models]
       end
 
-      def rails_files_models=(value)
-        rails_files[:models] = value
+      def rails_resource_models=(value)
+        rails_resource[:models] = value
       end
 
-      def rails_files_controllers
-        rails_files[:controllers]
+      def rails_resource_controllers
+        rails_resource[:controllers]
       end
 
       # Database Accessor/Helpers

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

@@ -13,7 +13,7 @@ module KDomain
         guard('indexes are missing')              if database[:indexes].nil?
         guard('foreign keys are missing')         if database[:foreign_keys].nil?
         guard('rails version is missing')         if database[:meta][:rails].nil?
-        guard('postgres extensions are missing')  if database[:meta][:database][:extensions].nil?
+        guard('postgres extensions are missing')  if database[:meta][:db_info][:extensions].nil?
         guard('unique keys are missing')          if database[:meta][:unique_keys].nil?
       end
     end

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

@@ -13,7 +13,9 @@ class Step5AttachDictionary < KDomain::DomainModel::Step
       end
     end
 
-    domain[:dictionary] = dictionary.values
+    domain_data[:dictionary] = {
+      items: dictionary.values
+    }
   end
 
   private

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

@@ -7,12 +7,14 @@ class Step8LocateRailsModels < KDomain::DomainModel::Step
   def call
     raise 'ERD path not supplied' if opts[:erd_path].nil?
 
-    self.rails_files_models = domain_models.map { |model| locate_rails_model(model[:name], model[:table_name]) }
+    self.rails_resource_models = domain_models.map do |model|
+      locate_rails_model(model[:name], model[:table_name])
+    end
   end
 
   private
 
-  def locate_rails_model(table_name, model_name)
+  def locate_rails_model(model_name, table_name)
     file_normal = File.join(opts[:erd_path], "#{model_name}.rb")
     file_custom = File.join(opts[:erd_path], "#{table_name}.rb")
     file_exist  = true

data/lib/k_domain/raw_db_schema/transform.rb

@@ -16,7 +16,7 @@ module KDomain
 
       def initialize(source_file)
         @source_file = source_file
-        @template_file = 'lib/k_domain/raw_db_schema/template.rb'
+        @template_file = KDomain::Gem.resource('templates/load_schema.rb')
       end
 
       def call
@@ -24,7 +24,6 @@ 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)
@@ -34,9 +33,9 @@ module KDomain
         lines = content.lines.map { |line| "    #{line}" }.join
 
         @schema_loader = File
-                         .read(template_file)
-                         .gsub('{{source_file}}', source_file)
-                         .gsub('{{rails_schema}}', lines)
+          .read(template_file)
+          .gsub('{{source_file}}', source_file)
+          .gsub('{{rails_schema}}', lines)
       end
 
       # rename to target_ruby

data/lib/k_domain/schemas/_.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# log.warn 'models->domain' if AppDebug.require?
+
+module Types
+  include Dry.Types()
+end
+
+require_relative 'rails_resource'
+require_relative 'investigate'
+require_relative 'database/_'
+require_relative 'dictionary'
+require_relative 'domain/_'
+
+require_relative './domain_model'

data/lib/k_domain/schemas/database/_.rb

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 
-module Types
-  include Dry.Types()
-end
-
 # The require order is important due to dependencies
-require_relative './column'
-require_relative './database'
 require_relative './index'
 require_relative './table'
 require_relative './foreign_key'
-require_relative './unique_key'
 require_relative './schema'

data/lib/k_domain/schemas/database/schema.rb

@@ -3,10 +3,23 @@
 module KDomain
   module Database
     class Schema < Dry::Struct
+      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 :database             , KDomain::Database::Database
-        attribute :unique_keys          , Types::Strict::Array.of(KDomain::Database::UniqueKey)
+        attribute :db_info              , KDomain::Database::Schema::DbInfo
+        attribute :unique_keys          , Types::Strict::Array.of(KDomain::Database::Schema::UniqueKey)
       end
 
       attribute :tables               , Types::Strict::Array.of(KDomain::Database::Table)

data/lib/k_domain/schemas/database/table.rb

@@ -3,19 +3,30 @@
 module KDomain
   module Database
     class Table < Dry::Struct
-      class Meta < 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) # Types::Strict::String.optional.default(nil)
-      attribute :columns              , Types::Strict::Array.of(KDomain::Database::Column)
-      attribute :indexes              , Types::Strict::Array.of(KDomain::Database::Index)
-      attribute :rails_schema         , KDomain::Database::Table::Meta
+      attribute :id?                  , Types::Nominal::Any.optional.default(nil)
+      attribute :columns              , Types::Strict::Array.of(KDomain::Database::Table::Column)
+      attribute :indexes              , Types::Strict::Array.of(KDomain::Database::Index) # May want to have a Table::Index, but for now this is a shared scheam
+      attribute :rails_schema         , KDomain::Database::Table::RailsSchema
     end
   end
 end

data/lib/k_domain/schemas/dictionary.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Domain class holds a dictionary entry
+module KDomain
+  module Schemas
+    class Dictionary < Dry::Struct
+      attribute :items              , Types::Strict::Array do
+        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
+end

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

@@ -2,13 +2,10 @@
 
 # log.warn 'models->domain' if AppDebug.require?
 
-require_relative './dictionary'
-require_relative './investigate'
 require_relative './models/column'
 require_relative './models/model'
 require_relative './erd_file'
 require_relative './domain'
-require_relative './schema'
 
 module KDomain
   module DomainModel

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

@@ -6,7 +6,6 @@ module KDomain
     class Domain < Dry::Struct
       attribute :models               , Types::Strict::Array.of(KDomain::DomainModel::Model)
       attribute :erd_files            , Types::Strict::Array.of(KDomain::DomainModel::ErdFile)
-      attribute :dictionary           , Types::Strict::Array.of(KDomain::DomainModel::Dictionary)
     end
   end
 end

data/lib/k_domain/schemas/{domain/schema.rb → domain_model.rb}

@@ -2,12 +2,13 @@
 
 # DomainModel holds the entire domain model including database and ancillary information
 module KDomain
-  module DomainModel
-    class Schema < Dry::Struct
+  module Schemas
+    class DomainModel < Dry::Struct
       attribute :domain         , KDomain::DomainModel::Domain
       attribute :database       , KDomain::Database::Schema
-      # attribute :rails_files    , KDomain::RailsFiles::Schema
-      attribute :investigate    , KDomain::DomainModel::Investigate
+      attribute :dictionary     , KDomain::Schemas::Dictionary
+      attribute :rails_resource , KDomain::Schemas::RailsResource
+      attribute :investigate    , KDomain::Schemas::Investigate
     end
   end
 end

data/lib/k_domain/schemas/{domain/investigate.rb → investigate.rb}

@@ -2,7 +2,7 @@
 
 # Domain class holds a dictionary entry
 module KDomain
-  module DomainModel
+  module Schemas
     class Investigate < Dry::Struct
       attribute :issues                 , Types::Strict::Array do
         attribute :step                 , Types::Strict::String

data/lib/k_domain/schemas/rails_resource.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Domain class holds a dictionary entry
+module KDomain
+  module Schemas
+    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
+      end
+    end
+  end
+end

data/lib/k_domain/version.rb

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

data/lib/k_domain.rb

@@ -5,9 +5,7 @@ require 'dry-struct'
 require 'k_log'
 require 'peeky'
 require 'k_domain/version'
-require 'k_domain/schemas/database/_'
-require 'k_domain/schemas/domain/_'
-
+require 'k_domain/schemas/_'
 require 'k_domain/raw_db_schema/transform'
 require 'k_domain/raw_db_schema/load'
 require 'k_domain/domain_model/transform'
@@ -23,6 +21,15 @@ module KDomain
   # raise KDomain::Error, 'Sample message'
   class Error < StandardError; end
 
+  module Gem
+    def self.root
+      File.expand_path('..', File.dirname(__FILE__))
+    end
+    def self.resource(resource_path)
+      File.join(root, resource_path)
+    end
+  end
+
   # Your code goes here...
 end
 

data/{lib/k_domain/raw_db_schema/template.rb → templates/load_schema.rb}

@@ -11,7 +11,7 @@ class LoadSchema
       indexes: [],
       meta: {
         rails: @rails_version,
-        database: {
+        db_info: {
           type: 'postgres',
           version: nil,         # TODO
           extensions: []
@@ -50,14 +50,14 @@ class LoadSchema
     sort
     # code to time
 
-    # log.kv 'extensions', schema[:database][:extensions].length
+    # log.kv 'extensions', schema[:db_info][:extensions].length
     # log.kv 'tables', schema[:tables].length
     # log.kv 'indexes', schema[:indexes].length  
     # # a low foreign_keys count is indicative of not using SQL referential integrity
     # log.kv 'foreign_keys', schema[:foreign_keys].length
     # log.kv 'Time Taken', (finish - start)
 
-    # puts schema[:database][:extensions]
+    # puts schema[:db_info][:extensions]
     # print_unique_keys(type: :foreign_keys, title: 'unique options for foreign_keys')
     # print_unique_keys(type: :columns, title: 'unique options for columns')
     # print_unique_keys(type: :fields, category: :integer , title: 'unique options for column - integer')
@@ -74,7 +74,7 @@ class LoadSchema
 
   def enable_extension(name)
     # puts "enable_extension(#{name})"
-    schema[:meta][:database][:extensions] << name
+    schema[:meta][:db_info][:extensions] << name
   end
 
   def create_table(name, **opts)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_domain
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.14
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,21 +106,17 @@ files:
 - lib/k_domain/domain_model/transform_steps/step5_attach_dictionary.rb
 - lib/k_domain/domain_model/transform_steps/step8_locate_rails_models.rb
 - lib/k_domain/raw_db_schema/load.rb
-- lib/k_domain/raw_db_schema/template.rb
 - lib/k_domain/raw_db_schema/transform.rb
+- lib/k_domain/schemas/_.rb
 - lib/k_domain/schemas/database/_.rb
-- lib/k_domain/schemas/database/column.rb
-- lib/k_domain/schemas/database/database.rb
 - lib/k_domain/schemas/database/foreign_key.rb
 - lib/k_domain/schemas/database/index.rb
 - lib/k_domain/schemas/database/schema.rb
 - lib/k_domain/schemas/database/table.rb
-- lib/k_domain/schemas/database/unique_key.rb
+- lib/k_domain/schemas/dictionary.rb
 - lib/k_domain/schemas/domain/_.rb
-- lib/k_domain/schemas/domain/dictionary.rb
 - lib/k_domain/schemas/domain/domain.rb
 - lib/k_domain/schemas/domain/erd_file.rb
-- lib/k_domain/schemas/domain/investigate.rb
 - lib/k_domain/schemas/domain/models/column.rb
 - lib/k_domain/schemas/domain/models/model.rb
 - lib/k_domain/schemas/domain/old/belongs_to.rb
@@ -139,8 +135,11 @@ 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/schema.rb
+- lib/k_domain/schemas/domain_model.rb
+- lib/k_domain/schemas/investigate.rb
+- lib/k_domain/schemas/rails_resource.rb
 - lib/k_domain/version.rb
+- templates/load_schema.rb
 homepage: http://appydave.com/gems/k-domain
 licenses:
 - MIT

data/lib/k_domain/schemas/database/column.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module KDomain
-  module Database
-    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) # Types::Strict::Bool.optional.default(nil) | Types::Strict::Integer.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
-  end
-end

data/lib/k_domain/schemas/database/database.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module KDomain
-  module Database
-    class Database < Dry::Struct
-      attribute :type                 , Types::Strict::String
-      attribute :version              , Types::Nominal::Any.optional.default(nil)
-      attribute :extensions           , Types::Strict::Array
-    end
-  end
-end

data/lib/k_domain/schemas/database/unique_key.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module KDomain
-  module Database
-    # Keep a track of unique keys that appear in the data structures
-    # so that we can track what new attributes to add to the models
-    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
-  end
-end

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

@@ -1,17 +0,0 @@
-# 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