samovar 1.10.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1e5553e013cfe19724bdbdb1cb1c989025216e737e6b7591068f97fc4059fb3
-  data.tar.gz: 7430857e0d0d389b041056d2cac1f532d6215014ed06b4f60fc2a8e0fdc4161f
+  metadata.gz: 3d7ea0c2f3e68eea317420d35531661fcca9c912d034eb26eae71572ba7977cf
+  data.tar.gz: 25406ee8967a8a5854145683cdca839c62ba1999f8f8077582705423ca0613ed
 SHA512:
-  metadata.gz: 9a47b68e6b5c28c2539d9089d51752320a289056f762693edef1b7ec84dff3f8befc3f5196700f95243ca3bb1461413e1fc74c3d6d6619c816eeb873f5491800
-  data.tar.gz: b083e569e8f23de9da31c302dbd1526b32cbfbb9d6087430f0103ff68d3ca3de204d87bf4f541179f3c2b56f3f71c10b4ac0c32331a1261d740f5f3d7a88445e
+  metadata.gz: b48456ba224e7025fa4e16d3dc5a472795d6261f2861f50daf8b948dc28eb1936c56b23f3e0dc046260d59a933153a8b78ab7e66d80ccef265f1c73b89bc1d48
+  data.tar.gz: f1a65ab649c96805d5addc23f73dee070f5d505be81842f5f0944a0d52a600024e8ad12d4d18d1eadb91786c349688797f31a16853ee0af5708367287e345ed9

data/Gemfile

@@ -4,6 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-	gem 'simplecov'
-	gem 'coveralls', require: false
+	gem 'pry'
 end

data/lib/samovar/command.rb

@@ -27,36 +27,23 @@ require_relative 'split'
 
 require_relative 'output'
 
-require_relative 'command/system'
-require_relative 'command/track_time'
+require_relative 'error'
 
 module Samovar
-	class IncompleteParse < StandardError
-	end
-	
 	class Command
-		def self.parse(input)
-			command = self.new(input)
-			
-			raise IncompleteParse.new("Could not parse #{input}") unless input.empty?
+		# The top level entry point for parsing ARGV.
+		def self.parse(input = ARGV)
+			self.new(input)
+		rescue Error => error
+			error.command.print_usage(output: $stderr) do |formatter|
+				formatter.map(error)
+			end
 			
-			return command
-		end
-		
-		def self.[](*input)
-			self.parse(input)
-		end
-		
-		def [](*input)
-			self.dup.tap{|command| command.parse(input)}
+			return nil
 		end
 		
-		def parse(input)
-			self.class.table.parse(input, self)
-		end
-		
-		def initialize(input = nil)
-			parse(input) if input
+		def self.[](*input, **options)
+			self.new(input, **options)
 		end
 		
 		class << self
@@ -64,7 +51,7 @@ module Samovar
 		end
 		
 		def self.table
-			@table ||= Table.new
+			@table ||= Table.nested(self)
 		end
 		
 		def self.append(row)
@@ -95,9 +82,9 @@ module Samovar
 		
 		def self.usage(rows, name)
 			rows.nested(name, self) do |rows|
-				return unless @table
+				return if @table.nil?
 				
-				@table.rows.each do |row|
+				@table.merged.each do |row|
 					if row.respond_to?(:usage)
 						row.usage(rows)
 					else
@@ -109,18 +96,42 @@ module Samovar
 		
 		def self.command_line(name)
 			if @table
-				"#{name} #{@table.usage}"
+				"#{name} #{@table.merged.usage}"
 			else
 				name
 			end
 		end
 		
-		def print_usage(*args, output: $stderr, formatter: Output::DetailedFormatter)
+		def initialize(input = nil, name: File.basename($0), parent: nil)
+			@name = name
+			@parent = parent
+			
+			parse(input) if input
+		end
+		
+		attr :name
+		attr :parent
+		
+		def [](*input)
+			self.dup.tap{|command| command.parse(input)}
+		end
+		
+		def parse(input)
+			self.class.table.merged.parse(input, self)
+			
+			if input.empty?
+				return self
+			else
+				raise IncompleteParse.new(self, input)
+			end
+		end
+		
+		def print_usage(output: $stderr, formatter: Output::UsageFormatter, &block)
 			rows = Output::Rows.new
 			
-			self.class.usage(rows, *args)
+			self.class.usage(rows, @name)
 			
-			formatter.print(rows, output)
+			formatter.print(rows, output, &block)
 		end
 	end
 end

data/lib/samovar/{command/system.rb → error.rb}

@@ -1,4 +1,4 @@
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 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
@@ -18,39 +18,39 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative '../failure'
-
-require_relative 'terminal'
-
-require 'shellwords'
-
 module Samovar
-	class SystemError < Failure
+	class Error < StandardError
 	end
-	
-	class Command
-		def system(*args, **options)
-			log_system(args, options)
+		
+	class InvalidInputError < Error
+		def initialize(command, input)
+			@command = command
+			@input = input
 			
-			Kernel::system(*args, **options)
-		rescue Errno::ENOENT
-			return false
+			super "Could not parse token #{input.first.inspect}"
 		end
 		
-		def system!(*args, **options)
-			if system(*args, **options)
-				return true
-			else
-				raise SystemError.new("Command #{args.first.inspect} failed: #{$?.to_s}")
-			end
+		def token
+			@input.first
 		end
 		
-		private
+		def help?
+			self.token == "--help"
+		end
 		
-		def log_system(args, options)
-			# Print out something half-decent:
-			command_line = Shellwords.join(args)
-			terminal.puts command_line, style: :command
+		attr :command
+		attr :input
+	end
+	
+	class MissingValueError < Error
+		def initialize(command, field)
+			@command = command
+			@field = field
+			
+			super "#{field} is required"
 		end
+		
+		attr :command
+		attr :field
 	end
 end

data/lib/samovar/many.rb

@@ -20,14 +20,19 @@
 
 module Samovar
 	class Many
-		def initialize(key, description, stop: /^-/, default: nil)
+		def initialize(key, description, stop: /^-/, default: nil, required: false)
 			@key = key
 			@description = description
 			@stop = stop
 			@default = default
+			@required = required
 		end
 		
 		attr :key
+		attr :description
+		attr :stop
+		attr :default
+		attr :required
 		
 		def to_s
 			"<#{key}...>"
@@ -37,18 +42,24 @@ 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 @stop and stop_index = input.index{|item| @stop === item}
 				input.shift(stop_index)
-			else
+			elsif input.any?
 				input.shift(input.size)
-			end || default
+			elsif default ||= @default
+				return default
+			elsif @required
+				raise MissingValueError.new(parent, self)
+			end
 		end
 	end
 end

data/lib/samovar/nested.rb

@@ -20,23 +20,27 @@
 
 module Samovar
 	class Nested
-		def initialize(name, commands, key: :command, default: nil)
-			@name = name
-			@commands = commands
+		def initialize(key, commands, default: nil, required: false)
 			@key = key
+			@commands = commands
 			
 			# This is the default name [of a command], not the default command:
 			@default = default
+			
+			@required = required
 		end
 		
 		attr :key
+		attr :commands
+		attr :default
+		attr :required
 		
 		def to_s
-			@name
+			"<#{@key}>"
 		end
 		
 		def to_a
-			usage = [@name]
+			usage = [self.to_s]
 			
 			if @commands.size == 0
 				usage << "No commands available."
@@ -47,20 +51,27 @@ module Samovar
 			end
 			
 			if @default
-				usage << "Default: #{@default}"
+				usage << "(default: #{@default})"
+			elsif @required
+				usage << "(required)"
 			end
 			
 			return usage
 		end
 		
-		def parse(input, default)
+		# @param default [Command] the default command if any.
+		def parse(input, parent = nil, default = nil)
 			if command = @commands[input.first]
-				input.shift
+				name = input.shift
 				
 				# puts "Instantiating #{command} with #{input}"
-				command.new(input)
+				command.new(input, name: name, parent: parent)
+			elsif default
+				return default
 			elsif @default
-				default || @commands[@default].new(input)
+				@commands[@default].new(input, name: @default, parent: parent)
+			elsif @required
+				raise MissingValueError.new(parent, self)
 			end
 		end
 		

data/lib/samovar/one.rb

@@ -20,14 +20,19 @@
 
 module Samovar
 	class One
-		def initialize(key, description, pattern: //, default: nil)
+		def initialize(key, description, pattern: //, default: nil, required: false)
 			@key = key
 			@description = description
 			@pattern = pattern
 			@default = default
+			@required = required
 		end
 		
 		attr :key
+		attr :description
+		attr :pattern
+		attr :default
+		attr :required
 		
 		def to_s
 			"<#{@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 input.first =~ @pattern
 				input.shift
-			end || default
+			elsif default ||= @default
+				return default
+			elsif @required
+				raise MissingValueError.new(parent, self)
+			end
 		end
 	end
 end

data/lib/samovar/option.rb

@@ -0,0 +1,107 @@
+# 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 'flags'
+
+module Samovar
+	class Option
+		def initialize(flags, description, key: nil, default: nil, value: nil, type: nil, required: false, &block)
+			@flags = Flags.new(flags)
+			@description = description
+			
+			if key
+				@key = key
+			else
+				@key = @flags.first.key
+			end
+			
+			@default = default
+			
+			# If the value is given, it overrides the user specified input.
+			@value = value
+			@value ||= true if @flags.boolean?
+			
+			@type = type
+			@required = required
+			@block = block
+		end
+		
+		attr :flags
+		attr :description
+		attr :key
+		attr :default
+		
+		attr :value
+		
+		attr :type
+		attr :required
+		attr :block
+		
+		def coerce_type(result)
+			if @type == Integer
+				Integer(result)
+			elsif @type == Float
+				Float(result)
+			elsif @type == Symbol
+				result.to_sym
+			elsif @type.respond_to? :call
+				@type.call(result)
+			elsif @type.respond_to? :new
+				@type.new(result)
+			end
+		end
+		
+		def coerce(result)
+			if @type
+				result = coerce_type(result)
+			end
+			
+			if @block
+				result = @block.call(result)
+			end
+			
+			return result
+		end
+		
+		def parse(input, parent = nil, default = nil)
+			if result = @flags.parse(input)
+				@value.nil? ? coerce(result) : @value
+			elsif default ||= @default
+				return default
+			elsif @required
+				raise MissingValueError.new(parent, self)
+			end
+		end
+		
+		def to_s
+			@flags
+		end
+		
+		def to_a
+			if @default
+				[@flags, @description, "(default: #{@default})"]
+			elsif @required
+				[@flags, @description, "(required)"]
+			else
+				[@flags, @description]
+			end
+		end
+	end
+end