shellb 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d84b5194e0e060985310712fb4bb3babbd1433bf3d05d5b897340df509f23fe
-  data.tar.gz: 5924d05b401baefbec39d49c870a7500b0bb9de4e212c980d3da8f2a56f7b935
+  metadata.gz: 8f3a0166d547f1e9cadca213c3c4966f958d6deaf424cca3e41c7814fac41cf9
+  data.tar.gz: 63230d226d8e24acc56416bd12d737082d140ea0a785ddec4d0994365b7b4e0a
 SHA512:
-  metadata.gz: 6a013a5ee6be8d4d6bb1e319939c5028e9905069d4dbe5a1dd7ebc1025f1b3560ef51027dd3f3b58c68b6386c2b54a3ef238fe36a286ee8eb9f0e5dfcfd978a9
-  data.tar.gz: 814d7956dc9aceb546982e5faf89795b7ab4d119b5e75ab8d460f760a8e6d95f80962de527120be63a7c814484320eabac554311c563262e5bf78d645db0d639
+  metadata.gz: 38be6a731225de410c59815878f1927cade0f3f01af8bc4181930dae66ec352247891c726bef7230f707419e80e3b3d553c0df6986896e42d9d6f8eb5dee14b2
+  data.tar.gz: 1e3f462b44ffef6b6340f99c02921429c1449f49ed4a30b0454dddd7cad8b252611bef5d5fec75e66b14dccdf3083bb62a39de990904b206abe8e18073c21930

data/CHANGELOG.md

@@ -4,6 +4,14 @@ 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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shellb (0.0.1)
+    shellb (0.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -69,13 +69,6 @@ shb = ShellB.new
 shb.a("--help") | shb.e("last")
 puts shb.to_sh # => a --help | e last
 
-# Mix transact and direct methods
-shb = ShellB.new
-shb.a("--help") | shb.transact do
-  e("last") > dest.txt
-end
-puts shb.to_sh # => a --help | e last > dest.txt
-
 # Run a script
 shb = ShellB.new
 shb.a("--help") | shb.e("last")
@@ -142,6 +135,18 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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.

data/lib/shellb/shell.rb

@@ -19,9 +19,21 @@ module ShellB
       @opts = opts
     end
 
-    def transact(&block)
-      instance_eval(&block)
-      @commands.last
+    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)
@@ -33,10 +45,7 @@ module ShellB
       @commands -= [command]
     end
 
-    def run(opts = {}, &block)
-      if block
-        transact(&block)
-      end
+    def check_point(opts = {})
       script = Tempfile.new("script.sh")
       script.write(to_sh(opts))
       script.close
@@ -46,13 +55,13 @@ module ShellB
         ee.script = File.read(script)
         raise ee
       end
+    rescue ShellB::ExecutionError => ee
+      raise(ee) unless opts[:ignore_errors]
     ensure
+      @commands = []
       script.close!
     end
-
-    def run!(opts = {}, &block)
-      run(opts.merge(exit_on_errors: true), &block)
-    end
+    alias execute check_point
 
     def to_sh(opts = {})
       str = make_preamble(opts)
@@ -64,9 +73,15 @@ module ShellB
 
     def decorate_command(command, opts)
       cmd_str = command.to_sh
-      return cmd_str unless opts[:exit_on_errors]
+      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} || exit $?"
+      [cmd_str, append].compact.join(" || ")
     end
 
     def method_missing(meth, *args)
@@ -93,10 +108,6 @@ module ShellB
       @commander ||= Commander.new(self)
     end
 
-    def check_point
-      #no-op
-    end
-
     def pretty_print(pp)
       pp.object_group(self) do
         pp.breakable

data/lib/shellb/version.rb

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

data/shellb.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["aguynamedryan@gmail.com"]
 
   spec.summary       = %q{Light DSL to generate shell scripts}
-  spec.description   = %q{Ruby's Shell class is awesome, but it is slow and memory intensive because all IO passes through Ruby.  This gem is heavily inspired by the Shell class, but instead generates a script that executes in a shell without having Ruby in the mix, keeping things fast.}
+  spec.description   = %q{DSL for shell scripts similar to Ruby's Shell class.}
   spec.homepage      = "https://github.com/aguynamedryan/shellb"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan Duryea
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,10 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Ruby's Shell class is awesome, but it is slow and memory intensive because
-  all IO passes through Ruby.  This gem is heavily inspired by the Shell class, but
-  instead generates a script that executes in a shell without having Ruby in the mix,
-  keeping things fast.
+description: DSL for shell scripts similar to Ruby's Shell class.
 email:
 - aguynamedryan@gmail.com
 executables: []