uuids 1.0.0.pre.rc1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 716ef7b1e74c7adf9fd9d29302aa0ad0b2ba6c74
-  data.tar.gz: 6086c3c5ece7db6730ef17aa814373789ea03189
+  metadata.gz: 6e1135e09e3a04defaa19436933e9b299a7bb438
+  data.tar.gz: 9243d46849dc1f81e115685880b4e8d8d013b2ad
 SHA512:
-  metadata.gz: bc6c1947993bddd20aae7128f7be6987032bb7018e073a48c841a69ba4208ffdb20b854c2dec71d583a6f95b76ca2b35e944b7567e1050a2210a7946e8cf04af
-  data.tar.gz: 9a663e80d1b08d164eeb9a3ecab76fb5bf3d1051cecb579360bbae7333bf710fa87169d477f829133761012d4694c0665d5bbe555389dec0d9cacc57e3f8e43a
+  metadata.gz: 41349f357ecc392440a79ceb11be07c3aed5b67beef4ea1e0cf519198c9e43ce533bd8ca2afb2055ddd0f57d6e7998b11ce9b92bfa14a1793195e54ab1b7d020
+  data.tar.gz: cb56fc5edcf95f63ce210075db61a5b4e9c9116fe0f75f730b4986b8578afb57515def53f6ed65e6227e633591c85b24fccc60ed3695839dcda8a538d3b15b83

data/README.rdoc

@@ -50,7 +50,7 @@ Now the model of cities should **know nothing about outer models** that use it.
 
 === Translations
 
-Error messages are translated to English and Russian (see `config/locales`).
+Error messages are translated to English and Russian (see <tt>config/locales</tt>).
 Translations to other languages are welcome.
 
 == Installation
@@ -85,7 +85,7 @@ Run from a command line in application root:
 
 == Usage
 
-=== Adding UUIDs identifiers
+=== Adding UUIDs to models
 
 Add the assotiation to your AR model:
 
@@ -114,11 +114,10 @@ The first uuid is added by default. It can also be set manually:
 The destruction of object is forbidden if it has a +uuid+. You should reassign
 all object's UUIDs to another object in advance.
 
-=== Referring model by UUID [TODO]
+=== Referring model by UUID
 
 Instead of <tt>ActiveRecord::Associations</tt> +belongs_to+, +has_one+ and
-+has_many+, you should define custom methods by <tt>ActiveRecord::Relation</tt>
-explicitly.
++has_many+, you should define custom methods explicitly.
 
     class CreateStreetsTable < ActiveRecord::Migration
       def change
@@ -142,32 +141,12 @@ explicitly.
       end
     end
 
-== Uninstallation
-
-To uninstall the module you need to:
-
-* rollback and remove uuid's migration;
-* remove all lines containing <tt>include Uuids::Base</tt>, +has_uuids+ and <tt>by_uuid: true</tt> from any model;
-* remove the gem dependencies from application's +Gemfile+ and gemspec.
-
-=== Rails app
-
-Run from a command line in application root:
-
-    $ rake uuids:uninstall
-
-=== Rails mountable engine
-
-Run from a command line in engine root:
-
-    $ rake app:uuids:uninstall
-
 == Contributing
 
 1. Fork it ( https://github.com/nepalez/uuids/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+2. Create your feature branch (<tt>git checkout -b my-new-feature</tt>)
+3. Commit your changes (<tt>git commit -am 'Add some feature'</tt>)
+4. Push to the branch (<tt>git push origin my-new-feature</tt>)
 5. Create a new Pull Request
 
 == License

data/app/models/uuids/uuid.rb

@@ -2,16 +2,14 @@ module Uuids
 
   # Stores uuids assigned to corresponding records.
   #
-  # == Attributes:
-  #
+  # 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.
   #
-  # == Examples:
-  #
+  # @example
   #     # Create the uuid
   #     uuid = Uuids::Uuid.create! record: some_record
   #
@@ -23,16 +21,17 @@ module Uuids
   #
   class Uuid < ActiveRecord::Base
 
+    # 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}/
+
     attr_readonly  :value
     belongs_to     :record, polymorphic: true
-    validate       :record_present?
-    before_destroy :forbid_destruction
 
-    # Assigns a #value by default.
-    def initialize(*)
-      super
-      write_attribute :value, SecureRandom.uuid
-    end
+    validates :value, format: { with: UUID_FORMAT }, allow_nil: true
+    validate  :record_present?
+
+    before_create  :set_default_value
+    before_destroy :forbid_destruction
 
     private
 
@@ -42,6 +41,11 @@ module Uuids
       errors.add :record, :blank, uuid: value
     end
 
+    # Sets a new value by default
+    def set_default_value
+      self.value = SecureRandom.uuid unless value
+    end
+
     # Forbids destruction of the record.
     def forbid_destruction
       errors.add :base, :destruction_forbidden

data/config/locales/en.yml

@@ -7,4 +7,6 @@ en:
             base:
               destruction_forbidden: "Destruction of UUID is forbidden. Instead of destruction reassign the UUID to another record!"
             record:
-              blank: "Define a record the UUID: %{uuid} is assigned to!"
+              blank: "Define a record the UUID: %{uuid} is assigned to!"
+            value:
+              invalid: "%{value} is not a proper UUID."

data/config/locales/ru.yml

@@ -7,4 +7,6 @@ ru:
             base:
               destruction_forbidden: "Удаление UUID запрещено. Вместо удаления перенаправьте UUID на другую запись!"
             record:
-              blank: "Укажите запись, на которую ссылается UUID: %{uuid}!"
+              blank: "Укажите запись, на которую ссылается UUID: %{uuid}!"
+            value:
+              invalid: "%{value} не является корректным UUID."

data/lib/tasks/uuids_tasks.rake

@@ -4,44 +4,4 @@ namespace :uuids do
   task install: %w(install:migrations) do
     sh "rake db:migrate SCOPE=uuids"
   end
-
-  desc "Uninstalls and removes the uuids gem from a Rails application"
-  task :uninstall do
-    sh "rake db:rollback SCOPE=uuids"
-    remove_gem
-    sh "bundle"
-  end
-
-  def remove_gem
-    say "Removing the 'uuids' gem" do
-      GEMFILE = /gem\s+["|']uuids["|']/
-      GEMSPEC = /_dependency\s+["|']uuids["|']/
-      remove_from_file "Gemfile", GEMFILE
-      Dir["*.gemspec"].each { |file| remove_from_file file, GEMSPEC }
-    end
-  end
-
-  def remove_from_file(name, regex)
-    say_with_time name do
-      temp = File.read(name).split("\n").reject { |line| line[regex] }.join "\n"
-      File.write name, temp
-    end
-  end
-
-  def say(name)
-    print "== #{ name } #{ "=" * (75 - name.count) }\n"
-    yield
-    print "\n"
-  end
-
-  def say_with_time(name)
-    start = seconds
-    print "-- remove from #{ name }\n"
-    yield
-    print "   -> #{ seconds - start }s\n"
-  end
-
-  def seconds
-    Time.now.to_f.round(4)
-  end
 end

data/lib/uuids/base.rb

@@ -4,19 +4,6 @@ module Uuids
   module Base
     extend ActiveSupport::Concern
 
-    # Prevents the module usage outside an ActiveRecord model.
-    #
-    #   class Text < String
-    #     include Uuids::Base
-    #   end
-    #   # => raises a TypeError
-    #
-    def self.included(klass)
-      unless klass.ancestors.include? ActiveRecord::Base
-        fail TypeError.new("#{ klass.name } isn't an ActiveRecord model.")
-      end
-    end
-
     # Methods added to the ActiveRecord model.
     module ClassMethods
 
@@ -24,9 +11,25 @@ module Uuids
 
       # Declares:
       #
-      # * +uuids+ association attribute;
-      # * +uuid+ method (string);
-      # * <tt>uuid</tt> relation scope.
+      # +uuids+:: association attribute;
+      # +uuid+:: method (string);
+      # <tt>uuid</tt>:: relation scope.
+      #
+      # @example
+      #     class City < ActiveRecord::Base
+      #       has_uuids
+      #     end
+      #
+      #     city = City.create!
+      #
+      #     city.uuids.map(&:value)
+      #     # => 51f50391-fcd2-4f69-aab7-6ef31b29c379
+      #
+      #     city.uuid
+      #     # => 51f50391-fcd2-4f69-aab7-6ef31b29c379
+      #
+      #     City.by_uuid("51f50391-fcd2-4f69-aab7-6ef31b29c379").to_a == [city]
+      #     # => true
       #
       def has_uuids
         define_uuids
@@ -49,14 +52,22 @@ module Uuids
 
       # Defines the <tt>uuid</tt> relation scope.
       def define_scope
-        scope :by_uuid, ->(value) {
-          joins(:uuids).where(uuids_uuids: { value: value }).uniq
-        }
+        scope(
+          :by_uuid,
+          ->(value) { joins(:uuids).where(uuids_uuids: { value: value }).uniq }
+        )
       end
     end
 
     private
 
+    # Prevents the module usage outside an ActiveRecord model.
+    def self.included(klass)
+      unless klass.ancestors.include? ActiveRecord::Base
+        fail TypeError.new("#{ klass.name } isn't an ActiveRecord model.")
+      end
+    end
+
     # Creates the uuids by default preventing a record from being ureferrable
     def add_default_uuid
       uuids.present? || uuids.new

data/lib/uuids/version.rb

@@ -2,5 +2,5 @@
 module Uuids
 
   # Current release.
-  VERSION = "1.0.0-rc1"
+  VERSION = "1.0.0"
 end