process_sip 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17b9364de22ae3b02b0a75a8784b4c901aeef3b54dbc6e5f38d6da60650a69b5
+  data.tar.gz: f461fc3bf4e53946752c408e66573dc74ab02e18f0df6bd6d886c06b2e3ab985
+SHA512:
+  metadata.gz: af80279a0da2234735734fb08bf8ac28601cccd2527bb527135436d10749c510ab8f69719266dcbe04fb7c109bdec562be9469def2953945152a0f52b730d175
+  data.tar.gz: 6e541702d7999251bb03e55a08e26fa4bbda7d47fd916ae0c652fe3a6b3b9c67feee09557c686f321308a98cba76e3686fdbd20492f3dce6d4325bcff5d63ad2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-03
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in process_sip.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest"
+gem "minitest-sprint"

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    process_sip (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.22.2)
+    minitest-sprint (1.2.2)
+      path_expander (~> 1.1)
+    path_expander (1.1.1)
+    rake (13.1.0)
+
+PLATFORMS
+  arm64-darwin-20
+  arm64-darwin-23
+
+DEPENDENCIES
+  minitest
+  minitest-sprint
+  process_sip!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.5.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kasper Timm Hansen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# ProcessSip
+
+ProcessSip lets you make ad-hoc adapters for CLIs to interface with from Ruby.
+
+Here's wrapping `git`:
+
+```ruby
+git = ProcessSip.git # Connect an adapter to an executable, here `git`.
+
+# Any subcommands are automatically proxied, so:
+git.branch.call    # Calls `git branch` on the commandline.
+git.branch :remote # Automatically calls when passed arguments, `git branch --remote`.
+git.branch :r # `git branch -r`. 1-count symbols get prefixed with -, while anything else gets --.
+
+git.branch :show_current # Get the current branch: `git branch --show-current`.
+
+git.diff.call # `git diff`
+git.status :name_only # `git diff --name-only`
+```
+
+And here's `bundle`:
+
+```ruby
+# Run `bundle install` and stream each line into the block:
+ProcessSip.bundle.install.stream do |line|
+  puts line
+end
+
+ProcessSip.bundle.update.call          # `bundle update`
+ProcessSip.bundle.update :only_bundler # `bundle update --only-bundler`
+
+ProcessSip.gem.update :system # `gem update --system`
+```
+
+The real power of ProcessSip is to extend the default proxying with your ad-hoc needs. So you can extend the `git` adapter like this:
+
+```ruby
+# Open an adapter for a specific executable, here `git`.
+ProcessSip.git do
+  def commit_all(message)
+    add "." and commit message
+  end
+
+  def commit(message)
+    super :m, message
+  end
+
+  def with_work_tree = with(work_tree: __dir__)
+  def with_git_dir   = with(git_dir: __dir__ + "/.git")
+end
+
+git = ProcessSip.git.with_work_tree.with_git_dir
+
+# Now every git command will use the --work-tree and --git-dir context arguments
+git.branch.call # `git --work-tree= --git-dir branch`
+
+deleted_lines = git.diff.select { _1.start_with?("- ") } # `git --work-tree= --git-dir diff`
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add process_sip
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install process_sip
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kaspth/process_sip.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/lib/process_sip/refinements.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ProcessSip::Refinements
+  refine(Symbol) { def dasherize = name.dasherize }
+  refine(String) { def dasherize = tr("_", "-") }
+
+  refine Object do
+    def clone_with(**instance_variables)
+      clone.tap do |object|
+        instance_variables.each { object.instance_variable_set "@#{_1}", _2 }
+      end
+    end
+  end
+end

data/lib/process_sip/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ProcessSip
+  VERSION = "0.1.0"
+end

data/lib/process_sip.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "shellwords"
+require_relative "process_sip/version"
+
+module ProcessSip
+  require_relative "process_sip/refinements"
+  using Refinements
+
+  # ProcessSip.load_each :git, :curl
+  def self.load_each(*names)
+    names.each do
+      require "lib/process_sip/adapters/#{_1}"
+    end
+  end
+
+  def self.method_missing(name, &)
+    Class.new(Adapter, &).new(name).tap do |adapter|
+      define_singleton_method(name) do |&block|
+        adapter.class.class_eval(&block) if block
+        adapter
+      end
+    end
+  end
+
+  class Adapter
+    def initialize(name)
+      @name, @context, @preprint = name.dasherize, Context.new, false
+    end
+
+    def omit(*keys)     = clone_with(context: @context.except(*keys))
+    def with(**options) = clone_with(context: @context.merge(**options))
+
+    def call(name, *, **, &block)
+      chain = [@name, @context.arguments, name.to_s.dasherize, process(*, **)].flatten.map(&:shellescape).join(" ")
+      puts chain if @preprint
+
+      IO.popen(chain, &block || -> { _1.read.chomp })
+    end
+
+    ruby2_keywords def method_missing(name, *arguments, &block)
+      Subcommand.new(self, name).then do |apply|
+        if block_given? || arguments.any?
+          apply.call(*arguments, &block)
+        else
+          apply
+        end
+      end
+    end
+
+    def preprint = clone_with(preprint: true)
+    def silent   = clone_with(preprint: false)
+
+    private
+      def process(*arguments, **options)
+        arguments.map { option_name _1 } + options.transform_keys { option_name _1 }.flatten
+      end
+
+      def option_name(name)
+        name.is_a?(Symbol) ? "#{name.size > 1 ? "--" : "-"}#{name.dasherize}" : name
+      end
+  end
+
+  class Subcommand < Data.define(:adapter, :name)
+    include Enumerable
+
+    def each(&) = stream(&)
+    alias each_line each
+
+    def match?(...) = call.match?(...)
+    def readlines(chomp: true) = call { _1.readlines(chomp:) }
+
+    def stream(*, **)
+      return enum_for(:stream, *, **) unless block_given?
+
+      call(*, **) do |io|
+        while line = io.gets&.chomp; yield line; end
+      end
+    end
+
+    def call(...) = adapter.call(name, ...)
+    alias method_missing call
+    alias read call
+  end
+
+  class Context
+    def initialize(**options)
+      @options = options
+      @arguments = @options.map { ["--#{_1.dasherize}", _2.shellescape].join("=") }
+    end
+    attr_reader :arguments
+
+    def except(*) = self.class.new(**@options.except(*))
+    def merge(**options) = self.class.new(**@options, **options)
+  end
+end

data/process_sip.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/process_sip/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "process_sip"
+  spec.version = ProcessSip::VERSION
+  spec.authors = ["Kasper Timm Hansen"]
+  spec.email = ["hey@kaspth.com"]
+
+  spec.summary  = "Make ad-hoc adapters for CLIs to interface with from Ruby."
+  spec.homepage = "https://github.com/kaspth/process_sip"
+  spec.license  = "MIT"
+  spec.required_ruby_version = ">= 3.3.0"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"]   = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/test.rb

@@ -0,0 +1,38 @@
+require_relative "lib/process_sip"
+
+# lib/process_sip/executables/git.rb
+git = ProcessSip.git do
+  def commit_all(message)
+    add "." and commit message
+  end
+
+  def commit(message)
+    super :m, message
+  end
+end
+p git
+
+git = ProcessSip.git do
+  def with_work_tree = with(work_tree: __dir__)
+  def with_git_dir   = with(git_dir: __dir__ + "/.git")
+end
+p git
+
+git = ProcessSip.git.preprint
+p git
+define_method(:git) { git }
+
+binding.irb
+
+# git.with_work_tree.with(git_dir: __dir__ + "/.git").omit(:git_dir, :work_tree)
+# git.with_work_tree.with_git_dir.omit(:git_dir, :work_tree)
+# git.with_work_tree.silent.preprint.branch :d, "branch"
+
+# def git.commit(message) = super(:m, message)
+#
+# def git.commit_all(message)
+#   add "." and commit message
+# end
+#
+# git_dir = git.with(git_dir: __dir__)
+# define_method(:git_dir) { git_dir }

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: process_sip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kasper Timm Hansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-18 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- hey@kaspth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/process_sip.rb
+- lib/process_sip/refinements.rb
+- lib/process_sip/version.rb
+- process_sip.gemspec
+- test.rb
+homepage: https://github.com/kaspth/process_sip
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kaspth/process_sip
+  source_code_uri: https://github.com/kaspth/process_sip
+  changelog_uri: https://github.com/kaspth/process_sip/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Make ad-hoc adapters for CLIs to interface with from Ruby.
+test_files: []