sdoc_all 0.2.1.0 → 1.0.0

data/Manifest

@@ -1,14 +1,15 @@
 bin/sdoc-all
 lib/sdoc_all/base.rb
 lib/sdoc_all/config_error.rb
-lib/sdoc_all/gems.rb
+lib/sdoc_all/file_list.rb
 lib/sdoc_all/generator/sdoc_all/sdoc_all_generator.rb
 lib/sdoc_all/generator/sdoc_all/templates/config.yml
 lib/sdoc_all/generator/sdoc_all/templates/Rakefile
-lib/sdoc_all/paths.rb
-lib/sdoc_all/plugins.rb
-lib/sdoc_all/rails.rb
-lib/sdoc_all/ruby.rb
+lib/sdoc_all/parts/gems.rb
+lib/sdoc_all/parts/paths.rb
+lib/sdoc_all/parts/plugins.rb
+lib/sdoc_all/parts/rails.rb
+lib/sdoc_all/parts/ruby.rb
 lib/sdoc_all/task.rb
 lib/sdoc_all.rb
 lib/tasks/sdoc_all_rake.rb
@@ -16,6 +17,7 @@ LICENSE
 Manifest
 Rakefile
 README.rdoc
+spec/sdoc_all/file_list_spec.rb
 spec/sdoc_all/gems_spec.rb
 spec/sdoc_all/paths_spec.rb
 spec/sdoc_all/plugins_spec.rb

data/README.rdoc

@@ -53,6 +53,11 @@ also as ruby has no index page, you can create folder with index.html in it (als
       version: 1.8.6
       index: ruby_quick_ref
 
+to build stdlib documentation for every group not fully present in ruby documentation (based on http://stdlib-doc.rubyforge.org)
+  - ruby:
+      version: 1.8.6
+      stdlib: true
+
 === rails
 choose rails version
   - rails: 2.3.2

data/VERSION.yml

@@ -1 +1 @@
-[0, 2, 1, 0]
+[1, 0, 0]

data/lib/sdoc_all/base.rb

@@ -107,13 +107,13 @@ class SdocAll
       end
 
       def add_task(options = {})
-        options[:paths] ||= []
-        [/^readme$/i, /^readme\.(?:txt|rdoc|markdown)$/i, /^readme\./i].each do |readme_r|
-          options[:main] ||= options[:paths].grep(readme_r).first
-        end
         @@tasks << Task.new(options)
       end
 
+      def add_merge_task(options = {})
+        @@tasks << MergeTask.new(options)
+      end
+
       def system(*args)
         escaped_args = args.map(&:to_s).map{ |arg| arg[/[^a-z0-9\/\-.]/i] ? arg.inspect : arg }
         command = escaped_args.join(' ')

data/lib/sdoc_all/file_list.rb

@@ -0,0 +1,11 @@
+class SdocAll
+  class FileList < Rake::FileList
+    def resolve
+      if @pending
+        super
+        @items.replace(@items.uniq.reject{ |path| !File.exist?(path) })
+      end
+      self
+    end
+  end
+end

data/lib/sdoc_all/generator/sdoc_all/templates/config.yml

@@ -1,7 +1,10 @@
 ---
 min_update_interval: 1 hour
+title: "ruby, rails, gems"
 sdoc: # watch indent in this section - it must be 4 spaces
-- ruby: 1.8.7
+- ruby:
+    version: 1.8.7
+    stdlib: true
 - rails
 - gems:
     exclude:
@@ -12,5 +15,5 @@ sdoc: # watch indent in this section - it must be 4 spaces
     - activerecord
     - activeresource
     - activesupport
-- plugins: ~/.plugins
+# - plugins: ~/.plugins
 # - path: ~/some/path

data/lib/sdoc_all/parts/gems.rb

@@ -0,0 +1,83 @@
+class SdocAll
+  class Gems < Base
+    def initialize(raw_config)
+      raw_config ||= {}
+      raw_config = {:only => raw_config} unless raw_config.is_a?(Hash)
+
+      @config = {
+        :versions => raw_config.delete(:versions).to_s.downcase,
+        :only => config_only_option(raw_config),
+        :exclude => config_exclude_option(raw_config),
+      }
+
+      errors = []
+      gem_names = unfiltered_specs.map{ |spec| spec.name.downcase }
+      [:only, :exclude].each do |option|
+        if config[option]
+          config[option].each do |gem_name|
+            errors << "#{option} #{gem_name} does not match any gem" unless gem_names.include?(gem_name)
+          end
+        end
+      end
+      unless errors.empty?
+        raise ConfigError.new(errors.join("\n"))
+      end
+
+      if filtered_specs.empty?
+        options = config.map do |option, values|
+          "#{option} => #{Array(values).join(',')}" if values.present?
+        end.compact.join(', ')
+        raise ConfigError.new("no gems matches #{options}")
+      end
+
+      raise_unknown_options_if_not_blank!(raw_config)
+    end
+
+    def add_tasks(options = {})
+      specs = filtered_specs.sort_by{ |spec| [spec.name.downcase, spec.sort_obj] }
+      specs.each do |spec|
+        main = nil
+        spec.rdoc_options.each_cons(2) do |options|
+          main = options[1] if %w(--main -m).include?(options[0])
+        end
+        Base.add_task(
+          :src_path => spec.full_gem_path,
+          :doc_path => "gems.#{spec.full_name}",
+          :paths => spec.require_paths + spec.extra_rdoc_files,
+          :main => main,
+          :title => "gems: #{spec.full_name}"
+        )
+      end
+    end
+
+  private
+
+    def unfiltered_specs
+      config[:versions] == 'all' ? self.class.all_specs : self.class.latest_specs
+    end
+
+    def filtered_specs
+      specs = unfiltered_specs
+
+      specs.delete_if{ |spec| !config[:only].include?(spec.name.downcase) } if config[:only]
+      specs.delete_if{ |spec| config[:exclude].include?(spec.name.downcase) }
+
+      specs
+    end
+
+    module ClassMethods
+      def latest_specs
+        Gem.source_index.latest_specs
+      end
+
+      def all_specs
+        specs = []
+        Gem.source_index.each do |_, spec|
+          specs << spec
+        end
+        specs
+      end
+    end
+    extend ClassMethods
+  end
+end

data/lib/sdoc_all/{paths.rb → parts/paths.rb}

@@ -1,40 +1,54 @@
 class SdocAll
   class Paths < Base
-    def initialize(config)
-      config = [config] unless config.is_a?(Array)
+    def initialize(raw_config)
+      raw_config = [raw_config] unless raw_config.is_a?(Array)
 
-      config.each do |entry|
-        case entry
-        when Hash
-          entry.symbolize_keys!
-
-          unless entry[:root].present?
-            raise ConfigError.new("specify what to document")
+      errors = []
+      raw_config.each do |raw_entry|
+        begin
+          raw_entries = case raw_entry
+          when Hash
+            [raw_entry]
+          when String
+            Dir[File.expand_path(raw_entry)].map{ |path| {:root => path} }
+          else
+            raise_unknown_options_if_not_blank!(raw_entry)
           end
 
-          root = Pathname.new(entry.delete(:root)).expand_path
+          raw_entries.each do |entry|
+            begin
+              entry.symbolize_keys!
 
-          unless root.exist?
-            raise ConfigError.new("path #{root} does not exist")
-          end
+              unless entry[:root].present?
+                raise ConfigError.new("specify what to document")
+              end
 
-          paths = entry.delete(:paths)
-          paths = [paths] if paths && !paths.is_a?(Array)
-
-          entries << {
-            :root => root,
-            :main => entry.delete(:main),
-            :paths => paths,
-          }
-          raise_unknown_options_if_not_blank!(entry)
-        when String
-          Dir[File.expand_path(entry)].each do |path|
-            config << {:root => path}
+              root = Pathname.new(entry.delete(:root)).expand_path
+
+              unless root.exist?
+                raise ConfigError.new("path #{root} does not exist")
+              end
+
+              paths = entry.delete(:paths)
+              paths = [paths] if paths && !paths.is_a?(Array)
+
+              entries << {
+                :root => root,
+                :main => entry.delete(:main),
+                :paths => paths,
+              }
+              raise_unknown_options_if_not_blank!(entry)
+            rescue ConfigError => e
+              errors << e
+            end
           end
-        else
-          raise_unknown_options_if_not_blank!(entry)
+        rescue ConfigError => e
+          errors << e
         end
       end
+      unless errors.empty?
+        raise ConfigError.new(errors.join("\n"))
+      end
     end
 
     def add_tasks(options = {})

data/lib/sdoc_all/{plugins.rb → parts/plugins.rb}

@@ -1,27 +1,27 @@
 class SdocAll
   class Plugins < Base
-    def initialize(config)
-      config ||= {}
-      config = {:path => config} unless config.is_a?(Hash)
+    def initialize(raw_config)
+      raw_config ||= {}
+      raw_config = {:path => raw_config} unless raw_config.is_a?(Hash)
 
-      config[:path] ||= sources_path
+      raw_config[:path] ||= sources_path
 
       @config = {
-        :update => config.delete(:update) != false,
-        :path => Pathname.new(config.delete(:path)).expand_path,
-        :only => config_only_option(config),
-        :exclude => config_exclude_option(config),
+        :update => raw_config.delete(:update) != false,
+        :path => Pathname.new(raw_config.delete(:path)).expand_path,
+        :only => config_only_option(raw_config),
+        :exclude => config_exclude_option(raw_config),
       }
 
-      unless @config[:path].directory?
-        raise ConfigError.new("path #{@config[:path]} is not a directory")
+      unless config[:path].directory?
+        raise ConfigError.new("path #{config[:path]} is not a directory")
       end
 
-      raise_unknown_options_if_not_blank!(config)
+      raise_unknown_options_if_not_blank!(raw_config)
     end
 
     def add_tasks(options = {})
-      plugins = @config[:path].children.map do |path|
+      plugins = config[:path].children.map do |path|
         path if path.directory?
       end.compact
 

data/lib/sdoc_all/{rails.rb → parts/rails.rb}

@@ -1,12 +1,12 @@
 class SdocAll
   class Rails < Base
-    def initialize(config)
-      config ||= {}
-      config = {:version => config} unless config.is_a?(Hash)
+    def initialize(raw_config)
+      raw_config ||= {}
+      raw_config = {:version => raw_config} unless raw_config.is_a?(Hash)
 
-      if config[:version]
-        unless self.class.versions.include?(config[:version])
-          raise ConfigError.new("you don't have rails #{config[:version]} installed")
+      if raw_config[:version]
+        unless self.class.versions.include?(raw_config[:version])
+          raise ConfigError.new("you don't have rails #{raw_config[:version]} installed")
         end
       else
         if self.class.versions.empty?
@@ -15,14 +15,14 @@ class SdocAll
       end
 
       @config = {
-        :version => config.delete(:version) || self.class.versions.last,
+        :version => raw_config.delete(:version) || self.class.versions.last,
       }
 
-      raise_unknown_options_if_not_blank!(config)
+      raise_unknown_options_if_not_blank!(raw_config)
     end
 
     def add_tasks(options = {})
-      version = @config[:version]
+      version = config[:version]
       path = sources_path + version
 
       unless path.directory?

data/lib/sdoc_all/parts/ruby.rb

@@ -0,0 +1,203 @@
+require 'net/ftp'
+require 'net/http'
+
+class SdocAll
+  class Ruby < Base
+    def initialize(raw_config)
+      raw_config ||= {}
+      raw_config = {:version => raw_config} unless raw_config.is_a?(Hash)
+
+      @config = {
+        :update => raw_config.delete(:update) != false,
+        :version => raw_config.delete(:version),
+        :index => raw_config.delete(:index),
+        :stdlib => raw_config.delete(:stdlib),
+      }
+
+      version = config[:version]
+      unless version.present?
+        raise ConfigError.new("specify version of ruby (place archive to 'sources' directory or it will be download from ftp://ftp.ruby-lang.org/)")
+      end
+      self.class.find_or_download_matching_archive(version)
+
+      if config[:index]
+        index = Pathname(config[:index])
+        unless index.directory? && (index + 'index.html').file?
+          raise ConfigError.new("index should be a directory with index.html inside and all related files should be with relative links")
+        end
+      end
+
+      if config[:stdlib]
+        download_and_get_stdlib_config
+      end
+
+      raise_unknown_options_if_not_blank!(raw_config)
+    end
+
+    def add_tasks(options = {})
+      archive = self.class.find_or_download_matching_archive(config[:version], :update => config[:update] && options[:update])
+      version = archive.full_version
+      src_path = sources_path + version
+
+      unless src_path.directory?
+        Base.remove_if_present(src_path)
+        case archive.extension
+        when 'tar.bz2'
+          Base.system('tar', '-xjf', archive.path, '-C', sources_path)
+        when 'tar.gz'
+          Base.system('tar', '-xzf', archive.path, '-C', sources_path)
+        when 'zip'
+          Base.system('unzip', '-q', archive.path, '-d', sources_path)
+        end
+        File.rename(sources_path + "ruby-#{version}", src_path)
+      end
+      self.class.used_sources << src_path
+
+      task_options = {
+        :src_path => src_path,
+        :doc_path => "ruby-#{version}",
+        :title => "ruby-#{version}"
+      }
+      task_options[:index] = config[:index] if config[:index]
+      Base.add_task(task_options)
+
+      if config[:stdlib]
+        stdlib_config = download_and_get_stdlib_config(:update => config[:update] && options[:update])
+
+        stdlib_tasks = []
+        Dir.chdir(src_path) do
+          main_files_to_document = get_files_to_document
+          stdlib_config['targets'].each do |target|
+            name = target['target']
+
+            paths = FileList.new
+            paths.include("{lib,ext}/#{name}/**/README*")
+            paths.include("{lib,ext}/#{name}.{c,rb}")
+            paths.include("{lib,ext}/#{name}/**/*.{c,rb}")
+            paths.resolve
+            paths.reject! do |path|
+              [%r{/extconf.rb\Z}, %r{/test/(?!unit)}, %r{/tests/}, %r{/sample}, %r{/demo/}].any?{ |pat| pat.match path }
+            end
+
+            if paths.present? && (paths - main_files_to_document).present?
+              stdlib_tasks << {
+                :src_path => src_path,
+                :doc_path => name.gsub(/[^a-z0-9\-_]/i, '-'),
+                :paths => paths.to_a,
+                :main => target['mainpage'],
+                :title => name
+              }
+            end
+          end
+        end
+        Base.add_merge_task(
+          :doc_path => "ruby-stdlib-#{version}",
+          :title => "ruby-stdlib-#{version}",
+          :tasks_options => stdlib_tasks.sort_by{ |task| task[:title].downcase }
+        )
+      end
+    end
+
+  private
+
+    def get_files_to_document(dir = nil)
+      files = []
+
+      dot_document_name = '.document'
+      dot_document_path = dir ? dir + dot_document_name : Pathname(dot_document_name)
+      if dot_document_path.exist?
+        dot_document_path.readlines.map(&:strip).reject(&:blank?).reject{ |line| line[/^\s*#/] }
+      else
+        ['*']
+      end.each do |glob|
+        Pathname.glob(dir ? dir + glob : glob) do |path|
+          if path.directory?
+            files.concat(get_files_to_document(path))
+          else
+            files << path.to_s
+          end
+        end
+      end
+
+      files
+    end
+
+    def download_and_get_stdlib_config(options = {})
+      stdlib_config_url = 'http://stdlib-doc.rubyforge.org/svn/trunk/data/gendoc.yaml'
+      if options[:update] || (config = get_stdlib_config).nil?
+        data = Net::HTTP.get(URI.parse(stdlib_config_url))
+        stdlib_config_path.write(data)
+        if (config = get_stdlib_config).nil?
+          raise ConfigError.new("could not get stdlib config from #{stdlib_config_url}")
+        end
+      end
+      config
+    end
+
+    def get_stdlib_config
+      YAML.load_file stdlib_config_path if stdlib_config_path.readable?
+    end
+
+    def stdlib_config_path
+      sources_path.parent + 'stdlib-gendoc.yaml'
+    end
+
+    ArchiveInfo = Struct.new(:path, :name, :full_version, :extension, :version)
+    module ClassMethods
+      def match_ruby_archive(path)
+        name = File.basename(path)
+        if match = /^ruby-((\d+\.\d+\.\d+)-p(\d+))(?:\.(tar\.(?:gz|bz2)|zip))$/.match(name)
+          ArchiveInfo.new.tap do |i|
+            i.path = path
+            i.name = name
+            i.full_version = match[1]
+            i.extension = match[4]
+            i.version = match[2].split('.').map(&:to_i) << match[3].to_i
+          end
+        end
+      end
+
+      def last_matching_ruby_archive(version, paths)
+        paths.map do |path|
+          match_ruby_archive(path)
+        end.compact.sort_by(&:version).reverse.find do |tar_info|
+          tar_info.full_version.starts_with?(version)
+        end
+      end
+
+      def find_matching_archive(version)
+        paths = sources_path.parent.children.select(&:file?)
+        last_matching_ruby_archive(version, paths)
+      end
+
+      def download_matching_archive(version)
+        Net::FTP.open('ftp.ruby-lang.org') do |ftp|
+          remote_path = '/pub/ruby'
+          ftp.debug_mode = true
+          ftp.passive = true
+          ftp.login
+          ftp.chdir(remote_path)
+          paths = ftp.list('ruby-*.tar.bz2').map{ |line| "#{remote_path}/#{line.split.last}" }
+
+          if tar = last_matching_ruby_archive(version, paths)
+            dest = sources_path.parent + tar.name
+            unless File.exist?(dest) && File.size(dest) == ftp.size(tar.path)
+              ftp.getbinaryfile(tar.path, dest)
+            end
+          end
+        end
+      end
+
+      def find_or_download_matching_archive(version, options = {})
+        if options[:update] || (archive = find_matching_archive(version)).nil?
+          download_matching_archive(version)
+          if (archive = find_matching_archive(version)).nil?
+            raise ConfigError.new("could not find version of ruby matching #{version.inspect}")
+          end
+        end
+        archive
+      end
+    end
+    extend ClassMethods
+  end
+end

data/lib/sdoc_all/task.rb

@@ -1,9 +1,40 @@
 require 'digest'
 
 class SdocAll
-  class Task
+  class BaseTask
+    def config_hash
+      Digest::SHA1.hexdigest(for_hash.inspect)
+    end
+
+    def config_hash_path
+      Base.docs_path + doc_path + 'config.hash'
+    end
+
+    def created_rid_path
+      Base.docs_path + doc_path + 'created.rid'
+    end
+
+    def last_build_time
+      Time.parse(created_rid_path.read) rescue nil
+    end
+
+    def clobber?
+      full_doc_path = Base.docs_path + doc_path
+      return true unless full_doc_path.exist?
+
+      created_hash = config_hash_path.read rescue nil
+      return true if created_hash != config_hash
+    end
+  end
+
+  class Task < BaseTask
     attr_reader :src_path, :doc_path, :paths, :main, :title, :index
     def initialize(options = {})
+      options[:paths] ||= []
+      [/^readme$/i, /^readme\.(?:txt|rdoc|markdown)$/i, /^readme\./i].each do |readme_r|
+        options[:main] ||= options[:paths].grep(readme_r).first
+      end
+
       @src_path = Pathname.new(options[:src_path]).expand_path
       @doc_path = options[:doc_path]
       @paths = options[:paths]
@@ -40,36 +71,20 @@ class SdocAll
 
         if (Base.docs_path + doc_path).directory?
           config_hash_path.open('w') do |f|
-            f.write(hash)
+            f.write(config_hash)
           end
         end
       end
     end
 
-    def hash
+    def for_hash
       for_hash = [src_path.to_s, doc_path.to_s, paths, main, title, last_build_time]
       for_hash << index if index
-      Digest::SHA1.hexdigest(for_hash.inspect)
-    end
-
-    def config_hash_path
-      Base.docs_path + doc_path + 'config.hash'
-    end
-
-    def created_rid_path
-      Base.docs_path + doc_path + 'created.rid'
-    end
-
-    def last_build_time
-      Time.parse(created_rid_path.read) rescue nil
+      for_hash
     end
 
     def clobber?
-      full_doc_path = Base.docs_path + doc_path
-      return true unless full_doc_path.exist?
-
-      created_hash = config_hash_path.read rescue nil
-      return true if created_hash != hash
+      return true if super
 
       latest = [src_path.mtime, src_path.ctime].max
       created = last_build_time
@@ -82,5 +97,64 @@ class SdocAll
       end
       created.nil? || latest >= created
     end
+
+    def occupied_doc_pathes
+      [doc_path]
+    end
+  end
+
+  class MergeTask < BaseTask
+    attr_reader :doc_path, :title, :tasks, :titles
+    def initialize(options = {})
+      @doc_path = options[:doc_path]
+      @title = options[:title]
+      @tasks = options[:tasks_options].map do |task_options|
+        Task.new(task_options.merge(
+          :doc_path => "#{parts_path}/#{task_options[:doc_path]}",
+          :title => "#{title}: #{task_options[:title]}"
+        ))
+      end
+      @titles = options[:tasks_options].map do |task_options|
+        task_options[:title]
+      end
+    end
+
+    def parts_path
+      "#{doc_path}_parts"
+    end
+
+    def run(options = {})
+      p clobber?
+      if clobber?
+        Base.remove_if_present(Base.docs_path + doc_path)
+
+        tasks.each do |task|
+          task.run(options)
+        end
+
+        Dir.chdir(Base.docs_path) do
+          cmd = %w(sdoc-merge)
+          cmd << '-o' << Base.docs_path + doc_path
+          cmd << '-t' << title
+          cmd << '-n' << titles.join(',')
+          cmd << '-u' << tasks.map{ |task| "../#{task.doc_path}" }.join(' ')
+          Base.system(*cmd + tasks.map(&:doc_path))
+        end
+      end
+    end
+
+    def for_hash
+      [doc_path.to_s, title, tasks.map(&:config_hash).join(' ')]
+    end
+
+    def clobber?
+      return true if super
+
+      tasks.any?(&:clobber?)
+    end
+
+    def occupied_doc_pathes
+      [doc_path, parts_path]
+    end
   end
 end

data/lib/sdoc_all.rb

@@ -64,7 +64,7 @@ class SdocAll
           Dir.chdir(Base.docs_path) do
             to_delete = Dir.glob('*')
             tasks.each do |task|
-              to_delete.delete(task.doc_path)
+              to_delete -= task.occupied_doc_pathes
             end
             to_delete.each do |path|
               Base.remove_if_present(path)
@@ -76,10 +76,10 @@ class SdocAll
           task.run(options)
         end
 
-        hash = Digest::SHA1.hexdigest(tasks.map(&:hash).inspect + title.to_s)
+        config_hash = Digest::SHA1.hexdigest(tasks.map(&:config_hash).inspect + title.to_s)
         created_hash = config_hash_path.read rescue nil
 
-        if hash != created_hash
+        if config_hash != created_hash
           Dir.chdir(Base.docs_path) do
             paths = []
             titles = []
@@ -106,7 +106,7 @@ class SdocAll
               if Base.public_path.directory?
                 File.symlink(Base.docs_path, Base.public_path + 'docs')
                 config_hash_path.open('w') do |f|
-                  f.write(hash)
+                  f.write(config_hash)
                 end
                 last_build_sdoc_version_path.open('w') do |f|
                   f.write(current_sdoc_version)
@@ -116,7 +116,7 @@ class SdocAll
           end
         end
       rescue ConfigError => e
-        STDERR.puts e.to_s
+        STDERR.puts "\e[1;31m#{e.to_s}\e[0m"
       end
     end
 
@@ -125,17 +125,7 @@ class SdocAll
       config = YAML.load_file('config.yml').symbolize_keys rescue {}
 
       min_update_interval = if config[:min_update_interval].to_s[/(\d+)\s*(.*)/]
-        value = $1.to_i
-        case $2
-        when /^d/
-          value.days
-        when /^h/
-          value.hours
-        when /^m/
-          value.minutes
-        else
-          value.seconds
-        end
+        $1.to_i.send({'d' => :days, 'h' => :hours, 'm' => :minutes}[$2[0, 1].downcase] || :seconds)
       else
         1.hour
       end
@@ -163,7 +153,7 @@ class SdocAll
           end
         end
         if errors.present?
-          raise ConfigError.new(errors)
+          raise ConfigError.new(errors.join("\n"))
         end
       else
         raise ConfigError.new("config did not specify what to document")
@@ -173,10 +163,11 @@ class SdocAll
   extend ClassMethods
 end
 
-require 'sdoc_all/base.rb'
-require 'sdoc_all/task.rb'
-require 'sdoc_all/config_error.rb'
+require 'sdoc_all/base'
+require 'sdoc_all/task'
+require 'sdoc_all/config_error'
+require 'sdoc_all/file_list'
 
-Dir.entries("#{__DIR__}/sdoc_all").grep(/\.rb$/).each do |file|
-  require "sdoc_all/#{file}"
+Dir.entries("#{__DIR__}/sdoc_all/parts").grep(/\.rb$/).each do |file|
+  require "sdoc_all/parts/#{file}"
 end

data/sdoc_all.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sdoc_all}
-  s.version = "0.2.1.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["toy"]
-  s.date = %q{2009-06-26}
+  s.date = %q{2009-08-15}
   s.default_executable = %q{sdoc-all}
   s.description = %q{Command line tool to get documentation for ruby, rails, gems and plugins in one place}
   s.email = %q{ivan@workisfun.ru}
   s.executables = ["sdoc-all"]
-  s.extra_rdoc_files = ["bin/sdoc-all", "lib/sdoc_all/base.rb", "lib/sdoc_all/config_error.rb", "lib/sdoc_all/gems.rb", "lib/sdoc_all/generator/sdoc_all/sdoc_all_generator.rb", "lib/sdoc_all/generator/sdoc_all/templates/config.yml", "lib/sdoc_all/generator/sdoc_all/templates/Rakefile", "lib/sdoc_all/paths.rb", "lib/sdoc_all/plugins.rb", "lib/sdoc_all/rails.rb", "lib/sdoc_all/ruby.rb", "lib/sdoc_all/task.rb", "lib/sdoc_all.rb", "lib/tasks/sdoc_all_rake.rb", "LICENSE", "README.rdoc"]
-  s.files = ["bin/sdoc-all", "lib/sdoc_all/base.rb", "lib/sdoc_all/config_error.rb", "lib/sdoc_all/gems.rb", "lib/sdoc_all/generator/sdoc_all/sdoc_all_generator.rb", "lib/sdoc_all/generator/sdoc_all/templates/config.yml", "lib/sdoc_all/generator/sdoc_all/templates/Rakefile", "lib/sdoc_all/paths.rb", "lib/sdoc_all/plugins.rb", "lib/sdoc_all/rails.rb", "lib/sdoc_all/ruby.rb", "lib/sdoc_all/task.rb", "lib/sdoc_all.rb", "lib/tasks/sdoc_all_rake.rb", "LICENSE", "Manifest", "Rakefile", "README.rdoc", "spec/sdoc_all/gems_spec.rb", "spec/sdoc_all/paths_spec.rb", "spec/sdoc_all/plugins_spec.rb", "spec/sdoc_all/rails_spec.rb", "spec/sdoc_all/ruby_spec.rb", "spec/sdoc_all_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "VERSION.yml", "sdoc_all.gemspec"]
+  s.extra_rdoc_files = ["bin/sdoc-all", "lib/sdoc_all/base.rb", "lib/sdoc_all/config_error.rb", "lib/sdoc_all/file_list.rb", "lib/sdoc_all/generator/sdoc_all/sdoc_all_generator.rb", "lib/sdoc_all/generator/sdoc_all/templates/config.yml", "lib/sdoc_all/generator/sdoc_all/templates/Rakefile", "lib/sdoc_all/parts/gems.rb", "lib/sdoc_all/parts/paths.rb", "lib/sdoc_all/parts/plugins.rb", "lib/sdoc_all/parts/rails.rb", "lib/sdoc_all/parts/ruby.rb", "lib/sdoc_all/task.rb", "lib/sdoc_all.rb", "lib/tasks/sdoc_all_rake.rb", "LICENSE", "README.rdoc"]
+  s.files = ["bin/sdoc-all", "lib/sdoc_all/base.rb", "lib/sdoc_all/config_error.rb", "lib/sdoc_all/file_list.rb", "lib/sdoc_all/generator/sdoc_all/sdoc_all_generator.rb", "lib/sdoc_all/generator/sdoc_all/templates/config.yml", "lib/sdoc_all/generator/sdoc_all/templates/Rakefile", "lib/sdoc_all/parts/gems.rb", "lib/sdoc_all/parts/paths.rb", "lib/sdoc_all/parts/plugins.rb", "lib/sdoc_all/parts/rails.rb", "lib/sdoc_all/parts/ruby.rb", "lib/sdoc_all/task.rb", "lib/sdoc_all.rb", "lib/tasks/sdoc_all_rake.rb", "LICENSE", "Manifest", "Rakefile", "README.rdoc", "spec/sdoc_all/file_list_spec.rb", "spec/sdoc_all/gems_spec.rb", "spec/sdoc_all/paths_spec.rb", "spec/sdoc_all/plugins_spec.rb", "spec/sdoc_all/rails_spec.rb", "spec/sdoc_all/ruby_spec.rb", "spec/sdoc_all_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "VERSION.yml", "sdoc_all.gemspec"]
   s.homepage = %q{http://github.com/toy/sdoc_all}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Sdoc_all", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{toytoy}
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{documentation for everything}
 
   if s.respond_to? :specification_version then

data/spec/sdoc_all/file_list_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+class SdocAll
+  describe FileList do
+    before do
+      @list = FileList.new
+    end
+
+    it "should include well" do
+      @list.include('R*')
+      @list.should == %w(Rakefile README.rdoc)
+    end
+
+    it "should exclude well" do
+      @list.include('R*')
+      @list.exclude('Rake*')
+      @list.should == %w(README.rdoc)
+    end
+
+    it "should exclude non existing files from list" do
+      @list.include('R*')
+      @list.include('non existing')
+      @list.should == %w(Rakefile README.rdoc)
+    end
+
+    it "should exclude duplicates" do
+      @list.include('R*')
+      @list.include('R*')
+      @list.should == %w(Rakefile README.rdoc)
+    end
+
+    it "should not fail if directory changes after resolve" do
+      @list.include('R*')
+      @list.resolve
+      Dir.original_chdir('lib') do
+        @list.should == %w(Rakefile README.rdoc)
+      end
+    end
+  end
+end

data/spec/sdoc_all/paths_spec.rb

@@ -14,7 +14,7 @@ class SdocAll
         Pathname.should_receive(:new).with("#{sym}").and_return(@roots[sym])
         Base.should_receive(:add_task).with(:doc_path => "paths.lala.#{sym}_exp", :src_path => @roots[sym].expand_path, :title => "paths: lala/#{sym}_exp")
       end
-      Paths.should_receive(:common_path).with([@roots[:a], @roots[:b], @roots[:c]].map(&:expand_path)).and_return('/common')
+      Paths.should_receive(:common_path).with(@roots.values_at(:a, :b, :c).map(&:expand_path)).and_return('/common')
 
       File.should_receive(:expand_path).with('*').and_return('/common/lala/*')
       Dir.should_receive(:[]).with('/common/lala/*').and_return(['a', 'b', 'c'])
@@ -28,7 +28,7 @@ class SdocAll
         Pathname.should_receive(:new).with("#{sym}").and_return(@roots[sym])
         Base.should_receive(:add_task).with(:doc_path => "paths.lala.#{sym}_exp", :src_path => @roots[sym].expand_path, :title => "paths: lala/#{sym}_exp")
       end
-      Paths.should_receive(:common_path).with([@roots[:a], @roots[:b], @roots[:d], @roots[:e]].map(&:expand_path)).and_return('/common')
+      Paths.should_receive(:common_path).with(@roots.values_at(:a, :b, :d, :e).map(&:expand_path)).and_return('/common')
 
       File.should_receive(:expand_path).with('*').and_return('/common/lala/*')
       File.should_receive(:expand_path).with('**').and_return('/common/common/lala/*')
@@ -97,5 +97,21 @@ class SdocAll
         Paths.new([{:root => '/lalala/lala/root'}, {:root => '/lalala/lolo/other'}]).add_tasks
       end
     end
+
+    it "should add task for mixed config" do
+      @roots = {}
+      [:a, :b, :c, :d, :e, :f, :g].each do |sym|
+        @roots[sym] = mock(sym, :expand_path => mock("#{sym}_exp".to_sym, :exist? => true, :relative_path_from => "lala/#{sym}_exp"))
+        Pathname.should_receive(:new).with("#{sym}").and_return(@roots[sym])
+        Base.should_receive(:add_task).with(:doc_path => "paths.lala.#{sym}_exp", :src_path => @roots[sym].expand_path, :title => "paths: lala/#{sym}_exp")
+      end
+      Paths.should_receive(:common_path).with(@roots.values_at(:a, :b, :c, :d, :e, :f, :g).map(&:expand_path)).and_return('/common')
+
+      File.should_receive(:expand_path).with('*').and_return('/common/lala/*')
+      Dir.should_receive(:[]).with('/common/lala/*').and_return(['b', 'c'])
+      File.should_receive(:expand_path).with('**').and_return('/common/lala/**')
+      Dir.should_receive(:[]).with('/common/lala/**').and_return(['e', 'f'])
+      Paths.new([{:root => 'a'}, '*', {:root => 'd'}, '**', {:root => 'g'}]).add_tasks
+    end
   end
 end

data/spec/sdoc_all_spec.rb

@@ -24,7 +24,7 @@ describe SdocAll do
       @tasks = []
       @each = @tasks.should_receive(:each_with_progress)
       %w(a b c).each do |c|
-        task = mock(c, :doc_path => "#{c}", :src_path => "/sources/#{c}", :title => "<#{c}>")
+        task = mock(c, :doc_path => "#{c}", :src_path => "/sources/#{c}", :title => "<#{c}>", :config_hash => 'abc')
         task.should_receive(:run)
         File.should_receive(:file?).with(Pathname.new("/docs/#{c}/index.html")).and_return(true)
         @each.and_yield(task)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sdoc_all
 version: !ruby/object:Gem::Version 
-  version: 0.2.1.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - toy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-26 00:00:00 +04:00
+date: 2009-08-15 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,14 +52,15 @@ extra_rdoc_files:
 - bin/sdoc-all
 - lib/sdoc_all/base.rb
 - lib/sdoc_all/config_error.rb
-- lib/sdoc_all/gems.rb
+- lib/sdoc_all/file_list.rb
 - lib/sdoc_all/generator/sdoc_all/sdoc_all_generator.rb
 - lib/sdoc_all/generator/sdoc_all/templates/config.yml
 - lib/sdoc_all/generator/sdoc_all/templates/Rakefile
-- lib/sdoc_all/paths.rb
-- lib/sdoc_all/plugins.rb
-- lib/sdoc_all/rails.rb
-- lib/sdoc_all/ruby.rb
+- lib/sdoc_all/parts/gems.rb
+- lib/sdoc_all/parts/paths.rb
+- lib/sdoc_all/parts/plugins.rb
+- lib/sdoc_all/parts/rails.rb
+- lib/sdoc_all/parts/ruby.rb
 - lib/sdoc_all/task.rb
 - lib/sdoc_all.rb
 - lib/tasks/sdoc_all_rake.rb
@@ -69,14 +70,15 @@ files:
 - bin/sdoc-all
 - lib/sdoc_all/base.rb
 - lib/sdoc_all/config_error.rb
-- lib/sdoc_all/gems.rb
+- lib/sdoc_all/file_list.rb
 - lib/sdoc_all/generator/sdoc_all/sdoc_all_generator.rb
 - lib/sdoc_all/generator/sdoc_all/templates/config.yml
 - lib/sdoc_all/generator/sdoc_all/templates/Rakefile
-- lib/sdoc_all/paths.rb
-- lib/sdoc_all/plugins.rb
-- lib/sdoc_all/rails.rb
-- lib/sdoc_all/ruby.rb
+- lib/sdoc_all/parts/gems.rb
+- lib/sdoc_all/parts/paths.rb
+- lib/sdoc_all/parts/plugins.rb
+- lib/sdoc_all/parts/rails.rb
+- lib/sdoc_all/parts/ruby.rb
 - lib/sdoc_all/task.rb
 - lib/sdoc_all.rb
 - lib/tasks/sdoc_all_rake.rb
@@ -84,6 +86,7 @@ files:
 - Manifest
 - Rakefile
 - README.rdoc
+- spec/sdoc_all/file_list_spec.rb
 - spec/sdoc_all/gems_spec.rb
 - spec/sdoc_all/paths_spec.rb
 - spec/sdoc_all/plugins_spec.rb
@@ -123,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: toytoy
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: documentation for everything

data/lib/sdoc_all/gems.rb

@@ -1,54 +0,0 @@
-class SdocAll
-  class Gems < Base
-    def initialize(config)
-      config ||= {}
-      config = {:only => config} unless config.is_a?(Hash)
-
-      @config = {
-        :versions => config.delete(:versions).to_s.downcase,
-        :only => config_only_option(config),
-        :exclude => config_exclude_option(config),
-      }
-
-      raise_unknown_options_if_not_blank!(config)
-    end
-
-    def add_tasks(options = {})
-      specs = config[:versions] == 'all' ? self.class.all_specs : self.class.latest_specs
-
-      specs.sort_by!{ |spec| [spec.name.downcase, spec.sort_obj] }
-
-      specs.delete_if{ |spec| !config[:only].include?(spec.name.downcase) } if config[:only]
-      specs.delete_if{ |spec| config[:exclude].include?(spec.name.downcase) }
-
-      specs.each do |spec|
-        main = nil
-        spec.rdoc_options.each_cons(2) do |options|
-          main = options[1] if %w(--main -m).include?(options[0])
-        end
-        Base.add_task(
-          :src_path => spec.full_gem_path,
-          :doc_path => "gems.#{spec.full_name}",
-          :paths => spec.require_paths + spec.extra_rdoc_files,
-          :main => main,
-          :title => "gems: #{spec.full_name}"
-        )
-      end
-    end
-
-    module ClassMethods
-      def latest_specs
-        Gem.source_index.latest_specs
-      end
-
-      def all_specs
-        specs = []
-        Gem.source_index.each do |_, spec|
-          specs << spec
-        end
-        specs
-      end
-    end
-    extend ClassMethods
-  end
-end

data/lib/sdoc_all/ruby.rb

@@ -1,119 +0,0 @@
-require 'net/ftp'
-
-class SdocAll
-  class Ruby < Base
-    def initialize(config)
-      config ||= {}
-      config = {:version => config} unless config.is_a?(Hash)
-
-      @config = {
-        :update => config.delete(:update) != false,
-        :version => config.delete(:version),
-        :index => config.delete(:index),
-      }
-
-      version = @config[:version]
-      unless version.present?
-        raise ConfigError.new("specify version of ruby (place archive to 'sources' directory or it will be download from ftp://ftp.ruby-lang.org/)")
-      end
-      self.class.find_or_download_matching_archive(version)
-
-      if @config[:index]
-        index = Pathname(@config[:index])
-        unless index.directory? && (index + 'index.html').file?
-          raise ConfigError.new("index should be a directory with index.html inside and all related files should be with relative links")
-        end
-      end
-
-      raise_unknown_options_if_not_blank!(config)
-    end
-
-    def add_tasks(options = {})
-      archive = self.class.find_or_download_matching_archive(config[:version], :update => config[:update] && options[:update])
-      version = archive.full_version
-      path = sources_path + version
-
-      unless path.directory?
-        Base.remove_if_present(path)
-        case archive.extension
-        when 'tar.bz2'
-          Base.system('tar', '-xjf', archive.path, '-C', sources_path)
-        when 'tar.gz'
-          Base.system('tar', '-xzf', archive.path, '-C', sources_path)
-        when 'zip'
-          Base.system('unzip', '-q', archive.path, '-d', sources_path)
-        end
-        File.rename(sources_path + "ruby-#{version}", path)
-      end
-      self.class.used_sources << path
-
-      task_options = {
-        :src_path => path,
-        :doc_path => "ruby-#{version}",
-        :title => "ruby-#{version}"
-      }
-      task_options[:index] = config[:index] if config[:index]
-      Base.add_task(task_options)
-    end
-
-  private
-
-    ArchiveInfo = Struct.new(:path, :name, :full_version, :extension, :version)
-    module ClassMethods
-      def match_ruby_archive(path)
-        name = File.basename(path)
-        if match = /^ruby-((\d+\.\d+\.\d+)-p(\d+))(?:\.(tar\.(?:gz|bz2)|zip))$/.match(name)
-          ArchiveInfo.new.tap do |i|
-            i.path = path
-            i.name = name
-            i.full_version = match[1]
-            i.extension = match[4]
-            i.version = match[2].split('.').map(&:to_i) << match[3].to_i
-          end
-        end
-      end
-
-      def last_matching_ruby_archive(version, paths)
-        paths.map do |path|
-          match_ruby_archive(path)
-        end.compact.sort_by(&:version).reverse.find do |tar_info|
-          tar_info.full_version.starts_with?(version)
-        end
-      end
-
-      def find_matching_archive(version)
-        paths = sources_path.parent.children.select(&:file?)
-        last_matching_ruby_archive(version, paths)
-      end
-
-      def download_matching_archive(version)
-        Net::FTP.open('ftp.ruby-lang.org') do |ftp|
-          remote_path = '/pub/ruby'
-          ftp.debug_mode = true
-          ftp.passive = true
-          ftp.login
-          ftp.chdir(remote_path)
-          paths = ftp.list('ruby-*.tar.bz2').map{ |line| "#{remote_path}/#{line.split.last}" }
-
-          if tar = last_matching_ruby_archive(version, paths)
-            dest = sources_path.parent + tar.name
-            unless File.exist?(dest) && File.size(dest) == ftp.size(tar.path)
-              ftp.getbinaryfile(tar.path, dest)
-            end
-          end
-        end
-      end
-
-      def find_or_download_matching_archive(version, options = {})
-        if options[:update] || (archive = find_matching_archive(version)).nil?
-          download_matching_archive(version)
-          if (archive = find_matching_archive(version)).nil?
-            raise ConfigError.new("could not find version of ruby matching #{version.inspect}")
-          end
-        end
-        archive
-      end
-    end
-    extend ClassMethods
-  end
-end