uuids 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c89b99f654c1dfea64b0eb20b53e29c43a23e5b6
-  data.tar.gz: 8248163a5e3b377d0b2d28953d95a12f035e0747
+  metadata.gz: ab2fee573db51b09e456f46051b38e4a4bb191a9
+  data.tar.gz: 86a0819f977fb1866d60c286bffda28d090285c5
 SHA512:
-  metadata.gz: 9c138b109db21234ff97829e1116a542257100dfeec619009edca64e9d33c88b215dd87139aab5a1a852d8b3b2514e5c82ec2db6db26d632d96e379696e3d15e
-  data.tar.gz: ec574018240a64d28ccb52018f1d91a16a62c71767eb4cbb8318b149337a698059c0bd2fdc45962db94b6fcbd5997d835b775cefe3147f5cc51cca2e869647ed
+  metadata.gz: 360f89779357fc89de36f625aac37ea2f8d16516e981f3428f92fe49574c43b11b2982769a02403630e9a18e1abf2f501d8c10e6d87330d819006a698757b2cc
+  data.tar.gz: d88f464eeb0923ea24a0405f4aa4a45b4630beaea14ab14afdbff61817d29aaa53a80dd703418ee091c632e366ca7db10a52e43693dc77bc2d2e390ee7a06b1e

data/README.rdoc

@@ -98,8 +98,8 @@ This will add methods:
 
 +#uuids+:: List of <tt>Uuids::Uuid</tt> objects referred to the record.
 +#uuid+:: main UUID for the record - a value of the first +uuids+ (ordered by value).
-+#uuid=(value):: assigns the UUID (an alias for <tt>#uuids.new value: value</tt>).
-<tt>.by_uuid</tt>:: A scope for unique records by UUID: <tt>City.by_uuid</tt>.
+<tt>#uuid=(value)</tt>:: assigns the UUID (an alias for <tt>#uuids.new value: value</tt>).
+<tt>.by_uuid(*values)</tt>:: A scope for selecting unique records by UUID.
 
 The first uuid is added by default. It can also be set manually:
     

data/Rakefile

@@ -29,14 +29,16 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new :spec
-task default: %w(app:uuids:test:prepare) do
-  sh "bundle exec rspec spec"
+
+task :default do
+  system "rake db:migrate RAILS_ENV=test"
+  system "bundle exec rspec spec"
 end
 
-task :full do
-  sh "coveralls report"
-  sh "rubocop"
-  sh "metric_fu"
-  sh "rails_best_practices"
-  sh "inch --pedantic"
+task :check do
+  system "coveralls report"
+  system "rubocop"
+  system "metric_fu"
+  system "inch --pedantic"
+  system "rails_best_practices"
 end

data/lib/tasks/uuids/install.rake

@@ -0,0 +1,9 @@
+namespace :uuids do
+
+  desc "Installs the uuids gem inside a Rails application or Rails engine."
+  task install: :environment do
+    app = Rake::Task.task_defined?("railties:install:migrations") ? "" : "app:"
+    Rake::Task["#{ app }railties:install:migrations"].reenable
+    system "rake #{ app }uuids:install:migrations"
+  end
+end

data/lib/uuids/base/has_uuids.rb

@@ -0,0 +1,100 @@
+module Uuids
+  module Base
+
+    # Defines custom methods to be defined by `has_uuids` method.
+    module HasUuids
+      extend ActiveSupport::Concern
+
+      # Model scopes.
+      module ClassMethods
+
+        # Selects distinct records by uuids (relation scope).
+        #
+        # @example
+        #
+        #     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 string uuids values to select records by.
+        #
+        # Returns the <tt>ActiveRecord::Relation</tt> object.
+        #
+        def by_uuid(*values)
+          first_value = values.first
+          list = first_value.is_a?(Array) ? first_value : values
+          joins(:uuids).where(uuids_uuids: { value: list }).uniq
+        end
+      end
+
+      # 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"
+      #
+      def uuid
+        uuids.map(&:value).sort.first
+      end
+
+      # 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.
+      #
+      def uuid=(value)
+        uuids.new value: value
+      end
+
+      # 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.
+      #
+      def uuids=(*values)
+        first_value = values.first
+        list        = first_value.is_a?(Array) ? first_value : values
+        list.each { |value| self.uuid = value }
+      end
+
+      private
+
+      # 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 reassigned to
+      # other records.
+      def prevent_destruction
+        return true if uuids.blank?
+        errors.add :base, :uuids_present
+        false
+      end
+    end
+  end
+end

data/lib/uuids/base.rb

@@ -1,3 +1,5 @@
+require_relative "base/has_uuids"
+
 module Uuids
 
   # Creates required `#uuids` attribute of the ActiveRecord model.
@@ -13,8 +15,8 @@ module Uuids
       #
       # +uuids+:: association attribute.
       # +uuid+:: method (string).
-      # <tt>uuid=</tt>:: new uuid's value assignment.
-      #                  An alias for <tt>#uuids.new value: value</tt>
+      # <tt>uuid=</tt>:: new uuid value assignment.
+      # <tt>uuids=</tt>:: a list of uuids values assignment.
       # <tt>uuid</tt>:: relation scope.
       #
       # @example
@@ -32,48 +34,21 @@ module Uuids
       #
       #     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
       #
       def has_uuids
-        define_uuids
-        define_uuid_getter
-        define_uuid_setter
-        define_scope
-      end
-
-      # Defines the +uuids+ association attribute;
-      def define_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
         validates :uuids, presence: true, on: :update
       end
-
-      # Defines the +uuid+ method
-      def define_uuid_getter
-        class_eval "def uuid; uuids.map(&:value).sort.first; end"
-      end
-
-      # Defines the <tt>uuid=</tt> method
-      def define_uuid_setter
-        class_eval "def uuid=(value); uuids.new value: value; end"
-      end
-
-      # Defines the <tt>uuid</tt> relation scope.
-      def define_scope
-        scope(
-          :by_uuid,
-          ->(*list) {
-            if list.first.is_a? Array
-              warn "[DEPRECATION] use a list of values, not an array" \
-                   " in .by_uuid(*values) method."
-              list = list.first
-            end
-            joins(:uuids).where(uuids_uuids: { value: list }).uniq
-          }
-        )
-      end
     end
 
     private
@@ -84,17 +59,5 @@ module Uuids
         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
-    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 = "1.2.0"
+  VERSION = "1.3.0"
 end