vanity_slug 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vanity_slug.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'debugger'
+  gem 'activerecord'
+  gem 'sqlite3'
+  gem 'simplecov', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nick Merwin
+
+MIT License
+
+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.md

@@ -0,0 +1,84 @@
+# VanitySlug
+
+Add unique vanity urls to any model without use of redirects. 
+Routing trickery via middleware like so:
+
+    "/my-post-title" => "/posts/1"
+    "/the-category" => "/category/2"
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vanity_slug'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vanity_slug
+
+## Usage
+
+    has_vanity_slug
+
+### 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
+  * uniqueness_scope: method or attribute to use as uniqueness check in slug
+    generation
+
+#### Config
+
+  ```ruby
+    VanitySlug.path_scope Proc.new { |env| { } }
+  ```
+
+Use to scope the finder based on rack env, i.e. host parameter.
+
+## Examples:
+
+  ```ruby
+    class Post < ActiveRecord::Base
+      attr_accessible :title, :site
+
+      has_vanity_slug action: "/posts/:id", 
+        field_to_slug: :title, 
+        uniqueness_scope: :site_id
+
+      belongs_to :site
+    end
+
+    class Category < ActiveRecord::Base
+      attr_accessible :name, :site
+
+      has_vanity_slug action: "/categories/:id/slug", 
+        slug_field: :permalink
+
+      belongs_to :site
+    end
+
+    class Site < ActiveRecord::Base
+      attr_accessible :domain
+    end
+  ```
+
+### Initializer:
+
+  ```ruby
+    VanitySlug.path_scope = Proc.new{|env|
+      { organization_id: Organization.find_by_host(env["HTTP_HOST"]).try(:id) }
+    }
+  ```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/vanity_slug.rb

@@ -0,0 +1,10 @@
+require "vanity_slug/version"
+require "vanity_slug/active_record"
+
+if defined?(Rails)
+  require 'vanity_slug/vanity_router'
+  require 'vanity_slug/railtie'
+end
+
+module VanitySlug
+end

data/lib/vanity_slug/active_record.rb

@@ -0,0 +1,136 @@
+ActiveSupport.on_load :active_record do
+  module VanitySlug
+    module ActiveRecord
+      def has_vanity_slug(opts={})
+        unless opts[:do_not_set]
+          validate :check_vanity_slug
+          before_validation :set_vanity_slug, on: :create
+        end
+
+        opts = {
+          field_to_slug: :name,
+          slug_field: :slug
+        }.merge opts
+
+        class_attribute :has_vanity_slug_opts
+        self.has_vanity_slug_opts = opts
+
+        class_attribute :field_to_slug
+        self.field_to_slug = opts[:field_to_slug]
+
+        class_attribute :slug_field
+        self.slug_field = opts[:slug_field]
+
+        class_attribute :vanity_action
+        self.vanity_action = opts[:vanity_action]
+
+        VanitySlug.add_class self
+
+        include InstanceMethods
+      end
+
+      module InstanceMethods
+
+        def get_vanity_action
+          action = self.class.has_vanity_slug_opts[:action] 
+
+          if action.is_a?(Proc)
+            self.instance_eval &action
+          else
+            action.gsub(/:(.+?)(?=\/|$)/){ |s| send s[1..-1] }
+          end
+        end
+
+        def set_vanity_slug
+          potential_slug = send(self.class.field_to_slug).parameterize
+          i = 1
+
+          if vanity_slug_exists?(potential_slug)
+            potential_slug += "-#{i}"
+
+            while vanity_slug_exists?(potential_slug)
+              potential_slug.gsub!(/-\d$/, "-#{i += 1}")
+            end
+          end
+
+          self.send "#{self.class.slug_field}=", potential_slug
+        end
+
+        def check_vanity_slug
+          slug_to_check = send(self.class.slug_field)
+
+          exists = VanitySlug.classes.any? do |klass|
+            scope = klass.has_vanity_slug_opts[:uniqueness_scope] 
+            conditions = scope ? { scope => send(scope) } : {}
+
+            finder = klass.where(conditions.merge({ 
+              klass.slug_field => slug_to_check 
+            }))
+
+            finder = finder.where("id != ?", id) if klass == self.class
+            finder.count > 0
+          end
+
+          if exists
+            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
+          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
+
+          VanitySlug.classes.any? do |klass|
+            scope = klass.has_vanity_slug_opts[:uniqueness_scope] 
+            conditions = scope ? { scope => send(scope) } : {}
+            klass.exists? conditions.merge({ klass.slug_field => potential_slug })
+          end
+        end
+      end
+    end
+
+    class << self
+      attr_accessor :path_scope
+      attr_accessor :classes
+      
+      def add_class(klass)
+        @classes ||= []
+        @classes << klass unless @classes.include?(klass)
+      end
+
+      def find(env)
+        path = env["PATH_INFO"]
+        base_path = File.basename path, ".*"
+
+        slug = base_path.gsub(/^\//,'')
+
+        conditions = @path_scope ? @path_scope.call(env) : {}
+
+        obj = nil
+        @classes.any? do |klass|
+          obj = klass.where(conditions.merge({ klass.slug_field => slug }))
+            .first
+        end
+        return false unless obj
+        
+        obj.get_vanity_action + File.extname(path)
+      end
+    end
+
+  end
+
+  ActiveRecord::Base.extend VanitySlug::ActiveRecord
+end

data/lib/vanity_slug/railtie.rb

@@ -0,0 +1,7 @@
+module VanitySlug
+  class Railtie < Rails::Railtie
+    initializer "vanity_slug.configure_rails_initialization" do |app|
+      app.middleware.use VanitySlug::VanityRouter
+    end
+  end
+end

data/lib/vanity_slug/vanity_router.rb

@@ -0,0 +1,19 @@
+module VanitySlug
+  class VanityRouter
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      begin
+        Rails.application.routes.recognize_path env["PATH_INFO"] 
+      rescue
+        if path = VanitySlug.find(env)
+          env["PATH_INFO"] = path
+        end
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/lib/vanity_slug/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'active_support/all'
+require 'vanity_slug'
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end
+
+def silence
+  return yield if ENV['silence'] == 'false'
+  
+  silence_stream(STDOUT) do
+    yield
+  end
+end

data/spec/support/active_record.rb

@@ -0,0 +1,24 @@
+require 'active_record'
+
+silence do
+  ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+  ActiveRecord::Migration.create_table :posts do |t|
+    t.string :title
+    t.string :slug
+    t.integer :site_id
+    t.timestamps
+  end
+
+  ActiveRecord::Migration.create_table :categories do |t|
+    t.string :name
+    t.string :permalink
+    t.integer :site_id
+    t.timestamps
+  end
+
+  ActiveRecord::Migration.create_table :sites do |t|
+    t.string :domain
+    t.timestamps
+  end
+end

data/spec/vanity_slug_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'support/active_record'
+
+VanitySlug.path_scope = Proc.new{|env|
+  { site_id: Site.find_by_domain(env["HTTP_HOST"]).try(:id) }
+}
+
+class Post < ActiveRecord::Base
+  attr_accessible :title, :site
+
+  has_vanity_slug action: "/posts/:id", 
+    field_to_slug: :title, 
+    uniqueness_scope: :site_id
+
+  belongs_to :site
+end
+
+class Category < ActiveRecord::Base
+  attr_accessible :name, :site
+
+  has_vanity_slug action: "/categories/:id/slug", 
+    slug_field: :permalink
+
+  belongs_to :site
+end
+
+class Site < ActiveRecord::Base
+  attr_accessible :domain
+end
+
+describe VanitySlug do
+  context "setting slugs" do
+    let(:str) { "slug me" }
+    let(:str_slugged) { "slug-me" }
+
+    before do
+      @site_1 = Site.create domain: "a.com"
+      @site_2 = Site.create domain: "b.com"
+
+      @post_1 = Post.create title: str, site: @site_1
+      @post_2 = Post.create title: str, site: @site_1
+      @post_3 = Post.create title: str, site: @site_2
+
+      @category_1 = Category.create name: str, site: @site_1
+      @category_2 = Category.create name: str, site: @site_2
+    end
+
+    it { @post_1.slug.should eq str_slugged }
+    it { @post_2.slug.should eq str_slugged+"-1" }
+    it { @post_3.slug.should eq str_slugged }
+    it { @category_1.permalink.should eq str_slugged+"-2" }
+    it { @category_2.permalink.should eq str_slugged+"-1" }
+
+    it do
+      env = {"HTTP_HOST" => @site_1.domain, "PATH_INFO" => "/#{@post_1.slug}"}
+      VanitySlug.find(env).should eq "/posts/#{@post_1.id}"
+    end
+
+    it do
+      env = {"HTTP_HOST" => @site_1.domain, "PATH_INFO" => "/#{@post_2.slug}"}
+      VanitySlug.find(env).should eq "/posts/#{@post_2.id}"
+    end
+
+    it do
+      env = {"HTTP_HOST" => @site_2.domain, "PATH_INFO" => "/#{@post_3.slug}"}
+      VanitySlug.find(env).should eq "/posts/#{@post_3.id}"
+    end
+
+    it do
+      env = {"HTTP_HOST" => @site_1.domain, "PATH_INFO" => "/#{@category_1.permalink}"}
+      VanitySlug.find(env).should eq "/categories/#{@category_1.id}/slug"
+    end
+
+    it do
+      env = {"HTTP_HOST" => @site_2.domain, "PATH_INFO" => "/#{@category_2.permalink}"}
+      VanitySlug.find(env).should eq "/categories/#{@category_2.id}/slug"
+    end
+
+    it do
+      env = {"HTTP_HOST" => "c.com", "PATH_INFO" => "/#{@category_2.permalink}"}
+      VanitySlug.find(env).should be_false
+    end
+  end
+end

data/vanity_slug.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vanity_slug/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vanity_slug"
+  gem.version       = VanitySlug::VERSION
+  gem.authors       = ["Nick Merwin"]
+  gem.email         = ["nick@lemurheavy.com"]
+  gem.description   = %q{root level Vanity Slug for any model}
+  gem.summary       = %q{easily add vanity slugs}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: vanity_slug
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nick Merwin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-13 00:00:00.000000000 Z
+dependencies: []
+description: root level Vanity Slug for any model
+email:
+- nick@lemurheavy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vanity_slug.rb
+- lib/vanity_slug/active_record.rb
+- lib/vanity_slug/railtie.rb
+- lib/vanity_slug/vanity_router.rb
+- lib/vanity_slug/version.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/vanity_slug_spec.rb
+- vanity_slug.gemspec
+homepage: ''
+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.23
+signing_key: 
+specification_version: 3
+summary: easily add vanity slugs
+test_files:
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+- spec/vanity_slug_spec.rb