squared 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7942c4e6f2ca9177fbca4e9a5400982c4a6c5431c04e3f4ed2c80f8d47408cf8
-  data.tar.gz: 8bf51312a2ecbe75a54c1d584a336fb4729b89db9be305259a8fc076bc7b7488
+  metadata.gz: 447c24bc317440fcf3f5b8e8c8f542f5e8f7641e3b548c5ee0204ba948460881
+  data.tar.gz: 1f048b1de055cd375e9e50f18361ef61a26c87602bb56a5f40245951faf05358
 SHA512:
-  metadata.gz: d3156775e41dd2eaba6609631b37111d4d52f979ec7f14f456f0e05b3d43b481a0880fdf2552ba557d4e70594af541fec4564e990b701b11146c3dfd5f25ef92
-  data.tar.gz: 9b63ad8b38308c35557961061c5e89fd787bd0b7db094443464aa8f27e3eee661fc3031d297556e896f9cc9404df7a327e5b198ae6f81fe45b5f22b579bb7756
+  metadata.gz: bf73faecb83832adfa1cbb21212939a93cc2fa133c4a13d24f008eb432cbc663a198294a944b35449921902fa3045cfa581839e52bea6723703c95772e537e05
+  data.tar.gz: a9db1c7dfd58750be1285fb1c2b39f9c087a3488560c6c2d35eb77939f69753127b2d97121450c5409f8b0c7b7fd821cd722291d57cabc0c5a7930f50ae338fb

data/CHANGELOG.md

@@ -1,13 +1,70 @@
 # Changelog
 
-## [0.1.4] - 2024-02-05
+## [0.2.0] - 2025-01-07
+
+### Added
+
+- Event system when executing a base or extension command.
+- Git extension module with clone command was created.
+- Missing workspace projects can create generation tasks.
+- Node copies over symlinks when global store is detected.
+- Git command rebase was implemented.
+- Ruby command copy uses resolve_feature_path for autodetect.
+- Task descriptions can be transformed using Regexp.
+- Python command outdated is SemVer stylized.
+- Config viewer can pre-parse and autoload file types.
+- Projects can use dependency injection to create tasks.
+- Config viewer can load multiple files of the same type.
+- Unused Project class sub-tasks can be excluded.
+- Project method property version was created.
+- Git pull and fetch action remote can include refspec.
+- Project dependency graph displays version when printed.
+- Git command diff actions between and contain were implemented.
+- Event system was appled to all git commands.
+- Python command depend with Distutils was implemented.
+- Full executable path to programs can be defined in Common.
+- Banners can be hidden by group or reference.
+- Git command reset action patch was implemented.
+- Git command branch was implemented.
+- Project build graph can be created using group or reference.
+- Git command restore action source was implemented.
+- Gem install and update non-deprecated options are fully complete.
+- Pip install options are fully complete.
+- Node command bump action version was implemented.
+- Node command add was implemented. 
+- Python command install can use single character options.
+- Gem install and pristine options are fully complete.
+- Gem command outdated was implemented.
+- Git command checkout action track was implemented.
+- Theme style current used with outdated was created.
+
+### Changed
+
+- Task description uses a separate Application method.
+- Project populate method base commands can be removed.
+- Git pull and fetch options were revised.
+- Git show actions were reduced to format and oneline.
+- Common module System copy methods were renamed.
+- Unused task arguments as placeholders were removed.
+- Top-level namespaces are not used for standard gems.
+- Task descriptions use a wrapper when calling Rake method.
+- Git pull and fetch actions were reduced to origin and remote.
+- Series class uses delegation for Application instance methods.
+- Global constant alias to module Common was removed.
+- Config viewer delegates task attributes to Project workspace.
+- Global git commands pull-s and rebase-s were renamed using +s.
+- Ruby command gem using pristine was implemented.
+- Git class methods were given same name as command name.
+- Abbreviated command options are no longer supported.
+- Git commit hash uses string interpolation format.
+- Git options ending with "!" use conventional "no-" prefix.
+- Git pull and reset commands were reduced.
 
 ### Fixed
 
-- Build options with array args were not recognized.
-- Base clean command did not enumerate non-string values.
-- Git command refs did not include ref option.
-- Pip upgrade did not append package names.
+- Workspace did not locate root folder when main was named.
+- Node tasks without any action are not displayed.
+- Git fetch commands that do not apply to pull are rejected.
 
 ## [0.1.3] - 2024-01-02
 
@@ -38,7 +95,7 @@
 - Workspace did not check base project for Windows filename.
 - Regexp for SemVer did not recognize package names.
 
-## [0.1.1] - 2024-12-14
+## [0.1.1] - 2025-12-14
 
 ### Added
 
@@ -88,7 +145,7 @@
 
 - Changelog was created.
 
-[0.1.4]: https://github.com/anpham6/squared/releases/tag/v0.1.4-ruby
+[0.2.0]: https://github.com/anpham6/squared/releases/tag/v0.2.0-ruby
 [0.1.3]: https://github.com/anpham6/squared/releases/tag/v0.1.3-ruby
 [0.1.2]: https://github.com/anpham6/squared/releases/tag/v0.1.2-ruby
 [0.1.1]: https://github.com/anpham6/squared/releases/tag/v0.1.1-ruby

data/README.md

@@ -119,6 +119,9 @@ rake repo:init[latest]   # squared
 rake repo:init[0.11.x]   # e-mc
 # OR
 REPO_ROOT=/tmp/123 NODE_INSTALL=pnpm repo:init
+# OR - without Repo
+rake clone:node          # master
+rake clone               # node + docs
 ```
 
 > [!TIP]

data/README.ruby.md

@@ -1,4 +1,4 @@
-# squared 0.1
+# squared 0.2
 
 * [source](https://github.com/anpham6/squared)
 * [manifest](https://github.com/anpham6/squared-repo)
@@ -6,9 +6,12 @@
 
 ## Version Compatibility
 
-| Date     | squared | Ruby 2 | Ruby 3 |
-| :------: | ------: | -----: | -----: |
-| 12-07-24 |   0.1.0 |  2.4.0 |  3.0.0 |
+| Date       | squared |    Min |    Max |
+| :--------: | ------: | -----: | -----: |
+| 2024-12-07 |   0.1.0 |  2.4.0 |  3.3.6 |
+| 2025-01-07 |   0.2.0 |  2.4.0 |  3.4.0 |
+
+The range chart indicates the latest Ruby tested against at the time of release.
 
 ## Installation
 
@@ -77,7 +80,7 @@ Workspace::Application
     "CFLAGS" => "-fPIC -O1"
   })
   .add("optparse", doc: "rake rdoc", group: "default") # Uses bundler/gem_tasks (without C extensions)
-  .add("logger", copy: { from: "lib", glob: "**/*.rb", into: "~/.rvm/gems/ruby-3.3.5/gems/logger-1.6.1" }, clean: ["tmp/"]) # autodetect: true
+  .add("logger", copy: { from: "lib", glob: "**/*.rb", into: "~/.rvm/gems/ruby-3.4.0/gems/logger-1.6.1" }, clean: ["tmp/"]) # autodetect: true
   .add("e-mc", "emc", copy: { from: "publish", scope: "@e-mc", also: [:pir, "squared-express/"] }, ref: :node) # Node
   .add("pi-r", "pir", copy: { from: "publish", scope: "@pi-r" }, clean: ["publish/**/*.js", "tmp/"]) # Trailing slash required for directories
   .add("squared", script: ["build:stage1", "build:stage2"], group: "app") do # Copy target (main)
@@ -89,8 +92,8 @@ Workspace::Application
     # OR
     add(["publish/sqd-cli", "publish/sqd-serve", "publish/sqd-admin"], true, exclude: [:base]) # rake squared:sqd-serve:build
   end
-  .add("squared/sqd", exclude: [:git]) do
-    variable_set :script, "build:sqd"     # Override detection
+  .add("squared/sqd", exclude: :git, pass: [:node, 'checkout', 'bump']) do # Skip initialize(:node) + squared:checkout:* + squared:bump:*
+    variable_set :script, "build:sqd"   # Override detection
     variable_set :depend, false
     variable_set :clean, ["build/sqd/"]
   end
@@ -112,26 +115,71 @@ Workspace::Application
 # chrome    = /workspaces/chrome-docs
 
 Workspace::Application
-  .new(ENV["SQUARED_HOME"], prefix: "rb", common: false) # Local styles
+  .new(ENV["SQUARED_HOME"], prefix: "rb", common: false)        # Local styles
   .group("ruby", "default", run: "rake build", copy: "rake install", clean: "rake clean", ref: :ruby, override: {
     pathname: {
-      run: "rake compile"                                # rake rb:pathname:build
+      run: "rake compile"                                       # rake rb:pathname:build
     }
   })
-  .with(:python) do                                      # ref=Symbol | group=String
-    banner([:name, ": ", :version], "path")              # chrome-docs: 0.1.0 | /workspaces/chrome-docs
-    doc("make html")                                     # rake rb:doc:python
-    run(false)                                           # rake rb:build:python (disabled)
-    exclude(%i[base git])                                # Project::Git.ref (superclass)
-    add("android-docs", "android")                       # rake rb:android:doc
-    add("chrome-docs", "chrome")                         # rake rb:chrome:doc
-  end                                                    #
+  .with(:python) do                                             # ref=Symbol | group=String
+    banner([:name, ": ", :version], "path")                     # chrome-docs: 0.1.0 | /workspaces/chrome-docs
+    doc("make html")                                            # rake rb:doc:python
+    run(false)                                                  # rake rb:build:python (disabled)
+    exclude(%i[base git])                                       # Project::Git.ref (superclass)
+    add("android-docs", "android")                              # rake rb:android:doc
+    add("chrome-docs", "chrome")                                # rake rb:chrome:doc
+  end
   .style("inline", "bold")
   .build
 ```
 
 **NOTE**: The use of "**ref**" (class name) is only necessary when initializing an empty directory (e.g. *rake repo:init*).
 
+### Clone
+
+The task is only active when the project directory is empty or does not exist.
+
+```ruby
+Workspace::Application
+  .new(main: "squared")
+  .git(
+    "emc": "https://github.com/anpham6/e-mc",                    # rake emc:clone
+    "pir": {                                                     # rake pir:clone
+      uri: "https://github.com/anpham6/pi-r",                    #
+      options: {                                                 #
+        "origin": "github",                                      # --origin='github'
+        "recurse-submodules": false,                             # --no-recurse-submodules
+        "shallow-exclude": ["v0.0.1", "v0.0.2"]                  # --shallow-exclude='v0.0.1' --shallow-exclude='v0.0.2'
+      }
+    }
+  )
+  .git("squared", "/path/to/squared", options: { local: true })  # Relative paths resolve from workspace root
+  .git(
+    {
+      emc: { uri: "e-mc", options: { "depth": 2 } },             # https://github.com/anpham6/e-mc
+      pir: "pi-r"                                                # Maps task alias to repository folder
+    },
+    base: "https://github.com/anpham6",                          # Required
+    repo: ["squared", "android-docs", "chrome-docs"],            # https://github.com/anpham6/squared
+    options: {                                                   # Only "repo"
+      "depth": 1,
+      "quiet": true
+    }
+  )
+  .with(:node) do                                                # rake clone:node
+    add("e-mc", "emc")                                           # https://github.com/anpham6/e-mc
+    add("pi-r", "pir")                                           # https://github.com/anpham6/pi-r
+    add("squared")                                               # https://github.com/anpham6/squared
+  end
+  .with(:python) do                                              # rake clone:python
+    add("android-docs")
+    add("chrome-docs")
+  end
+  .git("https://github.com/anpham6")                             # Uses already defined root projects
+  .git("https://github.com/anpham6", ["emc", "pir"])             # Targets any defined project
+  .build(parallel: ["clone"])                                    # rake clone + rake clone:sync
+```
+
 ### Graph
 
 ```ruby
@@ -143,17 +191,30 @@ Workspace::Application
     add("chrome-docs", "chrome", graph: "android")
   end
   .with(:node) do
-    graph(["build", "copy"]) # Overrides "git"
-    add("e-mc", "emc")
-    add("pi-r", "pir", graph: "emc")
+    graph(["build", "copy"], on: {                               # Overrides "git"
+      first: proc { puts "1" },
+      last: proc { puts "2" }
+    })
+    add("e-mc", "emc") do
+      first("build", "emc:clean", "emc:depend")                  # rake emc:clean; rake emc:depend; rake emc:build; puts "123";
+      last("build", out: "123") { |out: nil| puts out }          #
+      error("build") { |err: nil| log.debug err }                #
+    end
+    add("pi-r", "pir", graph: "emc", first: {
+      build: proc { puts self.name }                             # puts "pir"
+    })
     add("squared-express", "express", graph: "pir")
-    add("squared", graph: ["chrome", "express"])
+    add("squared", graph: ["chrome", "express"]) do
+      first("git:ls-files") { puts path }
+      last("git:ls-files") { puts workspace.root }
+    end
   end
   .with(:ruby) do
     add("pathname")
     add("fileutils", graph: "pathname")
     add("optparse")
     add("rake", graph: ["fileutils", "optparse"])
+    banner(command: false)                                       # Always hide banner
   end
   .build
 ```
@@ -188,27 +249,30 @@ Workspace::Series.rename("depend", "install")
 ## Usage
 
 ```sh
-rake -T             # List tasks
-rake                # rake status (usually "build")
+rake -T               # List tasks
+rake                  # rake status (usually "build")
 
 # GIT_OPTIONS=rebase
-rake pull           # All except "default" + "app"
-rake pull:ruby      # pathname + optparse + logger
-rake pull:default   # pathname + optparse
-rake pull:app       # squared
-rake pull:node      # emc + pir + squared
-
-rake build          # All except "android"
-rake doc            # optparse + android
-rake depend         # All except "default"
-
-rake build:ruby     # rake compile + rake install + rake install
-
-rake clean          # All except "default" + "app"
-rake clean:ruby     # rake clean + rake clean + ["tmp/"]
-rake clean:default  # rake clean + rake clean + skip
-rake clean:app      # none + skip + ["build/"]
-rake clean:node     # none + ["publish/**/*.js", "tmp/"] + ["build/"]
+rake pull             # All except "default" + "app"
+rake pull:ruby        # pathname + optparse + logger
+rake pull:default     # pathname + optparse
+rake pull:app         # squared
+rake pull:node        # emc + pir + squared
+
+rake build            # All except "android"
+rake doc              # optparse + android
+rake depend           # All except "default"
+
+rake build:ruby       # rake compile + rake install + rake install
+
+rake clean            # All except "default" + "app"
+rake clean:ruby       # rake clean + rake clean + ["tmp/"]
+rake clean:default    # rake clean + rake clean + skip
+rake clean:app        # none + skip + ["build/"]
+rake clean:node       # none + ["publish/**/*.js", "tmp/"] + ["build/"]
+
+rake squared:run[#]   # List scripts (node)
+rake squared:rake[#]  # List tasks (ruby)
 ```
 
 ```sh
@@ -242,6 +306,7 @@ Non-task:
 * header
 * active
 * inline
+* current
 * major
 * red
 * yellow
@@ -249,22 +314,37 @@ Non-task:
 
 ## Environment
 
+### Path
+
+All project executable programs can have their binary path set to a non-global alias.
+
+```ruby
+Common::PATH.merge!({
+  GIT: '/usr/bin/git',
+  GEM: '~/.rvm/rubies/ruby-3.4.0/bin/gem',
+  BUNDLE: '~/.rvm/gems/ruby-3.4.0/bin/bundle',
+  RAKE: '~/.rvm/gems/ruby-3.4.0/bin/rake',
+  NPM: '/opt/node/v22.0.0/bin/npm',
+  PYTHON: "#{ENV['PYTHONPATH']}/bin/python"
+})
+```
+
 ### Build
 
 ```ruby
 # :env                                         :run           :opts
 # LD_LIBRARY_PATH="path/to/lib" CFLAGS="-Wall" gcc a.c -o a.o -c
 BUILD_${NAME}      # gcc a.c -o a.o
-BUILD_${NAME}_OPTS # -c
-BUILD_${NAME}_ENV  # {"LD_LIBRARY_PATH":"path/to/lib","CFLAGS":"-Wall"} (hash/json)
+BUILD_OPTS_${NAME} # -c
+BUILD_ENV_${NAME}  # {"LD_LIBRARY_PATH":"path/to/lib","CFLAGS":"-Wall"} (hash/json)
 
 # :env                                       :opts                               :script
 # NODE_ENV="production" NO_COLOR="1" npm run --loglevel=error --workspaces=false build:dev
 BUILD_${NAME}      # build:dev
-BUILD_${NAME}_OPTS # --loglevel=error --workspaces=false
-BUILD_${NAME}_ENV  # {"NODE_ENV":"production","NO_COLOR":"1"} (hash/json)
-BUILD_${NAME}_DEV  # pattern,0,1 (:dev)
-BUILD_${NAME}_PROD # pattern,0,1 (:prod)
+BUILD_OPTS_${NAME} # --loglevel=error --workspaces=false
+BUILD_ENV_${NAME}  # {"NODE_ENV":"production","NO_COLOR":"1"} (hash/json)
+BUILD_DEV_${NAME}  # pattern,0,1 (:dev)
+BUILD_PROD_${NAME} # pattern,0,1 (:prod)
 
 BUILD_${NAME}=0    # skip project
 ```

data/lib/squared/app.rb

@@ -6,5 +6,3 @@ require_relative 'workspace/project/node'
 require_relative 'workspace/project/python'
 require_relative 'workspace/project/ruby'
 require_relative 'config'
-
-Common = Squared::Common

data/lib/squared/common/base.rb

@@ -2,6 +2,7 @@
 
 module Squared
   module Common
+    PATH = {}
     ARG = {
       PIPE: 1,
       OUT: nil,
@@ -11,6 +12,7 @@ module Squared
       BANNER: true,
       SPACE: ' => ',
       GRAPH: ['│', '─', '├', '└', '┬'],
+      VIEW: 'view',
       COLOR: ENV.fetch('NO_COLOR', '').empty?
     }
     VAR = {
@@ -35,29 +37,31 @@ module Squared
       },
       theme: {
         workspace: {
-          header: %i[bold],
-          active: %i[bold],
-          inline: %i[bold],
-          major: %i[bold]
+          header: [:bold],
+          active: [:bold],
+          inline: [:bold],
+          current: nil,
+          major: [:bold]
         },
         project: {},
         viewer: {
-          banner: %i[blue bold],
-          key: %i[bold],
-          value: %i[green],
-          string: %i[yellow],
+          banner: [:bold],
+          border: [:blue],
+          key: nil,
+          value: [:green],
+          string: [:yellow],
           hash: %i[green black!],
           array: %i[blue black!],
-          number: %i[magenta],
+          number: [:magenta],
           undefined: %i[red italic]
         },
         logger: {
-          unknown: %i[cyan],
+          unknown: [:cyan],
           fatal: %i[white bold red!],
           error: %i[red bold],
           warn: %i[yellow bold],
-          info: %i[blue],
-          debug: %i[green]
+          info: [:blue],
+          debug: [:green]
         }
       }
     }.compare_by_identity
@@ -76,6 +80,7 @@ module Squared
     end
 
     def __freeze__
+      PATH.freeze
       ARG.freeze
       VAR.each_value(&:freeze)
       VAR[:theme].each_value(&:freeze)
@@ -84,7 +89,7 @@ module Squared
 
     module_function
 
-    def as_a(obj, meth = nil, flat: nil, compact: false)
+    def as_a(obj, meth = nil, flat: nil, compact: false, &blk)
       return [] if obj.nil?
 
       unless obj.is_a?(::Array)
@@ -96,7 +101,8 @@ module Squared
       end
       obj = obj.flatten(flat.is_a?(::Numeric) ? flat : nil) if flat
       obj = obj.compact if compact
-      meth ? obj.map(&meth) : obj
+      obj = obj.map(&meth) if meth
+      block_given? ? obj.select(&blk) : obj
     end
   end
 end

data/lib/squared/common/class.rb

@@ -34,11 +34,28 @@ module Squared
         super.match(/[^:]+\z/)[0]
       end
 
+      attr_reader :delim
+
       def initialize(data = [], delim: ' ')
         super(data.compact)
         @delim = delim
       end
 
+      def pass(&blk)
+        ret = to_a.map!(&:to_s).reject(&:empty?)
+        block_given? ? ret.reject(&blk) : ret
+      end
+
+      def temp(*args, &blk)
+        args.compact!
+        ret = pass(&blk)
+        unless args.empty?
+          ret += args
+          ret = Set.new(ret).to_a
+        end
+        ret.join(@delim)
+      end
+
       def done
         ret = to_s
         clear
@@ -46,7 +63,7 @@ module Squared
       end
 
       def to_s
-        to_a.map!(&:to_s).reject(&:empty?).join(@delim)
+        pass.join(@delim)
       end
     end
   end

data/lib/squared/common/format.rb

@@ -138,15 +138,15 @@ module Squared
       def log_sym(level)
         if level.is_a?(::Numeric)
           case level
-          when ::Logger::DEBUG
+          when Logger::DEBUG
             :debug
-          when ::Logger::INFO
+          when Logger::INFO
             :info
-          when ::Logger::WARN
+          when Logger::WARN
             :warn
-          when ::Logger::ERROR
+          when Logger::ERROR
             :error
-          when ::Logger::FATAL
+          when Logger::FATAL
             :fatal
           else
             :unknown
@@ -185,10 +185,10 @@ module Squared
       end
 
       def puts_oe(*args, pipe: 1)
-        if pipe.is_a?(::Pathname)
+        if pipe.is_a?(Pathname)
           begin
-            ::File.open(pipe, 'a') do |f|
-              br = ::File::SEPARATOR == '\\' ? "\r\n" : "\n"
+            File.open(pipe, 'a') do |f|
+              br = File::SEPARATOR == '\\' ? "\r\n" : "\n"
               args.flatten.each { |val| f.write("#{strip_style(val.chomp)}#{br}") }
             end
             return
@@ -279,7 +279,7 @@ module Squared
       end
 
       def raise_error(*args, hint: nil, kind: ArgumentError)
-        raise kind, message(*args, hint: hint, empty: true)
+        raise kind, message(*args, hint: hint, empty: true), caller_locations(1)
       end
     end
   end

data/lib/squared/common/shell.rb

@@ -27,7 +27,7 @@ module Squared
 
       def shell_quote(val, force: true)
         val = val.to_s
-        return val if (!force && !val.include?(' ')) || val =~ /(?:^|\S=|[^=]\s+)(["']).+\1\z/m
+        return val if (!force && !val.include?(' ')) || val.match?(/(?:^|\S=|[^=]\s+)(["']).+\1\z/m)
 
         Rake::Win32.windows? ? "\"#{double_quote(val)}\"" : "'#{single_quote(val)}'"
       end
@@ -40,13 +40,14 @@ module Squared
       end
 
       def shell_option(flag, val = nil, quote: false, escape: true)
-        "--#{flag}#{if val
-                      "=#{if escape
-                            shell_escape(val, quote: quote)
-                          else
-                            quote ? shell_quote(val) : val
-                          end}"
-                    end}"
+        a, b = flag.size == 1 ? ['-', ' '] : ['--', '=']
+        "#{a}#{flag}#{if val
+                        "#{b}#{if escape
+                                 shell_escape(val, quote: quote)
+                               else
+                                 quote ? shell_quote(val) : val
+                               end}"
+                      end}"
       end
 
       def fill_option(val)
@@ -55,6 +56,14 @@ module Squared
         shell_escape(val.start_with?('-') ? val : "--#{val}")
       end
 
+      def quote_option(flag, val)
+        shell_option(flag, val, escape: false, quote: true)
+      end
+
+      def basic_option(flag, val)
+        shell_option(flag, val, escape: false)
+      end
+
       def single_quote(val)
         val.gsub("'", "'\\\\''")
       end