friendly_id_sequel 3.0.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Norman Clarke
+
+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,31 @@
+This is an in-development experimental adapter for
+[FriendlyId](http://norman.github.com/friendly_id) using Sequel.
+
+It currently supports all of FriendlyId's features except:
+
+* Cached slugs
+* Scoped slugs
+* Rake tasks
+* Rails Generator
+
+Currently, only finds using `[]` are supported; I'll be adding some custom
+filters to make working with slugged records easier if anybody ends up using
+this.
+
+    @post = Post["this-is-a-title"]
+    @post.friendly_id # this-is-a-title
+
+## Usage
+
+    gem install friendly_id friendly_id_sequel
+
+    require "friendly_id"
+    require "friendly_id/sequel"
+
+    class Post < Sequel::Model
+      plugin :friendly_id :title, :use_slug => true
+    end
+
+
+For more information on the available features, please see the
+[FriendlyId Guide](http://norman.github.com/friendly_id/file.Guide.html).

data/Rakefile

@@ -0,0 +1,27 @@
+require "rake"
+require "rake/testtask"
+require "rake/gempackagetask"
+require "rake/clean"
+
+CLEAN << "pkg" << "doc" << "coverage" << ".yardoc"
+
+Rake::GemPackageTask.new(eval(File.read("friendly_id_sequel.gemspec"))) { |pkg| }
+Rake::TestTask.new(:test) { |t| t.pattern = "test/*_test.rb" }
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ["--output-dir=docs"]
+  end
+rescue LoadError
+end
+
+begin
+  require "rcov/rcovtask"
+  Rcov::RcovTask.new do |r|
+    r.test_files = FileList["test/**/*_test.rb"]
+    r.verbose = true
+    r.rcov_opts << "--exclude gems/*"
+  end
+rescue LoadError
+end

data/lib/friendly_id/sequel_adapter/create_slugs.rb

@@ -0,0 +1,27 @@
+require "sequel/extensions/migration"
+
+module FriendlyId
+  module SequelAdapter
+    class CreateSlugs < ::Sequel::Migration
+
+      def up
+        create_table :slugs do
+          primary_key :id, :type => Integer
+          string :name
+          integer :sluggable_id
+          integer :sequence, :null => false, :default => 1
+          string :sluggable_type, :limit => 40
+          string :scope
+          timestamp :created_at
+        end
+        add_index :slugs, :sluggable_id
+        add_index :slugs, [:name, :sluggable_type, :sequence, :scope], :name => "index_slugs_on_n_s_s_and_s", :unique => true
+      end
+
+      def down
+        drop_table :slugs
+      end
+
+    end
+  end
+end

data/lib/friendly_id/sequel_adapter/simple_model.rb

@@ -0,0 +1,66 @@
+module FriendlyId
+  module SequelAdapter
+
+    module SimpleModel
+
+      class SingleFinder
+
+        include FriendlyId::Finders::Base
+        include FriendlyId::Finders::Single
+
+        def find
+          with_sql(query).first if !unfriendly?
+        end
+
+        private
+
+        def query
+          table = simple_table
+          column = friendly_id_config.column
+          "SELECT * FROM #{table} WHERE #{column} = #{dataset.literal(id)}"
+        end
+
+      end
+
+      def self.included(base)
+        def base.primary_key_lookup(pk)
+          SingleFinder.new(pk, self).find or super
+        end
+      end
+
+      # Get the {FriendlyId::Status} after the find has been performed.
+      def friendly_id_status
+        @friendly_id_status ||= Status.new :record => self
+      end
+
+      # Returns the friendly_id.
+      def friendly_id
+        send self.class.friendly_id_config.column
+      end
+
+      # Returns the friendly id, or if none is available, the numeric id.
+      def to_param
+        (friendly_id || id).to_s
+      end
+
+      def validate
+        return if skip_friendly_id_validations
+        column = friendly_id_config.column
+        value = send(column)
+        return errors.add(column, "can't be blank") if value.blank?
+        return errors.add(column, "is reserved") if friendly_id_config.reserved?(value)
+      end
+
+      private
+
+      def skip_friendly_id_validations
+        friendly_id.nil? && self.class.friendly_id_config.allow_nil?
+      end
+
+      def friendly_id_config
+        self.class.friendly_id_config
+      end
+
+    end
+  end
+end

data/lib/friendly_id/sequel_adapter/slug.rb

@@ -0,0 +1,43 @@
+module FriendlyId
+  module SequelAdapter
+    class Slug < ::Sequel::Model
+
+      def to_friendly_id
+        sequence.to_i > 1 ? friendly_id_with_sequence : name
+      end
+
+      private
+
+      def before_create
+        self.sequence = next_sequence
+        self.created_at = DateTime.now
+      end
+
+      def enable_name_reversion
+        conditions = { :sluggable_id => sluggable_id, :sluggable_type => sluggable_type,
+            :name => name, :scope => scope }
+        self.class.filter(conditions).delete
+      end
+
+      def friendly_id_with_sequence
+        "#{name}#{separator}#{sequence}"
+      end
+
+      def next_sequence
+        enable_name_reversion
+        conditions =  { :name => name, :scope => scope, :sluggable_type => sluggable_type }
+        prev = self.class.filter(conditions).order("sequence DESC").first
+        prev ? prev.sequence.succ : 1
+      end
+
+      def separator
+        sluggable_type.constantize.friendly_id_config.sequence_separator
+      end
+
+      def validate
+        errors.add(:name, "can't be blank") if name.blank?
+      end
+
+    end
+  end
+end

data/lib/friendly_id/sequel_adapter/slugged_model.rb

@@ -0,0 +1,84 @@
+module FriendlyId
+  module SequelAdapter
+
+    module SluggedModel
+
+      class SingleFinder
+
+        include FriendlyId::Finders::Base
+        include FriendlyId::Finders::Single
+
+        def find
+          join(*join_conditions).select(columns).where(conditions).first
+        end
+
+        private
+
+        def columns
+          :"#{table_name}".*
+        end
+
+        def conditions
+          {:name.qualify("slugs") => name, :sequence.qualify("slugs") => sequence}
+        end
+
+        def join_conditions
+          return :slugs, :sluggable_id => :id, :sluggable_type => model_class.to_s
+        end
+
+      end
+
+      include FriendlyId::Slugged::Model
+
+      def self.included(base)
+        base.one_to_many :slugs,
+          :class => slug_class,
+          :key => "sluggable_id",
+          :conditions => {:sluggable_type => "#{base.to_s}"},
+          :order => "id DESC"
+        def base.[](*args)
+          if args.size == 1
+            SingleFinder.new(args.first, self).find or super
+          else
+            super
+          end
+        end
+      end
+
+      def self.slug_class
+        FriendlyId::SequelAdapter::Slug
+      end
+
+      def find_slug(name, sequence)
+        slugs_dataset.where("slugs.name" => name, "slugs.sequence" => sequence).first
+      end
+
+      private
+
+      def after_save
+        return if friendly_id_config.allow_nil? && !@slug
+        @slug.sluggable_id = id
+        @slug.save
+      end
+
+      def build_slug
+        self.slug = SluggedModel.slug_class.new :name => slug_text,
+          :sluggable_type => self.class.to_s
+      end
+
+      def skip_friendly_id_validations
+        friendly_id.nil? && friendly_id_config.allow_nil?
+      end
+
+      def validate
+        build_slug if new_slug_needed?
+        method = friendly_id_config.method
+      rescue FriendlyId::BlankError
+        return errors.add(method, "can't be blank")
+      rescue FriendlyId::ReservedError
+        return errors.add(method, "is reserved")
+      end
+
+    end
+  end
+end

data/lib/friendly_id/sequel_adapter/version.rb

@@ -0,0 +1,11 @@
+module FriendlyId
+  module SequelAdapter
+    module Version
+      MAJOR  = 3
+      MINOR  = 0
+      TINY   = 0
+      STRING = [MAJOR, MINOR, TINY].join(".")
+    end
+  end
+end
+

data/lib/friendly_id_sequel.rb

@@ -0,0 +1,33 @@
+require "sequel"
+require File.join(File.dirname(__FILE__), "friendly_id", "sequel_adapter", "simple_model")
+require File.join(File.dirname(__FILE__), "friendly_id", "sequel_adapter", "slugged_model")
+require File.join(File.dirname(__FILE__), "friendly_id", "sequel_adapter", "create_slugs")
+
+module Sequel
+
+  module Plugins
+
+    module FriendlyId
+
+      def self.configure(model, method, opts={})
+        model.instance_eval do
+          if friendly_id_config.use_slug?
+            require File.join(File.dirname(__FILE__), "friendly_id", "sequel_adapter", "slug")
+            include ::FriendlyId::SequelAdapter::SluggedModel
+          else
+            include ::FriendlyId::SequelAdapter::SimpleModel
+          end
+        end
+      end
+
+      module ClassMethods
+        attr_accessor :friendly_id_config
+        def friendly_id_config
+          @friendly_id_config ||= ::FriendlyId::Configuration.new(self, *friendly_id_opts)
+        end
+      end
+
+    end
+  end
+
+end

data/test/basic_simple_test.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+module FriendlyId
+  module Test
+    module SequelAdapter
+
+      # Tests for Sequel models using FriendlyId without slugs.
+      class BasicSimpleTest < ::Test::Unit::TestCase
+        include FriendlyId::Test::Generic
+        include FriendlyId::Test::Simple
+        include FriendlyId::Test::SequelAdapter::Core
+        include FriendlyId::Test::SequelAdapter::Simple
+      end
+    end
+  end
+end

data/test/basic_slugged_test.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+module FriendlyId
+  module Test
+    module SequelAdapter
+
+      # Tests for Sequel models using FriendlyId with slugs.
+      class BasicSluggedTest < ::Test::Unit::TestCase
+        include FriendlyId::Test::Generic
+        include FriendlyId::Test::Slugged
+        include FriendlyId::Test::SequelAdapter::Core
+        include FriendlyId::Test::SequelAdapter::Slugged
+      end
+    end
+  end
+end

data/test/core.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+module FriendlyId
+  module Test
+    module SequelAdapter
+
+      # Core tests for any sequel model using FriendlyId.
+      module Core
+
+        def teardown
+          klass.delete
+          other_class.delete
+          FriendlyId::SequelAdapter::Slug.delete
+        end
+
+        def find_method
+          :[]
+        end
+
+        def create_method
+          :create
+        end
+
+        def delete_all_method
+          :destroy
+        end
+
+        def save_method
+          :save
+        end
+
+        def validation_exceptions
+          ::Sequel::ValidationFailed
+        end
+
+      end
+    end
+  end
+end

data/test/custom_normalizer_test.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+module FriendlyId
+  module Test
+    module SequelAdapter
+
+      class CustomNormalizerTest < ::Test::Unit::TestCase
+
+        include FriendlyId::Test::SequelAdapter::Core
+        include FriendlyId::Test::SequelAdapter::Slugged
+        include FriendlyId::Test::CustomNormalizer
+
+        def klass
+          Person
+        end
+
+      end
+    end
+  end
+end

data/test/simple.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+module FriendlyId
+  module Test
+    module SequelAdapter
+
+      module Simple
+
+        def klass
+          User
+        end
+
+        def other_class
+          Book
+        end
+
+        def instance
+          @instance ||= klass.send(create_method, :name => "hello world")
+        end
+
+      end
+    end
+  end
+end

data/test/slugged.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+module FriendlyId
+  module Test
+    module SequelAdapter
+
+      module Slugged
+
+        def klass
+          Post
+        end
+
+        def other_class
+          City
+        end
+
+        def instance
+          @instance ||= klass.send(create_method, :name => "hello world")
+        end
+
+      end
+    end
+  end
+end

data/test/sti_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+module FriendlyId
+  module Test
+    module SequelAdapter
+
+      class StiTest < ::Test::Unit::TestCase
+
+        include FriendlyId::Test::Generic
+        include FriendlyId::Test::Slugged
+        include FriendlyId::Test::SequelAdapter::Core
+        include FriendlyId::Test::SequelAdapter::Slugged
+
+        def klass
+          Cat
+        end
+
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,63 @@
+begin
+  # Try to require the preresolved locked set of gems.
+  require File.join(File.dirname(__FILE__), "..", ".bundle", "environment")
+rescue LoadError
+  # Fall back on doing an unlocked resolve at runtime.
+  require "rubygems"
+  require "bundler"
+  Bundler.setup
+end
+
+require "sequel"
+require "active_support"
+require "friendly_id"
+require "friendly_id/test"
+require "logger"
+require "test/unit"
+require "mocha"
+
+require File.dirname(__FILE__) + "/../lib/friendly_id_sequel"
+require File.dirname(__FILE__) + "/core"
+require File.dirname(__FILE__) + "/simple"
+require File.dirname(__FILE__) + "/slugged"
+
+DB = Sequel.sqlite
+FriendlyId::SequelAdapter::CreateSlugs.apply(DB, :up)
+
+%w[books users].each do |table|
+  DB.create_table(table) do
+    primary_key :id, :type => Integer
+    string :name, :unique => true
+    string :note
+  end
+end
+
+class Book < Sequel::Model; end
+class User < Sequel::Model; end
+[Book, User].each do |klass|
+  klass.plugin :friendly_id, :name
+end
+
+%w[animals cities people posts].each do |table|
+  DB.create_table(table) do
+    primary_key :id, :type => Integer
+    string :name
+    string :note
+  end
+end
+
+class Animal < Sequel::Model; end
+class Cat < Animal; end
+class City < Sequel::Model; end
+class Post < Sequel::Model; end
+class Person < Sequel::Model
+  def normalize_friendly_id(string)
+    string.upcase
+  end
+end
+
+[Cat, City, Post, Person].each do |klass|
+  klass.plugin :friendly_id, :name, :use_slug => true
+end
+
+# DB.loggers << Logger.new($stdout)

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: friendly_id_sequel
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 3
+  - 0
+  - 0
+  version: 3.0.0
+platform: ruby
+authors: 
+- Norman Clarke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-29 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: friendly_id
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta3
+        version: 3.0.0.beta3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 8
+        - 0
+        version: 3.8.0
+  type: :runtime
+  version_requirements: *id002
+description: An adapter for using Sequel::Model with FriendlyId.
+email: norman@njclarke.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/friendly_id/sequel_adapter/create_slugs.rb
+- lib/friendly_id/sequel_adapter/simple_model.rb
+- lib/friendly_id/sequel_adapter/slug.rb
+- lib/friendly_id/sequel_adapter/slugged_model.rb
+- lib/friendly_id/sequel_adapter/version.rb
+- lib/friendly_id_sequel.rb
+- README.md
+- LICENSE
+- Rakefile
+- test/basic_simple_test.rb
+- test/basic_slugged_test.rb
+- test/core.rb
+- test/custom_normalizer_test.rb
+- test/simple.rb
+- test/slugged.rb
+- test/sti_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://norman.github.com/friendly_id_sequel
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: friendly_id_sequel
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A Sequel adapter for FriendlyId
+test_files: 
+- test/basic_simple_test.rb
+- test/basic_slugged_test.rb
+- test/custom_normalizer_test.rb
+- test/sti_test.rb