rbcli 0.3.2 → 0.4.0

data/lib/rbcli/version.rb

@@ -1,23 +1,8 @@
+# frozen_string_literal: true
 ##################################################################################
-#     RBCli -- A framework for developing command line applications in Ruby      #
-#     Copyright (C) 2018 Andrew Khoury                                           #
-#                                                                                #
-#     This program is free software: you can redistribute it and/or modify       #
-#     it under the terms of the GNU General Public License as published by       #
-#     the Free Software Foundation, either version 3 of the License, or          #
-#     (at your option) any later version.                                        #
-#                                                                                #
-#     This program is distributed in the hope that it will be useful,            #
-#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
-#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
-#     GNU General Public License for more details.                               #
-#                                                                                #
-#     You should have received a copy of the GNU General Public License          #
-#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
-#                                                                                #
-#     For questions regarding licensing, please contact andrew@blacknex.us       #
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
 ##################################################################################
-
 module Rbcli
-	VERSION = '0.3.2'
-end
+  VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), '../../VERSION'))).chomp.strip
+end

data/lib/rbcli-tool/helpers.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+require 'erb'
+
+module Rbcli
+  module ToolHelpers
+    def self.render_erb src, template_vars
+      ERBRenderer.new(src, template_vars).render
+    end
+
+    def self.cp_file src_file, dest_file, render_erb: true, set_executable: false, template_vars: nil, force: false
+      src = File.expand_path(src_file)
+      dest = File.expand_path(dest_file)
+      if File.exist?(dest) && !force
+        Rbcli.log.info "File #{File.basename(dest)} already exists. Overwrite? (y/N):", "TOOL"
+        answer = gets.chomp
+        answer = { 'y' => true, 'n' => false }[(answer[0] || '').downcase]
+        if answer
+          FileUtils.rm_rf(dest)
+        else
+          Rbcli.log.error "Destination file #{dest} already exists. Please delete it and try again.", "TOOL"
+          return false
+        end
+      end
+      Rbcli.log.info "Generating file " + File.basename(dest) + " ... ", "TOOL"
+      if render_erb
+        File.write(dest, self.render_erb(src, template_vars))
+      else
+        FileUtils.cp(src, dest)
+      end
+      FileUtils.chmod(set_executable ? 0755 : 0644, dest)
+      FileUtils.rm_f(File.join(File.dirname(dest), '.keep')) if File.exist?(File.join(File.dirname(dest), '.keep'))
+      true
+    end
+
+    class ERBRenderer
+      def initialize filename, varlist
+        @filename = filename
+        varlist.each do |k, v|
+          self.instance_variable_set("@#{k.to_s}", v)
+        end
+        @vars = varlist
+      end
+
+      def render_component name, filename = 'template.rb.erb'
+        location = File.join(RBCLI_LIBDIR, 'components', name, filename)
+        ERB.new(File.read(location), trim_mode: '-', eoutvar: '_sub01').result(binding)
+      end
+
+      def render
+        ERB.new(File.read(@filename), trim_mode: '-').result(binding)
+      end
+    end
+  end
+end

data/lib/rbcli-tool/skeletons/gem.rb.erb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+####<%= @appname.gsub(/./,'#') %>####
+### <%= @appname.capitalize %> ###
+####<%= @appname.gsub(/./,'#') %>####
+
+<%- if @development -%>
+require '<%= File.expand_path(File.join(RBCLI_LIBDIR, '..', 'rbcli.rb')) %>'
+<%- else -%>
+require 'rbcli'
+<%- end -%>
+
+require File.join(File.dirname(__FILE__), '..', 'lib', '<%= @appname %>')
+Dir[File.join(File.dirname(__FILE__), '..', 'lib', 'config', '*.rb')].each { |file| require file }
+Dir[File.join(File.dirname(__FILE__), '..', 'lib', 'commands', '*.rb')].each { |file| require file }
+
+Rbcli.go!

data/lib/rbcli-tool/skeletons/portable.rb.erb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+####<%= @appname.gsub(/./,'#') %>####
+### <%= @appname.capitalize %> ###
+####<%= @appname.gsub(/./,'#') %>####
+
+<%- if @development -%>
+require '<%= File.expand_path(File.join(RBCLI_LIBDIR, '..', 'rbcli.rb')) %>'
+<%- elsif @use_bundler -%>
+require 'bundler/inline'
+gemfile do
+  source 'https://rubygems.org'
+  ruby '>= <%= RUBY_VERSION %>'
+  gem 'rbcli', '~> <%= Rbcli::VERSION %>', require: true
+end
+<%- else -%>
+require 'rbcli'
+<%- end -%>
+
+module <%= @appname.capitalize %>
+  VERSION = '0.0.0'
+end
+
+##########################
+## Configuration        ##
+##########################
+
+<%= render_component('parser') %>
+
+<%= render_component('logger') %>
+
+<%= render_component('config') %>
+
+<%= render_component('envvars') %>
+
+<%= render_component('hooks') %>
+
+<%= render_component('updatechecker') %>
+
+##########################
+## Command Declarations ##
+##########################
+
+<%= render_component('commands', 'command.rb.erb') %>
+
+<%= render_component('commands', 'script.rb.erb') %>
+
+Rbcli.go!

data/lib/rbcli.rb

@@ -1,55 +1,24 @@
+# frozen_string_literal: true
 ##################################################################################
-#     RBCli -- A framework for developing command line applications in Ruby      #
-#     Copyright (C) 2018 Andrew Khoury                                           #
-#                                                                                #
-#     This program is free software: you can redistribute it and/or modify       #
-#     it under the terms of the GNU General Public License as published by       #
-#     the Free Software Foundation, either version 3 of the License, or          #
-#     (at your option) any later version.                                        #
-#                                                                                #
-#     This program is distributed in the hope that it will be useful,            #
-#     but WITHOUT ANY WARRANTY; without even the implied warranty of             #
-#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              #
-#     GNU General Public License for more details.                               #
-#                                                                                #
-#     You should have received a copy of the GNU General Public License          #
-#     along with this program.  If not, see <https://www.gnu.org/licenses/>.     #
-#                                                                                #
-#     For questions regarding licensing, please contact andrew@blacknex.us       #
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
 ##################################################################################
+RBCLI_LIBDIR = File.join(File.expand_path(File.dirname(__FILE__)), 'rbcli')
+RBCLI_TOOLDIR = File.join(File.expand_path(File.dirname(__FILE__)), 'rbcli-tool')
+EXECUTABLE = File.basename($0).gsub(/\.[^.]+$/, '')
 
-###########
-## RBCLI ##
-###########
-#
-# This file loads the Rbcli systems.
-#
-# Utils and Prereqs must be loaded first.
-#
-###########
+# Prerequisites for anything else to run
+require_relative "rbcli/version"
+require 'colorize'
+Dir[File.join(RBCLI_LIBDIR, 'util', '*.rb')].each { |file| require file }
 
-lib = File.expand_path('../../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# Core framework
+require File.join(RBCLI_LIBDIR, 'components', 'logger', 'logger.rb')
+require File.join(RBCLI_LIBDIR, 'components', 'core', 'engine.rb')
+require File.join(RBCLI_LIBDIR, 'components', 'core', 'warehouse.rb')
+require File.join(RBCLI_LIBDIR, 'components', 'parser', 'parser.rb')
+require File.join(RBCLI_LIBDIR, 'components', 'config', 'config.rb')
+require File.join(RBCLI_LIBDIR, 'components', 'commands', 'command.rb')
 
-module Rbcli end # Empty module declaration required to declare submodules freely
-require 'rbcli/version'
-
-# UTILS
-require 'rbcli/util/hash_deep_symbolize'
-require 'rbcli/util/deprecation_warning'
-require 'rbcli/util/msg'
-#require 'rbcli/util/string_colorize' # We are using the colorize gem instead. The code is kept here for reference.
-# END UTILS
-
-# BASE PREREQS
-require 'rbcli/features/userconfig'
-require 'rbcli/features/logging'
-# END BASE PREREQS
-
-# CORE
-require 'rbcli/state_storage/placeholders'
-require 'rbcli/configuration/configurate'
-require 'rbcli/engine/load_project'
-require 'rbcli/engine/command'
-require 'rbcli/engine/parser'
-# END CORE
+# The Rbcli Interface
+require File.join(RBCLI_LIBDIR, 'components', 'core', 'configurate')

data/sig/rbcli.rbs

@@ -0,0 +1,9 @@
+##################################################################################
+#     Rbcli -- A framework for developing command line applications in Ruby      #
+#     Copyright (C) 2024 Andrew Khoury <akhoury@live.com>                        #
+##################################################################################
+module Rbcli
+  VERSION: String
+
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end