acts_as_keyed 0.0.8 → 0.1.0

data/Gemfile

@@ -2,3 +2,8 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in acts_as_keyed.gemspec
 gemspec
+
+# Development dependencies 
+gem "rake"
+gem "activesupport", "~>3.0"
+gem "sqlite3-ruby"

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Jeremy Hubert
+
+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/Rakefile

@@ -1,2 +1,15 @@
 require 'bundler'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the restful_authentication plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
 Bundler::GemHelper.install_tasks

data/acts_as_keyed.gemspec

@@ -12,10 +12,10 @@ Gem::Specification.new do |s|
   s.summary     = %q{Automatically key an active record model with a unique key}
   s.description = %q{A simple plugin that automatically generates a key for a model on create. It takes care of protecting the key, automatically generating it and making sure it is unique.}
 
+  s.add_dependency "activerecord", "~> 3.0"
   s.rubyforge_project = "acts_as_keyed"
 
   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.test_files    = `git ls-files -- test/*`.split("\n")
   s.require_paths = ["lib"]
 end

data/lib/acts_as_keyed/class_methods.rb

@@ -0,0 +1,30 @@
+module ActsAsKeyed
+  module ClassMethods
+    def acts_as_keyed(options={})
+      before_validation :create_key, :on => :create
+      class_attribute :options
+
+      options[:as_param] ||= false
+      options[:size] ||= 10
+      options[:chars] ||= ('a'..'z').to_a + ('A'..'Z').to_a + (1..9).to_a - ['l','I','O']
+
+      self.options = options
+
+      raise ArgumentError, "#{self.name} is missing key column" if ActiveRecord::Base.connection.table_exists?(self.table_name) && columns_hash['key'].nil?
+
+      attr_protected :key
+
+      class << self
+        def find(*args)
+          if self.options[:as_param] && args.first.is_a?(String)
+            find_by_key(args)
+          else
+            super(*args)
+          end
+        end
+      end
+    
+      include InstanceMethods
+    end
+  end
+end

data/lib/acts_as_keyed/errors.rb

@@ -0,0 +1,7 @@
+module ActsAsKeyed
+  class NoAvailableKeys < StandardError
+    def to_s
+      'Very few unique keys are still available. Please change your acts_as_keyed chars or size settings.'
+    end
+  end
+end

data/lib/acts_as_keyed/instance_methods.rb

@@ -0,0 +1,32 @@
+module ActsAsKeyed
+  module InstanceMethods
+
+    def to_param
+      options[:as_param] ? self.key : self.id.to_s
+    end
+
+    def regenerate_key!
+      self.create_key
+      self.save
+    end
+
+    protected
+
+    def create_key
+      k = nil
+      100.times do
+        k = random_key
+        break if self.class.count(:conditions => { :key => k }) == 0
+        k = nil
+      end
+      raise NoAvailableKeys if k.nil?
+      self.key = k
+    end
+
+    def random_key
+      code_array=[]
+      1.upto(options[:size]) { code_array << options[:chars][rand(options[:chars].length)] }
+      code_array.join('')
+    end
+  end
+end

data/lib/acts_as_keyed/version.rb

@@ -1,3 +1,3 @@
 module ActsAsKeyed
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

data/lib/acts_as_keyed.rb

@@ -1,66 +1,12 @@
+require 'active_record'
+require 'acts_as_keyed/errors'
+require 'acts_as_keyed/class_methods'
+require 'acts_as_keyed/instance_methods'
+
 module ActsAsKeyed
   def self.included(base)
     base.extend ClassMethods
   end
-
-  module ClassMethods
-    def acts_as_keyed(options={})
-      class_inheritable_accessor :options
-      options[:size] ||= 10
-      options[:chars] ||= ('a'..'z').to_a + ('A'..'Z').to_a + (1..9).to_a - ['l','I','O']
-      self.options = options
-
-      raise ArgumentError, "#{self.name} is missing key column" if columns_hash['key'].nil?
-
-      if Rails.version < '3'
-        before_validation_on_create :create_key
-      else
-        before_validation :create_key, :on => :create
-      end
-
-      attr_protected :key
-
-      class << self
-        def find(*args)
-          if self.options[:as_param] && args.first.is_a?(String)
-            find_by_key(args)
-          else
-            super(*args)
-          end
-        end
-      end
-    
-      include InstanceMethods
-    end
-  end
-
-  module InstanceMethods
-
-    def to_param
-      options[:as_param] ? self.key : self.id.to_s
-    end
-
-    def regenerate_key!
-      self.create_key
-      self.save
-    end
-
-    protected
-
-    def create_key
-      k = random_key
-      while(self.class.count(:conditions => { :key => k }) > 0)
-        k = random_key
-      end
-      self.key = k
-    end
-
-    def random_key
-      code_array=[]
-      1.upto(options[:size]) { code_array << options[:chars][rand(options[:chars].length)] }
-      code_array.join('')
-    end
-  end
 end
 
 ActiveRecord::Base.send :include, ActsAsKeyed

data/test/acts_as_keyed_test.rb

@@ -0,0 +1,83 @@
+require 'test/test_helper'
+
+class ActsAsKeyedBaseTest < ActiveSupport::TestCase
+  def setup
+  end
+
+  def teardown
+  end
+end
+
+class ActsAsKeyedTest < ActsAsKeyedBaseTest
+  test "should generate key on create" do
+    owk_setup
+
+    o = ObjectWithKey.create()
+    assert_not_nil o.key
+  end
+
+  test "should generate key based on custom characters" do
+    owk_setup(:chars => ['a'])
+
+    o = ObjectWithKey.create
+    assert_equal 'aaaaaaaaaa', o.key
+  end
+
+  test "should generate key based on size parameter" do
+    owk_setup(:size => 2)
+
+    o = ObjectWithKey.create
+    assert_equal 2, o.key.length
+  end
+
+  test "should treat key as a protected attribute" do
+    owk_setup
+
+    o = ObjectWithKey.create
+    o.update_attributes(:key => 'hello')
+    assert_not_equal 'hello', o.key
+  end
+
+  test "should require a unique key" do
+    owk_setup(:chars => (0...10).to_a, :size => 1)
+
+    sum = 0
+    10.times do
+      o = ObjectWithKey.create
+      sum += o.key.to_i
+    end
+
+    assert_equal 45, sum
+  end
+
+  test "should raise an error if no unique keys can be found easily" do
+    owk_setup(:chars => ['a'], :size => 1)
+
+    error = false
+    begin
+      2.times do
+        o = ObjectWithKey.create
+      end
+    rescue ActsAsKeyed::NoAvailableKeys
+      error = true
+    end
+
+    assert error
+  end
+
+  test "should fail if object doesn't have key column" do
+    output = nil
+    begin
+      ObjectWithoutKey.acts_as_keyed
+    rescue ArgumentError => e
+      output = e.message
+    end
+    assert_equal "ObjectWithoutKey is missing key column", output
+  end
+
+  private
+
+  def owk_setup(options = {})
+    ObjectWithKey.acts_as_keyed(options)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_record'
+require 'active_model'
+
+$:.unshift "#{File.dirname(__FILE__)}/../"
+$:.unshift "#{File.dirname(__FILE__)}/../lib/"
+
+require 'acts_as_keyed'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :objects_with_key_column do |t|
+    t.string    :key
+  end
+
+  create_table :objects_without_key_column do |t|
+    t.string    :name
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class ObjectWithKey < ActiveRecord::Base
+  self.table_name = 'objects_with_key_column'
+end
+
+class ObjectWithoutKey < ActiveRecord::Base
+  self.table_name = 'objects_without_key_column'
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_keyed
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 8
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jeremy Hubert
@@ -15,9 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-22 00:00:00 Z
-dependencies: []
-
+date: 2012-02-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
 description: A simple plugin that automatically generates a key for a model on create. It takes care of protecting the key, automatically generating it and making sure it is unique.
 email: 
 - jhubert@gmail.com
@@ -28,13 +42,20 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gemtest
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - acts_as_keyed.gemspec
 - lib/acts_as_keyed.rb
+- lib/acts_as_keyed/class_methods.rb
+- lib/acts_as_keyed/errors.rb
+- lib/acts_as_keyed/instance_methods.rb
 - lib/acts_as_keyed/version.rb
+- test/acts_as_keyed_test.rb
+- test/test_helper.rb
 homepage: http://github.com/jhubert/acts-as-keyed
 licenses: []
 
@@ -64,9 +85,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: acts_as_keyed
-rubygems_version: 1.8.6
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Automatically key an active record model with a unique key
-test_files: []
-
+test_files: 
+- test/acts_as_keyed_test.rb
+- test/test_helper.rb