ffi-uuid 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Mullis
+
+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.rdoc

@@ -0,0 +1,17 @@
+= ffi-uuid
+
+FFI Wrapper for libuuid. Access to the basic functions is provided as well as extra helpers to make usage friendlier.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Michael Mullis. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ffi-uuid"
+    gem.summary = %Q{FFI Wrapper for libuuidm}
+    gem.description = %Q{FFI Wrapper for libuuid with extra helpers for common UUID tasks like getting an array of uuids for quicker distribution}
+    gem.email = "michael@mullistechnologies.com"
+    gem.homepage = "http://github.com/mmullis/ffi-uuid"
+    gem.authors = ["Michael Mullis"]
+    gem.add_dependency 'ffi', ">= 0.6.3"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ffi-uuid #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/ffi-uuid.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ffi-uuid}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Mullis"]
+  s.date = %q{2010-10-04}
+  s.description = %q{FFI Wrapper for libuuid with extra helpers for common UUID tasks like getting an array of uuids for quicker distribution}
+  s.email = %q{michael@mullistechnologies.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "ffi-uuid.gemspec",
+     "lib/ffi-uuid.rb",
+     "lib/ffi/ffi_uuid_impl.rb",
+     "test/helper.rb",
+     "test/test_ffi_uuid.rb"
+  ]
+  s.homepage = %q{http://github.com/mmullis/ffi-uuid}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{FFI Wrapper for libuuidm}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_ffi_uuid.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ffi>, [">= 0.6.3"])
+    else
+      s.add_dependency(%q<ffi>, [">= 0.6.3"])
+    end
+  else
+    s.add_dependency(%q<ffi>, [">= 0.6.3"])
+  end
+end
+

data/lib/ffi/ffi_uuid_impl.rb

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'ffi'
+
+# uuid_generate_xxx take uuid_t which is a 16 byte unsigned char
+# that is directly updated - treat like a bang! method
+
+class FFI::UUID
+  extend FFI::Library
+
+  # load our custom C library and attach
+  # FFI functions to our Ruby runtime
+  # unfortunately, linux doesnt set libsuid.so 
+  ffi_lib(["uuid", "libuuid", "libuuid.so", "libuuid.so.1"])
+
+  functions = [
+    # method # parameters        # return
+    [:uuid_generate_random, [:pointer], :void],
+    [:uuid_generate_time,   [:pointer], :void],
+
+    # these are not really necessary and havent' been tested
+    [:uuid_generate,        [:pointer], :void],
+    #[:uuid_clear, [:string], :void],
+    #[:uuid_compare, [:string, :string], :int],
+    #[:uuid_copy, [:string, :string], :void],
+
+    #[:uuid_is_null, [:string], :bool],
+
+    # convertion formatted hex string to binary
+    [:uuid_parse,   [:pointer, :pointer], :void],
+
+    # convert binary to formatted hex string
+    [:uuid_unparse, [:pointer, :pointer], :void],
+    [:uuid_unparse_lower, [:pointer, :pointer], :void],
+    [:uuid_unparse_upper, [:pointer, :pointer], :void],
+  ]
+
+  functions.each do |func|
+    begin
+      attach_function(*func)
+    rescue Object => e
+      puts "Could not attach #{func}, #{e.message}"
+    end
+  end
+
+  def self.generate(algorithm=:random)
+    binary_uuid = " " * 16
+    formatted_result = " " * 36  # 32 hex chars + 4 dashes
+    case algorithm
+    when :time
+      FFI::UUID.uuid_generate_time(binary_uuid)
+    else
+      FFI::UUID.uuid_generate_random(binary_uuid)
+    end
+    ##puts "BINARY_UUID #{binary_uuid.bytes.to_a.inspect}"
+
+    FFI::UUID.uuid_unparse(binary_uuid, formatted_result)
+    formatted_result    # manual/slower/ruby way .unpack("H*")[0]
+  end
+
+  def self.generate_random
+    generate(:random)
+  end
+
+  def self.generate_time
+    generate(:time)
+  end
+
+  def self.unparse(binary_uuid)
+    raise "UUID unparsed required non-nil input" if binary_uuid.nil? || binary_uuid.empty?
+    formatted_uuid = " " * 36
+    FFI::UUID.uuid_unparse(binary_uuid, formatted_uuid)
+    formatted_uuid
+  end
+
+  # get a set of uuids - useful for server/backend apps that need a lot
+  # defaults to the :random algorightm
+  # algorithm=:time will switch to the less desirable/secure time based method
+  def self.get_uuids(num=1, algorithm=:random)
+    uuids = Array.new(num) # preallocate to avoid expansion
+    num.times { |i|
+      result = case algorithm
+      when :time
+        generate_time
+      else
+        generate_random
+      end
+      uuids[i-1] = result
+    }
+    uuids
+  end
+end

data/lib/ffi-uuid.rb

@@ -0,0 +1,2 @@
+require 'ffi/ffi_uuid_impl'    # naming to avoid collisions with other uuid implementations
+

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ffi-uuid'
+
+class Test::Unit::TestCase
+end

data/test/test_ffi_uuid.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class TestFfiUuid < Test::Unit::TestCase
+  def test_parse_unparse
+    binary_uuid = " " * 16
+    FFI::UUID.uuid_generate_random(binary_uuid)
+    #puts "binary_uuid: #{binary_uuid.inspect}"
+    unparsed_uuid = " " * 36   # 32 hex chars plus 4 dashes
+    FFI::UUID.uuid_unparse(binary_uuid, unparsed_uuid)  # unparsed is the formatted hex string
+    #puts "unparsed_uuid: #{unparsed_uuid.inspect}"
+    parsed_uuid = ' ' * 16
+    FFI::UUID.uuid_parse(unparsed_uuid, parsed_uuid)  # parsed is the binary version
+    #puts "parsed_uuid: #{parsed_uuid.inspect}"
+    assert_equal( binary_uuid, parsed_uuid)
+  end
+
+  def test_get_uuid
+   unparsed = nil
+   sample_uuid = nil
+   num_uuids = 100000
+   1.times {
+    sample_uuid = FFI::UUID.get_uuids(num_uuids)
+    assert sample_uuid.length == num_uuids
+    assert sample_uuid.is_a?(Array)
+    assert_equal(36, sample_uuid[0].length)
+    
+    unparsed = FFI::UUID.unparse(sample_uuid[0])
+    
+    assert_equal( 36, unparsed.length)
+    assert_equal(unparsed.split(/\-/).length, 5)
+    }
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: ffi-uuid
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Michael Mullis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-04 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 6
+        - 3
+        version: 0.6.3
+  type: :runtime
+  version_requirements: *id001
+description: FFI Wrapper for libuuid with extra helpers for common UUID tasks like getting an array of uuids for quicker distribution
+email: michael@mullistechnologies.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ffi-uuid.gemspec
+- lib/ffi-uuid.rb
+- lib/ffi/ffi_uuid_impl.rb
+- test/helper.rb
+- test/test_ffi_uuid.rb
+has_rdoc: true
+homepage: http://github.com/mmullis/ffi-uuid
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: FFI Wrapper for libuuidm
+test_files: 
+- test/helper.rb
+- test/test_ffi_uuid.rb