vidibus-permalink 0.0.1

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+gem "rails", "~> 3.0.0"
+gem "mongoid", "~> 2.0.0.beta.20"
+gem "vidibus-core_extensions"
+gem "vidibus-uuid"
+gem "vidibus-words"
+
+# Development dependecies
+gem "jeweler"
+gem "rake"
+gem "rspec", "~> 2.0.0.beta.20"
+gem "rr"
+gem "relevance-rcov"

data/Gemfile.lock

@@ -0,0 +1,120 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.1)
+      actionpack (= 3.0.1)
+      mail (~> 2.2.5)
+    actionpack (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+    activesupport (3.0.1)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    bson (1.1.2)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.2)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    macaddr (1.0.0)
+    mail (2.2.9)
+      activesupport (>= 2.3.6)
+      i18n (~> 0.4.1)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mongo (1.1.2)
+      bson (>= 1.1.1)
+    mongoid (2.0.0.beta.20)
+      activemodel (~> 3.0)
+      mongo (~> 1.1)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.1)
+      actionmailer (= 3.0.1)
+      actionpack (= 3.0.1)
+      activerecord (= 3.0.1)
+      activeresource (= 3.0.1)
+      activesupport (= 3.0.1)
+      bundler (~> 1.0.0)
+      railties (= 3.0.1)
+    railties (3.0.1)
+      actionpack (= 3.0.1)
+      activesupport (= 3.0.1)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    relevance-rcov (0.9.2.1)
+    rr (1.0.2)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    thor (0.14.4)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+    uuid (2.3.1)
+      macaddr (~> 1.0)
+    vidibus-core_extensions (0.3.11)
+    vidibus-uuid (0.3.8)
+      mongoid (~> 2.0.0.beta.20)
+      uuid (~> 2.3.1)
+    vidibus-words (0.0.0)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  mongoid (~> 2.0.0.beta.20)
+  rails (~> 3.0.0)
+  rake
+  relevance-rcov
+  rr
+  rspec (~> 2.0.0.beta.20)
+  vidibus-core_extensions
+  vidibus-uuid
+  vidibus-words

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Andre Pankratz
+
+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,37 @@
+= vidibus-permalink
+
+This gem allows changeable permalinks. That's an oxymoron, but it's really useful from a SEO perspective.
+
+It is part of the open source SOA framework Vidibus: http://vidibus.org
+
+
+== Installation
+
+Add the dependency to the Gemfile of your application:
+
+  gem "vidibus-permalink"
+
+Then call bundle install on your console.
+
+
+== Usage
+
+TODO: describe
+
+
+== TODO
+
+* Add controller extension for automatic dispatching
+* Limit length of permalinks
+
+
+== Ideas (for a separate gem)
+
+* Catch 404s and store invalid routes.
+* Make invalid routes assignable from a web interface.
+* Try to suggest a matching Linkable by valid parts of the request path.
+
+
+== Copyright
+
+Copyright (c) 2010 Andre Pankratz. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,40 @@
+require "rubygems"
+require "rake"
+require "rake/rdoctask"
+require "rspec"
+require "rspec/core/rake_task"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "vidibus-permalink"
+    gem.summary = %Q{Permalink handling}
+    gem.description = %Q{Allows changeable permalinks (good for SEO).}
+    gem.email = "andre@vidibus.com"
+    gem.homepage = "http://github.com/vidibus/vidibus-permalink"
+    gem.authors = ["Andre Pankratz"]
+    gem.add_dependency "rails", "~> 3.0.0"
+    gem.add_dependency "mongoid", "~> 2.0.0.beta.20"
+    gem.add_dependency "vidibus-core_extensions"
+    gem.add_dependency "vidibus-uuid"
+    gem.add_dependency "vidibus-words"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+Rspec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.rcov = true
+  t.rcov_opts = ["--exclude", "^spec,/gems/"]
+end
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "vidibus-permalink #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.options << "--charset=utf-8"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/app/models/permalink.rb

@@ -0,0 +1,161 @@
+class Permalink
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  class UuidRequiredError < StandardError; end
+
+  field :value
+  field :linkable_class
+  field :linkable_uuid
+  field :_current, :type => Boolean, :default => true
+
+  before_save :set_current
+  after_destroy :set_last_current, :if => :current?
+
+  validates :linkable_uuid, :uuid => true
+  validates :value, :linkable_class, :presence => true
+
+  index :value
+
+  # Sets object as linkable.
+  def linkable=(obj)
+    @linkable = nil
+    self.linkable_class = obj.class.to_s
+    if uuid = obj.try!(:uuid)
+      self.linkable_uuid = uuid
+    else
+      raise UuidRequiredError.new("The linkable object must respond to #uuid. The gem vidibus-uuid will help you.")
+    end
+  end
+
+  # Returns the linkable object.
+  def linkable
+    @linkable ||= begin
+      return unless linkable_class and linkable_uuid
+      linkable_class.constantize.where(:uuid => linkable_uuid).first
+    end
+  end
+  
+  # Assigns given string as value.
+  # Sanitizes and increments string, if necessary.
+  def value=(string)
+    unless string == value
+      string = sanitize(string)
+      unless string == value
+        string = increment(string)
+        self.write_attribute(:value, string)
+      end
+    end
+    string
+  end
+
+  # Returns true if this permalink is the current one
+  # of the assigned linkable.
+  def current?
+    @is_current ||= !!_current
+  end
+
+  # Returns the current permalink of the assigned linkable.
+  def current
+    @current ||= begin
+      if current?
+        self
+      else
+        Permalink.where(:linkable_uuid => linkable_uuid, :_current => true).first
+      end
+    end
+  end
+
+  class << self
+
+    # Scope method for finding Permalinks for given object.
+    def for_linkable(object)
+      where(:linkable_uuid => object.uuid)
+    end
+
+    # Scope method for finding Permalinks for given value.
+    # The value will be sanitized.
+    def for_value(value)
+      where(:value => sanitize(value))
+    end
+    
+    # Returns a dispatcher object for given path.
+    def dispatch(path)
+      Vidibus::Permalink::Dispatcher.new(path)
+    end
+  end
+
+  protected
+
+  # Removes stopwords and turns string into a permalink-formatted one.
+  # However, if the stopwords-free value is blank or it already exists
+  # in the database, the full value will be used.
+  def sanitize(string)
+    return if string.blank?
+    clean = Permalink.remove_stopwords(string)
+    unless clean.blank? or clean == string
+      clean = clean.permalink
+      sanitized = clean unless existing(clean).any?
+    end
+    sanitized || string.permalink
+  end
+
+  # Sanitize string: Remove stopwords and format as permalink.
+  # See Vidibus::CoreExtensions::String for details.
+  def self.sanitize(string)
+    return if string.blank?
+    remove_stopwords(string).permalink
+  end
+
+  # Tries to remove stopwords from string.
+  # If the resulting string is blank, the original one will be returned.
+  # See Vidibus::Words for details.
+  def self.remove_stopwords(string)
+    words = Vidibus::Words.new(string)
+    clean = words.keywords(10).join(" ")
+    clean.blank? ? string : clean
+  end
+
+  # Appends next available number to string if it's already in use.
+  def increment(string)
+    _existing = existing(string)
+    return string unless _existing.any?
+    number = 1
+    while true
+      number += 1
+      desired = "#{string}-#{number}"
+      unless _existing.detect {|e| e.value == desired}
+        return desired
+      end
+    end
+  end
+
+  # Finds existing permalinks with current value.
+  def existing(string)
+    @existing ||= {}
+    @existing[string] ||= Permalink.where(:value => /^#{string}(-\d+)?$/).excludes(:_id => id).to_a
+  end
+
+  # Sets this permalink as the current one and unsets all others.
+  def set_current
+    unset_other_current
+    self._current = true
+  end
+
+  # Sets _current to false on all permalinks of the assigned linkable.
+  def unset_other_current
+    return unless linkable
+    collection.update(
+      {:linkable_uuid => linkable_uuid, :_id => {"$ne" => _id}},
+      {"$set" => {:_current => false}},
+      {:multi => true}
+    )
+  end
+
+  # Sets the lastly updated permalink of the assigned linkable as current one.
+  def set_last_current
+    if last = Permalink.where(:linkable_uuid => linkable_uuid).order_by(:updated_at.desc).limit(1).first
+      last.update_attributes!(:_current => true)
+    end
+  end
+end

data/lib/vidibus/permalink/dispatcher.rb

@@ -0,0 +1,83 @@
+module Vidibus
+  module Permalink
+    class Dispatcher
+
+      class PathError < StandardError; end
+
+      # Initialize a new Dispatcher instance.
+      # Provide an absolute +path+ to be dispatched.
+      def initialize(path)
+        unless path.match(/^\//)
+          raise PathError, "Path must be absolute."
+        end
+        @path = path
+      end
+
+      # Returns the path to dispatch.
+      def path
+        @path
+      end
+
+      # Returns parts of the path.
+      def parts
+        @parts ||= path.split("/").reject{|p| p == ""}
+      end
+
+      # Returns permalink objects matching the parts.
+      def objects
+        @objects ||= resolve_path
+      end
+
+      # Returns true if all parts could be resolved.
+      def found?
+        @is_found ||= begin
+          !objects.include?(nil)
+        end
+      end
+
+      # Returns true if any part does not reflect
+      # the current permalink of the underlying linkable.
+      def redirect?
+        @is_redirect ||= begin
+          return unless found?
+          redirectables.any?
+        end
+      end
+
+      # Returns the path to redirect to, if any.
+      def redirect_path
+        @redirect_path ||= begin
+          return unless redirect?
+          "/" << current_parts.join("/")
+        end
+      end
+
+      private
+
+      # TODO: Allow scopes
+      def resolve_path
+        results = ::Permalink.any_in(:value => parts)
+        links = Array.new(parts.length)
+        done = {}
+        for result in results
+          if i = parts.index(result.value)
+            key = "#{result.linkable_class}##{result.linkable_uuid}"
+            next if done[key]
+            links[i] = result
+            done[key] = true
+          end
+        end
+        links
+      end
+
+      # Returns an array containing the current permalinks of all objects.
+      def current_parts
+        objects.map {|o| o.current.value}
+      end
+
+      def redirectables
+        objects.select {|o| !o.current?}
+      end
+    end
+  end
+end

data/lib/vidibus/permalink/mongoid.rb

@@ -0,0 +1,71 @@
+module Vidibus
+  module Permalink
+    module Mongoid
+      extend ActiveSupport::Concern
+
+      class PermalinkConfigurationError < StandardError; end
+
+      included do
+        field :permalink
+        before_validation :set_permalink
+        validates :permalink, :presence => true
+        after_save :store_permalink_object
+        after_destroy :destroy_permalink_objects
+      end
+
+      module ClassMethods
+
+        # Sets permalink attributes.
+        # Usage:
+        #   permalink :some, :fields
+        def permalink(*args)
+          class_eval <<-EOS
+            def permalink_attributes
+              #{args.inspect}
+            end
+          EOS
+        end
+      end
+
+      # Returns the current permalink object.
+      def permalink_object
+        @permalink_object || ::Permalink.for_linkable(self).where(:_current => true).first
+      end
+
+      # Returns all permalink objects ordered by time of update.
+      def permalink_objects
+        ::Permalink.for_linkable(self).asc(:updated_at)
+      end
+
+      protected
+
+      # Initializes a new permalink object and sets permalink attribute.
+      def set_permalink
+        if attributes = try!(:permalink_attributes)
+          changed = false
+          values = []
+          for a in attributes
+            changed = send("#{a}_changed?") unless changed == true
+            values << send(a)
+          end
+          return unless permalink.blank? or changed
+          value = values.join(" ")
+          @permalink_object = ::Permalink.for_linkable(self).for_value(value).first
+          @permalink_object ||= ::Permalink.new(:value => value, :linkable => self)
+          self.permalink = @permalink_object.value
+        else
+          raise PermalinkConfigurationError.new("Permalink attributes have not been assigned!")
+        end
+      end
+
+      # Stores current new permalink object or updates an existing one that matches.
+      def store_permalink_object
+        @permalink_object.save! if @permalink_object
+      end
+
+      def destroy_permalink_objects
+        ::Permalink.delete_all(:conditions => {:linkable_uuid => uuid})
+      end
+    end
+  end
+end

data/lib/vidibus/permalink.rb

@@ -0,0 +1,2 @@
+require "permalink/mongoid"
+require "permalink/dispatcher"

data/lib/vidibus-permalink.rb

@@ -0,0 +1,14 @@
+require "rails"
+require "mongoid"
+require "vidibus-core_extensions"
+require "vidibus-uuid"
+require "vidibus-words"
+    
+$:.unshift(File.join(File.dirname(__FILE__), "vidibus"))
+require "permalink"
+
+if defined?(Rails)
+  module Vidibus::Permalink
+    class Engine < ::Rails::Engine; end
+  end
+end

data/spec/models.rb

@@ -0,0 +1,20 @@
+require "vidibus-uuid"
+
+class Asset
+  include Mongoid::Document
+  include Vidibus::Uuid::Mongoid
+  field :label
+end
+
+class Category
+  include Mongoid::Document
+  include Vidibus::Uuid::Mongoid
+  field :label
+end
+
+# class Article
+#   include Mongoid::Document
+#   field :label
+#   field :date, :format => Date
+#   #permalink :label, :date
+# end