sequel-nonsequential_id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4092f9d8947383ae099eb15b1bb5e48b3eb572f56460c3db5545a45c4c9adff8
+  data.tar.gz: 88a9a676917bb0bc20fc890eb61d7491c8e6b88fe2a89638e9aa72e008c53aae
+SHA512:
+  metadata.gz: 0e2f63c596303c7a28df3f6c0af2fd7802b2234a6c7c65415d5e0091687e62a2aec14c635ffe922b1d75ee6ced4810b449d18f4b94b66328197e790e1f22e86b
+  data.tar.gz: 54f4ef3d3957f7563c794b84e27444a31b14b21338816fd274cb7bc2b8a6e8a0911704843ec4cc355e7cb6a436460708d71edf5b1f7f32f47d6119ce7959e14f

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+*.iml
+.idea

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Dashing Rocket, Ltd
+
+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,57 @@
+# sequel-nonsequential_id
+[![Run Status](https://api.shippable.com/projects/5bb3aa2628d5f40700431d28/badge?branch=master)](https://app.shippable.com/github/dashingrocket/sequel-nonsequential_id/dashboard) 
+[![Gem Version](https://badge.fury.io/rb/sequel-nonsequential_id.svg)](http://badge.fury.io/rb/sequel-nonsequential_id) 
+[![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/sequel-nonsequential_id?type=total)](https://rubygems.org/gems/sequel-nonsequential_id)
+
+Automatically generate non-sequential (pseudo-random) IDs for Sequel Models
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel-nonsequential_id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-nonsequential_id
+
+## Usage
+
+```ruby
+# Enable nonsequential id for all Models
+Sequel::Model.plugin :nonsequential_id
+
+# Enable nonsequential id on a specific model (defaults to the :id field)
+class Artist < Sequel::Model
+  plugin :nonsequential_id 
+end
+
+
+# Enable nonsequential id on a specific model using a custom id field
+class Artist < Sequel::Model
+  plugin :nonsequential_id, id_field: :custom_id_field
+end
+```
+
+## Continuous Integration
+Tested in a CI environment against the following Ruby versions:
+* ruby-head
+* 2.5
+* 2.4
+* 2.3
+
+
+## Contributing
+
+1. Fork it ( https://github.com/dashingrocket/sequel-nonsequential_id/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+desc 'Run tests'
+task :default => [:test]

data/lib/sequel/plugins/nonsequential_id.rb

@@ -0,0 +1,37 @@
+require 'securerandom'
+
+module Sequel
+  module Plugins
+    module NonsequentialId
+      def self.configure(model, opts = {})
+        model.instance_eval do
+          @id_field = opts[:id_field] || :id
+        end
+      end
+
+      module ClassMethods
+        attr_reader :id_field
+        Sequel::Plugins.inherited_instance_variables(self, :@id_field => nil)
+      end
+
+      module InstanceMethods
+        def before_create
+          set_nonsequential_id
+          super
+        end
+
+        private def set_nonsequential_id
+          method = :"#{model.id_field}="
+
+          loop do
+            id = SecureRandom.hex.hex.to_s(36)
+            unless model.first("#{model.id_field}": id)
+              set_column_value(method, id)
+              return id
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sequel-unique_id.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sequel-nonsequential_id'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Jesse Bowes']
+  spec.email         = ['jbowes@dashingrocket.com']
+  spec.summary       = 'Sequel Non-Sequential Unique ID Plugin'
+  spec.description   = 'Automatically generate non-sequential (pseudo-random) IDs for Sequel Models'
+  spec.homepage      = 'https://github.com/dashingrocket/sequel-nonsequential_id'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sequel', '~> 5.13'
+
+  spec.add_development_dependency 'test-unit', '~> 3.2'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+end

data/shippable.yml

@@ -0,0 +1,7 @@
+language: ruby
+
+rvm:
+  - ruby-head
+  - 2.5
+  - 2.4
+  - 2.3

data/test/nonsequential_id_test.rb

@@ -0,0 +1,62 @@
+require 'test/unit'
+require 'sequel'
+
+require_relative '../lib/sequel/plugins/nonsequential_id'
+
+DB = Sequel.sqlite
+
+DB.create_table :test_models do
+  primary_key :id, type: String, auto_increment: false
+  String :name
+end
+
+DB.create_table :test_model2s do
+  primary_key :custom_id, type: String, auto_increment: false
+  String :name
+end
+
+class TestModel < Sequel::Model
+  plugin :nonsequential_id
+end
+
+class TestModel2 < Sequel::Model
+  plugin :nonsequential_id, id_field: :custom_id
+end
+
+class NonsequentialIdTest < Test::Unit::TestCase
+  def setup
+
+  end
+
+  def test_nonsequential_id
+    obj1 = TestModel.create(name: 'obj1')
+    obj2 = TestModel.create(name: 'obj2')
+
+    assert_kind_of String, obj1.id
+    assert_kind_of String, obj2.id
+
+    assert_not_empty obj1.id
+    assert_not_empty obj2.id
+
+    assert_not_equal obj1.id, obj2.id
+
+    assert_equal(obj1.id, TestModel.first(id: obj1.id).id)
+    assert_equal(obj2.id, TestModel.first(id: obj2.id).id)
+  end
+
+  def test_test_nonsequential_id_custom_field
+    obj1 = TestModel2.create(name: 'obj1')
+    obj2 = TestModel2.create(name: 'obj2')
+
+    assert_kind_of String, obj1.custom_id
+    assert_kind_of String, obj2.custom_id
+
+    assert_not_empty obj1.custom_id
+    assert_not_empty obj2.custom_id
+
+    assert_not_equal obj1.custom_id, obj2.custom_id
+
+    assert_equal(obj1.custom_id, TestModel2.first(custom_id: obj1.custom_id).custom_id)
+    assert_equal(obj2.custom_id, TestModel2.first(custom_id: obj2.custom_id).custom_id)
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: sequel-nonsequential_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jesse Bowes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.13'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Automatically generate non-sequential (pseudo-random) IDs for Sequel
+  Models
+email:
+- jbowes@dashingrocket.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sequel/plugins/nonsequential_id.rb
+- sequel-unique_id.gemspec
+- shippable.yml
+- test/nonsequential_id_test.rb
+homepage: https://github.com/dashingrocket/sequel-nonsequential_id
+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: Sequel Non-Sequential Unique ID Plugin
+test_files:
+- test/nonsequential_id_test.rb