speaking_url 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in speaking_url_resource.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,102 @@
+= Speaking URL
+
+The Speaking URL Gem provides an extension for the <tt>routes.rb</tt> file of
+your Rails-App to allow for arbitrary URL being used for resources. The
+Gem is mainly SEO-motivated; it facilitates:
+
+* Usage of so called "static" or "nice-looking" URLs,
+* Implementation of a SEO friendly URL strategy,
+* Usage of different style URLs for resources of the same type
+* And (from a SEO-point maybe most importantly) Modification of URL 
+  strategies with proper HTTP (301) redirects. 
+
+This Gem <em>does not</em>:
+
+* generate URLs
+* manage all of your App's URLs
+
+
+These points have to by managed by yourself.
+
+= Installation
+
+Add the gem to your Rails-App by including it in your Gemfile:
+
+    gem "speaking_url"
+
+
+= Usage
+
+A quick list of steps that have to be done in order to get started
+with using this Gem follows.
+
+== Usage in your models
+
+The Speaking Url must be setup within the models (resources) that you
+want to assign a Speaking URL to.
+
+    class Person
+      include Mongoid::Document
+      include include SpeakingUrl::MongoResource
+    end
+
+This adds an array field +urls+ to the Person resource, where the
+current url and the url history are stored.
+
+To add a new route to a some resource, use the +add_mapping+ method
+instead of modifying the field directly.
+
+    @person.add_mapping('/some/new/mapping')
+
+
+
+== Configuring routes
+
+To actually deploy the new routes, the Gem ships with the
++speaking_url_resource+ method. So far it accepts no customizations; you
+simply provide the resources as symbols:
+
+
+  speaking_url_resource :person, :product
+
+Here both - the person and product resource - are made accessible by their
+speaking url(s). You probably want to include this line as one of your last
+statements (maybe before your root source), so that the other routes
+have higher priority and achieve slightly better performance.  
+
+
+
+== Usage in Controllers  
+
+In the appropriate controllers actions a specific resource is no longer
+fetches by it's databse ID, but by the request.path:
+
+    @search = Person.find_by_url(request.path) 
+
+You can be sure there that a resource is found because otherwise the the
+controller wouldn't have been called by the routing mapper.
+
+
+== Usage in views 
+
+Instead of using the default rails route helpers in your views, you want
+to use the speaking url helpers:
+
+    <%= link_to "A nice person", @person.current_url %> 
+
+
+= Outlook and Todo
+
+So far the Gem is pretty limited. What could be developed for following
+version is:
+
+* unit tests (asap)
+* support for other persistent storage mappers
+* configuration options for the routes method
+
+
+= License
+
+GPLv3. Copyright 2011 Kai Rubarth.  
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/speaking_url/mongo_resource.rb

@@ -0,0 +1,42 @@
+require 'mongoid'
+
+module SpeakingUrl
+
+  module MongoResource
+    def self.included(klass)
+      @@cocktails ||= []
+      @@cocktails.push(klass).uniq!
+
+      klass.instance_eval do 
+        include Mongoid::Document
+        field :urls, :type => Array, :default => []
+      end
+
+      klass.extend(ClassMethods)
+    end
+
+    def self.cocktails
+      @@cocktails
+    end
+
+    def current_url
+      urls.last
+    end
+
+    def add_mapping(new_url)
+      urls << new_url
+    end
+
+    module ClassMethods
+      def find_by_url(url)
+        where(:urls => url).first
+      end
+    end
+
+  end
+
+end
+
+
+
+

data/lib/speaking_url/routing_extensions.rb

@@ -0,0 +1,43 @@
+
+module ActionDispatch::Routing
+
+  class Mapper
+
+    def speaking_url_resource(*resources)
+
+      resources.map!(&:to_sym)
+
+      resources.each do |sym|
+
+        klass = Kernel.const_get(sym.to_s.classify) 
+
+        current_address_constraint_class = Class.new do
+          @klass = klass
+          class << self; attr_reader :klass; end
+          def matches?(request)
+            r = self.class.klass.find_by_url(request.path)
+            return false if r.nil?
+            r.current_url == request.path
+          end
+        end
+
+        old_address_constraint_class = Class.new do
+          @klass = klass
+          class << self; attr_reader :klass; end
+          def matches?(request)
+            r = self.class.klass.find_by_url(request.path)
+            return false if r.nil?
+            r.current_url != request.path
+          end
+        end
+
+        match "*path", :to  => "#{klass.name.underscore.pluralize}#show", :constraints => current_address_constraint_class.new
+        match "*path" => redirect{|p, req| klass.find_by_url(req.path).current_url}, :constraints => old_address_constraint_class.new
+
+      end
+    end
+  end
+
+end
+
+

data/lib/speaking_url/version.rb

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

data/lib/speaking_url.rb

@@ -0,0 +1,12 @@
+require 'rails'
+#require 'active_support/dependencies'
+
+require 'speaking_url/mongo_resource'
+require 'speaking_url/routing_extensions'
+
+module SpeakingUrl
+
+end
+
+
+

data/speaking_url.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "speaking_url/version"
+
+Gem::Specification.new do |s|
+  s.name        = "speaking_url"
+  s.version     = SpeakingUrl::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kai Rubarth"]
+  s.email       = ["kai@doxter.de"]
+  s.homepage    = ""
+  s.summary     = %q{allows arbitrary url for resources and facilitates seo-friendly changing of urls.}
+  s.description = %q{Provides the possibility to have arbitrary URL for resources.}
+
+  s.rubyforge_project = "speaking_url"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('mongoid')
+  s.add_development_dependency('shoulda')
+  s.add_development_dependency('mocha')
+
+end
+
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: speaking_url
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kai Rubarth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Provides the possibility to have arbitrary URL for resources.
+email: 
+- kai@doxter.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/speaking_url.rb
+- lib/speaking_url/mongo_resource.rb
+- lib/speaking_url/routing_extensions.rb
+- lib/speaking_url/version.rb
+- speaking_url.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: speaking_url
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: allows arbitrary url for resources and facilitates seo-friendly changing of urls.
+test_files: []
+