vanity_slug 0.0.2 → 0.0.3

data/README.md

@@ -1,11 +1,14 @@
 # VanitySlug
 
-Add unique vanity urls to any model without use of redirects. 
-Routing trickery via middleware like so:
+Add unique vanity urls to any model without use of redirects. Middleware matches routes that don't resolve with the Rails router and checks if they match a slug from any vanity-slug enabled model. If found, the env["PATH_INFO"] is changed like so:
+
+    Given a Post with slug "my-post-title" and id 1, and a Category with slug "the-category" and id 2:
 
     "/my-post-title" => "/posts/1"
     "/the-category" => "/category/2"
 
+This lets Rails do the rest of the work.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,11 +29,11 @@ Or install it yourself as:
 
 ### Options
   
-  * action: route vanity slug will resolve to, "/posts/:id"
-  * field_to_slug: which column to use in vanity slug generation
-  * slug_field: which column to store generated slug
+  * action: route vanity slug will resolve to (default: RESTful show route i.e. "/posts/:id"). Route must be defined.
+  * field_to_slug: which column to use in vanity slug generation (default: :name).
+  * slug_field: which column to store generated slug (default: :slug).
   * uniqueness_scope: method or attribute to use as uniqueness check in slug
-    generation
+    generation (default: nil).
 
 #### Config
 
@@ -38,7 +41,12 @@ Or install it yourself as:
     VanitySlug.path_scope Proc.new { |env| { } }
   ```
 
-Use to scope the finder based on rack env, i.e. host parameter.
+Use to scope the finder based on rack env, i.e. host parameter. Should return a hash suitable for a `where` relational argument.
+
+### Gotchas
+
+  * no catch all routes may be used in Rails, otherwise the route collision check
+    will always find a matching route
 
 ## Examples:
 

data/lib/vanity_slug/active_record.rb

@@ -9,7 +9,8 @@ ActiveSupport.on_load :active_record do
 
         opts = {
           field_to_slug: :name,
-          slug_field: :slug
+          slug_field: :slug,
+          action: "/#{self.to_s.tableize}/:id"
         }.merge opts
 
         class_attribute :has_vanity_slug_opts
@@ -32,7 +33,7 @@ ActiveSupport.on_load :active_record do
       module InstanceMethods
 
         def get_vanity_action
-          action = self.class.has_vanity_slug_opts[:action] 
+          action = self.class.has_vanity_slug_opts[:action]
 
           if action.is_a?(Proc)
             self.instance_eval &action
@@ -75,23 +76,13 @@ ActiveSupport.on_load :active_record do
             errors.add :slug, "already exists"
           end
 
-          if defined?(Rails)
-            begin
-              if Rails.application.routes.recognize_path(slug) 
-                errors.add :slug, "conflicts with another url"
-              end
-            rescue ActionController::RoutingError
-            end
+          if VanitySlug.check_route_collision(slug_to_check)
+            errors.add :slug, "conflicts with another url"
           end
         end
 
         def vanity_slug_exists?(potential_slug)
-          if defined?(Rails)
-            begin
-              return true if Rails.application.routes.recognize_path(potential_slug) 
-            rescue ActionController::RoutingError
-            end
-          end
+          return true if VanitySlug.check_route_collision(potential_slug) 
 
           VanitySlug.classes.any? do |klass|
             scope = klass.has_vanity_slug_opts[:uniqueness_scope] 
@@ -128,8 +119,18 @@ ActiveSupport.on_load :active_record do
         
         obj.get_vanity_action + File.extname(path)
       end
-    end
 
+      def check_route_collision(path)
+        if defined?(Rails)
+          begin
+            return true if Rails.application.routes.recognize_path(path)
+          rescue ActionController::RoutingError
+            false
+          end
+        end
+      end
+
+    end
   end
 
   ActiveRecord::Base.extend VanitySlug::ActiveRecord

data/lib/vanity_slug/version.rb

@@ -1,3 +1,3 @@
 module VanitySlug
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/vanity_slug.rb

@@ -1,3 +1,5 @@
+require "active_support/all"
+
 require "vanity_slug/version"
 require "vanity_slug/active_record"
 

data/spec/vanity_slug_spec.rb

@@ -8,8 +8,7 @@ VanitySlug.path_scope = Proc.new{|env|
 class Post < ActiveRecord::Base
   attr_accessible :title, :site
 
-  has_vanity_slug action: "/posts/:id", 
-    field_to_slug: :title, 
+  has_vanity_slug field_to_slug: :title,
     uniqueness_scope: :site_id
 
   belongs_to :site

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vanity_slug
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: