uuids 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfc2367f33f47dad9657d2967ce4b748e250d74d
-  data.tar.gz: 65bdc11b1153c8a642d8db7cf955551d40f30598
+  metadata.gz: 99ef18c3631191192674065383bde357d99af73f
+  data.tar.gz: 30e4d290b12cc1a08492356202ad9c3391ab839a
 SHA512:
-  metadata.gz: 3727f692aa29305a27f71e6f4a014cecd51f44994093d8045582e69a15124e6a366122a66d135e1536d294ae7ec8a94652b259a0a6045e84a70a49bff85e082b
-  data.tar.gz: b84266c8b36f76e2540c7706dc31656606c1eb61dbfbc9fc1eeb3a5e149e69e9b6d65ef9ee7d1080fbb1f696fb3ac9aebcd950695cbc19a91908818bf2043e8f
+  metadata.gz: 09ba36da96395129310604992a3d8121e520041b251a468d8ebebb559332f9d0e2924308489b6e1ce83a36d6e1b626feaa2ddf4d6842569d345a05e933a980c0
+  data.tar.gz: d9f9fa8fe03b4d4b17ee72d72b7797013eb719525d3a2f7091338515667adaa22d065950f9702f0306256bc325ad71f4444eec3d6de29c765ac536d46408d7bb

data/README.rdoc

@@ -91,7 +91,7 @@ Add the assotiation to your AR model with a `has_uuids` helper:
 
 This will add methods:
 
-+#uuids+:: List of <tt>Uuids::Uuid</tt> objects referred to the record.
++#uuids+:: List of <tt>Uuids::Models::Uuid</tt> objects referred to the record.
 <tt>#uuid=(value)</tt>:: assigns the UUID (an alias for <tt>#uuids.new value: value</tt>).
 +#uuid+:: main UUID for the record - a value of the first +uuids+ (ordered by value).
 <tt>.by_uuid(*values)</tt>:: A scope for selecting unique records by UUID.
@@ -136,7 +136,40 @@ Instead of <tt>ActiveRecord::Associations</tt> +belongs_to+, +has_one+ and
       end
 
       def city=(city)
-        read_attribute :city_uuid, city.uuid
+        write_attribute :city_uuid, city.uuid
+      end
+    end
+
+=== Adding uuid
+
+The module also contains the service object +Add+:
+
+    service = Uuids::Services::Add.new(
+      value: "43523547-8230-5723-0457-234057254725",
+      record: #<ActiveRecord::Base ... >
+    )
+    service.subscribe listener
+    service.run
+
+Depending on the result of creation, the listener will receive either the
+<tt>:created, uuid, messages</tt> or <tt>:error, messages</tt> notification.
+
+The service doesn't know what the record is. In the success message it
+will be referred as the record "with id: %{id}".
+To provide more concise messaging, the service should be reloaded with a
+new <tt>name</tt> method.
+
+    module Users
+      module Services
+        class AddUuid < Uuids::Services::Add
+          private
+          def name
+            # It is expected the record is a user, that responds to full_name.
+            # Not the success message will be something near:
+            # "The uuid ... has been added to the record Иван Иванов."
+            record.full_name
+          end
+        end
       end
     end
 

data/app/models/uuid.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+module Uuids
+
+  # The module contains ActiveRecord based models.
+  module Models
+
+    # 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
+    #   # Creates the uuid
+    #   uuid = Uuids::Models::Uuid.create! 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
+    #
+    class Uuid < ActiveRecord::Base
+      self.table_name = :uuids_uuids
+
+      # @!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
+
+      # @!attribute record
+      # @return [ActiveRecord::Base] an object the uuid is assigned to.
+
+      belongs_to :record, polymorphic: true
+      validate   :record_present?
+
+      # Callbacks
+      after_initialize :set_default_value
+      before_destroy   :forbid_destruction
+
+      private
+
+      # Validates record presence with a custom error message.
+      def record_present?
+        return if record
+        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
+        false
+      end
+    end
+  end
+end

data/app/queries/by_uuid.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+
+module Uuids
+
+  # @api hide
+  # Contains complex queries to be used in model scopes.
+  module Queries
+
+    # @api hide
+    # The query selects records by uuids.
+    #
+    # @example Selects records by an array of uuids
+    #   ByUuid.select(
+    #     MyModel,
+    #     [
+    #       "20547204-3875-0234-7d52-437523057235",
+    #       "04702362-355e-9237-5e32-da2057054720"
+    #     ]
+    #   )
+    #
+    # @example Selects records by a list of uuids
+    #   ByUuid.select(
+    #     MyModel,
+    #     "20547204-3875-0234-7d52-437523057235",
+    #     "04702362-355e-9237-5e32-da2057054720"
+    #   )
+    #
+    # @example Selects all records when no values given
+    #   result =  ByUuid.select MyModel
+    #   result == MyModel.all # => true
+    class ByUuid < Hexx::Scope
+
+      # @api hide
+      # Initializes the query object.
+      # @param [ActiveRecord::Base, #uuids] model The model for selecting
+      #   records of.
+      # @param [Array<String>, nil] values The values to select records by.
+      def initialize(model, *values)
+        super(model)
+        @values = values.flatten
+      end
+
+      # @api hide
+      # Runs and returns the query.
+      def select
+        values.any? ? by_uuid : model.all
+      end
+
+      private
+
+      attr_reader :values
+
+      def by_uuid
+        model.joins(:uuids).where(uuids_uuids: { value: values }).uniq
+      end
+    end
+  end
+end

data/app/services/add.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+module Uuids
+
+  # The module contains services for managing uuids.
+  #
+  # Any service implements the Observer pattern using the 'wisper' gem.
+  # This means a service doesn't return results to its caller, but calls
+  # a corresponding methods of its subscribers ("notifies subscribers").
+  #
+  # @see http://en.wikipedia.org/wiki/Observer_pattern Observer pattern.
+  # @see http://github.com/krisleech/wisper the Wisper gem.
+  module Services
+
+    # Adds the uuid to the record.
+    #
+    # @example
+    #   service = Uuids::Services::Add.new(
+    #     record: #<ActiveRecord::Base ...>,
+    #     value:  "42037503-2753-0570-3257-230403275325",
+    #   )
+    #   service.subscribe some_listener
+    #   service.run
+    class Add < Hexx::Service
+
+      # @!scope class
+      # @!method new(params)
+      # Constructs the service object.
+      # @example (see Uuids::Services::Add)
+      # @param [Hash] params The list of service options.
+      # @option params [ActiveRecord::Base] :record The record for adding uuid.
+      # @option params [String] :value The uuid to be added to the record.
+      allow_params :record, :value
+
+      # @!method subscribe(listener, options = {})
+      # Subscribes a listener to receive the service's notifications.
+      # @example (see Uuids::Services::Add)
+      # @param [Object] listener Any object can be subscribed as a listener.
+      #   It is expected (but not required) the listener to respond to
+      #   notifications, published by the {#run}.
+      # @param [Hash] options The subscription options.
+      # @option options [Symbol] :prefix (nil) The prefix to be added
+      #   to notifications to provide valid listener method names to call.
+
+      # Runs the service and publishes its results.
+      # @example (see Uuids::Services::Add)
+      # @change Creates the uuid assigned to the record.
+      # @publish created(uuid,messages) when the uuid has been created.
+      # @publish error(messages) when the uuid cannot be created.
+      def run
+        create_uuid
+      end
+
+      private
+
+      attr_reader :uuid
+
+      def create_uuid
+        escape do
+          @uuid = Models::Uuid.create! record: record, value: value
+          on_uuid_created
+        end
+      end
+
+      def on_uuid_created
+        add_message "success", :created, uuid: uuid, record: name
+        publish :created, uuid, messages
+      end
+
+      def name
+        t :record, id: record.id
+      end
+    end
+  end
+end

data/config/initializers/i18.rb

@@ -0,0 +1,3 @@
+# Configures i18n paths
+Dir[File.expand_path("../../locales/**/*.yml", __FILE__)]
+  .each { |file| I18n.load_path << file }

data/config/locales/services/add/en.yml

@@ -0,0 +1,8 @@
+---
+en:
+  activemodel:
+    messages:
+      models:
+        uuids/services/add:
+          created: "The uuid %{uuid} has been added to the record %{record}."
+          record: "with id %{id}"

data/config/locales/services/add/ru.yml

@@ -0,0 +1,8 @@
+---
+ru:
+  activemodel:
+    messages:
+      models:
+        uuids/services/add:
+          created: "Добавлен uuid %{uuid} к записи %{record}."
+          record: "с id %{id}"

data/db/migrate/20141016112506_create_uuids_uuids.rb

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

data/lib/uuids/base/has_uuids.rb

@@ -8,27 +8,29 @@ module Uuids
       # Model scopes.
       module ClassMethods
 
-        # Selects records by uuid.
+        # Selects records by uuid(s).
         #
-        # @example
-        #   class MyRecord < ActiveRecord::Base
+        # @example Selects records by a list of uuids
+        #   class MyModel < ActiveRecord::Base
         #     include Uuids::Base
         #     has_uuids
         #   end
         #
-        #   MyRecord.by_uuid(
+        #   MyModel.by_uuid(
         #     "23423fe3-28d8-a1e5-bde3-2e08074aa92d",
         #     "9223238d-a7e3-2d36-a93d-1e50fea02de2"
         #   )
         #   # => #<ActiveRecord::Relation ...>
         #
-        # @param  values [Array<String>] a list of uuids to select records by.
+        # @example Selects all records without a constraint
+        #   scope =  MyModel.by_uuid
+        #   scope == MyModel.all # => true
+        #
+        # @param  [Array<String>, nil] values ([]) The list of uuids to select
+        #   records by.
         # @return [ActiveRecord::Relation] scope.
         def by_uuid(*values)
-          return all unless values.any?
-          first_value = values.first
-          list = first_value.is_a?(Array) ? first_value : values
-          joins(:uuids).where(uuids_uuids: { value: list }).uniq
+          Queries::ByUuid.select(self, *values)
         end
       end
 
@@ -72,9 +74,7 @@ module Uuids
       # @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
-        list.each { |value| self.uuid = value }
+        values.flatten.each { |value| self.uuid = value }
       end
 
       private

data/lib/uuids/base.rb

@@ -42,12 +42,23 @@ module Uuids
       #   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
+        add_association
         after_initialize :add_default_uuid
         before_destroy   :prevent_destruction
         validates :uuids, presence: true, on: :update
       end
+
+      # @api hide
+      # Associates uuids to the current model.
+      def add_association
+        has_many(
+          :uuids,
+          class_name: "Uuids::Models::Uuid",
+          as: :record,
+          validate: false
+        )
+      end
     end
 
     private

data/lib/uuids/version.rb

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

data/lib/uuids.rb

@@ -1,12 +1,14 @@
 # Dependencies
-require "active_record"
-require "i18n"
+require "hexx-active_record"
 require "securerandom"
 
 # 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 }
+Dir[
+  "#{ root }/config/initializers/*.rb",
+  "#{ root }/lib/uuids/**/*.rb",
+  "#{ root }/app/**/*.rb"
+].each { |file| require file }
 
 # Namespace for the +uuids+ gem code.
 module Uuids

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

@@ -1,3 +1,3 @@
 class Record < ActiveRecord::Base
-  has_many :uuids, class_name: "Uuids::Uuid", as: :record
+  has_many :uuids, class_name: "Uuids::Models::Uuid", as: :record
 end

data/spec/lib/uuids/base_spec.rb

@@ -33,8 +33,8 @@ module Uuids
       it "defines the #uuids attribute" do
         subject.uuids.new value: SecureRandom.uuid
         subject.save!
-        expect(Uuids::Uuid.first.try(:record)).to eq subject
-        expect(subject.uuids.first).to eq Uuids::Uuid.first
+        expect(Uuids::Models::Uuid.first.try(:record)).to eq subject
+        expect(subject.uuids.first).to eq Uuids::Models::Uuid.first
       end
 
       it "defines the #uuid method" do

data/spec/{app/models/uuids → models}/uuid_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-module Uuids
+module Uuids::Models
   describe Uuid do
 
     describe "#value" do

data/spec/services/add_spec.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+require "spec_helper"
+
+module Uuids::Services
+  describe Add do
+
+    let!(:record) { create :record }
+    let!(:params) do
+      {
+        "record" => record,
+        "value"  => "47027502-4574-3434-0547-032453443434",
+        "wrong"  => "wrong"
+      }
+    end
+
+    describe ".new" do
+
+      subject { Add.new params }
+
+      it "sets #record" do
+        expect(subject.record).to eq params["record"]
+      end
+
+      it "sets #value" do
+        expect(subject.value).to eq params["value"]
+      end
+
+      it "whitelists params" do
+        expect(subject.params).to eq params.slice("record", "value")
+      end
+    end
+
+    describe "#run" do
+
+      let(:listener) { double "listener" }
+
+      context "with valid params" do
+
+        subject { Add.new params }
+
+        it "adds a uuid to the record" do
+          expect { subject.run }.to change { Uuids::Models::Uuid.count }.by 1
+          uuid = Uuids::Models::Uuid.last
+          expect(uuid.record).to eq params["record"]
+          expect(uuid.value).to  eq params["value"]
+        end
+
+        it "publishes :created" do
+          subject.subscribe listener
+          expect(listener).to receive(:created) do |uuid, messages|
+            expect(uuid).to eq Uuids::Models::Uuid.last
+            expect(messages).not_to be_blank
+          end
+          subject.run
+        end
+      end
+
+      context "with a wrong value" do
+
+        subject { Add.new params.merge(value: "wrong") }
+
+        it "doesn't create a uuid" do
+          expect { subject.run }.not_to change { Uuids::Models::Uuid.all }
+        end
+
+        it "publishes :error" do
+          subject.subscribe listener
+          expect(listener).to receive(:error)
+          subject.run
+        end
+      end
+    end
+  end
+end

data/spec/support/runtime/factories/uuids.rb

@@ -1,7 +1,7 @@
 require_relative "../config/factory_girl"
 
 FactoryGirl.define do
-  factory :uuid, class: Uuids::Uuid do
+  factory :uuid, class: Uuids::Models::Uuid do
     value  { SecureRandom.uuid }
     record # defined in the `dummy/spec/factories`
   end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: uuids
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: hexx-active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: active_record_install
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: hexx-generators
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: inch
   requirement: !ruby/object:Gem::Requirement
@@ -206,16 +206,20 @@ files:
 - LICENSE.rdoc
 - README.rdoc
 - Rakefile
-- app/models/uuids/uuid.rb
+- app/models/uuid.rb
+- app/queries/by_uuid.rb
+- app/services/add.rb
 - bin/uuids
-- config/locales/en.yml
-- config/locales/ru.yml
+- config/initializers/i18.rb
+- config/locales/models/uuid/en.yml
+- config/locales/models/uuid/ru.yml
+- config/locales/services/add/en.yml
+- config/locales/services/add/ru.yml
 - db/migrate/20141016112506_create_uuids_uuids.rb
 - lib/uuids.rb
 - lib/uuids/base.rb
 - lib/uuids/base/has_uuids.rb
 - lib/uuids/version.rb
-- spec/app/models/uuids/uuid_spec.rb
 - spec/bin/uuids_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/models/city.rb
@@ -231,6 +235,8 @@ files:
 - spec/dummy/db/test.sqlite3
 - spec/dummy/lib/dummy.rb
 - spec/lib/uuids/base_spec.rb
+- spec/models/uuid_spec.rb
+- spec/services/add_spec.rb
 - spec/spec_helper.rb
 - spec/spec_helper_dev.rb
 - spec/support/all/config/focus.rb
@@ -276,6 +282,7 @@ summary: UUIDs AR model.
 test_files:
 - spec/spec_helper_dev.rb
 - spec/spec_helper.rb
+- spec/models/uuid_spec.rb
 - spec/dummy/config/environment.rb
 - spec/dummy/config/database.yml
 - spec/dummy/config/initializers/seed_loader.rb
@@ -289,8 +296,8 @@ test_files:
 - spec/dummy/app/models/city.rb
 - spec/dummy/lib/dummy.rb
 - spec/dummy/Rakefile
-- spec/app/models/uuids/uuid_spec.rb
 - spec/lib/uuids/base_spec.rb
+- spec/services/add_spec.rb
 - spec/bin/uuids_spec.rb
 - spec/support/development/config/timecop.rb
 - spec/support/development/config/sandbox.rb

data/app/models/uuids/uuid.rb

@@ -1,58 +0,0 @@
-module Uuids
-
-  # 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
-  #   # Creates the uuid
-  #   uuid = Uuids::Uuid.create! 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
-  #
-  class Uuid < ActiveRecord::Base
-    self.table_name = :uuids_uuids
-
-    # @!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
-
-    # @!attribute record
-    # @return [ActiveRecord::Base] an object the uuid is assigned to.
-
-    belongs_to :record, polymorphic: true
-    validate   :record_present?
-
-    # Callbacks
-    after_initialize :set_default_value
-    before_destroy   :forbid_destruction
-
-    private
-
-    # Validates record presence with a custom error message.
-    def record_present?
-      return if record
-      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
-      false
-    end
-  end
-end