couchbase-id 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c0049a7aa83f9c40a73745146062faec8f8802a
+  data.tar.gz: 91b16ae8153a4dde5b9538fd2ceef49836738343
+SHA512:
+  metadata.gz: 595a593873c6104558ae8bc93e0df7b30d6da9c9cb5b140e6faf1f4c5221e79fe31f90363b2c333622c5fef1b869bfee380a48bdc8fe9605af490d07fd2e3a43
+  data.tar.gz: 3f15376892527018890300b436ba5dac626073d4300430e4cf34012b44c88a482bab33c24a4f441e8aec82b7dfb888aa9fb0cec4ee9cfbc733d1741a893839e0

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 CoTag Media
+
+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,3 @@
+# Couchbase ID Generator
+
+Built to support efficient ID generation with XDCR capabilities

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'rspec/core/rake_task'  # testing framework
+require 'yard'                  # yard documentation
+
+
+
+# By default we don't run network tests
+task :default => :limited_spec
+RSpec::Core::RakeTask.new(:limited_spec) do |t|
+    # Exclude network tests
+    # t.rspec_opts = "--tag ~network" 
+end
+RSpec::Core::RakeTask.new(:spec)
+
+
+desc "Run all tests"
+task :test => [:spec]
+
+
+YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb', '-', 'ext/README.md', 'README.md']
+end

data/couchbase-id.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path("../lib/couchbase-id/version", __FILE__)
+
+Gem::Specification.new do |gem|
+    gem.name          = "couchbase-id"
+    gem.version       = CouchbaseId::VERSION
+    gem.license       = 'MIT'
+    gem.authors       = ["Stephen von Takach"]
+    gem.email         = ["steve@cotag.me"]
+    gem.homepage      = "https://github.com/cotag/couchbase-id"
+    gem.summary       = "Couchbase ID generator with XDCR support"
+    gem.description   = "Overwrites the existing couchbase-model id implementation"
+
+    gem.required_ruby_version = '>= 1.9.2'
+    gem.require_paths = ["lib"]
+
+    gem.add_runtime_dependency     'couchbase-model'
+    gem.add_runtime_dependency     'radix' # This converts numbers to the unicode representation
+
+    gem.add_development_dependency 'rspec', '>= 2.14'
+    gem.add_development_dependency 'rake', '>= 10.1'
+    gem.add_development_dependency 'yard'
+
+    gem.files = Dir["{lib}/**/*"] + %w(Rakefile couchbase-id.gemspec README.md LICENSE)
+    gem.test_files = Dir["spec/**/*"]
+    gem.extra_rdoc_files = ["README.md"]
+end

data/lib/couchbase-id/generator.rb

@@ -0,0 +1,117 @@
+#
+# This disables the built in generator, faster then running validations twice
+#  Forces models to include an ID generator
+#
+module Couchbase
+    class Model
+        class UUID
+            def initialize(*args)
+                
+            end
+            
+            def next(*args)
+                nil
+            end
+        end
+    end
+end
+
+#
+# This is our id generator, runs in the before save call back
+#
+module CouchbaseId
+    
+    # NOTE:: incr, decr, append, prepend == atomic
+    module Generator
+        
+
+        # Basic compression using UTF (more efficient for ID's stored as strings)
+        B65 = Radix::Base.new(Radix::BASE::B62 + ['-', '_', '~'])
+        B10 = Radix::Base.new(10)
+
+        # The cluster id this node belongs to (avoids XDCR clashes)
+        CLUSTER_ID ||= ENV['COUCHBASE_CLUSTER'] || 1     # Cluster ID number
+
+        # instance method
+        def generate_id
+            if self.id.nil?
+                name = "#{self.class.name.underscore.gsub!(/\/|_/, '-')}"      # The included classes name
+                
+                #
+                # Generate the id (incrementing values as required)
+                #
+                overflow = @@__overflow__ ||= self.class.bucket.get("#{name}:#{CLUSTER_ID}:overflow", :quiet => true) # Don't error if not there
+                count = self.class.bucket.incr("#{name}:#{CLUSTER_ID}:count", :create => true)     # This models current id count
+                if count == 0 || overflow.nil?
+                    overflow ||= 0
+                    overflow += 1
+                    # We shouldn't need to worry about concurrency here due to the size of count
+                    # Would require ~18446744073709551615 concurrent writes
+                    self.class.bucket.set("#{name}:#{CLUSTER_ID}:overflow", overflow)
+                    @@__overflow__ = overflow
+                end
+                
+                self.id = @@__class_id_generator__.call(name, overflow, count)
+                
+                
+                #
+                # So an existing id would only be present if:
+                # => something crashed before incrementing the overflow
+                # => this is another request was occurring before the overflow is incremented
+                #
+                # Basically only the overflow should be able to cause issues, we'll increment the count just to be sure
+                # One would hope this code only ever runs under high load during an overflow event
+                #
+                while self.class.bucket.get(self.id, :quiet => true).present?
+                    # Set in-case we are here due to a crash (concurrency is not an issue)
+                    # Note we are not incrementing the @__overflow__ variable
+                    self.class.bucket.set("#{name}:#{CLUSTER_ID}:overflow", overflow + 1)
+                    count = self.class.bucket.incr("#{name}:#{CLUSTER_ID}:count")               # Increment just in case (attempt to avoid infinite loops)
+                    
+                    # Reset the overflow
+                    if @@__overflow__ == overflow
+                        @@__overflow__ = nil
+                    end
+
+                    # Generate the new id
+                    self.id = @@__class_id_generator__.call(name, overflow + 1, count)
+                end
+            end
+        end
+
+        module ClassMethods
+            def default_class_id_generator(name, overflow, count)
+                id = Radix.convert([overflow, CLUSTER_ID].join.to_i, B10, B65) + Radix.convert(count, B10, B65)
+                "#{name}-#{id}"
+            end
+
+            #
+            # Override the default hashing function
+            #
+            def set_class_id_generator(callback = nil, &block)
+                callback ||= block
+                @@__class_id_generator__ = callback
+            end
+        end
+
+        def self.included(base)
+            base.extend(ClassMethods)
+
+            base.class_eval do
+                #
+                # Configure class level variables
+                @@__overflow__ ||= nil
+                @@__class_id_generator__ ||= method(:default_class_id_generator)
+
+                
+                #
+                # Best case we have 18446744073709551615 * 18446744073709551615 model entries for each database cluster
+                #  and we can always change the cluster id if this limit is reached
+                #
+                define_model_callbacks :save, :create
+                before_save :generate_id
+                before_create :generate_id
+            end
+        end
+    end # END:: Generator
+end

data/lib/couchbase-id/version.rb

@@ -0,0 +1,3 @@
+module CouchbaseId
+    VERSION = '1.0.0'
+end

data/lib/couchbase-id.rb

@@ -0,0 +1,7 @@
+require 'radix'
+require 'couchbase-model'
+require 'couchbase-id/generator'
+
+
+module CouchbaseId
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: couchbase-id
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stephen von Takach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: couchbase-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: radix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Overwrites the existing couchbase-model id implementation
+email:
+- steve@cotag.me
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/couchbase-id/generator.rb
+- lib/couchbase-id/version.rb
+- lib/couchbase-id.rb
+- Rakefile
+- couchbase-id.gemspec
+- README.md
+- LICENSE
+homepage: https://github.com/cotag/couchbase-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: 1.9.2
+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: Couchbase ID generator with XDCR support
+test_files: []
+has_rdoc: