uuids 1.4.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b59630d1254cf17915e3a7b7beb44845dd1812f
-  data.tar.gz: 9eb598e421669103dcbf1c227e71e0ce5a5b775a
+  metadata.gz: 47eac9c29e60c9923b3ccc38491475e2090447f4
+  data.tar.gz: da49a4fb5fe1cac362c92521d2a5a79691f97a2a
 SHA512:
-  metadata.gz: e8c87ee98ad9b849aa557e1da0b42fb1da5b699dfce7e3039bdc448c0b2fda9884865b233d79b37f79a008ce33b2b71540bbb276c8b352e0999d14c6588c8ed3
-  data.tar.gz: 5c94540825bcbf75fc55890c4ac28c1d5dfac97e41050de8e11a60796b4c4e82bf3b3431d7f1e93b7d7f6af7a713b7dd1ab4e420daf2fcb617c5e0f6b5a43f23
+  metadata.gz: f8fd6392d538cb0b819b1d3a54e691b180a60b50f85142cd69b855f3b471782b794eadbd5aeace541ee0b69b866e88f2f0a495047f0bd48462aca24afc59db6c
+  data.tar.gz: c9823e9694e4b849ee54f78b64aa96804830d43d0963c887dbd5b3c3a2db8987f301dda4c18f71b8381b999b15b9a670723ead18703c8db475b91aa91059fd1e

data/app/models/uuids/uuid.rb

@@ -1,38 +1,40 @@
 module Uuids
 
-  # Stores uuids assigned to corresponding records.
-  #
-  # Attributes:
-  # +value+:: A value of uuid as defined in
-  #           {RFC4122}[http://www.ietf.org/rfc/rfc4122.txt].
-  #           Assigned by default on creation. Cannot be set or edited manually.
-  # +record+:: An AR record the uuid is assigned to.
-  #            Required attribute. Can be changed.
+  # The model describes uuids assigned to corresponding records.
+  # @see http://www.ietf.org/rfc/rfc4122.txt RFC4122 standard.
+  # @see https://en.wikipedia.org/wiki/Universally_unique_identifier Wikipedia
+  # article.
   #
   # @example
-  #     # Create the uuid
-  #     uuid = Uuids::Uuid.create! record: some_record
+  #   # Creates the uuid
+  #   uuid = Uuids::Uuid.create! record: some_record
   #
-  #     # Find a record by uuid
-  #     Uuid.find_by_value(uuid.value).record # => some_record
+  #   # Finds a record by uuid
+  #   Uuid.find_by_value(uuid.value).record # => some_record
   #
-  #     # Reassigns a uuid to another record
-  #     uuid.update_attributes! record: another_record
+  #   # Reassigns a uuid to another record
+  #   uuid.update_attributes! record: another_record
   #
   class Uuid < ActiveRecord::Base
     self.table_name = :uuids_uuids
 
-    # A format for UUID following RFC4122
-    UUID_FORMAT = /[a-z\d]{8}-[a-z\d]{4}-[a-z\d]{4}-[a-z\d]{4}-[a-z\d]{12}/
+    # @!attribute [r] value
+    # Assigned by default on creation. Cannot be set or edited manually.
+    # @return [String] uuid value as defined in RFC4122.
+
+    UUID = /[a-z\d]{8}-[a-z\d]{4}-[a-z\d]{4}-[a-z\d]{4}-[a-z\d]{12}/
+    attr_readonly :value
+    validates :value, format: { with: UUID }, allow_nil: true
 
-    attr_readonly  :value
-    belongs_to     :record, polymorphic: true
+    # @!attribute record
+    # @return [ActiveRecord::Base] an object the uuid is assigned to.
 
-    validates :value, format: { with: UUID_FORMAT }, allow_nil: true
-    validate  :record_present?
+    belongs_to :record, polymorphic: true
+    validate   :record_present?
 
-    before_create  :set_default_value
-    before_destroy :forbid_destruction
+    # Callbacks
+    after_initialize :set_default_value
+    before_destroy   :forbid_destruction
 
     private
 

data/bin/uuids

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require "active_record_install"
 
+# Initializes the 'uuids' gem inside application.
 ActiveRecordInstall::Generator.start(
   [File.expand_path("../..", __FILE__), "uuids"] + ARGV[1..-1]
 )

data/db/migrate/20141016112506_create_uuids_uuids.rb

@@ -1,3 +1,6 @@
+# encoding: utf-8
+
+# Creates a table for the Uuids::Uuid model of uuids.
 class CreateUuidsUuids < ActiveRecord::Migration
   def change
     create_table :uuids_uuids do |t|

data/lib/uuids/base/has_uuids.rb

@@ -1,7 +1,7 @@
 module Uuids
   module Base
 
-    # Defines custom methods to be defined by `has_uuids` method.
+    # Defines methods to be added by the +has_uuids+ class helper.
     module HasUuids
       extend ActiveSupport::Concern
 
@@ -10,25 +10,20 @@ module Uuids
 
         # Selects records by uuid.
         #
-        #     by_uuid(*values)
-        #
         # @example
+        #   class MyRecord < ActiveRecord::Base
+        #     include Uuids::Base
+        #     has_uuids
+        #   end
         #
-        #     class MyRecord < ActiveRecord::Base
-        #       include Uuids::Base
-        #       has_uuids
-        #     end
-        #
-        #     MyRecord.by_uuid(
-        #       "23423fe3-28d8-a1e5-bde3-2e08074aa92d",
-        #       "9223238d-a7e3-2d36-a93d-1e50fea02de2"
-        #     )
-        #     # => #<ActiveRecord::Relation ...>
-        #
-        # Params:
-        # <tt>*values</tt>:: a list of uuids to select records by.
+        #   MyRecord.by_uuid(
+        #     "23423fe3-28d8-a1e5-bde3-2e08074aa92d",
+        #     "9223238d-a7e3-2d36-a93d-1e50fea02de2"
+        #   )
+        #   # => #<ActiveRecord::Relation ...>
         #
-        # Returns an <tt>ActiveRecord::Relation</tt> scope.
+        # @param  values [Array<String>] a list of uuids to select records by.
+        # @return [ActiveRecord::Relation] scope.
         def by_uuid(*values)
           first_value = values.first
           list = first_value.is_a?(Array) ? first_value : values
@@ -39,10 +34,11 @@ module Uuids
       # Returns the first UUID (sorted as a string) for the record.
       #
       # @example
-      #     record.uuids.new value: "23423fe3-28d8-a1e5-bde3-2e08074aa92d"
-      #     record.uuids.new value: "9223238d-a7e3-2d36-a93d-1e50fea02de2"
-      #     record.uuid # => "23423fe3-28d8-a1e5-bde3-2e08074aa92d"
+      #   record.uuids.new value: "23423fe3-28d8-a1e5-bde3-2e08074aa92d"
+      #   record.uuids.new value: "9223238d-a7e3-2d36-a93d-1e50fea02de2"
+      #   record.uuid # => "23423fe3-28d8-a1e5-bde3-2e08074aa92d"
       #
+      # @return [String] first value of the record's uuids.
       def uuid
         uuids.map(&:value).sort.first
       end
@@ -50,12 +46,11 @@ module Uuids
       # Assigns a new uuid to the record.
       #
       # @example
-      #     record.uuid = "23423fe3-28d8-a1e5-bde3-2e08074aa92d"
-      #     record.uuid # => "23423fe3-28d8-a1e5-bde3-2e08074aa92d"
-      #
-      # Params:
-      # <tt>value</tt>:: a string value of uuid to assign.
+      #   record.uuid = "23423fe3-28d8-a1e5-bde3-2e08074aa92d"
+      #   record.uuid # => "23423fe3-28d8-a1e5-bde3-2e08074aa92d"
       #
+      # @param  value [String] a value of uuid to assign.
+      # @return object
       def uuid=(value)
         uuids.new value: value
       end
@@ -63,19 +58,18 @@ module Uuids
       # Assigns a list of new uuids to the record.
       #
       # @example
-      #     record.uuids = [
-      #       "23423fe3-28d8-a1e5-bde3-2e08074aa92d",
-      #       "9223238d-a7e3-2d36-a93d-1e50fea02de2"
-      #     ]
-      #     record.uuids.map(&:value)
-      #     # => [
-      #       "23423fe3-28d8-a1e5-bde3-2e08074aa92d",
-      #       "9223238d-a7e3-2d36-a93d-1e50fea02de2"
-      #     ]
-      #
-      # Params:
-      # <tt>values</tt>:: an array of uuids string values to assign.
+      #   record.uuids = [
+      #     "23423fe3-28d8-a1e5-bde3-2e08074aa92d",
+      #     "9223238d-a7e3-2d36-a93d-1e50fea02de2"
+      #   ]
+      #   record.uuids.map(&:value)
+      #   # => [
+      #     "23423fe3-28d8-a1e5-bde3-2e08074aa92d",
+      #     "9223238d-a7e3-2d36-a93d-1e50fea02de2"
+      #   ]
       #
+      # @param  values [Array<String>] an array of uuids string values to assign
+      # @return object.
       def uuids=(*values)
         first = values.first
         list  = first.is_a?(Array) ? first : values
@@ -84,12 +78,12 @@ module Uuids
 
       private
 
-      # Creates the uuids by default preventing a record from being ureferrable.
+      # Creates the uuid value by default.
       def add_default_uuid
         uuids.present? || uuids.new
       end
 
-      # Prevents destruction of a record before its uuids reassigned to
+      # Prevents destruction of a record before its uuids are reassigned to
       # other records.
       def prevent_destruction
         return true if uuids.blank?

data/lib/uuids/base.rb

@@ -2,7 +2,7 @@ require_relative "base/has_uuids"
 
 module Uuids
 
-  # Creates required `#uuids` attribute of the ActiveRecord model.
+  # Defines the +has_uuids+ model class helper.
   module Base
     extend ActiveSupport::Concern
 
@@ -11,42 +11,41 @@ module Uuids
 
       private
 
-      # Declares:
+      # The helper defines:
       #
-      # +uuids+:: association attribute.
-      # +uuid+:: method (string).
-      # <tt>uuid=</tt>:: new uuid value assignment.
-      # <tt>uuids=</tt>:: a list of uuids values assignment.
-      # <tt>uuid</tt>:: relation scope.
+      # +uuids+:: the +ActiveRecord+ association with a record's uuids.
+      # +uuid+:: a virtual attribute that returns the first value of uuids.
+      # <tt>uuid=</tt>:: new uuid setter.
+      # <tt>uuids=</tt>:: uuids group setter.
+      # <tt>by_uuid</tt>:: the +ActiveRecord+ relation scope.
       #
       # @example
-      #     class City < ActiveRecord::Base
-      #       has_uuids
-      #     end
+      #   class City < ActiveRecord::Base
+      #     has_uuids
+      #   end
       #
-      #     city = City.create!
+      #   city = City.create!
       #
-      #     city.uuids.map(&:value)
-      #     # => 51f50391-fcd2-4f69-aab7-6ef31b29c379
+      #   city.uuids.map(&:value)
+      #   # => 51f50391-fcd2-4f69-aab7-6ef31b29c379
       #
-      #     city.uuid
-      #     # => 51f50391-fcd2-4f69-aab7-6ef31b29c379
+      #   city.uuid
+      #   # => 51f50391-fcd2-4f69-aab7-6ef31b29c379
       #
-      #     city.uuid = "51f50391-fcd2-4f69-aab7-6ef31b29c379"
+      #   city.uuid = "51f50391-fcd2-4f69-aab7-6ef31b29c379"
       #
-      #     city.uuids = [
-      #       "51f50391-fcd2-4f69-aab7-6ef31b29c379",
-      #       "3ea8fd89-232f-4ed1-90b5-743da173cd7d"
-      #     ]
-      #
-      #     City.by_uuid("51f50391-fcd2-4f69-aab7-6ef31b29c379").to_a == [city]
-      #     # => true
+      #   city.uuids = [
+      #     "51f50391-fcd2-4f69-aab7-6ef31b29c379",
+      #     "3ea8fd89-232f-4ed1-90b5-743da173cd7d"
+      #   ]
       #
+      #   City.by_uuid("51f50391-fcd2-4f69-aab7-6ef31b29c379").to_a == [city]
+      #   # => true
       def has_uuids
         has_many :uuids, class_name: "Uuids::Uuid", as: :record, validate: false
         include Uuids::Base::HasUuids
-        before_create  :add_default_uuid
-        before_destroy :prevent_destruction
+        after_initialize :add_default_uuid
+        before_destroy   :prevent_destruction
         validates :uuids, presence: true, on: :update
       end
     end

data/lib/uuids/version.rb

@@ -1,5 +1,5 @@
 module Uuids
 
   # Current release.
-  VERSION = "1.4.2"
+  VERSION = "2.0.0"
 end

data/lib/uuids.rb

@@ -3,11 +3,11 @@ require "active_record"
 require "i18n"
 require "securerandom"
 
-# `uuids` gem content.
+# The +uuids+ gem content.
 root = File.expand_path "../..", __FILE__
 Dir[File.join(root, "lib/uuids/**/*.rb")].each { |f| require f }
 Dir[File.join(root, "app/**/*.rb")].each { |f| require f }
 
-# Namespace for `uuids` gem code.
+# Namespace for the +uuids+ gem code.
 module Uuids
 end

data/spec/app/models/uuids/uuid_spec.rb

@@ -15,7 +15,6 @@ module Uuids
       end
 
       it "assigned by default" do
-        subject.save!
         expect(subject.value).not_to be_blank
       end
     end

data/spec/lib/uuids/base_spec.rb

@@ -45,17 +45,14 @@ module Uuids
 
       it "defines the #uuid= method" do
         value = "3ea8fd89-232f-4ed1-90b5-743da173cd7d"
-        expect { subject.uuid = value }.to change { subject.uuids.map(&:value) }
-          .to [value]
+        subject.uuid = value
+        expect(subject.uuids.map(&:value)).to be_include(value)
       end
 
       it "defines the #uuids= method" do
-        values = [
-          "3ea8fd89-232f-4ed1-90b5-743da173cd7d",
-          "4ea8fd89-232f-4ed1-90b5-743da173cd7d"
-        ]
-        expect { subject.uuids = values }
-          .to change { subject.uuids.map(&:value) }.to values
+        value = "3ea8fd89-232f-4ed1-90b5-743da173cd7d"
+        subject.uuids = [value]
+        expect(subject.uuids.map(&:value)).to be_include(value)
       end
 
       it "defines +by_uuid+ class scope" do
@@ -66,7 +63,6 @@ module Uuids
       end
 
       it "creates the first uuid by default" do
-        subject.save!
         expect(subject.uuid).not_to be_blank
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uuids
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
+date: 2014-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord