sdoc_all 0.2.0.11 → 0.2.1.0

data/README.rdoc

@@ -32,6 +32,9 @@ time to skip updates (for now ruby and plugins are updated)
 days, hours, minutes, seconds accepted
   min_update_interval: 1 hour
 
+title of resulting page
+  title: "full reference"
+
 list of things you want to document
 carefully watch indent - 4 spaces for options
   sdoc:
@@ -45,6 +48,11 @@ if you don't want updates use this
       version: 1.8.6
       update: false
 
+also as ruby has no index page, you can create folder with index.html in it (also there can be stylesheets, images or whatever you want but they should be linked relatively; I choose http://www.zenspider.com/Languages/Ruby/QuickRef.html :) ) and put path to it in config like
+  - ruby:
+      version: 1.8.6
+      index: ruby_quick_ref
+
 === rails
 choose rails version
   - rails: 2.3.2

data/VERSION.yml

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

data/lib/sdoc_all/ruby.rb

@@ -9,6 +9,7 @@ class SdocAll
       @config = {
         :update => config.delete(:update) != false,
         :version => config.delete(:version),
+        :index => config.delete(:index),
       }
 
       version = @config[:version]
@@ -17,6 +18,13 @@ class SdocAll
       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
 
@@ -39,11 +47,13 @@ class SdocAll
       end
       self.class.used_sources << path
 
-      Base.add_task(
+      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

data/lib/sdoc_all/task.rb

@@ -2,13 +2,14 @@ require 'digest'
 
 class SdocAll
   class Task
-    attr_reader :src_path, :doc_path, :paths, :main, :title
+    attr_reader :src_path, :doc_path, :paths, :main, :title, :index
     def initialize(options = {})
       @src_path = Pathname.new(options[:src_path]).expand_path
       @doc_path = options[:doc_path]
       @paths = options[:paths]
       @main = options[:main]
       @title = options[:title]
+      @index = options[:index]
     end
 
     def run(options = {})
@@ -25,6 +26,14 @@ class SdocAll
             cmd << '-m' << main if main
             Base.system(*cmd + paths)
           end
+          if index
+            custom_index_dir_name = 'custom_index'
+            custom_index_path = Base.docs_path + doc_path + custom_index_dir_name
+            Base.remove_if_present(custom_index_path)
+            FileUtils.cp_r(index, custom_index_path)
+            index_html = Base.docs_path + doc_path + 'index.html'
+            index_html.write index_html.read.sub(/(<frame src=")[^"]+(" name="docwin" \/>)/, "\\1#{custom_index_dir_name}/index.html\\2")
+          end
         else
           Base.system(*cmd + [src_path])
         end
@@ -38,7 +47,9 @@ class SdocAll
     end
 
     def hash
-      Digest::SHA1.hexdigest([src_path.to_s, doc_path.to_s, paths, main, title, last_build_time].inspect)
+      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

data/lib/sdoc_all.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/ruby
 
+require 'pathname'
 require 'fileutils'
 require 'find'
 require 'digest'
@@ -18,6 +19,14 @@ class Array
   end
 end
 
+class Pathname
+  def write(s)
+    open('w') do |f|
+      f.write(s)
+    end
+  end
+end
+
 class SdocAll
   module ClassMethods
     def update?
@@ -25,7 +34,7 @@ class SdocAll
     end
 
     def title
-      @title
+      @title.present? ? @title : 'ruby related reference'
     end
 
     def last_build_sdoc_version_path
@@ -67,7 +76,7 @@ class SdocAll
           task.run(options)
         end
 
-        hash = Digest::SHA1.hexdigest(tasks.map(&:hash).inspect + title)
+        hash = Digest::SHA1.hexdigest(tasks.map(&:hash).inspect + title.to_s)
         created_hash = config_hash_path.read rescue nil
 
         if hash != created_hash
@@ -134,7 +143,7 @@ class SdocAll
       created = last_build_sdoc_version_path.mtime rescue nil
       @update = created.nil? || created < min_update_interval.ago
 
-      @title = config[:title].present? ? config[:title] : 'ruby related reference'
+      @title = config[:title]
 
       if config[:sdoc] && config[:sdoc].is_a?(Array) && config[:sdoc].length > 0
         errors = []

data/sdoc_all.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sdoc_all}
-  s.version = "0.2.0.11"
+  s.version = "0.2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["toy"]

data/spec/sdoc_all_spec.rb

@@ -33,7 +33,7 @@ describe SdocAll do
 
       SdocAll.should_receive(:read_config)
       SdocAll::Base.should_receive(:tasks).and_return(@tasks)
-      SdocAll::Base.should_receive(:system).with('sdoc-merge', '-o', Pathname.new('/public'), '-t', 'all', '-n', '<a>,<b>,<c>', '-u', '/docs/a /docs/b /docs/c', 'a', 'b', 'c')
+      SdocAll::Base.should_receive(:system).with('sdoc-merge', '-o', Pathname.new('/public'), '-t', 'ruby related reference', '-n', '<a>,<b>,<c>', '-u', 'docs/a docs/b docs/c', 'a', 'b', 'c')
       SdocAll.run
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sdoc_all
 version: !ruby/object:Gem::Version 
-  version: 0.2.0.11
+  version: 0.2.1.0
 platform: ruby
 authors: 
 - toy