pseudocephalopod 0.3.1 → 0.3.2

data/README.md

@@ -1,123 +1,3 @@
 # Pseudocephalopod #
 
-## About ###
-
-Pseudocephalopod is a simple slug library for ActiveRecord 3.0 plus.
-
-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
-
-Also, it's name is inspired by the Jason Wander series of books which I just happened to be
-reading when I had the need for this.
-
-### 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.
-
-Pseudocephalopod 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 Pseudocephalopod is simple. In Rails, simply drop this in your Gemfile:
-
-    gem 'pseudocephalopod'
-    
-Optionally restricting the version.
-
-Next, if you wish to use slug history run:
-
-    $ rails generate pseudocephalopod: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 pseudocephalopod: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 Pseudocephalopod.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 Pseudocephalopod ##
-
-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.
+Pseudocephalopod has been renamed - please see [Slugged](http://github.com/Sutto/slugged) instead.

data/Rakefile

@@ -1,110 +1,18 @@
-require 'rubygems'
-require 'bundler'
-Bundler.setup
-Bundler.require
-
 require 'rake'
 
-require File.expand_path('../lib/pseudocephalopod/version', __FILE__)
-
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.version     = Pseudocephalopod::Version::STRING
+    gem.version     = "0.3.2"
     gem.name        = "pseudocephalopod"
-    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.summary     = %Q{Renamed to slugged (http://github.com/Sutto/slugged)}
+    gem.description = %Q{Renamed to slugged (http://github.com/Sutto/slugged)}
     gem.email       = "sutto@sutto.net"
-    gem.homepage    = "http://github.com/Sutto/pseudocephalopod"
+    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"
+    gem.add_dependency "slugged"
   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 = "pseudocephalopod #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/lib/pseudocephalopod.rb

@@ -1,80 +1,5 @@
-require 'active_support'
-require 'active_record'
-require 'uuid'
+require 'slugged'
 
-require 'active_support/dependencies/autoload'
-require 'active_support/core_ext/module/attribute_accessors'
-require 'active_support/concern'
+warn 'Pseudocephalopod is now known as Slugged - see http://github.com/Sutto/slugged.'
 
-module Pseudocephalopod
-  extend ActiveSupport::Autoload
-
-  mattr_accessor :cache_key_prefix, :cache
-
-  class << self
-
-    def with_counter(prefix, counter = 0)
-      counter < 1 ? prefix : "#{prefix}--#{counter}"
-    end
-
-    def next_value(scope, prefix)
-      counter = 0
-      slug    = self.with_counter(prefix, counter)
-      while scope.with_cached_slug(slug).exists?
-        counter += 1
-        slug     = self.with_counter(prefix, counter)
-      end
-      slug
-    end
-
-    def uuid
-      @uuid ||= UUID.new
-    end
-
-    def generate_uuid_slug
-      uuid.generate
-    end
-
-    def last_known_slug_id(scope, slug)
-      Pseudocephalopod::Slug.id_for(Pseudocephalopod.key_for_scope(scope), slug)
-    end
-
-    def record_slug(record, slug)
-      Pseudocephalopod::Slug.record_slug(record, slug)
-    end
-
-    def previous_slugs_for(record)
-      Pseudocephalopod::Slug.previous_for(record)
-    end
-
-    def remove_slug_history_for(record)
-      Pseudocephalopod::Slug.remove_history_for(record)
-    end
-
-    def key_for_scope(scope)
-      if scope.respond_to?(:slug_scope_key)
-        scope.slug_scope_key
-      elsif scope.class.respond_to?(:slug_scope_key)
-        scope.class.slug_scope_key
-      else
-        scope.to_s
-      end
-    end
-
-  end
-
-  self.cache_key_prefix ||= "cached-slugs"
-
-  autoload :Caching
-  autoload :Scopes
-  autoload :Finders
-  autoload :SlugHistory
-  autoload :Slug
-  autoload :MemoryCache
-
-  require 'pseudocephalopod/active_record_methods'
-  ActiveRecord::Base.extend Pseudocephalopod::ActiveRecordMethods
-
-  require 'pseudocephalopod/railtie' if defined?(Rails::Railtie)
-
-end
+Pseudocephalopod = Slugged

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pseudocephalopod
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -15,46 +15,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-19 00:00:00 +08:00
+date: 2010-10-30 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: slugged
   prerelease: false
-  type: :runtime
-  name: activerecord
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  name: activesupport
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
-  name: uuid
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -63,36 +30,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: shoulda
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: reversible_data
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id005
-description: Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history
+  type: :runtime
+  version_requirements: *id001
+description: Renamed to slugged (http://github.com/Sutto/slugged)
 email: sutto@sutto.net
 executables: []
 
@@ -105,35 +45,12 @@ files:
 - .document
 - .gitignore
 - .rvmrc
-- Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- lib/generators/pseudocephalopod/slug_migration/slug_migration_generator.rb
-- lib/generators/pseudocephalopod/slug_migration/templates/migration.erb
-- lib/generators/pseudocephalopod/slugs/slugs_generator.rb
-- lib/generators/pseudocephalopod/slugs/templates/migration.erb
 - lib/pseudocephalopod.rb
-- lib/pseudocephalopod/active_record_methods.rb
-- lib/pseudocephalopod/caching.rb
-- lib/pseudocephalopod/finders.rb
-- lib/pseudocephalopod/memory_cache.rb
-- lib/pseudocephalopod/railtie.rb
-- lib/pseudocephalopod/scopes.rb
-- lib/pseudocephalopod/slug.rb
-- lib/pseudocephalopod/slug_history.rb
-- lib/pseudocephalopod/version.rb
-- metrics/.gitignore
-- pseudocephalopod.gemspec
-- test/caching_test.rb
-- test/helper.rb
-- test/is_sluggable_test.rb
-- test/model_definitions.rb
-- test/pseudocephalopod_test.rb
-- test/slug_history_test.rb
 has_rdoc: true
-homepage: http://github.com/Sutto/pseudocephalopod
+homepage: http://github.com/Sutto/slugged
 licenses: []
 
 post_install_message: 
@@ -165,11 +82,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Super simple slugs for ActiveRecord 3.0 and higher, with support for slug history
-test_files: 
-- test/caching_test.rb
-- test/helper.rb
-- test/is_sluggable_test.rb
-- test/model_definitions.rb
-- test/pseudocephalopod_test.rb
-- test/slug_history_test.rb
+summary: Renamed to slugged (http://github.com/Sutto/slugged)
+test_files: []
+