doc 0.0.0.0 → 0.0.1

data/lib/doc/merger.rb

@@ -0,0 +1,40 @@
+module Doc
+  class Merger < BaseTask
+    attr_reader :tasks
+    def initialize(documentor, options)
+      super
+      @tasks = options[:tasks].uniq
+
+      @config = {
+        :title => title,
+        :dir_name => dir_name,
+        :tasks => tasks.map(&:config),
+      }
+    end
+
+    state_methods :failed, <<-RUBY
+      tasks.map(&:failed?)
+    RUBY
+
+    def run
+      tasks.with_progress('build').each(&:run)
+      super(failed_state_changed?)
+      write_failed_state if succeeded?
+    end
+
+    def build
+      succeded_tasks = tasks.reject(&:failed?)
+      task_titles = succeded_tasks.map{ |task| task.title.gsub(',', '_') }.join(',')
+      task_urls = succeded_tasks.map{ |task| task.doc_dir.relative_path_from(doc_dir).to_s.strip }.join(' ')
+
+      cmd = Command.new('sdoc-merge')
+      cmd.add "--op=#{doc_dir}"
+      cmd.add "--title=#{title}"
+      cmd.add "--names=#{task_titles}"
+      cmd.add "--urls=#{task_urls}"
+      cmd.add *succeded_tasks.map(&:doc_dir)
+
+      cmd.run
+    end
+  end
+end

data/lib/doc/root_config.rb

@@ -0,0 +1,29 @@
+module Doc
+  class RootConfig < ConfigObject
+    attr_reader :documentor
+    def initialize(documentor, *arguments, &block)
+      @documentor = documentor
+      super :title, *arguments, &block
+
+      if clean_after
+        if !clean_after.is_a?(Numeric)
+          raise "clean_after must be a number, got #{clean_after.inspect}"
+        elsif clean_after < 0
+          raise "clean_after must zero or greater, got #{clean_after.inspect}"
+        end
+      end
+    end
+
+    def configurators
+      @configurators ||= []
+    end
+
+    def self.configurator(name, klass)
+      class_eval <<-RUBY, __FILE__, __LINE__
+        def #{name}(*arguments, &block)
+          configurators << #{klass}.new(documentor, *arguments, &block)
+        end
+      RUBY
+    end
+  end
+end

data/lib/doc/root_merger.rb

@@ -0,0 +1,14 @@
+module Doc
+  class RootMerger < Merger
+    def doc_dir
+      documentor.public_dir
+    end
+
+    def run
+      super
+      if succeeded?
+        (doc_dir / documentor.docs_dir.basename).make_symlink(documentor.docs_dir.relative_path_from(doc_dir))
+      end
+    end
+  end
+end

data/lib/doc/tasks.rb

@@ -0,0 +1,52 @@
+require 'doc'
+
+module Doc
+  class Tasks
+    include Rake::DSL
+
+    attr_reader :documentor
+    def initialize(*arguments, &block)
+      @documentor = Documentor.new(*arguments, &block)
+      define
+    end
+
+    def humanize_time(seconds)
+      case seconds
+      when 0...60
+        '%.1fs' % seconds
+      when 60...3600
+        '%.1fm' % (seconds / 60)
+      else
+        '%.1fh' % (seconds / 3600)
+      end
+    end
+
+    def count_time
+      start = Time.now
+      yield
+      puts "It took #{humanize_time(Time.now - start)}"
+    end
+
+  private
+
+    def define
+      task :default => :build
+
+      task :config do
+        count_time{ documentor.config }
+      end
+
+      desc 'build documentation'
+      task :build do
+        count_time{ documentor.build }
+      end
+
+      namespace :build do
+        desc 'force update and build documentation'
+        task :update do
+          count_time{ documentor.build(true) }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: doc
 version: !ruby/object:Gem::Version 
-  hash: 79
-  prerelease: false
+  hash: 29
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 0
-  - 0
-  version: 0.0.0.0
+  - 1
+  version: 0.0.1
 platform: ruby
 authors: 
 - Ivan Kuchin
@@ -16,13 +15,70 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-16 00:00:00 +03:00
-default_executable: 
+date: 2011-10-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: sdoc
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 2
+        - 20
+        version: 0.2.20
+  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"
+  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: 3
+        segments: 
+        - 0
+        version: "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: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -34,11 +90,11 @@ dependencies:
         - 1
         version: 1.5.1
   type: :development
-  version_requirements: *id001
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rake-gem-ghost
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -48,11 +104,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id002
-description: Command line tool to get searchable documentation for ruby, rails, gems, plugins and other ruby related code in one place
+  version_requirements: *id006
+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: 
@@ -64,9 +120,29 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- bin/docr
 - doc.gemspec
 - lib/doc.rb
-has_rdoc: true
+- lib/doc/base_task.rb
+- lib/doc/builder.rb
+- lib/doc/command.rb
+- lib/doc/config_error.rb
+- lib/doc/config_object.rb
+- lib/doc/configurator.rb
+- lib/doc/configurator/gems.rb
+- lib/doc/configurator/paths.rb
+- lib/doc/configurator/rails.rb
+- lib/doc/configurator/ruby.rb
+- lib/doc/configurator/ruby/path_info.rb
+- lib/doc/configurator/ruby/source.rb
+- lib/doc/configurator/ruby/stdlib.rb
+- lib/doc/configurator/ruby/version_specifier.rb
+- lib/doc/core_ext.rb
+- lib/doc/documentor.rb
+- lib/doc/merger.rb
+- lib/doc/root_config.rb
+- lib/doc/root_merger.rb
+- lib/doc/tasks.rb
 homepage: http://github.com/toy/doc
 licenses: 
 - MIT
@@ -96,9 +172,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Documentation for everything
+summary: Get all ruby documentation in one place
 test_files: []