uuidtools 2.1.2 → 2.1.3

data/CHANGELOG

@@ -1,6 +1,3 @@
-== UUIDTools 2.1.2
- * fixed issue with frozen objects
- * fixed issue with running specs in Ruby 1.9.2
 == UUIDTools 2.1.1
  * fixed issue with Ruby 1.9 compatibility
 == UUIDTools 2.1.0

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'launchy', '>= 2.0.0'
+  gem 'yard', '>= 0.8.2'
+  gem 'redcarpet'
+  gem 'rubyforge'
+end
+
+group :test, :development do
+  gem 'rake', '>= 0.7.3'
+  gem 'rspec', '>= 2.9.0'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    uuidtools (2.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    diff-lcs (1.1.3)
+    json_pure (1.7.3)
+    launchy (2.1.0)
+      addressable (~> 2.2.6)
+    rake (0.9.2.2)
+    redcarpet (2.1.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  launchy (>= 2.0.0)
+  rake (>= 0.7.3)
+  redcarpet
+  rspec (>= 2.9.0)
+  rubyforge
+  uuidtools!
+  yard

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,38 @@
+# UUIDTools
+
+<dl>
+  <dt>Homepage</dt><dd><a href="http://uuidtools.rubyforge.org/">uuidtools.rubyforge.org</a></dd>
+  <dt>Author</dt><dd><a href="mailto:bob@sporkmonger.com">Bob Aman</a></dd>
+  <dt>Copyright</dt><dd>Copyright © 2005-2012 Bob Aman</dd>
+  <dt>License</dt><dd>Apache 2.0</dd>
+</dl>
+
+[![Build Status](https://secure.travis-ci.org/sporkmonger/uuidtools.png)](http://travis-ci.org/sporkmonger/uuidtools)
+[![Dependency Status](https://gemnasium.com/sporkmonger/uuidtools.png)](https://gemnasium.com/sporkmonger/uuidtools)
+
+# Description
+
+UUIDTools was designed to be a simple library for generating any
+of the various types of UUIDs.  It conforms to RFC 4122 whenever
+possible.
+
+# Reference
+
+- {UUIDTools::UUID}
+
+# Example usage
+
+    require "uuidtools"
+
+    UUIDTools::UUID.md5_create(UUIDTools::UUID_DNS_NAMESPACE, "www.widgets.com")
+    # => #<UUID:0x287576 UUID:3d813cbb-47fb-32ba-91df-831e1593ac29>
+    UUIDTools::UUID.sha1_create(UUIDTools::UUID_DNS_NAMESPACE, "www.widgets.com")
+    # => #<UUID:0x2a0116 UUID:21f7f8de-8051-5b89-8680-0195ef798b6a>
+    UUIDTools::UUID.timestamp_create
+    # => #<UUID:0x2adfdc UUID:64a5189c-25b3-11da-a97b-00c04fd430c8>
+    UUIDTools::UUID.random_create
+    # => #<UUID:0x19013a UUID:984265dc-4200-4f02-ae70-fe4f48964159>
+
+# Install
+
+    $ sudo gem install uuidtools

data/Rakefile

@@ -1,20 +1,11 @@
-lib_dir = File.expand_path(File.join(File.dirname(__FILE__), "lib"))
-$:.unshift(lib_dir)
-$:.uniq!
-
 require 'rubygems'
 require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'spec/rake/spectask'
 
-require File.join(File.dirname(__FILE__), 'lib/uuidtools', 'version')
+require File.join(File.dirname(__FILE__), 'lib', 'uuidtools', 'version')
 
 PKG_DISPLAY_NAME   = 'UUIDTools'
 PKG_NAME           = PKG_DISPLAY_NAME.downcase
-PKG_VERSION        = UUID::VERSION::STRING
+PKG_VERSION        = UUIDTools::VERSION::STRING
 PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
 
 RELEASE_NAME       = "REL #{PKG_VERSION}"
@@ -35,12 +26,7 @@ PKG_FILES = FileList[
     "[A-Z]*", "Rakefile"
 ].exclude(/database\.yml/).exclude(/[_\.]git$/)
 
-RCOV_ENABLED = (RUBY_PLATFORM != "java" && RUBY_VERSION =~ /^1\.8/)
-if RCOV_ENABLED
-  task :default => "spec:verify"
-else
-  task :default => "spec"
-end
+task :default => "spec"
 
 WINDOWS = (RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/) rescue false
 SUDO = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])

data/lib/uuidtools.rb

@@ -1,26 +1,21 @@
+# encoding:utf-8
 #--
-# UUIDTools, Copyright (c) 2005-2008 Bob Aman
+# Copyright (C) 2005-2012 Bob Aman
 #
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
 #
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
+#        http://www.apache.org/licenses/LICENSE-2.0
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
 #++
 
+
 $:.unshift(File.dirname(__FILE__))
 
 require 'uri'
@@ -38,30 +33,50 @@ rescue LoadError
 end
 
 module UUIDTools
-  #= uuidtools.rb
-  #
+  ##
   # UUIDTools was designed to be a simple library for generating any
   # of the various types of UUIDs.  It conforms to RFC 4122 whenever
   # possible.
   #
-  #== Example
-  #  UUID.md5_create(UUID_DNS_NAMESPACE, "www.widgets.com")
-  #  => #<UUID:0x287576 UUID:3d813cbb-47fb-32ba-91df-831e1593ac29>
-  #  UUID.sha1_create(UUID_DNS_NAMESPACE, "www.widgets.com")
-  #  => #<UUID:0x2a0116 UUID:21f7f8de-8051-5b89-8680-0195ef798b6a>
-  #  UUID.timestamp_create
-  #  => #<UUID:0x2adfdc UUID:64a5189c-25b3-11da-a97b-00c04fd430c8>
-  #  UUID.random_create
-  #  => #<UUID:0x19013a UUID:984265dc-4200-4f02-ae70-fe4f48964159>
+  # @example
+  #   UUID.md5_create(UUID_DNS_NAMESPACE, "www.widgets.com")
+  #   # => #<UUID:0x287576 UUID:3d813cbb-47fb-32ba-91df-831e1593ac29>
+  #   UUID.sha1_create(UUID_DNS_NAMESPACE, "www.widgets.com")
+  #   # => #<UUID:0x2a0116 UUID:21f7f8de-8051-5b89-8680-0195ef798b6a>
+  #   UUID.timestamp_create
+  #   # => #<UUID:0x2adfdc UUID:64a5189c-25b3-11da-a97b-00c04fd430c8>
+  #   UUID.random_create
+  #   # => #<UUID:0x19013a UUID:984265dc-4200-4f02-ae70-fe4f48964159>
   class UUID
     include Comparable
 
+    ##
+    # @api private
     @@last_timestamp = nil
+
+    ##
+    # @api private
     @@last_node_id = nil
+
+    ##
+    # @api private
     @@last_clock_sequence = nil
+
+    ##
+    # @api private
     @@state_file = nil
+
+    ##
+    # @api private
     @@mutex = Mutex.new
 
+    ##
+    # Creates a new UUID structure from its component values.
+    # @see UUID.md5_create
+    # @see UUID.sha1_create
+    # @see UUID.timestamp_create
+    # @see UUID.random_create
+    # @api private
     def initialize(time_low, time_mid, time_hi_and_version,
         clock_seq_hi_and_reserved, clock_seq_low, nodes)
       unless time_low >= 0 && time_low < 4294967296
@@ -110,13 +125,31 @@ module UUIDTools
       @nodes = nodes
     end
 
+    ##
+    # Returns the value of attribute `time_low`
     attr_accessor :time_low
+
+    ##
+    # Returns the value of attribute `time_mid`
     attr_accessor :time_mid
+
+    ##
+    # Returns the value of attribute `time_hi_and_version`
     attr_accessor :time_hi_and_version
+
+    ##
+    # Returns the value of attribute `clock_seq_hi_and_reserved`
     attr_accessor :clock_seq_hi_and_reserved
+
+    ##
+    # Returns the value of attribute `clock_seq_low`
     attr_accessor :clock_seq_low
+
+    ##
+    # Returns the value of attribute `nodes`
     attr_accessor :nodes
 
+    ##
     # Parses a UUID from a string.
     def self.parse(uuid_string)
       unless uuid_string.kind_of? String
@@ -140,6 +173,7 @@ module UUIDTools
         clock_seq_hi_and_reserved, clock_seq_low, nodes)
     end
 
+    ##
     # Parses a UUID from a raw byte string.
     def self.parse_raw(raw_string)
       unless raw_string.kind_of? String
@@ -161,6 +195,7 @@ module UUIDTools
         clock_seq_hi_and_reserved, clock_seq_low, nodes)
     end
 
+    ##
     # Parses a UUID from an Integer.
     def self.parse_int(uuid_int)
       unless uuid_int.kind_of?(Integer)
@@ -170,6 +205,7 @@ module UUIDTools
       return self.parse_raw(self.convert_int_to_byte_string(uuid_int, 16))
     end
 
+    ##
     # Parse a UUID from a hexdigest String.
     def self.parse_hexdigest(uuid_hexdigest)
       unless uuid_hexdigest.kind_of?(String)
@@ -179,6 +215,7 @@ module UUIDTools
       return self.parse_int(uuid_hexdigest.to_i(16))
     end
 
+    ##
     # Creates a UUID from a random value.
     def self.random_create()
       new_uuid = self.parse_raw(SecureRandom.random_bytes(16))
@@ -189,6 +226,7 @@ module UUIDTools
       return new_uuid
     end
 
+    ##
     # Creates a UUID from a timestamp.
     def self.timestamp_create(timestamp=nil)
       # We need a lock here to prevent two threads from ever
@@ -248,16 +286,19 @@ module UUIDTools
       end
     end
 
+    ##
     # Creates a UUID using the MD5 hash.  (Version 3)
     def self.md5_create(namespace, name)
       return self.create_from_hash(Digest::MD5, namespace, name)
     end
 
+    ##
     # Creates a UUID using the SHA1 hash.  (Version 5)
     def self.sha1_create(namespace, name)
       return self.create_from_hash(Digest::SHA1, namespace, name)
     end
 
+    ##
     # This method applies only to version 1 UUIDs.
     # Checks if the node ID was generated from a random number
     # or from an IEEE 802 address (MAC address).
@@ -269,6 +310,7 @@ module UUIDTools
       return ((self.nodes.first & 0x01) == 1)
     end
 
+    ##
     # Returns true if this UUID is the
     # nil UUID (00000000-0000-0000-0000-000000000000).
     def nil_uuid?
@@ -283,6 +325,7 @@ module UUIDTools
       return true
     end
 
+    ##
     # Returns the UUID version type.
     # Possible values:
     # 1 - Time-based with unique or random host identifier
@@ -294,6 +337,7 @@ module UUIDTools
       return (time_hi_and_version >> 12)
     end
 
+    ##
     # Returns the UUID variant.
     # Possible values:
     # 0b000 - Reserved, NCS backward compatibility.
@@ -313,6 +357,7 @@ module UUIDTools
       return (result >> 6)
     end
 
+    ##
     # Returns true if this UUID is valid.
     def valid?
       if [0b000, 0b100, 0b110, 0b111].include?(self.variant) &&
@@ -323,6 +368,7 @@ module UUIDTools
       end
     end
 
+    ##
     # Returns the IEEE 802 address used to generate this UUID or
     # nil if a MAC address was not used.
     def mac_address
@@ -333,6 +379,7 @@ module UUIDTools
       end).join(":")
     end
 
+    ##
     # Returns the timestamp used to generate this UUID
     def timestamp
       return nil if self.version != 1
@@ -345,6 +392,7 @@ module UUIDTools
         (gmt_timestamp_100_nanoseconds - 0x01B21DD213814000) / 10000000.0)
     end
 
+    ##
     # Compares two UUIDs lexically
     def <=>(other_uuid)
       check = self.time_low <=> other_uuid.time_low
@@ -369,81 +417,69 @@ module UUIDTools
       return 0
     end
 
+    ##
     # Returns a representation of the object's state
     def inspect
       return "#<UUID:0x#{self.object_id.to_s(16)} UUID:#{self.to_s}>"
     end
 
+    ##
     # Returns the hex digest of the UUID object.
     def hexdigest
-      return @hexdigest unless @hexdigest.nil?
-      if self.frozen?
-        return generate_hexdigest
-      else
-        return (@hexdigest = generate_hexdigest)
-      end
+      self.frozen? ? generate_hexdigest : (@hexdigest ||= generate_hexdigest)
     end
 
+    ##
     # Returns the raw bytes that represent this UUID.
     def raw
-      return @raw unless @raw.nil?
-      if self.frozen?
-        return generate_raw
-      else
-        return (@raw = generate_raw)
-      end
+      self.frozen? ? generate_raw : (@raw ||= generate_raw)
     end
 
+    ##
     # Returns a string representation for this UUID.
     def to_s
-      return @string unless @string.nil?
-      if self.frozen?
-        return generate_s
-      else
-        return (@string = generate_s)
-      end
+      self.frozen? ? generate_s : (@string ||= generate_s)
     end
     alias_method :to_str, :to_s
 
+    ##
     # Returns an integer representation for this UUID.
     def to_i
-      return @integer unless @integer.nil?
-      if self.frozen?
-        return generate_i
-      else
-        return (@integer = generate_i)
-      end
+      self.frozen? ? generate_i : (@integer ||= generate_i)
     end
 
+    ##
     # Returns a URI string for this UUID.
     def to_uri
       return "urn:uuid:#{self.to_s}"
     end
 
+    ##
     # Returns an integer hash value.
     def hash
-      return @hash unless @hash.nil?
-      if self.frozen?
-        return generate_hash
-      else
-        return (@hash = generate_hash)
-      end
+      self.frozen? ? generate_hash : (@hash ||= generate_hash)
     end
 
-    #These methods generate the appropriate representations the above methods cache
-    protected
-    
+  protected
+    ##
     # Generates the hex digest of the UUID object.
+    #
+    # @api private
     def generate_hexdigest
       return self.to_i.to_s(16).rjust(32, "0")
     end
-    
+
     # Generates an integer hash value.
+    #
+    # @api private
     def generate_hash
       return self.to_i % 0x3fffffff
     end
-    
+
+    ##
     # Generates an integer representation for this UUID.
+    #
+    # @api private
     def generate_i
       return (begin
         bytes = (time_low << 96) + (time_mid << 80) +
@@ -455,8 +491,11 @@ module UUIDTools
         bytes
       end)
     end
-    
+
+    ##
     # Generates a string representation for this UUID.
+    #
+    # @api private
     def generate_s
       result = sprintf("%8.8x-%4.4x-%4.4x-%2.2x%2.2x-", @time_low, @time_mid,
         @time_hi_and_version, @clock_seq_hi_and_reserved, @clock_seq_low);
@@ -465,25 +504,29 @@ module UUIDTools
       end
       return result.downcase
     end
-    
+
+    ##
     # Generates the raw bytes that represent this UUID.
+    #
+    # @api private
     def generate_raw
       return self.class.convert_int_to_byte_string(self.to_i, 16)
     end
-    
-    public
 
+  public
+    ##
     # Returns true if this UUID is exactly equal to the other UUID.
     def eql?(other)
       return self == other
     end
 
+    ##
     # Returns the MAC address of the current computer's network card.
     # Returns nil if a MAC address could not be found.
-    def self.mac_address #:nodoc:
+    def self.mac_address
       if !defined?(@@mac_address)
         require 'rbconfig'
-        os_platform = Config::CONFIG['target_os']
+        os_platform = RbConfig::CONFIG['target_os']
         os_class = nil
         if (os_platform =~ /win/i && !(os_platform =~ /darwin/i)) ||
             os_platform =~ /w32/i
@@ -607,6 +650,7 @@ module UUIDTools
       return @@mac_address
     end
 
+    ##
     # Allows users to set the MAC address manually in cases where the MAC
     # address cannot be obtained programatically.
     def self.mac_address=(new_mac_address)
@@ -616,8 +660,12 @@ module UUIDTools
     # The following methods are not part of the public API,
     # and generally should not be called directly.
 
+
+    ##
     # Creates a new UUID from a SHA1 or MD5 hash
-    def self.create_from_hash(hash_class, namespace, name) #:nodoc:
+    #
+    # @api private
+    def self.create_from_hash(hash_class, namespace, name)
       if hash_class == Digest::MD5
         version = 3
       elsif hash_class == Digest::SHA1
@@ -640,7 +688,9 @@ module UUIDTools
       return new_uuid
     end
 
-    def self.convert_int_to_byte_string(integer, size) #:nodoc:
+    ##
+    # @api private
+    def self.convert_int_to_byte_string(integer, size)
       byte_string = ""
       if byte_string.respond_to?(:force_encoding)
         byte_string.force_encoding(Encoding::ASCII_8BIT)
@@ -651,7 +701,9 @@ module UUIDTools
       return byte_string
     end
 
-    def self.convert_byte_string_to_int(byte_string) #:nodoc:
+    ##
+    # @api private
+    def self.convert_byte_string_to_int(byte_string)
       if byte_string.respond_to?(:force_encoding)
         byte_string.force_encoding(Encoding::ASCII_8BIT)
       end
@@ -666,8 +718,19 @@ module UUIDTools
     end
   end
 
+  ##
+  # Constant that represents the DNS namespace.
   UUID_DNS_NAMESPACE = UUID.parse("6ba7b810-9dad-11d1-80b4-00c04fd430c8")
+
+  ##
+  # Constant that represents the URL namespace.
   UUID_URL_NAMESPACE = UUID.parse("6ba7b811-9dad-11d1-80b4-00c04fd430c8")
+
+  ##
+  # Constant that represents the OID namespace.
   UUID_OID_NAMESPACE = UUID.parse("6ba7b812-9dad-11d1-80b4-00c04fd430c8")
+
+  ##
+  # Constant that represents the X500 namespace.
   UUID_X500_NAMESPACE = UUID.parse("6ba7b814-9dad-11d1-80b4-00c04fd430c8")
 end

data/lib/uuidtools/version.rb

@@ -1,33 +1,28 @@
+# encoding:utf-8
 #--
-# UUIDTools, Copyright (c) 2005-2008 Bob Aman
+# Copyright (C) 2005-2012 Bob Aman
 #
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
 #
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
+#        http://www.apache.org/licenses/LICENSE-2.0
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
 #++
 
+
 # Used to prevent the class/module from being loaded more than once
-unless defined? UUID::VERSION
-  class UUID
+unless defined? UUIDTools::VERSION
+  module UUIDTools
     module VERSION #:nodoc:
       MAJOR = 2
       MINOR = 1
-      TINY  = 2
+      TINY  = 3
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+$VERBOSE=true
+
 spec_dir = File.expand_path(File.dirname(__FILE__))
 lib_dir = File.expand_path(File.join(spec_dir, "../lib"))
 

data/tasks/gem.rake

@@ -1,12 +1,11 @@
-require "rake/gempackagetask"
+require "rubygems/package_task"
+require "rake"
+require "rake/clean"
+
+CLOBBER.include("pkg")
 
 namespace :gem do
   GEM_SPEC = Gem::Specification.new do |s|
-    unless s.respond_to?(:add_development_dependency)
-      puts "The gem spec requires a newer version of RubyGems."
-      exit(1)
-    end
-
     s.name = PKG_NAME
     s.version = PKG_VERSION
     s.summary = PKG_SUMMARY
@@ -14,28 +13,47 @@ namespace :gem do
 
     s.files = PKG_FILES.to_a
 
-    s.has_rdoc = true
-    s.extra_rdoc_files = %w( README )
-    s.rdoc_options.concat ["--main",  "README"]
+    s.extra_rdoc_files = %w( README.md )
+    s.rdoc_options.concat ["--main",  "README.md"]
 
-    s.add_development_dependency("rake", ">= 0.8.3")
-    s.add_development_dependency("rspec", ">= 1.1.11")
-    s.add_development_dependency("launchy", ">= 0.3.2")
+    if !s.respond_to?(:add_development_dependency)
+      puts "Cannot build Gem with this version of RubyGems."
+      exit(1)
+    end
+
+    s.add_development_dependency("rake", ">= 0.7.3")
+    s.add_development_dependency("rspec", ">= 2.9.0")
+    s.add_development_dependency("yard", ">= 0.8.2")
+    s.add_development_dependency("launchy", ">= 2.0.0")
 
     s.require_path = "lib"
 
     s.author = "Bob Aman"
     s.email = "bob@sporkmonger.com"
-    s.homepage = "http://#{PKG_NAME}.rubyforge.org/"
-    s.rubyforge_project = RUBY_FORGE_PROJECT
+    s.homepage = RUBY_FORGE_URL
   end
 
-  Rake::GemPackageTask.new(GEM_SPEC) do |p|
+  Gem::PackageTask.new(GEM_SPEC) do |p|
     p.gem_spec = GEM_SPEC
     p.need_tar = true
     p.need_zip = true
   end
 
+  desc "Generates .gemspec file"
+  task :gemspec do
+    spec_string = GEM_SPEC.to_ruby
+
+    begin
+      Thread.new { eval("$SAFE = 3\n#{spec_string}", binding) }.join
+    rescue
+      abort "unsafe gemspec: #{$!}"
+    else
+      File.open("#{GEM_SPEC.name}.gemspec", 'w') do |file|
+        file.write spec_string
+      end
+    end
+  end
+
   desc "Show information about the gem"
   task :debug do
     puts GEM_SPEC.to_ruby
@@ -65,4 +83,4 @@ end
 desc "Alias to gem:package"
 task "gem" => "gem:package"
 
-task "clobber" => ["gem:clobber_package"]
+task "gem:release" => "gem:gemspec"

data/tasks/rspec.rake

@@ -0,0 +1,58 @@
+require "rspec/core/rake_task"
+require "rake/clean"
+
+CLOBBER.include("coverage", "specdoc")
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:rcov) do |t|
+    t.pattern = FileList['spec/**/*_spec.rb']
+    t.rspec_opts = ['--color', '--format', 'documentation']
+
+    t.rcov = true
+    t.rcov_opts = [
+      '--exclude', 'lib\\/compat',
+      '--exclude', 'spec',
+      '--exclude', '\\.rvm\\/gems',
+      '--exclude', '1\\.8\\/gems',
+      '--exclude', '1\\.9\\/gems',
+      '--exclude', '\\.rvm',
+      '--exclude', '\\/Library\\/Ruby'
+    ]
+  end
+
+  RSpec::Core::RakeTask.new(:normal) do |t|
+    t.pattern = FileList['spec/**/*_spec.rb'].exclude(/compat/)
+    t.rspec_opts = ['--color', '--format', 'documentation']
+    t.rcov = false
+  end
+
+  RSpec::Core::RakeTask.new(:all) do |t|
+    t.pattern = FileList['spec/**/*_spec.rb']
+    t.rspec_opts = ['--color', '--format', 'documentation']
+    t.rcov = false
+  end
+
+  desc "Generate HTML Specdocs for all specs"
+  RSpec::Core::RakeTask.new(:specdoc) do |t|
+    specdoc_path = File.expand_path(
+      File.join(File.dirname(__FILE__), '..', 'documentation')
+    )
+    Dir.mkdir(specdoc_path) if !File.exist?(specdoc_path)
+
+    output_file = File.join(specdoc_path, 'index.html')
+    t.pattern = FileList['spec/**/*_spec.rb']
+    t.rspec_opts = ["--format", "\"html:#{output_file}\"", "--diff"]
+    t.fail_on_error = false
+  end
+
+  namespace :rcov do
+    desc "Browse the code coverage report."
+    task :browse => "spec:rcov" do
+      require "launchy"
+      Launchy::Browser.run("coverage/index.html")
+    end
+  end
+end
+
+desc "Alias to spec:normal"
+task "spec" => "spec:normal"

data/tasks/rubyforge.rake

@@ -26,7 +26,7 @@ end
 
 namespace :doc do
   desc "Publish RDoc to RubyForge"
-  task :release => ["doc:rdoc"] do
+  task :release => ["doc:yard"] do
     require "rake/contrib/sshpublisher"
     require "yaml"
 

data/tasks/yard.rake

@@ -0,0 +1,22 @@
+require "rake"
+require "rake/clean"
+
+CLOBBER.include("doc")
+
+require "yard"
+require "yard/rake/yardoc_task"
+
+namespace :doc do
+  desc "Generate Yardoc documentation"
+  YARD::Rake::YardocTask.new do |yardoc|
+    yardoc.name = "yard"
+    yardoc.options = ["--verbose", "--markup", "markdown"]
+    yardoc.files = FileList[
+      "lib/**/*.rb", "ext/**/*.c",
+      "README.md", "CHANGELOG.md", "LICENSE.txt"
+    ].exclude(/idna/)
+  end
+end
+
+desc "Alias to doc:yard"
+task "doc" => "doc:yard"

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: uuidtools
 version: !ruby/object:Gem::Version 
-  hash: 15
   prerelease: 
-  segments: 
-  - 2
-  - 1
-  - 2
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors: 
 - Bob Aman
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-02 00:00:00 -08:00
-default_executable: 
+date: 2012-07-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -26,12 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 57
-        segments: 
-        - 0
-        - 8
-        - 3
-        version: 0.8.3
+        version: 0.7.3
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -42,30 +31,31 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 1
-        - 11
-        version: 1.1.11
+        version: 2.9.0
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: launchy
+  name: yard
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 0
-        - 3
-        - 2
-        version: 0.3.2
+        version: 0.8.2
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: launchy
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :development
+  version_requirements: *id004
 description: |
   A simple universally unique ID generation library.
 
@@ -75,7 +65,7 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.md
 files: 
 - lib/compat/securerandom.rb
 - lib/uuidtools/version.rb
@@ -87,26 +77,26 @@ files:
 - spec/uuidtools/uuid_creation_spec.rb
 - spec/uuidtools/uuid_parsing_spec.rb
 - tasks/benchmark.rake
-- tasks/clobber.rake
 - tasks/gem.rake
 - tasks/git.rake
 - tasks/metrics.rake
-- tasks/rdoc.rake
+- tasks/rspec.rake
 - tasks/rubyforge.rake
-- tasks/spec.rake
+- tasks/yard.rake
 - website/index.html
 - CHANGELOG
-- LICENSE
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - Rakefile
-- README
-has_rdoc: true
+- README.md
 homepage: http://uuidtools.rubyforge.org/
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --main
-- README
+- README.md
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -114,23 +104,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
-rubyforge_project: uuidtools
-rubygems_version: 1.4.1
+rubyforge_project: 
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: UUID generator

data/LICENSE

@@ -1,20 +0,0 @@
-UUIDTools, Copyright (c) 2005-2008 Bob Aman
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -1,13 +0,0 @@
- UUIDTools was designed to be a simple library for generating any
- of the various types of UUIDs.  It conforms to RFC 4122 whenever
- possible.
-
-== Example
-  UUIDTools::UUID.md5_create(UUIDTools::UUID_DNS_NAMESPACE, "www.widgets.com")
-  => #<UUID:0x287576 UUID:3d813cbb-47fb-32ba-91df-831e1593ac29>
-  UUIDTools::UUID.sha1_create(UUIDTools::UUID_DNS_NAMESPACE, "www.widgets.com")
-  => #<UUID:0x2a0116 UUID:21f7f8de-8051-5b89-8680-0195ef798b6a>
-  UUIDTools::UUID.timestamp_create
-  => #<UUID:0x2adfdc UUID:64a5189c-25b3-11da-a97b-00c04fd430c8>
-  UUIDTools::UUID.random_create
-  => #<UUID:0x19013a UUID:984265dc-4200-4f02-ae70-fe4f48964159>

data/tasks/clobber.rake

@@ -1,2 +0,0 @@
-desc "Remove all build products"
-task "clobber"

data/tasks/rdoc.rake

@@ -1,29 +0,0 @@
-require "rake/rdoctask"
-
-namespace :doc do
-  desc "Generate RDoc documentation"
-  Rake::RDocTask.new do |rdoc|
-    rdoc.rdoc_dir = "doc"
-    rdoc.title    = "#{PKG_NAME}-#{PKG_VERSION} Documentation"
-    rdoc.options << "--line-numbers" << "--inline-source" <<
-      "--accessor" << "cattr_accessor=object" << "--charset" << "utf-8"
-    rdoc.template = "#{ENV["template"]}.rb" if ENV["template"]
-    rdoc.rdoc_files.include("README", "CHANGELOG", "LICENSE")
-    rdoc.rdoc_files.include("lib/**/*.rb")
-  end
-
-  desc "Generate ri locally for testing"
-  task :ri do
-    sh "rdoc --ri -o ri ."
-  end
-
-  desc "Remove ri products"
-  task :clobber_ri do
-    rm_r "ri" rescue nil
-  end
-end
-
-desc "Alias to doc:rdoc"
-task "doc" => "doc:rdoc"
-
-task "clobber" => ["doc:clobber_rdoc", "doc:clobber_ri"]

data/tasks/spec.rake

@@ -1,64 +0,0 @@
-require 'spec/rake/verify_rcov'
-
-namespace :spec do
-  Spec::Rake::SpecTask.new(:rcov) do |t|
-    t.spec_files = FileList['spec/**/*_spec.rb']
-    t.spec_opts = ['--color', '--format', 'specdoc']
-    if RCOV_ENABLED
-      t.rcov = true
-    else
-      t.rcov = false
-    end
-    t.rcov_opts = [
-      '--exclude', 'spec',
-      '--exclude', '1\\.8\\/gems',
-      '--exclude', '1\\.9\\/gems',
-      '--exclude', 'addressable\\/idna\\.rb', # unicode tables too big
-    ]
-  end
-
-  Spec::Rake::SpecTask.new(:normal) do |t|
-    t.spec_files = FileList['spec/**/*_spec.rb']
-    t.spec_opts = ['--color', '--format', 'specdoc']
-    t.rcov = false
-  end
-
-  if RCOV_ENABLED
-    RCov::VerifyTask.new(:verify) do |t|
-      t.threshold = 100.0
-      t.index_html = 'coverage/index.html'
-    end
-
-    task :verify => :rcov
-  end
-
-  desc "Generate HTML Specdocs for all specs"
-  Spec::Rake::SpecTask.new(:specdoc) do |t|
-    specdoc_path = File.expand_path(
-      File.join(File.dirname(__FILE__), '../specdoc/'))
-    Dir.mkdir(specdoc_path) if !File.exist?(specdoc_path)
-
-    output_file = File.join(specdoc_path, 'index.html')
-    t.spec_files = FileList['spec/**/*_spec.rb']
-    t.spec_opts = ["--format", "\"html:#{output_file}\"", "--diff"]
-    t.fail_on_error = false
-  end
-
-  namespace :rcov do
-    desc "Browse the code coverage report."
-    task :browse => "spec:rcov" do
-      require "launchy"
-      Launchy::Browser.run("coverage/index.html")
-    end
-  end
-end
-
-if RCOV_ENABLED
-  desc "Alias to spec:verify"
-  task "spec" => "spec:verify"
-else
-  desc "Alias to spec:normal"
-  task "spec" => "spec:normal"
-end
-
-task "clobber" => ["spec:clobber_rcov"]