kballard-openri 0.1

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Kevin Ballard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,19 @@
+= openri
+by Kevin Ballard <kevin@sb.org>
+
+== DESCRIPTION
+
+openri is a script that opens the documentation
+for the given gem in your browser.
+
+The gem can be specified either by gem name or by require name.
+
+== Usage
+
+  $ openri gemname
+
+=== Examples
+
+  $ openri activerecord
+
+Opens the documentation for ActiveRecord

data/bin/openri

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + "/../lib/openri"
+
+def usage
+  puts <<-EOF
+usage: openri gem
+
+Opens the generated rdoc HTML for the specified gem.
+EOF
+end
+
+if ARGV.empty? or ARGV[0] == '-h' or ARGV[0] == '--help'
+  usage
+else
+  OpenRi.open ARGV[0]
+end

data/lib/openri.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+
+module OpenRi
+  # Opens the documentation for the specified gem
+  def self.open(name)
+    gems = Gem.source_index.find_name(name)
+    if gems.empty?
+      # try and find based on require name
+      gem = Gem.searcher.find(name)
+      if gem.nil?
+        raise "No gems matched '#{name}'"
+      end
+    else
+      gem = gems[0]
+    end
+    open_url("file://#{gem.installation_path}/doc/#{gem.full_name}/rdoc/index.html")
+  end
+
+  def self.open_url(url)
+    # this works on OS X
+    # I don't know what's necessary for other platforms
+    exec "open", url
+  end
+end

data/openri.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name = "openri"
+  s.version = "0.1"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version
+  s.authors = ["Kevin Ballard"]
+  s.date = "2008-05-14"
+  s.default_executable = "openri"
+  s.description = "Quickly open documentation for your Gems in your browser"
+  s.email = "kevin@sb.org"
+  s.executables = ["openri"]
+  s.extra_rdoc_files = ["LICENSE", "README", "bin/openri"]
+  s.files = ["bin/openri", "lib/openri.rb", "LICENSE", "README", "openri.gemspec"]
+  s.has_rdoc = true
+  s.homepage = "http://github.com/kballard/openri"
+  s.rubygems_version = "1.1.1"
+  s.summary = s.description
+  s.rdoc_options = ["--inline-source", "--title", "openri", "--main", "README"]
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: kballard-openri
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Kevin Ballard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-14 00:00:00 -07:00
+default_executable: openri
+dependencies: []
+
+description: Quickly open documentation for your Gems in your browser
+email: kevin@sb.org
+executables: 
+- openri
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- bin/openri
+files: 
+- bin/openri
+- lib/openri.rb
+- LICENSE
+- README
+- openri.gemspec
+has_rdoc: true
+homepage: http://github.com/kballard/openri
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --title
+- openri
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Quickly open documentation for your Gems in your browser
+test_files: []
+