uuids 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ce0188d48ab948a1a9d6e01b9bce6783d7d05f4
-  data.tar.gz: 55040c5ebc0e3824e2e81c5eb05806544dea305e
+  metadata.gz: 016e522c63a1b3f96e575a5e3cc46ebf45d4b7f8
+  data.tar.gz: a23f8b1dc1bbc0e4588294ca6537526bec02d8cf
 SHA512:
-  metadata.gz: 0980d73961b09197aa7e419de79d880fcee3966b552eb1d7e31fad42aab546973479bac2a6321ebc71242150934378cc4a42b5041d709a6e7c807a355cabb1f3
-  data.tar.gz: c1eb2d45b66ebfdde301d6c4c31b2dc357a53447fc02754395ed88fea18caeb4f4c12ea67ca916e78b4032e3de9006bf9c63fb172f9ac7a098422ec23a12ab9b
+  metadata.gz: 1265400e53725494f22c2a31b4c90de117a8caa5bc16e415aedf3732ddaac2d4ef403268f65a7ff1544f9c65421b5d9b6586abc51ffc3f95c56edceeb58457f5
+  data.tar.gz: e635c00cf24e8c160723d7c9c2716014ec4199f0abfb90966f45685fdcdabcf010a42e7cab3bce6edb662b20821cbf33ab47d0f8ec61c0531b2618584ff82399

data/.rubocop.yml

@@ -29,6 +29,9 @@ Style/Documentation:
     - 'db/**/*'
     - 'lib/uuids/version.rb'
 
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
 Style/EmptyLinesAroundClassBody:
   Enabled: false
 
@@ -39,8 +42,7 @@ Style/EmptyLinesAroundModuleBody:
   Enabled: false
 
 Style/EmptyLineBetweenDefs:
-  Exclude:
-    - 'spec/**/*'
+  Enabled: false
 
 Style/PredicateName:
   Enabled: false

data/README.rdoc

@@ -60,24 +60,18 @@ Or install it yourself as:
 
     $ gem install uuids
 
-== Initialization
-
-After installation you should copy and run uuid's db migration into your module.
-
-When you install the module to a final application, the migration should be
-installed to `db/migrate` path directly.
+Then run the command in the root of a <b>end-up application</b>:
 
     $ uuids install
 
-When you install the module to another gem as a part of its environment,
-the migration isn't a part of your project. It only needed for testing
-your gem in a proper environment.
-
-In this case the migration should be installed to a dummy app in a
-`spec/dummy/db/migrate` folder. Do it with the `-d` key:
+Use the <tt>-d</tt> key when installing the gem into a <b>module</b> that is not
+an end-up application (Rails engine etc.):
 
     $ uuids install -d
 
+(this will copy the gem's migrations to the host's dummy folder:
++spec/dummy/db/migrate+).
+
 == Usage
 
 === Adding UUIDs to models
@@ -86,6 +80,7 @@ Add the assotiation to your AR model with a `has_uuids` helper:
 
     class City < ActiveRecord::Base
       include Uuids::Base
+
       has_uuids
     end
 
@@ -113,9 +108,6 @@ all object's UUIDs to another record in advance.
 
 === Referring model by UUID
 
-Instead of <tt>ActiveRecord::Associations</tt> +belongs_to+, +has_one+ and
-+has_many+, you should define custom methods explicitly.
-
     # db/migrate/*_create_streets.rb
     class CreateStreetsTable < ActiveRecord::Migration
       def change
@@ -128,17 +120,17 @@ Instead of <tt>ActiveRecord::Associations</tt> +belongs_to+, +has_one+ and
 
     # app/models/street.rb
     class Street < ActiveRecord::Base
+      include Uuids::Base
 
-      scope :by_city, ->(city) { City.by_uuid(city.uuid) }
+      belongs_by_uuid_to :city, class: City
+    end
 
-      def city
-        @city ||= City.by_uuid(city_uuid)
-      end
+This will add both getter and setter for the attribute:
 
-      def city=(city)
-        write_attribute :city_uuid, city.uuid
-      end
-    end
+    street = Street.new name: "Damrak", city: City.new name: "Amsterdam"
+    street.city
+    # => #<City @name="Amsterdam" ... >
+    street.city_uuid == street.city.uuid # => true
 
 === Adding uuid
 

data/app/queries/by_uuid.rb

@@ -41,7 +41,8 @@ module Uuids
       end
 
       # @api hide
-      # Runs and returns the query.
+      # Runs and returns the query
+      # @return [ActiveRecord::Relation] The updated scope.
       def select
         values.any? ? by_uuid : model.all
       end

data/lib/uuids/base/belongs_to.rb

@@ -0,0 +1,123 @@
+module Uuids
+  module Base
+
+    # @api hide
+    # Adds getter and setter for the model attribute referred by uuid.
+    #
+    # @example
+    #   BelongsTo.add City, :state, State
+    #   city = City.new
+    #   city.respond_to? :state   # => true
+    #   city.respond_to? :state=  # => true
+    class BelongsTo < Struct.new(:klass, :name, :model)
+
+      # @api hide
+      # @!attribute klass
+      # The model to add the attribute to.
+      # @return [ActiveRecord::Base] The model class.
+
+      # @api hide
+      # @!attribute name
+      # The name of the attribute to be added.
+      # @return [String, Symbol] The name.
+
+      # @api hide
+      # @!attribute model
+      # The model to be referred by uuid.
+      # @return [ActiveRecord::Base] The model class to be referred to.
+
+      # @api hide
+      # @!attribute [r] class_name
+      # The name of the {#klass} constant.
+      # @return [String] The {#klass} name.
+      def class_name
+        @class_name ||= klass.name
+      end
+
+      # @api hide
+      # @!attribute [r] model_name
+      # The name of the {#model} constant.
+      # @return [String] The {#model} name.
+      def model_name
+        @model_name ||= model.name
+      end
+
+      # @api hide
+      # @!attribute [r] model_name
+      # The name of the {#klass} db table column to store reference to the
+      #   attribute by uuid.
+      # @return [String] The name of the column.
+      def column_name
+        @column_name ||= "#{ name }_uuid"
+      end
+
+      # @api hide
+      # Constructs the object and adds the attribute.
+      # @example (see Uuids::Base::BelongsTo)
+      # @params [ActiveRecord::Base] klass The model to add attribute to.
+      #   Should have a corresponding column for reference by uuid.
+      # @params [String, Symbol] name The name of the attribute to be added.
+      # @params [ActiveRecord::Base] model The model to be referred by uuid.
+      #   Should include the <tt>Uuids::Base</tt> module.
+      # @raise (see Uuids::Base::BelongsTo#add)
+      def self.add(*args)
+        new(*args).add
+      end
+
+      # @api hide
+      # Adds the attribute's getter and setter.
+      # @raise [TypeError] if the {#model} doesn't include
+      #   the <tt>Uuids::Base</tt> module.
+      # @raise [NotImplementedError] if the {#klass} doesn't have the
+      #   correspondint {#column_name} column.
+      def add
+        check_model
+        check_column
+        add_getter
+        add_setter
+      end
+
+      private
+
+      def check_model
+        return if model.ancestors.include? Uuids::Base
+        fail TypeError
+          .new "#{ model_name } class doesn't include the Uuids::Base module"
+      end
+
+      def check_column
+        return if klass.attribute_names.include? column_name
+        fail NotImplementedError
+          .new "#{ class_name }##{ column_name } attribute isn't implemented"
+      end
+
+      def add_getter
+        klass.class_eval getter
+      end
+
+      def add_setter
+        klass.class_eval setter
+      end
+
+      def getter
+        "def #{ name };
+           uuid = read_attribute :#{ column_name };
+           return @#{ name } = nil unless uuid;
+           if Array(@#{ name }.try(:uuids)).map(&:value).include? uuid;
+             @#{ name };
+           else;
+             @#{ name } = #{ model_name }.by_uuid(uuid).includes(:uuids).first;
+           end;
+         end"
+      end
+
+      def setter
+        "def #{ name }=(value);
+           fail TypeError unless value.nil? || value.is_a?(#{ model_name });
+           write_attribute :#{ column_name }, value.try(:uuid);
+           #{ name };
+         end"
+      end
+    end
+  end
+end

data/lib/uuids/base/has_uuids.rb

@@ -1,13 +1,16 @@
 module Uuids
   module Base
 
+    # @api hide
     # Defines methods to be added by the +has_uuids+ class helper.
     module HasUuids
       extend ActiveSupport::Concern
 
+      # @api hide
       # Model scopes.
       module ClassMethods
 
+        # @api hide
         # Selects records by uuid(s).
         #
         # @example Selects records by a list of uuids
@@ -32,8 +35,22 @@ module Uuids
         def by_uuid(*values)
           Queries::ByUuid.select(self, *values)
         end
+
+        private
+
+        # @api hide
+        # Associates uuids to the current model.
+        def has_many_uuids
+          has_many(
+            :uuids,
+            class_name: "Uuids::Models::Uuid",
+            as: :record,
+            validate: false
+          )
+        end
       end
 
+      # @api hide
       # Returns the first UUID (sorted as a string) for the record.
       #
       # @example
@@ -46,6 +63,7 @@ module Uuids
         uuids.map(&:value).sort.first
       end
 
+      # @api hide
       # Assigns a new uuid to the record.
       #
       # @example
@@ -58,6 +76,7 @@ module Uuids
         uuids.new value: value
       end
 
+      # @api hide
       # Assigns a list of new uuids to the record.
       #
       # @example

data/lib/uuids/base.rb

@@ -21,6 +21,8 @@ module Uuids
       #
       # @example
       #   class City < ActiveRecord::Base
+      #     include Uuids::Base
+      #
       #     has_uuids
       #   end
       #
@@ -43,21 +45,38 @@ module Uuids
       #   # => true
       def has_uuids
         include Uuids::Base::HasUuids
-        add_association
+        has_many_uuids
         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
-        )
+      # The helper defines both the getter and setter for object, associated
+      # by uuid.
+      #
+      # @example
+      #   class City < ActiveRecord::Base
+      #     include Uuids::Base
+      #
+      #     belongs_by_uuid_to :state, class: State
+      #   end
+      #
+      #   city = City.new
+      #   city.state_uuid = "12345678-90ab-cdef-1234-567890abcdef"
+      #
+      #   city.state.class # => State
+      #   city.state.uuid  # => "12345678-90ab-cdef-1234-567890abcdef"
+      #
+      #   city.state = State.new uuid: "fedcba98-7654-3210-fedc-ba9876543210"
+      #   city.state.uuid  # => "fedcba98-7654-3210-fedc-ba9876543210"
+      #
+      # @param [String, Symbol] name The name of the attribute.
+      # @param [Hash] options The options for the association.
+      # @option options [Class] :class The model of the attribute.
+      # @option options [String] :class_name The name of the attribute's model.
+      def belongs_by_uuid_to(name, options = {})
+        class_name = options[:class] || options[:class_name].constantize
+        BelongsTo.add self, name, class_name
       end
     end
 

data/lib/uuids/version.rb

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

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

@@ -0,0 +1,6 @@
+require "uuids"
+
+class State < ActiveRecord::Base
+  include Uuids::Base
+  has_uuids
+end

data/spec/dummy/db/migrate/20141215182349_create_states.rb

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

data/spec/dummy/db/migrate/{20141017081115_create_cities.rb → 20151215182355_create_cities.rb}

@@ -1,7 +1,7 @@
 class CreateCities < ActiveRecord::Migration
   def change
     create_table :cities do |t|
-
+      t.string :state_uuid, limit: 36
       t.timestamps
     end
   end

data/spec/dummy/db/schema.rb

@@ -11,9 +11,10 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20141017081115) do
+ActiveRecord::Schema.define(version: 20151215182355) do
 
   create_table "cities", force: true do |t|
+    t.string   "state_uuid", limit: 36
     t.datetime "created_at"
     t.datetime "updated_at"
   end
@@ -23,6 +24,11 @@ ActiveRecord::Schema.define(version: 20141017081115) do
     t.datetime "updated_at"
   end
 
+  create_table "states", force: true do |t|
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
   create_table "uuids_uuids", force: true do |t|
     t.string  "value",       limit: 36, null: false
     t.integer "record_id",              null: false

data/spec/lib/uuids/base_spec.rb

@@ -81,5 +81,70 @@ module Uuids
         expect { subject.destroy! }.not_to raise_error
       end
     end
+
+    describe ".belongs_by_uuid_to" do
+
+      context "when a model doesn't include Uuids::Base" do
+
+        it "raises TypeError" do
+          expect { City.send :belongs_by_uuid_to, :state, class: Record }
+            .to raise_error { TypeError }
+        end
+      end
+
+      context "when a class doesn't have column for uuids" do
+
+        it "raises NotImplementedError" do
+          expect { City.send :belongs_by_uuid_to, :country, class: State }
+            .to raise_error { NotImplementedError }
+        end
+      end
+
+      context "with valid arguments" do
+
+        before  { City.send :belongs_by_uuid_to, :state, class: State }
+        subject { City.new }
+
+        let!(:uuid)  { "01234567-89ab-cdef-0123-456789abcdef" }
+        let!(:state) { State.create uuid: uuid }
+
+        it "defines the getter" do
+          expect(subject).to respond_to :state
+          expect(subject.method(:state).arity).to eq 0
+        end
+
+        it "defines the setter" do
+          expect(subject).to respond_to :state=
+          expect(subject.method(:state=).arity).to eq 1
+        end
+
+        it "sets the object" do
+          expect { subject.state = state }
+            .to change { subject.state }.to state
+        end
+
+        it "sets the object uuid" do
+          expect { subject.state = state }
+            .to change { subject.state_uuid }.to state.uuid
+        end
+
+        it "resets the object" do
+          subject.state = state
+          expect { subject.state = nil }
+            .to change { subject.state }.to nil
+        end
+
+        it "resets the object uuid" do
+          subject.state = state
+          expect { subject.state = nil }
+            .to change { subject.state_uuid }.to nil
+        end
+
+        it "sets the object by uuid" do
+          expect { subject.state_uuid = state.uuid }
+            .to change { subject.state }.to state
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uuids
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Andrew Kozin
@@ -218,19 +218,22 @@ files:
 - db/migrate/20141016112506_create_uuids_uuids.rb
 - lib/uuids.rb
 - lib/uuids/base.rb
+- lib/uuids/base/belongs_to.rb
 - lib/uuids/base/has_uuids.rb
 - lib/uuids/version.rb
 - spec/bin/uuids_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/models/city.rb
 - spec/dummy/app/models/record.rb
+- spec/dummy/app/models/state.rb
 - spec/dummy/config/database.yml
 - spec/dummy/config/environment.rb
 - spec/dummy/config/initializers/application.rb
 - spec/dummy/config/initializers/dummy.rb
 - spec/dummy/config/initializers/seed_loader.rb
 - spec/dummy/db/migrate/20141016113016_create_records.rb
-- spec/dummy/db/migrate/20141017081115_create_cities.rb
+- spec/dummy/db/migrate/20141215182349_create_states.rb
+- spec/dummy/db/migrate/20151215182355_create_cities.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/db/test.sqlite3
 - spec/dummy/lib/dummy.rb
@@ -288,10 +291,12 @@ test_files:
 - spec/dummy/config/initializers/seed_loader.rb
 - spec/dummy/config/initializers/application.rb
 - spec/dummy/config/initializers/dummy.rb
-- spec/dummy/db/migrate/20141017081115_create_cities.rb
+- spec/dummy/db/migrate/20141215182349_create_states.rb
 - spec/dummy/db/migrate/20141016113016_create_records.rb
+- spec/dummy/db/migrate/20151215182355_create_cities.rb
 - spec/dummy/db/test.sqlite3
 - spec/dummy/db/schema.rb
+- spec/dummy/app/models/state.rb
 - spec/dummy/app/models/record.rb
 - spec/dummy/app/models/city.rb
 - spec/dummy/lib/dummy.rb