effective_slugs 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Code and Effect Inc.
+
+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,128 @@
+# Effective Slugs
+
+Generates a URL-appropriate slug, as required, when saving a record.
+
+Also overrides ActiveRecord .find() methods to accept the slug, or an id as the parameter.
+
+Rails >= 3.2.x, Ruby >= 1.9.x.  Has not been tested/developed for Rails4.
+
+
+## Getting Started
+
+Add to Gemfile:
+
+```ruby
+gem 'effective_slugs'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+(optional) If you want control over any excluded slugs, run the generator:
+
+```console
+rails generate effective_slugs:install
+```
+
+The generator will install an initializer which describes all configuration options.
+
+
+## Usage
+
+Add the mixin to an existing model:
+
+```ruby
+class Post
+  acts_as_sluggable
+end
+```
+
+Then create a migration to add the :slug column to the model.
+As we're doing lookups on this column, a database index makes a lot of sense too:
+
+```console
+rails generate migration add_slug_to_post slug:string:index
+```
+
+which will create a migration something like
+
+```ruby
+class AddSlugToPost < ActiveRecord::Migration
+  def change
+    add_column :posts, :slug, :string
+    add_index :posts, :slug
+  end
+end
+```
+
+## Behavior
+
+### Slug Generation
+
+When saving a record that does not have a slug, a slug will be automatically generated and assigned.
+
+Tweak the behavior by adding the following instance method to the model:
+
+```ruby
+def should_generate_new_slug?
+  slug.blank?
+end
+```
+
+The slug is generated based on the slug_source instance method, which can also be overridden by adding the following instance method to the model:
+
+```ruby
+def slug_source
+  return title if self.respond_to?(:title)
+  return name if self.respond_to?(:name)
+  to_s
+end
+```
+
+There is also the idea of excluded slugs.  Every model in a rails application has its default route automatically excluded.
+So if you have a model called Event, with its corresponding 'events' table, the /events slug will be unavailable.
+
+You can add additional excluded slugs in the generated config file.
+
+Any slug conflicts will be resolved by appending a -1, -2, etc to the slug.
+
+### Finder Methods
+
+```ruby
+post = Post.create(:title => 'My First Post')
+post.id
+  => 1
+post.slug
+  => 'my-first-post'
+```
+
+The .find() ActiveRecord method is overridden so the following are equivelant:
+
+```ruby
+Post.find('my-first-post')
+Post.find(1)
+Post.where(:slug => 'my-first-post').first
+```
+
+## License
+
+MIT License.  Copyright Code and Effect Inc. http://www.codeandeffect.com
+
+You are not granted rights or licenses to the trademarks of Code and Effect
+
+## Credits
+
+Some of the code in this gem was inspired by an old version of FriendlyId (https://github.com/FriendlyId/friendly_id)
+
+### Testing
+
+The test suite for this gem is unfortunately not yet complete.
+
+Run tests by:
+
+```ruby
+rake spec
+```

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+# Our tasks
+load 'lib/tasks/effective_slugs_tasks.rake'
+
+# Testing tasks
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/models/concerns/acts_as_sluggable.rb

@@ -0,0 +1,167 @@
+# ActsAsSluggable
+#
+# This module automatically generates slugs based on the :title, :name, or :to_s field
+# using a before_validation filter
+#
+# Mark your model with 'acts_as_sluggable'
+#
+# and create the migration
+#
+# structure do
+#   slug     :string
+# end
+#
+# You can override
+# ActsAsSluggable
+#
+# This module automatically generates slugs based on the :title, :name, or :to_s field
+# using a before_validation filter
+#
+# Mark your model with 'acts_as_sluggable'
+#
+# and create the migration
+#
+# structure do
+#   slug     :string
+# end
+#
+# You can override
+# def should_generate_new_slug?
+#   new_record?
+# end
+#
+# and
+# def slug_source
+#   return title if self.respond_to?(:title)
+#   return name if self.respond_to?(:name)
+#   to_s
+# end
+#
+# This will work transparently with the ActsAsSiteSpecific, and should "just work"
+# Please do not put any unique indexes on the slugs column. Or make it unique [:slug, :site_id]
+
+module ActsAsSluggable
+  extend ActiveSupport::Concern
+
+  module ActiveRecord
+    def acts_as_sluggable(options = {})
+      if self.methods.include?(:is_site_specific) # ActsAsSiteSpecific
+        @acts_as_sluggable_opts = {:validation_scope => :site_id}.merge(options)
+      else
+        @acts_as_sluggable_opts = {}.merge(options)
+      end
+
+      include ::ActsAsSluggable
+    end
+  end
+
+  included do
+    before_validation :set_slug, :if => proc { should_generate_new_slug? }
+
+    #attr_accessible :slug
+    validates_presence_of :slug
+    validates_exclusion_of :slug, :in => EffectiveSlugs.all_excluded_slugs
+    validates_format_of :slug, :with => /^[a-zA-Z0-9_\-]*[a-zA-Z][a-zA-Z0-9_\-]*$/, :message => 'only _ and - symbols allowed'
+
+    if @acts_as_sluggable_opts[:validation_scope]
+      validates_uniqueness_of :slug, :scope => @acts_as_sluggable_opts[:validation_scope]
+    else
+      validates_uniqueness_of :slug
+    end
+
+    class_eval do
+      class << self
+        alias relation_without_sluggable relation
+      end
+
+      def self.relation
+        @relation = nil unless @relation.class <= relation_class
+        @relation ||= relation_class.new(self, arel_table)
+      end
+
+      # Gets an anonymous subclass of the model's relation class.
+      # This should increase long term compatibility with any gems that also override finder methods
+      # The other idea would be to just return Class.new(ActiveRecord::Relation)
+
+      def self.relation_class
+        @relation_class ||= Class.new(relation_without_sluggable.class) do
+          alias_method :find_one_without_sluggable, :find_one
+          alias_method :exists_without_sluggable?, :exists?
+          include ActsAsSluggable::FinderMethods
+        end
+      end
+    end
+  end
+
+  module ClassMethods
+  end
+
+  # We inject these methods into the ActsAsSluggable.relation class, as below
+  # Allows us to use sluggable id's identically to numeric ids in Finders
+  # And lets all the pages_path() type stuff work
+  #
+  # This makes all these the same:
+  # Post.find(3) == Post.find('post-slug') == Post.find(post)
+  module FinderMethods
+    protected
+
+    # Find one can be passed 4, "my-slug" or <Object>
+    def find_one(id)
+      begin
+        if id.respond_to?(:slug)
+          where(:slug => id.slug).first
+        elsif id.kind_of?(String)
+          where(:slug => id).first
+        end || super
+      rescue => e
+        super
+      end
+    end
+
+    def exists?(id = false)
+      if id.respond_to?(:slug)
+        super :slug => id.slug
+      elsif id.kind_of?(String)
+        super :slug => id
+      else
+        super
+      end
+    end
+  end
+
+  def set_slug
+    raise StandardError, "ActsAsSluggable expected a table column :slug to exist" unless self.respond_to?(:slug)
+
+    new_slug = slug_source.to_s.try(:parameterize)
+
+    if new_slug.present?
+      while EffectiveSlugs.excluded_slugs.include?(new_slug) do
+        new_slug << "-" << self.class.name.demodulize.parameterize
+      end
+
+      # TODO: Could make this a bit smarter about conflicts
+      num_slugs = self.class.name.constantize.where(:slug => new_slug).count
+      num_slugs = self.class.name.constantize.where('slug LIKE ?', "#{new_slug}%").count if num_slugs > 0
+
+      num_slugs == 0 ? self.slug = new_slug : self.slug = "#{new_slug}-#{num_slugs}"
+    end
+
+    true
+  end
+
+  def slug_source
+    return title if self.respond_to?(:title)
+    return name if self.respond_to?(:name)
+    to_s
+  end
+
+  def should_generate_new_slug?
+    slug.blank?
+  end
+
+  def to_param
+    slug.present? ? slug_was : id.to_s
+  end
+
+end
+

data/lib/effective_slugs/engine.rb

@@ -0,0 +1,20 @@
+module EffectiveSlugs
+  class Engine < ::Rails::Engine
+    engine_name 'effective_slugs'
+
+    config.autoload_paths += Dir["#{config.root}/app/models/concerns"]
+
+    # Include acts_as_addressable concern and allow any ActiveRecord object to call it
+    initializer 'effective_slugs.active_record' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.extend(ActsAsSluggable::ActiveRecord)
+      end
+    end
+
+    # Set up our default configuration options.
+    initializer "effective_slugs.defaults", :before => :load_config_initializers do |app|
+      eval File.read("#{config.root}/lib/generators/templates/effective_slugs.rb")
+    end
+
+  end
+end

data/lib/effective_slugs/version.rb

@@ -0,0 +1,3 @@
+module EffectiveSlugs
+  VERSION = "0.1"
+end

data/lib/effective_slugs.rb

@@ -0,0 +1,23 @@
+require "effective_slugs/engine"
+require "effective_slugs/version"
+
+module EffectiveSlugs
+  mattr_accessor :excluded_slugs
+
+  def self.setup
+    yield self
+  end
+
+  # This restricts /events /jobs /posts /pages type slugs, for every model in our application.
+  def self.all_excluded_slugs
+    Rails.env.development? ? get_all_excluded_slugs : (@@excluded_slugs ||= get_all_excluded_slugs)
+  end
+
+  private
+
+  def self.get_all_excluded_slugs
+    (ActiveRecord::Base.connection.tables.map { |x| x }.compact + (EffectiveSlugs.excluded_slugs || []))
+  end
+
+
+end

data/lib/generators/effective_slugs/install_generator.rb

@@ -0,0 +1,17 @@
+module EffectiveSlugs
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Creates an EffectiveSlugs initializer in your application."
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def copy_initializer
+        template "effective_slugs.rb", "config/initializers/effective_slugs.rb"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1 @@
+Thanks for using EffectiveSlugs

data/lib/generators/templates/effective_slugs.rb

@@ -0,0 +1,3 @@
+EffectiveSlugs.setup do |config|
+  config.excluded_slugs = %w(contact-us calendar cart destroy_cart moneris_postback search sitemap robots)
+end

data/lib/tasks/effective_slugs_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :effective_slugs do
+#   # Task goes here
+# end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks