uid_attribute 0.2.7 → 0.3.0

data/lib/uid_attribute.rb

@@ -1,57 +1,86 @@
-module UIDAttribute
+require "uid_attribute/version"
 require 'uuidtools'
 
+module UIDAttribute
+
 def self.included( klass ) # :nodoc:
   klass.extend ClassMethods
-  klass.install_uid_attribute
+  klass.send(: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
+    install_uid_attribute_validators(uid_attr)
 
     class_eval("class << self;attr_accessor :uid_attr;attr_accessor :uid_object; end")
-    @uid_attr = uid_attr
     @uid_object = false
+    protected
+    @uid_attr = uid_attr
   end
 
-end
+protected
+
+  def install_uid_attribute #:nodoc:
+    uid_attribute
+  end
+
+  # :call-seq:
+  # install_uid_attribute_validators :uid_attr
+  #
+  # if the including class inherits from ActiveRecord::Base,
+  # then validate Klass.uid_attr is not blank and is unique (within this model)
+
+  def install_uid_attribute_validators(uid_attr) #:nodoc:
+    return unless ancestors.collect{|ancestor|
+      ancestor.to_s }.include?('ActiveRecord::Base')
+    validates_presence_of uid_attr
+    validates_uniqueness_of uid_attr
+  end
+
+end # /class_methods
 
-def initialize(args = {}) # :nodoc:
-  args.empty? ? super() : super(args)
+def initialize(*args) # :nodoc:
+  # hyjack including class initializer to set UID too
+  ret = super(*args)
   set_uid
+  ret
 end
 
 # :call-seq:
 # set_uid
 #
-# This function sets the attribute (as identified by klass.uid_attribute)
+# set :uid_attribute
 
 def set_uid
-  raise "dev.error: #{self.class}.respond_to?(:#{self.class.uid_attr}) == false" unless respond_to?(self.class.uid_attr)
+  klass = self.class
+  has_uid_accessors?
 
-  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
+  uid = klass.uid_object ?  UUIDTools::UUID.md5_create(UUIDTools::UUID_OID_NAMESPACE, self.inspect) :
+    UUIDTools::UUID.random_create.to_s
 
-  send("#{self.class.uid_attr}=", uid)
+  send("#{klass.uid_attr}=", uid)
 end
 
-# /module
+protected
+
+# :call-seq:
+# has_uid_accessors?
+#
+# raises errors unless the including class has a setter and getter for Klass.uid_attr
+
+def has_uid_accessors?
+  klass = self.class
+  uid_attr = klass.uid_attr
+  raise "dev.error: #{klass}.respond_to?(:#{uid_attr}) == false" unless respond_to?(uid_attr)
+  raise "dev.error: #{klass}.respond_to?(:#{uid_attr}=) == false" unless respond_to?("#{uid_attr}=")
 end
 
+end # /module
+

data/lib/uid_attribute/version.rb

@@ -0,0 +1,5 @@
+# UIDAttribute version
+module UIDAttribute
+  VERSION = '0.3.0'
+end
+

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+begin; require 'cover_me'; rescue LoadError; end
+require 'rubygems'
+require 'rspec'
+#require 'rr'
+#require 'spec/rr'  # not updated to rspec-2
+
+begin; require 'database_cleaner'; rescue LoadError; end
+
+# Capybara defaults to XPath selectors rather than Webrat's default of CSS3. In
+# order to ease the transition to Capybara we set the default here. If you'd
+# prefer to use XPath just remove this line and adjust any selectors in your
+# steps to use the XPath syntax.
+# Capybara.default_selector = :css
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :mocha
+end
+

data/spec/uid_attribute_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'uid_attribute'
+require 'ap'
+
+class Model
+  include UIDAttribute
+  attr_accessor :uid
+end
+
+class ModelSpecifyingUID
+  include UIDAttribute
+  uid_attribute :my_uid
+  attr_accessor :my_uid
+end
+
+class ReadOnlyModel
+  include UIDAttribute
+  attr_reader :uid
+end
+
+describe 'uid_attribute' do
+  describe 'generation of a unique ID attribute upon instantiation' do
+    it 'should default to use the :uid attribute of the including class' do
+      @model = Model.new
+      @model.should respond_to(:uid)
+    end
+
+    it 'should allow specification of the :uid attribute by the including class' do
+      @model_specifying_uid = ModelSpecifyingUID.new
+      @model_specifying_uid.should respond_to(:my_uid)
+    end
+
+    it 'should generate a random ID upon instantiation' do
+      @model = Model.new
+      @model.uid.should be_a(String)
+    end
+
+    it 'should optionally generate a MD5-sum (as an :uid) upon instantiation' do
+      @model = Model.new
+      Model.uid_object = true
+      @model.uid = 'seed'
+      checksum = @model.set_uid
+
+      @model.uid = 'seed'
+      @model.set_uid
+      @model.uid.should == checksum
+    end
+
+    context 'should raise an error if the including classes uid_attribute' do
+      it 'does not have a getter' do
+        Model.uid_attr = :test_uid
+        lambda { Model.new }.should raise_error(RuntimeError)
+      end
+
+      it 'does not have a setter' do
+        lambda { ReadOnlyModel.new }.should raise_error(RuntimeError)
+      end
+    end
+  end
+
+  describe 'classes inheritting ActiveRecord' do
+    pending 'should add validations to the including model' do
+      @model = Model.new
+      @model_specifying_uid = ModelSpecifyingUID.new
+      debugger
+      true
+    end
+  end
+
+end
+

data/uid_attribute.gemspec

@@ -1,53 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'uid_attribute/version'
 
 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.name        = 'uid_attribute'
+  s.version     = UIDAttribute::VERSION
+  s.authors     = ['Paul Belt']
+  s.email       = ['paul.belt@gmail.com']
+  s.homepage    = %q{http://github.com/belt/uid_attribute}
+  s.summary     = %q{machina to automatically generate UIDs upon object instantiation}
   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
+  s.rubyforge_project = 'uid_attribute'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ['lib']
 
-    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
+  s.add_development_dependency 'rspec'
+  s.add_runtime_dependency 'uuidtools'
 end
 

metadata

@@ -1,74 +1,117 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: uid_attribute
-version: !ruby/object:Gem::Version 
-  version: 0.2.7
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Paul Belt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-06 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2161449260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2161449260
+- !ruby/object:Gem::Dependency
   name: uuidtools
+  requirement: &2161448840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   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: []
+  prerelease: false
+  version_requirements: *2161448840
+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.
 
-extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
-files: 
+  One method to do this is to use globally unique identifiers within the system to
+  identify any given object.'
+email:
+- paul.belt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
 - .gitignore
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION.yml
+- doc/UidAttribute.html
+- doc/UidAttribute/ClassMethods.html
+- doc/created.rid
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_green.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/quicksearch.js
+- doc/js/thickbox-compressed.js
+- doc/lib/uid_attribute/version_rb.html
+- doc/lib/uid_attribute_rb.html
+- doc/rdoc.css
 - lib/uid_attribute.rb
-- test/uid_attribute_test.rb
+- lib/uid_attribute/version.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/uid_attribute_spec.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: 
+rdoc_options: []
+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: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: uid_attribute
-rubygems_version: 1.3.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: machina to automatically generate UUIDs upon object instantiation.
-test_files: 
-- test/uid_attribute_test.rb
+summary: machina to automatically generate UIDs upon object instantiation
+test_files: []