samovar 2.1.4 → 2.3.0

data/spec/samovar/coerce_spec.rb

@@ -1,45 +0,0 @@
-# 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'
-
-module Samovar::CoerceSpec
-	class Coerce < Samovar::Command
-		options do
-			option '--things <array>', "A list of things" do |input|
-				input.split(/\s*,\s*/)
-			end
-			
-			option '--count <integer>', "A number to count", type: Integer
-		end
-	end
-
-	RSpec.describe Samovar::Command do
-		it "should coerce to array" do
-			top = Coerce['--things', 'a,b,c']
-			expect(top.options[:things]).to be == ['a', 'b', 'c']
-		end
-		
-		it "should coerce to integer" do
-			top = Coerce['--count', '10']
-			expect(top.options[:count]).to be == 10
-		end
-	end
-end

data/spec/samovar/command_spec.rb

@@ -1,91 +0,0 @@
-# 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'
-
-module Samovar::CommandSpec
-	class Bottom < Samovar::Command
-		self.description = "Create a new teapot package using the specified repository."
-		
-		one :project_name, "The name of the new project in title-case, e.g. 'My Project'."
-		many :packages, "Any additional packages you'd like to include in the project."
-		split :argv, "Additional arguments to be passed to the sub-process."
-	end
-
-	class Top < Samovar::Command
-		self.description = "A decentralised package manager and build tool."
-		
-		options do
-			option '-c/--configuration <name>', "Specify a specific build configuration.", default: 'TEAPOT_CONFIGURATION'
-			option '-i/--in/--root <path>', "Work in the given root directory."
-			option '--verbose | --quiet', "Verbosity of output for debugging.", key: :logging
-			option '-h/--help', "Print out help information."
-			option '-v/--version', "Print out the application version."
-		end
-		
-		nested :command, {
-			'bottom' => Bottom
-		}
-	end
-
-	RSpec.describe Samovar::Command do
-		it "should invoke call" do
-			expect(Top).to receive(:new).and_wrap_original do |original_method, *arguments, &block|
-				original_method.call(*arguments, &block).tap do |instance|
-					expect(instance).to receive(:call)
-				end
-			end
-			
-			Top.call([])
-		end
-		
-		it "should use default value" do
-			top = Top[]
-			expect(top.options[:configuration]).to be == 'TEAPOT_CONFIGURATION'
-		end
-		
-		it "can update options" do
-			top = Top[]
-			expect(top.options[:configuration]).to be == 'TEAPOT_CONFIGURATION'
-			
-			top = top['--verbose']
-			expect(top.options[:configuration]).to be == 'TEAPOT_CONFIGURATION'
-			expect(top.options[:logging]).to be == :verbose
-		end
-		
-		it "should parse a simple command" do
-			top = Top["-c", "path", "bottom", "foobar", "A", "B", "--", "args", "args"]
-			
-			expect(top.options[:configuration]).to be == 'path'
-			expect(top.command.class).to be == Bottom
-			expect(top.command.project_name).to be == 'foobar'
-			expect(top.command.packages).to be == ['A', 'B']
-			expect(top.command.argv).to be == ["args", "args"]
-		end
-		
-		it "should generate documentation" do
-			top = Top[]
-			buffer = StringIO.new
-			top.print_usage(output: buffer)
-			
-			expect(buffer.string).to be_include(Top.description)
-		end
-	end
-end

data/spec/samovar/many_spec.rb

@@ -1,49 +0,0 @@
-# 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,111 +0,0 @@
-# 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'
-
-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 < InnerA
-		options do
-			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
-		end
-
-		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
-		end
-	end
-end

data/spec/samovar/one_spec.rb

@@ -1,49 +0,0 @@
-# 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::One do
-	let(:default) {"1"}
-	let(:input) {["2", "3", "4"]}
-	
-	subject{described_class.new(:thing, "a thing", default: default)}
-	
-	it "has string representation" do
-		expect(subject.to_s).to be == "<thing>"
-	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"
-		expect(input).to be == ["3", "4"]
-	end
-end

data/spec/samovar/options_spec.rb

@@ -1,50 +0,0 @@
-# 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.
-
-RSpec.describe Samovar::Options do
-	subject(:options) do
-		described_class.parse do
-			option '-x <value>', "The x factor", default: 2
-			option '-y <value>', "The y factor"
-			
-			option '--symbol <value>', "A symbol", type: Symbol
-		end
-	end
-	
-	it "should set defaults" do
-		values = options.parse([], nil, nil)
-		expect(values).to be == {x: 2}
-	end
-	
-	it "should preserve current values" do
-		values = options.parse([], nil, {x: 1, y: 2, z: 3})
-		expect(values).to be == {x: 1, y: 2, z: 3}
-	end
-	
-	it "should update specified values" do
-		values = options.parse(['-x', 10], nil, {x: 1, y: 2, z: 3})
-		expect(values).to be == {x: 10, y: 2, z: 3}
-	end
-	
-	it "converts to symbol" do
-		values = options.parse(['--symbol', 'thing'], {})
-		expect(values[:symbol]).to eq :thing
-	end
-end

data/spec/samovar/split_spec.rb

@@ -1,49 +0,0 @@
-# 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/split'
-
-RSpec.describe Samovar::Split do
-	let(:default) {["1", "2", "3"]}
-	let(:input) {["2", "--", "3"]}
-	
-	subject{described_class.new(:arguments, "arguments", default: default)}
-	
-	it "has string representation" do
-		expect(subject.to_s).to be == "-- <arguments...>"
-	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 == ["3"]
-		expect(input).to be == ["2"]
-	end
-end

data/spec/samovar/table_spec.rb

@@ -1,39 +0,0 @@
-# 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/table'
-require 'samovar/options'
-
-RSpec.describe Samovar::Table do
-	let(:parent) {described_class.new}
-	subject{described_class.new(parent)}
-	
-	it "can merge options" do
-		parent << Samovar::Options.parse
-		subject << Samovar::Options.parse do
-			option "--help", "Print help information."
-		end
-		
-		subject.merged
-		parent.merged
-		
-		expect(parent[:options]).to be_empty
-	end
-end

data/spec/spec_helper.rb

@@ -1,32 +0,0 @@
-# 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 'covered/rspec'
-
-RSpec.configure do |config|
-	config.disable_monkey_patching!
-	
-	# Enable flags like --only-failures and --next-failure
-	config.example_status_persistence_file_path = ".rspec_status"
-
-	config.expect_with :rspec do |c|
-		c.syntax = :expect
-	end
-end