yard_gems 1.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+public.html
+public
+tmp

data/Gemfile.passenger_ignore

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

data/README

@@ -0,0 +1,4 @@
+Local On Demand YARD Docs for Rubygems
+=======================================
+
+This is a simple application that makes it easy to have local YARD docs for all installed Rubygems, created on demand.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/yard-gems

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require "rubygems" # ruby1.9 doesn't "require" it though
+require "thor"
+require 'fileutils'
+
+class YardGems < Thor
+  desc "install PATH", "Installs a YARD gems application the supplied path"
+  def install(path)
+    puts "I will install it here: #{path}"
+    FileUtils.mkdir_p(path + '/public')
+    FileUtils.mkdir_p(path + '/tmp')
+    FileUtils.cp(File.expand_path("../../config.ru", __FILE__), path + "/config.ru")
+  end
+
+  desc "pow", "Installs the yard gems application to ~/.pow"
+  def pow(path="~/.pow")
+    path = File.join(File.expand_path(path), "yard")
+    install(path)
+  end
+end
+
+YardGems.start
+

data/config.ru

@@ -0,0 +1,4 @@
+$: << File.expand_path(File.dirname(__FILE__), 'lib')
+require 'rubygems'
+require 'yard_gems'
+run YardGems::RackAdapter.new

data/lib/yard_gems.rb

@@ -0,0 +1,5 @@
+require "yard_gems/version"
+
+module YardGems
+  require 'yard_gems/rack_adapter'
+end

data/lib/yard_gems/rack_adapter.rb

@@ -0,0 +1,60 @@
+require 'yard'
+require 'fileutils'
+
+class YardGems::RackAdapter
+  def initialize
+    @cached_libraries = load_cached_libraries
+
+    load_libraries
+
+    if @cached_libraries != @libraries
+      FileUtils.rm_f 'public.html'
+      cache_libraries
+    end
+
+    @last_refresh = Time.now
+    @yard_server = YARD::Server::RackAdapter.new(@libraries, {:caching => true}, :DocumentRoot => 'public')
+  end
+
+  REFRESH_INTERVAL = 60 #seconds
+
+  def call(env)
+    if Time.now - @last_refresh > REFRESH_INTERVAL
+      $stderr.puts "Checking for new gems"
+      Gem.source_index.refresh!
+
+      load_libraries
+
+      if @cached_libraries != @libraries
+        $stderr.puts "Reloading gems"
+
+        FileUtils.rm_f 'public.html'
+        @yard_server.libraries = @libraries
+        cache_libraries
+      end
+      @last_refresh = Time.now
+    end
+
+    @yard_server.call(env)
+  end
+
+  private
+  def load_cached_libraries
+    Marshal.load(IO.read('tmp/gems.index')) if File.exist?('tmp/gems.index')
+  end
+
+  def load_libraries
+    @libraries = {}
+    gems = Gem.source_index.find_name('').each do |spec|
+      @libraries[spec.name] ||= []
+      @libraries[spec.name] << YARD::Server::LibraryVersion.new(spec.name, spec.version.to_s, nil, :gem)
+    end
+  end
+
+  def cache_libraries
+    File.open('tmp/gems.index', 'w') do |f|
+      f << Marshal.dump(@libraries)
+    end
+    @cached_libraries = @libraries
+  end
+end

data/lib/yard_gems/version.rb

@@ -0,0 +1,3 @@
+module YardGems
+  VERSION = "1.0"
+end

data/yard_gems.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yard_gems/version"
+
+Gem::Specification.new do |s|
+  s.name        = "yard_gems"
+  s.version     = YardGems::VERSION
+  s.authors     = ["Doug Barth"]
+  s.email       = ["dougbarth@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Local On Demand YARD Docs for Rubygems}
+  s.description = %q{Easily install a YARD backed site for viewing locally installed Rubygem docs. Install this and disable rdoc generation on gem install.}
+
+  s.rubyforge_project = "yard_gems"
+
+  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_runtime_dependency "yard"
+  s.add_runtime_dependency "rack"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: yard_gems
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Doug Barth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  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
+description: Easily install a YARD backed site for viewing locally installed Rubygem docs. Install this and disable rdoc generation on gem install.
+email: 
+- dougbarth@gmail.com
+executables: 
+- yard-gems
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile.passenger_ignore
+- README
+- Rakefile
+- bin/yard-gems
+- config.ru
+- lib/yard_gems.rb
+- lib/yard_gems/rack_adapter.rb
+- lib/yard_gems/version.rb
+- public/.gitkeep
+- tmp/.gitkeep
+- yard_gems.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: yard_gems
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Local On Demand YARD Docs for Rubygems
+test_files: []
+