webget_ruby_ramp 1.8.0 → 1.8.2

data/lib/webget_ruby_ramp/symbol.rb

@@ -4,6 +4,22 @@
 
 class Symbol
 
+  # Compare this symbol to another symbol.
+  # 
+  # @example Less than
+  #    :foo <=> :goo 
+  #    => -1
+  #
+  # @example Equal
+  #    :foo <=> :foo
+  #    => 0
+  #
+  # @example Greater than
+  #    :foo <=> :bar 
+  #    => 1
+  #
+  # @return [-1,0,1] -1 if this is < that, 0
+
   include Comparable
   def <=>(that)
     self.to_s<=>that.to_s

data/lib/webget_ruby_ramp/time.rb

@@ -5,14 +5,15 @@
 class Time
 
 
-  # Return a time stamp string in standard format: "YYYY-MM-DD HH:MM:SSZ"
+  # @return [String] a time stamp string in standard format: "YYYY-MM-DD HH:MM:SSZ"
   #
   # This standard format is specified in IETF RFC 3339 and ISO 8601.
   #
-  # See http://www.ietf.org/rfc/rfc3339.txt
+  # @see http://www.ietf.org/rfc/rfc3339.txt
   #
-  # ==Example
-  #   Time.now.stamp => "2010-12-31 12:59:59Z" 
+  # @example
+  #   Time.now.stamp 
+  #   => "2010-12-31 12:59:59Z" 
 
   def stamp
     getutc.strftime('%Y-%m-%d %H:%M:%SZ')
@@ -21,20 +22,24 @@ class Time
 
   # Shorthand for Time.now.stamp
   #
-  # ==Example
-  #   Time.stamp => "2010-12-31 12:59:59Z" 
+  # @example
+  #   Time.stamp
+  #    => "2010-12-31 12:59:59Z" 
+  #
+  # @return [String] Time.now.stamp
 
   def self.stamp
     now.stamp
   end
 
 
-  # Return time packed into a short string: "YYYYMMDDHHMMSS"
+  # @return [String] time packed into a short string: "YYYYMMDDHHMMSS"
   #
   # The time is converted to UTC.
   #
-  # ==Example
-  #   Time.now.pack => "20101231125959" 
+  # @example
+  #   Time.now.pack
+  #   => "20101231125959" 
 
   def pack
     getutc.strftime('%Y%m%d%H%M%S')
@@ -43,8 +48,11 @@ class Time
 
   # Shorthand for Time.now.pack
   #
-  # ==Example
-  #   Time.pack => "20101231125959" 
+  # @example
+  #   Time.pack
+  #   => "20101231125959" 
+  # 
+  # @return [String] Time.now.pack                                                                                 
 
   def self.pack
     now.pack

data/lib/webget_ruby_ramp/xml.rb

@@ -11,12 +11,12 @@ module XML
   #
   # See [Dir#glob](http://www.ruby-doc.org/core/classes/Dir.html#M002347) for pattern details.
   #
-  # ==Example
+  # @example To load xml documents
   #   XML.load_dir('/tmp/*.xml'){|xml_document|
   #     #...whatever you want to do with each xml document
   #   }
   #
-  # ==Example to load xml documents in files beginning in "foo" or "bar"
+  # @example To load xml documents in files beginning in "foo" or "bar"
   #   XML.load_dir('/tmp/foo*.yaml','/tmp/bar*.xml','){|xml_document|
   #     #...whatever you want to do with the xml document
   #   }
@@ -36,7 +36,7 @@ module XML
 
   # Sugar to load elements from a file.
   #
-  # ==Example
+  # @example
   #   XML.load_attributes('config.xml','userlist/user'){|element| pp element.attributes['first_name'] }
 
   def XML.load_elements(dirpath,xpath)
@@ -50,7 +50,7 @@ module XML
 
   # Sugar to load attributes from a file.
   #
-  # ==Example
+  # @example
   #   XML.load_attributes('config.xml','userlist/user'){|attributes| pp attributes['first_name'] }
 
   def XML.load_attributes(dirpath,xpath)
@@ -61,7 +61,7 @@ module XML
 
   # Sugar to load attributes hash from a file.
   #
-  # ==Example
+  # @example
   #   XML.load_attributes('config.xml','userlist/user'){|attributes| pp attributes['first_name'] }
 
   def XML.load_attributes_hash(dirpath,xpath)
@@ -75,16 +75,18 @@ module XML
   # comments, and generally anything else we might need
   # to enable the XML parser to handle a dirty document.
   #
-  # ==Example 
-  #   # This example shows curly braces instead of angle braces because of HTML formatting
-  #   s="{foo a=b c=d}{!--comment--}Hello{!-[if bar]}Microsoft{![endif]}World{/foo}"
-  #   XML.strip_all(s) => "{foo}HelloWorld{/foo}"
-  #
   # This method calls these in order:
   #   - XML.strip_unprintables
   #   - XML.strip_microsoft
   #   - XML.strip_comments
   #   - XML.strip_attributes
+  #
+  # @example 
+  #   # This example shows curly braces instead of angle braces because of HTML formatting
+  #   s="{foo a=b c=d}{!--comment--}Hello{!-[if bar]}Microsoft{![endif]}World{/foo}"
+  #   XML.strip_all(s) => "{foo}HelloWorld{/foo}"
+  #
+  # @return [String] the text, stripped of unprintables, Microsoft markup, comments, and attributes
 
   def XML.strip_all(xml_text)
     return XML.strip_attributes(XML.strip_comments(XML.strip_microsoft(XML.strip_unprintables(xml_text))))
@@ -93,9 +95,11 @@ module XML
 
   # Strip out all attributes from the xml text's tags.
   #
-  # ==Example
+  # @example
   #   s="<foo a=b c=d e=f>Hello</foo>"
   #   XML.strip_attributes(s) => "<foo>Hello</foo>"
+  #
+  # @return [String] the text, stripped of attributes
 
   def XML.strip_attributes(xml_text)
     return xml_text.gsub(/<(\/?\w+).*?>/im){"<#{$1}>"}  # delete attributes
@@ -104,10 +108,12 @@ module XML
 
   # Strip out all comments from the xml text.
   #
-  # ==Example
+  # @example
   #   # This example shows curly braces instead of angle braces because of HTML formatting
   #   s="Hello{!--comment--}World"
   #   XML.strip_comments(s) => "HelloWorld"
+  #
+  # @return [String] the text, stripped of comments
 
   def XML.strip_comments(xml_text)
     return xml_text.gsub(/<!.*?>/im,'')  
@@ -116,9 +122,11 @@ module XML
 
   # Strip out all microsoft proprietary codes.
   #
-  # ==Example
+  # @example
   #   s="Hello<!-[if foo]>Microsoft<![endif]->World"
   #   XML.strip_microsoft(s) => "HelloWorld"
+  #
+  # @return [String] the text, stripped of Microsoft markup
 
   def XML.strip_microsoft(xml_text)
     return xml_text.gsub(/<!-*\[if\b.*?<!\[endif\]-*>/im,'')
@@ -127,9 +135,11 @@ module XML
 
   # Strip out all unprintable characters from the input string.
   #
-  # ==Example
+  # @example
   #   s="Hello\XXXWorld" # where XXX is unprintable
   #   XML.strip_unprintables(s) => "HelloWorld"
+  #
+  # @return [String] the text, stripped of unprintables
 
   def XML.strip_unprintables(xml_text)
     return xml_text.gsub(/[^[:print:]]/, "")
@@ -142,9 +152,9 @@ end
 
 class REXML::Attributes
 
-  # Return a new hash of the attribute keys and values.
+  # @return a new hash of the attribute keys and values.
   #
-  # ==Example
+  # @example
   #   attributes.to_hash => {"src"=>"pic.jpg", "height" => "100", "width" => "200"} 
 
   def to_hash
@@ -162,9 +172,9 @@ class REXML::Document
 
   # Remove all attributes from the document's elements.
   # 
-  # Return the document.
+  # @return the document.
   #
-  # cf. Element#remove_attributes
+  # @see Element#remove_attributes
 
   def remove_attributes
     self.elements.each("//") { |elem| elem.attributes.each_attribute{|attribute| attribute.remove }}
@@ -180,9 +190,9 @@ class REXML::Element
 
   # Remove all attributes from the element.
   #
-  # Return the element.
+  # @return the element.
   #
-  # cf. Document#remove_attributes
+  # @see Document#remove_attributes
 
   def remove_attributes
     self.attributes.each_attribute{|attribute| attribute.remove }

data/lib/webget_ruby_ramp/yaml.rb

@@ -6,17 +6,18 @@ require 'yaml'
 
 module YAML
 
+
   # Specify one or more directory patterns and pass each YAML file in the matching directories to a block.
   #
-  # See [Dir#glob](http://www.ruby-doc.org/core/classes/Dir.html#M002347) for pattern details.
+  # @see [Dir#glob](http://www.ruby-doc.org/core/classes/Dir.html#M002347) for pattern details.
   #
-  # ==Example
+  # @example To load documents in files ending in ".yaml"
   #   YAML.load_dir('/tmp/*.yaml'){|yaml_document|
   #     #...whatever you want to do with each yaml document
   #   }
   #
-  # ==Example to load documents in files ending in ".yaml" and ".yml"
-  #   YAML.load_dir('/tmp/*.yaml','/tmp/*.yml','){|yaml_document|
+  # @example To load documents in files beginning in "foo" or "bar"
+  #   YAML.load_dir('/tmp/foo*.yaml','/tmp/bar*.yaml','){|yaml_document|
   #     #...whatever you want to do with the yaml document
   #   }
   

data/test/webget_ruby_ramp/numeric_test.rb

@@ -24,65 +24,5 @@ class NumericTest < Test::Unit::TestCase
   end
 
   
-  def test_peta
-    assert_equal(1,1000000000000000.peta)
-  end
-
-
-  def test_tera
-    assert_equal(1,1000000000000.tera)
-  end
-
-
-  def test_giga
-    assert_equal(1,1000000000.giga)
-  end
-
-
-  def test_mega
-    assert_equal(1,1000000.mega)
-  end
-
-
-  def test_kilo
-    assert_equal(1,1000.kilo)
-  end
-
-
-  def test_hecto
-    assert_equal(1,100.hecto)
-  end
-
-
-  def test_deka
-    assert_equal(1,10.deka)
-  end
-
-
-  def test_deci
-    assert_equal(1,0.1.deci)
-  end
-
-
-  def test_centi
-    assert_equal(1,0.01.centi)
-  end
-
-
-  def test_milli
-    assert_equal(1,0.001.milli)
-  end
-
-
-  def test_micro
-    assert_equal(1,0.000001.micro)
-  end
-
-
-  def test_nano
-    assert_equal(1,0.000000001.nano)
-  end
-
-
 end
 

data/test/webget_ruby_ramp/string_test.rb

@@ -5,11 +5,6 @@ require 'webget_ruby_ramp'
 class StringTest < Test::Unit::TestCase
 
 
-  def test_accents
-    assert(String::ACCENTS.is_a?Hash)
-  end
-
-
   def test_capitalize_words
     assert_equal("Foo Goo Hoo","foo goo hoo".capitalize_words)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: webget_ruby_ramp
 version: !ruby/object:Gem::Version 
-  version: 1.8.0
+  version: 1.8.2
 platform: ruby
 authors: 
 - WebGet
@@ -32,7 +32,7 @@ cert_chain:
   DXnLFY0cVuBnNDMOOFl8vk1qIcZjcTovhzgcixpG6Uk5qmUsKHRLQf4oQJx7TfLK
   -----END CERTIFICATE-----
 
-date: 2010-03-05 00:00:00 -08:00
+date: 2010-03-21 00:00:00 -07:00
 default_executable: 
 dependencies: []
 

metadata.gz.sig

@@ -1 +1 @@
-���D�h6�y2P�`eF��=Y}��DPh#ZZ���fY�_�]^��.����y��h���E�G�i�EPÆI<���.&���X���2�`Z��U����2��hy;Z�^f}���m�p�f��
+��u�6�������ށ"C҂��i�˷"�H7��}����vg��u�=��3��@���F��&	q��r��/�_��͠WB���:P�b"����f�'����G��AJW����W�龈 ����Sm