unique_generator 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format=progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@unique_generate --create

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in unique_generator.gemspec
+gemspec
+
+gem "sqlite3"
+gem "bson_ext"
+gem "ci_reporter"

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+begin
+  require 'ci/reporter/rake/rspec'
+rescue LoadError => e
+end
+
+RSpec::Core::RakeTask.new do |task|
+  task.name = :spec
+end
+
+task :default => :spec

data/lib/unique_generator/version.rb

@@ -0,0 +1,3 @@
+module UniqueGenerator
+  VERSION = "0.0.1"
+end

data/lib/unique_generator.rb

@@ -0,0 +1,78 @@
+require "unique_generator/version"
+require "active_support/concern"
+
+module UniqueGenerator
+  extend ActiveSupport::Concern
+
+  def self.setup!
+    ActiveRecord::Base.send(:include, self) if defined?(ActiveRecord::Base)
+    MongoMapper::Document.plugin(self)      if defined?(MongoMapper::Document)
+  end
+  setup!
+
+  CHOICES = (Array('A'..'Z') + Array('a'..'z') + Array('0'..'9'))
+
+  included do
+    if defined?(ActiveRecord::Base) && self <= ActiveRecord::Base
+      include UniqueChecks::AR
+    elsif defined?(MongoMapper::Document) && self <= MongoMapper::Plugins::Document
+      include UniqueChecks::MM
+    end
+  end
+
+  module UniqueChecks
+
+    module MM
+      # Returns whether or not the given field is unique to every item.
+      def unique_field?(field_name)
+        scope = self.class.where(field_name => send(field_name))
+        scope = scope.where(:_id.ne => id) if id.present?
+        scope.empty?
+      end
+    end
+
+    module AR
+      # Returns whether or not the given field is unique to every item.
+      def unique_field?(field_name)
+        scope = self.class.where(field_name => send(field_name))
+        # When we have an id, check for those with a different id.
+        if id.present?
+          conditions = self.class.scoped.table[:id].eq(id).not
+          scope = scope.where(conditions)
+        end
+        scope.empty?
+      end
+    end
+
+  end
+  
+  module ClassMethods
+
+    # Generate a unique field
+    def generate_unique(length = 32, &blk)
+      unique = generate_random(length)
+      unique = generate_random(length) until blk.call(unique)
+      unique
+    end
+
+    # Generate a random string with the given number of characters.
+    def generate_random(length = 32)
+      (1..length).inject("") { |token, _| token << CHOICES.sample }
+    end
+    
+  end
+  
+  module InstanceMethods
+    
+    # Generate unique field.
+    def generate_unique_field!(name, size = 32)
+      return if send(name).present?
+      self.class.generate_unique(size) do |token|
+        send "#{name}=", token
+        unique_field? name
+      end
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Dir[Pathname(__FILE__).dirname.join("support", "**", "*.rb")].each { |f| require f }
+
+UniqueGenerator.setup!
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

data/spec/specific/active_record_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe UniqueGenerator, 'along side active record' do
+
+  # Temporary environment
+  let(:manager) { ReversibleData.manager_for(:users) }
+  before(:each) { manager.up! }
+  after(:each)  { manager.down! }
+
+  let(:example_model) { User }
+
+  it_should_behave_like 'a model with unique generator enabled'
+
+end

data/spec/specific/mongo_mapper_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe UniqueGenerator, 'along side mongo mapper' do
+
+  class ExampleModel
+    include MongoMapper::Document
+    include UniqueGenerator
+    
+    key :name,  String
+    key :token, String
+    
+  end
+
+  let(:example_model) { ExampleModel }
+  after(:each)        { ExampleModel.destroy_all }
+
+  it_should_behave_like 'a model with unique generator enabled'
+
+end

data/spec/support/reversible_data_setup.rb

@@ -0,0 +1,9 @@
+require 'reversible_data'
+
+ReversibleData.in_memory!
+ReversibleData.add :users do |t|
+  t.string :name
+  t.string :token
+end
+
+MongoMapper.database = 'unique_generator_test'

data/spec/support/shared_unique_specs.rb

@@ -0,0 +1,78 @@
+shared_examples_for 'a model with unique generator enabled' do
+
+  it 'should include the mixin' do
+    example_model.should be < UniqueGenerator
+  end
+
+  describe 'on an instance of an object' do
+    
+    before :each do
+      example_model.create! :name => "Test Name A"
+      example_model.create! :name => "Test Name B"
+      @other_model = example_model.create! :name => "Test Name C"
+    end
+    
+    it "should let you correctly check if a field has a unique value" do
+      example_model.create(:name => "Test Name A").should_not be_unique_field :name
+      example_model.create(:name => "Test Name D").should be_unique_field :name
+      @other_model.should be_unique_field :name
+      @other_model.name = 'Test Name A'
+      @other_model.should_not be_unique_field :name
+      
+    end
+    
+    it 'should let you generate a unique token' do
+      model = example_model.new
+      model.token.should be_blank
+      model.generate_unique_field! :token
+      model.token.should be_present
+    end
+    
+    it 'should let you generate the token length' do
+      model = example_model.new
+      model.generate_unique_field! :token, 100
+      model.token.length.should == 100
+    end
+    
+  end
+  
+  describe 'on a class including the mixin' do
+    
+    it 'should add a generate random method' do
+      example_model.should respond_to(:generate_random)
+      example_model.generate_random.should be_present
+      example_model.generate_random.should_not == example_model.generate_random
+    end
+    
+    it 'should let you specify the random string length' do
+      example_model.generate_random(32).length.should == 32
+      example_model.generate_random(64).length.should == 64
+      example_model.generate_random(16).length.should == 16
+    end
+    
+    it 'should let you generate a unique value' do
+      example_model.should respond_to(:generate_unique)
+      v = nil
+      example_model.generate_unique do |value|
+        v = value
+      end
+      v.should be_present
+    end
+    
+    it 'should use generate random until the predicate is true' do
+      times_called = 0
+      mock(example_model).generate_random(32).times(3)
+      example_model.generate_unique do |t|
+        (times_called += 1) == 3
+      end
+      times_called.should == 3
+    end
+    
+    it 'should let you pass an argument to generate random' do
+      mock(example_model).generate_random(64) { 'Test' }
+      example_model.generate_unique(64) { |t| true }
+    end
+    
+  end
+
+end

data/spec/unique_generator_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe UniqueGenerator do
+
+  it 'should be a module' do
+      UniqueGenerator.should be_a Module
+  end
+  
+end

data/unique_generator.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "unique_generator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "unique_generator"
+  s.version     = UniqueGenerator::VERSION
+  s.authors     = ["Darcy Laycock"]
+  s.email       = ["darcy@filtersquad.com"]
+  s.homepage    = "http://github.com/filtersquad/unique_generator"
+  s.summary     = %q{Makes generating unique fields in MongoMapper and ActiveRecord easy.}
+  s.description = %q{ActiveRecord, MongoMapper and general tools for generating unique values e.g. api keys and tokens.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "activesupport"
+
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "mongo_mapper"
+  s.add_development_dependency "reversible_data"
+  s.add_development_dependency "rr"
+  s.add_development_dependency "rspec"
+
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: unique_generator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Darcy Laycock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70246689187780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70246689187780
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70246689187360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70246689187360
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: &70246689186940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70246689186940
+- !ruby/object:Gem::Dependency
+  name: reversible_data
+  requirement: &70246689186520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70246689186520
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70246689186100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70246689186100
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70246689202040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70246689202040
+description: ActiveRecord, MongoMapper and general tools for generating unique values
+  e.g. api keys and tokens.
+email:
+- darcy@filtersquad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Rakefile
+- lib/unique_generator.rb
+- lib/unique_generator/version.rb
+- spec/spec_helper.rb
+- spec/specific/active_record_spec.rb
+- spec/specific/mongo_mapper_spec.rb
+- spec/support/reversible_data_setup.rb
+- spec/support/shared_unique_specs.rb
+- spec/unique_generator_spec.rb
+- unique_generator.gemspec
+homepage: http://github.com/filtersquad/unique_generator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Makes generating unique fields in MongoMapper and ActiveRecord easy.
+test_files:
+- spec/spec_helper.rb
+- spec/specific/active_record_spec.rb
+- spec/specific/mongo_mapper_spec.rb
+- spec/support/reversible_data_setup.rb
+- spec/support/shared_unique_specs.rb
+- spec/unique_generator_spec.rb