uuid_parameter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '090d5a9e80813acdeed189b4946249c92072ef14b9519c253d60710c86405132'
+  data.tar.gz: 55aefd1612e65362d133972bc56271ddab529ef4739cddf359898a1c7640bbf0
+SHA512:
+  metadata.gz: 4c8972c83b056bfa1b024949ecbef4957b1e4e9314447995f2455306ca64f59850f75dc3798accde471530281e8dd2a6607d6a85b4076a0803af862740530069
+  data.tar.gz: '079c228088fc5d79467457cbbe0c444178e85765210f3ff372459958b59b93e0a45f1861e11f3d03490fbd2f4b4398e206678bd5ca4b6037f533b7981b4fe99b'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 hellekin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# UUIDParameter
+
+The `UUIDParameter` module provides support for UUIDs in `ActiveRecord` models.
+
+It takes care of generating (if one was not provided), validating, and keeping
+this UUID intact, protecting the `:uuid` field from being changed once set.
+
+Models including the `UUIDParameter` module will:
+- use their `:uuid` rather than their `:id` (primary key) for URLs.
+- accept an given UUID on creation to allow offline resource generation.
+
+### Features
+
+- Can be used with existing models (simply add a `uuid` column).
+- 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.
+- Only works with UUID version 4 (random).
+- Prevents changing the UUID once set.
+- Silently ignores any attempt at changing a set UUID.
+- Overrides `:to_param` to provide the UUID instead of the primary key.
+
+## Usage
+
+Add a `uuid` column to your model if it does not have one already:
+``` bash
+$ rails g migration AddUuidColumnToUser uuid:string{36}
+$ rails db:migrate
+```
+
+If you're using Postgres, you should use the native `uuid` type instead:
+``` bash
+$ rails g migration AddUuidColumnToUser uuid:uuid
+$ rails db:migrate
+```
+
+Then, simply include the module in your model:
+``` ruby
+class User < ApplicationRecord
+  include UUIDParameter
+end
+
+# u = User.create  # Generates a new UUID
+# u.id             # => 123 (does not change primary key)
+# u.uuid           # => '8bb27724-7439-4965-9598-883419179b21'
+# u.to_param       # => '8bb27724-7439-4965-9598-883419179b21'
+# u.uuid = SecureRandom.uuid
+# u.save           # Silently ignores changes to :uuid
+# u.reload         # Instead, it restores the original:
+# u.uuid           # => '8bb27724-7439-4965-9598-883419179b21'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'uuid_parameter'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install uuid_parameter
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on Gitlab at
+https://gitlab.com/incommon.cc/uuid_parameter.
+
+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
+there.
+
+[Github repository]: https://github.com/moners/uuid_parameter
+
+# Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Run specifications with `bundle exec rake`.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+See `bundle exec rake -T` for more options.
+
+## License
+
+This gem is free software under the same [license] terms as Rails.
+
+[license]: ./LICENSE

data/Rakefile

@@ -0,0 +1,39 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UuidParameter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecordFixIntegerLimit'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/uuid_parameter/railtie.rb

@@ -0,0 +1,4 @@
+module UUIDParameter
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/uuid_parameter/uuid_version4_validator.rb

@@ -0,0 +1,16 @@
+# 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

data/lib/uuid_parameter/version.rb

@@ -0,0 +1,3 @@
+module UUIDParameter
+  VERSION = '0.1.0'
+end

data/lib/uuid_parameter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'uuid_parameter/uuid_version4_validator'
+
+# == UUIDParameter
+#
+# UUIDParameter module provides support for UUIDs in models.  It takes care of
+# generating (if one was not provided), validating, and keeping this UUID
+# intact, protecting the :uuid field from being changed once set.  Models
+# including the UUIDParameter module will use their :uuid rather than their :id
+# for URLs.
+#
+module UUIDParameter
+  extend ActiveSupport::Concern
+  included do
+    validates_with UUIDVersion4Validator
+
+    before_validation :assign_uuid, on: :create
+    before_save :keep_existing_uuid
+
+    def to_param
+      uuid.to_s
+    end
+
+    private
+
+    def assign_uuid
+      self.uuid ||= SecureRandom.uuid
+    end
+
+    def keep_existing_uuid
+      self.uuid = uuid_was if existing_uuid_changed?
+    end
+
+    def existing_uuid_changed?
+      !new_record? && uuid_changed?
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: uuid_parameter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hellekin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: UUIDParameter handles a :uuid column and validation for any model.
+email:
+- hellekin@cepheide.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- 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:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Adds a UUID to an ActiveRecord model.
+test_files: []