runfile 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4214f82d6684139a8037647c5ccbc573faf47ab4
-  data.tar.gz: d38adc9cad47620f82812bbe0fe1881e9e2efff8
+  metadata.gz: ea9b733a42bb98660d63972f6058640c7066d0ab
+  data.tar.gz: ffd28023ce207978725d0fb738d044df06c22149
 SHA512:
-  metadata.gz: cf2f7fafb7d05a4ad9888ca22d4f3a507811749fe383b1c579ab0057c26e931331a88c1a88809c4ad3cadf07d658e1ca74006e2cdd9f24ff1ea9113f619f0183
-  data.tar.gz: bda2f4546fd50cd8550dacf75acf184be4bb580fccc95ca26f8bb778d5fb55c83a17148776059a6dc3a99771b05afc4b55d48f01146366775f1567ce5bd644fc
+  metadata.gz: 25f6f6d32f4ca26cb516485520b0d2f193c076fa489c619f223861771cb4cfd5e50bf8a0be29e036fe1c53214850059b7ef980f05c8c1e4adf645025f6061c41
+  data.tar.gz: d9a5be0f3a2aa31767265d27d35c787b66e46187586c50405e48acc15dbef2283bad0da83e576f15b3cf8c78cc0ef8ece490ee3e785f9dd6e4a912d10426e09d

data/README.md

@@ -72,7 +72,7 @@ Options:
 
 ## Test
 
-  $ rake test
+	$ rake test
 
 
 ## Todo

data/bin/run

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
 
 require 'runfile'
+
+# for dev
+# require File.dirname(__FILE__) + "/../lib/runfile"
+
 include Runfile
 
 Runner.instance.execute ARGV

data/lib/runfile.rb

@@ -4,3 +4,4 @@ require 'runfile/docopt_maker'
 require 'runfile/action'
 require 'runfile/runner'
 require 'runfile/dsl'
+require 'runfile/util'

data/lib/runfile/docopt_maker.rb

@@ -7,7 +7,8 @@ module Runfile
 	# The DocoptMaker class handles the dynamic generation of the docopt
 	# document.
 	class DocoptMaker
-		def initialize(version, summary, actions, options)
+		def initialize(name, version, summary, actions, options)
+			@name    = name
 			@version = version
 			@summary = summary
 			@actions = actions
@@ -18,7 +19,7 @@ module Runfile
 		# and options we have collected from the Runfile DSL.
 		def make
 			width, height = detect_terminal_size
-			doc = "Runfile #{@version}\n"
+			doc = "#{@name} #{@version}\n"
 			doc += "#{@summary} \n" if @summary
 			doc += "\nUsage:\n";
 			@actions.each do |name, action|

data/lib/runfile/dsl.rb

@@ -3,6 +3,11 @@
 # for handling.
 
 module Runfile
+	# Set the name of your Runfile program
+	def name(name)
+		Runner.instance.name = name
+	end
+
 	# Set the version of your Runfile program
 	def version(ver)
 		Runner.instance.version = ver

data/lib/runfile/runner.rb

@@ -6,20 +6,22 @@ module Runfile
 	# The Runner class is the main workhorse behind Runfile.
 	# It handles all the Runfile DSL commands and executes the Runfile.
 	class Runner
-		attr_accessor :last_usage, :last_help, :version, :summary, :namespace, :superspace
+		attr_accessor :last_usage, :last_help, :name, :version, 
+			:summary, :namespace, :superspace
 
 		@@instance = nil
 
 		# Initialize all variables to sensible defaults.
 		def initialize
-			@last_usage = nil  # dsl: usage
-			@last_help  = nil  # dsl: help
-			@superspace = nil  # used when filename != Runfile
-			@namespace  = nil  # dsl: #command
-			@actions = {}      # dsl: action
-			@options = {}      # dsl: option
-			@version = "0.0.0" # dsl: version
-			@summary = false   # dsl: summary
+			@superspace = nil    # used when filename != Runfile
+			@last_usage = nil    # dsl: usage
+			@last_help  = nil    # dsl: help
+			@namespace  = nil    # dsl: #command
+			@actions = {}        # dsl: action
+			@options = {}        # dsl: option
+			@name    = "Runfile" # dsl: name
+			@version = "0.0.0"   # dsl: version
+			@summary = false     # dsl: summary
 		end
 
 		# Return a singleton Runner instance.
@@ -30,11 +32,11 @@ module Runfile
 
 		# Load and execute a Runfile call.
 		def execute(argv, filename='Runfile')
-			File.file? filename or handle_no_runfile argv
+			File.file?(filename) or handle_no_runfile argv
 			begin
 				load filename
-			rescue
-				abort "Failed loading file '#{filename}'.\nIs it a valid Runfile?"
+			rescue => e
+				abort "Runfile error:\n#{e.message}"
 			end
 			@@instance.run *argv
 		end
@@ -89,7 +91,7 @@ module Runfile
 
 		# Dynamically generate the docopt document.
 		def docopt
-			maker = DocoptMaker.new(@version, @summary, @actions, @options)
+			maker = DocoptMaker.new(@name, @version, @summary, @actions, @options)
 			maker.make
 		end
 
@@ -125,23 +127,55 @@ module Runfile
 		# If the first argument matches the name of a *.runfile name,
 		# we will execute it.
 		def handle_no_runfile(argv)
+			# make a new runfile
 			if argv[0] == "make"
-				sample = File.dirname(__FILE__) + "/../../examples/template/Runfile"
-				dest   = Dir.pwd + "/Runfile"
-				File.write(dest, File.read(sample))
-				abort "Runfile created."
-			elsif argv[0] and File.exist? "#{argv[0]}.runfile"
-				@superspace = argv[0]
-				execute argv, "#{argv[0]}.runfile"
-			else
-				runfiles = Dir['*.runfile']
-				runfiles.empty? and abort "Runfile engine v#{Runfile::VERSION}\n\nRunfile not found.\nUse 'run make' to create one."
-				runfiles.each do |f|
-					f.slice! '.runfile'
-					puts "Did you mean 'run #{f}'"
+				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})"
+			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

@@ -0,0 +1,9 @@
+summary "Application description"
+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..."
+end

data/lib/runfile/util.rb

@@ -0,0 +1,29 @@
+module Runfile
+
+	# Debug print and exit
+	def d(obj)
+		p obj 
+		exit
+	end
+
+	# Find a single file in any of the path directories
+	def find_in_path(file)
+		ENV['PATH'].split(File::PATH_SEPARATOR).any? do |d|
+			candidate = File.join(d, file)
+			return candidate if File.exist? candidate
+		end
+		false
+	end
+
+	# Find all files matching a pattern in any of the path directories
+	def find_all_in_path(pattern, include_cwd=true)
+		result = []
+		dirs = ENV['PATH'].split(File::PATH_SEPARATOR)
+		dirs.insert(0, Dir.pwd) if include_cwd 
+		dirs.each do |d|
+			found = Dir[File.join(d, pattern)]
+			result << found unless found.empty?
+		end
+		return result.empty? ? false : result.flatten
+	end
+end

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-	VERSION = "0.2.2"
+	VERSION = "0.2.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -52,6 +52,8 @@ files:
 - lib/runfile/docopt_maker.rb
 - lib/runfile/dsl.rb
 - lib/runfile/runner.rb
+- lib/runfile/templates/Runfile
+- lib/runfile/util.rb
 - lib/runfile/version.rb
 homepage: https://github.com/DannyBen/runfile
 licenses: