with_uuid 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb9642c8c8bb5bf5889dc9484c0474ddec605305
+  data.tar.gz: 649122cc58a2d70e333f864f09eda84735a4d0ac
+SHA512:
+  metadata.gz: d5dd1ad095df47e61c6c688506a94ae59b8db614fdd2602d9762b29829e196a5664dddd73e80ce45b2825c283bd12df626bb19db24935f5e486e4a55f3951a35
+  data.tar.gz: e1185f43899ed56948be28b333bac1ef0b44aece1e2e464b18b571e16fb26187afa088933f39a38384f6e28aa33713ee27950d99a00cc046953e56523657628f

data/.gitignore

@@ -0,0 +1,15 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+gemdev

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in has_uuid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Harrelson
+
+MIT License
+
+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.md

@@ -0,0 +1,36 @@
+# HasUuid
+
+Provides facilities to utilize UUIDs with ActiveRecord, including model and migration extensions.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has_uuid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_uuid
+
+
+## Usage
+
+In a migration:
+
+    create_table "comments", :id => false, :force => true do |t|
+      t.uuid     "id",      :primary_key => true 
+      t.uuid     "post_id",                       :null => false
+    end
+
+In a model:
+
+    class Posts < ActiveRecord::Base
+      include WithUuid::Model
+
+      # ...
+    end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/schema_dumper.rb

@@ -0,0 +1,131 @@
+module ActiveRecord
+  # = Active Record Schema Dumper
+  #
+  # This class is used to dump the database schema for some connection to some
+  # output format (i.e., ActiveRecord::Schema).
+  class SchemaDumper #:nodoc:
+    private
+
+      def uuid_sql_types
+        [
+          'varchar(36)',
+          'uniqueidentifier'
+        ]
+      end
+
+      def table(table, stream)
+        columns = @connection.columns(table)
+        begin
+          tbl = StringIO.new
+
+          # first dump primary key column
+          pk = nil
+          if @connection.respond_to?(:pk_and_sequence_for)
+            pk, _ = @connection.pk_and_sequence_for(table)
+          end
+          if @connection.respond_to?(:primary_key) && pk.nil?
+            pk = @connection.primary_key(table)
+          end
+
+          tbl.print "  create_table #{remove_prefix_and_suffix(table).inspect}"
+          if pk_col = columns.detect { |c| c.name == pk }
+            if pk != 'id'
+              tbl.print %Q(, :primary_key => "#{pk}")
+            end
+            if uuid_sql_types.include?( pk_col.sql_type  )
+              tbl.print ", :id => false"
+            end
+          else
+            tbl.print ", :id => false"
+          end
+          tbl.print ", :force => true"
+          tbl.puts " do |t|"
+
+          # then dump all non-primary key columns
+          column_specs = columns.map do |column|
+            raise StandardError, "Unknown type '#{column.sql_type}' for column '#{column.name}'" if @types[column.type].nil?
+            next if column.name == pk
+            spec = {}
+            spec[:name]      = column.name.inspect
+
+            #debugger if column.name.include?( 'id' )
+            # AR has an optimization which handles zero-scale decimals as integers. This
+            # code ensures that the dumper still dumps the column as a decimal.
+            spec[:type]      = if column.type == :integer && [/^numeric/, /^decimal/].any? { |e| e.match(column.sql_type) }
+                                 'decimal'
+                               elsif uuid_sql_types.include?( column.sql_type  ) && !column.primary
+                                 'uuid'
+                               else
+                                 column.type.to_s
+                               end
+            unless spec[:type] == 'uuid'
+              spec[:limit]     = column.limit.inspect if column.limit != @types[column.type][:limit] && spec[:type] != 'decimal'
+              spec[:precision] = column.precision.inspect if column.precision
+              spec[:scale]     = column.scale.inspect if column.scale
+              spec[:default]   = default_string(column.default) if column.has_default?
+            end
+            spec[:null]      = 'false' unless column.null
+            (spec.keys - [:name, :type]).each{ |k| spec[k].insert(0, "#{k.inspect} => ")}
+            spec
+          end.compact
+
+          # add PK column spec if UUID
+          if pk_col && uuid_sql_types.include?( pk_col.sql_type )
+            pk_spec = {}
+            pk_spec[:name]      = pk_col.name.inspect
+
+            pk_spec[:type]      = if uuid_sql_types.include?( pk_col.sql_type  )
+                                    'uuid'
+                                  else
+                                    pk_col.type.to_s
+                                  end
+
+            pk_spec[:primary_key] = 'true'
+            pk_spec[:null]      = 'false' unless pk_col.null
+            pk_spec[:default]   = default_string(pk_col.default) if pk_col.has_default?
+            (pk_spec.keys - [:name, :type]).each{ |k| pk_spec[k].insert(0, "#{k.inspect} => ")}
+            column_specs.insert( 0, pk_spec )
+          end
+
+          # find all migration keys used in this table
+          keys = [:name, :limit, :precision, :scale, :default, :null, :primary_key] & column_specs.map{ |k| k.keys }.flatten
+
+          # figure out the lengths for each column based on above keys
+          lengths = keys.map{ |key| column_specs.map{ |spec| spec[key] ? spec[key].length + 2 : 0 }.max }
+
+          # the string we're going to sprintf our values against, with standardized column widths
+          format_string = lengths.map{ |len| "%-#{len}s" }
+
+          # find the max length for the 'type' column, which is special
+          type_length = column_specs.map{ |column| column[:type].length }.max
+
+          # add column type definition to our format string
+          format_string.unshift "    t.%-#{type_length}s "
+
+          format_string *= ''
+
+          column_specs.each do |colspec|
+            values = keys.zip(lengths).map{ |key, len| colspec.key?(key) ? colspec[key] + ", " : " " * len }
+            values.unshift colspec[:type]
+            tbl.print((format_string % values).gsub(/,\s*$/, ''))
+            tbl.puts
+          end
+
+          tbl.puts "  end"
+          tbl.puts
+
+          indexes(table, tbl)
+
+          tbl.rewind
+          stream.print tbl.read
+        rescue => e
+          stream.puts "# Could not dump table #{table.inspect} because of following #{e.class}"
+          stream.puts "#   #{e.message}"
+          stream.puts
+        end
+
+        stream
+      end
+
+  end
+end

data/lib/with_uuid/comb_uuid.rb

@@ -0,0 +1,63 @@
+module WithUuid
+  class CombUuid
+
+    def initialize( uuid_str )
+      @uuid_str = uuid_str
+    end
+
+    def to_s
+      uuid_str
+    end
+
+    def parts
+      @parts ||= @uuid_str.split( '-' )
+    end
+
+    def []( idx )
+      parts[idx]
+    end
+
+    def first
+      parts[0]
+    end
+
+    def last
+      parts[4]
+    end
+
+    def self.uuid
+      # See:
+      #   http://stackoverflow.com/questions/7747145/is-comb-guid-a-good-idea-with-rails-3-1-if-i-use-guids-for-primary-keys
+      #   http://www.codeproject.com/Articles/32597/Performance-Comparison-Identity-x-NewId-x-NewSeque
+
+      # MS SQL syntax: SELECT CAST(CAST(NEWID() AS BINARY(10)) + CAST(GETDATE() AS BINARY(6)) AS UNIQUEIDENTIFIER)
+
+      # Get current Time object
+      utc_timestamp = Time.now.utc
+
+      # Convert to integer with milliseconds:  (Seconds since Epoch * 1000) + (6-digit microsecond fraction / 1000)
+      utc_timestamp_with_ms_int = (utc_timestamp.tv_sec * 1000) + (utc_timestamp.tv_usec / 1000)
+
+      # Format as hex, minimum of 12 digits, with leading zero.  Note that 12 hex digits handles to year 10889 (*).
+      utc_timestamp_with_ms_hexstring = "%012x" % utc_timestamp_with_ms_int
+
+      # If we supply UUIDTOOLS with a MAC address, it will use that rather than retrieving from system.
+      # Use a regular expression to split into array, then insert ":" characters so it "looks" like a MAC address.
+      UUIDTools::UUID.mac_address = (utc_timestamp_with_ms_hexstring.scan( /.{2}/ )).join(":")
+
+      # Generate Version 1 UUID (see RFC 4122).
+      uuid_str = UUIDTools::UUID.timestamp_create().to_s.upcase
+
+      # (*) A note on maximum time handled by 6-byte timestamp that includes milliseconds:
+      # If utc_timestamp_with_ms_hexstring = "FFFFFFFFFFFF" (12 F's), then
+      # Time.at(Float(utc_timestamp_with_ms_hexstring.hex)/1000).utc.iso8601(10) = "10889-08-02T05:31:50.6550292968Z".
+
+      self.new( uuid_str )
+    end
+
+  protected
+
+    attr_reader :uuid_str
+
+  end
+end

data/lib/with_uuid/extensions/migrations.rb

@@ -0,0 +1,30 @@
+require 'active_record'
+
+module WithUuid
+  module Extensions
+
+    module Migrations
+
+      def uuid(*column_names)
+        options = column_names.extract_options!
+        column_names.each do |name|
+          type = case(@base.adapter_name.downcase)
+                 when 'sqlserver'
+                   'uniqueidentifier'
+                 when 'postgresql'
+                   'uuid'
+                 else
+                   'varchar(36)'
+                 end
+          column(name, "#{type}#{' PRIMARY KEY' if options.delete(:primary_key)}", options)
+        end
+      end
+
+      def uuid_fk(*column_names)
+        uuid( *column_names )
+      end
+
+    end
+
+  end
+end

data/lib/with_uuid/extensions.rb

@@ -0,0 +1,16 @@
+module WithUuid
+  module Extensions
+
+    autoload :Migrations, 'with_uuid/extensions/migrations'
+
+    def self.apply!
+      if defined? ActiveRecord::ConnectionAdapters::Table
+        ActiveRecord::ConnectionAdapters::Table.send :include, WithUuid::Extensions::Migrations
+      end
+      if defined? ActiveRecord::ConnectionAdapters::TableDefinition
+        ActiveRecord::ConnectionAdapters::TableDefinition.send :include, WithUuid::Extensions::Migrations
+      end
+    end
+
+  end
+end

data/lib/with_uuid/model.rb

@@ -0,0 +1,24 @@
+require "active_support/concern"
+
+module WithUuid
+  module Model
+
+	  extend ActiveSupport::Concern
+
+	  included do
+
+      self.primary_key = :id
+
+	    before_validation :set_id
+
+	  end
+
+    def set_id
+      return unless id.blank?
+
+      # Assign generated COMBination GUID to #id
+      write_attribute( :id, WithUuid::CombUuid.uuid.to_s )
+    end
+
+  end
+end

data/lib/with_uuid/railtie.rb

@@ -0,0 +1,12 @@
+require 'with_uuid'
+require 'rails'
+
+module WithUuid
+  class Railtie < Rails::Railtie
+    railtie_name :with_uuid
+
+    config.to_prepare do
+      WithUuid::Extensions.apply!
+    end
+  end
+end

data/lib/with_uuid/version.rb

@@ -0,0 +1,3 @@
+module WithUuid
+  VERSION = "0.1.2"
+end

data/lib/with_uuid.rb

@@ -0,0 +1,12 @@
+require 'with_uuid/railtie' if defined?(Rails::Railtie)
+require "with_uuid/version"
+require 'schema_dumper'
+require 'uuidtools'
+
+module WithUuid
+
+  autoload :CombUuid,   'with_uuid/comb_uuid'
+  autoload :Extensions, 'with_uuid/extensions'
+  autoload :Model,      'with_uuid/model'
+
+end

data/with_uuid.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'with_uuid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "with_uuid"
+  spec.version       = WithUuid::VERSION
+  spec.authors       = ["Jason Harrelson"]
+  spec.email         = ["cjharrelson@iberon.com"]
+  spec.description   = %q{Provides facilities to utilize UUIDs with ActiveRecord, including model and migration extensions.}
+  spec.summary       = %q{Provides facilities to utilize UUIDs with ActiveRecord.}
+  spec.homepage      = "https://github.com/midas/with_uuid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  #spec.add_development_dependency "database_cleaner"
+  #spec.add_development_dependency "forgery"
+  #spec.add_development_dependency "fabrication"
+  #spec.add_development_dependency "sqlite3"
+  #spec.add_development_dependency "pg"
+  #spec.add_development_dependency "mysql2"
+
+  spec.add_runtime_dependency "uuidtools"
+  spec.add_runtime_dependency "activerecord", '>= 3.1'
+  spec.add_runtime_dependency "activesupport", '>= 3.1'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: with_uuid
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Jason Harrelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Provides facilities to utilize UUIDs with ActiveRecord, including model
+  and migration extensions.
+email:
+- cjharrelson@iberon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/schema_dumper.rb
+- lib/with_uuid.rb
+- lib/with_uuid/comb_uuid.rb
+- lib/with_uuid/extensions.rb
+- lib/with_uuid/extensions/migrations.rb
+- lib/with_uuid/model.rb
+- lib/with_uuid/railtie.rb
+- lib/with_uuid/version.rb
+- with_uuid.gemspec
+homepage: https://github.com/midas/with_uuid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Provides facilities to utilize UUIDs with ActiveRecord.
+test_files: []