k_manager 0.0.13 → 0.0.22

data/tasks/watch.rake

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'pry'
+require 'k_manager'
+# require 'filewatcher'
+# require 'io/console'
+
+namespace :k_manager do
+  desc 'Create CSV Files for Models'
+  task :watch do
+    target_folder = 'spec/k_manager/scenarios'
+    watch_folder = File.join(Dir.pwd, target_folder)
+    boot_file = File.join(watch_folder, 'simple/boot.rb')
+
+    watcher = Watcher.new(watch_folder, boot_file)
+    watcher.start
+  end
+end
+
+# require 'pry'
+# require 'k_manager'
+# require 'filewatcher'
+# require 'io/console'
+
+# class Watcher
+#   include KLog::Logging
+
+#   attr_reader :watch_folder
+#   attr_reader :boot_file
+
+#   def initialize(watch_folder, boot_file)
+#     @watch_folder = watch_folder
+#     @boot_file = boot_file
+#   end
+
+#   # rubocop:disable Lint/RescueException
+#   def start
+#     boot(boot_file)
+#     update_dashboard
+
+#     Filewatcher.new(watch_folder).watch do |changes|
+#       changes.each do |filename, event|
+#         $stdout.clear_screen
+#         puts "File #{event}: #{filename}"
+
+#         uri = URI::File.build(host: nil, path: filename)
+#         KManager.resource_changed(uri, event)
+
+#         # process_created_file(filename) if event == :created
+#         # process_updated_file(filename) if event == :updated # || event == :created
+#         # process_deleted_file(filename) if event == :deleted
+#         update_dashboard
+#       end
+#     end
+#   rescue Exception => e
+#     # TODO: Make style a setting: :message, :short, (whatever the last one is)
+#     log.exception(e, style: :short)
+#   end
+#   # rubocop:enable Lint/RescueException
+
+#   private
+
+#   def boot(boot_file)
+#     clear_screen
+
+#     content = File.read(boot_file)
+#     Object.class_eval(content, boot_file)
+#   end
+
+#   # rubocop:disable Lint/RescueException
+#   def process_updated_file(filename)
+#     clear_screen
+#     update_load_path(filename)
+
+#     puts "File updated: #{filename}"
+#   rescue Exception => e
+#     # TODO: Make style a setting: :message, :short, (whatever the last one is)
+#     log.exception(e, style: :short)
+#   end
+
+#   def process_updated_file_old(filename)
+#     clear_screen
+#     update_load_path(filename)
+
+#     puts "File updated: #{filename}"
+
+#     content = File.read(filename)
+#     Object.class_eval(content, filename)
+#   rescue Exception => e
+#     # TODO: Make style a setting: :message, :short, (whatever the last one is)
+#     log.exception(e, style: :short)
+#   end
+#   # rubocop:enable Lint/RescueException
+
+#   def update_dashboard
+#     dashboard = KManager::Overview::Dashboard.new(KManager.manager)
+#     dashboard.areas
+#     dashboard.resources
+#     dashboard.documents
+#   end
+
+#   def update_load_path(filename)
+#     dirname = File.dirname(filename)
+
+#     # This needs to be in detailed logging
+#     $LOAD_PATH.unshift(dirname) unless $LOAD_PATH.find { |path| path.start_with?(dirname) }
+#   end
+
+#   def clear_screen
+#     puts "\n" * 70
+#     $stdout.clear_screen
+#   end
+# end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: k_manager
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.22
 platform: ruby
 authors:
 - David Cruwys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta5
 - !ruby/object:Gem::Dependency
   name: k_builder
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: k_fileset
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.0
 - !ruby/object:Gem::Dependency
   name: k_log
   requirement: !ruby/object:Gem::Requirement
@@ -70,7 +112,8 @@ description: "    K Manager provides a managed host for documents, resources and
   generator execution\n"
 email:
 - david@ideasmen.com.au
-executables: []
+executables:
+- k_manager
 extensions: []
 extra_rdoc_files: []
 files:
@@ -78,8 +121,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- Assessment1.md
-- Assessment2.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -94,39 +135,44 @@ files:
 - bin/kgitsync
 - bin/khotfix
 - bin/setup
+- docs/flow.drawio
+- exe/k_manager
 - hooks/pre-commit
 - hooks/update-version
 - k_manager.gemspec
 - lib/k_manager.rb
+- lib/k_manager/area.rb
 - lib/k_manager/configuration/project_config.rb
-- lib/k_manager/create_document.rb
-- lib/k_manager/documents/basic_document.rb
-- lib/k_manager/documents/builder_document.rb
-- lib/k_manager/documents/document_taggable.rb
-- lib/k_manager/documents/model_document.rb
-- lib/k_manager/project.rb
+- lib/k_manager/document_factory.rb
+- lib/k_manager/manager.rb
+- lib/k_manager/overview/dashboard.rb
+- lib/k_manager/overview/dump_json.rb
+- lib/k_manager/overview/models.rb
+- lib/k_manager/overview/queries.rb
 - lib/k_manager/resources/base_resource.rb
-- lib/k_manager/resources/csv_file_resource.rb
-- lib/k_manager/resources/factories/document_factory.rb
 - lib/k_manager/resources/factories/ruby_document_factory.rb
 - lib/k_manager/resources/file_resource.rb
-- lib/k_manager/resources/json_file_resource.rb
-- lib/k_manager/resources/ruby_file_resource.rb
-- lib/k_manager/resources/unknown_file_resource.rb
+- lib/k_manager/resources/file_resources/ruby_file_resource.rb
+- lib/k_manager/resources/file_resources/unknown_file_resource.rb
+- lib/k_manager/resources/mem_resource.rb
+- lib/k_manager/resources/resource_document_factory.rb
+- lib/k_manager/resources/resource_factory.rb
+- lib/k_manager/resources/resource_manager.rb
+- lib/k_manager/resources/resource_set.rb
+- lib/k_manager/resources/web_resource.rb
 - lib/k_manager/resources/x_resource.rb
-- lib/k_manager/resources/yaml_file_resource.rb
 - lib/k_manager/version.rb
-- lib/k_manager/x_project.rb
-- lib/k_manager/x_project_manager.rb
-- lib/k_manager/x_register.rb
+- lib/k_manager/watcher.rb
 - lib/k_manager/x_resource_documents/resource_document.rb
+- lib/k_manager/x_resource_documents/x_project.rb
+- lib/k_manager/x_resource_documents/x_project_manager.rb
+- lib/k_manager/x_resource_documents/x_register.rb
+- tasks/watch.rake
 homepage: http://appydave.com/gems/k-manager
 licenses:
 - MIT
 metadata:
-  homepage_uri: http://appydave.com/gems/k-manager
-  source_code_uri: https://github.com/klueless-io/k_manager
-  changelog_uri: https://github.com/klueless-io/k_manager/commits/master
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -142,7 +188,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 Manager provides a managed host for documents, resources and code generator

data/Assessment1.md

@@ -1,127 +0,0 @@
-1. Business modelling tools and Technical modelling tools
-
-Technical modelling tools 
-ERD
- 
-- Entity Relationship Diagram used for Databases
-
-Tools: Gliffy, Lucid Charts,   
-
-2. Software development methodologies  
-- Agile/  
-- Waterflow  
-- RAD 
-- Extreme XP 
-- Feature Driven  
-- Scrum
-
-3. Application architecture diagram
-- N-Tier (Layered) vs - Microservices
-- Application Architecture Diagram
-- Integration Architecture Diagram
-- Deployment Architecture Diagram
-- DevOps Architecture Diagram
-- Data Architecture Diagram
-
-4. Software risk analysis
-- Estimates, Scope Creep, Stake holder expectations, Low Stake holder engagement,  
-- Requirements / Use Cases
--  Abuse or security analysis  
-- Unproven Technology  
-- Choice of Infrustruction
- 
-- Cloud, Server/On-Premise/Integrations
-- UX Design
- 
-- Framwork, Accesibility
-- Risk analysis
- 
-- Code Quality
- 
-- Anti Patterns,
- 
-- Poor Architecture
-- Test Design
- 
-- Data edge cases
-- Static Analysis tools
- 
-- Linters
-- Pen Testing
-  
-5. Database diagram processes and steps
-- ERD
-- Conceptual model   
-- Purpose of database     
-   - Monolith vs Microservice     
-- Relational, Object/JSON/NoSql Store, Key/Value Store, Event Sourced
-6. Design database process and steps  
-- Normalized tables     
-	- Entities     
-	- Attributes  
-	- Relationships, (1-1, 1-m, m-m)     
-	  - Define cardinality, maximum number of values
-	  - Define ordinality, minimum number of values     
-	  - Lhs can be zero or one or many     
-	  - Rhs can be zero, one or many       
-	  - Referential integrity, constraints, indexes
-7. Implement database database processes and steps  
-- DDL  
-	- create database  
-	- create table     
-		- primary key     
-		- attributes  
-		- create index and constraints  
-		- create foreign key references  
-		- create views   
-8. Principles of database-management systems.  
-
-- Shared collection of related data  
-- Data Modeling  
-- Data Storage    
-- Structured Data    
-- Unstructured Data  
-- Transactions (Local or Distributed)  
-- Referential Integrity  
-- Cardinatlity/Ordinality  
-- Distributed Data  
-- Data Warehouses / Big Data  
-- Relational, Object/JSON Store, Key/Value Stores, Event Sourced
-
-9. Object-oriented programming concepts 
-- Encapsulation, Inheritance, Abstraction, Polymorphism
-
-10. Characteristics of a programming language (C#) 
-- Object Oriented 
-- Memory Management 
-- Garbage Collection 
-- Type Safe 
-- Compiled to Byte Code 
-- Cross Platform  
-11. Open-source development tools and platforms 
-- Git Hub 
-- VSCode 
-- Bootstrap, Material, Tailwind CSS 
-- Angular, React, Vue   
-12. Input and output requirements & examples 
-- Input   
-- Console, Terminal, Browser, Ports, Devices - 
-Output   - Console, Screen, Printer, Devices (3D Printer, Robot), Ports (Database, Message Queue)
-13. Testing techniques 
-- Unit Testing 
-- Integration Test 
-- Regression Testing 
-- Penn Testing 
-- User Acceptance Testing  
-14. Computer hardware & why it is important in soft dev
- 
-- PC, Mac, Embedded Device, IOT, Mobile (Android, IOS, Tablets) 
-- Operating systems, Kernals, VM's and Dockerization 
-- Provides both a physical devices  and virtual environments on which to run applications  
-15. Computer networking components & why it is important in soft dev 
-- Allows for distributed computing 
-- Scalable databases 
-- Scalable services 
-- Provides redundancy and resilience. 
-- Provides external backup stores
-

data/Assessment2.md

@@ -1,88 +0,0 @@
-# Assessment
-
-Validate Software
-
-ICPTPRG520 Validate an application design against specifications
-
-## PART 1
-
-1. Develop a proof of concept
-2. Present the prototype system
-3. Perform design and code validation
-4. Document and report validation results
-
-A. Determine the procedures and tools required to perform
-
-* Software requirements validation
-* Database validation
-* Software design validation
-* Source code validation
-* User Interface (UI) validation
-* Test validation
-
-B. Now it is time to design and build a prototype.
-1. Identify a prototyping tool to develop proof of concept
-2. Identify the use cases from the software requirements.
-3. Develop a prototype using the selected tool.
-
-C. Save your word-processed document as VDP_Part1
-
-## PART 2
-
-10-15 minutes to present your prototype
-
-Role Play Participants:
-  Client and Developer.
-
-1. Identify each use case requirements that you need to fulfil
-2. Confirm the completeness and correctness of the requirements using appropriate questioning and listening techniques.
-3. Demonstrate the prototype (from Part 1) to the client and determine whether any further refinements need to be made.
-4. Record the outcome of the presentation and any changes required in a document.
-
-## PART 3
-
-Now you have implement selected use cases, its time for you to validate it.
-
-Record your validation details
-- Date
-- Name
-- Procedures
-- Results (including screen shots)
-
-1. Validate the software design to ensure the design is complete, accurate and feasible.
-   1. Include diagrams, class, erd, activity, seq, flow etc...
-2. Validate the database structure and elements, inluding screenshots
-3. Validate the UI design
-4. Validate the software code for consistency and analysis of the code using 2 static analysis tools (c# and web). Include screen shots
-
-## PART 4
-
-Document and report validation results
-See: Original document for this.
-
-### Application Requirements
-
-Sydney club needs a simple membership system.
-
-System should allow club employees to enter member details.
-
-Future: Guests can sign-up and manage their membership online via the clubs website and via mobile app.
-
-## Database
-
-### Users
-
-The users table will hold a list of employees who can add new members to the system.
-
-* email - Valid email that acts as a unique user name
-* password - hashed value that holds the users password
-
-### Members
-
-Members table will store member details
-
-* First name
-* Last name
-* Phone number
-* Date of Birth
-  

data/lib/k_manager/create_document.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module KManager
-  module CreateDocument
-    def model(key = nil, **opts)
-      opts = { key: key }.merge(opts) unless key.nil?
-      document = new_document(KManager::Documents::ModelDocument, **opts)
-
-      attach_to_resource(document, change_resource_type: :dsl)
-    end
-
-    def attach_to_resource(document, change_resource_type: :dsl)
-      KManager.target_resource&.attach_document(document, change_resource_type: :dsl)
-      document
-    end
-
-    # Create an instance of a document
-    #
-    # @param [Class<DocumentTaggable>] klass type of document to create
-    def new_document(klass, **opts)
-      key = KManager.target_resource.documents.length.zero? ? KManager.target_resource.infer_key : nil
-
-      opts = {
-        resource: KManager.target_resource,
-        key: key
-      }.merge(opts)
-
-      klass.new(**opts)
-    end
-  end
-end

data/lib/k_manager/documents/basic_document.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module KManager
-  module Documents
-    # A basic document stores a simple data object with tags for
-    # unique key, type, namespace and project.
-    class BasicDocument < KDoc::Container
-      include KLog::Logging
-      include KManager::Documents::DocumentTaggable
-
-      def initialize(**opts)
-        super(**opts)
-        initialize_document_tags(**opts)
-      end
-
-      def default_document_type
-        :basic
-      end
-    end
-  end
-end

data/lib/k_manager/documents/builder_document.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module KManager
-  module Documents
-    class BuilderDocument
-      include KLog::Logging
-      include KManager::Documents::DocumentTaggable
-
-      def initialize(**opts)
-        initialize_document_tags(**opts)
-      end
-
-      # def default_document_type
-      #   nil
-      # end
-    end
-  end
-end

data/lib/k_manager/documents/document_taggable.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-module KManager
-  module Documents
-    # Tag a document with attributes that can be used to uniquely identify
-    # a document within a project or namespace
-    #
-    # Examples:
-    #   User DSL could be tagged user_entity
-    #   Blue print DSL for building a data layer User could be tagged user_blueprint
-    #   Users.csv file could be tagged data_files_users_csv
-    #   Account DSL in the CRM project could be tagged crm_account_entity
-    #   AccountController DSL in the CRM project could be tagged crm_controllers_account_controller
-    module DocumentTaggable
-      # Name of the document (required)
-      #
-      # Examples: user, account, country
-      attr_reader :key
-
-      # Type of document (optional, but will set to :default_document_type if not provided)
-      #
-      # Examples by data type
-      #   :csv, :yaml, :json, :xml
-      #
-      # Examples by shape of the data in a DSL
-      #   :entity, :microapp, blueprint
-      attr_reader :type
-
-      # Namespace of the document (optional, '' if not set)
-      #
-      # When using a data file, this should be based on the relative file path
-      # When using a DSL data file, this will be manually configured
-      attr_reader :namespace
-
-      # Resource that this document belongs to (optional)
-      attr_accessor :resource
-
-      # Project that this document belongs to (optional)
-      attr_reader :project
-
-      # Project key is inferred from the attached project ('' if project not set)
-      attr_reader :project_key
-
-      # Errors in documents can be stored against the document
-      #
-      # This helps debugging invalid DSL's and data documents
-      attr_reader :error
-
-      def initialize_document_tags(**opts)
-        @key = opts[:key] || SecureRandom.alphanumeric(4)
-        @type = opts[:type] || default_document_type
-        @namespace = opts[:namespace] || ''
-        @resource = opts[:resource]
-        @project = @resource&.project
-        @project_key = project&.infer_key
-      end
-
-      # This method should be implemented on the document class
-      # generally it will return a :symbol
-      # def default_document_type; end;
-
-      # The unique key on resources provides a way to prevent conflicts
-      # between resource names, resource types, local namespaces and projects.
-      def unique_key
-        return @unique_key if defined? @unique_key
-
-        @unique_key = begin
-          raise KDoc::Error, 'key is required when generating unique key' if key.nil? || key.empty?
-
-          [project_key, namespace, key, type]
-            .reject { |k| k.nil? || k == '' }
-            .map { |k| k.to_s.gsub('_', '-') }
-            .join('-')
-        end
-      end
-
-      # rubocop:disable Metrics/AbcSize
-      def debug
-        log.section_heading(self.class.name)
-
-        log.kv 'unique_key'   , unique_key  , 15
-        log.kv 'key'          , key         , 15
-        log.kv 'type'         , type        , 15
-        log.kv 'namespace'    , namespace   , 15
-        # log.kv 'resource'     , resource    , 15
-        # log.kv 'project'      , project     , 15
-        log.kv 'project_key'  , project_key , 15
-        log.kv 'data'         , data.nil? ? '' : data.to_s[0..100].gsub("\n", '\n'), 15
-        log.kv 'error'        , error       , 15
-      end
-      # rubocop:enable Metrics/AbcSize
-    end
-  end
-end

data/lib/k_manager/documents/model_document.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module KManager
-  module Documents
-    class ModelDocument < KDoc::Model
-      include KLog::Logging
-      include KManager::Documents::DocumentTaggable
-
-      def initialize(**opts)
-        super(**opts)
-        initialize_document_tags(**opts)
-      end
-
-      def default_document_type
-        KDoc.opinion.default_model_type
-      end
-    end
-  end
-end