samovar 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 245b83811d09cc997ce160fa8c6a5481e3efe0cc
-  data.tar.gz: b7e021a4cad13a340d6b77dbd2cbe4c066383c5d
+  metadata.gz: 06e76d86b275ed684abaabcadd799765248b67d8
+  data.tar.gz: 5dbb428a9e5523779b394d3c14cb8661ca14271c
 SHA512:
-  metadata.gz: 9a7e9e3e968d94c1d88eb308f1bf1e46c3c29ee2e7c1847d3a42b2b5f55f686e7e45a10ba43b75a98ccff09288a99e733bccd030bf58f05a721e8c43084014f1
-  data.tar.gz: b8d72d941e4f5f2659c7e4ea9235a66667ed637945d43ee0772eb3774b929afdfff013719ba677a00ff8f4da92cb07d39c822dae2e50e1c1775a2ec1a5a9ec58
+  metadata.gz: e412c9871a224a1ad5049fd9d13a94dc1cf6f3f1a6b5c4bb2a92f085ce3a7b629f9a2ab142fe428b1e6a766c2252ef93eaf059b3d92e9bd48582fa9aca6c5abd
+  data.tar.gz: ba4f76b3c6b9457647cf8132e02d94df20add0d19e6c7c610ca2277291544db21e767735b4a9850a4756fd765e341c8ecefa3ecc4d0016b063e008a8d1a9f3d9

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rspec_status
+.tags

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
---color
+--backtrace
 --warnings
+--require spec_helper

data/README.md

@@ -116,6 +116,18 @@ Or install it yourself as:
 	application.fruit # 'apple'
 	application.cakes # ['chocolate cake', 'fruit cake']
 
+### Explicit Commands
+
+Given a custom `Samovar::Command` subclass, you can instantiate it with options:
+
+	application = Application['--root', path]
+
+You can also duplicate an existing command instance with additions/changes:
+
+	concurrent_application = application['--threads', 12]
+
+These forms can be useful when invoking one command from another, or in unit tests.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,12 +1,9 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec) do |task|
-	begin
-		require('simplecov/version')
-		task.rspec_opts = %w{--require simplecov} if ENV['COVERAGE']
-	rescue LoadError
-	end
-end
+# Load all rake tasks:
+import(*Dir.glob('tasks/**/*.rake'))
 
-task :default => :spec
+RSpec::Core::RakeTask.new(:test)
+
+task :default => :test

data/lib/samovar/command.rb

@@ -52,9 +52,7 @@ module Samovar
 		end
 		
 		def parse(input)
-			self.class.table.parse(input) do |key, value|
-				self.send("#{key}=", value)
-			end
+			self.class.table.parse(input, self)
 		end
 		
 		def initialize(input = nil)

data/lib/samovar/many.rb

@@ -36,12 +36,12 @@ module Samovar
 			[to_s, @description]
 		end
 		
-		def parse(input)
+		def parse(input, default)
 			if @stop and stop_index = input.index{|item| @stop === item}
 				input.shift(stop_index)
 			else
 				input.shift(input.size)
-			end
+			end || default
 		end
 	end
 end

data/lib/samovar/nested.rb

@@ -20,10 +20,13 @@
 
 module Samovar
 	class Nested
-		def initialize(name, commands, key: :command)
+		def initialize(name, commands, key: :command, default: nil)
 			@name = name
 			@commands = commands
 			@key = key
+			
+			# This is the default name [of a command], not the default command:
+			@default = default
 		end
 		
 		attr :key
@@ -33,15 +36,31 @@ module Samovar
 		end
 		
 		def to_a
-			[@name, "One of #{@commands.keys.join(', ')}."]
+			usage = [@name]
+			
+			if @commands.size == 0
+				usage << "No commands available."
+			elsif @commands.size == 1
+				usage << "Only #{@commands.first}."
+			else
+				usage << "One of: #{@commands.keys.join(', ')}."
+			end
+			
+			if @default
+				usage << "Default: #{@default}"
+			end
+			
+			return usage
 		end
 		
-		def parse(input)
+		def parse(input, default)
 			if command = @commands[input.first]
 				input.shift
 				
 				# puts "Instantiating #{command} with #{input}"
 				command.new(input)
+			elsif @default
+				default || @commands[@default].new(input)
 			end
 		end
 		

data/lib/samovar/one.rb

@@ -36,10 +36,10 @@ module Samovar
 			[to_s, @description]
 		end
 		
-		def parse(input)
+		def parse(input, default)
 			if input.first =~ @pattern
 				input.shift
-			end
+			end || default
 		end
 	end
 end

data/lib/samovar/options.rb

@@ -74,12 +74,10 @@ module Samovar
 			return result
 		end
 		
-		def parse(input)
+		def parse(input, default = @default)
 			if result = @flags.parse(input)
 				@value.nil? ? coerce(result) : @value
-			else
-				@default
-			end
+			end || default
 		end
 		
 		def to_s
@@ -138,8 +136,8 @@ module Samovar
 			end
 		end
 		
-		def parse(input)
-			values = @defaults.dup
+		def parse(input, default)
+			values = (default || @defaults).dup
 			
 			while option = @keyed[input.first]
 				if result = option.parse(input)

data/lib/samovar/split.rb

@@ -36,10 +36,10 @@ module Samovar
 			[to_s, @description]
 		end
 		
-		def parse(input)
+		def parse(input, default = nil)
 			if offset = input.index(@marker)
 				input.pop(input.size - offset).tap(&:shift)
-			end
+			end || default
 		end
 	end
 end

data/lib/samovar/table.rb

@@ -36,19 +36,15 @@ module Samovar
 		end
 		
 		def usage
-			items = Array.new
-			
-			@rows.each do |row|
-				items << row.to_s
-			end
-			
-			items.join(' ')
+			@rows.collect(&:to_s).join(' ')
 		end
 		
-		def parse(input)
+		def parse(input, command)
 			@parser.each do |row|
-				if result = row.parse(input)
-					yield row.key, result, row
+				current = command.send(row.key)
+				
+				if result = row.parse(input, current)
+					command.send("#{row.key}=", result)
 				end
 			end
 		end

data/lib/samovar/version.rb

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

data/samovar.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
 
 	spec.add_development_dependency "bundler", "~> 1.11"
 	spec.add_development_dependency "rake", "~> 10.0"
-	spec.add_development_dependency "rspec", "~> 3.0"
+	spec.add_development_dependency "rspec", "~> 3.6"
 end

data/spec/samovar/coerce_spec.rb

@@ -0,0 +1,27 @@
+
+require 'samovar'
+require 'stringio'
+
+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

@@ -2,7 +2,7 @@
 require 'samovar'
 require 'stringio'
 
-module Command
+module Samovar::CommandSpec
 	class Bottom < Samovar::Command
 		self.description = "Create a new teapot package using the specified repository."
 		
@@ -25,37 +25,46 @@ module Command
 		nested '<command>',
 			'bottom' => Bottom
 	end
-end
 
-describe Samovar::Command do
-	it "should use default value" do
-		top = Command::Top.parse([])
-		expect(top.options[:configuration]).to be == 'TEAPOT_CONFIGURATION'
-	end
-	
-	it "should parse a simple command" do
-		top = Command::Top.parse(["-c", "path", "bottom", "foobar", "A", "B", "--", "args", "args"])
+	RSpec.describe Samovar::Command do
+		it "should use default value" do
+			top = Top[]
+			expect(top.options[:configuration]).to be == 'TEAPOT_CONFIGURATION'
+		end
 		
-		expect(top.options[:configuration]).to be == 'path'
-		expect(top.command.class).to be == Command::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 = Command::Top.new([])
-		buffer = StringIO.new
-		top.print_usage('top', output: buffer)
+		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
 		
-		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
+		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
 		
-		expect(subject.system("fail")).to be_falsey
-		expect{subject.system!("fail")}.to raise_error(Samovar::SystemError)
+		it "should generate documentation" do
+			top = Top[]
+			buffer = StringIO.new
+			top.print_usage('top', 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/nested_spec.rb

@@ -0,0 +1,30 @@
+
+require 'samovar'
+require 'stringio'
+
+module Samovar::NestedSpec
+	class InnerA < Samovar::Command
+	end
+	
+	class InnerB < Samovar::Command
+	end
+	
+	class Outer < Samovar::Command
+		nested '<command>',
+			'inner-a' => InnerA,
+			'inner-b' => InnerB,
+			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)
+		end
+		
+		it "should select explicitly named nested command" do
+			outer = Outer['inner-a']
+			expect(outer.command).to be_kind_of(InnerA)
+		end
+	end
+end

data/spec/samovar/options_spec.rb

@@ -0,0 +1,24 @@
+
+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"
+		end
+	end
+	
+	it "should set defaults" do
+		values = options.parse([], nil)
+		expect(values).to be == {x: 2}
+	end
+	
+	it "should preserve current values" do
+		values = options.parse([], {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], {x: 1, y: 2, z: 3})
+		expect(values).to be == {x: 10, y: 2, z: 3}
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+
+if ENV['COVERAGE'] || ENV['TRAVIS']
+	begin
+		require 'simplecov'
+		
+		SimpleCov.start do
+			add_filter "/spec/"
+		end
+		
+		if ENV['TRAVIS']
+			require 'coveralls'
+			Coveralls.wear!
+		end
+	rescue LoadError
+		warn "Could not load simplecov: #{$!}"
+	end
+end
+
+require "bundler/setup"
+require "samovar"
+
+RSpec.configure do |config|
+	# 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samovar
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2017-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mapping
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
 description: 
 email:
 - samuel.williams@oriontransfer.co.nz
@@ -89,7 +89,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".simplecov"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -109,8 +108,11 @@ files:
 - lib/samovar/table.rb
 - lib/samovar/version.rb
 - samovar.gemspec
+- spec/samovar/coerce_spec.rb
 - spec/samovar/command_spec.rb
-- spec/samovar/type_spec.rb
+- spec/samovar/nested_spec.rb
+- spec/samovar/options_spec.rb
+- spec/spec_helper.rb
 - teapot.png
 homepage: https://github.com/ioquatix/samovar
 licenses:
@@ -138,5 +140,8 @@ specification_version: 4
 summary: Samovar is a flexible option parser excellent support for sub-commands and
   help documentation.
 test_files:
+- spec/samovar/coerce_spec.rb
 - spec/samovar/command_spec.rb
-- spec/samovar/type_spec.rb
+- spec/samovar/nested_spec.rb
+- spec/samovar/options_spec.rb
+- spec/spec_helper.rb

data/.simplecov

@@ -1,9 +0,0 @@
-
-SimpleCov.start do
-	add_filter "/spec/"
-end
-
-if ENV['TRAVIS']
-	require 'coveralls'
-	Coveralls.wear!
-end

data/spec/samovar/type_spec.rb

@@ -1,27 +0,0 @@
-
-require 'samovar'
-require 'stringio'
-
-module Command
-	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
-end
-
-describe Samovar::Command do
-	it "should coerce to array" do
-		top = Command::Coerce.parse(['--things', 'a,b,c'])
-		expect(top.options[:things]).to be == ['a', 'b', 'c']
-	end
-	
-	it "should coerce to integer" do
-		top = Command::Coerce.parse(['--count', '10'])
-		expect(top.options[:count]).to be == 10
-	end
-end