uuidtools 1.0.3 → 1.0.4

data/lib/uuidtools/version.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005-2008 Robert Aman
+# 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
@@ -22,10 +22,10 @@
 #++
 
 class UUID
-  module UUID_TOOLS_VERSION #:nodoc:
+  module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 0
-    TINY  = 3
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+spec_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.expand_path(File.join(spec_dir, "../lib"))
+
+$:.unshift(lib_dir)
+$:.uniq!
+
+require "uuidtools"

data/spec/uuidtools/mac_address_spec.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe UUID, "when obtaining a MAC address" do
+  before do
+    @mac_address = UUID.mac_address
+  end
+
+  it "should obtain a MAC address" do
+    @mac_address.should_not be_nil
+  end
+
+  it "should cache the MAC address" do
+    @mac_address.object_id.should == UUID.mac_address.object_id
+  end
+end

data/spec/uuidtools/uuid_creation_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe UUID, "when generating" do
+  it "should correctly generate SHA1 variant UUIDs" do
+    UUID.sha1_create(
+      UUID_URL_NAMESPACE, 'http://sporkmonger.com'
+    ).to_s.should == "f2d04685-b787-55da-8644-9bd28a6f5a53"
+  end
+
+  it "should correctly generate MD5 variant UUIDs" do
+    UUID.md5_create(
+      UUID_URL_NAMESPACE, 'http://sporkmonger.com'
+    ).to_s.should == "15074785-9071-3fe3-89bd-876e4b9e919b"
+  end
+
+  it "should correctly generate timestamp variant UUIDs" do
+    UUID.timestamp_create.to_s.should_not == UUID.timestamp_create.to_s
+    current_time = Time.now
+    UUID.timestamp_create(current_time).to_s.should_not ==
+      UUID.timestamp_create(current_time).to_s
+    uuids = []
+    1000.times do
+      uuids << UUID.timestamp_create
+    end
+    # Check to make sure that none of the 10,000 UUIDs were duplicates
+    (uuids.map {|x| x.to_s}).uniq.size.should == uuids.size
+  end
+
+  it "should correctly generate random number variant UUIDs" do
+    uuids = []
+    1000.times do
+      uuids << UUID.random_create
+    end
+    # Check to make sure that none of the 10,000 UUIDs were duplicates
+    (uuids.map {|x| x.to_s}).uniq.size.should == uuids.size
+  end
+end

data/spec/uuidtools/uuid_parsing_spec.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe UUID, "when parsing" do
+  it "should correctly parse the MAC address from a timestamp version UUID" do
+    UUID.timestamp_create.mac_address.should == UUID.mac_address
+  end
+
+  it "should correctly parse the variant from a timestamp version UUID" do
+    UUID.timestamp_create.variant.should == 0b100
+  end
+
+  it "should correctly parse the version from a timestamp version UUID" do
+    UUID.timestamp_create.version.should == 1
+  end
+
+  it "should correctly parse the timestamp from a timestamp version UUID" do
+    UUID.timestamp_create.timestamp.should < Time.now + 1
+    UUID.timestamp_create.timestamp.should > Time.now - 1
+  end
+
+  it "should not treat a timestamp version UUID as a nil UUID" do
+    UUID.timestamp_create.should_not be_nil_uuid
+  end
+
+  it "should not treat a timestamp version UUID as a random node UUID" do
+    UUID.timestamp_create.should_not be_random_node_id
+  end
+
+  it "should treat a timestamp version UUID as a random node UUID " +
+      "if there is no MAC address" do
+    old_mac_address = UUID.mac_address
+    UUID.mac_address = nil
+    UUID.timestamp_create.should be_random_node_id
+    UUID.mac_address = old_mac_address
+  end
+end

data/tasks/benchmark.rake

@@ -0,0 +1,38 @@
+task :benchmark do
+  require 'lib/uuidtools'
+  require 'benchmark'
+
+  # Version 1
+  result = Benchmark.measure do
+    10000.times do
+      UUID.timestamp_create.to_s
+    end
+  end
+  puts "#{(10000.0 / result.real)} version 1 per second."
+
+  # Version 3
+  result = Benchmark.measure do
+    10000.times do
+      UUID.md5_create(UUID_URL_NAMESPACE,
+        "http://www.ietf.org/rfc/rfc4122.txt").to_s
+    end
+  end
+  puts "#{(10000.0 / result.real)} version 3 per second."
+
+  # Version 4
+  result = Benchmark.measure do
+    10000.times do
+      UUID.random_create.to_s
+    end
+  end
+  puts "#{(10000.0 / result.real)} version 4 per second."
+
+  # Version 5
+  result = Benchmark.measure do
+    10000.times do
+      UUID.sha1_create(UUID_URL_NAMESPACE,
+        "http://www.ietf.org/rfc/rfc4122.txt").to_s
+    end
+  end
+  puts "#{(10000.0 / result.real)} version 5 per second."
+end

data/tasks/clobber.rake

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

data/tasks/gem.rake

@@ -0,0 +1,62 @@
+require "rake/gempackagetask"
+
+namespace :gem do
+  GEM_SPEC = Gem::Specification.new do |s|
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.summary = PKG_SUMMARY
+    s.description = PKG_DESCRIPTION
+
+    s.files = PKG_FILES.to_a
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = %w( README )
+    s.rdoc_options.concat ["--main",  "README"]
+
+    s.add_dependency("rake", ">= 0.7.3")
+    s.add_dependency("rspec", ">= 1.0.8")
+
+    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
+  end
+
+  Rake::GemPackageTask.new(GEM_SPEC) do |p|
+    p.gem_spec = GEM_SPEC
+    p.need_tar = true
+    p.need_zip = true
+  end
+
+  desc "Show information about the gem"
+  task :debug do
+    puts GEM_SPEC.to_ruby
+  end
+
+  desc "Install the gem"
+  task :install => ["clobber", "gem:package"] do
+    sh "#{SUDO} gem install --local pkg/#{GEM_SPEC.full_name}"
+  end
+
+  desc "Uninstall the gem"
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PKG_NAME)
+    if installed_list &&
+        (installed_list.collect { |s| s.version.to_s}.include?(PKG_VERSION))
+      sh(
+        "#{SUDO} gem uninstall --version '#{PKG_VERSION}' " +
+        "--ignore-dependencies --executables #{PKG_NAME}"
+      )
+    end
+  end
+
+  desc "Reinstall the gem"
+  task :reinstall => [:uninstall, :install]
+end
+
+desc "Alias to gem:package"
+task "gem" => "gem:package"
+
+task "clobber" => ["gem:clobber_package"]

data/tasks/git.rake

@@ -0,0 +1,40 @@
+namespace :git do
+  namespace :tag do
+    desc "List tags from the Git repository"
+    task :list do
+      tags = `git tag -l`
+      tags.gsub!("\r", "")
+      tags = tags.split("\n").sort {|a, b| b <=> a }
+      puts tags.join("\n")
+    end
+
+    desc "Create a new tag in the Git repository"
+    task :create do
+      changelog = File.open("CHANGELOG", "r") { |file| file.read }
+      puts "-" * 80
+      puts changelog
+      puts "-" * 80
+      puts
+
+      v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+      abort "Versions don't match #{v} vs #{PKG_VERSION}" if v != PKG_VERSION
+
+      tag = "#{PKG_NAME}-#{PKG_VERSION}"
+      msg = "Release #{PKG_NAME}-#{PKG_VERSION}"
+
+      existing_tags = `git tag -l #{PKG_NAME}-*`.split("\n")
+      if existing_tags.include?(tag)
+        warn("Tag already exists, deleting...")
+        unless system "git tag -d #{tag}"
+          abort "Tag deletion failed."
+        end
+      end
+      puts "Creating git tag '#{tag}'..."
+      unless system "git tag -a -m \"#{msg}\" #{tag}"
+        abort "Tag creation failed."
+      end
+    end
+  end
+end
+
+task "gem:release" => "git:tag:create"

data/tasks/metrics.rake

@@ -0,0 +1,22 @@
+namespace :metrics do
+  task :lines do
+    lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
+    for file_name in FileList["lib/**/*.rb"]
+      f = File.open(file_name)
+      while line = f.gets
+        lines += 1
+        next if line =~ /^\s*$/
+        next if line =~ /^\s*#/
+        codelines += 1
+      end
+      puts "L: #{sprintf("%4d", lines)}, " +
+        "LOC #{sprintf("%4d", codelines)} | #{file_name}"
+      total_lines     += lines
+      total_codelines += codelines
+
+      lines, codelines = 0, 0
+    end
+
+    puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
+  end
+end

data/tasks/rdoc.rake

@@ -0,0 +1,29 @@
+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/rubyforge.rake

@@ -0,0 +1,78 @@
+require 'rubyforge'
+require 'rake/contrib/sshpublisher'
+
+namespace :gem do
+  desc 'Package and upload to RubyForge'
+  task :release => ["gem:package"] do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PKG_VERSION
+    pkg = "pkg/#{GEM_SPEC.full_name}"
+
+    rf = RubyForge.new
+    rf.configure
+    puts 'Logging in...'
+    rf.login
+
+    c = rf.userconfig
+    changelog = File.open("CHANGELOG") { |file| file.read }
+    c['release_changes'] = changelog
+    c['preformatted'] = true
+
+    files = ["#{pkg}.tgz", "#{pkg}.zip", "#{pkg}.gem"]
+
+    puts "Releasing #{PKG_NAME} v. #{PKG_VERSION}"
+    rf.add_release RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, *files
+  end
+end
+
+namespace :doc do
+  desc "Publish RDoc to RubyForge"
+  task :release => ["doc:rdoc"] do
+    config = YAML.load(
+      File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = RUBY_FORGE_PATH + "/api"
+    local_dir = "doc"
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end
+
+namespace :spec do
+  desc "Publish specdoc to RubyForge"
+  task :release => ["spec:specdoc"] do
+    config = YAML.load(
+      File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = RUBY_FORGE_PATH + "/specdoc"
+    local_dir = "specdoc"
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+
+  namespace :rcov do
+    desc "Publish coverage report to RubyForge"
+    task :release => ["spec:rcov"] do
+      config = YAML.load(
+        File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+      )
+      host = "#{config['username']}@rubyforge.org"
+      remote_dir = RUBY_FORGE_PATH + "/coverage"
+      local_dir = "coverage"
+      Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+    end
+  end
+end
+
+namespace :website do
+  desc "Publish website to RubyForge"
+  task :release => ["doc:release", "spec:release", "spec:rcov:release"] do
+    config = YAML.load(
+      File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = RUBY_FORGE_PATH
+    local_dir = "website"
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,89 @@
+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']
+    t.rcov = true
+    t.rcov_opts = [
+      '--exclude', 'spec',
+      '--exclude', '1\\.8\\/gems',
+      '--exclude', '1\\.9\\/gems'
+    ]
+  end
+
+  RCov::VerifyTask.new(:verify) do |t|
+    t.threshold = 100.0
+    t.index_html = 'coverage/index.html'
+  end
+
+  task :verify => :rcov
+
+  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
+      Rake.browse("coverage/index.html")
+    end
+  end
+end
+
+desc "Alias to spec:verify"
+task "spec" => "spec:verify"
+
+task "clobber" => ["spec:clobber_rcov"]
+
+module Rake
+  def self.browse(filepath)
+    if RUBY_PLATFORM =~ /mswin/
+      system(filepath)
+    else
+      try_browsers = lambda do
+        result = true
+        if !(`which firefox 2>&1` =~ /no firefox/)
+          system("firefox #{filepath}")
+        elsif !(`which mozilla 2>&1` =~ /no mozilla/)
+          system("mozilla #{filepath}")
+        elsif !(`which netscape 2>&1` =~ /no netscape/)
+          system("netscape #{filepath}")
+        elsif !(`which links 2>&1` =~ /no links/)
+          system("links #{filepath}")
+        elsif !(`which lynx 2>&1` =~ /no lynx/)
+          system("lynx #{filepath}")
+        else
+          result = false
+        end
+        result
+      end
+      opened = false
+      if RUBY_PLATFORM =~ /darwin/
+        opened = true
+        system("open #{filepath}")
+      elsif !(`which gnome-open 2>&1` =~ /no gnome-open/)
+        success =
+          !(`gnome-open #{filepath} 2>&1` =~ /There is no default action/)
+        if !success
+          opened = try_browsers.call()
+        else
+          opened = true
+        end
+      else
+        opened = try_browsers.call()
+      end
+      if !opened
+        puts "Don't know how to browse to location."
+      end
+    end
+  end
+end