uid_attribute 0.2.7

data/.gitignore

@@ -0,0 +1,2 @@
+rdoc
+coverage

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [Paul Belt]
+
+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,37 @@
+= UidAttribute -- Globally Unique Identifiable Attributes
+
+machina to automatically generate UUIDs upon object instantiation.
+
+
+== Example
+
+  require File.join(File.dirname(__FILE__),'lib','uid_attribute')
+
+  class MyObject
+    include UIDAttribute
+
+    attr_accessor :uid
+    uid_attribute :uid  # this is optional e.g. to change the UID attribute
+  end
+
+  puts MyObject.new.uid
+  # => 4981a86e-239c-45dd-b4b3-283c435fb8ad
+
+== Use case
+
+Some projects are confined by regulations (or requirements) that demand data can not be used to identify individuals. In such cases data must be scrubbed i.e. identifiable object names must be removed before unauthorized users can see said data. For example, when a developer needs to recreate a bug on their own system that was reported by a customer using customer-specific data.
+
+One method to do this is to use globally unique identifiers within the system to identify any given object.
+
+== Installation
+
+ % script/plugin install git://github.com/belt/uid_attribute.git
+
+== License
+
+Copyright (c) 2010 [Paul Belt], released under the MIT license
+
+== Support
+
+http://github.com/belt/uid_attribute
+

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the uid_attribute plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the uid_attribute plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UidAttribute'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'uid_attribute'
+    gemspec.summary = 'machina to automatically generate UUIDs upon object instantiation.'
+    gemspec.description = "Some projects are confined by regulations (or requirements) that demand data can not be used to identify individuals. In such cases data must be scrubbed i.e. identifiable object names must be removed before unauthorized users can see said data. For example, when a developer needs to recreate a bug on their own system that was reported by a customer using customer-specific data.\n\nOne method to do this is to use globally unique identifiers within the system to identify any given object."
+    gemspec.email = 'Paul Belt'
+    gemspec.authors = ['Paul Belt']
+    gemspec.homepage = 'http://github.com/belt/uid_attribute'
+    gemspec.extra_rdoc_files = ['README.rdoc']
+    gemspec.rdoc_options = ['--charset=UTF-8']
+    gemspec.add_dependency('uuidtools', '>= 2.1.1')
+    gemspec.rubyforge_project = 'uid_attribute'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/VERSION.yml

@@ -0,0 +1,5 @@
+---
+:minor: 2
+:patch: 7
+:build:
+:major: 0

data/lib/uid_attribute.rb

@@ -0,0 +1,57 @@
+module UIDAttribute
+require 'uuidtools'
+
+def self.included( klass ) # :nodoc:
+  klass.extend ClassMethods
+  klass.install_uid_attribute
+end
+
+module ClassMethods
+  include UUIDTools
+
+  def install_uid_attribute #:nodoc:
+    uid_attribute
+  end
+
+  # :call-seq:
+  # uid_attribute
+  #
+  # This function defines the UID attribute for the klass <tt>(default: :uid)</tt>
+
+  def uid_attribute(uid_attr = :uid)
+    if ancestors.include?('ActiveRecord::Base')
+      validates_uniqueness_of uid_attr
+    end
+
+    class_eval("class << self;attr_accessor :uid_attr;attr_accessor :uid_object; end")
+    @uid_attr = uid_attr
+    @uid_object = false
+  end
+
+end
+
+def initialize(args = {}) # :nodoc:
+  args.empty? ? super() : super(args)
+  set_uid
+end
+
+# :call-seq:
+# set_uid
+#
+# This function sets the attribute (as identified by klass.uid_attribute)
+
+def set_uid
+  raise "dev.error: #{self.class}.respond_to?(:#{self.class.uid_attr}) == false" unless respond_to?(self.class.uid_attr)
+
+  if self.class.uid_object
+    uid = UUIDTools::UUID.md5_create(UUIDTools::UUID_OID_NAMESPACE, "#{self.inspect}")
+  else
+    uid = UUIDTools::UUID.random_create.to_s
+  end
+
+  send("#{self.class.uid_attr}=", uid)
+end
+
+# /module
+end
+

data/test/uid_attribute_test.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'test/unit'
+require File.join(File.dirname(__FILE__),'..','lib','uid_attribute')
+
+class Model
+  include UIDAttribute
+  attr_accessor :uid
+end
+
+class UidAttribueTest < Test::Unit::TestCase
+  def setup
+    @model = Model.new
+    assert @model.class.uid_attr
+  end
+
+  def test_uid_attr
+    assert !@model.send(@model.class.uid_attr).nil?
+  end
+
+  def test_object_uid_attr
+    Model.uid_object = true
+    assert !@model.send(@model.class.uid_attr).nil?
+  end
+end
+

data/uid_attribute.gemspec

@@ -0,0 +1,53 @@
+# 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{uid_attribute}
+  s.version = "0.2.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Belt"]
+  s.date = %q{2010-05-06}
+  s.description = %q{Some projects are confined by regulations (or requirements) that demand data can not be used to identify individuals. In such cases data must be scrubbed i.e. identifiable object names must be removed before unauthorized users can see said data. For example, when a developer needs to recreate a bug on their own system that was reported by a customer using customer-specific data.
+
+One method to do this is to use globally unique identifiers within the system to identify any given object.}
+  s.email = %q{Paul Belt}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/uid_attribute.rb",
+     "test/uid_attribute_test.rb",
+     "uid_attribute.gemspec"
+  ]
+  s.homepage = %q{http://github.com/belt/uid_attribute}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{uid_attribute}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{machina to automatically generate UUIDs upon object instantiation.}
+  s.test_files = [
+    "test/uid_attribute_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<uuidtools>, [">= 2.1.1"])
+    else
+      s.add_dependency(%q<uuidtools>, [">= 2.1.1"])
+    end
+  else
+    s.add_dependency(%q<uuidtools>, [">= 2.1.1"])
+  end
+end
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: uid_attribute
+version: !ruby/object:Gem::Version 
+  version: 0.2.7
+platform: ruby
+authors: 
+- Paul Belt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-06 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.1
+    version: 
+description: |-
+  Some projects are confined by regulations (or requirements) that demand data can not be used to identify individuals. In such cases data must be scrubbed i.e. identifiable object names must be removed before unauthorized users can see said data. For example, when a developer needs to recreate a bug on their own system that was reported by a customer using customer-specific data.
+  
+  One method to do this is to use globally unique identifiers within the system to identify any given object.
+email: Paul Belt
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/uid_attribute.rb
+- test/uid_attribute_test.rb
+- uid_attribute.gemspec
+has_rdoc: true
+homepage: http://github.com/belt/uid_attribute
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: uid_attribute
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: machina to automatically generate UUIDs upon object instantiation.
+test_files: 
+- test/uid_attribute_test.rb