bake 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f99be0a2f861aa6bbfad669012adabb50a63b50284cfbd08184c51aa1ccd833
-  data.tar.gz: d2ed3be69422c1b17e127cc6b3d31097f7203e4ab5fa1260076309659f7a31f8
+  metadata.gz: 235731a8ee0e63e3ef1cf630809bb5839b55a2abc4ee7e6612c19b179208b465
+  data.tar.gz: c394732e183d146875c650b9c0546302214ef7e6ee2526066fda5aad1612eadc
 SHA512:
-  metadata.gz: 865d204e2390a3ac306c8c9c4e84c779b5070b9356030395ce02b08a0f4a8bb8343912354f47bf7f7f72203be5b8b4a20975e7df549564fc1c3deead1bbcc489
-  data.tar.gz: 7eba460839a07814c3ee432d775789b65a810c876b20e1bb201d2092cdf80c7388a4397613cdd06e608f730ce8613644b99749964fbc7944dbf74d9ed06cd7b6
+  metadata.gz: 0e965cf9fca9dd37092addd4c24bc58d25712039526504149b3eef7f2f2d594bd6d34de60d8323316c21c1ac8cde81e08487e5b5a52752d426ad1ab65a8ab0d7
+  data.tar.gz: 4280078bf3b331fc0c3057001cb7a276608a2a541ab9f8fbf36378f45b764ff2afe5efdfc1e3a83ac175cd7b769e384dd3aa71ba0034523bc926e45f0fd2f039

data/bake.rb

@@ -1,4 +0,0 @@
-
-# A test method.
-def test
-end

data/lib/bake/command/list.rb

@@ -24,7 +24,7 @@ require 'set'
 module Bake
 	module Command
 		class List < Samovar::Command
-			PARAMETER = /@param\s+(?<name>.*?)\s+\[(?<type>.*?)\]\s+(?<details>.*?)\Z/
+			one :pattern, "The pattern to filter tasks by."
 			
 			def format_parameters(parameters, terminal)
 				parameters.each do |type, name|
@@ -52,25 +52,39 @@ module Bake
 				end
 			end
 			
-			def print_scope(terminal, scope)
+			def print_scope(terminal, scope, printed: false)
 				format_recipe = self.method(:format_recipe).curry
 				
 				scope.recipes.sort.each do |recipe|
+					if @pattern and !recipe.command.include?(pattern)
+						next
+					end
+					
+					unless printed
+						yield
+						
+						printed = true
+					end
+					
 					terminal.print_line
 					terminal.print_line("\t", format_recipe[recipe])
 					
-					recipe.description.each do |line|
-						if match = line.match(PARAMETER)
-							terminal.print_line("\t\t",
-								:parameter, match[:name], :reset, " [",
-								:type, match[:type], :reset, "] ",
-								:description, match[:details]
-							)
-						else
-							terminal.print_line("\t\t", :description, line)
-						end
+					documentation = recipe.documentation
+					
+					documentation.description do |line|
+						terminal.print_line("\t\t", :description, line)
+					end
+					
+					documentation.parameters do |parameter|
+						terminal.print_line("\t\t",
+							:parameter, parameter[:name], :reset, " [",
+							:type, parameter[:type], :reset, "] ",
+							:description, parameter[:details]
+						)
 					end
 				end
+				
+				return printed
 			end
 			
 			def call
@@ -79,23 +93,30 @@ module Bake
 				context = @parent.context
 				
 				if scope = context.scope
-					terminal.print_line(:context, context)
-					
-					print_scope(terminal, context.scope)
+					printed = print_scope(terminal, context.scope) do
+						terminal.print_line(:context, context)
+					end
 					
-					terminal.print_line
+					if printed
+						terminal.print_line
+					end
 				end
 				
 				context.loaders.each do |loader|
-					terminal.print_line(:loader, loader)
+					printed = false
 					
 					loader.each do |path|
 						if scope = loader.scope_for(path)
-							print_scope(terminal, scope)
+							print_scope(terminal, scope, printed: printed) do
+								terminal.print_line(:loader, loader)
+								printed = true
+							end
 						end
 					end
 					
-					terminal.print_line
+					if printed
+						terminal.print_line
+					end
 				end
 			end
 		end

data/lib/bake/documentation.rb

@@ -0,0 +1,80 @@
+# Copyright, 2020, 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 'scope'
+
+module Bake
+	class Documentation
+		
+		def initialize(comments)
+			@comments = comments
+		end
+		
+		DESCRIPTION = /\A\s*([^@\s].*)?\z/
+		
+		def description
+			return to_enum(:description) unless block_given?
+			
+			# We track empty lines and only yield a single empty line when there is another line of text:
+			gap = false
+			
+			@comments.each do |comment|
+				if match = comment.match(DESCRIPTION)
+					if match[1]
+						if gap
+							yield ""
+							gap = false
+						end
+						
+						yield match[1]
+					else
+						gap = true
+					end
+				else
+					break
+				end
+			end
+		end
+		
+		ATTRIBUTE = /\A\s*@(?<name>.*?)\s+(?<value>.*?)\z/
+		
+		def attributes
+			return to_enum(:attributes) unless block_given?
+			
+			@comments.each do |comment|
+				if match = comment.match(ATTRIBUTE)
+					yield match
+				end
+			end
+		end
+		
+		PARAMETER = /\A\s*@param\s+(?<name>.*?)\s+\[(?<type>.*?)\]\s+(?<details>.*?)\z/
+		
+		def parameters
+			return to_enum(:parameters) unless block_given?
+			
+			@comments.each do |comment|
+				if match = comment.match(PARAMETER)
+					yield match
+				end
+			end
+		end
+	end
+end

data/lib/bake/recipe.rb

@@ -19,17 +19,17 @@
 # THE SOFTWARE.
 
 require_relative 'types'
+require_relative 'documentation'
 
 module Bake
-	PARAMETER = /@param\s+(?<name>.*?)\s+\[(?<type>.*?)\]\s+(?<details>.*?)\Z/
-	
 	class Recipe
 		def initialize(instance, name, method = nil)
 			@instance = instance
 			@name = name
 			@command = nil
-			@description = nil
+			@comments = nil
 			@types = nil
+			@documentation = nil
 			
 			@method = method
 			@arity = nil
@@ -136,8 +136,12 @@ module Bake
 			end
 		end
 		
-		def description
-			@description ||= read_description
+		def comments
+			@comments ||= read_comments
+		end
+		
+		def documentation
+			@documentation ||= Documentation.new(self.comments)
 		end
 		
 		def types
@@ -158,23 +162,21 @@ module Bake
 			end
 		end
 		
-		def read_description
+		COMMENT = /\A\s*\#\s?(.*?)\Z/
+		
+		def read_comments
 			file, line_number = self.method.source_location
 			
 			lines = File.readlines(file)
 			line_index = line_number - 1
 			
-			# Legacy "recipe" syntax:
-			if match = lines[line_index].match(/description: "(.*?)"/)
-				return [match[1]]
-			end
-			
 			description = []
 			line_index -= 1
 			
 			# Extract comment preceeding method:
 			while line = lines[line_index]
-				if match = line.match(/^\s*\#\s?(.*?)$/)
+				# \Z matches a trailing newline:
+				if match = line.match(COMMENT)
 					description.unshift(match[1])
 				else
 					break
@@ -189,10 +191,8 @@ module Bake
 		def read_types
 			types = {}
 			
-			description.each do |description|
-				if fields = PARAMETER.match(description)
-					types[fields[:name].to_sym] = Types.parse(fields[:type])
-				end
+			self.documentation.parameters do |parameter|
+				types[parameter[:name].to_sym] = Types.parse(parameter[:type])
 			end
 			
 			return types

data/lib/bake/types/input.rb

@@ -0,0 +1,42 @@
+# Copyright, 2020, 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 'any'
+
+module Bake
+	module Types
+		module Input
+			extend Type
+			
+			def self.composite?
+				false
+			end
+			
+			def self.parse(input)
+				case input
+				when '-'
+					return $stdin
+				else
+					File.open(input)
+				end
+			end
+		end
+	end
+end

data/lib/bake/types/output.rb

@@ -0,0 +1,42 @@
+# Copyright, 2020, 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 'any'
+
+module Bake
+	module Types
+		module Output
+			extend Type
+			
+			def self.composite?
+				false
+			end
+			
+			def self.parse(input)
+				case input
+				when '-'
+					return $stdout
+				else
+					File.open(input, "w")
+				end
+			end
+		end
+	end
+end

data/lib/bake/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Bake
-	VERSION = "0.11.0"
+	VERSION = "0.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bake
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: samovar
@@ -118,6 +118,7 @@ files:
 - lib/bake/command/list.rb
 - lib/bake/command/top.rb
 - lib/bake/context.rb
+- lib/bake/documentation.rb
 - lib/bake/loader.rb
 - lib/bake/loaders.rb
 - lib/bake/recipe.rb
@@ -129,8 +130,10 @@ files:
 - lib/bake/types/decimal.rb
 - lib/bake/types/float.rb
 - lib/bake/types/hash.rb
+- lib/bake/types/input.rb
 - lib/bake/types/integer.rb
 - lib/bake/types/nil.rb
+- lib/bake/types/output.rb
 - lib/bake/types/string.rb
 - lib/bake/types/symbol.rb
 - lib/bake/types/tuple.rb