doesprettyurls 0.1.0

data/Gemfile

@@ -0,0 +1,13 @@
+# AWEXOME LABS
+# Gemfile
+
+source "http://rubygems.org"
+
+# Runtime dependencies:
+
+
+# Development dependencies:
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)

data/README.rdoc

@@ -0,0 +1,51 @@
+= DoesPrettyURLs
+
+Uses ActiveRecord to_param to force your individual models to have attractive, slug-like, and more
+SEO-friendly URLs.
+
+
+== Installation
+
+Do the usual, of course:
+
+  gem install doesprettyurls
+
+And add a gem dependency to your Gemfile:
+
+  gem "doesprettyurls", ">=0.1.0"
+
+
+== Example Usage
+
+To add pretty URL support for objects of a given model, declare your desire for fanciness within the
+ActiveRecord model:
+
+  doesprettyurls
+  
+This will, by default, surgically attach a "slug"-ified version of your object's :name attribute to the
+objects id in URLs and for finders. This means where you used to have this:
+
+  # tag = <Tag @id=5, @name="Beer and Brats", @title="Something Really Cool"...>
+  http://myrailsproject.com/tags/5
+  
+You would now have something a bit fancier and search engine friendly like this:
+
+  http://myrailsproject.com/tags/5-beer-and-brats
+  
+You can tell the doesprettyurls invocation to use a different field for slugification, too. Just pass it
+along in your method call:
+
+  doesprettyurls :attribute=>:title
+  
+For the same object object, you'd now see this URL used in your site:
+
+  http://myrailsproject.com/tags/5-something-really-cool
+
+Voila! Se Magnifique!
+
+
+
+== Copyright
+
+Copyright (c) 2011 Awexome Labs, LLC. http://awexomelabs.com/
+

data/Rakefile

@@ -0,0 +1,40 @@
+# AWEXOME LABS
+# Rakefile
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "doesprettyurls"
+  gem.homepage = "http://github.com/awexome/doesprettyvalues"
+  gem.license = "MIT"
+  gem.summary = %Q{Uses ActiveRecord to_param to force your individual models to have attractive and more SEO-friendly URLs}
+  gem.description = %Q{Uses ActiveRecord to_param to force your individual models to have attractive and more SEO-friendly URLs}
+  gem.email = "gems@awexomelabs.com"
+  gem.authors = ["Awexome Labs"]
+  
+  # Internal Gem Dependencies:
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "doesprettyurls #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/doesprettyurls.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{doesprettyurls}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Awexome Labs"]
+  s.date = %q{2011-02-17}
+  s.description = %q{Uses ActiveRecord to_param to force your individual models to have attractive and more SEO-friendly URLs}
+  s.email = %q{gems@awexomelabs.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "doesprettyurls.gemspec",
+    "lib/doesprettyurls.rb"
+  ]
+  s.homepage = %q{http://github.com/awexome/doesprettyvalues}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Uses ActiveRecord to_param to force your individual models to have attractive and more SEO-friendly URLs}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/lib/doesprettyurls.rb

@@ -0,0 +1,61 @@
+# AWEXOME LABS
+# DoesPrettyUrls
+
+require 'doesprettyurls'
+require 'rails'
+require 'active_record'
+
+
+module DoesPrettyUrls
+
+  # Create a Rails Engine
+  class Engine < Rails::Engine
+  end
+  
+  # Return the current working version from VERSION file:
+  def self.version
+    @@version ||= File.open(File.join(File.dirname(__FILE__), "..", "VERSION"), "r").read
+  end
+  
+end # DoesPrettyUrls
+
+
+module ActiveRecord
+  class Base
+    
+    # Call this method within your class to get fancy URLs
+    def self.doesprettyurls(opts={})
+      self.instance_eval do
+        cattr_accessor :pretty_param_attribute
+        cattr_accessor :pretty_param_proc
+        cattr_accessor :pretty_param_reverse_proc
+
+        # Typical use case is to send a column/attribute name:
+        @@pretty_param_attribute = opts[:attribute] || :name
+
+        # A Proc may also be sent for realtime URL beautification:
+        if opts[:proc]
+          @@pretty_param_proc = opts[:proc]
+        end
+        
+      end
+    end
+    
+    # Provide a mechanism to automagically "slugify" URL parameters
+    def to_param
+      slug_source = if pretty_param_proc
+        pretty_param_proc.call(self)
+      else
+        self.send(pretty_param_attribute)
+      end
+      "#{id}-#{slug_source.downcase.gsub("'", "").gsub(/[^a-z1-9]+/i, "-")}"
+    end
+    
+    # We need to help ActiveRecord go back the other way:
+    def self.from_param(param)
+      find(param.to_i)
+    end
+    
+    
+  end # ActiveRecord::Base
+end # ActiveRecord

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: doesprettyurls
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Awexome Labs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: Uses ActiveRecord to_param to force your individual models to have attractive and more SEO-friendly URLs
+email: gems@awexomelabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- VERSION
+- doesprettyurls.gemspec
+- lib/doesprettyurls.rb
+has_rdoc: true
+homepage: http://github.com/awexome/doesprettyvalues
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3285598090168023541
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Uses ActiveRecord to_param to force your individual models to have attractive and more SEO-friendly URLs
+test_files: []
+