pseudocephalopod 0.3.1 → 0.3.2

data/Gemfile

@@ -1,20 +0,0 @@
-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

@@ -1,82 +0,0 @@
-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/lib/generators/pseudocephalopod/slug_migration/slug_migration_generator.rb

@@ -1,24 +0,0 @@
-module Pseudocephalopod
-  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/pseudocephalopod/slug_migration/templates/migration.erb

@@ -1,12 +0,0 @@
-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/pseudocephalopod/slugs/slugs_generator.rb

@@ -1,24 +0,0 @@
-module Pseudocephalopod
-  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_pseudocephalopod_slugs.rb"
-      end
-      
-    end
-  end
-end

data/lib/generators/pseudocephalopod/slugs/templates/migration.erb

@@ -1,20 +0,0 @@
-class CreatePseudocephalopodSlugs < ActiveRecord::Migration
-  
-  def self.up
-    create_table :slugs do |t|
-      t.string   :scope
-      t.string   :slug
-      t.integer  :record_id
-      t.datetime :created_at
-    end
-    add_index :slugs, [:scope, :slug]
-    add_index :slugs, [:scope, :record_id]
-    add_index :slugs, [:scope, :slug, :created_at]
-    add_index :slugs, [:scope, :record_id, :created_at]
-  end
-
-  def self.down
-    drop_table :slugs
-  end
-  
-end

data/lib/pseudocephalopod/active_record_methods.rb

@@ -1,112 +0,0 @@
-module Pseudocephalopod
-  module ActiveRecordMethods
-    AR_CLASS_ATTRIBUTE_NAMES = %w(cached_slug_column slug_source slug_convertor_proc default_uuid_slug use_slug_history sync_slugs slug_scope use_slug_cache use_slug_to_param).map(&:to_sym)
-    
-    def is_sluggable(source = :name, options = {})
-      options.symbolize_keys!
-      class_attribute *AR_CLASS_ATTRIBUTE_NAMES
-      attr_accessor   :found_via_slug
-      # Load extensions
-      extend  ClassMethods
-      include InstanceMethods
-      extend Pseudocephalopod::Scopes
-      extend Pseudocephalopod::Finders
-      self.slug_source = source.to_sym
-      set_slug_options options
-      alias_method :to_param, :to_slug      if use_slug_to_param
-      include Pseudocephalopod::SlugHistory if use_slug_history
-      include Pseudocephalopod::Caching     if use_slug_cache
-      before_save :autogenerate_slug
-    end
-    
-    module InstanceMethods
-      
-      def to_slug
-        cached_slug.present? ? cached_slug : id.to_s
-      end
-      
-      def generate_slug
-        slug_value = send(self.slug_source)
-        slug_value = self.slug_convertor_proc.call(slug_value) if slug_value.present?
-        if slug_value.present?
-          scope = self.class.other_than(self).slug_scope_relation(self)
-          slug_value = Pseudocephalopod.next_value(scope, slug_value)
-          write_attribute self.cached_slug_column, slug_value
-        elsif self.default_uuid_slug
-          write_attribute self.cached_slug_column, Pseudocephalopod.generate_uuid_slug
-        else
-          write_attribute self.cached_slug_column, nil
-        end
-      end
-      
-      def generate_slug!
-        generate_slug
-        save :validate => false
-      end
-      
-      def autogenerate_slug
-        generate_slug if should_generate_slug?
-      end
-      
-      def should_generate_slug?
-        send(self.cached_slug_column).blank? || (self.sync_slugs && send(:"#{self.slug_source}_changed?"))
-      end
-      
-      def has_better_slug?
-        found_via_slug.present? && found_via_slug != to_slug
-      end
-      
-      def slug_scope_key(nested_scope = [])
-        self.class.slug_scope_key(nested_scope)
-      end
-      
-    end
-    
-    module ClassMethods
-      
-      def update_all_slugs!
-        find_each { |r| r.generate_slug! }
-      end
-      
-      def slug_scope_key(nested_scope = [])
-        ([table_name, slug_scope] + Array(nested_scope)).flatten.compact.join("|")
-      end
-      
-      def slug_scope_relation(record)
-        has_slug_scope? ? where(slug_scope => record.send(slug_scope)) : scoped
-      end
-      
-      protected
-      
-      def has_slug_scope?
-        self.slug_scope.present?
-      end
-      
-      def set_slug_options(options)
-        set_slug_convertor options[:convertor]
-        self.cached_slug_column = (options[:slug_column] || :cached_slug).to_sym
-        self.slug_scope         = options[:scope]
-        self.default_uuid_slug  = !!options.fetch(:uuid, true)
-        self.sync_slugs         = !!options.fetch(:sync, true)
-        self.use_slug_cache     = !!options.fetch(:use_cache, true)
-        self.use_slug_to_param  = !!options.fetch(:to_param, true)
-        self.use_slug_history   = !!options.fetch(:history, Pseudocephalopod::Slug.usable?)
-      end
-      
-      def set_slug_convertor(convertor)
-        if convertor.present?
-          unless convertor.respond_to?(:call)
-            convertor_key = convertor.to_sym
-            convertor     = proc { |r| r.try(convertor_key) }
-          end
-          self.slug_convertor_proc = convertor
-        else
-          self.slug_convertor_proc = proc do |slug|
-            slug.respond_to?(:to_url) ? slug.to_url : ActiveSupport::Multibyte::Chars.new(slug.to_s).parameterize
-          end
-        end
-      end
-      
-    end    
-  end
-end

data/lib/pseudocephalopod/caching.rb

@@ -1,87 +0,0 @@
-require 'digest/sha2'
-
-module Pseudocephalopod
-  # Mixin for adding simple caching support to models using pseudocephalod.
-  # Usually included by passing the :cache option as true (by default it is
-  # true, you can disable by passing :cache as false or nil).
-  module Caching
-    extend ActiveSupport::Concern
-    
-    mattr_accessor :cache_expires_in
-    # Cache for 10 minutes by default.
-    self.cache_expires_in = 600
-   
-    included do
-      after_save :globally_cache_slug
-    end
-   
-    module InstanceMethods
-      # Automatically called in after_save, will cache this records id
-      # with to match the current records slug / scope
-      def globally_cache_slug
-        return unless send(:"#{self.cached_slug_column}_changed?")
-        value = self.to_slug
-        self.class.cache_slug_lookup!(value, self) if value.present?
-        unless use_slug_history
-          value = send(:"#{self.cached_slug_column}_was")
-          self.class.cache_slug_lookup!(value, nil)
-        end
-      end
-      
-      # Wraps remove_slug_history! to remove each of the slugs
-      # recording in this models slug history.
-      def remove_slug_history!
-        previous_slugs.each { |s| self.class.cache_slug_lookup!(s, nil) }
-        super
-      end
-      
-    end
-   
-    module ClassMethods
-      
-      # Wraps find_using_slug to look in the cache.
-      def find_using_slug(slug, options = {})
-        # First, attempt to load an id and then record from the cache.
-        if (cached_id = lookup_cached_id_from_slug(slug)).present?
-          return find(cached_id, options).tap { |r| r.found_via_slug = slug }
-        end
-        # Otherwise, fallback to the normal approach.
-        super.tap do |record|
-          cache_slug_lookup!(slug, record) if record.present?
-        end
-      end
-      
-      # Returns a slug cache key for a given slug.
-      def slug_cache_key(slug)
-        [Pseudocephalopod.cache_key_prefix, slug_scope_key(Digest::SHA256.hexdigest(slug.to_s.strip))].compact.join("/")
-      end
-      
-      def has_cache_for_slug?(slug)
-        lookup_cached_id_from_slug(slug).present?
-      end
-      
-      # Modify the cache for a given slug. If record is nil, it will
-      # delete the item from the slug cache, otherwise it will store
-      # the records id.
-      def cache_slug_lookup!(slug, record)
-        return if Pseudocephalopod.cache.blank?
-        cache = Pseudocephalopod.cache
-        key   = slug_cache_key(slug)
-        # Set an expires in option for caching.
-        caching_options = Hash.new.tap do |hash|
-          expiry = Pseudocephalopod::Caching.cache_expires_in
-          hash[:expires_in] = expiry.to_i if expiry.present?
-        end
-        record.nil? ? cache.delete(key) : cache.write(key, record.id, caching_options)
-      end
-      
-      protected
-      
-      def lookup_cached_id_from_slug(slug)
-        Pseudocephalopod.cache && Pseudocephalopod.cache.read(slug_cache_key(slug))
-      end
-      
-    end
-    
-  end
-end

data/lib/pseudocephalopod/finders.rb

@@ -1,19 +0,0 @@
-module Pseudocephalopod
-  module Finders
-    
-    def find_using_slug(slug, options = {})
-      slug = slug.to_s
-      value = nil
-      value ||= find_by_id(slug.to_i, options) if slug =~ /\A\d+\Z/
-      value ||= with_cached_slug(slug).first(options)
-      value ||= find_using_slug_history(slug, options) if use_slug_history
-      value.found_via_slug = slug if value.present?
-      value
-    end
-    
-    def find_using_slug!(slug, options = {})
-      find_using_slug(slug, options) or raise ActiveRecord::RecordNotFound
-    end
-    
-  end
-end

data/lib/pseudocephalopod/memory_cache.rb

@@ -1,29 +0,0 @@
-module Pseudocephalopod
-  # Implements a simple cache store that uses the
-  # current processes memory. This makes is primarily
-  # used for testing purposes in the situations where
-  # caching is used.
-  class MemoryCache
-    
-    def self.write(key, value, options = {})
-      cache[key.to_s] = value
-    end
-    
-    def self.read(key)
-      cache[key.to_s]
-    end
-    
-    def self.delete(key)
-      cache.delete key.to_s
-    end
-    
-    def self.reset!
-      @cache = nil
-    end
-    
-    def self.cache
-      @cache ||= {}
-    end
-    
-  end
-end

data/lib/pseudocephalopod/railtie.rb

@@ -1,9 +0,0 @@
-module Pseudocephalopod
-  class Railtie < Rails::Railtie
-    
-    initializer "pseudocephalopod.initialize_cache" do
-      Pseudocephalopod.cache = Rails.cache if Rails.cache.present?
-    end
-    
-  end
-end