samovar 1.10.0 → 2.0.0

data/lib/samovar/output/usage_formatter.rb

@@ -0,0 +1,87 @@
+# 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 'mapping/model'
+require 'event/terminal'
+
+require_relative '../error'
+
+require_relative 'header'
+
+require_relative 'row'
+require_relative 'rows'
+
+module Samovar
+	module Output
+		class UsageFormatter < Mapping::Model
+			def self.print(rows, output)
+				formatter = self.new(rows, output)
+				
+				yield formatter if block_given?
+				
+				formatter.print
+			end
+			
+			def initialize(rows, output)
+				@rows = rows
+				@output = output
+				@width = 80
+				
+				@terminal = Event::Terminal.for(@output)
+				@terminal[:header] = @terminal.style(nil, nil, :bright)
+				@terminal[:description] = @terminal.style(:blue)
+				@terminal[:error] = @terminal.style(:red)
+			end
+			
+			map(InvalidInputError) do |error|
+				# This is a little hack which avoids printing out "--help" if it was part of an incomplete parse. In the future I'd prefer if this was handled explicitly.
+				@terminal.puts("#{error.message} in:", style: :error) unless error.help?
+			end
+			
+			map(MissingValueError) do |error|
+				@terminal.puts("#{error.message} in:", style: :error)
+			end
+			
+			map(Header) do |header, rows|
+				@terminal.puts unless header == @rows.first
+				
+				command_line = header.object.command_line(header.name)
+				@terminal.puts "#{rows.indentation}#{command_line}", style: :header
+				
+				if description = header.object.description
+					@terminal.puts "#{rows.indentation}\t#{description}", style: :description
+					@terminal.puts
+				end
+			end
+			
+			map(Row) do |row, rows|
+				@terminal.puts "#{rows.indentation}#{row.align(rows.columns)}"
+			end
+			
+			map(Rows) do |items|
+				items.collect{|row, rows| map(row, rows)}
+			end
+			
+			def print
+				map(@rows)
+			end
+		end
+	end
+end

data/lib/samovar/split.rb

@@ -20,14 +20,19 @@
 
 module Samovar
 	class Split
-		def initialize(key, description, marker: '--', default: nil)
+		def initialize(key, description, marker: '--', default: nil, required: false)
 			@key = key
 			@description = description
 			@marker = marker
 			@default = default
+			@required = required
 		end
 		
 		attr :key
+		attr :description
+		attr :marker
+		attr :default
+		attr :required
 		
 		def to_s
 			"#{@marker} <#{@key}...>"
@@ -37,16 +42,22 @@ module Samovar
 			usage = [to_s, @description]
 			
 			if @default
-				usage << "Default: #{@default.inspect}"
+				usage << "(default: #{@default.inspect})"
+			elsif @required
+				usage << "(required)"
 			end
 			
 			return usage
 		end
 		
-		def parse(input, default = @default)
+		def parse(input, parent = nil, default = nil)
 			if offset = input.index(@marker)
 				input.pop(input.size - offset).tap(&:shift)
-			end || default
+			elsif default ||= @default
+				return default
+			elsif @required
+				raise MissingValueError.new(parent, self)
+			end
 		end
 	end
 end

data/lib/samovar/table.rb

@@ -20,31 +20,79 @@
 
 module Samovar
 	class Table
-		def initialize
-			@rows = []
-			@parser = []
+		def self.nested(klass, parent = nil)
+			if klass.superclass.respond_to?(:table)
+				parent = klass.superclass.table
+			end
+			
+			self.new(parent, name: klass.name)
+		end
+		
+		def initialize(parent = nil, name: nil)
+			@parent = parent
+			@name = name
+			@rows = {}
 		end
 		
-		attr :rows
+		def freeze
+			return self if frozen?
+			
+			@rows.freeze
+			
+			super
+		end
+		
+		def [] key
+			@rows[key]
+		end
+		
+		def each(&block)
+			@rows.each_value(&block)
+		end
 		
 		def << row
-			@rows << row
+			if existing_row = @rows[row.key] and existing_row.respond_to?(:merge!)
+				existing_row.merge!(row)
+			else
+				# In the above case where there is an existing row, but it doensn't support being merged, we overwrite it. This preserves order.
+				@rows[row.key] = row.dup
+			end
+		end
+		
+		def empty?
+			@rows.empty? && @parent&.empty?
+		end
+		
+		def merge_into(table)
+			@parent&.merge_into(table)
 			
-			if row.respond_to?(:parse)
-				@parser << row
+			@rows.each_value do |row|
+				table << row
+			end
+			
+			return table
+		end
+		
+		def merged
+			if @parent.nil? or @parent.empty?
+				return self
+			else
+				merge_into(self.class.new)
 			end
 		end
 		
 		def usage
-			@rows.collect(&:to_s).join(' ')
+			@rows.each_value.collect(&:to_s).reject(&:empty?).join(' ')
 		end
 		
-		def parse(input, command)
-			@parser.each do |row|
-				current = command.send(row.key)
+		def parse(input, parent)
+			@rows.each do |key, row|
+				next unless row.respond_to?(:parse)
+				
+				current = parent.send(key)
 				
-				if result = row.parse(input, current)
-					command.send("#{row.key}=", result)
+				if result = row.parse(input, parent, current)
+					parent.send("#{row.key}=", result)
 				end
 			end
 		end

data/lib/samovar/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Samovar
-	VERSION = "1.10.0"
+	VERSION = "2.0.0"
 end

data/spec/samovar/coerce_spec.rb

@@ -1,6 +1,24 @@
+# Copyright, 2019, 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 'samovar'
-require 'stringio'
 
 module Samovar::CoerceSpec
 	class Coerce < Samovar::Command

data/spec/samovar/command_spec.rb

@@ -1,6 +1,24 @@
+# Copyright, 2019, 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 'samovar'
-require 'stringio'
 
 module Samovar::CommandSpec
 	class Bottom < Samovar::Command
@@ -22,7 +40,7 @@ module Samovar::CommandSpec
 			option '-v/--version', "Print out the application version."
 		end
 		
-		nested '<command>', {
+		nested :command, {
 			'bottom' => Bottom
 		}
 	end
@@ -55,17 +73,9 @@ module Samovar::CommandSpec
 		it "should generate documentation" do
 			top = Top[]
 			buffer = StringIO.new
-			top.print_usage('top', output: buffer)
+			top.print_usage(output: buffer)
 			
 			expect(buffer.string).to be_include(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
 end

data/spec/samovar/many_spec.rb

@@ -0,0 +1,49 @@
+# Copyright, 2019, 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 'samovar/many'
+
+RSpec.describe Samovar::Many do
+	let(:default) {["1", "2", "3"]}
+	let(:input) {["2", "3", "--else"]}
+	
+	subject{described_class.new(:items, "some items", default: default)}
+	
+	it "has string representation" do
+		expect(subject.to_s).to be == "<items...>"
+	end
+	
+	it "should have default" do
+		expect(subject.default).to be == default
+	end
+	
+	it "should use default" do
+		expect(subject.parse([])).to be == default
+	end
+	
+	it "should use specified default" do
+		expect(subject.parse([], nil, ["2"])).to be == ["2"]
+	end
+	
+	it "should not use default if input specified" do
+		expect(subject.parse(input)).to be == ["2", "3"]
+		expect(input).to be == ["--else"]
+	end
+end

data/spec/samovar/nested_spec.rb

@@ -1,39 +1,108 @@
+# Copyright, 2019, 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 'samovar'
-require 'stringio'
+
+RSpec.describe Samovar::Nested do
+	let(:commands) do
+		{
+			'inner-a' => Class.new(Samovar::Command),
+			'inner-b' => Class.new(Samovar::Command),
+		}
+	end
+	
+	let(:default) {'inner-a'}
+	let(:input) {['inner-a']}
+	subject{described_class.new(:command, commands, default: default)}
+	
+	it "has string representation" do
+		expect(subject.to_s).to be == "<command>"
+	end
+	
+	it "should have default" do
+		expect(subject.default).to be == default
+	end
+	
+	it "should use default" do
+		expect(subject.parse([])).to be_kind_of commands[default]
+	end
+	
+	it "should use specified default" do
+		command = commands['inner-b'].new
+		
+		expect(subject.parse([], nil, command)).to be command
+	end
+	
+	it "should not use default if input specified" do
+		expect(subject.parse(input)).to be_kind_of commands['inner-a']
+	end
+end
 
 module Samovar::NestedSpec
 	class InnerA < Samovar::Command
+		options
 	end
 	
-	class InnerB < Samovar::Command
+	class InnerB < InnerA
 		options do
-			option '--help'
+			option '--help', "Do you need it?"
+		end
+	end
+	
+	class InnerC < InnerB
+		options do
+			option '--frobulate', "Zork is waiting for you."
 		end
 	end
 	
 	class Outer < Samovar::Command
 		options do
-			option '--help'
 		end
-		
-		nested '<command>', {
+
+		nested :command, {
 			'inner-a' => InnerA,
 			'inner-b' => InnerB,
+			'inner-c' => InnerC,
 		}, default: 'inner-b'
 	end
-	
+
 	RSpec.describe Samovar::Nested do
 		it "should select default nested command" do
 			outer = Outer[]
 			expect(outer.command).to be_kind_of(InnerB)
+			
+			outer.print_usage
 		end
-		
+
 		it "should select explicitly named nested command" do
 			outer = Outer['inner-a']
 			expect(outer.command).to be_kind_of(InnerA)
 		end
-		
+
+		it "can parse derived options" do
+			outer = Outer['inner-c', '--help']
+			expect(outer.command).to be_kind_of(InnerC)
+			expect(outer.command.options).to include(help: true)
+			expect(outer.command.parent).to be outer
+		end
+
 		xit "should parse help option at outer level" do
 			outer = Outer['inner-a', '--help']
 			expect(outer.options[:help]).to_be truthy