uid_attribute 0.2.7 → 0.3.0

data/.gitignore

@@ -1,2 +1,8 @@
-rdoc
-coverage
+.*.swp
+*.gem
+.bundle
+coverage/
+coverage.data
+Gemfile.lock
+pkg/*
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+gemspec
+

data/LICENSE

@@ -1,20 +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.
-
+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

@@ -1,37 +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
-
+= 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
+
+ % gem install uid_attribute
+
+== License
+
+Copyright (c) 2010 [Paul Belt], released under the MIT license
+
+== Support
+
+http://github.com/belt/uid_attribute
+

data/Rakefile

@@ -1,42 +1,18 @@
-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
+require 'bundler/gem_tasks'
 
 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'
+  require 'cover_me'
+  namespace :cover_me do
+    desc 'rcov-esque report for ruby-1.9.x'
+    task :report do
+      # we expect this to fail
+      begin
+        Rake::Task['spec'].invoke
+      rescue => e
+      end
+
+      CoverMe.complete!
+    end
   end
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end
+rescue LoadError; end
 

data/doc/UidAttribute.html

@@ -0,0 +1,258 @@
+<?xml version="1.0" encoding="US-ASCII"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=US-ASCII" http-equiv="Content-Type" />
+
+  <title>Module: UIDAttribute</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="module">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/uid_attribute/version_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/uid_attribute/version.rb">lib/uid_attribute/version.rb</a></li>
+          
+            <li><a href="./lib/uid_attribute_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/uid_attribute.rb">lib/uid_attribute.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+
+      
+
+      
+      <!-- Namespace Contents -->
+      <div id="namespace-list-section" class="section">
+        <h3 class="section-header">Namespace</h3>
+        <ul class="link-list">
+          
+          <li><span class="type">MODULE</span> <a href="UIDAttribute/ClassMethods.html">UIDAttribute::ClassMethods</a></li>
+          
+        </ul>
+      </div>
+      
+
+      
+      <!-- Method Quickref -->
+      <div id="method-list-section" class="section">
+        <h3 class="section-header">Methods</h3>
+        <ul class="link-list">
+          
+          <li><a href="#method-i-has_uid_accessors-3F">#has_uid_accessors?</a></li>
+          
+          <li><a href="#method-i-set_uid">#set_uid</a></li>
+          
+        </ul>
+      </div>
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./UIDAttribute.html">UIDAttribute</a></li>
+        
+          <li><a href="./UIDAttribute/ClassMethods.html">UIDAttribute::ClassMethods</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="module">UIDAttribute</h1>
+
+    <div id="description" class="description">
+      
+<p><a href="UIDAttribute.html">UIDAttribute</a> version</p>
+
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+      <!-- Constants -->
+      <div id="constants-list" class="section">
+        <h3 class="section-header">Constants</h3>
+        <dl>
+        
+          <dt><a name="VERSION">VERSION</a></dt>
+          
+          <dd class="description"></dd>
+          
+        
+        </dl>
+      </div>
+      
+
+      
+
+      <!-- Methods -->
+      
+      <div id="public-instance-method-details" class="method-section section">
+        <h3 class="section-header">Public Instance Methods</h3>
+
+      
+        <div id="set_uid-method" class="method-detail ">
+          <a name="method-i-set_uid"></a>
+
+          
+          
+          <div class="method-heading">
+            <span class="method-callseq">set_uid</span>
+            
+            <span class="method-click-advice">click to toggle source</span>
+            
+          </div>
+          
+          
+
+          <div class="method-description">
+            
+            <p>set :uid_attribute</p>
+            
+
+            
+            <div class="method-source-code" id="set_uid-source">
+<pre>
+<span class="ruby-comment"># File lib/uid_attribute.rb, line 61</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_uid</span>
+  <span class="ruby-identifier">klass</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>
+  <span class="ruby-identifier">has_uid_accessors?</span>
+
+  <span class="ruby-identifier">uid</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">uid_object</span> <span class="ruby-operator">?</span>  <span class="ruby-constant">UUIDTools</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID</span>.<span class="ruby-identifier">md5_create</span>(<span class="ruby-constant">UUIDTools</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID_OID_NAMESPACE</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">inspect</span>) <span class="ruby-operator">:</span>
+    <span class="ruby-constant">UUIDTools</span><span class="ruby-operator">::</span><span class="ruby-constant">UUID</span>.<span class="ruby-identifier">random_create</span>.<span class="ruby-identifier">to_s</span>
+
+  <span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{klass.uid_attr}=&quot;</span>, <span class="ruby-identifier">uid</span>)
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- set_uid-source -->
+            
+          </div>
+
+          
+
+          
+        </div><!-- set_uid-method -->
+
+      
+      </div><!-- public-instance-method-details -->
+    
+      <div id="protected-instance-method-details" class="method-section section">
+        <h3 class="section-header">Protected Instance Methods</h3>
+
+      
+        <div id="has_uid_accessors-3F-method" class="method-detail ">
+          <a name="method-i-has_uid_accessors-3F"></a>
+
+          
+          
+          <div class="method-heading">
+            <span class="method-callseq">has_uid_accessors?</span>
+            
+            <span class="method-click-advice">click to toggle source</span>
+            
+          </div>
+          
+          
+
+          <div class="method-description">
+            
+            <p>raises errors unless the including class has a setter and getter for
+Klass.uid_attr</p>
+            
+
+            
+            <div class="method-source-code" id="has_uid_accessors-3F-source">
+<pre>
+<span class="ruby-comment"># File lib/uid_attribute.rb, line 78</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">has_uid_accessors?</span>
+  <span class="ruby-identifier">klass</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>
+  <span class="ruby-identifier">uid_attr</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">uid_attr</span>
+  <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;dev.error: #{klass}.respond_to?(:#{uid_attr}) == false&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">uid_attr</span>)
+  <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;dev.error: #{klass}.respond_to?(:#{uid_attr}=) == false&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-node">&quot;#{uid_attr}=&quot;</span>)
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- has_uid_accessors-3F-source -->
+            
+          </div>
+
+          
+
+          
+        </div><!-- has_uid_accessors-3F-method -->
+
+      
+      </div><!-- protected-instance-method-details -->
+    
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+