run-gem-dev 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8384400d2fed3a7e13b975cc131cd24725566d7b
-  data.tar.gz: b511593f4c8a460b038876d547ae12da884c463c
+  metadata.gz: a8852b79f7c805890bb95af6c1c48c1d7050b4dd
+  data.tar.gz: 5b56626ea677a9836d5ae2668a922f5139a8161d
 SHA512:
-  metadata.gz: 4e60c0c146e5671db7e492055c337171b1f6c1f7a06ccbcb622dab6e4c59b43bfedd4d9f52380e6cf0f1e1d19b6ddc9ea8a1d2cd6bdce6697a098da9d6785e1e
-  data.tar.gz: 192a6ed53997c7cfb9a11a1e44f4238ef46a35668c985bb9f554ed60e14780236907cca4aa876e259cd4def5800da4256ec0a78a1bc42c8ef747c12af2cb9799
+  metadata.gz: d38bc615d650149ad85f4f5bc9bbc8a4f42362244f32c9e3bdeaad04d36dde5c9620bd6c2e62e49fd4cdfd1891411dc6b23cd31700bf7f231e9821261c3da23f
+  data.tar.gz: 625ec6632cf0d7eaca59cefaae5c74e422289b1c4322a8a345ab47e43a9204cfd2aad479c5c571a20e7872a53c22b7c189f674a9935820f576918d28b21b1471

data/README.md

@@ -20,22 +20,30 @@ name    "My Gem Runfile"
 summary "Tasks for my gem"
 version "0.1.0"
 
-RunGemDev::Tasks.embed 'run-gem-dev'
+# Add rubygems tasks (publish, install etc.)
+RunGemDev::gem_tasks 'my-gem-name'
+
+# Add test task (minitest)
+RunGemDev::test_tasks
+
+# Add rdoc task
+RunGemDev::rdoc_tasks
 
 # Your other tasks here
+# ...
 
 ```
 
 ## Available Tasks
 
-	run gem build [<folder>]
-	run gem install
+	run gem build [--install]
+	run gem install [--remote]
 	run gem publish
 	run gem yank [<version>]
-	run gem test [<name>]
-
+	run test [<name>]
+	run rdoc [-- <options>...]
+	run addtest <command>
 
 ## Todo
 
-- Docs
 - Add `init` (scaffold gemspec and folders)

data/lib/run-gem-dev/tasks.rb

@@ -1,61 +1,98 @@
+# This module provides Runfile tasks for gem developers.
+# The tasks are divided to three categories:
+#
+# 1. Rubygems tasks (publish, build etc)
+# 2. Tests tasks (using minitest)
+# 3. Rdoc tasks
 
 module RunGemDev
-	def self.tasks(gemname, gemdir="gems")
+
+	@@default_rdoc_options = [
+		"--main README.md",
+		"--all",
+	]
+
+	
+	# Add rubygems tasks: build, install, publish and yank
+	def self.gem_tasks(gemname, gemdir="gems")
 		command "gem"
 
 		spec = Gem::Specification::load "#{gemname}.gemspec"
 		spec or abort "Error loading #{gemname}.gemspec"
 		gemver = spec.version.to_s
-		
+
 		usage  "build [--install]"
 		help   "Build gem from gemspec and move it to '#{gemdir}' folder.\nUse --install to also install it."
 		action :build do |args|
-			say "Building gem..."
+			say "!txtgrn!Building gem"
 			cmd = "gem build #{gemname}.gemspec"	
-			say "Running: #{cmd}"
+			say "!txtgrn!Running: !txtpur!#{cmd}"
 			system cmd
-			say "Moving to #{gemdir}..."
+			say "!txtgrn!Moving gem file to #{gemdir}"
 			files = Dir["*.gem"]
 			files.each {|f| FileUtils.mv f, gemdir }
 			args['--install'] and call "gem install"
 		end
 
-		help   "Install local gem"
-		action :install do
-			gemfile = "gems/#{gemname}-#{gemver}.gem"
-			cmd = "gem install #{gemfile}"
-			say "Running: #{cmd}"
+		usage  "install [--remote]"
+		help   "Install gem from local gem file or from rubygems (--remote)."
+		action :install do |args|
+			if args['--remote']
+				cmd = "gem install #{gemname}"
+			else
+				gemfile = "gems/#{gemname}-#{gemver}.gem"
+				cmd = "gem install #{gemfile}"
+			end
+			say "!txtgrn!Running: !txtpur!#{cmd}"
 			system cmd
 		end
 
-		help   "Publish gem to rubygems"
+		help   "Publish gem to rubygems. Make sure to 'run gem build' before you publish."
 		action :publish do
 			gemfile = "gems/#{gemname}-#{gemver}.gem"
 			File.exist? gemfile or abort "File not found #{gemfile}"
 			cmd = "gem push #{gemfile}"
-			say "Running: #{cmd}"
+			say "!txtgrn!Running: !txtpur!#{cmd}"
 			system cmd
 		end
 
 		usage  "yank [<version>]"
-		help   "Yank gem from rubygems"
+		help   "Yank gem from rubygems."
 		action :yank do |args|
 			ver = args['<version>'] || gemver
 			cmd = "gem yank #{gemname} -v #{ver}"
-			say "Running: #{cmd}"
+			say "!txtgrn!Running: !txtpur!#{cmd}"
 			system cmd
-		end			
+		end
+		
+		endcommand
+	end
 
+	# Add minitest task
+	def self.test_tasks
 		usage  "test [<name>]"
-		help   "Run all tests or a single test file"
+		help   "Run all tests or a single test file."
 		action :test do |args|
 			name = args['<name>'] || "*"
 			cmd = "ruby -Itest test/test_#{name}.rb"
-			say "Running: #{cmd}"
+			say "!txtgrn!Running: !txtpur!#{cmd}"
 			system cmd
 		end
-
-		endcommand
 	end
 
+	# Add rdoc task
+	def self.rdoc_tasks(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

data/lib/run-gem-dev/version.rb

@@ -1,3 +1,5 @@
 module RunGemDev
-	VERSION = "0.1.2"
+
+	# Version constant, used by gemspec
+	VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: run-gem-dev
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runfile