uuid_parameter 0.1.0 → 0.2.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '090d5a9e80813acdeed189b4946249c92072ef14b9519c253d60710c86405132'
-  data.tar.gz: 55aefd1612e65362d133972bc56271ddab529ef4739cddf359898a1c7640bbf0
+  metadata.gz: f7718b5d84a19a25b9ce316d23919ef34a13a31a50aa46993578f18f59a81eed
+  data.tar.gz: d7be3d70a50ecda0d8fe7db471ab36f948618b56f09acba4af076e2f6da62f15
 SHA512:
-  metadata.gz: 4c8972c83b056bfa1b024949ecbef4957b1e4e9314447995f2455306ca64f59850f75dc3798accde471530281e8dd2a6607d6a85b4076a0803af862740530069
-  data.tar.gz: '079c228088fc5d79467457cbbe0c444178e85765210f3ff372459958b59b93e0a45f1861e11f3d03490fbd2f4b4398e206678bd5ca4b6037f533b7981b4fe99b'
+  metadata.gz: 7906c3a3529293eabb7c51a0c6bc97e4d6e2eb8a81ab19f3d717e2c67fb2caec9fbb38c8e5cfd9ca05d56ddfd73c02352338f7618995e8de7adfc32faafa8279
+  data.tar.gz: 28ae550b9f0288cdaf292045f1c4f924167a3d2108dc5babdb03e5ba3db0b70590920feb8e875da937abe5a95e4fca127955d0081c3159b4a0313ad114141e15

data/README.md

@@ -11,7 +11,8 @@ Models including the `UUIDParameter` module will:
 
 ### Features
 
-- Can be used with existing models (simply add a `uuid` column).
+- Can be used with existing models (simply add a `uuid` column): saving the
+  model with `nil` values will provide a new UUID.
 - Does not affect existing primary key.
 - Can accept any valid random UUID (version 4) provided externally.
 - Automatically generates a UUID on `:create` if one is not set.
@@ -20,6 +21,17 @@ Models including the `UUIDParameter` module will:
 - Silently ignores any attempt at changing a set UUID.
 - Overrides `:to_param` to provide the UUID instead of the primary key.
 
+### Anti-Features
+
+- If the database already contains invalid UUIDv4 data, the affected records
+  will become **impossible to save**: this is to ensure that you can check your
+  referential integrity. You can still force `#reset_uuid!` to bypass this, or
+  use SQL directly in the database. (See #1)
+
+### I18n
+
+Translations are in progress (See #2): specs are therefore failing (on purpose).
+
 ## Usage
 
 Add a `uuid` column to your model if it does not have one already:
@@ -72,6 +84,8 @@ $ gem install uuid_parameter
 Bug reports and pull requests are welcome on Gitlab at
 https://gitlab.com/incommon.cc/uuid_parameter.
 
+See [ChangeLog](../CHANGELOG.md) and commit messages.
+
 The [Github repository] is a mirror to facilitate integration with other Rails
 development, but I don't like Microsoft, and never will. They may show the face
 they like, they come from enemity and, as far as I'm concerned, will remain

data/lib/locale/en.yml

@@ -0,0 +1,4 @@
+en:
+  errors:
+    messages:
+      not_a_uuid_v4: "must be a random UUID (v4)"

data/lib/locale/fr.yml

@@ -0,0 +1,4 @@
+fr:
+  errors:
+    messages:
+      not_a_uuid_v4: "doit être un UUID aléatoire (v4)"

data/lib/uuid_parameter/railtie.rb

@@ -1,4 +1,12 @@
+# frozen_string_literal: true
+
 module UUIDParameter
   class Railtie < ::Rails::Railtie
+    config.uuid_parameter = ActiveSupport::OrderedOptions.new
+
+    initializer 'uuid_parameter.set_locales' do |app|
+      app.config.i18n.load_paths << File.expand_path('../locale', __DIR__)
+      app.config.i18n.available_locales = [:en, :fr].freeze
+    end
   end
 end

data/lib/uuid_parameter/version.rb

@@ -1,3 +1,3 @@
 module UUIDParameter
-  VERSION = '0.1.0'
+  VERSION = '0.2.0-alpha.1'
 end

data/lib/uuid_parameter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'uuid_parameter/uuid_version4_validator'
+# TODO: move this to the right place... But where?
+I18n.load_path << File.expand_path("locale/en.yml", __dir__)
 
 # == UUIDParameter
 #
@@ -10,13 +11,37 @@ require 'uuid_parameter/uuid_version4_validator'
 # including the UUIDParameter module will use their :uuid rather than their :id
 # for URLs.
 #
+# class User < ActiveRecord::Base
+#   include UUIDParameter
+# end
+#
+# user = User.new
+# user.uuid         # => nil
+# user.save         # => true
+# user.uuid         # => some UUID was generated
+# user.uuid = 'foo'
+# user.save         # => true
+# user.uuid         # => original UUID is preserved
+#
+# user = User.create(uuid: '8bb96d58-2efd-45df-833b-119971a19fea')
+# user.update_attribute(uuid: '00000000-aaaa-45df-cccc-119971a19fea') # => true
+# user.reload.uuid  # => '8bb96d58-2efd-45df-833b-119971a19fea' (unchanged)
+# user.to_param     # => '8bb96d58-2efd-45df-833b-119971a19fea'
+#
 module UUIDParameter
   extend ActiveSupport::Concern
+
+  # Note the static '4' in the third group: that's the UUID version.
+  UUID_V4_REGEX = %r[\A[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12}\z]
+
   included do
-    validates_with UUIDVersion4Validator
+    validates :uuid,
+              presence: true,
+              uniqueness: true,
+              format: { with: UUID_V4_REGEX, message: :not_a_uuid_v4 }
 
-    before_validation :assign_uuid, on: :create
-    before_save :keep_existing_uuid
+    before_validation :assign_uuid
+    before_save :recover_uuid
 
     def to_param
       uuid.to_s
@@ -28,12 +53,18 @@ module UUIDParameter
       self.uuid ||= SecureRandom.uuid
     end
 
-    def keep_existing_uuid
+    def existing_uuid_changed?
+      !new_record? && !uuid_was.nil? && uuid_changed?
+    end
+
+    def recover_uuid
       self.uuid = uuid_was if existing_uuid_changed?
+      reset_uuid! unless UUID_V4_REGEX.match?(self.uuid)
     end
 
-    def existing_uuid_changed?
-      !new_record? && uuid_changed?
+    def reset_uuid!
+      self.uuid = nil
+      assign_uuid
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uuid_parameter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.pre.alpha.1
 platform: ruby
 authors:
 - hellekin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-18 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -76,9 +76,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/locale/en.yml
+- lib/locale/fr.yml
 - lib/uuid_parameter.rb
 - lib/uuid_parameter/railtie.rb
-- lib/uuid_parameter/uuid_version4_validator.rb
 - lib/uuid_parameter/version.rb
 homepage: https://gitlab.com/incommon.cc/uuid_parameter
 licenses:
@@ -95,9 +96,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6

data/lib/uuid_parameter/uuid_version4_validator.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module UUIDParameter
-  # Validate a UUID v4: it must be correctly formatted and cannot change.
-  # This latter responsibility is defined in the UUIDParameter model concern.
-  class UUIDVersion4Validator < ActiveModel::Validator
-    # Note the static '4' in the third group: that's the UUID version.
-    UUID_V4_REGEX = %r[\A[a-f0-9]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12}\z]
-
-    def validate(record)
-      unless UUID_V4_REGEX.match?(record.uuid)
-        record.errors.add(:uuid, 'must be a valid random UUID (v4)')
-      end
-    end
-  end
-end