docster 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in docster.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/docster

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'docster/cli'
+Docster::CLI.start

data/docster.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "docster/version"
+
+Gem::Specification.new do |s|
+  s.name        = "docster"
+  s.version     = Docster::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jim Ryan", "Chris Gunther"]
+  s.email       = ["info@room118solutions.com"]
+  s.homepage    = "http://github.com/room118solutions/docster"
+  s.summary     = %q{Generates searchable documentation for your ruby project}
+  s.description = s.summary
+
+  s.rubyforge_project = "docster"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "sdoc"
+  s.add_dependency "thor"
+  s.add_development_dependency "rake"
+end

data/lib/docster.rb

@@ -0,0 +1 @@
+module Docster; end

data/lib/docster/cli.rb

@@ -0,0 +1,18 @@
+require 'thor'
+require 'bundler'
+require 'docster/doc_generator'
+
+module Docster
+  class CLI < Thor
+    
+    desc 'generate', "Generate merged sdoc documentation for all :default and :development gems in this project"
+    method_option :groups, :default => ['default', 'development'], :type => :array, :aliases => '-g'
+    method_option :name, :default => Bundler.default_gemfile.dirname.split.last.to_s, :type => :string, :aliases => '-n'
+    method_option :ruby_version, :default => "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}", :type => :string, :aliases => '-r', :desc => 'Ruby version to include (defaults to this Ruby)', :banner => '(VERSION)-p(PATCHLEVEL)'
+    method_option :without_ruby, :default => false, :type => :boolean, :desc => 'Generate documentation without Ruby docs'
+    def generate
+      DocGenerator.generate! options.name, options.groups, (options.without_ruby ? nil : options.ruby_version)
+    end
+
+  end
+end

data/lib/docster/doc_generator.rb

@@ -0,0 +1,116 @@
+require 'bundler'
+
+module Docster
+  class RubyNotFound < StandardError; end
+
+  class DocGenerator
+    def self.generate!(project_name, groups, ruby_version)
+      begin
+        @@groups = groups
+      
+        create_docs_directory! unless Dir.exists?(docs_dir)
+        create_projects_directory! unless Dir.exists?(projects_path)
+      
+        changes = false
+        gems.each do |name, info|
+          unless Dir.exists?(doc_path_for name, info[:version])
+            generate_sdoc_for :type => :gem, :name => name, :version => info[:version], :path => info[:path]
+            changes = true
+          end
+        end
+      
+        unless ruby_version.nil? || Dir.exists?(doc_path_for 'ruby', ruby_version)
+          generate_sdoc_for :name => 'ruby', :version => ruby_version, :path => download_ruby(ruby_version)
+          changes = true
+        end
+      
+        if changes || !File.exists?(File.join(project_path_for(project_name), 'index.html'))
+          FileUtils.rm_rf project_path_for project_name
+          sdoc_merge project_name, ruby_version
+        end
+              
+        `open #{File.join project_path_for(project_name), 'index.html'}`
+      ensure
+        cleanup!
+      end
+    end
+    
+  private
+    def self.sdoc_merge(project_name, ruby_version)
+      names = ruby_version ? [gem_names, 'ruby'].join(',') : gem_names
+      paths = ruby_version ? doc_paths << %Q( "#{doc_path_for 'ruby', ruby_version}") : doc_paths
+      `sdoc-merge --title "#{project_name}" --op "#{project_path_for project_name}" --names "#{names}" #{paths}`
+    end
+    
+    def self.generate_sdoc_for(options = {})      
+      `sdoc -o "#{doc_path_for options[:name], options[:version]}" "#{options[:path]}"`
+    end
+    
+    def self.gems
+      return @@gems if defined?(@@gems)
+      
+      gem_paths = {}
+      Bundler.definition.specs_for(@@groups.map(&:to_sym)).each do |gem|
+        gem_paths[gem.name] = { :path => gem.full_gem_path, :version => gem.version.to_s }
+      end
+      @@gems = gem_paths
+    end
+    
+    def self.gem_names
+      gems.keys.join(',')
+    end
+    
+    def self.doc_paths
+      '"' << gems.map{ |name, info| "#{doc_path_for name, info[:version]}" }.join('" "') << '"'
+    end
+    
+    def self.user_docster_path
+      return @@user_docster_path if defined?(@@user_docster_path)
+      
+      @@user_docster_path = File.join(Etc.getpwuid.dir, '.docster')
+    end
+    
+    def self.doc_path_for(name, version)
+      File.join user_docster_path, 'docs', name, version
+    end
+    
+    def self.create_docs_directory!
+      FileUtils.mkdir_p docs_dir
+    end
+    
+    def self.create_projects_directory!
+      FileUtils.mkdir_p projects_path
+    end
+    
+    def self.docs_dir
+      File.join(user_docster_path, 'docs')
+    end
+    
+    def self.tmp_path
+      path = File.join(user_docster_path, 'tmp')
+      FileUtils.mkdir_p path
+      path
+    end
+    
+    def self.cleanup!
+      FileUtils.rm_rf tmp_path
+    end
+    
+    def self.projects_path
+      File.join user_docster_path, 'projects'
+    end
+    
+    def self.project_path_for(project_name)
+      File.join projects_path, project_name
+    end
+    
+    def self.download_ruby(version)
+      ruby_archive = "ruby-#{version}.tar.bz2"
+      archive_path = File.join tmp_path, ruby_archive
+      `wget http://ftp.ruby-lang.org/pub/ruby/#{version.split('.')[0..1].join('.')}/#{ruby_archive} -O "#{archive_path}"`
+      raise RubyNotFound unless File.size?(archive_path)
+      `tar -xf "#{archive_path}" -C "#{tmp_path}"`
+      File.join tmp_path, "ruby-#{version}"
+    end
+  end
+end

data/lib/docster/version.rb

@@ -0,0 +1,3 @@
+module Docster
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: docster
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jim Ryan
+- Chris Gunther
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sdoc
+  requirement: &2164266320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164266320
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &2164265900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164265900
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2164265400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164265400
+description: Generates searchable documentation for your ruby project
+email:
+- info@room118solutions.com
+executables:
+- docster
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- bin/docster
+- docster.gemspec
+- lib/docster.rb
+- lib/docster/cli.rb
+- lib/docster/doc_generator.rb
+- lib/docster/version.rb
+homepage: http://github.com/room118solutions/docster
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3265255303828275375
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3265255303828275375
+requirements: []
+rubyforge_project: docster
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Generates searchable documentation for your ruby project
+test_files: []