rubygems-yardoc 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0274adef59e1ec7f54d5417c70b211539a4bf656
+  data.tar.gz: 380233675e69e53276f8ac4af05e92c389c1e367
+SHA512:
+  metadata.gz: c95c18db2625a0c0d6d2d0e4e3e1589ae0795637e938d9e7cfd8dec1a6d94303748dbc0dfd889a60754f5d6a9a120b8d2917687cf6269a531938ba10e3e520bb
+  data.tar.gz: 39b0165b019a2b38c57dbde93174e25e09ea7eb1a08f881b82d9c07190c1d06e81a31f7e5afbc377f3bd49648418b35726570a3e76254506df1e291bd57c8eda

data/README.markdown

@@ -6,40 +6,25 @@ This gem provides `gem yardoc` command which generates YARD documentations for s
 Installation
 ------------
 
-Add this line to your application's Gemfile:
-
-    gem 'rubygems-yardoc'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install rubygems-yardoc
 
-Installing `redcarpet` by writing:
-
-    gem 'recarpet'
-
-And executing:
-
-    $ bundle
-
-Or just executing:
+Installing [Redcarpet][1] by:
 
     $ gem install redcarpet
 
 often helps you because many gems use Markdown to write README files
-and YARD require `redcapet` when parsing Markdown.
+and YARD requires Redcarpet when parsing Markdown.
 
 Usage
 -----
 
     $ gem yardoc GEMNAME [GEMNAME ...]
 
-Make `yard` directory into specified gem's doc directory and
-YARD Documentation for the gem will be generated into the directory
+Makes `yardoc` directory into specified gem's doc directory and
+YARD Documentation for the gem will be generated into the directory.
+
+And this gem add `--yardoc` option to `gem install` command
+which install YARD documentation.
 
 Contributing
 ------------
@@ -49,3 +34,5 @@ Contributing
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[1]: https://github.com/vmg/redcarpet

data/lib/rubygems/commands/yardoc_command.rb

@@ -3,8 +3,6 @@ require 'rubygems/command'
 require 'yard'
 
 class Gem::Commands::YardocCommand < Gem::Command
-  VERSION = '0.0.2'
-
   def initialize
     super 'yardoc', 'Generate YARD documentations for specified gems into doc directory'
   end
@@ -19,17 +17,18 @@ class Gem::Commands::YardocCommand < Gem::Command
 
   def execute
     get_all_gem_names.each do |name|
-      run_yardoc name
+      self.class.run_yardoc Gem::Specification.find_by_name(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
+  class << self
+    def run_yardoc(spec)
+      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 to:'
+      $stderr.puts yardoc_dir
     end
-    $stderr.puts 'YARD documentation is generated in:'
-    $stderr.puts yardoc_dir
   end
 end

data/lib/rubygems_plugin.rb

@@ -1,3 +1,22 @@
 require 'rubygems/command_manager'
+require 'rubygems/install_update_options'
+require 'rubygems/commands/yardoc_command'
 
 Gem::CommandManager.instance.register_command :yardoc
+
+module Gem::InstallUpdateOptions
+  alias install_update_options_without_yardoc add_install_update_options
+  def add_install_update_options
+    install_update_options_without_yardoc
+
+    add_option 'Install/Update', '--yardoc', 'Generate YARD documentation for installed gems' do |value, option|
+      unless options[:document].include? 'yardoc'
+        options[:document] << 'yardoc'
+
+        Gem.post_install do |installer|
+          Gem::Commands::YardocCommand.run_yardoc(installer.spec)
+        end
+      end
+    end
+  end
+end

data/rubygems-yardoc.gemspec

@@ -1,24 +1,25 @@
 # -*- 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       = Gem::Commands::YardocCommand::VERSION
+  gem.version       = '0.0.3'
   gem.authors       = ["KITAITI Makoto"]
   gem.email         = ["KitaitiMakoto@gmail.com"]
   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    = "https://github.com/KitaitiMakoto/rubygems-yardoc"
+  gem.license     = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'yard'
+  gem.add_runtime_dependency 'yard', '~> 0.8.5'
 
   gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'redcarpet'
 end

metadata

@@ -1,49 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: rubygems-yardoc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-27 00:00:00.000000000 Z
+date: 2013-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &12928800 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.5
   type: :runtime
   prerelease: false
-  version_requirements: *12928800
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &12928380 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12928380
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &12944320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12944320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides a "gem yardoc" command which generates YARD documentations for
   specified gems
 email:
@@ -60,28 +82,28 @@ files:
 - lib/rubygems_plugin.rb
 - rubygems-yardoc.gemspec
 homepage: https://github.com/KitaitiMakoto/rubygems-yardoc
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: gem yardoc command-line tool
 test_files: []
 has_rdoc: