sequel_uuid_prefix 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf00930233f9fe19eca45eaa8ee052b4f52e6fb1
+  data.tar.gz: 603e7de1a670e9fb1a67eec175c8736bad5b4174
+SHA512:
+  metadata.gz: cfd7d3cd8ce10cdc9ab58489c2a51215c691a4981e339030b4b5751037a1e05129dc743151bef42a4f9cb66acaf41490854225fc7daf00c74eed5c467d3b3f76
+  data.tar.gz: 1bb81fe757f3ad7330d6504b4a194b943910d5fe863b11760e9ad3dc077a15683f1941b4f136baa539c8535dbdea1729f09fdb0556ad34d528ad36c736d177c8

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,34 @@
+# UUID Prefix
+
+This is a Sequel Model plugin that adds [0-9a-z] unique ID prefixed by a custom string.
+
+The prefix isn't stored in the database. Only the Unique ID itself is.
+
+Usage:
+
+```ruby
+class Account < Sequel::Model
+  plugin Sequel::Plugins::UUIDPrefix
+
+  uuid_prefix 'a'
+end
+
+class User < Sequel::Model
+  plugin Sequel::Plugins::UUIDPrefix
+
+  uuid_prefix 'u'
+end
+
+# Find an account.
+UUIDPrefix.find('a-xxxxxxxx')
+
+# Find a user.
+UUIDPrefix.find('u-xxxxxxxx')
+
+user1.uuid_prefix # == 'u'
+user1.canonical_uuid # == 'u-abcd1234'
+
+Account['a-xxxxyyyy'] # Returns the account with UUID a-xxxxyyyy
+
+Account.trim_uuid('a-abcd1234') # == 'abcd1234'
+```

data/lib/sequel/plugins/uuid_prefix.rb

@@ -0,0 +1,209 @@
+# -*- coding: utf-8 -*-
+
+require 'sequel/plugins/after_initialize'
+
+module Sequel
+  module Plugins
+    # Sequel::Model plugin to inject the UUIDPrefix feature to the model
+    # class.
+    #
+    # UUIDPrefix model supports the features below:
+    # - UUIDPrefix.uuid_prefix to both set and get uuid_prefix for the model.
+    # - Collision detection for specified uuid_prefix.
+    # - Generate unique value for :uuid column at initialization.
+    # - Add column :uuid if the model is capable of :schema plugin methods.
+    module UUIDPrefix
+      UUID_TABLE='abcdefghijklmnopqrstuvwxyz0123456789'.split('').freeze
+      UUID_REGEX=%r/^(\w+)-([#{UUID_TABLE.join}]+)/
+
+      class InvalidUUIDError < StandardError; end
+      class UUIDPrefixDuplication < StandardError; end
+      class UUIDDuplication < StandardError; end
+      class UnsetUUIDPrefix < StandardError; end
+
+      def self.apply(model, _options = {})
+        model.plugin Sequel::Plugins::AfterInitialize
+      end
+
+      def self.uuid_prefix_collection
+        @uuid_prefix_collection ||= {}
+      end
+
+      # Find a model with an prefixed uuid object from the
+      # given canonical uuid.
+      #
+      # # Find an account.
+      # UUIDPrefix.find('a-xxxxxxxx')
+      #
+      # # Find a user.
+      # UUIDPrefix.find('u-xxxxxxxx')
+      def self.find(uuid)
+        raise ArgumentError, "Invalid uuid syntax: #{uuid}" unless uuid =~ UUID_REGEX
+        upc = uuid_prefix_collection[$1.downcase]
+        raise "Unknown uuid prefix: #{$1.downcase}" if upc.nil?
+        upc[:class].find(:uuid=>$2)
+      end
+
+      # Checks if the uuid object stored in the database.
+      def self.exists?(uuid)
+        !find(uuid).nil?
+      end
+
+      def self.configure(model)
+        model.schema_builders << proc {
+          unless has_column?(:uuid)
+            # add :uuid column with unique index constraint.
+            column(:uuid, String, :size=>8, :null=>false, :fixed=>true, :unique=>true)
+          end
+        }
+      end
+
+      module InstanceMethods
+        # read-only instance method to retrieve @uuid_prefix class
+        # variable.
+        def uuid_prefix
+          self.class.uuid_prefix
+        end
+
+        def before_validation
+          # trim uuid prefix if it is in the self[:uuid]
+          self[:uuid].sub!(/^#{self.class.uuid_prefix}-/, '')
+
+          super
+        end
+
+        def before_create
+          if !self.class.find(:uuid=>self[:uuid]).nil?
+            raise UUIDDuplication, "Duplicate UUID: #{self.canonical_uuid} already exists"
+          end
+
+          super
+        end
+
+        def after_initialize
+          super
+          # set random generated uuid value
+          self[:uuid] ||= Array.new(8) do UUID_TABLE[rand(UUID_TABLE.size)]; end.join
+        end
+
+        # Returns canonicalized uuid which has the form of
+        # "{uuid_prefix}-{uuid}".
+        def canonical_uuid
+          "#{self.uuid_prefix}-#{self[:uuid]}"
+        end
+        alias_method :cuuid, :canonical_uuid
+
+        def to_hash()
+          r = self.values.dup.merge({id: self.id,
+                                     uuid: canonical_uuid,
+                                     class_name: self.class.name.demodulize
+                                   })
+
+          serialize_columns = []
+
+          if defined? Sequel::Plugins::Serialization
+            if self.class.plugins.member?(Sequel::Plugins::Serialization)
+              self.class.deserialization_map.keys.each { |c|
+                serialize_columns << c
+                r[c] = self.__send__(c)
+              }
+            end
+          end
+
+          # convert Sequel::SQL::Blob column.
+          # TODO: look for alternative method to stop to retrieve
+          #       db_schema hash.
+          self.class.db_schema.each { |c, v|
+            if v[:db_type] == 'text' && v[:type] == :string && !serialize_columns.member?(c)
+              r[c] = self.__send__(c).to_s
+            end
+          }
+          r
+        end
+
+        # generate API response document. similar to to_hash() but not
+        # to expose integer primary key.
+        def to_api_document
+          self.values.dup.merge({:id=>self.canonical_uuid, :uuid=>canonical_uuid})
+        end
+      end
+
+      module ClassMethods
+        # Getter and setter for uuid_prefix of the class.
+        #
+        # @example
+        #   class Model1 < Sequel::Model
+        #     plugin UUIDPrefix
+        #     uuid_prefix('m')
+        #   end
+        #
+        #   Model1.uuid_prefix # == 'm'
+        #   Model1.new.canonical_uuid # == 'm-abcd1234'
+        def uuid_prefix(prefix=nil)
+          if prefix
+            if UUIDPrefix.uuid_prefix_collection.has_key?(prefix)
+              raise UUIDPrefixDuplication, "Found collision for uuid_prefix key: #{prefix}"
+            end
+
+            UUIDPrefix.uuid_prefix_collection[prefix]={:class=>self}
+            @uuid_prefix = prefix
+          end
+
+          @uuid_prefix ||
+            (superclass.uuid_prefix if superclass.respond_to?(:uuid_prefix)) ||
+            raise(UnsetUUIDPrefix, "uuid prefix is unset for: #{self}")
+        end
+
+
+        # Override Model.[] to add lookup by uuid.
+        #
+        # @example
+        #   Account['a-xxxxxx']
+        def [](*args)
+          if args.size == 1 and args[0].is_a? String
+            super(:uuid=>trim_uuid(args[0]))
+          else
+            super(*args)
+          end
+        end
+
+        # Returns dataset which has been selected for the uuid.
+        #
+        # @example
+        #   Account.dataset_where_uuid('a-xxxxxx')
+        def dataset_where_uuid(p_uuid)
+          dataset.where(uuid: trim_uuid(p_uuid))
+        end
+
+        # Returns the uuid string which is removed prefix part: /^(:?\w+)-/.
+        #
+        # @example
+        #   Account.trim_uuid('a-abcd1234') # = 'abcd1234'
+        # @example Will get InvalidUUIDError as the uuid with invalid prefix has been tried.
+        #   Account.trim_uuid('u-abcd1234') # 'u-' prefix is for User model.
+        def trim_uuid(p_uuid)
+          regex = %r/^#{self.uuid_prefix}-/
+          if p_uuid and p_uuid =~ regex
+            return p_uuid.sub(regex, '')
+          end
+          raise InvalidUUIDError, "Invalid uuid or unsupported uuid: #{p_uuid} in #{self}"
+        end
+
+        # Checks the general uuid syntax
+        def check_trimmed_uuid_format(uuid)
+          uuid.match(/^[\w]+$/) && uuid.length <= 255
+        end
+
+        # Checks the uuid syntax if it is for the UUIDPrefix class.
+        def check_uuid_format(uuid)
+          uuid =~ /^#{self.uuid_prefix}-/
+        end
+
+        def valid_uuid_syntax?(uuid)
+          uuid =~ /^#{self.uuid_prefix}-[\w]+/
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: sequel_uuid_prefix
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Axsh Co. LTD
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-16 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: dev@axsh.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sequel/plugins/uuid_prefix.rb
+- LICENSE
+- README.md
+homepage: https://github.com/axsh/sequel_uuid_prefix
+licenses:
+- LGPLv3
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Sequel Model plugin that adds [0-9a-z] unique id prefixed by a custom string.
+test_files: []