runfile-tasks 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dd4e3a43cf9f25dff922b382652fd3ee38a8623
-  data.tar.gz: f0f6d668c56f41a1175170a6d33c7e7e1ddc1073
+  metadata.gz: abebf00a93220e0bf6605b917c844daf8a5ef3ef
+  data.tar.gz: 523f6137b921d7903e4604e8d83114feb5faf553
 SHA512:
-  metadata.gz: a0fc8373f66062b000aae5faa41caf41c41c89335ecfd5ab632821e72130e40e70d71ac212eb86b61939811dce63d3879d6a54c06d5f66d6e4849cf1da4cb17b
-  data.tar.gz: 174ef213dc3d9b13e4e960d7558cf24bb55c7c175336c23c17bf2ae1f7bcf70c75b909f73c8778c52ec7edcf8ff00e50cb6c1774d638a8de68006f053c43309d
+  metadata.gz: 821b70deec211fafda1ef03e5e0a0eaaf170f0bdb5279ff4c05b3920db1be8e918dc5efe2f58534061928e89fa8c6255e44027c28d6075aa5d163616a500e6d0
+  data.tar.gz: a4de31834c7950a555c0cfad8e1d333bafca32a0edecaa4f00699fbc3ab2727161e0d4624228d08995d7cba45ab7dd17331c33e21f0f1e15aa0316711f420461

data/README.md

@@ -1,3 +1,171 @@
 Runfile Tasks
 =============
 
+A library of tasks ready to be included in your [Runfile]
+
+## Install
+
+Install the gem or require it in your Gemfile:
+
+	gem 'runfile-tasks'
+
+In your Runfile, you can include either all tasks:
+
+	require 'runfile-tasks'
+
+Or pick and choose from the various task categories:
+
+	require 'runfile-tasks/testing'
+
+
+Requiring the task packs does not make the available in your Runfile 
+immediately. You need to activate any of the tasks you want as described 
+below.
+
+
+## Usage
+
+Include any of the tasks you need in your Runfile like this:
+
+```ruby
+require 'runfile-tasks'
+
+name    "Greeter"
+summary "A sample Runfile"
+version "0.1.0"
+
+# Include rdoc tasks and rspec tasks
+RunfileTasks::Docs.rdoc
+RunfileTasks::Testing.rspec
+
+# The rest of your Runfile goes here
+action :hello do
+  puts "world"
+end
+
+```
+
+
+## Task Index
+
+### Testing Tasks
+
+Including all testing tasks:
+
+```ruby
+require 'runfile-tasks/testing'
+```
+
+#### Testing with RSpec
+
+Commands Added:
+
+- `run spec [NAME]` - Run all specs or a single spec file matching a regex.
+
+```ruby
+# Runfile
+
+# Only include the rspec tasks
+require 'runfile-tasks/testing/rspec'
+
+# Include the rspec tasks with default configuration
+RunfileTasks::Testing.rspec
+
+# Set the Runfile action to 'test' instead of the default 'spec'
+RunfileTasks::Testing.rspec 'test'
+
+# Change the default options with a hash (these are the defaults)
+RunfileTasks::rspec action: 'spec', 
+  pattern: './spec/**/*_spec.rb', command: 'rspec'
+
+```
+
+
+#### Testing with Minitest
+
+Commands Added:
+
+- `test [NAME]` - Run all tests or a single test file.
+
+```ruby
+# Runfile
+
+# Only include the minitest tasks
+require 'runfile-tasks/testing/minitest'
+
+# Include the minitest tasks with default configuration
+RunfileTasks::Testing.minitest
+
+# Set the file pattern to look for (this is the default)
+RunfileTasks::Testing.rspec './test/*_test.rb'
+
+```
+
+#### Testing with Cucumber
+
+Commands Added:
+
+- `(feature|features) [current]` - Run cucumber feature tests
+
+```ruby
+# Runfile
+
+# Only include the minitest tasks
+require 'runfile-tasks/testing/cucumber'
+
+# Include the cucumber tasks with default configuration
+RunfileTasks::Testing.cucumber
+```
+
+
+### Gem Authoring Tasks
+
+Commands Added:
+
+- `build [--install]` - Build gem from gemspec and move it to 'gems' folder. 
+   Use --install to also install it.
+- `install [--remote]` - Install gem from local gem file or from rubygems 
+   (--remote).
+- `publish` - Publish gem to rubygems. Make sure to 'run gem build' before 
+   you publish.
+- `yank [VERSION]` - Yank gem from rubygems.
+
+
+```ruby
+# Runfile
+require 'runfile-tasks/rubygems'
+
+# Include the tasks with default configuration. Pass in your gem name.
+RunfileTasks::RubyGems.all 'my-gem'
+
+# Set the folder where gems are copied after they are built (default)
+RunfileTasks::RubyGems.all 'my-gem', 'gems'
+```
+
+
+### Documentation Tasks
+
+Commands Added:
+
+- `rdoc [-- OPTIONS...]` - Generate documentation using the rdoc command 
+  line tool. To pass arguments to rdoc, place them after '--'.
+
+
+```ruby
+# Runfile
+require 'runfile-tasks/docs'
+
+# Include the tasks with default configuration.
+RunfileTasks::Docs.rdoc
+
+# Set the files to be considered (default below)
+RunfileTasks::Docs.rdoc '**/*.{rb,md}'
+
+# Pass any additional option directly to rdoc (defaults below)
+RunfileTasks::Docs.rdoc '**/*.{rb,md}', ["--main README.md", "--all",]
+```
+
+
+---
+[Runfile]: https://github.com/DannyBen/runfile
+[random cat]: http://thecatapi.com/api/images/get

data/lib/runfile-tasks/docs/rdoc.rb

@@ -1,25 +1,25 @@
 module RunfileTasks
-	module Docs
-		extend self
+  module Docs
+    extend self
 
-		@@default_rdoc_options = [
-			"--main README.md",
-			"--all",
-		]
+    @@default_rdoc_options = [
+      "--main README.md",
+      "--all",
+    ]
 
-		def rdoc(files=nil, options=@@default_rdoc_options)
-			files or files = Dir['**/*.{rb,md}']
-			files = "'" + files.join("' '") + "'"
-			usage  "rdoc [-- <options>...]"
-			help   "Generate documentation using the rdoc command line tool. To pass arguments to rdoc, place them after '--'."
-			action :rdoc do |args|
-				inopts = args['<options>']
-				options = inopts unless inopts.empty?
-				options = options.join(' ')
-				cmd = "rdoc #{options} #{files}"
-				say "!txtgrn!Running: !txtpur!#{cmd}"
-				system cmd
-			end
-		end
-	end
+    def rdoc(files=nil, options=@@default_rdoc_options)
+      files or files = Dir['**/*.{rb,md}']
+      files = "'" + files.join("' '") + "'"
+      usage  "rdoc [-- <options>...]"
+      help   "Generate documentation using the rdoc command line tool. To pass arguments to rdoc, place them after '--'."
+      action :rdoc do |args|
+        inopts = args['<options>']
+        options = inopts unless inopts.empty?
+        options = options.join(' ')
+        cmd = "rdoc #{options} #{files}"
+        say "!txtgrn!Running: !txtpur!#{cmd}"
+        system cmd
+      end
+    end
+  end
 end

data/lib/runfile-tasks/rubygems/rubygems.rb

@@ -22,7 +22,7 @@ module RunfileTasks
         files = Dir["*.gem"]
         Dir.exist? gemdir or FileUtils.mkdir gemdir
         files.each {|f| FileUtils.mv f, gemdir }
-        args['--install'] and call "gem install"
+        args['--install'] and execute "gem install"
       end
 
       usage  "install [--remote]"

data/lib/runfile-tasks/testing/minitest.rb

@@ -1,23 +1,23 @@
 module RunfileTasks
-	module Testing
-		extend self
+  module Testing
+    extend self
 
-		def minitest(pattern="./test/*_test.rb")
-			usage  "test [<name>]"
-			help   "Run all tests or a single test file."
-			action :test do |args|
-				if args['<name>'] 
-					file = pattern.sub "*", args['<name>']
-					say "!txtgrn!Using: !txtpur!#{file}"
-					require file
-				else
-					Dir[pattern].each do |file| 
-						say "!txtgrn!Using: !txtpur!#{file}"
-						require file
-					end
-				end
-			end
-		end
+    def minitest(pattern="./test/*_test.rb")
+      usage  "test [<name>]"
+      help   "Run all tests or a single test file."
+      action :test do |args|
+        if args['<name>'] 
+          file = pattern.sub "*", args['<name>']
+          say "!txtgrn!Using: !txtpur!#{file}"
+          require file
+        else
+          Dir[pattern].each do |file| 
+            say "!txtgrn!Using: !txtpur!#{file}"
+            require file
+          end
+        end
+      end
+    end
 
-	end
+  end
 end

data/lib/runfile-tasks/version.rb

@@ -1,3 +1,3 @@
 module RunfileTasks
-	VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile-tasks
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-12 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runfile
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Runfile tasks collection