runfile 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cb84d16815dfadc5e82418e78fd206aa620b1db
-  data.tar.gz: ff736e5bb5457df832e1d86bcc30e0b511c5306a
+  metadata.gz: 1df6dc7a19fa65337447fc31211bca292dfe4f51
+  data.tar.gz: b18d49b824c571c79b33bdfce4de8d623341f24f
 SHA512:
-  metadata.gz: 0e43ff2a0f3abcdad96268ac6a31dab5dad865af382ab083f71e18d3d8e7fb5c4cc8205a5e96909e2758368f9aab747ba0ec8defeda934c1b1bc6aa1a76b7ed5
-  data.tar.gz: c1d2e5d20e4fe53249bd36ed69805b724d45c3d43d0092505c2a346bb217c0a415b7f352e0440a853ae2211cb5241132950f77f56159d46daeccf06ba2ef387d
+  metadata.gz: 98946aa178216ee977540b219285e7adf68afdb5bf73ae36ad1f1af422e1129be2255ebee3eb1f5155021c84354ddd127031facee9b66e89f875ca11f39d7896
+  data.tar.gz: 53eb5cdc444911e1587490f042381d5b1e0c3d4153fa4b97b8d8b301008ec58fab05a14b6e28e2bb59e1e41644e9efd8dcbbbdc9202c836f0c04835cef12b251

data/README.md

@@ -82,4 +82,3 @@ Options:
 - [Runfile Command Reference](https://github.com/DannyBen/runfile/wiki/Runfile-Command-Reference)
 - [Wiki](https://github.com/DannyBen/runfile/wiki)
 - [Rubydoc](http://www.rubydoc.info/gems/runfile)
-

data/lib/runfile.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'runfile/version'
-require 'runfile/docopt_maker'
+require 'runfile/docopt_helper'
+require 'runfile/runfile_helper'
 require 'runfile/action'
 require 'runfile/runner'
 require 'runfile/dsl'

data/lib/runfile/{docopt_maker.rb → docopt_helper.rb}

@@ -4,9 +4,15 @@ require 'colsole'
 module Runfile
 	include Colsole
 
-	# The DocoptMaker class handles the dynamic generation of the docopt
-	# document.
-	class DocoptMaker
+	# The DocoptHelper class handles the dynamic generation of the 
+	# docopt document and the docopt part of the execution (meaning,
+	# to call Docopt so it returns the parsed arguments or halts with
+	# usage message).
+	class DocoptHelper
+
+		# The constructor expects to get all the textual details
+		# needed to generate a docopt document (name, version, 
+		# summary, options) and an array of Action objects.
 		def initialize(name, version, summary, actions, options)
 			@name    = name
 			@version = version
@@ -17,7 +23,7 @@ module Runfile
 
 		# Generate a document based on all the actions, help messages
 		# and options we have collected from the Runfile DSL.
-		def make
+		def docopt
 			width, height = detect_terminal_size
 			doc = "#{@name} #{@version}\n"
 			doc += "#{@summary} \n" if @summary
@@ -45,5 +51,11 @@ module Runfile
 			end
 			doc
 		end
+
+		# Calls 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)
+		end
 	end
 end

data/lib/runfile/runfile_helper.rb

@@ -0,0 +1,82 @@
+require 'docopt'
+require 'pp'
+
+module Runfile
+
+	# The RunfileHelper class assists in:
+	# 1. Finding named.runfiles
+	# 2. Creating new runfiles (`run make`)
+	# 3. Showing a list of found system runfiles in a colorful help
+	class RunfileHelper
+		
+		# Handle the case when `run` is called without a Runfile 
+		# present. We will let the user know they can type `run make`
+		# to create a new sample Runfile.
+		# If the first argument matches the name of a *.runfile name,
+		# we will return it to the caller. Otherwise, we return false
+		# to indicate "no further handling is needed".
+		def handle(argv)
+			# make a new runfile
+			if argv[0] == "make"
+				make_runfile argv[1]
+				return false
+			end
+
+			# get a list of *.runfile path-wide
+			runfiles = find_runfiles || []
+
+			# if first arg is a valid *.runfile, run it
+			if argv[0] 
+				runfile = runfiles.select { |f| f[/#{argv[0]}.runfile/] }.first
+				runfile and return runfile
+			end
+
+			# if we are here, offer some help and advice
+			show_make_help runfiles
+			return false
+		end
+
+		private
+
+		# Create a new runfile in the current directory. We can either
+		# create a standard 'Runfile' or a 'named.runfile'.
+		def make_runfile(name=nil)
+			name = 'Runfile' if name.nil?
+			template = File.expand_path("../templates/Runfile", __FILE__)
+			name += ".runfile" unless name == 'Runfile'
+			dest = "#{Dir.pwd}/#{name}"
+			begin
+				File.write(dest, File.read(template))
+				puts "#{name} created."
+			rescue => e
+				abort "Failed creating #{name}\n#{e.message}"
+			end
+		end
+
+		# Find all *.runfiles path-wide
+		def find_runfiles
+			find_all_in_path '*.runfile'
+		end
+
+		# Show some helpful tips, and a list of available runfiles
+		def show_make_help(runfiles)
+			say "!txtpur!Runfile engine v#{Runfile::VERSION}"
+			runfiles.size < 5 and say "\nTip:  Type '!txtblu!run make!txtrst!' or '!txtblu!run make name!txtrst!' to create a runfile.\n      Place !txtblu!named.runfiles!txtrst! anywhere in the PATH for global access."
+			if runfiles.empty? 
+				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
+			end
+		end
+	end
+end

data/lib/runfile/runner.rb

@@ -4,7 +4,10 @@ require 'pp'
 module Runfile
 
 	# The Runner class is the main workhorse behind Runfile.
-	# It handles all the Runfile DSL commands and executes the Runfile.
+	# It handles all the Runfile DSL commands and executes the 
+	# Runfile with the help of two more specialized classes:
+	# 1. DocoptHelper - for deeper docopt related actions
+	# 2. RunfileHelper - for Runfile creation and system wide search
 	class Runner
 		attr_accessor :last_usage, :last_help, :name, :version, 
 			:summary, :namespace, :superspace
@@ -89,18 +92,13 @@ module Runfile
 
 		private
 
-		# Dynamically generate the docopt document.
-		def docopt
-			maker = DocoptMaker.new(@name, @version, @summary, @actions, @options)
-			maker.make
-		end
-
 		# Call the docopt parser and execute the action with the 
 		# parsed arguments.
 		# This should always be called in a begin...rescue block and
 		# you should handle the Docopt::Exit exception.
 		def docopt_exec(argv)
-			args = Docopt::docopt(docopt, version: @version, argv:argv)
+			helper = DocoptHelper.new(@name, @version, @summary, @actions, @options)
+			args   = helper.args argv
 			action = find_action argv
 			action or abort "Runfile error: Action not found"
 			@actions[action].execute args
@@ -121,61 +119,18 @@ module Runfile
 			return false
 		end
 
-		# Handle the case when `run` is called without a Runfile 
-		# present. We will let the user know they can type `run make`
-		# to create a new sample Runfile.
-		# If the first argument matches the name of a *.runfile name,
-		# we will execute it.
+		# When `run` is called without a Runfile (or runfile not 
+		# found), hand over handling to the RunfileHelper class.
+		# If will either return false if no further handling is needed
+		# on our part, or the name of a runfile to execute.
 		def handle_no_runfile(argv)
-			# make a new runfile
-			if argv[0] == "make"
-				make_runfile argv[1]
-				exit
-			end
-
-			# get a list of *.runfile path-wide
-			runfiles = find_runfiles || []
-
-			# if first arg is a valid *.runfile, run it
-			if argv[0] 
-				runfile = runfiles.select { |f| f[/#{argv[0]}.runfile/] }.first
-				if runfile
-					@superspace = argv[0]
-					execute argv, runfile
-					exit
-				end
-			end
-
-			# if we are here, offer some help and advice
-			say "!txtpur!Runfile engine v#{Runfile::VERSION}\n"
-			runfiles.empty? and say "!txtred!Runfile not found."
-			runfiles.each do |f|
-				f[/([^\/]+).runfile$/]
-				say "Did you mean '!txtgrn!run #{$1}!txtrst!' (#{f})"
+			maker = RunfileHelper.new
+			runfile = maker.handle argv
+			if runfile
+				@superspace = argv[0]
+				execute argv, runfile
 			end
-			say "\nUse '!txtblu!run make!txtrst!' to create 'Runfile'.\nUse '!txtblu!run make name!txtrst!' to create 'name.runfile'.\nPlace named.runfiles anywhere in the path for global access.\n"
 			exit
-
-		end
-
-		# Create a new runfile in the current directory. We can either
-		# create a standard 'Runfile' or a 'named.runfile'.
-		def make_runfile(name=nil)
-			name = 'Runfile' if name.nil?
-			template = File.expand_path("../templates/Runfile", __FILE__)
-			name += ".runfile" unless name == 'Runfile'
-			dest = "#{Dir.pwd}/#{name}"
-			begin
-				File.write(dest, File.read(template))
-				puts "#{name} created."
-			rescue => e
-				abort "Failed creating #{name}\n#{e.message}"
-			end
-		end
-
-		# Find all *.runfiles path-wide
-		def find_runfiles
-			find_all_in_path '*.runfile'
 		end
 	end
 end

data/lib/runfile/templates/Runfile

@@ -1,9 +1,14 @@
-summary "Application description"
+name    "Greeter"
+summary "A sample Runfile"
 version "0.1.0"
 
-usage  "command <arg> [--flag]"
-help   "Help line for command"
-option "-f --flag", "Help text for option"
-action :command do |args|
-	say "Command running..."
+usage  "hello [<name> --color]"
+help   "Say hello"
+option "-c --color", "Greet with color"
+action :hello do |args|
+	if args['--color']
+		say "!txtgrn!Hello #{args['<name>']}"
+	else
+		say "Hello #{args['<name>']}"
+	end
 end

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-	VERSION = "0.2.7"
+	VERSION = "0.2.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -49,8 +49,9 @@ files:
 - bin/run
 - lib/runfile.rb
 - lib/runfile/action.rb
-- lib/runfile/docopt_maker.rb
+- lib/runfile/docopt_helper.rb
 - lib/runfile/dsl.rb
+- lib/runfile/runfile_helper.rb
 - lib/runfile/runner.rb
 - lib/runfile/templates/Runfile
 - lib/runfile/util.rb