samovar 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a92bf8cd31c971fc9652c6cc1a1620f8587d8d41
-  data.tar.gz: acce28bc01d1016b2c6be77f15ea50ef88b6d576
+  metadata.gz: 245b832e19301eafe975c8bc751f3d8f7c5f5fab
+  data.tar.gz: 8db97750516f551f87c9d614958e53e191a0d665
 SHA512:
-  metadata.gz: a127d1fea13405231ca8c3386f0c848fafa741aa328d38825187eeae1a0f728feb9374cceec196d17ebf569465cbc141e070d3b88033013d9527a0ca71f57df6
-  data.tar.gz: dadcdda3c02b1df2b46e2d656e4bf980a17a75bc16595410aeb195bf9131e6315395241a9f95f82d7c7b4105ef082267738ca1e52128adf9358bbdec52364041
+  metadata.gz: 0a57f9f297cf8c2b77e7d49185991dc154bb7dc0968a0c220ea666d84306bb10a6fc07f8ece5593b3776deae3f356ed857475ac314dfc1fa5b5aea616e7c64ee
+  data.tar.gz: a76705582cda894101104c34d73ab0c7dcec1b15557302c5ed753fce3746ccacc27de7151a29855351abcb0411406f841c84244fd53ad322320e532e6f446a31

data/README.md

@@ -30,7 +30,11 @@ Or install it yourself as:
 
 ## Usage
 
-The best example of a working Samovar command line is probably [Teapot](https://github.com/ioquatix/teapot/blob/master/lib/teapot/command.rb). Please feel free to submit other examples and I will link to them here.
+The best example of a working Samovar command line is probably [Teapot](https://github.com/ioquatix/teapot/blob/master/lib/teapot/command.rb).
+
+[Utopia](https://github.com/ioquatix/utopia/blob/master/lib/utopia/command.rb) shows how to use multiple levels of nested commands.
+
+Please feel free to submit other examples and I will link to them here.
 
 ## Contributing
 

data/lib/samovar.rb

@@ -1,3 +1,22 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
 
 require_relative 'samovar/version'
 require_relative 'samovar/command'

data/lib/samovar/command.rb

@@ -27,6 +27,9 @@ require_relative 'split'
 
 require_relative 'output'
 
+require_relative 'command/system'
+require_relative 'command/track_time'
+
 module Samovar
 	class IncompleteParse < StandardError
 	end
@@ -40,10 +43,10 @@ module Samovar
 			return command
 		end
 		
-		def initialize(input)
+		def initialize(input = nil)
 			self.class.table.parse(input) do |key, value|
 				self.send("#{key}=", value)
-			end
+			end if input
 		end
 		
 		def [] key

data/lib/samovar/command/system.rb

@@ -0,0 +1,60 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'time'
+
+module Samovar
+	class SystemError < RuntimeError
+	end
+	
+	class Command
+		def system(*args, **options)
+			command_line = args.join(' ')
+			
+			pid = Process.spawn(*args, **options)
+			
+			puts Rainbow(command_line).color(:blue)
+			
+			status = Process.waitpid2(pid).last
+			
+			return status.success?
+		rescue Errno::ENOENT
+			return false
+		end
+		
+		def system!(*args, **options)
+			command_line = args.join(' ')
+			
+			pid = Process.spawn(*args, **options)
+			
+			puts Rainbow(command_line).color(:blue)
+			
+			status = Process.waitpid2(pid).last
+			
+			if status.success?
+				return true
+			else
+				raise SystemError.new("Command #{command_line.dump} failed: #{status.to_s}")
+			end
+		rescue Errno::ENOENT
+			raise SystemError.new("Command #{command_line.dump} failed: #{$!}")
+		end
+	end
+end

data/lib/samovar/command/track_time.rb

@@ -0,0 +1,37 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'time'
+
+module Samovar
+	class Command
+		def track_time
+			start_time = Time.now
+			
+			yield
+		ensure
+			end_time = Time.now
+			elapsed_time = end_time - start_time
+			
+			$stdout.flush
+			$stderr.puts Rainbow("Elapsed Time: %0.3fs" % elapsed_time).magenta
+		end
+	end
+end

data/lib/samovar/many.rb

@@ -44,4 +44,4 @@ module Samovar
 			end
 		end
 	end
-end
+end

data/lib/samovar/output.rb

@@ -163,4 +163,4 @@ module Samovar
 			end
 		end
 	end
-end
+end

data/lib/samovar/table.rb

@@ -53,4 +53,4 @@ module Samovar
 			end
 		end
 	end
-end
+end

data/lib/samovar/version.rb

@@ -1,3 +1,23 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
 module Samovar
-  VERSION = "1.0.0"
+	VERSION = "1.1.0"
 end

data/spec/{samovar_spec.rb → samovar/command_spec.rb}

@@ -27,7 +27,7 @@ module Command
 	end
 end
 
-describe Samovar do
+describe Samovar::Command do
 	it "should parse a simple command" do
 		top = Command::Top.parse(["-c", "path", "bottom", "foobar", "A", "B", "--", "args", "args"])
 		
@@ -45,4 +45,12 @@ describe Samovar do
 		
 		expect(buffer.string).to be_include(Command::Top.description)
 	end
+	
+	it "can run commands" do
+		expect(subject.system("ls")).to be_truthy
+		expect(subject.system!("ls")).to be_truthy
+		
+		expect(subject.system("fail")).to be_falsey
+		expect{subject.system!("fail")}.to raise_error(Samovar::SystemError)
+	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samovar
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-23 00:00:00.000000000 Z
+date: 2016-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mapping
@@ -97,6 +97,8 @@ files:
 - flopp.gemspec
 - lib/samovar.rb
 - lib/samovar/command.rb
+- lib/samovar/command/system.rb
+- lib/samovar/command/track_time.rb
 - lib/samovar/flags.rb
 - lib/samovar/many.rb
 - lib/samovar/nested.rb
@@ -107,7 +109,7 @@ files:
 - lib/samovar/split.rb
 - lib/samovar/table.rb
 - lib/samovar/version.rb
-- spec/samovar_spec.rb
+- spec/samovar/command_spec.rb
 - teapot.png
 homepage: https://github.com/ioquatix/samovar
 licenses:
@@ -135,4 +137,4 @@ specification_version: 4
 summary: Samovar is a flexible option parser excellent support for sub-commands and
   help documentation.
 test_files:
-- spec/samovar_spec.rb
+- spec/samovar/command_spec.rb