shellb 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f3a0166d547f1e9cadca213c3c4966f958d6deaf424cca3e41c7814fac41cf9
+  data.tar.gz: 63230d226d8e24acc56416bd12d737082d140ea0a785ddec4d0994365b7b4e0a
+SHA512:
+  metadata.gz: 38be6a731225de410c59815878f1927cade0f3f01af8bc4181930dae66ec352247891c726bef7230f707419e80e3b3d553c0df6986896e42d9d6f8eb5dee14b2
+  data.tar.gz: 1e3f462b44ffef6b6340f99c02921429c1449f49ed4a30b0454dddd7cad8b252611bef5d5fec75e66b14dccdf3083bb62a39de990904b206abe8e18073c21930

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2
+install: bundle install
+script: bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project **may some day** to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.2] - 2019-12-03
+### Added
+- Shell#attempt will execute a script and ignore errors
+
+### Changed
+- Shell#check_point now executes scripts
+- Shell#transact no longer allows chaining with other commands
+
+## [0.0.1] - 2019-12-02
+### Added
+- Initial version of ShellB

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in shellb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    shellb (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry-byebug (~> 3.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  shellb!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ryan Duryea
+
+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,156 @@
+# ShellB
+
+`ShellB` (pronounced Shelby) is a shell script builder.  The goal is to be a (near) drop-in replacement for Ruby's `Shell` class
+
+
+## FAQ
+
+### Wha?  Why?
+
+I've long loved Ruby's `Shell` class, essentially a DSL for building a shell script.
+
+Imagine my dismay when I realized that piping information between commands in `Shell` is done _through_ Ruby, making my beautiful shell scripts _slow_ and _hungry_ for memory.
+
+I wanted something that would build out my shell scripts like `Shell`, but would _stay_ in the shell where commands and pipes work quickly and smoothly.
+
+### I used `ShellB` in place of `Shell` and it didn't work
+
+Yikes.  I'm not surprised. The library Works For Me in that the few places I use it and I haven't really developed it beyond my own needs.
+
+Also, there are some differences I can't figure out how to avoid.
+
+### Why are there so many \\\\\\\\'s in my script?
+
+Ruby's `Shellwords` library does that.  If you know of a better library for properly escaping shell-related strings, let me know!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shellb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shellb
+
+## Usage
+
+`ShellB` is intended to work similarly to Shell.  There are a few differences:
+
+1. All commands you intend to use must be defined via `ShellB.def_system_command`
+2. Unlike `Shell`, `ShellB` will not run any commands on its own.  You must either
+  - Call `#run` on a `ShellB::Shell` instance
+  - Call `ShellB::Shell#run { <commands here> }` which will immediately execute the script
+
+See the examples below.
+
+## Examples
+
+```
+%w[a b c d e f g].each do |cmd|
+  ShellB.def_system_command(cmd)
+end
+
+# Support Shell's #transact method -- my favorite way to build a script
+shb = ShellB.new
+script = shb.transact do
+  a | b | c("--last", "--delimiter", "\t")
+end
+puts script # a | b | c --last --delimiter "\t"
+
+# Invoke methods directly on ShellB::Shell instance
+shb = ShellB.new
+shb.a("--help") | shb.e("last")
+puts shb.to_sh # => a --help | e last
+
+# Run a script
+shb = ShellB.new
+shb.a("--help") | shb.e("last")
+shb.run # creates a temporary script file and invokes it using Bash
+
+# Immediately run a script after building it
+ShellB.new.run do
+  a | b
+  c
+end
+
+# Support `cd` ala Shell
+# NOT YET IMPLEMENTED
+shb.cd("/tmp") do
+  pwd
+end # => (cd /tmp ; pwd)
+
+# Handle Multiple Inputs into a Command
+# Allow variable names as arguments
+# NOT YET IMPLEMENTED
+file1_csv = "/tmp/file1.csv"
+file2_csv = "/tmp/file2.csv"
+shb.transact do
+  diff \
+    < transact(do
+        xsv("sort", file1_csv) | head
+      end) \
+    < transact({
+        xsv("sort", file2_csv) | tail
+      })
+end # => diff <(xsv sort /tmp/file1.csv | head) <(xsv sort /tmp/file2.csv | tail)
+```
+
+## Future Ideas
+
+Some ideas I'm toying with:
+
+### Support for hash => switches
+
+It might be handy to feed a hash to a command and have that generate the appropriate switches for a command.
+
+Something like:
+
+```
+shb = ShellB.new
+shb.transact do
+  e(long_switch: "value", s: true)
+end
+puts shb.to_sh # => e --long-switch value -s
+```
+
+However, how do we handle some of the following?
+
+- Underscore vs dash in long names?
+  - E.g. does `long_switch_name` become `--long-switch-name` or `--long_switch_name`
+- For long switches, do we include an equals sign if a value is included?
+  - E.g. does `long_switch_name: "value"` become `--long-switch-name=value` or `--long-switch-name value`
+- For switches without arguments, do we relegate those to an array only, or allow them in the hash?
+  - E.g. does `s: true` become `-s`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Similar Projects
+
+As any good programmer, I wrote first and googled later.  Here are some other projects that seem very similar to ShellB:
+
+- https://github.com/jgoizueta/sys_cmd
+- https://github.com/duncanbeevers/sheller
+- https://github.com/fetlife/scallop
+- https://github.com/quark-zju/easysh
+- https://github.com/eropple/shellator
+- https://github.com/petyosi/shellshot
+- https://github.com/taccon/eksek
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/aguynamedryan/shellb.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shellb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shellb.rb

@@ -0,0 +1,25 @@
+require "shellb/version"
+require "shellb/shell"
+begin
+  require "pry-byebug"
+rescue LoadError
+end
+
+module ShellB
+  class Error < StandardError; end
+  class ExecutionError < StandardError; attr_accessor :script ; end
+  # Your code goes here...
+  class << self
+    def new(*args)
+      Shell.new(*args)
+    end
+
+    def def_system_command(*args)
+      Shell.def_system_command(*args)
+    end
+
+    def alias_command(*args)
+      Shell.alias_command(*args)
+    end
+  end
+end

data/lib/shellb/command.rb

@@ -0,0 +1,69 @@
+require "shellwords"
+
+module ShellB
+  class Command
+    attr_reader :name, :opts, :shell, :block
+    attr_accessor :downstream
+
+    def initialize(shell, name, *opts)
+      @shell = shell
+      @name = name
+      @opts = opts
+    end
+
+    def |(command)
+      shell.drop_command(command)
+      self.downstream = command
+    end
+
+    def >(to)
+      @output = to
+      self
+    end
+
+    def >>(to)
+      @append = to
+      self
+    end
+
+    def <(from)
+      @input = from
+      self
+    end
+
+    def redirection_parts
+      return [">", @output.to_s] if @output
+      return [">>", @append.to_s] if @append
+      return ["<", @input.to_s] if @input
+      return []
+    end
+
+    def to_s
+      "<Command: #{name} #{opts.join(" ")}>"
+    end
+
+    def to_sh
+      parts = []
+      parts << Shellwords.shelljoin([name, *opts])
+
+      unless (rd_parts = redirection_parts.join(" ")).empty?
+        parts.last << " " + rd_parts
+      end
+
+      parts << downstream.to_sh if downstream
+      parts.join(" | ")
+    end
+
+    def pretty_print(pp)
+      pp.object_group(self) do
+        pp.breakable
+        pp.text "@name="
+        pp.pp @name
+
+        pp.breakable
+        pp.text "@opts="
+        pp.pp @opts
+      end
+    end
+  end
+end

data/lib/shellb/commander.rb

@@ -0,0 +1,32 @@
+require_relative "command"
+
+module ShellB
+  class Commander
+    attr_reader :shell
+
+    class << self
+      def def_system_command(name, path = nil)
+        define_method(name) do |*args|
+          Command.new(shell, path || name, *args)
+        end
+      end
+
+      def alias_command(name, *args)
+        define_method(name) do |*opts|
+          Command.new(shell, *args, *opts)
+        end
+      end
+    end
+
+    DEFAULT_COMMANDS = %w[
+      cd
+      pwd
+    ].each do |cmd|
+      def_system_command(cmd)
+    end
+
+    def initialize(shell)
+      @shell = shell
+    end
+  end
+end

data/lib/shellb/shell.rb

@@ -0,0 +1,133 @@
+require "tempfile"
+require_relative "commander"
+
+module ShellB
+  class Shell
+    class << self
+      def def_system_command(name, path = nil)
+        Commander.def_system_command(name, path)
+      end
+
+      def alias_command(name, *args)
+        Commander.alias_command(name, *args)
+      end
+    end
+
+    attr_reader :opts
+    def initialize(opts = {})
+      @commands = []
+      @opts = opts
+    end
+
+    def transact(opts = {}, &block)
+      instance_eval(&block) if block
+      check_point(opts) if opts[:execute]
+    end
+
+    def run(opts = {}, &block)
+      transact(opts.merge(execute: true), &block)
+    end
+
+    def run!(opts = {}, &block)
+      run(opts.merge(exit_on_errors: true), &block)
+    end
+
+    def attempt(opts = {}, &block)
+      run(opts.merge(ignore_errors: true), &block)
+    end
+
+    def add_command(command)
+      @commands << command
+      command
+    end
+
+    def drop_command(command)
+      @commands -= [command]
+    end
+
+    def check_point(opts = {})
+      script = Tempfile.new("script.sh")
+      script.write(to_sh(opts))
+      script.close
+      output = `bash #{script.path}`
+      unless $?.exitstatus.zero?
+        ee = ShellB::ExecutionError.new(output)
+        ee.script = File.read(script)
+        raise ee
+      end
+    rescue ShellB::ExecutionError => ee
+      raise(ee) unless opts[:ignore_errors]
+    ensure
+      @commands = []
+      script.close!
+    end
+    alias execute check_point
+
+    def to_sh(opts = {})
+      str = make_preamble(opts)
+      str += @commands.map do |command|
+        decorate_command(command, opts)
+      end.join("\n\n")
+      str
+    end
+
+    def decorate_command(command, opts)
+      cmd_str = command.to_sh
+      append = if opts[:exit_on_errors]
+                 "exit $?"
+               elsif opts[:ignore_errors]
+                 "true"
+               else
+                 nil
+               end
+      cmd_str = wrap_it(cmd_str, "(") unless command.name == "cd"
+      [cmd_str, append].compact.join(" || ")
+    end
+
+    def method_missing(meth, *args)
+      return super unless commander.respond_to?(meth)
+      add_command(commander.public_send(meth, *args))
+    end
+
+    def make_preamble(opts)
+      preamble = []
+      if opts[:exit_on_errors]
+        preamble << %w[set -x]
+        preamble << %w[set -e]
+        preamble << []
+      end
+      preamble = preamble.map { |pream| Shellwords.join(pream) }
+      preamble.join("\n")
+    end
+
+    def respond_to?(meth)
+      super || commander.respond_to?(meth)
+    end
+
+    def commander
+      @commander ||= Commander.new(self)
+    end
+
+    def pretty_print(pp)
+      pp.object_group(self) do
+        pp.breakable
+        pp.text "@commands="
+        pp.pp @commands
+      end
+    end
+
+    private
+
+    def wrap_it(str, wrap_char)
+      return str if wrap_char.nil?
+
+      wrap_char = "(" if wrap_char == true
+      end_char = {
+        "(" => ")",
+        "{" => "}",
+        "[" => "]"
+      }[wrap_char] || raise("No matching character for #{wrap_char}")
+      "#{wrap_char} #{str} #{end_char}"
+    end
+  end
+end

data/lib/shellb/version.rb

@@ -0,0 +1,3 @@
+module ShellB
+  VERSION = "0.0.2"
+end

data/shellb.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shellb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shellb"
+  spec.version       = ShellB::VERSION
+  spec.authors       = ["Ryan Duryea"]
+  spec.email         = ["aguynamedryan@gmail.com"]
+
+  spec.summary       = %q{Light DSL to generate shell scripts}
+  spec.description   = %q{DSL for shell scripts similar to Ruby's Shell class.}
+  spec.homepage      = "https://github.com/aguynamedryan/shellb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/aguynamedryan/shellb"
+    spec.metadata["changelog_uri"] = "https://github.com/aguynamedryan/shellb/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: shellb
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ryan Duryea
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: DSL for shell scripts similar to Ruby's Shell class.
+email:
+- aguynamedryan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shellb.rb
+- lib/shellb/command.rb
+- lib/shellb/commander.rb
+- lib/shellb/shell.rb
+- lib/shellb/version.rb
+- shellb.gemspec
+homepage: https://github.com/aguynamedryan/shellb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/aguynamedryan/shellb
+  source_code_uri: https://github.com/aguynamedryan/shellb
+  changelog_uri: https://github.com/aguynamedryan/shellb/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Light DSL to generate shell scripts
+test_files: []