scripto 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 682b3b4d477f4c653c2f4f28b650eeb539d7c7fd
-  data.tar.gz: 1b9e0f393c6d9666f6cb374ca2c485ca95272fc6
+SHA256:
+  metadata.gz: 7cdd03bc1a558ff5c9f151d972205bde0816ad6feb89de992ae141bd637ebc54
+  data.tar.gz: b5c45a7c274391597e1c6dcd2e91579cdb09cc028bda6179a1762f010d005a73
 SHA512:
-  metadata.gz: 2780520e158ddcf2843a38361c1fd64a9d041c7c215901ad6fe95e5932c43acca75fbda8bf2af8bb6c3928b795e41edf46e2ef3e7cd913d758558d7d8428bcd2
-  data.tar.gz: de8a0e1eb329fddfe4ff9e86efc65ecbaacc2765c6bbaed3877492b5e58f97b5f89af5d9d5f719fd4743a5171c9c31632c52b2fc63311b460f692bcfb50f5f32
+  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,18 +1 @@
 *.gem
-*.rbc
-.bundle
-.config
-.vagrant
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-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,13 +1,15 @@
-# 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)
 
-Scripto is a framework for writing command line applications. It fills in many of the blanks that Ruby's standard library is missing:
+# Scripto
 
-* **print to $stderr** - 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.
+Scripto is a framework for writing Ruby command line applications. It fills in many of the blanks that Ruby's standard library is missing:
 
-Rdoc at [rdoc.info](http://rdoc.info/github/gurgeous/scripto/). Thanks!
+- **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.
 
 ## Getting Started
 
@@ -41,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")
@@ -65,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
@@ -151,3 +154,17 @@ md5_string(str)    - calculate md5 for a string
 prompt?(question)  - ask the user a question, return true if they say yes
 random_string(len) - calculate a random alphanumeric string
 ```
+
+# Changelog
+
+### 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,16 +1,5 @@
-require "bundler/gem_tasks"
+require "bundler/setup"
 require "rake/testtask"
-require "rdoc/task"
 
-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

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,4 +1,5 @@
 require "csv"
+require "tempfile"
 require "zlib"
 
 module Scripto
@@ -6,16 +7,17 @@ module Scripto
     # Read a csv from +path+. Returns an array of Structs, using the keys from
     # the csv header row.
     def csv_read(path)
-      lines = if path =~ /\.gz$/
-        Zlib::GzipReader.open(path) do |f|
-          CSV.new(f).read
+      rows = if /\.gz$/.match?(path)
+        Zlib::GzipReader.open(path) do
+          CSV.new(_1).read
         end
       else
-        CSV.read(path)
+        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,
@@ -23,26 +25,22 @@ module Scripto
     # first row are used as the csv header. If +cols+ is specified, it will be
     # used as the column keys instead.
     def csv_write(path, rows, cols: nil)
-      begin
-        tmp = "/tmp/_scripto_csv.csv"
-        CSV.open(tmp, "wb") { |f| csv_write0(f, rows, cols: cols) }
-        mv(tmp, path)
-      ensure
-        rm_if_necessary(tmp)
+      atomic_write(path) do |tmp|
+        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
@@ -56,8 +54,8 @@ 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
-end
+end

data/lib/scripto/file_commands.rb

@@ -36,13 +36,11 @@ module Scripto
     # Like ln -sf +src+ +dst. The command will be printed out if
     # verbose?.
     def ln(src, dst)
-      begin
-        FileUtils.ln_sf(src, dst, verbose: verbose?)
-      rescue Errno::EEXIST => e
-        # It's a race - this can occur because ln_sf removes the old
-        # dst, then creates the symlink. Raise if they don't match.
-        raise e if !(File.symlink?(dst) && src == File.readlink(dst))
-      end
+      FileUtils.ln_sf(src, dst, verbose: verbose?)
+    rescue Errno::EEXIST => e
+      # It's a race - this can occur because ln_sf removes the old
+      # dst, then creates the symlink. Raise if they don't match.
+      raise e if !(File.symlink?(dst) && src == File.readlink(dst))
     end
 
     # Like rm -f +file+. Like all file commands, the operation will be printed
@@ -55,45 +53,43 @@ module Scripto
     # directory had to be created. This is useful with verbose?, to get an
     # exact changelog.
     def mkdir_if_necessary(dir, owner: nil, mode: nil)
-      if !(File.exist?(dir) || File.symlink?(dir))
-        mkdir(dir, owner: owner, mode: mode)
-        true
-      end
+      return if File.exist?(dir) || File.symlink?(dir)
+
+      mkdir(dir, owner:, mode:)
+      true
     end
 
     # Runs #cp, but ONLY if +dst+ doesn't exist or differs from +src+. Returns
     # true if the file had to be copied. This is useful with verbose?, to get
     # an exact changelog.
     def cp_if_necessary(src, dst, mkdir: false, owner: nil, mode: nil)
-      if !(File.exist?(dst) && FileUtils.compare_file(src, dst))
-        cp(src, dst, mkdir: mkdir, owner: owner, mode: mode)
-        true
-      end
+      return if File.exist?(dst) && FileUtils.compare_file(src, dst)
+
+      cp(src, dst, mkdir:, owner:, mode:)
+      true
     end
 
     # Runs #ln, but ONLY if +dst+ isn't a symlink or differs from +src+.
     # Returns true if the file had to be symlinked. This is useful with
     # verbose?, to get an exact changelog.
     def ln_if_necessary(src, dst)
-      ln = if !File.symlink?(dst)
-        true
-      elsif File.readlink(dst) != src
+      if File.symlink?(dst)
+        return if src == File.readlink(dst)
+
         rm(dst)
-        true
-      end
-      if ln
-        ln(src, dst)
-        true
       end
+
+      ln(src, dst)
+      true
     end
 
     # Runs #rm, but ONLY if +file+ exists. Return true if the file had to be
     # removed. This is useful with verbose?, to get an exact changelog.
     def rm_if_necessary(file)
-      if File.exist?(file)
-        rm(file)
-        true
-      end
+      return if !File.exist?(file)
+
+      rm(file)
+      true
     end
 
     # Like chown user:user file. Like all file commands, the operation will be printed
@@ -103,23 +99,24 @@ module Scripto
       @scripto_uids ||= {}
       @scripto_uids[user] ||= Etc.getpwnam(user).uid
       uid = @scripto_uids[user]
-      if File.stat(file).uid != uid
-        FileUtils.chown(uid, uid, file, verbose: verbose?)
-      end
+      return if File.stat(file).uid == uid
+
+      FileUtils.chown(uid, uid, file, verbose: verbose?)
     end
 
     # Like chmod mode file. Like all file commands, the operation will be
     # printed out if verbose?.
     def chmod(file, mode)
-      if File.stat(file).mode != mode
-        FileUtils.chmod(mode, file, verbose: verbose?)
-      end
+      return if File.stat(file).mode == mode
+
+      FileUtils.chmod(mode, file, verbose: verbose?)
     end
 
     # 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 == ""
+
       FileUtils.rm_rf(dir, verbose: verbose?)
       mkdir(dir)
     end
@@ -131,5 +128,16 @@ module Scripto
       File.chmod(stat.mode, dst)
       File.utime(stat.atime, stat.mtime, dst)
     end
+
+    # Atomically write to +path+. An open temp file is yielded.
+    def atomic_write(path)
+      tmp = Tempfile.new(File.basename(path))
+      yield(tmp)
+      tmp.close
+      chmod(tmp.path, 0o644)
+      mv(tmp.path, path)
+    ensure
+      rm_if_necessary(tmp.path)
+    end
   end
-end
+end

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
+end