uuids 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 151323a9f9d9d1d1e2f0f852ca8dc3008d845022
-  data.tar.gz: b6b1d36f0697890239eb7d68f31f807fdb314fbf
+  metadata.gz: 5e74d457a60d98ff3a145f6a6a1833f2075983af
+  data.tar.gz: 6ff0c0939c243ef4648edb145a5d6f5b3b9cab3b
 SHA512:
-  metadata.gz: 864757381a06c18c1c0eeaa7883199fdf24a9873747aa9a0c736dd0a744a093f7a88a06b797f07f8a82d16405ec571ed00a7f1270a2c2962944e000be0a0b645
-  data.tar.gz: aa74d786fb783b687e07d201491a4788d60ab8aeb8357738abef2c674687259274557e05452f9594931bf3949d5a4ed0210ecfdbd0ce5a3dff2a2ad204e8a96e
+  metadata.gz: 8d4b2414ae87ce041c34248cb76c4e382072d2e20f5e1b54c86a884b5cb488bc703acf02220a8012fb8f3bb080dac55801a779147c67cd73567375ee182016fa
+  data.tar.gz: 168e82b3e79766a35e814ccb6660f35d4a82d277a8a9a23030936099faa4aa4c631a748beceadb5f72766dd1293b2c50662f2f9b4729106634faf645aabd8499

data/README.rdoc

@@ -16,6 +16,11 @@ identified by many uuids.
 
 The gem is a {mountable Rails engine}[http://guides.rubyonrails.org/engines.html#generating-an-engine].
 
+The gem provides:
+
+<tt>Uuids::Uuid</tt>:: A model of UUIDs associated with various records.
+<tt>Uuids::Base</tt>:: A module to be included to AR model to provide required +#uuids+ attribute.
+
 === Pattern
 
 This model allows refering records by some uuid (not the id).
@@ -52,12 +57,6 @@ The Uuid is generated authomatically following the
 This allows keeping all uuids in one model and referring to any record whatever
 type it has.
 
-=== Models
-
-A model <tt>Uuids::Uuid</tt> has two attributes: +value+ and +record+.
-Only the +record+ can (and must) be set and changed.
-The readonly +value+ (the uuid itself) is assigned by default.
-
 === Translations
 
 Error messages are translated to English and Russian (see `config/locales`).
@@ -100,17 +99,23 @@ Add the assotiation to your AR model:
     class YourModel < ActiveRecord::Base
 
       # declares the association
-      has_many :uuids, class_name: "Uuids::Uuid", as: :record, dependent: :destroy
+      has_many :uuids, class_name: "Uuids::Uuid", as: :record, validate: false
 
       # auto-generates uuid by default
-      before_create -> { uuids.new }
+      before_create  -> { uuids.present? || uuids.new }
 
       # prevents the record from being unreferable
-      validates :uuids, presence: true, unless: :destroy
+      validates :uuids, presence: true, on: :update
+
+      # prevents a record destruction before its uuids reassigned to another one
+      before_destroy -> { uuids.blank? }
     end
 
-**Note** the <tt>dependent: :destroy</tt> condition! It requires all uuids
-to be reassigned before destruction.
+Instead of above you can simply include the Uuids::Base module:
+
+    class YourModel < ActiveRecord::Base
+      include Uuids::Base
+    end
 
 Now you can refer to your model via uuid:
 
@@ -169,7 +174,7 @@ Redefine AR::Base class methods +has_one+ and +has_many+ to allow reference
 by uuid:
 
     class MyModel < ActiveRecord::Base
-      extend Uuids
+      include Uuids::Associations
 
       has_one :another_model, uuid: true
     end

data/Rakefile

@@ -34,7 +34,8 @@ task :default do
   sh "bundle exec rspec spec"
 end
 
-task full: [:default] do
+task :full do
+  sh "coveralls report"
   sh "rubocop"
   sh "metric_fu"
   sh "rails_best_practices"

data/lib/uuids/base.rb

@@ -0,0 +1,36 @@
+module Uuids
+
+  # Creates required `#uuids` attribute of the ActiveRecord model.
+  module Base
+
+    def self.included(klass)
+      fail unless klass.ancestors.include? ActiveRecord::Base
+
+      klass.has_many :uuids, uuids_params
+
+      klass.before_create  :add_default_uuid
+      klass.before_destroy :prevent_destruction
+
+      klass.validates :uuids, presence: true, on: :update
+    end
+
+    private
+
+    # Parameters for uuid associations
+    def self.uuids_params
+      { class_name: "Uuids::Uuid", as: :record, validate: false }
+    end
+
+    # Creates the uuids by default preventing a record from being ureferrable
+    def add_default_uuid
+      uuids.present? || uuids.new
+    end
+
+    # Prevents destruction of a record before its uuids assigned to another one
+    def prevent_destruction
+      return true if uuids.blank?
+      errors.add :base, :uuids_present
+      false
+    end
+  end
+end

data/lib/uuids/version.rb

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

data/lib/uuids.rb

@@ -1,6 +1,7 @@
 require "rails"
 require "securerandom"
 require "uuids/engine"
+require "uuids/base"
 
 # Namespace for a module
 module Uuids

data/spec/dummy/app/models/item.rb

@@ -0,0 +1,4 @@
+require "uuids"
+
+class Item < ActiveRecord::Base
+end

data/spec/dummy/db/migrate/20141017081115_create_items.rb

@@ -0,0 +1,8 @@
+class CreateItems < ActiveRecord::Migration
+  def change
+    create_table :items do |t|
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,12 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20141016113016) do
+ActiveRecord::Schema.define(version: 20141017081115) do
+
+  create_table "items", force: true do |t|
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
 
   create_table "records", force: true do |t|
     t.datetime "created_at"