scripto 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ea62ce310b383c38d173c5e3cd61b2eb4e7ea345c92f6b2f1874e7c6a3c93f
-  data.tar.gz: 0fc744955f01e99d7ee44f53b927d1a93ca6d46e35a7e1b9baf36f62e9939711
+  metadata.gz: 7cdd03bc1a558ff5c9f151d972205bde0816ad6feb89de992ae141bd637ebc54
+  data.tar.gz: b5c45a7c274391597e1c6dcd2e91579cdb09cc028bda6179a1762f010d005a73
 SHA512:
-  metadata.gz: fee85c4a32b32d4caf1f54aec0efac6e0634f2217154c1c6367b1c184878d08b14f9f4e035eda2d78b4157bef41d839b7044fbe230957bf81eba2df3bf451f8e
-  data.tar.gz: 7664c604a09572d1cecf1e4e7cc1d3b8845e6dfb5ff1ea1e37edf660a58007f19a17a46668786a8014a71f36c373e6eff7b8f811abe5d3b3f14dd854cb068e8f
+  metadata.gz: a2b6883573f231fe24d7c6566d62510e95d4672842f0c580fb29e2634877e3020db88fe71b9d683e571ca23a2ef4e1479a0f0cf2de9f52d3d1faab0137d88001
+  data.tar.gz: 5934be60e97a589d0099a136027ee3888a6d7c3d7a7f3589df70fe76a525f5286ee3aad2812a0e373f6b7248371aabece0d7c68c2256329ca3eb7e092709b934

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: ci
+
+on:
+  push:
+    paths-ignore:
+      - "**.md"
+  workflow_dispatch:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby-version: [3.4]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: taiki-e/install-action@just
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby-version }}
+      - run: just check

data/.gitignore

@@ -1,19 +1 @@
-_yardoc
-.bundle
-.config
-.ruby-version
-.vagrant
-.yardoc
 *.gem
-*.rbc
-coverage
-doc/
-Gemfile.lock
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rubocop.yml

@@ -0,0 +1,15 @@
+require:
+  - standard
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  Exclude:
+    - vendor/**/* # for ci - https://github.com/rubocop/rubocop/issues/9832
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+# tweaks
+Style/HashSyntax: { EnforcedShorthandSyntax: always }

data/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["Shopify.ruby-lsp"]
+}

data/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.formatOnSave": true
+}

data/Gemfile

@@ -1,4 +1,12 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in scripto.gemspec
 gemspec
+
+group :development, :test do
+  gem "minitest", "~> 5.0"
+  gem "mocha"
+  gem "pry", require: false
+  gem "rake", require: false
+  gem "ruby-lsp", require: false
+  gem "standard", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    scripto (1.0.0)
+      csv (~> 3.3)
+      ostruct (~> 0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    coderay (1.1.3)
+    csv (3.3.5)
+    io-console (0.8.2)
+    json (2.18.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    method_source (1.1.0)
+    minitest (5.27.0)
+    mocha (3.0.1)
+      ruby2_keywords (>= 0.0.5)
+    ostruct (0.6.3)
+    parallel (1.27.0)
+    parser (3.3.10.1)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    pry (0.16.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      reline (>= 0.6.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    rbs (3.10.2)
+      logger
+    regexp_parser (2.11.3)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rubocop (1.82.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    ruby-lsp (0.26.5)
+      language_server-protocol (~> 3.17.0)
+      prism (>= 1.2, < 2.0)
+      rbs (>= 3, < 5)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    standard (1.53.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.82.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.9.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.26.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+
+PLATFORMS
+  arm64-darwin-20
+  arm64-darwin-21
+  arm64-darwin-24
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  mocha
+  pry
+  rake
+  ruby-lsp
+  scripto!
+  standard
+
+BUNDLED WITH
+   2.5.21

data/README.md

@@ -1,16 +1,16 @@
-# Scripto
+[![Build Status](https://github.com/gurgeous/scripto/actions/workflows/ci.yml/badge.svg)](https://github.com/gurgeous/scripto/actions/workflows/ci.yml)
+
+![logo](logo.svg)
 
-[![Build Status](https://travis-ci.org/gurgeous/scripto.svg?branch=master)](https://travis-ci.org/gurgeous/scripto)
+# Scripto
 
-Scripto is a framework for writing command line applications. It fills in many of the blanks that Ruby's standard library is missing:
+Scripto is a framework for writing Ruby command line applications. It fills in many of the blanks that Ruby's standard library is missing:
 
-- **print to \$stderr** - Colored banners and a verbose mode to make your scripts louder.
+- **printing** - Colored banners and a verbose mode to make your scripts louder.
 - **file operations** - Mkdir, cp, mv, ln. These operations can take care of common edge cases, like creating the target directory before copying a file.
 - **run commands** - Run external commands and raise errors on failure.
 - **csv** - Read and write CSV files from hashes, Structs, or OpenStructs.
 
-Rdoc at [rdoc.info](http://rdoc.info/github/gurgeous/scripto/). Thanks!
-
 ## Getting Started
 
 You can call Scripto directly:
@@ -43,7 +43,7 @@ require "scripto"
 
 class Install < Scripto::Main
   def initialize(options = {})
-    verbose! if options[:verbose]
+    super
 
     banner("Starting installation...")
     cp("here.txt", "there.txt")
@@ -67,17 +67,18 @@ Install.new(verbose: true)
 
 ## Methods
 
-### Print to \$stderr
+### Printing
+
+Scripto has a built-in logger that wraps $stdout. The logger runs in INFO mode
+by default, but will switch to DEBUG if options[:verbose] is true. Or you can
+quiet it down to ERROR if options[:quiet] is true. `banner`, `warning` and
+`fatal` use Scripto's logger.
 
 ```
 banner(str)  - print a banner in green
 warning(str) - print a warning in yellow
 fatal(str)   - print a fatal error in red, then exit(1)
-
-verbose!     - turn on verbose mode
-vbanner(str) - print a colored banner in green if verbose is on
-vprintf(str) - printf if verbose is on
-vputs(str)   - puts if verbose is on
+verbose!     - force verbose
 ```
 
 ### File operations
@@ -156,7 +157,14 @@ random_string(len) - calculate a random alphanumeric string
 
 # Changelog
 
-0.0.4 (late 2020)
+### 1.0.0 (early 2026)
+
+- banner and friends use Logger (breaking)
+- only support Ruby 3.4+ (breaking)
+- [standardrb](https://github.com/testdouble/standard) and a [justfile](https://github.com/casey/just)
+- update deps, switch to Github actions, etc.
+
+### 0.0.4 (late 2020)
 
 - Added support for reading CSV with BOM.
 - Only support Ruby 2.3+, since we moved to modern Bundler

data/Rakefile

@@ -1,21 +1,5 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-require 'rdoc/task'
-require 'rubocop/rake_task'
+require "bundler/setup"
+require "rake/testtask"
 
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'test'
-end
+Rake::TestTask.new(:test)
 task default: :test
-
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "scripto #{Scripto::VERSION}"
-  rdoc.main = 'README.md'
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.include('README.md')
-end
-
-RuboCop::RakeTask.new do |task|
-  task.options << '--display-cop-names'
-end

data/justfile

@@ -0,0 +1,54 @@
+
+# read gem version
+gemver := `cat lib/scripto/version.rb | grep -Eo "[0-9]+\.[0-9]+\.[0-9]+"`
+
+set quiet := true
+
+#
+# dev
+#
+
+default: test
+
+check: lint test
+
+fmt:
+  bundle exec rubocop -a
+
+lint:
+  just banner lint...
+  bundle exec rubocop
+
+pry:
+  bundle exec pry -I lib -r scripto.rb
+
+test:
+  just banner test...
+  bundle exec rake test
+
+watch:
+  watchexec --watch lib --watch test --clear bundle exec rake test
+
+#
+# gem tasks
+#
+
+gem-push: # check-git-status
+  just banner gem build...
+  gem build scripto.gemspec
+  just banner tag...
+  # git tag -a "v{{gemver}}" -m "Tagging {{gemver}}"
+  # git push --tags
+  just banner gem push...
+  gem push "scripto-{{gemver}}.gem"
+
+#
+# util
+#
+
+GREEN := '\e[1;38;2;255;255;255;48;2;64;160;43m'
+banner *ARGS:
+  printf '{{GREEN}}[%s] %-72s \e[m\n' "$(date +%H:%M:%S)" "{{ARGS}}"
+
+check-git-status:
+  if [ ! -z "$(git status --porcelain)" ]; then echo "git status is dirty, bailing."; exit 1; fi

data/lib/scripto/csv_commands.rb

@@ -1,29 +1,23 @@
-require 'csv'
-require 'tempfile'
-require 'zlib'
+require "csv"
+require "tempfile"
+require "zlib"
 
 module Scripto
   module CsvCommands
     # Read a csv from +path+. Returns an array of Structs, using the keys from
     # the csv header row.
     def csv_read(path)
-      lines = begin
-        if path =~ /\.gz$/
-          Zlib::GzipReader.open(path) do |f|
-            CSV.new(f).read
-          end
-        else
-          encoding = 'bom|utf-8'
-          if RUBY_VERSION >= "2.6.0"
-            CSV.read(path, encoding: encoding)
-          else
-            CSV.read(path, "r:#{encoding}")
-          end
+      rows = if /\.gz$/.match?(path)
+        Zlib::GzipReader.open(path) do
+          CSV.new(_1).read
         end
+      else
+        CSV.read(path, encoding: "bom|utf-8")
       end
-      keys = lines.shift.map(&:to_sym)
+
+      keys = rows.shift.map(&:to_sym)
       klass = Struct.new(*keys)
-      lines.map { |i| klass.new(*i) }
+      rows.map { klass.new(*_1) }
     end
 
     # Write +rows+ to +path+ as csv. Rows can be an array of hashes, Structs,
@@ -32,21 +26,21 @@ module Scripto
     # used as the column keys instead.
     def csv_write(path, rows, cols: nil)
       atomic_write(path) do |tmp|
-        CSV.open(tmp.path, 'wb') { |f| csv_write0(f, rows, cols: cols) }
+        CSV.open(tmp.path, "wb") { csv_write0(_1, rows, cols:) }
       end
     end
 
     # Write +rows+ to $stdout as a csv. Similar to csv_write.
     def csv_to_stdout(rows, cols: nil)
-      CSV($stdout) { |f| csv_write0(f, rows, cols: cols) }
+      CSV($stdout) { csv_write0(_1, rows, cols:) }
     end
 
     # Returns a string containing +rows+ as a csv. Similar to csv_write.
     def csv_to_s(rows, cols: nil)
-      string = ''
-      f = CSV.new(StringIO.new(string))
-      csv_write0(f, rows, cols: cols)
-      string
+      StringIO.new.tap do
+        f = CSV.new(_1)
+        csv_write0(f, rows, cols:)
+      end.string
     end
 
     protected
@@ -60,7 +54,7 @@ module Scripto
       # rows
       rows.each do |row|
         row = row.to_h
-        csv << cols.map { |i| row[i] }
+        csv << cols.map { row[_1] }
       end
     end
   end

data/lib/scripto/file_commands.rb

@@ -1,5 +1,5 @@
-require 'etc'
-require 'fileutils'
+require "etc"
+require "fileutils"
 
 module Scripto
   module FileCommands
@@ -55,7 +55,7 @@ module Scripto
     def mkdir_if_necessary(dir, owner: nil, mode: nil)
       return if File.exist?(dir) || File.symlink?(dir)
 
-      mkdir(dir, owner: owner, mode: mode)
+      mkdir(dir, owner:, mode:)
       true
     end
 
@@ -65,7 +65,7 @@ module Scripto
     def cp_if_necessary(src, dst, mkdir: false, owner: nil, mode: nil)
       return if File.exist?(dst) && FileUtils.compare_file(src, dst)
 
-      cp(src, dst, mkdir: mkdir, owner: owner, mode: mode)
+      cp(src, dst, mkdir:, owner:, mode:)
       true
     end
 
@@ -115,7 +115,7 @@ module Scripto
     # Like rm -rf && mkdir -p. Like all file commands, the operation will be
     # printed out if verbose?.
     def rm_and_mkdir(dir)
-      raise "don't do this" if dir == ''
+      raise "don't do this" if dir == ""
 
       FileUtils.rm_rf(dir, verbose: verbose?)
       mkdir(dir)

data/lib/scripto/log_commands.rb

@@ -0,0 +1,112 @@
+require "logger"
+
+module Scripto
+  module LogCommands
+    # https://catppuccin.com/palette/
+    RESET = "\e[0m"
+    GREEN = "\e[1;38;2;255;255;255;48;2;64;160;43m"
+    YELLOW = "\e[1;38;2;255;255;255;48;2;251;100;11m"
+    RED = "\e[1;38;2;255;255;255;48;2;210;15;57m"
+
+    #
+    # logger
+    #
+
+    # Returns the built-in logger. If none has been set, create a new one
+    # wrapped around $stdout. Used by banner/warning/fatal.
+    def logger
+      @logger ||= begin
+        level = if options[:verbose]
+          Logger::DEBUG
+        elsif options[:quiet]
+          Logger::ERROR
+        else
+          Logger::INFO
+        end
+        Logger.new($stdout, level:, formatter: Formatter.new)
+      end
+    end
+
+    # Set the built-in logger.
+    def logger=(value)
+      @logger = value
+      @log_with_color = false
+    end
+
+    #
+    # options
+    #
+
+    # Get options
+    def options
+      @options ||= {}
+    end
+
+    # Set options
+    def options=(value)
+      @options = value.dup
+    end
+
+    # Should we log in verbose mode?
+    def verbose?
+      logger.level == Logger::DEBUG
+    end
+
+    # Should we log in quiet mode?
+    def quiet?
+      logger.level == Logger::ERROR
+    end
+
+    # Set logging to verbose (DEBUG)
+    def verbose!
+      logger.level = Logger::DEBUG
+    end
+
+    # Set logging to quiet (ERROR)
+    def quiet!
+      logger.level = Logger::ERROR
+    end
+
+    # Should we use color? Inferred from $stdout.tty? if not set.
+    def log_with_color?
+      return @log_with_color if defined?(@log_with_color)
+      $stdout.tty?
+    end
+
+    # Set whether we should use color.
+    def log_with_color=(value)
+      @log_with_color = value
+    end
+
+    #
+    # banner/warning/fatal
+    #
+
+    # Log a colored banner in green.
+    def banner(str, log_level: Logger::INFO, color: GREEN)
+      s = "#{str} ".ljust(72, " ")
+      s = "[#{Time.new.strftime("%H:%M:%S")}] #{s}"
+      s = "#{color}#{s}#{RESET}" if log_with_color?
+      logger.add(log_level, s)
+      nil
+    end
+
+    # Log a yellow warning banner.
+    def warning(str)
+      banner("Warning: #{str}", log_level: Logger::WARN, color: YELLOW)
+    end
+
+    # Log a red error banner, then exit.
+    def fatal(str)
+      banner(str, log_level: Logger::FATAL, color: RED)
+      exit(1)
+    end
+
+    # Simple log formatter with no timestamp.
+    class Formatter < Logger::Formatter
+      def call(_severity, _time, _progname, msg)
+        "#{msg}\n"
+      end
+    end
+  end
+end

data/lib/scripto/main.rb

@@ -4,15 +4,12 @@ module Scripto
   class Main
     include CsvCommands
     include FileCommands
+    include LogCommands
     include MiscCommands
-    include PrintCommands
     include RunCommands
 
-    attr_accessor :options
-
     def initialize(options = {})
       self.options = options
-      self.verbose = options[:verbose]
     end
   end
 end

data/lib/scripto/misc_commands.rb

@@ -1,9 +1,9 @@
-require 'digest/md5'
-require 'etc'
+require "digest/md5"
+require "etc"
 
 module Scripto
   module MiscCommands
-    BASE_62 = ('0'..'9').to_a + ('A'..'Z').to_a + ('a'..'z').to_a
+    BASE_62 = ("0".."9").to_a + ("A".."Z").to_a + ("a".."z").to_a
 
     # Who is the current user?
     def whoami
@@ -12,16 +12,12 @@ module Scripto
 
     # Return true if the current user is "root".
     def root?
-      whoami == 'root'
+      whoami == "root"
     end
 
     # Return the md5 checksum for the file at +path+.
     def md5_file(path)
-      File.open(path) do |f|
-        digest, buf = Digest::MD5.new, ''
-        digest.update(buf) while f.read(4096, buf)
-        digest.hexdigest
-      end
+      Digest::MD5.file(path).hexdigest
     end
 
     # Return the md5 checksum for +str+.

data/lib/scripto/run_commands.rb

@@ -1,22 +1,20 @@
-require 'English'
-require 'shellwords'
+require "English"
+require "shellwords"
 
 module Scripto
   module RunCommands
     # The error thrown by #run, #run_capture and #run_quietly on failure.
-    class Error < StandardError
+    class RunError < StandardError
     end
 
-    # Run an external command. Raise Error if something goes wrong. The
+    # Run an external command. Raise RunError if something goes wrong. The
     # command will be echoed if verbose?.
     #
     # Usage is similar to Kernel#system. If +args+ is nil, +command+ will be
-    # passed to the shell. If +args+ are included, the +command+ and +args+
-    # will be run directly without the shell.
+    # passed to the shell. If +args+ are included, the +command+ and +args+ will
+    # be run directly without the shell.
     def run(command, args = nil)
-      cmd = CommandLine.new(command, args)
-      vputs(cmd)
-      cmd.run
+      CommandLine.new(command, args).run
     end
 
     # Run a command and capture the output like backticks. See #run
@@ -36,7 +34,7 @@ module Scripto
     def run_succeeds?(command, args = nil)
       run_quietly(command, args)
       true
-    rescue Error
+    rescue RunError
       false
     end
 
@@ -74,24 +72,24 @@ module Scripto
         begin
           captured = `#{self}`
         rescue Errno::ENOENT
-          raise Error, "#{self} failed : ENOENT (No such file or directory)"
+          raise RunError, "#{self} failed : ENOENT (No such file or directory)"
         end
         raise!($CHILD_STATUS) if $CHILD_STATUS != 0
         captured
       end
 
       def raise!(status)
-        if status.termsig == Signal.list['INT']
+        if status.termsig == Signal.list["INT"]
           raise "#{self} interrupted"
         end
 
-        raise Error, "#{self} failed : #{status.to_i / 256}"
+        raise RunError, "#{self} failed : #{status.to_i / 256}"
       end
 
       def to_s
         if !args.empty?
-          escaped = args.map { |i| Shellwords.escape(i) }
-          "#{command} #{escaped.join(' ')}"
+          escaped = args.map { Shellwords.escape(_1) }
+          "#{command} #{escaped.join(" ")}"
         else
           command
         end