squared 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1795e8352e8278c8f4e26ced26ac936ce906ee8e626a9cf2ff2bf6a86412f09c
-  data.tar.gz: '08b8e2538b6316ffb141c15e560187222cbb18e0a37f5c74af6ed5fda87e6dc3'
+  metadata.gz: 60e2da1ce8ec4439d4180db0c0f806d9984046ef5f12b34008563edd7b40b938
+  data.tar.gz: 6eb7ef1c8273d10747cb79c1a113dae53210cebd167969f4a1546a9fc07162f0
 SHA512:
-  metadata.gz: a8d6bd537e66b744edd760ead7441aad45961bdc746e9ca81f577e8183893cd6209203f2ba507b5ab608bbf3ebe7a15aeb23aa84005a76bf10d0f3b3704c403d
-  data.tar.gz: 9a29c720ce14050bc604c9b561c376f55437865610827075dd6a2a961ce82b22c1f4b3fd303884186f9c59b1a330ed73ce14ad16169724c3578d8d4e01388bfe
+  metadata.gz: 75f989753670bd5854a8dccc6a3bf8d3d7397d2a373a50d46eaa7add861ff8d1f24cffb1c9ac00d48756d89abb50728c35368beb62649b3d704f3d7b059b449a
+  data.tar.gz: 6387222860eb65bd57cd14ba86b77b39d47a64d5a03940a5b6f6ac0ccea6368f0ab8df0a1886d5f6e6eec83f89887397b72f57a647a4ad06efa632020c1a5938

data/README.ruby.md

@@ -28,19 +28,26 @@ gem install squared
 
 ## Example - Rakefile
 
+Projects from any accessible folder can be added either relative to `REPO_ROOT` or absolutely. The same Rakefile can also manage other similarly cloned repositories remotely by setting the `REPO_ROOT` environment variable to the location. Missing projects will simply be excluded from the task runner.
+
 ```ruby
 require "squared"
+require "squared/workspace/repo" # Repo (optional)
 
-Repo::Workspace
+# REPO_ROOT = /workspaces
+# REPO_HOME = /workspaces/squared
+# rake      = /workspaces/squared/Rakefile
+
+Workspace::Application
   .new("squared") # REPO_HOME
-  .repo("https://github.com/anpham6/squared-repo", "nightly", run: 'build') # Optional
+  .repo("https://github.com/anpham6/squared-repo", "nightly", run: "build") # Repo (optional)
   .run("rake install", ref: :ruby)
   .clean("rake clean", group: "default") # depend test doc
   .clean(["build/"], group: "app")
   .add("pathname", run: "rake compile", copy: "rake install", test: "rake test", group: "default", ref: :ruby) # Ruby (with C extensions)
   .add("optparse", doc: "rake rdoc", group: "default") # Uses bundler/gem_tasks (without C extensions)
   .add("logger", copy: { from: "lib", glob: "**/*.rb", gemdir: "~/.rvm/gems/ruby-3.3.5/gems/logger-1.6.1" }, clean: ["tmp/"]) # autodetect: true
-  .add("android", "android-docs", run: false, doc: "make html", ref: :python) # task namespace "android" | directory "android-docs"
+  .add("android", "android-docs", run: false, doc: "make html", ref: :python) # Python
   .add("emc", "e-mc", copy: { from: "publish", into: "@e-mc", also: [:pir, "squared-express/"] }, ref: :node) # Node
   .add("pir", "pi-r", copy: { from: "publish", into: "@pi-r" }, clean: ["publish/**/*.js", "tmp/"]) # Trailing slash required for directories
   .add("squared", log: { file: "tmp/%Y-%m-%d.log", level: "debug" }, group: "app") # Copy target (main)
@@ -51,6 +58,22 @@ Repo::Workspace
       .style(:banner, "bright_cyan", "bold", "bright_black!")
       .finalize! # Optional
   end
+# pathname  = /workspaces/pathname
+# optparse  = /workspaces/optparse
+# log       = /workspaces/logger
+# android   = /workspaces/android-docs
+# emc       = /workspaces/e-mc
+# pir       = /workspaces/pi-r
+# squared   = /workspaces/squared
+
+Repo::Workspace
+  .new("squared")
+  .group("default", "ruby", run: "rake build", copy: "rake install", clean: "rake clean", pathname: { run: "rake compile" })
+  .build
+# default   = /workspaces/ruby/*
+# pathname  = /workspaces/ruby/pathname
+# optparse  = /workspaces/ruby/optparse
+# logger    = /workspaces/ruby/logger
 ```
 
 **NOTE**: The use of "**ref**" (class name) is only necessary when running `repo:init` for the first time into an empty directory.

data/lib/squared/common/base.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Squared
+  module Common
+    VAR = {
+      project: {},
+      colors: {
+        black: '30',
+        red: '31',
+        green: '32',
+        yellow: '33',
+        blue: '34',
+        magenta: '35',
+        cyan: '36',
+        white: '37',
+        black!: '40',
+        red!: '41',
+        green!: '42',
+        yellow!: '43',
+        blue!: '44',
+        magenta!: '45',
+        cyan!: '46',
+        white!: '47'
+      },
+      theme: {
+        workspace: {},
+        project: {},
+        viewer: {
+          banner: %i[blue bold],
+          key: %i[bold],
+          value: %i[green],
+          string: %i[yellow],
+          hash: %i[green black!],
+          array: %i[blue black!],
+          number: %i[magenta],
+          undefined: %i[red italic]
+        },
+        logger: {
+          unknown: %i[cyan],
+          fatal: %i[white bold red!],
+          error: %i[red bold],
+          warn: %i[yellow bold],
+          info: %i[blue],
+          debug: %i[green]
+        }
+      }
+    }.compare_by_identity
+    private_constant :VAR
+
+    private
+
+    def __get__(key)
+      VAR[key.is_a?(::String) ? key.to_sym : key]
+    end
+
+    def __set__(key, val)
+      return if VAR.frozen?
+
+      VAR[key.is_a?(::String) ? key.to_sym : key] = val
+    end
+
+    def env(key, equals: nil, ignore: nil, default: nil, **)
+      ret = ENV.fetch(key, '')
+      return ret == equals.to_s unless equals.nil?
+
+      ret.empty? || (ignore && as_a(ignore).any? { |val| ret == val.to_s }) ? default : ret
+    end
+
+    def message(*args, hint: nil)
+      args.reject(&:empty?).join(' => ') + (hint ? " (#{hint})" : '')
+    end
+
+    def as_a(obj, flat: nil)
+      if obj.nil?
+        []
+      elsif !obj.is_a?(::Array)
+        [obj]
+      elsif flat
+        obj.flatten(flat == true ? nil : flat)
+      else
+        obj
+      end
+    end
+
+    def finalize!
+      VAR.each_value(&:freeze)
+      VAR[:theme].each_value(&:freeze)
+      VAR.freeze
+    end
+  end
+end

data/lib/squared/common/class.rb

@@ -6,7 +6,7 @@ module Squared
   module Common
     class JoinSet < ::Set
       def self.to_s
-        /[^:]+$/.match(super.to_s)[0]
+        super.to_s.match(/[^:]+$/)[0]
       end
 
       def initialize(data = [], delim: ' ')

data/lib/squared/common/format.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require 'logger'
+
+require_relative 'base'
+
 module Squared
   module Common
     module Format
@@ -33,6 +37,8 @@ module Squared
         block_given? ? yield(self) : self
       end
 
+      private
+
       def emphasize(val, title: nil, cols: nil, sub: nil, pipe: nil)
         n = 0
         if title
@@ -66,14 +72,12 @@ module Squared
           yield out
         elsif pipe.respond_to?(:puts)
           pipe.puts out
-        elsif err
-          defined?(__warn__) == 'method' ? __warn__(out) : warn(out)
         else
-          puts out
+          err ? warn(out) : puts(out)
         end
       end
 
-      def sub_style(val, *args, pat: nil, styles: nil, index: 1)
+      def sub_style(val, *args, styles: nil, pat: nil, index: 1)
         return val unless ENV['NO_COLOR'].to_s.empty?
 
         if pat && index != 0
@@ -168,6 +172,10 @@ module Squared
         end
       end
 
+      def raise_error(*args, hint: nil, kind: ArgumentError)
+        raise kind, message(*args, hint: hint)
+      end
+
       def log_title(level, color: true)
         level = if level.is_a?(::Numeric)
                   case level
@@ -188,13 +196,12 @@ module Squared
                   level.to_s.downcase.to_sym
                 end
         theme = __get__(:theme)[:logger]
-        val = theme[level] || theme[level = :unknown]
-        level = +level.to_s.upcase
-        case level
+        styles = theme[level] || theme[level = :unknown]
+        case (ret = +level.to_s.upcase)
         when 'WARN', 'ERROR', 'FATAL'
-          level += '!'
+          ret += '!'
         end
-        color ? sub_style(level, *val) : level
+        color ? sub_style(ret, *styles) : ret
       end
 
       def log_message(level, *args, subject: nil, hint: nil, color: true)

data/lib/squared/common/shell.rb

@@ -1,24 +1,28 @@
 # frozen_string_literal: true
 
+require 'shellwords'
+require 'rake'
+
 module Squared
   module Common
     module Shell
-      def shell_escape(val)
-        return val if ::Rake::Win32.windows?
+      private
+
+      def shell_escape(val, quote: false)
+        return (quote ? shell_quote(val, force: false) : val) if ::Rake::Win32.windows?
 
-        require 'shellwords'
         Shellwords.escape(val)
       end
 
       def shell_quote(val, force: true)
         ret = val.to_s.strip
-        return ret if (!force && !ret.include?(' ')) || ret.match?(/(?:^|=)(["']).+\1$/m)
+        return ret if (!force && !ret.include?(' ')) || ret =~ /(?:^|=)(["']).+\1$/m
 
         ::Rake::Win32.windows? ? "\"#{double_quote(ret)}\"" : "'#{single_quote(ret)}'"
       end
 
       def fill_option(val)
-        return "-#{val}" if val.size == 1 || val.match?(/^[a-z]\d+$/i)
+        return "-#{val}" if val.size == 1 || val =~ /^[a-z]\d+$/i
 
         val = "--#{val}" unless val.start_with?('-')
         shell_escape(val).sub('\\=', '=')
@@ -36,10 +40,6 @@ module Squared
         val.split(/\s*(?<!\\)#{char}\s*/)
       end
 
-      def trailing_slash(val)
-        val.to_s.chomp(::File::SEPARATOR) + ::File::SEPARATOR
-      end
-
       def sanitize_args(*opts)
         opts.map { |val| val.include?(' ') ? shell_quote(val) : shell_escape(val) }.join(' ')
       end

data/lib/squared/common/system.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require 'pathname'
+require 'fileutils'
 
 module Squared
   module Common
     module System
+      private
+
       def shell(*cmd, **kwargs)
-        if /^2\.[0-5]\./.match?(RUBY_VERSION)
+        if RUBY_VERSION =~ /^2\.[0-5]\./
           exception = kwargs.delete(:exception)
           ret = system(*cmd, **kwargs)
           raise $?.to_s if !ret && exception

data/lib/squared/common/task.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
+require 'rake'
+
 module Squared
   module Common
     module Task
+      private
+
       def collect_args(args, *keys)
         ret = []
         return ret unless args.is_a?(::Rake::TaskArguments)
 
-        keys.each { |key| ret << args[key] if args[key] }
+        keys.each { |key| ret << args.fetch(key) if args.key?(key) }
         ret += args.extras
       end
 
@@ -16,7 +20,7 @@ module Squared
       rescue StandardError => e
         raise if exception
 
-        defined?(__warn__) == 'method' ? __warn__(e) : warn(e)
+        warn e
       end
 
       def invoked?(name)

data/lib/squared/common.rb

@@ -1,86 +1,9 @@
 # frozen_string_literal: true
 
 require 'pathname'
-require 'logger'
 require 'rake'
 
-module Squared
-  module Common
-    VAR = {
-      project: {},
-      colors: {
-        black: '30',
-        red: '31',
-        green: '32',
-        yellow: '33',
-        blue: '34',
-        magenta: '35',
-        cyan: '36',
-        white: '37',
-        black!: '40',
-        red!: '41',
-        green!: '42',
-        yellow!: '43',
-        blue!: '44',
-        magenta!: '45',
-        cyan!: '46',
-        white!: '47'
-      },
-      theme: {
-        workspace: {},
-        project: {},
-        viewer: {
-          banner: %i[blue bold],
-          key: %i[bold],
-          value: %i[green],
-          string: %i[yellow],
-          hash: %i[green black!],
-          array: %i[blue black!],
-          number: %i[magenta],
-          undefined: %i[red italic]
-        },
-        logger: {
-          unknown: %i[cyan],
-          fatal: %i[white bold red!],
-          error: %i[red bold],
-          warn: %i[yellow bold],
-          info: %i[blue],
-          debug: %i[green]
-        }
-      }
-    }.compare_by_identity
-    private_constant :VAR
-
-    def __get__(key)
-      VAR[key.is_a?(::String) ? key.to_sym : key]
-    end
-
-    def __set__(key, val)
-      return if VAR.frozen?
-
-      VAR[key.is_a?(::String) ? key.to_sym : key] = val
-    end
-
-    def finalize!
-      VAR.each_value(&:freeze)
-      VAR[:theme].each_value(&:freeze)
-      VAR.freeze
-    end
-
-    def message(*args, hint: nil)
-      args.reject(&:empty?).join(' => ') + (hint ? " (#{hint})" : '')
-    end
-
-    def as_a(obj, flat: nil)
-      return [] if obj.nil?
-      return [obj] unless obj.is_a?(::Array)
-      return obj unless flat
-
-      obj.flatten(flat == true ? nil : flat)
-    end
-  end
-end
-
+require_relative 'common/base'
 require_relative 'common/class'
 require_relative 'common/format'
 require_relative 'common/shell'

data/lib/squared/config.rb

@@ -2,6 +2,8 @@
 
 require 'json'
 
+require_relative 'common'
+
 module Squared
   module Config
     class Viewer
@@ -12,7 +14,7 @@ module Squared
 
       class << self
         def to_s
-          /[^:]+$/.match(super.to_s)[0]
+          super.to_s.match(/[^:]+$/)[0]
         end
       end
 
@@ -63,14 +65,14 @@ module Squared
           namespace view do
             if @mime['json'] && (exist? || !::Rake::Task.task_defined?("#{name}:#{view}:json"))
               desc format_desc(view, %w[json])
-              task :json, [:keys] do |_, args|
+              task 'json', [:keys] do |_, args|
                 read_keys(JSON, 'json', *params.(args))
               end
             end
 
             if @mime['yaml'] && (exist? || !::Rake::Task.task_defined?("#{name}:#{view}:yaml"))
               desc format_desc(view, %w[yaml yml])
-              task :yaml, [:keys] do |_, args|
+              task 'yaml', [:keys] do |_, args|
                 require 'yaml'
                 read_keys(YAML, 'yaml', *params.(args), ext: %w[yml yaml])
               end
@@ -161,7 +163,7 @@ module Squared
 
       def read_keys(reader, type, file, keys, ext: [type])
         if (mime = mime_type(file)) && base_path(file).exist?
-          raise ArgumentError, message(file, mime, hint: 'invalid') unless ext.include?(mime)
+          raise_error(file, mime, hint: 'invalid') unless ext.include?(mime)
         else
           if ext.include?(mime)
             alt = file
@@ -172,11 +174,9 @@ module Squared
             alt = base_path("#{main}.{#{ext.join(',')}}")
             file = Dir[alt].first
           end
-          unless file
-            raise ArgumentError, message(reader.name, "#{File.basename(alt, '.*')}.#{ext.first}", hint: 'not found')
-          end
+          raise_error(reader.name, "#{File.basename(alt, '.*')}.#{ext.first}", hint: 'not found') unless file
         end
-        project&.info "#{Viewer}(#{type}) => #{file} {#{keys.join(', ')}}"
+        project&.log&.info "#{Viewer}(#{type}) => #{file} {#{keys.join(', ')}}"
         doc = if reader.respond_to?(:load_file)
                 reader.load_file(file, **@mime[type])
               else
@@ -225,7 +225,7 @@ module Squared
               end
             end
           rescue StandardError
-            project&.warn "#{Viewer}(#{type}) => #{file ? "#{file} " : ''}{#{key}: undefined}"
+            project&.log&.warn "#{Viewer}(#{type}) => #{file ? "#{file} " : ''}{#{key}: undefined}"
             val = Regexp.escape($!.message)
             key = key.sub(/(#{val})\.|\.(#{val})|(#{val})/) do
               s = "<#{$3 || $2 || $1}>"
@@ -284,7 +284,7 @@ module Squared
       end
 
       def warning?
-        project ? project.warning : true
+        project && defined?(project.warning) == 'method' ? project.warning : true
       end
     end
   end

data/lib/squared/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Squared
-  VERSION = '0.0.4'
+  VERSION = '0.0.6'
 end