rdoc-readme 0.0.2

data/.gitignore

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

data/Gemfile

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

data/HISTORY

@@ -0,0 +1,6 @@
+2011-04-01 v0.0.2
+  - Documentation fix.
+
+2011-04-01 v0.0.1
+  - Initial prototype release.
+

data/README.rdoc

@@ -0,0 +1,16 @@
+= RDoc::Readme - Extract high-level RDOC for use in a README file
+
+== Usage
+
+  RDoc::Readme.new do |rdoc|
+    rdoc.from_file(file_name)     # Prints to $stdout
+    rdoc.from_file_handle($stdin) # Prints to $stdout
+  end
+
+== To Do
+
+* Tests!
+* Add Rake task 
+* Don't automagically print to +STDOUT+
+* Use +RDoc+ and/or +YARD+ to handle the parsing.
+

data/Rakefile

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

data/bin/rdoc2readme

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rdoc-readme'
+
+ARGV.empty? ? RDoc::Readme.new.from_file_handle($stdin) : RDoc::Readme.new.from_file( ARGV.first )
+
+# vim: syntax=ruby
+

data/lib/rdoc-readme/version.rb

@@ -0,0 +1,5 @@
+module RDoc # :nodoc:
+  class Readme
+    VERSION = '0.0.2'
+  end
+end

data/lib/rdoc-readme.rb

@@ -0,0 +1,64 @@
+module RDoc # :nodoc:
+  # = RDoc::Readme - Extract high-level RDOC for use in a README file
+  # 
+  # == Usage
+  #
+  #   RDoc::Readme.new do |rdoc|
+  #     rdoc.from_file(file_name)     # Prints to $stdout
+  #     rdoc.from_file_handle($stdin) # Prints to $stdout
+  #   end
+  #
+  # == To Do
+  #
+  # * Tests!
+  # * Add Rake task 
+  # * Don't automagically print to +STDOUT+
+  # * Use +RDoc+ and/or +YARD+ to handle the parsing.
+  #
+  class Readme
+
+    # Create new +RDoc::Readme+ generator.
+    def initialize
+      yield self if block_given?
+    end
+
+    # Read RDoc from filehandle.
+    def from_file_handle(fh)
+      rdoc = false
+
+      fh.readlines.each do |line|
+        line.chomp!
+
+        if rdoc
+          comment?(line)  ? ( puts sanitize(line) )               : rdoc = false
+        else
+          start?(line)    ? ( rdoc = true ; puts sanitize(line) ) : rdoc = false
+        end
+      end
+    end
+
+    # Read RDoc from file.
+    def from_file(fn)
+      from_file_handle( File.open(fn) )
+    end
+
+    private
+
+    # Is this a comment?
+    def comment?(text)
+      text =~ /^\s*#\s*/
+    end
+
+    # Is this the start of RDoc markup?
+    def start?(text)
+      text =~ /^\s*#\s+=/
+    end
+
+    # Remove leading whitespace and comments from RDoc text.
+    def sanitize(text)
+      text.lstrip.gsub(/^#\s?/, '')
+    end
+
+  end
+end
+

data/rdoc-readme.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rdoc-readme/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'rdoc-readme'
+  s.version     = RDoc::Readme::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Blair Christensen']
+  s.email       = ['blair.christensen@gmail.com']
+  s.homepage    = ""
+  s.summary     = %q{Extract high-level RDoc for use in a README file}
+  s.description = %q{Extract high-level RDoc for use in a README file}
+
+  s.rubyforge_project = "rdoc-readme"
+
+  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']
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: rdoc-readme
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Blair Christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-04-01 00:00:00.000000000 -05:00
+default_executable: 
+dependencies: []
+description: Extract high-level RDoc for use in a README file
+email:
+- blair.christensen@gmail.com
+executables:
+- rdoc2readme
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- HISTORY
+- README.rdoc
+- Rakefile
+- bin/rdoc2readme
+- lib/rdoc-readme.rb
+- lib/rdoc-readme/version.rb
+- rdoc-readme.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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rdoc-readme
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 3
+summary: Extract high-level RDoc for use in a README file
+test_files: []