scoped_id 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e98b2cafc0f93b81f6b9872ce8c01a1f9a51c5be
+  data.tar.gz: e0f6d16fa4c5532d6b1588ba4ad535015d5ea205
+SHA512:
+  metadata.gz: 3f6ca0dea90dfabfd778f40ed6615153f438f4672c70093fbdfa7b3271c664ed0c4686381eeac686775eeebca94683564a367ba65fcf45440b2b7d396107e800
+  data.tar.gz: b633b35869cdf8b33d0ea87063053c208fe4a6c2ce6d80449b4ab80a8dfe20f7199bbd6071a335d334e211e2ff43ab3386c7ed6221e23dce4fa04592d5de4dba

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scoped_id.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michel Billard
+
+MIT License
+
+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,42 @@
+# scoped_id
+
+Generates scoped unique identifiers.
+
+## Installation
+
+Add `scoped_id` to your Gemfile:
+
+    gem 'scoped_id', '~> 0.0.1'
+
+## Usage
+
+```
+class Project < ActiveRecord::Base
+  include ScopedId::Concern
+  scoped_id :per_owner_id, scope: :owner_id
+end
+
+jacks_project = Project.create(owner_id: 1)
+jacks_project.per_owner_id # => 1
+
+johns_project = Project.create(owner_id: 2)
+johns_project.per_owner_id # => 1
+```
+
+The scoped_id is generated in a `before_create` callback unless it has been manually set.
+
+The scoped_id will be marked as readonly and will validate the uniqueness of its value.
+
+### Options
+
+#### Scope (required)
+
+The scope by which to determine the next identifier when creating a new object.
+
+## Contributing
+
+1. Fork it ( http://github.com/mbillard/scoped_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 new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")

data/lib/scoped_id/concern.rb

@@ -0,0 +1,56 @@
+require 'active_record'
+require 'active_support/concern'
+
+module ScopedId
+
+  ScopedIdDefinition = Struct.new(:attr_name, :scope_attr)
+
+  module Concern
+    extend ActiveSupport::Concern
+
+    included do
+      before_create :generate_next_scoped_ids
+    end
+
+    module ClassMethods
+      def scoped_id(attr_name, options = {})
+        scope = options[:scope]
+        if scope.nil?
+          raise ArgumentError.new(":scope is not defined. It is a mandatory option of scoped_id.")
+        end
+
+        scoped_ids_definitions << ScopedIdDefinition.new(attr_name, scope)
+
+        attr_readonly attr_name
+
+        validates_uniqueness_of attr_name, scope: scope
+      end
+
+      def scoped_ids_definitions
+        @scoped_ids_definitions ||= []
+      end
+    end
+
+    def generate_next_scoped_ids
+      self.class.scoped_ids_definitions.each do |definition|
+        attr_name = definition.attr_name
+        if send("#{attr_name}").nil?
+          send "#{attr_name}=", send("get_next_scoped_id", definition)
+        end
+      end
+    end
+
+    def get_next_scoped_id(scoped_id_definition)
+      attr_name  = scoped_id_definition.attr_name
+      scope_attr = scoped_id_definition.scope_attr
+
+      scope = self.class.where(scope_attr => read_attribute(scope_attr))
+      current_max_scoped_id = scope.maximum(attr_name) || 0
+      current_max_scoped_id + 1
+    end
+
+  end
+end
+
+# Uncomment to auto-extend ActiveRecord, probably not a good idea
+# ActiveRecord::Base.send(:extend, ScopedId)

data/lib/scoped_id/errors.rb

@@ -0,0 +1,13 @@
+module ScopedId
+
+  class ReadonlyAttributeError < StandardError
+    attr_reader :attribute
+
+    def initialize(attr_name, message = nil)
+      @attribute = attr_name
+      message ||= "#{attr_name} is readonly."
+      super(message)
+    end
+  end
+
+end

data/lib/scoped_id/version.rb

@@ -0,0 +1,3 @@
+module ScopedId
+  VERSION = '0.0.1'.freeze
+end

data/lib/scoped_id.rb

@@ -0,0 +1,3 @@
+require 'scoped_id/version'
+require 'scoped_id/concern'
+require 'scoped_id/errors'

data/scoped_id.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scoped_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scoped_id"
+  spec.version       = ScopedId::VERSION
+  spec.authors       = ["Michel Billard"]
+  spec.email         = ["michel@mbillard.com"]
+  spec.summary       = "Generates scoped unique identifiers"
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "http://github.com/mbillard/scoped_id"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 'activerecord', '>= 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+end

data/spec/scoped_id/concern_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe ScopedId do
+
+  class Model < BaseModel
+    scoped_id :owner_scoped_id, scope: :owner_id
+  end
+
+  it "generates 1 for the first ID" do
+    model = Model.create
+    model.owner_scoped_id.should == 1
+  end
+
+  it "generates 2 for the second ID" do
+    Model.create
+    model = Model.create
+    model.owner_scoped_id.should == 2
+  end
+
+  it "generates 1 if other models exist for a different scope" do
+    Model.create(owner_id: 3)
+    model = Model.create(owner_id: 7)
+    model.owner_scoped_id.should == 1
+  end
+
+  it "generates the next id even if a model was deleted" do
+    Model.create # 1
+    model_to_delete = Model.create # 2
+    Model.create # 3
+    model = Model.create
+
+    model_to_delete.destroy
+    model.owner_scoped_id.should == 4
+  end
+
+  it "marks the scoped id as readonly" do
+    model = Model.create
+    model.owner_scoped_id = 78
+    model.save
+    model.reload.owner_scoped_id.should == 1
+  end
+
+  it "allows setting a scoped id value before creation" do
+    model = Model.new
+    model.owner_scoped_id = 123
+    model.save
+    model.owner_scoped_id.should == 123
+  end
+
+  it "validates the uniqueness of the scoped id" do
+    Model.create(owner_scoped_id: 123)
+    model = Model.new(owner_scoped_id: 123)
+    model.valid?.should be_false
+  end
+
+  it "validates the uniqueness of the scoped id per scope" do
+    Model.create(owner_scoped_id: 123, owner_id: 13)
+    model = Model.new(owner_scoped_id: 123, owner_id: 9)
+    model.valid?.should be_true
+  end
+
+  it "raises an exception if scope is not specified" do
+    expect{
+      Class.new(BaseModel) do
+        scoped_id :owner_scoped_id # no scope
+      end
+    }.to raise_error(ArgumentError)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'pry'
+require 'scoped_id'
+
+# Require this file using `require 'spec_helper'` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.before :each do
+    Model.delete_all
+  end
+end
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3',
+                                        database: ':memory:')
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :models, force: true do |t|
+    t.string :owner_id
+    t.integer :owner_scoped_id
+  end
+
+end
+
+class BaseModel < ActiveRecord::Base
+  self.table_name = 'models'
+  include ScopedId::Concern
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: scoped_id
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Billard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rake
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: 
+email:
+- michel@mbillard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scoped_id.rb
+- lib/scoped_id/concern.rb
+- lib/scoped_id/errors.rb
+- lib/scoped_id/version.rb
+- scoped_id.gemspec
+- spec/scoped_id/concern_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/mbillard/scoped_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.3.0
+signing_key: 
+specification_version: 4
+summary: Generates scoped unique identifiers
+test_files:
+- spec/scoped_id/concern_spec.rb
+- spec/spec_helper.rb