rdoc-readme 0.1.1 → 0.1.2

data/.gitignore

@@ -1,5 +1,7 @@
 .*.swp
 *.gem
 .bundle
+coverage/
 Gemfile.lock
+html/
 pkg/*

data/HISTORY.rdoc

@@ -0,0 +1,28 @@
+= RDoc::Readme History
+
+== 2012-01-03 v0.1.2
+
+* Actual tests!
+* Play nice with +RDoc::Task+
+
+== 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.
+
+== 2011-04-01 v0.0.1
+
+* Initial prototype release.
+

data/README.rdoc

@@ -25,8 +25,15 @@
   # Pull in RDoc from $stdin and print to $stdout.
   RDoc::Readme::RakeTask.new 
 
+== Author
+
+blair christensen. <mailto:blair.christensen@gmail.com>
+
+== Homepage
+
+https://github.com/blairc/rdoc-readme/
+
 == To Do
 
-* Tests!
 * Use +RDoc+ and/or +YARD+ to handle the parsing.
 

data/Rakefile

@@ -1,6 +1,24 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
+require File.expand_path( File.join( File.dirname(__FILE__), 'lib', 'rdoc-readme', 'rake_task' ) )
+require 'rake/clean'
+require 'rake/testtask'
+require 'rdoc/task'
+
+%w{ coverage html out.txt pkg }.each  { |p| CLEAN.include(p) }
+%w{ build install test }.each         { |t| task t.to_sym => [ 'rdoc:readme' ] }
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs       << 'test'
+  t.test_files =   FileList['test/test*.rb']
+  t.verbose    =   true
+end
 
-require './lib/rdoc-readme/rake_task'
 RDoc::Readme::RakeTask.new 'lib/rdoc-readme.rb', 'README.rdoc'
 
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
+end
+

data/lib/rdoc-readme.rb

@@ -26,22 +26,33 @@ module RDoc # :nodoc:
   #   # Pull in RDoc from $stdin and print to $stdout.
   #   RDoc::Readme::RakeTask.new 
   #
+  # == Author
+  #
+  # blair christensen. <mailto:blair.christensen@gmail.com>
+  #
+  # == Homepage
+  #
+  # https://github.com/blairc/rdoc-readme/
+  #
   # == To Do
   #
-  # * Tests!
   # * Use +RDoc+ and/or +YARD+ to handle the parsing.
   #
   class Readme
 
-    # Create new +RDoc::Readme+ generator.
+    #
+    # Create new RDoc::Readme generator.
+    # 
     def initialize
       yield self if block_given?
+      self
     end
 
-    # Read RDoc from file handle.  Returns array of output lines.
+    #
+    # Read RDoc from file handle.  Returns +Array+ of output lines.
     #
     # Params:
-    # +fh+:: Read from this file handle.
+    #   +fh+:: Read from this file handle.
     def from_file_handle(fh)
       out   = []
       rdoc  = false
@@ -50,38 +61,45 @@ module RDoc # :nodoc:
         line.chomp!
 
         if rdoc
-          comment?(line)  ? ( out << sanitize(line) )               : rdoc = false
+          _comment?(line) ? ( out << _sanitize(line) )               : rdoc = false
         else
-          start?(line)    ? ( rdoc = true ; out << sanitize(line) ) : rdoc = false
+          _start?(line)   ? ( rdoc = true ; out << _sanitize(line) ) : rdoc = false
         end
       end
 
       out
     end
 
-    # Read RDoc from file.  Returns array of output lines.
+    #
+    # Read RDoc from file.  Returns +Array+ of output lines.
     #
     # Params:
-    # +fn+:: Read from this file.
+    #   +fn+:: Read from this file.
     def from_file(fn)
       from_file_handle( File.open(fn) )
     end
 
     private
 
-    # Is this a comment?
-    def comment?(text)
+    #
+    # Returns +true+ if +text+ contains a comment, otherwise +nil+.
+    #
+    def _comment?(text)
       text =~ /^\s*#\s*/
     end
 
-    # Is this the start of RDoc markup?
-    def start?(text)
-      text =~ /^\s*#\s+=/
+    # 
+    # Returns +text+ with leading whitespace and comment prefix removed.
+    # 
+    def _sanitize(text)
+      text.lstrip.gsub(/^#\s?/, '')
     end
 
-    # Remove leading whitespace and comments from RDoc text.
-    def sanitize(text)
-      text.lstrip.gsub(/^#\s?/, '')
+    #
+    # Returns +true+ if +text+ is the start of RDoc comments, otherwise +nil+.
+    #
+    def _start?(text)
+      text =~ /^\s*#\s+=/
     end
 
   end

data/lib/rdoc-readme/rake_task.rb

@@ -12,7 +12,7 @@ module RDoc                           # :nodoc:
  
         desc('Generate README from RDoc')
         task @name do
-          RDoc::Readme.new do |rdoc|
+          ::RDoc::Readme.new do |rdoc|
             if    src && dst
               File.open(dst, 'w').puts( rdoc.from_file(src) )
             elsif src

data/lib/rdoc-readme/version.rb

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

data/rdoc-readme.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Blair Christensen']
   s.email       = ['blair.christensen@gmail.com']
-  s.homepage    = ""
+  s.homepage    = 'https://github.com/blairc/rdoc-readme/'
   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}
 
@@ -18,4 +18,8 @@ Gem::Specification.new do |s|
   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_development_dependency 'rake',    '~> 0.9.2'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'simplecov'
 end

data/test/data/expected

@@ -0,0 +1,39 @@
+= RDoc::Readme - Extract high-level RDOC for use in a README file
+
+== Usage
+
+  require 'rdoc-readme'
+
+  RDoc::Readme.new do |rdoc|
+    # 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 
+
+== Author
+
+blair christensen. <mailto:blair.christensen@gmail.com>
+
+== Homepage
+
+https://github.com/blairc/rdoc-readme/
+
+== To Do
+
+* Use +RDoc+ and/or +YARD+ to handle the parsing.
+

data/test/test_rdoc_readme.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'rdoc-readme'
+require 'test/unit'
+
+class TestRDocReadme < Test::Unit::TestCase
+
+  @@expected = File.readlines( File.join( File.dirname(__FILE__), 'data', 'expected' ) )
+  @@expected.map { |line| line.chomp! }
+
+  def setup
+    @fn = File.expand_path( File.join( File.dirname(__FILE__), '..', 'lib', 'rdoc-readme.rb' ) )
+  end
+
+  def test_initialization
+    blockable = false
+    r = RDoc::Readme.new do |r|
+      assert_kind_of  RDoc::Readme, r
+      blockable = true
+    end
+    assert         blockable,    'works as block'
+    assert_kind_of RDoc::Readme, r
+    assert_kind_of RDoc::Readme, RDoc::Readme.new
+  end
+
+  def test_from_file_handle
+    RDoc::Readme.new do |r|
+      assert_not_nil  @@expected
+      assert_kind_of  Array,      @@expected
+      assert_equal    39,         @@expected.size
+
+      results = r.from_file_handle( File.open(@fn) )
+
+      assert_not_nil  results
+      assert_kind_of  Array,            results
+      assert_equal    @@expected.size,  results.size
+      @@expected.each_with_index { |line, idx| assert_equal line, results[idx] }
+    end
+  end
+
+  def test_from_file
+    RDoc::Readme.new do |r|
+      assert_not_nil  @@expected
+      assert_kind_of  Array,      @@expected
+      assert_equal    39,         @@expected.size
+
+      results = r.from_file(@fn)
+      assert_not_nil  results
+      assert_kind_of  Array,            results
+      assert_equal    @@expected.size,  results.size
+      @@expected.each_with_index { |line, idx| assert_equal line, results[idx] }
+    end
+  end
+
+  def test_underscore_comment?
+    RDoc::Readme.new do |r|
+      [ "", "foo" ].each do |txt|
+        assert_nil r.send(:_comment?, txt)
+      end
+      [ "#", " #", "# #" ].each do |txt|
+        assert r.send(:_comment?, txt)
+      end
+    end
+  end
+
+  def test_underscore_sanitize
+    RDoc::Readme.new do |r|r
+      {
+        ''        =>  '',
+        'foo'     =>  'foo',
+        'foo #'   => 'foo #',
+        ' # foo'  => 'foo',
+        '# foo'   => 'foo',
+        '#'       => ''
+      }.each_pair do |input, output|
+        assert_equal output, r.send(:_sanitize, input)
+      end
+    end
+  end
+      #text.lstrip.gsub(/^#\s?/, '')
+
+  def test_underscore_start?
+    RDoc::Readme.new do |r|
+      [ "", "foo", "#", " #", "# #", "#=", "# foo" ].each do |txt|
+        assert_nil r.send(:_start?, txt)
+      end
+      [ "# = foo", " # == foo" ].each do |txt|
+        assert r.send(:_start?, txt)
+      end
+    end
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-readme
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,41 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-06 00:00:00.000000000 -05:00
-default_executable: 
-dependencies: []
+date: 2012-01-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70363536723760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70363536723760
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70363536723340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70363536723340
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70363536759740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70363536759740
 description: Extract high-level RDoc for use in a README file
 email:
 - blair.christensen@gmail.com
@@ -22,7 +54,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- HISTORY
+- HISTORY.rdoc
 - README.rdoc
 - Rakefile
 - bin/rdoc2readme
@@ -30,8 +62,9 @@ files:
 - lib/rdoc-readme/rake_task.rb
 - lib/rdoc-readme/version.rb
 - rdoc-readme.gemspec
-has_rdoc: true
-homepage: ''
+- test/data/expected
+- test/test_rdoc_readme.rb
+homepage: https://github.com/blairc/rdoc-readme/
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -43,16 +76,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 595138242485204300
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 595138242485204300
 requirements: []
 rubyforge_project: rdoc-readme
-rubygems_version: 1.6.0
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: Extract high-level RDoc for use in a README file
-test_files: []
+test_files:
+- test/data/expected
+- test/test_rdoc_readme.rb

data/HISTORY

@@ -1,16 +0,0 @@
-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.
-
-2011-04-01 v0.0.1
-  - Initial prototype release.
-