sets_uuid 0.1.1 → 1.0.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+1.0.0 :: Switching to simple_uuid gem (because it is... simpler, and
+    does not use a file for persisting state)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Emmanuel Oga
+Copyright (c) 2009, 2010 Emmanuel Oga
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -2,14 +2,16 @@
 
 Allows you to declaratively initialize UUID columns in your ActiveRecords.
 
-class MyModel < ActiveRecord::Base
+  class MyModel < ActiveRecord::Base
+    sets_uuid :before_create, :guid => :compact
+  end
 
-  sets_uuid :before_create, :guid => :compact
+  m = MyModel.create!
+  m.guid # => "a80cca5469254331a2f7df23da2b837f"
 
-end
-
-m = MyModel.create!
-m.guid # => "a80cca54-6925-4331-a2f7-df23da2b837f"
+This gem requires the simple_uuid gem. The reason I picked this library instead
+of the classic uuid gem is because the later does not use a state file, which I
+find annoying in some situations.
 
 == Note on Patches/Pull Requests
 

data/Rakefile

@@ -1,26 +1,49 @@
-require 'rubygems'
 require 'rake'
+require 'date'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "sets_uuid"
-    gem.summary = %Q{Adds declarative uuid attribute initialization to models}
-    gem.description = %Q{UUID management for models}
-    gem.email = "EmmanuelOga@gmail.com"
-    gem.homepage = "http://github.com/EmmanuelOga/sets_uuid"
-    gem.authors = ["Emmanuel Oga"]
-    gem.add_development_dependency "rspec"
-    gem.add_dependency "uuid"
-    gem.add_dependency "activerecord"
-    # 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: sudo gem install jeweler"
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
 end
 
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
 require 'spec/rake/spectask'
+
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.spec_files = FileList['spec/**/*_spec.rb']
@@ -32,20 +55,88 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :spec => :check_dependencies
-
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
   end
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push --tags"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "sets_uuid #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
 end

data/lib/sets_uuid.rb

@@ -1,17 +1,16 @@
 module SetsUUID
+  VERSION = "1.0.0"
+
   module ClassMethods
 
     # Call it on ActiveRecord class definition body:
     #
     # sets_uuid :before_create, :attribute_name => :uuid_format.
     #
-    # uuid_format is one of the formats available from uuid gem:
-    # :compact, :urn, :default.
-    #
-    # Inspect UUID::FORMATS for the complete list.
+    # uuid_format is one of :compact, :default.
     #
     def sets_uuid(callback_name, attributes_and_formats_hash)
-      require 'uuid'
+      require 'simple_uuid'
 
       raise ArgumentError, "attributes_and_formats_hash does not act as a Hash!" unless attributes_and_formats_hash.respond_to?(:each)
 
@@ -19,7 +18,13 @@ module SetsUUID
 
         meth = "__generate_uuid_for_#{ attribute }".intern
 
-        define_method(meth) { write_attribute(attribute, UUID.new.generate(format)) }
+        if format == :compact
+          implementation = proc { write_attribute(attribute, SimpleUUID::UUID.new.to_guid.gsub(/-/, "")) }
+        else
+          implementation = proc { write_attribute(attribute, SimpleUUID::UUID.new.to_guid) }
+        end
+
+        include(Module.new { define_method(meth, &implementation) })
 
         send(callback_name, meth)
       end

data/sets_uuid.gemspec

@@ -1,60 +1,42 @@
-# 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{sets_uuid}
-  s.version = "0.1.1"
-
+  s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Emmanuel Oga"]
-  s.date = %q{2009-12-06}
-  s.description = %q{UUID management for models}
-  s.email = %q{EmmanuelOga@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/sets_uuid.rb",
-     "sets_uuid.gemspec",
-     "spec/sets_uuid_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/EmmanuelOga/sets_uuid}
+  s.rubygems_version = '1.3.5'
+
+  s.name              = 'sets_uuid'
+  s.version           = '1.0.0'
+  s.date              = '2010-07-27'
+  s.rubyforge_project = 'sets_uuid'
+
+  s.summary = %q{UUID management for models}
+  s.description = %q{Adds declarative uuid attribute initialization to models}
+
+  s.authors  = ["Emmanuel Oga"]
+  s.email    = 'EmmanuelOga@gmail.com'
+  s.homepage = 'http://github.com/emmanueloga'
+
+  s.require_paths = %w[lib]
+
   s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Adds declarative uuid attribute initialization to models}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/sets_uuid_spec.rb"
+  s.extra_rdoc_files = %w[README.rdoc LICENSE]
+
+  s.add_dependency('simple_uuid', [">= 0.1.1"])
+  s.add_dependency('activerecord', [">= 2.0.0"])
+
+  s.add_development_dependency('rspec', [">= 1.1.0", "< 2.0.0"])
+
+  # = MANIFEST =
+  s.files = %w[
+    CHANGELOG
+    LICENSE
+    README.rdoc
+    Rakefile
+    lib/sets_uuid.rb
+    sets_uuid.gemspec
+    spec/sets_uuid_spec.rb
+    spec/spec_helper.rb
   ]
+  # = MANIFEST =
 
-  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_development_dependency(%q<rspec>, [">= 0"])
-      s.add_runtime_dependency(%q<uuid>, [">= 0"])
-      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<uuid>, [">= 0"])
-      s.add_dependency(%q<activerecord>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<uuid>, [">= 0"])
-    s.add_dependency(%q<activerecord>, [">= 0"])
-  end
+  s.test_files = s.files.select { |path| path =~ /^spec\// }
 end
-

data/spec/sets_uuid_spec.rb

@@ -1,38 +1,46 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 class Thing < ActiveRecord::Base
-  sets_uuid :before_validation, :a => :compact
-  sets_uuid :before_create, :b => :default
+  sets_uuid :before_validation, :compact => :compact
+  sets_uuid :before_create, :default => :default
 end
 
 describe "SetsUuid" do
-  it "should be able to create new things" do
-    lambda { Thing.create! :a => "1", :b => "2", :c => "3" }.should_not raise_error
+  it "does not interfere with things creation" do
+    expect { Thing.create!(:some_field => "42") }.to_not raise_error
   end
 
-  it "should be able to set the UUID before validation" do
-    a = Thing.new
-    a.a.should be_blank
-    a.b.should be_blank
-    a.c.should be_blank
+  it "can create compact and default uuids" do
+    thing = Thing.create
+    thing.compact.should_not =~ /-/
+    thing.default.should =~ /-/
+  end
+
+  it "sets the UUID before validation" do
+    thing = Thing.new
 
-    a.valid?
+    thing.compact.should be_blank
+    thing.default.should be_blank
+    thing.some_field.should be_blank
 
-    a.a.should_not be_blank
-    a.b.should be_blank
-    a.c.should be_blank
+    thing.valid?
+
+    thing.compact.should_not be_blank
+    thing.default.should be_blank
+    thing.some_field.should be_blank
   end
 
-  it "should be able to set the UUID before creation" do
-    a = Thing.new
-    a.a.should be_blank
-    a.b.should be_blank
-    a.c.should be_blank
+  it "sets the UUID before creation" do
+    thing = Thing.new
+
+    thing.compact.should be_blank
+    thing.default.should be_blank
+    thing.some_field.should be_blank
 
-    a.save!
+    thing.save!
 
-    a.a.should_not be_blank
-    a.b.should_not be_blank
-    a.c.should be_blank
+    thing.compact.should_not be_blank
+    thing.default.should_not be_blank
+    thing.some_field.should be_blank
   end
 end

data/spec/spec_helper.rb

@@ -1,21 +1,18 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
-require 'spec'
-require 'spec/autorun'
-require 'logger'
 require 'rubygems'
 require 'activerecord'
+require 'spec/autorun'
 
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'sets_uuid'
 
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
 
+# require 'logger'
 # ActiveRecord::Base.logger = Logger.new(STDOUT)
 
 ActiveRecord::Schema.define do
   create_table "things" do |t|
-    t.string :a, :b, :c
+    t.string :compact, :default, :some_field
   end
 end
 

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sets_uuid
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Emmanuel Oga
@@ -9,61 +15,85 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-06 00:00:00 -03:00
+date: 2010-07-27 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: simple_uuid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: uuid
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: activerecord
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: UUID management for models
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id003
+description: Adds declarative uuid attribute initialization to models
 email: EmmanuelOga@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - README.rdoc
+- LICENSE
 files: 
-- .document
-- .gitignore
+- CHANGELOG
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - lib/sets_uuid.rb
 - sets_uuid.gemspec
 - spec/sets_uuid_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/EmmanuelOga/sets_uuid
+homepage: http://github.com/emmanueloga
 licenses: []
 
 post_install_message: 
@@ -72,24 +102,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubyforge_project: sets_uuid
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 3
-summary: Adds declarative uuid attribute initialization to models
+specification_version: 2
+summary: UUID management for models
 test_files: 
-- spec/spec_helper.rb
 - spec/sets_uuid_spec.rb
+- spec/spec_helper.rb

data/.document

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

data/.gitignore

@@ -1,5 +0,0 @@
-*.sw?
-.DS_Store
-coverage
-rdoc
-pkg

data/VERSION

@@ -1 +0,0 @@
-0.1.1