rdoc-readme 0.0.2 → 0.1.1

data/HISTORY

@@ -1,3 +1,13 @@
+2011-04-06 v0.1.1
+  - Rake task can now send output to a file.
+
+2011-04-06 v0.1.0
+  - '#from_file' now returns array instead of printing to $stdout.
+  - '#from_file_handle' now returns array instead of printing to $stdout.
+
+2011-04-06 v0.0.3
+  - Added Rake task
+
 2011-04-01 v0.0.2
   - Documentation fix.
 

data/README.rdoc

@@ -2,15 +2,31 @@
 
 == Usage
 
+  require 'rdoc-readme'
+
   RDoc::Readme.new do |rdoc|
-    rdoc.from_file(file_name)     # Prints to $stdout
-    rdoc.from_file_handle($stdin) # Prints to $stdout
+    # Read from file
+    rdoc.from_file(file_name).each { |line| puts line }
+    
+    # Read from file handle
+    rdoc.from_file_handle($stdin).each { |line| puts line }
   end
 
+== Rake Task
+
+  require 'rdoc-readme/rake_task'
+  
+  # Pull in RDoc from source file and print to destination file.
+  RDoc::Readme::RakeTask.new 'lib/rdoc-readme.rb', 'README.rdoc'
+  
+  # Pull in RDoc from source file and print to $stdout.
+  RDoc::Readme::RakeTask.new 'lib/rdoc-readme.rb'
+  
+  # Pull in RDoc from $stdin and print to $stdout.
+  RDoc::Readme::RakeTask.new 
+
 == To Do
 
 * Tests!
-* Add Rake task 
-* Don't automagically print to +STDOUT+
 * Use +RDoc+ and/or +YARD+ to handle the parsing.
 

data/Rakefile

@@ -1,2 +1,6 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require './lib/rdoc-readme/rake_task'
+RDoc::Readme::RakeTask.new 'lib/rdoc-readme.rb', 'README.rdoc'
+

data/lib/rdoc-readme/rake_task.rb

@@ -0,0 +1,31 @@
+require 'rake'
+require 'rake/tasklib'
+require 'rdoc-readme'
+
+module RDoc                           # :nodoc:
+  class Readme                        # :nodoc:
+
+    class RakeTask < ::Rake::TaskLib  # :nodoc:
+
+      def initialize( src=nil, dst=nil )
+        @name = 'rdoc:readme'
+ 
+        desc('Generate README from RDoc')
+        task @name do
+          RDoc::Readme.new do |rdoc|
+            if    src && dst
+              File.open(dst, 'w').puts( rdoc.from_file(src) )
+            elsif src
+              puts rdoc.from_file(src)
+            else
+              puts rdoc.from_file_handle($stdin)
+            end
+          end
+        end
+      end
+
+    end # class RakeTask
+
+  end # class Readme
+end # module RDoc
+

data/lib/rdoc-readme/version.rb

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

data/lib/rdoc-readme.rb

@@ -3,16 +3,32 @@ module RDoc # :nodoc:
   # 
   # == Usage
   #
+  #   require 'rdoc-readme'
+  #
   #   RDoc::Readme.new do |rdoc|
-  #     rdoc.from_file(file_name)     # Prints to $stdout
-  #     rdoc.from_file_handle($stdin) # Prints to $stdout
+  #     # Read from file
+  #     rdoc.from_file(file_name).each { |line| puts line }
+  #     
+  #     # Read from file handle
+  #     rdoc.from_file_handle($stdin).each { |line| puts line }
   #   end
   #
+  # == Rake Task
+  #
+  #   require 'rdoc-readme/rake_task'
+  #   
+  #   # Pull in RDoc from source file and print to destination file.
+  #   RDoc::Readme::RakeTask.new 'lib/rdoc-readme.rb', 'README.rdoc'
+  #   
+  #   # Pull in RDoc from source file and print to $stdout.
+  #   RDoc::Readme::RakeTask.new 'lib/rdoc-readme.rb'
+  #   
+  #   # Pull in RDoc from $stdin and print to $stdout.
+  #   RDoc::Readme::RakeTask.new 
+  #
   # == To Do
   #
   # * Tests!
-  # * Add Rake task 
-  # * Don't automagically print to +STDOUT+
   # * Use +RDoc+ and/or +YARD+ to handle the parsing.
   #
   class Readme
@@ -22,22 +38,31 @@ module RDoc # :nodoc:
       yield self if block_given?
     end
 
-    # Read RDoc from filehandle.
+    # Read RDoc from file handle.  Returns array of output lines.
+    #
+    # Params:
+    # +fh+:: Read from this file handle.
     def from_file_handle(fh)
-      rdoc = false
+      out   = []
+      rdoc  = false
 
       fh.readlines.each do |line|
         line.chomp!
 
         if rdoc
-          comment?(line)  ? ( puts sanitize(line) )               : rdoc = false
+          comment?(line)  ? ( out << sanitize(line) )               : rdoc = false
         else
-          start?(line)    ? ( rdoc = true ; puts sanitize(line) ) : rdoc = false
+          start?(line)    ? ( rdoc = true ; out << sanitize(line) ) : rdoc = false
         end
       end
+
+      out
     end
 
-    # Read RDoc from file.
+    # Read RDoc from file.  Returns array of output lines.
+    #
+    # Params:
+    # +fn+:: Read from this file.
     def from_file(fn)
       from_file_handle( File.open(fn) )
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-readme
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-01 00:00:00.000000000 -05:00
+date: 2011-04-06 00:00:00.000000000 -05:00
 default_executable: 
 dependencies: []
 description: Extract high-level RDoc for use in a README file
@@ -27,6 +27,7 @@ files:
 - Rakefile
 - bin/rdoc2readme
 - lib/rdoc-readme.rb
+- lib/rdoc-readme/rake_task.rb
 - lib/rdoc-readme/version.rb
 - rdoc-readme.gemspec
 has_rdoc: true