quick_short 0.0.1 → 0.1.0

data/lib/quick_short/duplicate_prefix.rb

@@ -0,0 +1,13 @@
+module QuickShort
+
+  class DuplicatePrefix < StandardError
+
+    # When trying to register the same key twice
+    def initialize(prefix)
+      klass = QuickShort.short_id_prefixes[prefix]
+      super "Duplicate prefix: #{prefix} (already assigned to #{klass.name})"
+    end
+
+  end
+
+end

data/lib/quick_short/has_short_id.rb

@@ -0,0 +1,36 @@
+module QuickShort
+
+  # A mixin for registering a class with short_ids
+  module HasShortId
+
+    # Register this class with QuickShort with a certain
+    # prefix.  With prefix 'a', will generate ids like 'a-lksdjf'
+    # @param [String] prefix - The prefix for this class
+    def has_short_id(prefix)
+      send(:include, InstanceMethods)  
+      if QuickShort.short_id_prefixes.has_key?(prefix)
+        raise QuickShort::DuplicatePrefix.new(prefix)
+      else
+        QuickShort.short_id_prefixes[prefix] = self
+        self
+      end
+    end
+
+    # Instance methods for things that has_short_id
+    module InstanceMethods
+
+      # Get the short id (expects a method named #id to be
+      # defined on this class)
+      # @return [String] the generated short id
+      def short_id
+        if id
+          prefix = QuickShort.short_id_prefixes.key(self.class)
+          "#{prefix}-#{QuickShort::ShortId.encode(id)}"
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/quick_short/no_such_prefix.rb

@@ -0,0 +1,12 @@
+module QuickShort
+
+  # When there is no such prefix
+  class NoSuchPrefix < StandardError
+
+    def initialize(prefix)
+      super "No such prefix registered: #{prefix}"
+    end
+
+  end
+
+end

data/lib/quick_short/short_id.rb

@@ -1,30 +1,50 @@
 module QuickShort
 
+  # This module handles the actual encoding and decoding
+  # of the IDs
   module ShortId
 
-    AlphabetLength = QuickShort::Alphabet.length # optimization
-    
-    # Encode a numeric ID
-    def self.encode(id)
-      alpha = ''
-      while id != 0
-        alpha = QuickShort::Alphabet[id % AlphabetLength].chr + alpha
-        id /= AlphabetLength
+    # This is the sequence of characters we use to encode the ID
+    # Note: We cut out vowels to avoid shortened strings from mistakenly
+    # forming words
+    DefaultAlphabet = 'bcdfghjklmnpqrstvwxyz0123456789BCDFGHJKLMNPQRSTVWXYZ'
+
+    class << self
+
+      # Get the alphabet to use
+      def alphabet
+        @alphabet ||= DefaultAlphabet
       end
-      alpha
-    end
-    
-    # Decode an ID created with encode
-    def self.decode(alpha)
-      alpha = alpha.dup; id = 0
-      0.upto(alpha.length - 1) do |i|
-        letter = alpha[alpha.length - 1]
-        alphabet_index = QuickShort::Alphabet.index letter
-        raise ArgumentError.new("Character not in Alphabet: #{letter}") unless alphabet_index # bad character present
-        id += alphabet_index * (AlphabetLength ** i)
-        alpha.chop!
+
+      # Encode a numeric ID
+      # @param [Fixnum] id - the ID to encode
+      # @return [String] the encoded ID
+      def encode(id)
+        alpha = ''
+        while id != 0
+          alpha = alphabet[id % alphabet.length].chr + alpha
+          id /= alphabet.length
+        end
+        alpha
+      end
+
+      # Decode an ID created with encode
+      # @param [String] the ID to decode
+      # @return [Fixnum] the decoded ID
+      def decode(alpha)
+        alpha = alpha.dup; id = 0
+        0.upto(alpha.length - 1) do |i|
+          letter = alpha[alpha.length - 1]
+          alphabet_index = alphabet.index letter
+          unless alphabet_index # bad character present?
+            raise ArgumentError.new("Character not in Alphabet: #{letter}")
+          end
+          id += alphabet_index * (alphabet.length ** i)
+          alpha.chop!
+        end
+        id
       end
-      id
+
     end
     
   end

data/lib/quick_short/version.rb

@@ -1,5 +1,5 @@
 module QuickShort
 
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
   
 end

data/lib/quick_short.rb

@@ -1,10 +1,54 @@
 module QuickShort
 
-  # This is the sequence of characters we use to encode the ID
-  # Note: We cut out vowels to avoid shortened strings from mistakenly
-  # forming words
-  Alphabet = 'bcdfghjklmnpqrstvwxyz0123456789BCDFGHJKLMNPQRSTVWXYZ'
+  autoload :ShortId, File.dirname(__FILE__) + '/quick_short/short_id'
+  autoload :HasShortId, File.dirname(__FILE__) + '/quick_short/has_short_id'
+
+  autoload :DuplicatePrefix, File.dirname(__FILE__) + '/quick_short/duplicate_prefix'
+  autoload :NoSuchPrefix, File.dirname(__FILE__) + '/quick_short/no_such_prefix'
+
+  autoload :VERSION, File.dirname(__FILE__) + '/quick_short/version'
+
+  class << self
+
+    # The current mapping of short_id_prefixes
+    # @return [Hash] the mapping
+    def short_id_prefixes
+      @prefixes ||= {}
+    end
+
+    # A convenient alias for #find which locates the class and calls find(id)
+    # @param [String] short_id - the short id to look up
+    def find(short_id)
+      lookup(short_id) do |klass, id|
+        klass.find id
+      end
+    end
+
+    # A convenient alias for #find_by_id which locates the class and calls
+    # find_by_id(id)
+    # @param [String] short_id - the short id to look up
+    def find_by_short_id(short_id)
+      lookup(short_id) do |klass, id|
+        klass.find_by_id id
+      end
+    end
+
+    # Look up a short id, and yield [klass, id] to a block, or return as array
+    # @param [String] short_id - the short id to look up
+    def lookup(short_id)
+      prefix, short_id = short_id.split('-', 2)
+      if klass = short_id_prefixes[prefix]
+        id = QuickShort::ShortId.decode(short_id)
+        if block_given?
+          yield klass, id # return result
+        else
+          [klass, id] # otherwise, return [klass, id]
+        end
+      else
+        raise NoSuchPrefix.new(prefix)
+      end
+    end
+
+  end
 
-  require 'lib/quick_short/short_id.rb'
-  
 end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+begin
+  require 'simplecov'
+  SimpleCov.start
+rescue LoadError
+  # oh well
+end
+
+# Load
+require File.join(File.dirname(__FILE__), '..', 'lib', 'quick_short')
+
+# ensure that a number makes a successful round trip and then
+# return its encoding
+def ensure_numeric_round_trip(number)
+  encoding = QuickShort::ShortId.encode(number)
+  QuickShort::ShortId.decode(encoding).should == number
+  encoding
+end

metadata

@@ -1,82 +1,64 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: quick_short
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - John Crepezzi
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-08-25 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &22384760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: quick_short is a really awesome way to generate short URLs (especially for local resources)
+  prerelease: false
+  version_requirements: *22384760
+description: quick_short is a really awesome way to generate short URLs (especially
+  for local resources)
 email: john@crepezzi.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/quick_short/short_id.rb
+files:
+- lib/quick_short/has_short_id.rb
+- lib/quick_short/no_such_prefix.rb
 - lib/quick_short/version.rb
+- lib/quick_short/duplicate_prefix.rb
+- lib/quick_short/short_id.rb
 - lib/quick_short.rb
-has_rdoc: true
+- spec/spec_helper.rb
 homepage: http://seejohnrun.github.com/quick_short/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: quick-short
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Rails Short URL Library - Employs Magic
-test_files: []
-
+test_files:
+- spec/spec_helper.rb