k_starter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eb17485410dc901622fc6b41024dc456c613f94e21028881628b7c01c963e78
-  data.tar.gz: dc5709020a431b183bfe08b26adaf6d169b327c9c07444eb1b9a5feeb6cc2386
+  metadata.gz: e2b29b568199352177ac17f32f961648755203d693458e2123d0742000000b25
+  data.tar.gz: 2a9bc72d4fbff3184fceb7fe8f5a67c81995234c7fa621d43f01f3da0462ca4d
 SHA512:
-  metadata.gz: 5e4e00f4c6df24ea40a7799e1d86a5f3e5da6eccd401931e3da76402fd7d7a7f1a6fa6f42a07462668357df1ec5e9a2b81bf9d5b641db55b2de61a76538bb392
-  data.tar.gz: 8c7adf0f2ff3956503073f265e96c13b95a3a2cfc8c84c540e161e09f65ece9e08be1a5293f41f0b18e7474efbd1f483c64ebad209ca13560f542bc209326101
+  metadata.gz: 48c1f36ae28241ce8c498f49e92e03c4fb876682f5191e7a506d70de397d53e7e9ae59da60a0056ca38bd79884b15ec9a8906e076c4a0361dae67fe562ad4707
+  data.tar.gz: dd22b27ff1b530f3513b0a4ca4aea1ab080f9587ca13c0f0b91482b2c12d95b43172b59125d188c0d2160a3acdfcc21bacaf2668f82ded9d505d0e8f8ef588f1

data/.builders/generators/01-bootstrap.rb

@@ -70,38 +70,38 @@ KManager.action :bootstrap do
         run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
       end
       .blueprint(
-        active: false,
+        active: true,
         name: :opinionated,
         description: 'opinionated GEM files',
         on_exist: :write) do
 
         cd(:app)
 
-        add('bin/setup')
-        add('bin/console')
+        # add('bin/setup')
+        # add('bin/console')
 
-        add("lib/#{typed_dom.application}.rb"             , template_file: 'lib/applet_name.rb'         , dom: dom)
-        add("lib/#{typed_dom.application}/version.rb"     , template_file: 'lib/applet_name/version.rb' , dom: dom)
+        # add("lib/#{typed_dom.application}.rb"             , template_file: 'lib/applet_name.rb'         , dom: dom)
+        # add("lib/#{typed_dom.application}/version.rb"     , template_file: 'lib/applet_name/version.rb' , dom: dom)
     
-        add('spec/spec_helper.rb')
-        add("spec/#{typed_dom.application}_spec.rb"       , template_file: 'spec/applet_name_spec.rb', dom: dom)
+        # add('spec/spec_helper.rb')
+        # add("spec/#{typed_dom.application}_spec.rb"       , template_file: 'spec/applet_name_spec.rb', dom: dom)
 
         add("#{typed_dom.application}.gemspec"            , template_file: 'applet_name.gemspec', dom: dom)
-        add('Gemfile', dom: dom)
-        add('Guardfile', dom: dom)
-        add('Rakefile', dom: dom)
-        add('.rspec', dom: dom)
-        add('.rubocop.yml', dom: dom)
+        # add('Gemfile', dom: dom)
+        # add('Guardfile', dom: dom)
+        # add('Rakefile', dom: dom)
+        # add('.rspec', dom: dom)
+        # add('.rubocop.yml', dom: dom)
         add('README.md', dom: dom)
-        add('CODE_OF_CONDUCT.md', dom: dom)
-        add('LICENSE.txt', dom: dom)
+        # add('CODE_OF_CONDUCT.md', dom: dom)
+        # add('LICENSE.txt', dom: dom)
 
-        run_command("rubocop -a")
+        # run_command("rubocop -a")
       
         run_command("git add .; git commit -m 'chore: #{self.options.description.downcase}'; git push")
       end
       .blueprint(
-        active: true,
+        active: false,
         name: :ci_cd,
         description: 'github actions (CI/CD)',
         on_exist: :write) do

data/.rubocop.yml

@@ -11,6 +11,20 @@ AllCops:
     - ".builders/**/*"
     - "spec/samples/**/*"
 
+Metrics/AbcSize:
+  Exclude:
+    - "lib/**/questions/**/*"
+    - "lib/**/commands/**/*"
+    - "lib/**/r7_hotwire.rb"
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - "lib/**/r7_hotwire.rb"
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - "lib/**/r7_hotwire.rb"
+
 Metrics/BlockLength:
   Exclude:
     - "**/spec/**/*"

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [0.1.0](https://github.com/klueless-io/k_starter/compare/v0.0.1...v0.1.0) (2022-06-30)
+
+
+### Features
+
+* k_starter gem setup ([b71905a](https://github.com/klueless-io/k_starter/commit/b71905a95b7aafa581e460d790ad0714fa114639))
+
 ## [Unreleased]
 
 ## [0.1.0] - 2022-06-30

data/Gemfile

@@ -19,3 +19,25 @@ end
 group :test do
   gem 'simplecov', require: false
 end
+
+if ENV['KLUE_LOCAL_GEMS']&.to_s&.downcase == 'true'
+  group :development, :test do
+    puts 'Using Local GEMs'
+    gem 'handlebars-helpers'      , path: '../../kgems/handlebars-helpers'
+    gem 'k_builder'               , path: '../../kgems/k_builder'
+    gem 'k_builder-dotnet'        , path: '../../kgems/k_builder-dotnet'
+    gem 'k_builder-webpack5'      , path: '../../kgems/k_builder-webpack5'
+    gem 'k_config'                , path: '../../kgems/k_config'
+    gem 'k_decor'                 , path: '../../kgems/k_decor'
+    gem 'k_director'              , path: '../../kgems/k_director'
+    gem 'k_doc'                   , path: '../../kgems/k_doc'
+    gem 'k_domain'                , path: '../../kgems/k_domain'
+    gem 'k_ext-github'            , path: '../../kgems/k_ext-github'
+    gem 'k_fileset'               , path: '../../kgems/k_fileset'
+    gem 'k_log'                   , path: '../../kgems/k_log'
+    gem 'k_manager'               , path: '../../kgems/k_manager'
+    gem 'k_type'                  , path: '../../kgems/k_type'
+    gem 'k_util'                  , path: '../../kgems/k_util'
+    gem 'peeky'                   , path: '../../kgems/peeky'
+  end
+end

data/README.md

@@ -42,7 +42,7 @@ See all [usage examples](./USAGE.md)
 Checkout the repo
 
 ```bash
-git clone 
+git clone https://github.com/klueless-io/k_starter
 ```
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 

data/exe/k_starter

@@ -1,4 +1,19 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
 require 'k_starter'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  KStarter::CLI.start
+rescue KStarter::CLI::Error => e
+  puts "ERROR: #{e.message}"
+  exit 1
+end

data/ext/k_starter/extconf.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+create_makefile('k_starter/k_starter')

data/ext/k_starter/k_starter.c

@@ -0,0 +1,9 @@
+#include "k_starter.h"
+
+VALUE rb_mKStarter;
+
+void
+Init_k_starter(void)
+{
+  rb_mKStarter = rb_define_module("KStarter");
+}

data/ext/k_starter/k_starter.h

@@ -0,0 +1,6 @@
+#ifndef K_STARTER_H
+#define K_STARTER_H 1
+
+#include "ruby.h"
+
+#endif /* k_starter_H */

data/lib/k_starter/app.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module KStarter
+  # Handle the global access such as configuration, project data
+  class App
+    class << self
+      def config
+        @config ||= KStarter::Database::ConfigModel.new
+      end
+
+      def project
+        @project ||= KStarter::Database::ProjectModel.new
+      end
+    end
+  end
+end

data/lib/k_starter/app_generator.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+# require 'uri'
+# require 'net/http'
+# require 'active_model'
+require 'pry'
+
+# see: https://guides.rubyonrails.org/rails_application_templates.html
+
+module KStarter
+  class AppGenerator < Rails::Generators::AppGenerator
+    # attr_reader :host
+
+    #   attr_accessor :include_action_text
+    #   alias_method :action_text?, :include_action_text
+
+    #   attr_accessor :include_active_storage
+    #   alias_method :active_storage?, :include_active_storage
+
+    #   attr_accessor :include_sample_models
+    #   alias_method :sample_models?, :include_sample_models
+
+    #   attr_accessor :include_javascript_libraries
+    #   alias_method :javascript_libraries?, :include_javascript_libraries
+
+    #   attr_accessor :include_devise
+    #   alias_method :devise?, :include_devise
+
+    #   attr_accessor :include_rspec
+    #   alias_method :rspec?, :include_rspec
+
+    #   attr_accessor :include_common_pages
+    #   alias_method :common_pages?, :include_common_pages
+
+    #   attr_accessor :run_db_migrate
+    #   alias_method :db_migrate?, :run_db_migrate
+
+    # *args
+    # def initialize([temp_folder], opts)
+    #   @host = host
+    # end
+
+    #   private
+
+    #   def gac(message)
+    #     host.git add: "."
+    #     host.git commit: " -m '#{message}'"
+    #   end
+
+    #   def add_action_text
+    #     # see: https://youtube.com/clip/UgkxzZBvcxkIX9zvWTi21KEJSTDMlC25LY0y
+    #     rails_command "action_text:install"
+    #   end
+
+    #   def add_active_storage
+    #     rails_command "active_storage:install"
+    #   end
+
+    #   def add_devise
+    #     # run('bundle add devise')
+    #     # Bundler.with_unbundled_env do
+    #     #   run 'bundle install'
+    #     #   rails_command("devise:install")
+    #     # end
+    #     rails_command("devise:install")
+    #     # run("bundle install")
+    #   end
+
+    #   def add_gems
+    #     gem 'devise'                            if devise?
+    #     # gem 'friendly_id'           if
+    #     # gem 'sidekiq'               if
+    #     # gem 'name_of_person'        if
+    #     # gem 'cssbundling-rails'
+    #     # gem 'pay'                   if
+    #     # gem 'stripe'                if
+    #   end
+
+    #   def add_gem_groups
+    #     is_rspec = rspec?
+    #     host.gem_group :development, :test do
+    #       gem "rspec-rails"                     if is_rspec
+    #     end
+    #   end
+
+    #   # def add_gems
+    #   #   gem 'devise', '~> 4.8'
+    #   #   gem 'friendly_id', '~> 5.4', '>= 5.4.2'
+    #   #   gem 'sidekiq', '~> 6.3', '>= 6.3.1'
+    #   #   gem 'name_of_person', '~> 1.1', '>= 1.1.1'
+    #   #   gem 'cssbundling-rails'
+    #   #   gem 'pay', '~> 3.0' # https://github.com/pay-rails/
+    #   #   gem 'stripe', '>= 2.8', '< 6.0' # I prefer Stripe but you can opt for braintree or paddle too. https://github.com/pay-rails/pay/blob/master/docs/1_installation.md#gemfile
+    #   # end
+
+    #   def add_rspec
+    #     host.generate("rspec:install")
+    #   end
+
+    #   def bundle_add(name)
+    #     host.run("bundle add #{name}")
+    #   end
+
+    #   # Generate - Controller, model, and view
+    #   def g_scaffold(name, *args)
+    #     host.generate(:scaffold, name, *args)
+    #   end
+
+    #   # Generate - Controller and model
+    #   def g_resource(name, *args)
+    #     host.generate(:resource, name, *args)
+    #   end
+
+    #   # Generate - Mailer for sending emails
+    #   def g_mailer(name, *args)
+    #     # see: https://youtube.com/clip/UgkxV9uIgkL7fbHYWAAN6UiwdS8dFXSO1j5y
+    #     host.generate(:mailer, name, *args)
+    #   end
+
+    # #   ```bash
+    # # rm -rf kweb02-tailwind && rails new kweb02-tailwind --minimal
+    # # --javascript esbuild --css tailwind
+    # # ```
+
+    #   def g_controller(name, *args)
+    #     host.generate(:controller, name, *args)
+    #   end
+
+    #   def alter_first_file(glob, &block)
+    #     file = Dir[glob].first
+    #     instance_exec(file, &block)
+    #     # yield(file) if file
+    #   end
+
+    #   def add_environment(value, env: 'development')
+    #     # injects value into corresponding config/environment file.
+    #     host.environment(value, env: env)
+    #   end
+
+    #   def add_file(path, content)
+    #     host.file(path, content)
+    #   end
+
+    #   # env: 'production'
+    #   # sudo: true
+    #   # abort_on_failure: true
+    #   def rails_command(command, **args)
+    #     host.rails_command(command, **args)
+    #   end
+
+    #   def run(command)
+    #     host.run(command)
+    #   end
+
+    #   def yes?(question, default: true)
+    #     # see: https://github.com/rails/thor/blob/main/lib/thor/shell/basic.rb
+    #     answer = host.ask(question, default: default)
+    #     ActiveModel::Type::Boolean.new.cast(answer)
+    #   end
+
+    #   def no?(question, default: false)
+    #     answer = host.ask(question, default: default)
+    #     ActiveModel::Type::Boolean.new.cast(answer)
+    #   end
+
+    #   def settings_for_asset_management
+    #     # see: https://noelrappin.com/blog/2021/09/rails-7-and-javascript/
+
+    #     # This needs to be handled using command line options at the moment,
+    #     # in future I may call AppGenerator.new directly with these options.
+
+    #     # if you need transpiling then you need to install the esbuild-rails
+    #     # if you don't need transpiling (or node dependencies) then you can use importmap-rails
+    #     # see: https://d31d9mzh2cw851.cloudfront.net/wp-content/uploads/2022/02/10014354/Do-I-need-Importmap-FINAL2.jpg
+
+    #     # if using javascript bundling then you can use:
+    #     #   webpack (old/bad)
+    #     #   esbuild (new/good)
+    #     #   rollup (good)
+    #     #
+    #     #   use this if you are working with react or vue:
+    #     #   is a single page app
+
+    #     # alternative: importmap-rails does not do mapping and has a one to one relationship between files and browser
+    #     #   use this if you are working with hotwire (turbo/stimulas)
+    #     #   feels like a single page app, but using dynamic server side
+
+    #     # css bundling (investigate cssbundling-rails)
+
+    #     # hotwire: hotwire-rails
+
+    #     # Use importmap if you are not using much JS, you’ll get a great developer experience
+    #     # at the cost of some limited interaction with the JS world.
+
+    #     # Use one of the jsbundler tools if you want more interaction with the JS world.
+    #   end
+  end
+end

data/lib/k_starter/cli.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module KStarter
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc 'version', 'k_starter version'
+    def version
+      require_relative 'version'
+      puts "v#{KStarter::VERSION}"
+    end
+    map %w[--version -v] => :version
+
+    #
+    # config
+    #
+    # desc 'config KEYVALUE', 'Config description'
+    # method_option :help, aliases: '-h',
+    #                      type: :boolean,
+    #                      desc: 'Display usage information'
+    # def config(key, value)
+    #   if options[:help]
+    #     invoke :help, ['config']
+    #   else
+    #     KStarter::Commands::Configuration::Menu.new(key, value, options).execute
+    #   end
+    # end
+
+    #
+    # configuration
+    #
+    desc 'configuration SUBCOMMAND', 'Manage configuration'
+    method_option :help, aliases: '-h',
+                         type: :boolean,
+                         desc: 'Display usage information'
+    def configuration(subcommand = :menu)
+      if options[:help]
+        invoke :help, ['configuration']
+      else
+        KStarter::Commands::ConfigurationMenu.new(subcommand, options).execute
+      end
+    end
+
+    #
+    # project
+    #
+    desc 'project SUBCOMMAND', 'Create or edit project settings or generate new project'
+    def project(subcommand = :menu)
+      if options[:help]
+        invoke :help, ['project']
+      else
+        KStarter::Commands::ProjectMenu.new(subcommand, options).execute
+      end
+    end
+  end
+end

data/lib/k_starter/commands/.keep

@@ -0,0 +1 @@
+

data/lib/k_starter/commands/command.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module KStarter
+  module Commands
+    # Base command class
+    class Command
+      extend Forwardable
+      include TtyHelpers
+
+      def_delegators :command, :run
+
+      attr_reader :escape_pressed
+
+      # Execute this command
+      #
+      # @api public
+      def execute(*)
+        raise(
+          NotImplementedError,
+          "#{self.class}##{__method__} must be implemented"
+        )
+      end
+
+      def ask_questions(form_type, form_variant = nil, **data)
+        KStarter::Questions::AskQuestions.for(form_type, form_variant, **data)
+      end
+
+      def display_exiting_projects
+        columns = %w[Name Type Path Description]
+        rows = App.project.project_list.map do |project|
+          [
+            project.name,
+            project.type,
+            project.variant,
+            project.root_path,
+            project.description
+          ]
+        end
+
+        table = TTY::Table.new(columns, rows)
+        puts table.render(:unicode)
+        prompt.warn('-' * 100)
+      end
+
+      def select_project
+        choices = App.project.project_list.map(&:name)
+        name = prompt.select('Select a project?', choices, cycle: true)
+        App.project.find_project(name)
+      end
+    end
+  end
+end

data/lib/k_starter/commands/configuration/configuration_menu.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module KStarter
+  module Commands
+    # Submenu for configuration
+    class ConfigurationMenu < KStarter::Commands::Command
+      def initialize(subcommand, options)
+        @subcommand = (subcommand || '').to_sym
+
+        @options = options
+        super()
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        command = nil
+        case @subcommand
+        when :menu
+          menu
+        when :open_config
+          editor.open(App.config.filename)
+          menu
+        when :open_project
+          editor.open(App.project.filename)
+          menu
+        end
+        command&.execute(input: input, output: output) if command
+      end
+
+      private
+
+      def menu
+        choices = [
+          { name: 'Open configuration JSON', value: :open_config },
+          { name: 'Open project JSON', value: :open_project }
+        ]
+
+        subcommand = prompt.select('Select your subcommand?', choices, per_page: 15, cycle: true)
+
+        command = KStarter::Commands::ConfigurationMenu.new(subcommand, {})
+        command.execute(input: @input, output: @output)
+      rescue KStarter::EscapePressed
+        nil
+      end
+    end
+  end
+end

data/lib/k_starter/commands/project/bootstrap_project.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module KStarter
+  module Commands
+    # Submenu for new
+    class BootstrapProject < KStarter::Commands::Command
+      def initialize(**options)
+        @options = options
+        super()
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        display_exiting_projects
+        project = select_project
+
+        # Is the if project even relevant at the moment?
+        bootstrap_project(project) if project
+      end
+
+      def bootstrap_project(project)
+        puts JSON.pretty_generate(project.to_h)
+
+        starter = KStarter::Map.starter(project)
+        starter.execute
+      end
+    end
+  end
+end

data/lib/k_starter/commands/project/edit_project.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module KStarter
+  module Commands
+    # Submenu for new
+    class EditProject < KStarter::Commands::Command
+      def initialize(**options)
+        @options = options
+        super()
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        display_exiting_projects
+        project = select_project
+
+        # Is the if project even relevant at the moment?
+        edit_project(project) if project
+      end
+
+      def edit_project(project)
+        form_type = project.type.to_sym
+        form_variant = project.variant&.to_sym
+
+        questions = ask_questions(form_type, form_variant, **project.to_h)
+        questions.ask_questions
+
+        puts JSON.pretty_generate(questions.to_h)
+        App.project.save_project(questions)
+      rescue KStarter::EscapePressed
+        prompt.warn 'Exiting without saving'
+      end
+    end
+  end
+end

data/lib/k_starter/commands/project/new_project.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module KStarter
+  module Commands
+    # Command Name goes here
+    class NewProject < KStarter::Commands::Command
+      attr_reader :form_type
+      attr_reader :form_variant
+
+      def initialize(form_type:, form_variant:)
+        @form_type = form_type
+        @form_variant = form_variant
+
+        super()
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        questions = ask_questions(form_type, form_variant)
+        questions.ask_questions
+
+        puts JSON.pretty_generate(questions.to_h)
+        App.project.save_project(questions)
+      rescue KStarter::EscapePressed
+        prompt.warn 'Exiting without saving'
+      end
+    end
+  end
+end