uuids 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fa4c647a7c49ca3c8dc977ef4eecdb8c98d8c65
-  data.tar.gz: 5ef6df5ecc81765ed887afb31ee8c9c76f065930
+  metadata.gz: 151323a9f9d9d1d1e2f0f852ca8dc3008d845022
+  data.tar.gz: b6b1d36f0697890239eb7d68f31f807fdb314fbf
 SHA512:
-  metadata.gz: e5a8eb30e3fb60615ad8ed955a9978519e73c3aefbb5db98413228fdcdc64f40d6d74d33ed7c35fb7e8c51854fdf38bdd39929dbc942bc3094816b153c0b1ebe
-  data.tar.gz: 581d68f4bc69eb48b28050f746cc744d89493b6cb156706cbf536767269ec1a16965ffcf37e665ffef58de4a55f73393cd6e43618e74b1aeb08e43f3b0cccbc1
+  metadata.gz: 864757381a06c18c1c0eeaa7883199fdf24a9873747aa9a0c736dd0a744a093f7a88a06b797f07f8a82d16405ec571ed00a7f1270a2c2962944e000be0a0b645
+  data.tar.gz: aa74d786fb783b687e07d201491a4788d60ab8aeb8357738abef2c674687259274557e05452f9594931bf3949d5a4ed0210ecfdbd0ce5a3dff2a2ad204e8a96e

data/README.rdoc

@@ -77,32 +77,42 @@ Or install it yourself as:
 
     $ gem install uuids
 
-Then run from a command line in application root:
+=== Rails application
+
+Run from a command line in application root:
 
     $ rake uuids:install
 
+This will copy gem migrations to a `db/migrate` folder and run it.
+
+=== Rails mountable engine
+
+Run from a command line in application root:
+
+    $ rake app:uuids:install
+
+This will copy gem migrations to a `spec/dummy/db/migrate` folder and run it.
+
 == Usage
 
 Add the assotiation to your AR model:
 
     class YourModel < ActiveRecord::Base
-      has_many :uuids, class_name: "Uuids::Uuid", as: :record, dependent: :destroy
-      ...
-    end
-
-Note the <tt>dependent: :destroy</tt> condition! It prevents a record from
-destruction before a corresponding uuids reassigned to another record.
 
-Then add a callback for uuid creation:
+      # declares the association
+      has_many :uuids, class_name: "Uuids::Uuid", as: :record, dependent: :destroy
 
-    class YourModel < ActiveRecord::Base
-      ...
-      # create the uuid by default
+      # auto-generates uuid by default
       before_create -> { uuids.new }
-      ...
+
+      # prevents the record from being unreferable
+      validates :uuids, presence: true, unless: :destroy
     end
 
-Now you can add reference to your model via uuid:
+**Note** the <tt>dependent: :destroy</tt> condition! It requires all uuids
+to be reassigned before destruction.
+
+Now you can refer to your model via uuid:
 
     class CreateAnotherModelTable < ActiveRecord::Migration
       def change
@@ -116,20 +126,35 @@ Now you can add reference to your model via uuid:
     class AnotherModel < ActiveRecord::Base
 
       def your_model
-        @your_model ||= YourModel.join(:uuids).where(uuids: { value: your_model_uuid }).first
+        @your_model ||= YourModel.join(:uuids)
+          .where(uuids_uuids: { value: your_model_uuid }).first
       end
 
-      def your_model=(value)
-        @your_model_uuid ||= Uuids::Uuid.find_by_record(value)
+      def your_model=(record)
+        @your_model_uuid ||= Uuids::Uuid.find_by_record(record).try(:value)
       end
     end
 
 == Uninstallation
 
+=== Rails app
+
 Run from a command line in application root:
 
     $ rake uuids:uninstall
 
+This will rollback and remove migration from `db/migrate` folder and then
+remove the gem dependencies from application's +Gemfile+ and gemspec.
+
+=== Rails mountable engine
+
+Run from a command line in engine root:
+
+    $ rake app:uuids:uninstall
+
+This will rollback and remove migration from `spec/dummy/db/migrate` folder and
+then remove the gem dependencies from engine's +Gemfile+ and gemspec.
+
 == Contributing
 
 1. Fork it ( https://github.com/nepalez/uuids/fork )

data/Rakefile

@@ -37,5 +37,6 @@ end
 task full: [:default] do
   sh "rubocop"
   sh "metric_fu"
-  sh "inch"
+  sh "rails_best_practices"
+  sh "inch --pedantic"
 end

data/app/models/uuids/uuid.rb

@@ -23,6 +23,7 @@ module Uuids
   #
   class Uuid < ActiveRecord::Base
 
+    attr_readonly  :value
     belongs_to     :record, polymorphic: true
     validate       :record_present?
     before_destroy :forbid_destruction
@@ -35,9 +36,6 @@ module Uuids
 
     private
 
-    # Disables value assignment.
-    attr_writer :value
-
     # Validates record presence with a custom error message.
     def record_present?
       return if record

data/lib/tasks/uuids_tasks.rake

@@ -8,13 +8,17 @@ namespace :uuids do
   desc "Uninstalls and removes the uuids gem from a Rails application"
   task :uninstall do
     sh "rake db:rollback SCOPE=uuids"
-    say do
+    remove_gem
+    sh "bundle"
+  end
+
+  def remove_gem
+    say "Removing the 'uuids' gem" do
       remove_from_file "Gemfile", /gem\s+["|']uuids["|']/
       Dir["*.gemspec"].each do |gemspec|
         remove_from_file gemspec, /_dependency\s+["|']uuids["|']/
       end
     end
-    sh "bundle"
   end
 
   def remove_from_file(name, regex)
@@ -25,17 +29,20 @@ namespace :uuids do
     end
   end
 
-  def say
-    print "== Removing the 'uuids' gem" \
-          " ===================================================\n"
+  def say(name)
+    print "== #{ name } #{ "=" * (75 - name.count) }\n"
     yield
     print "\n"
   end
 
   def say_with_time(name)
-    start = Time.now.to_f
+    start = seconds
     print "-- remove from #{ name }\n"
     yield
-    print "   -> #{ (Time.now.to_f - start).round(4) }s\n"
+    print "   -> #{ seconds - start }s\n"
+  end
+
+  def seconds
+    Time.now.to_f.round(4)
   end
 end

data/lib/uuids/version.rb

@@ -1,4 +1,6 @@
-# Current release.
+# Namespace for a module
 module Uuids
-  VERSION = "0.0.1"
+
+  # Current release.
+  VERSION = "0.1.0"
 end