doc 0.4.1 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3c67d282df1baec1c1b258b082bccca10b69c55
+  data.tar.gz: 57dec17e5ece6a3541f6db38df7ee41580c767e0
+SHA512:
+  metadata.gz: 41e583d7077a19db63db7cb072e952722e13285d9b69df6f7034d30454c37f06e5d2f21727feeb000ff26df577527ff916fb8a8029c77ecb287a7440bb2f0ae3
+  data.tar.gz: f1db12160b470bdfaf09d29a9a23c554c513d0fb57881749104a74fa8a127fa997466ccbc8c128330b266217910921991d73991d9e0478377d2483eade4c0f3f

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 Ivan Kuchin
+Copyright (c) 2010-2017 Ivan Kuchin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -83,4 +83,4 @@ Use `:title` to specify title, it must be a proc receiving path and returning ti
 
 ## Copyright
 
-Copyright (c) 2010-2012 Ivan Kuchin. See LICENSE.txt for details.
+Copyright (c) 2010-2017 Ivan Kuchin. See LICENSE.txt for details.

data/doc.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'doc'
-  s.version     = '0.4.1'
+  s.version     = '0.5.0'
   s.summary     = %q{Get all ruby documentation in one place}
   s.description = %Q{Generate `Rakefile` with `docr` and get searchable documentation for ruby, rails, gems, plugins and all other ruby code in one place}
   s.homepage    = "http://github.com/toy/#{s.name}"
@@ -16,9 +16,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = %w[lib]
 
-  s.add_runtime_dependency 'sdoc', '~> 0.2.0'
-  s.add_runtime_dependency 'fspath'
-  s.add_runtime_dependency 'progress', '~> 2.4'
+  s.add_runtime_dependency 'sdoc', '~> 0.2'
+  s.add_runtime_dependency 'fspath', '~> 3.0'
+  s.add_runtime_dependency 'progress', '~> 3.0'
   s.add_runtime_dependency 'net-ftp-list'
   s.add_runtime_dependency 'rake'
 end

data/lib/doc/base_task.rb

@@ -1,6 +1,7 @@
 require 'digest/sha2'
 require 'shellwords'
 require 'sdoc'
+require 'yaml'
 
 module Doc
   class BaseTask
@@ -25,11 +26,12 @@ module Doc
           doc_dir / '.#{name}_state'
         end
         def #{name}_state_changed?
-          !#{name}_state_path.exist? || Marshal.load(#{name}_state_path.read) != #{name}_state
-        rescue true
+          !#{name}_state_path.exist? || YAML.load(#{name}_state_path.read) != #{name}_state
+        rescue
+          true
         end
         def write_#{name}_state
-          #{name}_state_path.write(Marshal.dump(#{name}_state))
+          #{name}_state_path.write(YAML.dump(#{name}_state))
         end
       RUBY
     end
@@ -59,9 +61,10 @@ module Doc
     def run(force = false)
       if force || run?
         if doc_dir.exist?
-          in_progress_message %W[rm -r #{doc_dir}].shelljoin
+          $stderr.puts %W[rm -r #{doc_dir}].shelljoin
           doc_dir.rmtree
         end
+        Progress.note = title
         build
         write_config_state
         @state = control_files_exist? ? :succeeded : :failed
@@ -85,13 +88,5 @@ module Doc
     def loaded_gem_version(gem)
       Gem.loaded_specs[gem].version
     end
-
-    def in_progress_message(message)
-      if Progress.running?
-        Progress.note = message
-      else
-        $stderr.puts message
-      end
-    end
   end
 end

data/lib/doc/config_error.rb

@@ -1,11 +1,7 @@
 module Doc
   class ConfigError < Exception
     def initialize(object, message)
-      super("#{object.class.name}: #{message}").tap do |e|
-        if Exception === message
-          e.set_backtrace(message.backtrace)
-        end
-      end
+      super("#{object.class.name}: #{message}")
     end
   end
 end

data/lib/doc/configurator/gems.rb

@@ -31,6 +31,7 @@ module Doc
       def tasks
         @specs.map do |spec|
           main = spec.rdoc_options.each_cons(2).select{ |key, value| %w[--main -m].include?(key) }.map(&:last).first
+          next if spec.respond_to?(:default_gem?) && spec.default_gem?
           Dir.chdir(spec.full_gem_path) do
             file_list = FileList.new
             file_list.include *spec.extra_rdoc_files
@@ -44,7 +45,7 @@ module Doc
               :main => main,
             })
           end
-        end
+        end.compact
       end
 
     private

data/lib/doc/configurator/rails.rb

@@ -32,15 +32,12 @@ module Doc
 
     private
 
-      def version_less_than_3?(version)
-        version.segments.first < 3
-      end
-
       def paths_to_document_for_version(version)
-        code = if version_less_than_3?(version)
+        code = case version.segments.first
+        when 2
           <<-RUBY
-            require 'rdoc/task'
             gem 'rails', ARGV.first
+            require 'rdoc/task'
 
             Rake::FileList.class_eval do
               alias_method :original_include, :include
@@ -75,10 +72,10 @@ module Doc
 
             load 'tasks/documentation.rake'
           RUBY
-        else
+        when 3
           <<-RUBY
-            require 'rdoc/task'
             gem 'rails', ARGV.first
+            require 'rdoc/task'
 
             class RDocTaskWithoutDescriptions < Rake::RDocTask
               def initialize(name = :rdoc)
@@ -89,6 +86,26 @@ module Doc
 
             load 'rails/tasks/documentation.rake'
           RUBY
+        else
+          <<-RUBY
+            gem 'rails', ARGV.first
+            require 'rdoc/task'
+            require 'rails/api/task'
+
+            module Rails
+              module API
+                class InstalledTask < StableTask
+                  def component_root_dir(component)
+                    Gem::Specification.find_by_name(component).gem_dir
+                  end
+                end
+              end
+            end
+
+            task = Rails::API::InstalledTask.new('rdoc')
+            task.configure_rdoc_files
+            puts task.rdoc_files
+          RUBY
         end
         args = %W[ruby -r rubygems -e #{code} -- #{version}]
         IO.popen(args.shelljoin, &:readlines).map(&:strip)

data/lib/doc/configurator/ruby.rb

@@ -37,8 +37,6 @@ module Doc
             raise 'index should be a path to directory with index.html inside'
           end
         end
-      rescue => e
-        raise ConfigError.new(self, e)
       end
 
       def avaliable_formats

data/lib/doc/configurator/ruby/path_info.rb

@@ -9,7 +9,7 @@ module Doc
 
         def self.for_path(path)
           name = path.basename.to_s
-          if name =~ /^ruby-(\d+\.\d+\.\d+-p\d+)(?i:\.(tar\.(?:gz|bz2)|tgz|tbz|zip))?$/
+          if name =~ /^ruby-(\d+\.\d+\.\d+(?:-p\d+)?)(?i:\.(tar\.(?:gz|bz2)|tgz|tbz|zip))?$/
             extension = $2 ? $2.downcase : :dir
             type = ({'tar.bz2' => 'tbz', 'tar.gz' => 'tgz'}[extension] || extension).to_sym
             new(path, name, type, $1, $1.scan(/\d+/).map(&:to_i))

data/lib/doc/configurator/ruby/source.rb

@@ -13,6 +13,7 @@ module Doc
           version = VersionSpecifier.new(`#{binary} -e 'print "\#{RUBY_VERSION}-p\#{RUBY_PATCHLEVEL}"'`)
           if $?.success?
             if version.valid?
+              version = version.drop unless version < VersionSpecifier.new(2.1)
               by_version(version, update)
             else
               raise "invalid version from `#{binary}`: #{version.to_s.inspect}"
@@ -44,7 +45,7 @@ module Doc
             if path.basename.to_s =~ /^(.*)(?i:\.(tar\.(?:gz|bz2)|tgz|tbz|zip))$/
               dir, extension = sources_dir / $1, $2.downcase
               unless dir.exist?
-                Dir.mktmpdir 'ruby' do |d|
+                FSPath.temp_dir 'ruby', sources_dir do |d|
                   begin
                     case extension
                     when 'tbz', 'tar.bz2'
@@ -55,7 +56,7 @@ module Doc
                       Command.run('unzip', '-q', path, '-d', d)
                     end
 
-                    children = FSPath(d).children
+                    children = d.children
                     if children.length == 1
                       children.first.rename(dir)
                     else
@@ -104,8 +105,7 @@ module Doc
         end
 
         def tempfile_for(dst)
-          Tempfile.open 'ruby' do |f|
-            path = FSPath(f.path)
+          FSPath.temp_file_path 'ruby', sources_dir do |path|
             yield path
             path.rename(dst)
           end
@@ -122,8 +122,8 @@ module Doc
         def tmpdir_for_latest_version_from_tag_list(command, regexp, version)
           if tag_version = latest_version_from_tag_list(command, regexp, version)
             unless path_for_version(tag_version)
-              Dir.mktmpdir 'ruby' do |d|
-                tmp_dir = FSPath(d) / tag_version.dir_name
+              FSPath.temp_dir 'ruby', sources_dir do |d|
+                tmp_dir = d / tag_version.dir_name
                 if yield(tmp_dir, tag_version)
                   tmp_dir.rename(sources_dir / tag_version.dir_name)
                 end
@@ -149,11 +149,11 @@ module Doc
         FTP_HOST = 'ftp.ruby-lang.org'
         SVN_TAGS_URL = 'http://svn.ruby-lang.org/repos/ruby/tags/'
         SVN_TAG_LIST_COMMAND = "svn list --non-interactive #{SVN_TAGS_URL}"
-        SVN_TAG_REGEXP = /^(v\d+(?:_\d+){3})\/$/
+        SVN_TAG_REGEXP = /^(v\d+(?:_\d+){2,3})\/$/
         GIT_BARE_URL = 'github.com/ruby/ruby'
         GIT_URL = "git://#{GIT_BARE_URL}.git"
         GIT_TAG_LIST_COMMAND = "git ls-remote -t #{GIT_URL}"
-        GIT_TAG_REGEXP = /^.*\t(refs\/tags\/v\d+(?:_\d+){3})$/
+        GIT_TAG_REGEXP = /^.*\t(refs\/tags\/v\d+(?:_\d+){2,3})$/
 
         def download_version_via_ftp(version)
           Net::FTP.open(FTP_HOST) do |ftp|

data/lib/doc/configurator/ruby/version_specifier.rb

@@ -9,6 +9,10 @@ module Doc
           @parts = str.scan(/\d+/).map(&:to_i)
         end
 
+        def drop
+          self.class.new(parts.drop(1).join('.'))
+        end
+
         def valid?
           str =~ /^\d+\.\d+(?:\.\d+(?:-p\d+)?)?$/
         end
@@ -18,7 +22,8 @@ module Doc
         end
 
         def dir_name
-          'ruby-%d.%d.%d-p%d' % parts
+          fmt = 'ruby' + %w[-%d .%d .%d -p%d].take(parts.length).join('')
+          fmt % parts
         end
 
         include Comparable

data/lib/doc/merger.rb

@@ -30,7 +30,7 @@ module Doc
     end
 
     def build
-      in_progress_message "Merging #{title}"
+      $stderr.puts "Merging #{title}"
 
       succeded_tasks = tasks.reject(&:failed?)
       task_titles = succeded_tasks.map{ |task| task.title.gsub(',', '_') }

metadata

@@ -1,105 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: doc
-version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: 
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
+version: !ruby/object:Gem::Version
+  version: 0.5.0
 platform: ruby
-authors: 
+authors:
 - Ivan Kuchin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-12-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2017-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sdoc
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 0
-        - 2
-        - 0
-        version: 0.2.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: fspath
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: fspath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: progress
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 4
-        version: "2.4"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: progress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: net-ftp-list
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: net-ftp-list
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  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 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id005
-description: Generate `Rakefile` with `docr` and get searchable documentation for ruby, rails, gems, plugins and all other ruby code in one place
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate `Rakefile` with `docr` and get searchable documentation for
+  ruby, rails, gems, plugins and all other ruby code in one place
 email: 
-executables: 
+executables:
 - docr
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - LICENSE.txt
 - README.markdown
 - TODO
@@ -128,38 +117,27 @@ files:
 - lib/doc/tasks.rb
 - vendor/stdlib-config.yaml
 homepage: http://github.com/toy/doc
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: doc
-rubygems_version: 1.8.24
+rubygems_version: 2.6.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Get all ruby documentation in one place
 test_files: []
-
-has_rdoc: