runfile 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 558258a98c5a64125802ab9612acd60906bfd069
-  data.tar.gz: d787f718632c0e16df8d176938a30a54e668d5c7
+  metadata.gz: 4214f82d6684139a8037647c5ccbc573faf47ab4
+  data.tar.gz: d38adc9cad47620f82812bbe0fe1881e9e2efff8
 SHA512:
-  metadata.gz: 01ff19b161a0ab6492e87a5c432b2ca76de79802fa5356fb2103879e4ed67d11494d926f8343260414a3c51b56ae0c665ff7c423ea93377bc93e1519e68d0b84
-  data.tar.gz: 46ed488ad6b113c67223240d751a83409a7edb70950845cd1a34dd27133d5145ab74bf032b7a92da9e122658d51f7e8675d01af2e66a9c914713c22f80ab4445
+  metadata.gz: cf2f7fafb7d05a4ad9888ca22d4f3a507811749fe383b1c579ab0057c26e931331a88c1a88809c4ad3cadf07d658e1ca74006e2cdd9f24ff1ea9113f619f0183
+  data.tar.gz: bda2f4546fd50cd8550dacf75acf184be4bb580fccc95ca26f8bb778d5fb55c83a17148776059a6dc3a99771b05afc4b55d48f01146366775f1567ce5bd644fc

data/README.md

@@ -0,0 +1,88 @@
+Runfile - If Rake and Docopt had a baby
+=======================================
+
+An easy way to create project specific command line utilities
+
+
+## Wait, What?
+
+**Runfile** lets you create command line applications in a way similar 
+to [Rake](https://github.com/ruby/rake), but with the full power of 
+[Docopt](http://docopt.org/) command line options.
+
+You create a `Runfile`, and execute commands with 
+`run command arguments -and --flags`.
+
+
+## Install
+
+	$ gem install runfile
+
+
+## Example
+
+The most minimal `Runfile` looks like this:
+
+```ruby
+usage  "greet <name>"
+action :greet do |args|
+	puts "Hello #{args['<name>']}" 
+end
+```
+
+You can then run it by executing this command:
+
+```
+$ run greet Luke
+Hello Luke
+```
+
+Executing `run` without parameters, will show the usage patterns:
+
+```
+$ run
+Usage:
+  run greet <name>
+  run (-h | --help | --version)
+```
+
+Executing `run --help` will show the full help document (docopt)
+
+```
+$ run --help
+Runfile 0.0.0
+
+Usage:
+  run greet <name>
+  run (-h | --help | --version)
+
+Options:
+  -h --help
+      Show this screen
+
+  --version
+      Show version
+```
+
+## Documentation 
+
+- [Learn by Example](https://github.com/DannyBen/runfile/tree/master/examples)
+- [Runfile Command Reference](https://github.com/DannyBen/runfile/wiki/Runfile-Command-Reference)
+- [More about Runfile](https://github.com/DannyBen/runfile/wiki)
+
+## Test
+
+  $ rake test
+
+
+## Todo
+
+- Add documentation for `*.runfile` form files
+- (Colsole) Add newline detection in wordwrap (i.e. add indentation spaces 
+  after newline)
+- Consider supporting user and system level `*.runfiles`
+- Wiki (in progress)
+- GitHub pages
+- Can we have a colored docopt? Would be nice... 
+  (working, but causing some issues, will probably abandon)
+

data/lib/runfile.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+require 'runfile/version'
 require 'runfile/docopt_maker'
 require 'runfile/action'
 require 'runfile/runner'

data/lib/runfile/runner.rb

@@ -30,8 +30,12 @@ module Runfile
 
 		# Load and execute a Runfile call.
 		def execute(argv, filename='Runfile')
-			File.exist? filename or handle_no_runfile argv
-			load filename
+			File.file? filename or handle_no_runfile argv
+			begin
+				load filename
+			rescue
+				abort "Failed loading file '#{filename}'.\nIs it a valid Runfile?"
+			end
 			@@instance.run *argv
 		end
 
@@ -131,7 +135,7 @@ module Runfile
 				execute argv, "#{argv[0]}.runfile"
 			else
 				runfiles = Dir['*.runfile']
-				runfiles.empty? and abort "Runfile not found.\nUse 'run make' to create one."
+				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}'"

data/lib/runfile/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -45,12 +45,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/run
 - lib/runfile.rb
 - lib/runfile/action.rb
 - lib/runfile/docopt_maker.rb
 - lib/runfile/dsl.rb
 - lib/runfile/runner.rb
+- lib/runfile/version.rb
 homepage: https://github.com/DannyBen/runfile
 licenses:
 - MIT