speaking_id 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+0.1.0 (Jan 15, 2010)
+
+* initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Martin Jagusch
+
+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.rdoc

@@ -0,0 +1,52 @@
+= SpeakingId
+
+Creates simple and secure slugs from a given string or random slugs to hide a model ID.
+
+== Installation
+
+You can set it up as a gem in your environment.rb file.
+
+  config.gem "speaking_id"
+
+And then install the gem.
+
+  sudo rake gems:install
+
+Alternatively you can install it as a Rails plugin.
+
+  script/plugin install git://github.com/venlix/speaking_id.git
+
+== Instructions
+
+In your models:
+
+	class User < ActiveRecord::Base
+		has_slug :name
+	end
+	
+	class Project < ActiveRecord::Base
+		has_random_slug
+	end
+
+In your migrations:
+
+	class AddSpeakingIdToUserAndProject < ActiveRecord::Migration
+		def self.up
+			add_column :users, 		:slug, :string
+			add_column :project, 	:slug, :string
+			
+			add_index :users,		:slug, :unique => true
+			add_index :project, :slug, :unique => true
+		end
+		
+		def	self.down
+			remove_column :users, 	:slug
+			remove_column :project, :slug
+		end
+	end
+
+By default, SpeakingId uses a column called "slug". If you want to use a different column name, just pass the +:column+ option:
+
+	has_slug :title, :column => :column_name
+
+This works also with the +has_random_slug+ method.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/init.rb

@@ -0,0 +1 @@
+require 'speaking_id'

data/lib/speaking_id.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/speaking_id/speaking_id'
+
+if defined?(ActiveRecord)
+  ActiveRecord::Base.instance_eval {extend SpeakingId::ClassMethods}
+end

data/lib/speaking_id/speaking_id.rb

@@ -0,0 +1,54 @@
+module SpeakingId
+  module ClassMethods
+    def has_slug source, args = {}
+      include InstanceMethods
+
+      class_inheritable_accessor :slug_source, :slug_column
+      
+      self.slug_source = source
+      self.slug_column = args.has_key?(:column) ? args[:column] : :slug
+
+      before_save :create_slug
+    end
+
+    def has_random_slug args = {}
+      include InstanceMethods
+
+      class_inheritable_accessor :slug_column
+      
+      self.slug_column = args.has_key?(:column) ? args[:column] : :slug
+
+      before_save :create_random_slug
+    end
+  end
+
+  module InstanceMethods
+    def create_slug
+      begin
+        self[self.slug_column] = self[self.slug_source].to_s.parameterize("_")
+        self[self.slug_column] << ((counter ||= 1) == 1 ? nil : counter).to_s
+        counter += 1
+      end while slug_taken?
+    end
+
+    def create_random_slug
+      begin
+        self[self.slug_column] = create_random_token
+      end while slug_taken?
+    end
+
+    def to_param
+      self[self.slug_column]
+    end
+
+    private
+
+    def create_random_token limit = 6
+      ActiveSupport::SecureRandom.hex(limit).upcase
+    end
+    
+    def slug_taken?
+      self.class.first :conditions => {self.slug_column.to_sym => self[self.slug_column]}
+    end
+  end
+end

data/test/speaking_id_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class SpeakingIdTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: speaking_id
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Martin Jagusch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-15 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Creates simple and secure slugs from a given string or random slugs to hide a model ID.
+email: m@venlix.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE
+files: 
+- lib/speaking_id/speaking_id.rb
+- lib/speaking_id.rb
+- test/speaking_id_test.rb
+- test/test_helper.rb
+- LICENSE
+- README.rdoc
+- Rakefile
+- CHANGELOG.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/venlix/speaking_id
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --charset=UTF-8
+- --title
+- SpeakingId
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple slugs for ActiveRecord models.
+test_files: []
+