runfile 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2a0ccfa3a80cd356498b5a90abc45d2f799e36c
-  data.tar.gz: 343fb0c27e72cd670943ba0a8050efe92d3ccaf0
+  metadata.gz: 4b3f76f9bd21810f1bcec6852443b345ed34b96b
+  data.tar.gz: e0a618c50953691f9c4e8e03d6a07d889406b2c7
 SHA512:
-  metadata.gz: e172263529326fc9fd885faea650cacb0cbd08ffa35fe3222f9ffae3f42f73cd3fa642cbe74ad911ef0fad91286113f3aa04758b625744706aa0d04316bb9e69
-  data.tar.gz: bb064103aefc63311412ed55344c75183c8727d08304916013830a5840e252d8914588880aa7e9680cbb37023a9a53732ee576f999459724e83057f6339b4bc6
+  metadata.gz: 73b60741536a682d32c26c96276694f7d0dcfc23110c1b4c410d7647186613e064311b4c22cca3c8d5522c856b98b54d4b51f90f6728f89686e26b299377a07a
+  data.tar.gz: 2f586193dc34d876851a36d5510ff5fb69ca826e650f3b21a7aa2ea738346fe91cb0ffc2ce899e6232b7a9f1974be1bbfad8b79a3cf0c9be9f670edd9e3bcf0b

data/README.md

@@ -3,6 +3,8 @@ Runfile - If Rake and Docopt had a baby
 
 [![Gem Version](https://badge.fury.io/rb/runfile.svg)](http://badge.fury.io/rb/runfile)
 [![Build Status](https://travis-ci.org/DannyBen/runfile.svg?branch=master)](https://travis-ci.org/DannyBen/runfile)
+[![Code Climate](https://codeclimate.com/github/DannyBen/runfile/badges/gpa.svg)](https://codeclimate.com/github/DannyBen/runfile)
+[![Gem](https://img.shields.io/gem/dt/runfile.svg)](https://rubygems.org/gems/runfile)
 
 A beautiful command line application framework.  
 Rake-inspired, Docopt inside.

data/lib/runfile/docopt_helper.rb

@@ -25,34 +25,58 @@ module Runfile
 		# and options we have collected from the Runfile DSL.
 		def docopt
 			width, height = detect_terminal_size
-			doc = "#{@name} #{@version}\n"
-			doc += "#{@summary} \n" if @summary
-			doc += "\nUsage:\n";
+			doc = ["#{@name} #{@version}"]
+			doc << "#{@summary}" if @summary
+			doc += docopt_usage
+			doc += docopt_commands width
+			doc += docopt_options width
+			doc.join "\n"
+		end
+
+		# Return all docopt lines for the 'Usage' section
+		def docopt_usage 
+			doc = ["\nUsage:"];
 			@actions.each do |name, action|
-				doc += "  run #{action.usage}\n" unless action.usage == false
+				doc << "  run #{action.usage}" unless action.usage == false
 			end
-			doc += "  run ( -h | --help | --version )\n\n"
+			doc << "  run ( -h | --help | --version )\n"
+			doc
+		end
+
+		# Return all docopt lines for the 'Commands' section
+		def docopt_commands(width)
+			doc = []
 			caption_printed = false
 			@actions.each do |name, action|
 				action.help or next
-				doc += "Commands:\n" unless caption_printed
+				doc << "Commands:" unless caption_printed
 				caption_printed = true
 				helpline = "      #{action.help}"
 				wrapped  = word_wrap helpline, width
-				doc += "  #{action.usage}\n#{wrapped}\n\n" unless action.usage == false
+				doc << "  #{action.usage}\n#{wrapped}\n" unless action.usage == false
 			end
-			doc += "Options:\n"
-			doc += "  -h --help\n      Show this screen\n\n"
-			doc += "  --version\n      Show version\n\n"
-			@options.each do |flag, text|
-				helpline = "      #{text}"
-				wrapped  = word_wrap helpline, width
-				doc += "  #{flag}\n#{wrapped}\n\n"
+			doc
+		end
+
+		# Return all docopt lines for the various 'Options' sections
+		def docopt_options(width)
+			@options['Options'] = {} unless @options['Options']
+			@options['Options']['-h --help'] = 'Show this screen'
+			@options['Options']['--version'] = 'Show version number'
+
+			doc = []
+			@options.each do |scope, values|
+				doc << "#{scope}:"
+				values.each do |flag, text|
+					helpline = "      #{text}"
+					wrapped  = word_wrap helpline, width
+					doc << "  #{flag}\n#{wrapped}\n"
+				end
 			end
 			doc
 		end
 
-		# Calls the docopt handler, which will either return a parsed
+		# Call the docopt handler, which will either return a parsed
 		# arguments list, or halt execution and show usage.
 		def args(argv)
 			Docopt::docopt(docopt, version: @version, argv:argv)

data/lib/runfile/dsl.rb

@@ -30,8 +30,8 @@ module Runfile
 
 	# Add an option/flag to the next action (can be called multiple
 	# times)
-	def option(flag, text)
-		Runner.instance.add_option flag, text
+	def option(flag, text, scope=nil)
+		Runner.instance.add_option flag, text, scope
 	end
 
 	# Define the action

data/lib/runfile/runfile_helper.rb

@@ -72,16 +72,7 @@ module Runfile
 				say "\n!txtred!Runfile not found."
 			else
 				say ""
-				max = runfiles.max_by(&:length).size
-				width, height = detect_terminal_size
-				runfiles.each do |f|
-					f[/([^\/]+).runfile$/]
-					command  = "run #{$1}"
-					spacer_size = width - max - command.size - 6
-					spacer_size = [1, spacer_size].max
-					spacer = '.' * spacer_size
-					say "  !txtgrn!#{command}!txtrst! #{spacer} #{f}"
-				end
+				say_runfile_list runfiles
 			end
 		end
 
@@ -92,5 +83,19 @@ module Runfile
 			dirs
 		end
 
+		# Output the list of available runfiles
+		def say_runfile_list(runfiles)
+			max = runfiles.max_by(&:length).size
+			width, height = detect_terminal_size
+			runfiles.each do |f|
+				f[/([^\/]+).runfile$/]
+				command  = "run #{$1}"
+				spacer_size = width - max - command.size - 6
+				spacer_size = [1, spacer_size].max
+				spacer = '.' * spacer_size
+				say "  !txtgrn!#{command}!txtrst! #{spacer} #{f}"
+			end
+		end
+
 	end
 end

data/lib/runfile/runner.rb

@@ -48,22 +48,22 @@ module Runfile
 		# usage and help messages sent by the DSL.
 		def add_action(name, &block)
 			@last_usage = name if @last_usage.nil?
-			if @namespace 
-				name = "#{namespace}_#{name}".to_sym
-				@last_usage = "#{@namespace} #{@last_usage}" unless @last_usage == false
-			end
-			if @superspace 
-				name = "#{superspace}_#{name}".to_sym
-				@last_usage = "#{@superspace} #{@last_usage}" unless @last_usage == false
+			[@namespace, @superspace].each do |prefix|
+				prefix or next
+				name = "#{prefix}_#{name}"
+				@last_usage = "#{prefix} #{last_usage}" unless @last_usage == false
 			end
+			name = name.to_sym
 			@actions[name] = Action.new(block, @last_usage, @last_help)
 			@last_usage = nil
 			@last_help = nil
 		end
 
 		# Add an option flag and its help text.
-		def add_option(flag, text)
-			@options[flag] = text
+		def add_option(flag, text, scope=nil)
+			scope or scope = 'Options'
+			@options[scope] = {} unless @options[scope]
+			@options[scope][flag] = text
 		end
 
 		# Run the command. This is a wrapper around docopt. It will 
@@ -110,12 +110,16 @@ module Runfile
 		# finally for a. This is intended to allow "overloading" of 
 		# the command as an action (e.g. also allow a global action 
 		# called 'a').
+		# if no command was found, but we have a :global command, 
+		# assume this is the requested one (since we will not reach 
+		# this point unless the usage pattern matches).
 		def find_action(argv)
 			3.downto(1).each do |n|
 				next unless argv.size >= n 
 				action = argv[0..n-1].join('_').to_sym
 				return action if @actions.has_key? action
 			end
+			return :global if @actions.has_key? :global 
 			return false
 		end
 

data/lib/runfile/util.rb

@@ -1,7 +1,7 @@
 module Runfile
 	# Debug print and exit
 	def d(obj)
-		p obj 
+		pp obj 
 		exit
 	end
 

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-	VERSION = "0.3.2"
+	VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-13 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole