ruby-bitly 0.0.6 → 0.0.8

data/README.rdoc

@@ -1,4 +1,4 @@
-= This app is a simple bitly ruby client.
+= A simple bitly ruby client.
 
 == Examples
     bitly -s http://rafael.xlii.com.br

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.8

data/bin/bitly

@@ -1,44 +1,11 @@
-#!/usr/bin/env ruby 
-# = This app is a simple bitly ruby client.
-#
-# == Examples
-#     bitly -s http://rafael.xlii.com.br
-#     bitly -e http://bit.ly/XLII42
-#     bitly --user-clicks http://bit.ly/XLII42
-#     bitly --global-clicks http://bit.ly/XLII42
-#
-#   Other examples:
-#     bitly -q -s http://rafael.xlii.com.br
-#     bitly --verbose -e http://bit.ly/XLII42
-#
-# == Usage 
-#     bitly [options] url
-#
-#     For help: bitly -h
-#
-# == Options
-#     -s, --shorten        Shorten a long url
-#     -e, --expand         Expand a short bitly url
-#     -u, --user-clicks    Show user clicks from the short bitly url
-#     -g, --global-clicks  Show global clicks from the short bitly url
-#                          
-#     -h, --help           Displays help message, then exit
-#     -v, --version        Display the version, then exit
-#     -q, --quiet          Output as little as possible, overrides verbose
-#     -V, --verbose        Verbose output
-#
-# == Author
-#     rafaeldx7 ~ rafaeldx7(a)gmail.com
-#
-# == Copyright
-#     Copyright (c) 2010 rafaeldx7. Licensed under the MIT License:
-#     http://www.opensource.org/licenses/mit-license.php
+#!/usr/bin/env ruby
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
+require 'rubygems'
 require 'ruby-bitly'
 require 'optparse' 
-require 'rdoc/usage'
+require 'readme'
 require 'ostruct'
 require 'date'
 
@@ -123,11 +90,11 @@ class App
     end
     
     def output_help
-      RDoc::usage() #exits app
+      Readme::usage() #exits app
     end
     
     def output_usage
-      RDoc::usage('usage') # gets usage from comments above
+      Readme::usage('usage') # gets usage from comments above
     end
     
     def output_version
@@ -142,5 +109,7 @@ class App
     end
 end
 
-app = App.new(ARGV, STDIN)
-app.run
+if __FILE__ == $0
+  app = App.new(ARGV, STDIN)
+  app.run
+end

data/lib/readme.rb

@@ -0,0 +1,136 @@
+require 'rdoc/markup/simple_markup'
+require 'rdoc/markup/simple_markup/to_flow'
+require 'rdoc/ri/ri_formatter'
+require 'rdoc/ri/ri_options'
+
+module Readme
+
+  # Display usage information from the comment at the top of
+  # the file. String arguments identify specific sections of the
+  # comment to display. An optional integer first argument
+  # specifies the exit status  (defaults to 0)
+
+  def Readme.usage(*args)
+    exit_code = 0
+
+    if args.size > 0
+      status = args[0]
+      if status.respond_to?(:to_int)
+        exit_code = status.to_int
+        args.shift
+      end
+    end
+
+    # display the usage and exit with the given code
+    usage_no_exit(*args)
+    exit(exit_code)
+  end
+
+  # Display usage
+  def Readme.usage_no_exit(*args)
+    # main_program_file = caller[-1].sub(/:\d+$/, '') # ruby-bitly
+    main_program_file = "README.rdoc"
+    
+    comment = File.open(main_program_file) do |file|
+      find_comment(file)
+    end
+
+    comment = comment.gsub(/^\s*#/, '')
+
+    markup = SM::SimpleMarkup.new
+    flow_convertor = SM::ToFlow.new
+    
+    flow = markup.convert(comment, flow_convertor)
+
+    format = "plain"
+
+    unless args.empty?
+      flow = extract_sections(flow, args)
+    end
+
+    options = RI::Options.instance
+    if args = ENV["RI"]
+      options.parse(args.split)
+    end
+    formatter = options.formatter.new(options, "")
+    formatter.display_flow(flow)
+  end
+
+  ######################################################################
+
+  private
+
+  # Find the first comment in the file (that isn't a shebang line)
+  # If the file doesn't start with a comment, report the fact
+  # and return empty string
+
+  def Readme.gets(file)
+    if (line = file.gets) && (line =~ /^#!/) # shebang
+      throw :exit, find_comment(file)
+    else
+      line
+    end
+  end
+
+  def Readme.find_comment(file)
+    catch(:exit) do
+      # skip leading blank lines
+      0 while (line = gets(file)) && (line =~ /^\s*$/)
+
+      comment = []
+      while line # && line =~ /^\s*#/ # ruby-bitly
+        comment << line
+        line = gets(file)
+      end
+
+      0 while line && (line = gets(file))
+      return no_comment if comment.empty?
+      return comment.join
+    end
+  end
+
+
+  #####
+  # Given an array of flow items and an array of section names, extract those
+  # sections from the flow which have headings corresponding to
+  # a section name in the list. Return them in the order
+  # of names in the +sections+ array.
+
+  def Readme.extract_sections(flow, sections)
+    result = []
+    sections.each do |name|
+      name = name.downcase
+      copy_upto_level = nil
+
+      flow.each do |item|
+        case item
+        when SM::Flow::H
+          if copy_upto_level && item.level >= copy_upto_level
+            copy_upto_level = nil
+          else
+            if item.text.downcase == name
+              result << item
+              copy_upto_level = item.level
+            end
+          end
+        else
+          if copy_upto_level
+            result << item
+          end
+        end
+      end
+    end
+    if result.empty?
+      puts "Note to developer: requested section(s) [#{sections.join(', ')}] not found"
+      result = flow
+    end
+    result
+  end
+
+  #####
+  # Report the fact that no doc comment count be found
+  def Readme.no_comment
+    $stderr.puts "No usage information available for this program"
+    ""
+  end
+end

data/ruby-bitly.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-bitly}
-  s.version = "0.0.6"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["rafaeldx7"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "bin/bitly",
+     "lib/readme.rb",
      "lib/ruby-bitly.rb",
      "ruby-bitly.gemspec",
      "spec/ruby-bitly_spec.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-bitly
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - rafaeldx7
@@ -99,6 +99,7 @@ files:
 - Rakefile
 - VERSION
 - bin/bitly
+- lib/readme.rb
 - lib/ruby-bitly.rb
 - ruby-bitly.gemspec
 - spec/ruby-bitly_spec.rb