k_domain 0.0.20 → 0.0.23

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k_domain
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.23
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,6 +74,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".builders/config/_.rb"
+- ".builders/setup.rb"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -99,28 +101,26 @@ files:
 - lib/k_domain/domain_model/transform.rb
 - lib/k_domain/domain_model/transform_steps/_.rb
 - lib/k_domain/domain_model/transform_steps/step.rb
-- lib/k_domain/domain_model/transform_steps/step1_attach_db_schema.rb
-- lib/k_domain/domain_model/transform_steps/step2_attach_models.rb
-- lib/k_domain/domain_model/transform_steps/step3_attach_columns.rb
+- lib/k_domain/domain_model/transform_steps/step1_db_schema.rb
+- lib/k_domain/domain_model/transform_steps/step20_dictionary.rb
+- lib/k_domain/domain_model/transform_steps/step2_domain_models.rb
 - lib/k_domain/domain_model/transform_steps/step4_rails_resource_models.rb
-- lib/k_domain/domain_model/transform_steps/step5_rails_models.rb
-- lib/k_domain/domain_model/transform_steps/step6_attach_dictionary.rb
+- lib/k_domain/domain_model/transform_steps/step5_rails_resource_routes.rb
+- 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/rails_code_extractor/_.rb
+- lib/k_domain/rails_code_extractor/extract_controller.rb
 - lib/k_domain/rails_code_extractor/extract_model.rb
 - lib/k_domain/rails_code_extractor/shim_loader.rb
 - lib/k_domain/raw_db_schema/load.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/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.rb
 - lib/k_domain/schemas/dictionary.rb
+- lib/k_domain/schemas/domain.rb
 - lib/k_domain/schemas/domain/_.rb
-- lib/k_domain/schemas/domain/domain.rb
 - lib/k_domain/schemas/domain/erd_file.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
 - lib/k_domain/schemas/domain/old/column_old.rb
 - lib/k_domain/schemas/domain/old/domain_statistics.rb
@@ -142,9 +142,17 @@ files:
 - lib/k_domain/schemas/rails_resource.rb
 - lib/k_domain/schemas/rails_structure.rb
 - lib/k_domain/version.rb
-- templates/active_record_shims.rb
-- templates/fake_module_shims.rb
+- templates/custom/action_controller.rb
+- 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/simple/controller_interceptors.rb
 homepage: http://appydave.com/gems/k-domain
 licenses:
 - MIT
@@ -167,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: K Domain builds complex domain schemas by combining the database schema with

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

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-# Loop through the db_schema tables and build up a
-# basic model for each table
-class Step2AttachModels < KDomain::DomainModel::Step
-  # Map database schema to domain model
-  def call
-    raise 'ERD path not supplied' if opts[:erd_path].nil?
-
-    # Schema is re-shaped into a format designed for domain modeling
-    domain[:models] = database_tables.map { |table| model(table) }
-  end
-
-  def model(table)
-    table_name = table[:name].to_s
-    model_name = table_name.singularize
-
-    {
-      name: model_name,
-      name_plural: table_name, # need to check if this is correct as I know it is wrong for account_history_datum
-      table_name: table_name,
-      pk: primary_key(table),
-      erd_location: location(table_name, model_name),
-      statistics: {},                                   # Load in future step
-      columns: []                                       # Load in future step
-    }
-  end
-
-  def primary_key(table)
-    {
-      name: table[:primary_key],
-      type: table[:primary_key_type],
-      exist: !table[:primary_key].nil?
-    }
-  end
-
-  # Location of source code
-  def location(table_name, model_name)
-    file_normal = File.join(opts[:erd_path], "#{model_name}.rb")
-    file_custom = File.join(opts[:erd_path], "#{table_name}.rb")
-    file_exist  = true
-    state = []
-
-    if File.exist?(file_normal)
-      file = file_normal
-      state.push(:has_ruby_model)
-    elsif File.exist?(file_custom)
-      file = file_custom
-      state.push(:has_ruby_model)
-      state.push(:nonconventional_name)
-    else
-      file = ''
-      file_exist = false
-    end
-
-    {
-      file: file,
-      exist: file_exist,
-      state: state                      # display_state: state.join(' ')
-    }
-  end
-end

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

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-# Locate rails model files
-class Step5RailsModels < KDomain::DomainModel::Step
-  def call
-    raise 'ERD path not supplied' unless opts[:erd_path]
-
-    self.rails_structure_models = rails_resource_models.map do |resource|
-      process_resource(OpenStruct.new(resource))
-    end
-  end
-
-  private
-
-  def process_resource(resource)
-    @model = {
-      model_name: resource.model_name,
-      table_name: resource.table_name,
-      file: resource.file,
-      exist: resource.exist,
-      state: resource.state,
-      code: resource.exist ? File.read(resource.file) : '',
-      behaviours: {},
-      functions: {}
-    }
-
-    return @model unless  resource.exist
-
-    @model[:behaviours] = extract_model_behavior(resource.file)
-    @model[:functions] = extract_model_functions(resource.file)
-
-    @model
-  end
-
-  def extract_model_behavior(file)
-    extractor.extract(file)
-    extractor.model
-  end
-
-  def extract_model_functions(file)
-    klass_name = File.basename(file, File.extname(file))
-
-    klass = case klass_name
-            when 'clearbit_quota'
-              ClearbitQuota
-            when 'account_history_data'
-              AccountHistoryData
-            else
-              Module.const_get(klass_name.classify)
-            end
-
-    class_info = Peeky.api.build_class_info(klass.new)
-
-    class_info.to_h
-  rescue StandardError => e
-    log.exception(e)
-  end
-
-  def extractor
-    @extractor ||= KDomain::RailsCodeExtractor::ExtractModel.new(shim_loader)
-  end
-
-  def shim_loader
-    return opts[:shim_loader] if !opts[:shim_loader].nil? && opts[:shim_loader].is_a?(KDomain::RailsCodeExtractor::ShimLoader)
-
-    shim_loader = KDomain::RailsCodeExtractor::ShimLoader.new
-    shim_loader.register(:fake_module  , KDomain::Gem.resource('templates/fake_module_shims.rb'))
-    shim_loader.register(:active_record, KDomain::Gem.resource('templates/active_record_shims.rb'))
-    shim_loader
-  end
-end

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-# The require order is important due to dependencies
-require_relative './index'
-require_relative './table'
-require_relative './foreign_key'
-require_relative './schema'

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

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module KDomain
-  module Database
-    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
-  end
-end

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

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module KDomain
-  module Database
-    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
-  end
-end

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-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 :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)
-      attribute :foreign_keys?        , Types::Strict::Array.of(KDomain::Database::ForeignKey)
-      attribute :indexes?             , Types::Strict::Array.of(KDomain::Database::Index)
-      attribute :meta                 , KDomain::Database::Schema::Meta
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module KDomain
-  module Database
-    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::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/domain/domain.rb

@@ -1,11 +0,0 @@
-# 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 :erd_files            , Types::Strict::Array.of(KDomain::DomainModel::ErdFile)
-    end
-  end
-end

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

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module KDomain
-  module DomainModel
-    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                      #
-      attribute :foreign_key          , Types::Strict::Bool.optional.default(nil)     #
-      attribute :foreign_table        , Types::Strict::String                         #
-      attribute :foreign_table_plural , Types::Strict::String                         #
-
-      # def data_column
-      #   @columns_data ||= structure_type?(:data)
-      # end
-
-      # def structure_type?(*structure_types)
-      #   structure_types.include?(column.structure_type)
-      # end
-
-      def db_type
-        return @db_type if defined? @db_type
-
-        @db_type = DB_TYPE[type] || '******'
-      end
-
-      def ruby_type
-        return @ruby_type if defined? @ruby_type
-
-        @ruby_type = RUBY_TYPE[type] || '******'
-      end
-
-      def csharp_type
-        return @csharp_type if defined? @csharp_type
-
-        @csharp_type = CSHARP_TYPE[type] || '******'
-      end
-    end
-  end
-end

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

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-# Domain class holds a list of the entities
-module KDomain
-  module DomainModel
-    class Model < Dry::Struct
-      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
-
-      class ErdLocation < Dry::Struct
-        attribute :file               , Types::Strict::String
-        attribute :exist              , Types::Strict::Bool
-        attribute :state              , Types::Strict::Array
-      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::DomainModel::Model::Pk
-      attribute :erd_location         , KDomain::DomainModel::Model::ErdLocation
-      attribute :columns              , Types::Strict::Array.of(KDomain::DomainModel::Column)
-
-      def ruby?
-        location.exist
-      end
-
-      def pk?
-        pk.exist
-      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)
-      end
-
-      def traits
-        @traits ||= Traits.lookup(name)
-      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
-
-      def columns_foreign
-        @columns_foreign ||= columns_for_structure_types(:foreign_key)
-      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(: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, :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)
-      end
-
-      private
-
-      def columns_for_structure_types(*structure_types)
-        columns.select { |column| structure_types.include?(column.structure_type) }
-      end
-    end
-  end
-end

data/templates/fake_module_shims.rb

@@ -1,42 +0,0 @@
-class Rails
-  def self.env; end
-
-  def self.application
-    OpenStruct.new(secrets: OpenStruct.new(credentials_secret_key: Base64.encode64('ABC')))
-  end
-end
-
-module ActsAsCommentable
-  module Comment
-  end
-end
-
-module Scopes
-  module CompanyScopes
-  end
-end
-
-module ActionView
-  module Helpers
-    module NumberHelper
-    end
-  end
-end
-
-module RailsUpgrade
-  def rails4?
-    true
-  end
-
-  def rails5?
-    true
-  end
-
-  def rails6?
-    true
-  end
-
-  def belongs_to_required
-    {}
-  end
-end