rubygems-yardoc 0.0.1 → 0.0.2

data/README.markdown

@@ -1,7 +1,7 @@
 rubygems-yardoc
 ===============
 
-This gem provides `gem yardoc` command which generate YARD documentation for specified gems.
+This gem provides `gem yardoc` command which generates YARD documentations for specified gems.
 
 Installation
 ------------
@@ -18,12 +18,28 @@ Or install it yourself as:
 
     $ gem install rubygems-yardoc
 
+Installing `redcarpet` by writing:
+
+    gem 'recarpet'
+
+And executing:
+
+    $ bundle
+
+Or just executing:
+
+    $ gem install redcarpet
+
+often helps you because many gems use Markdown to write README files
+and YARD require `redcapet` when parsing Markdown.
+
 Usage
 -----
 
     $ gem yardoc GEMNAME [GEMNAME ...]
 
-YARD Documentation for GEMNAME will be generated to `{GEM INSTALATION DIRECTORY}/doc/{GEMNAME}-{VERSION}/yardoc`
+Make `yard` directory into specified gem's doc directory and
+YARD Documentation for the gem will be generated into the directory
 
 Contributing
 ------------

data/Rakefile

@@ -1,23 +1,6 @@
 require 'rake/clean'
 require 'rubygems/specification'
-require 'bundler/gem_helper'
+require 'bundler/gem_tasks'
 require 'yard'
 
 YARD::Rake::YardocTask.new
-
-spec = Gem::Specification.load(File.join(File.dirname(__FILE__), 'rubygems-yardoc.gemspec'))
-
-desc "Build #{spec.name}-#{spec.version}.gem into the pkg directory."
-task :build do
-  Bundler::GemHelper.new.build_gem
-end
-
-desc "Build and install #{spec.name}-#{spec.version}.gem into system gems."
-task :install do
-  Bundler::GemHelper.new.install_gem
-end
-
-desc "Create tag v#{spec.version} and build and push #{spec.name}-#{spec.version}.gem to Rubygems"
-task :release do
-  Bundler::GemHelper.new.release_gem
-end

data/lib/rubygems/commands/yardoc_command.rb

@@ -1,29 +1,35 @@
 require 'rubygems/package'
 require 'rubygems/command'
-require 'shellwords'
 require 'yard'
 
 class Gem::Commands::YardocCommand < Gem::Command
+  VERSION = '0.0.2'
+
   def initialize
-    super 'yardoc', 'Generate YARD documentation for specified gems'
+    super 'yardoc', 'Generate YARD documentations for specified gems into doc directory'
   end
 
   def arguments # :nodoc:
-    'GEMNAME [GEMNAME ...] gem to generate YARD documentation'
+    'GEMNAME [GEMNAME ...]       gem to generate YARD documentation'
   end
 
   def usage # :nodoc:
-    "gem #{command} #{arguments}"
+    "#{program_name} GEMNAME [GEMNAME ...]"
   end
 
   def execute
-    gemnames = get_all_gem_names
-    gemnames.each do |gemname|
-      gemspec = Gem::Specification.find_by_name(gemname)
-      yardoc_dir = File.join(gemspec.doc_dir, 'yardoc')
-      Dir.chdir gemspec.gem_dir do
-        YARD::CLI::Yardoc.run '--output-dir', yardoc_dir
-      end
+    get_all_gem_names.each do |name|
+      run_yardoc name
+    end
+  end
+
+  def run_yardoc(gem_name)
+    spec = Gem::Specification.find_by_name(gem_name)
+    yardoc_dir = File.join(spec.doc_dir, 'yardoc')
+    Dir.chdir spec.gem_dir do
+      YARD::CLI::Yardoc.run '--output-dir', yardoc_dir
     end
+    $stderr.puts 'YARD documentation is generated in:'
+    $stderr.puts yardoc_dir
   end
 end

data/lib/rubygems_plugin.rb

@@ -1,4 +1,3 @@
 require 'rubygems/command_manager'
-require 'rubygems/commands/yardoc_command'
 
 Gem::CommandManager.instance.register_command :yardoc

data/rubygems-yardoc.gemspec

@@ -1,15 +1,16 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubygems/commands/yardoc_command'
 
 Gem::Specification.new do |gem|
   gem.name          = "rubygems-yardoc"
-  gem.version       = '0.0.1'
+  gem.version       = Gem::Commands::YardocCommand::VERSION
   gem.authors       = ["KITAITI Makoto"]
   gem.email         = ["KitaitiMakoto@gmail.com"]
-  gem.description   = %q{Provides gem yardoc command which generate YARD document for specified gems}
+  gem.description   = %q{Provides a "gem yardoc" command which generates YARD documentations for specified gems}
   gem.summary       = %q{gem yardoc command-line tool}
-  gem.homepage      = ""
+  gem.homepage    = "https://github.com/KitaitiMakoto/rubygems-yardoc"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubygems-yardoc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &15435140 !ruby/object:Gem::Requirement
+  requirement: &12928800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15435140
+  version_requirements: *12928800
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &15434680 !ruby/object:Gem::Requirement
+  requirement: &12928380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15434680
+  version_requirements: *12928380
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &15434240 !ruby/object:Gem::Requirement
+  requirement: &12944320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,9 +43,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15434240
-description: Provides gem yardoc command which generate YARD document for specified
-  gems
+  version_requirements: *12944320
+description: Provides a "gem yardoc" command which generates YARD documentations for
+  specified gems
 email:
 - KitaitiMakoto@gmail.com
 executables: []
@@ -59,7 +59,7 @@ files:
 - lib/rubygems/commands/yardoc_command.rb
 - lib/rubygems_plugin.rb
 - rubygems-yardoc.gemspec
-homepage: ''
+homepage: https://github.com/KitaitiMakoto/rubygems-yardoc
 licenses: []
 post_install_message: 
 rdoc_options: []