slugged 0.3.2

data/.document

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

data/.gitignore

@@ -0,0 +1,14 @@
+.DS_Store
+.bundle
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp
+coverage
+rdoc
+pkg
+*.gem
+coverage
+metrics/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree@slugged --create

data/Gemfile

@@ -0,0 +1,20 @@
+source :gemcutter
+
+# Setup gems
+gem "activerecord", "= 3.0.0"
+gem "reversible_data"
+gem "uuid"
+gem "sqlite3-ruby", :require => "sqlite3"
+
+gem "shoulda",  :require => nil
+gem "redgreen", :require => nil if RUBY_VERSION < "1.9"
+gem "rcov",     :require => nil
+gem "reek",     :require => nil
+gem "roodi",    :require => nil
+gem "flay",     :require => nil
+gem "flog",     :require => nil
+gem "rake",     :require => nil
+gem "Saikuro",  :require => nil
+gem "jeweler",  :require => nil
+
+gem 'ruby-debug', :require => nil

data/Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    Saikuro (1.1.0)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.1)
+    flay (1.4.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    flog (2.5.0)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    linecache (0.43)
+    macaddr (1.0.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    redgreen (1.2.2)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    reversible_data (0.1.0)
+    roodi (2.1.0)
+      ruby_parser
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.5)
+      sexp_processor (~> 3.0)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sexp_processor (3.0.5)
+    shoulda (2.11.3)
+    sqlite3-ruby (1.3.1)
+    tzinfo (0.3.23)
+    uuid (2.3.1)
+      macaddr (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Saikuro
+  activerecord (= 3.0.0)
+  flay
+  flog
+  jeweler
+  rake
+  rcov
+  redgreen
+  reek
+  reversible_data
+  roodi
+  ruby-debug
+  shoulda
+  sqlite3-ruby
+  uuid

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Darcy Laycock
+
+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,125 @@
+# Slugged #
+
+## About ###
+
+Slugged is a simple slug library for ActiveRecord 3.0+.
+
+It's main features are:
+
+1. A very simple and tested codebase
+2. Support for slug history (e.g. if a users slug changes, it will record the old slug)
+3. Simple defaulting for slugs to UUID's (to avoid showing ID's.)
+4. Built on ActiveRecord 3.0
+5. If stringex is installed, uses stringex's transliteration stuff
+
+
+Slugged used to be called Pseudocephalopod - a name inspired by the Jason Wander series of
+books which I just happened to be reading when I had the need for this that focuses on a
+war with slug-like creatures.
+
+### Why? ###
+
+I love the idea of friendly\_id, and most of the implementation but it felt bloated
+to me and my experiences on getting it to work correctly with Rails 3 left a base taste
+in my mouth / was altogether hacky.
+
+Slugged is very much inspired by friendly id but with a much simpler codebase
+and built to work on Rails 3 from the start.
+
+## Usage ##
+
+Using Slugged is simple. In Rails, simply drop this in your Gemfile:
+
+    gem 'slugged'
+    
+Optionally restricting the version.
+
+Next, if you wish to use slug history run:
+
+    $ rails generate slugged:slugs
+    
+Otherwise, when calling is\_sluggable make sure to include :history => false
+
+Next, you need to add a cached slug column to your model and add an index. In your migration,
+you'd usually want something like:
+
+    add_column :users, :cached_slug, :string
+    add_index :users,  :cached_slug
+    
+Or, using our build in generator:
+
+    $ rails generate slugged:slug_migration Model
+    
+Lastly, in your model, call is\_sluggable:
+
+    class User
+      is_sluggable :name
+    end
+    
+is\_sluggable accepts the source method name as a symbol, and an optional has of options including:
+
+* _:sync_ - when source column changes, save the result. Defaults to true.
+* _:convertor_ - a symbol (for a method) or block for how to generate the base slug. Defaults to :to\_url if available, parameterize otherwise.
+* _:history_ - use slug history (e.g. if the name changes, it records the previous version in a slugs table). Defaults to true
+* _:uuid_ - If the slug is blank, uses a generated uuid instead. Defaults to true
+* _:slug\_column_ - the column in which to store the slug. Defaults to _:cached\_slug_
+* _:to\_param_ - if true (by default), overrides to_param to use the slug
+* _:use\_cache_ - uses Slugged.cache if available to cache any lookups e.g. in memcache.
+
+Once installed, it provides the following methods:
+
+### User.find\_using\_slug "some-slug" ###
+
+Finds a user from a slug (which can be the record's id, it's cached slug or, if enabled, slug history)
+
+### User.other\_than(record) ###
+
+Returns a relationship which returns records other than the given.
+
+### User.with\_cached\_slug(record) ###
+
+Returns a relationship which returns records with the given cached slug.
+
+### User#generate\_slug ###
+
+Forces the generation of a current slug
+
+### User#generate\_slug! ###
+
+Forces the generation of a current slug and saves it
+
+### User#autogenerate\_slug ###
+
+Generates a slug if not already present.
+
+### User#has\_better\_slug? ###
+
+When found via Model.find\_using\_slug, it will return try
+if there is a better slug available. Intended for use in redirects etc.
+
+## Working on Slugged ##
+
+To run tests, simply do the following:
+
+    bundle install
+    rake
+
+And it's ready!
+
+## Contributors ##
+
+Thanks to the following who contributed functionality / bug fixes:
+
+* [Matt Pruitt](http://github.com/guitsaru)
+
+## Note on Patches/Pull Requests ##
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright ##
+
+Copyright (c) 2010 Darcy Laycock. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,110 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require
+
+require 'rake'
+
+require File.expand_path('../lib/slugged/version', __FILE__)
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.version     = Slugged::Version::STRING
+    gem.name        = "slugged"
+    gem.summary     = %Q{Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history}
+    gem.description = %Q{Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history}
+    gem.email       = "sutto@sutto.net"
+    gem.homepage    = "http://github.com/Sutto/slugged"
+    gem.authors     = ["Darcy Laycock"]
+    gem.add_dependency "activerecord",  "~> 3.0.0"
+    gem.add_dependency "activesupport", "~> 3.0.0"
+    gem.add_dependency "uuid"
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "reversible_data"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+    test.rcov_opts << '--exclude /gems/,/Library/,/usr/,lib/tasks,.bundle,config,/lib/rspec/,/lib/rspec-'
+    test.output_dir = "metrics/coverage"
+  end
+rescue LoadError
+  task :rcov do
+    abort "Rcov isn't installed, please run via bundle exec after bundle installing"
+  end
+end
+
+task :metrics => [:rcov, :saikuro, :reek, :flay, :flog, :roodi]
+
+task :test => :check_dependencies
+
+task :flog do
+  system "flog lib"
+end
+
+task :saikuro do
+  system "rm -rf metrics/saikuro && mkdir -p metrics/saikuro && saikuro -c -t -i lib/ -y 0 -w 11 -e 16 -o metrics/saikuro/"
+end
+
+begin
+  require 'flay'
+  require 'flay_task'
+  FlayTask.new
+rescue LoadError
+  task :flay do
+    abort "Flay isn't installed, please run via bundle exec after bundle installing"
+  end
+end
+
+begin
+  require 'reek/rake/task'
+  Reek::Rake::Task.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek isn't installed, please run via bundle exec after bundle installing"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi isn't installed, please run via bundle exec after bundle installing"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "slugged #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/generators/slugged/slug_migration/slug_migration_generator.rb

@@ -0,0 +1,24 @@
+module Slugged
+  module Generators
+    class SlugMigrationGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+      
+      def self.source_root
+        @_ps_source_root ||= File.expand_path("templates", File.dirname(__FILE__))
+      end
+      
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+      
+      def create_migration_file
+        migration_template "migration.erb", "db/migrate/add_cached_slug_to_#{table_name}.rb"
+      end
+      
+    end
+  end
+end

data/lib/generators/slugged/slug_migration/templates/migration.erb

@@ -0,0 +1,12 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  
+  def self.up
+    add_column <%= table_name.to_sym.inspect %>, :cached_slug, :string
+    add_index  <%= table_name.to_sym.inspect %>, :cached_slug
+  end
+
+  def self.down
+    remove_column <%= table_name.to_sym.inspect %>, :cached_slug
+  end
+  
+end

data/lib/generators/slugged/slugs/slugs_generator.rb

@@ -0,0 +1,24 @@
+module Slugged
+  module Generators
+    class SlugsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      
+      def self.source_root
+        @_ps_source_root ||= File.expand_path("templates", File.dirname(__FILE__))
+      end
+      
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+      
+      def create_migration_file
+        migration_template "migration.erb", "db/migrate/create_slugged_slugs.rb"
+      end
+      
+    end
+  end
+end