sdoc_all 0.2.0.1 → 0.2.0.6

data/Rakefile

@@ -15,7 +15,7 @@ Echoe.new('sdoc_all', version) do |p|
   p.url = "http://github.com/toy/sdoc_all"
   p.runtime_dependencies << 'activesupport'
   p.runtime_dependencies << 'rake'
-  p.runtime_dependencies << 'progress >= 0.0.8'
+  p.runtime_dependencies << 'progress >=0.0.8'
   # TODO: sdoc or voloko-sdoc
   p.project = 'toytoy'
 end

data/VERSION.yml

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

data/lib/sdoc_all/paths.rb

@@ -46,8 +46,8 @@ class SdocAll
         task_options = {
           :src_path => path,
           :doc_path => "paths.#{path.relative_path_from(common_path).to_s.gsub('/', '.')}",
+          :title => "paths: #{path.relative_path_from(common_path)}"
         }
-        task_options[:title] = task_options[:doc_path].sub('.', ': ')
         task_options[:main] = entry[:main] if entry[:main]
 
         if entry[:paths]

data/lib/sdoc_all/plugins.rb

@@ -44,6 +44,22 @@ class SdocAll
           paths.include('lib/**/*.rb')
           paths.include('README*')
           paths.include('CHANGELOG*')
+
+          begin
+            File.open('Rakefile') do |f|
+              true until f.readline['Rake::RDocTask']
+              until ['end', '}'].include?(line = f.readline.strip)
+                globs = line.scan(/'([^']*)'/).map{ |match| match[0] }
+                if line['include(']
+                  paths.include(*globs)
+                elsif line['exclude(']
+                  paths.exclude(*globs)
+                end
+              end
+            end
+          rescue
+          end
+
           paths.resolve
         end
         Base.add_task(

data/lib/sdoc_all/task.rb

@@ -1,3 +1,5 @@
+require 'digest'
+
 class SdocAll
   class Task
     attr_reader :src_path, :doc_path, :paths, :main, :title
@@ -10,19 +12,64 @@ class SdocAll
     end
 
     def run(options = {})
-      cmd = %w(sdoc)
-      cmd << '-o' << Base.docs_path + doc_path
-      cmd << '-t' << title
-      cmd << '-T' << 'direct'
-
-      if src_path.directory?
-        Dir.chdir(src_path) do
-          cmd << '-m' << main if main
-          Base.system(*cmd + paths)
+      if clobber?
+        Base.remove_if_present(Base.docs_path + doc_path)
+
+        cmd = %w(sdoc)
+        cmd << '-o' << Base.docs_path + doc_path
+        cmd << '-t' << title
+        cmd << '-T' << 'direct'
+
+        if src_path.directory?
+          Dir.chdir(src_path) do
+            cmd << '-m' << main if main
+            Base.system(*cmd + paths)
+          end
+        else
+          Base.system(*cmd + [src_path])
+        end
+
+        if (Base.docs_path + doc_path).directory?
+          config_hash_path.open('w') do |f|
+            f.write(hash)
+          end
+        end
+      end
+    end
+
+    def hash
+      Digest::SHA1.hexdigest([src_path.to_s, doc_path.to_s, paths, main, title, last_build_time].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 != hash
+
+      latest = [src_path.mtime, src_path.ctime].max
+      created = last_build_time
+      if created && latest < created
+        src_path.find do |path|
+          Find.prune if path.directory? && path.basename.to_s[0] == ?.
+          latest = [latest, src_path.mtime, src_path.ctime].max
+          break unless latest < created
         end
-      else
-        Base.system(*cmd + [src_path])
       end
+      created.nil? || latest >= created
     end
   end
 end

data/lib/sdoc_all.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require 'find'
+require 'digest'
 
 require 'rubygems'
 require 'activesupport'
@@ -35,10 +36,8 @@ class SdocAll
       Gem.searcher.find('sdoc').version.to_s
     end
 
-    def store_current_sdoc_version
-      last_build_sdoc_version_path.open('w') do |f|
-        f.write(current_sdoc_version)
-      end
+    def config_hash_path
+      Base.public_path + 'config.hash'
     end
 
     def run(options = {})
@@ -58,38 +57,16 @@ class SdocAll
               Base.remove_if_present(path)
             end
           end
-
-          tasks.each do |task|
-            doc_path = Base.docs_path + task.doc_path
-            src_path = task.src_path
-            if doc_path.exist?
-              latest = [src_path.mtime, src_path.ctime].max
-
-              created = Time.parse(File.read(doc_path + 'created.rid')) rescue nil
-              if created && latest < created
-                src_path.find do |path|
-                  Find.prune if path.directory? && path.basename.to_s[0] == ?.
-                  latest = [latest, src_path.mtime, src_path.ctime].max
-                  break unless latest < created
-                end
-              end
-              if created.nil? || latest >= created
-                Base.remove_if_present(doc_path)
-              end
-            end
-          end
         end
 
-        merge = false
         tasks.each_with_progress('docs') do |task|
-          unless (Base.docs_path + task.doc_path).directory?
-            puts
-            merge = true
-            task.run(options)
-          end
+          task.run(options)
         end
 
-        if merge || !Base.public_path.exist?
+        hash = Digest::SHA1.hexdigest(tasks.map(&:hash).inspect)
+        created_hash = config_hash_path.read rescue nil
+
+        if hash != created_hash
           Dir.chdir(Base.docs_path) do
             paths = []
             titles = []
@@ -113,11 +90,18 @@ class SdocAll
               cmd << '-u' << urls.join(' ')
               Base.system(*cmd + paths)
 
-              File.symlink(Base.docs_path, Base.public_path + 'docs')
+              if Base.public_path.directory?
+                File.symlink(Base.docs_path, Base.public_path + 'docs')
+                config_hash_path.open('w') do |f|
+                  f.write(hash)
+                end
+                last_build_sdoc_version_path.open('w') do |f|
+                  f.write(current_sdoc_version)
+                end
+              end
             end
           end
         end
-        store_current_sdoc_version
       rescue ConfigError => e
         STDERR.puts e.to_s
       end

data/lib/tasks/sdoc_all_rake.rb

@@ -7,9 +7,15 @@ task :run do
   SdocAll.run
 end
 
+desc "Clobber documentation"
+task :clobber do
+  rm_rf 'docs' rescue nil
+  rm_rf 'public' rescue nil
+end
+
 namespace :run do
   desc "Force update sources, before building/updating"
-  task :force do
+  task :update do
     SdocAll.run(:update => true)
   end
 end

data/sdoc_all.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sdoc_all}
-  s.version = "0.2.0.1"
+  s.version = "0.2.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["toy"]
-  s.date = %q{2009-04-27}
+  s.date = %q{2009-05-02}
   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}
@@ -28,15 +28,15 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_runtime_dependency(%q<rake>, [">= 0"])
-      s.add_runtime_dependency(%q<progress>, [">= 0", "= 0.0.8"])
+      s.add_runtime_dependency(%q<progress>, [">= 0.0.8"])
     else
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<progress>, [">= 0", "= 0.0.8"])
+      s.add_dependency(%q<progress>, [">= 0.0.8"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<progress>, [">= 0", "= 0.0.8"])
+    s.add_dependency(%q<progress>, [">= 0.0.8"])
   end
 end

data/spec/sdoc_all/paths_spec.rb

@@ -12,7 +12,7 @@ class SdocAll
       [:a, :b, :c].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)
+        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')
 
@@ -26,7 +26,7 @@ class SdocAll
       [:a, :b, :d, :e].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)
+        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')
 
@@ -45,12 +45,12 @@ class SdocAll
       end
 
       it "should add task" do
-        Base.should_receive(:add_task).with(:doc_path => "paths.lala/root", :src_path => @root.expand_path)
+        Base.should_receive(:add_task).with(:doc_path => "paths.lala.root", :src_path => @root.expand_path, :title => 'paths: lala/root')
         Paths.new({:root => '/lalala/lala/root'}).add_tasks
       end
 
       it "should add task with main" do
-        Base.should_receive(:add_task).with(:doc_path => "paths.lala/root", :src_path => @root.expand_path, :main => 'special_readme')
+        Base.should_receive(:add_task).with(:doc_path => "paths.lala.root", :src_path => @root.expand_path, :main => 'special_readme', :title => 'paths: lala/root')
         Paths.new({:root => '/lalala/lala/root', :main => 'special_readme'}).add_tasks
       end
 
@@ -61,7 +61,7 @@ class SdocAll
         @file_list.should_receive(:include).with('*.rb')
         @file_list.should_receive(:to_a).and_return(['a.rb', 'b.rb'])
 
-        Base.should_receive(:add_task).with(:doc_path => "paths.lala/root", :src_path => @root.expand_path, :paths => ['a.rb', 'b.rb'])
+        Base.should_receive(:add_task).with(:doc_path => "paths.lala.root", :src_path => @root.expand_path, :paths => ['a.rb', 'b.rb'], :title => 'paths: lala/root')
         Paths.new({:root => '/lalala/lala/root', :paths => '*.rb'}).add_tasks
       end
 
@@ -76,7 +76,7 @@ class SdocAll
         @file_list.should_receive(:exclude).ordered.with('*.tmp')
         @file_list.should_receive(:to_a).and_return(['a.rb', 'b.rb', 'README', 'README_en'])
 
-        Base.should_receive(:add_task).with(:doc_path => "paths.lala/root", :src_path => @root.expand_path, :paths => ['a.rb', 'b.rb', 'README', 'README_en'])
+        Base.should_receive(:add_task).with(:doc_path => "paths.lala.root", :src_path => @root.expand_path, :paths => ['a.rb', 'b.rb', 'README', 'README_en'], :title => 'paths: lala/root')
         Paths.new({:root => '/lalala/lala/root', :paths => ['*.*', '-*.cgi', '+README', '+README_*', '-*.tmp']}).add_tasks
       end
     end
@@ -91,8 +91,8 @@ class SdocAll
 
         Paths.should_receive(:common_path).with([@root, @other].map(&:expand_path)).and_return('/common')
 
-        Base.should_receive(:add_task).with(:doc_path => "paths.lala/root", :src_path => @root.expand_path)
-        Base.should_receive(:add_task).with(:doc_path => "paths.lolo/other", :src_path => @other.expand_path)
+        Base.should_receive(:add_task).with(:doc_path => "paths.lala.root", :src_path => @root.expand_path, :title => 'paths: lala/root')
+        Base.should_receive(:add_task).with(:doc_path => "paths.lolo.other", :src_path => @other.expand_path, :title => 'paths: lolo/other')
 
         Paths.new([{:root => '/lalala/lala/root'}, {:root => '/lalala/lolo/other'}]).add_tasks
       end

data/spec/sdoc_all/ruby_spec.rb

@@ -190,7 +190,7 @@ class SdocAll
         @path.stub!(:directory?).and_return(true)
         Base.should_not_receive(:remove_if_present)
         Base.should_not_receive(:system)
-        Base.should_receive(:add_task).with(:doc_path => "ruby-1.2.3-p666", :src_path => @path)
+        Base.should_receive(:add_task).with(:doc_path => "ruby-1.2.3-p666", :src_path => @path, :title => 'ruby-1.2.3-p666')
 
         Ruby.new(:version => '1.2.3').add_tasks(:update => true)
       end

data/spec/sdoc_all_spec.rb

@@ -34,7 +34,6 @@ 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.should_receive(:store_current_sdoc_version)
       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.1
+  version: 0.2.0.6
 platform: ruby
 authors: 
 - toy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-27 00:00:00 +04:00
+date: 2009-05-02 00:00:00 +04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,9 +39,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    - - "="
       - !ruby/object:Gem::Version 
         version: 0.0.8
     version: