system_command 2.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17d5804e3398846f17e91e8b17810c4eec250075f778323d7720248ff1989de9
+  data.tar.gz: d501f75ca3bc25fcc8cd6af226e8e02149258746513b5fae58f182e866c475e1
+SHA512:
+  metadata.gz: 14634afaced6e4009b35bc1eb4d8e167b7db2a068ddfa2563a8518a786e4e90b39b28258860fdfcf20100290fbc7c31adfa8adf505da43ff599c0db2c22ca46e
+  data.tar.gz: 6eb7d58bc91aac42861f5368f026bfece3279e8bcbd4ce31249048224cd1e06d0220a4cd85ac11b6a71c8f20a9f3c59e8f2de3979cc19463657440c336d7c695

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from: .rubocop_coldwater.yml
+require:
+ - rubocop-rspec

data/.rubocop_coldwater.yml

@@ -0,0 +1,92 @@
+### Coldwater Systems Style Guide ##############################################
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2.0
+
+# The default of special_inside_parentheses involves too much indentation in
+# many cases.
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+# Stylistic preference that we think improves readability of complex hashes.
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Trailing comma makes editing multi-line literals slightly easier since lines
+# can be re-ordered, added, or removed without touching commas.
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+# Space inside braces is reserved for single line blocks.
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# I like the way it looks for block params to be attached to the opening brace.
+Layout/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+# It feels safer and easier to read if math operators are preferred.
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+# %i[] is rarely seen and I think obfuscates the fact that symbols are involved.
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# It pays to be direct, and oftentimes module names are shorter than "described_class"
+RSpec/DescribedClass:
+  EnforcedStyle: explicit
+
+# It feels more consistent with `be false` and `be true`
+RSpec/BeNil:
+  EnforcedStyle: be
+
+### Opt-ins ####################################################################
+
+Layout/EmptyLineAfterMultilineCondition:
+  Enabled: true
+Layout/HeredocArgumentClosingParenthesis:
+  Enabled: true
+Lint/NumberConversion:
+  Enabled: true
+Lint/HeredocMethodCallPosition:
+  Enabled: true
+Style/AutoResourceCleanup:
+  Enabled: true
+Style/RequireOrder:
+  Enabled: true
+Lint/Void:
+  CheckForMethodsWithNoSideEffects: true
+
+### Opt-outs ###################################################################
+
+# Can be useful as a guideline but most of these just contribute to noise.
+Metrics:
+  Enabled: false
+
+# Would be nice if this caught uncommon operator combinations but this also
+# lints PEMDAS operators.
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+# Oftentimes there's a whole block of oneline getters, and it looks weird to
+# have them double spaced.
+Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+# Don't flag single statement bodies because these often guards, and reworking
+# the code to not trigger this cop usually produces worse results in that case.
+Style/GuardClause:
+  MinBodyLength: 2
+
+# Don't flag numbers below 1 million because often times numbers below this are
+# often port numbers, which look weird when underscored. Above 1 million, the
+# underscore separators become very important for readability.
+Style/NumericLiterals:
+  MinDigits: 7

data/.vscode/launch.json

@@ -0,0 +1,12 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "rdbg",
+      "name": "rspec",
+      "request": "launch",
+      "cwd": "${workspaceFolder}",
+      "script": "bin/rspec",
+    },
+  ]
+}

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in system_command.gemspec
+gemspec
+
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-rspec', '~> 2.23'
+gem 'simplecov', '~> 0.22.0'

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    system_command (2.0.2)
+      colorize (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    colorize (1.1.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.2)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.23.2)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rspec (~> 2.23)
+  simplecov (~> 0.22.0)
+  system_command!
+
+BUNDLED WITH
+   2.4.22

data/README.md

@@ -0,0 +1,28 @@
+# SystemCommand
+
+`SystemCommand` allows you to run external process as if they were functions.
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests.
+
+To install this gem onto your local machine, run `rake install`.
+
+To release a new version:
+
+- Switch to the `main` branch.
+- Bump `lib/system_command/version.rb`, run `bundle install`, then commit the result.
+- Switch to the `v2` branch.
+- Run `git merge main`
+- Run `rake release`, which will create/push a git tag and publish the `.gem`
+  file to [rubygems.org].
+
+[rubygems.org]: https://rubygems.org
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at <https://gitlab.com/coldwater-systems/system_command>.

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'

data/lib/system_command/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class SystemCommand
+  VERSION = '2.0.2'
+end

data/lib/system_command.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'colorized_string'
+require 'shellwords'
+
+# Allows you to run external process with syntax a little bit more polished than
+# the ruby built-ins.
+#
+# Turn an external process into a class:
+#
+#     git = SystemCommand.new('git')
+#     git.run('status')
+class SystemCommand
+  Error = Class.new(StandardError)
+
+  class << self
+    def verbose?
+      @verbose ||= false
+    end
+
+    attr_writer :verbose
+
+    def run?(*, **)
+      argv0, *argv = coerce_argv(*)
+
+      puts_command argv0, argv
+      system([argv0, argv0], *argv, **)
+    end
+
+    def run(*, **)
+      argv0, *argv = coerce_argv(*)
+
+      puts_command argv0, argv
+      system([argv0, argv0], *argv, **)
+      raise SystemCommand::Error, "#{argv0} failed (#{Process.last_status})" unless Process.last_status.success?
+
+      nil
+    end
+
+    def gets(*, **)
+      argv0, *argv = coerce_argv(*)
+
+      puts_command argv0, argv
+      result = IO.popen([argv0, *argv], **, &:read)
+      raise SystemCommand::Error, "#{argv0} failed (#{Process.last_status})" unless Process.last_status.success?
+
+      result
+    end
+
+    def lines(*, chomp: false, **) = gets(*, **).lines(chomp:)
+
+    def each_line(*, chomp: false, **, &)
+      argv0, *argv = coerce_argv(*)
+      raise LocalJumpError, 'no block given' unless block_given?
+
+      puts_command argv0, argv
+      IO.popen([argv0, *argv], **) do |io|
+        io.each_line(chomp:, &)
+      end
+      raise SystemCommand::Error, "#{argv0} failed (#{Process.last_status})" unless Process.last_status.success?
+
+      nil
+    end
+
+    private
+
+    def coerce_argv(*args)
+      args = Array(args.first) if args.length == 1
+      raise ArgumentError, 'Must specify one or more argument' if args.empty?
+
+      args.map do |arg|
+        arg = arg.to_path if arg.respond_to?(:to_path)
+        arg
+      end
+    end
+
+    def puts_command(argv0, argv)
+      puts ColorizedString["$ #{[argv0, *argv].shelljoin}"].light_black if verbose?
+    end
+  end
+
+  def initialize(path, *options)
+    @path = path
+    @options = options
+  end
+
+  def run?(...) = SystemCommand.run?(@path, *@options, ...)
+  def run(...) = SystemCommand.run(@path, *@options, ...)
+  def gets(...) = SystemCommand.gets(@path, *@options, ...)
+  def lines(...) = SystemCommand.lines(@path, *@options, ...)
+  def each_line(...) = SystemCommand.each_line(@path, *@options, ...)
+end
+
+require_relative 'system_command/version'

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: system_command
+version: !ruby/object:Gem::Version
+  version: 2.0.2
+platform: ruby
+authors:
+- Alex Gittemeier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description:
+email:
+- me@a.lexg.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_coldwater.yml"
+- ".vscode/launch.json"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/system_command.rb
+- lib/system_command/version.rb
+homepage: https://gitlab.com/coldwater-systems/system_command
+licenses: []
+metadata:
+  homepage_uri: https://gitlab.com/coldwater-systems/system_command
+  source_code_uri: https://gitlab.com/coldwater-systems/system_command
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Run external process as if they were functions.
+test_files: []