aq1018-dm-is-slug 0.9.9

data/History.txt

@@ -0,0 +1 @@
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Aaron Qian
+
+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/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+LICENSE
+Manifest.txt
+README.txt
+Rakefile
+TODO
+lib/dm-is-slug.rb
+lib/dm-is-slug/is/slug.rb
+lib/dm-is-slug/is/version.rb
+spec/integration/slug_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,56 @@
+= dm-is-slug
+
+DataMapper plugin for creating and slugs(permalinks).
+
+== Installation
+
+NOTE: You no longer need to download dm-more source code in order to install
+this.
+
+All you need to do is:
+
+$ sudo rake install
+
+Remember to require it in your app's init.rb
+
+dependency 'dm-is-slug'
+
+== Getting started
+
+Lets say we have a post-class, and we want to generate permalinks or slugs for all posts.
+
+class Post
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :title, String
+  property :content, String
+
+  # here we define that it should have a slug that uses title as the permalink
+  # it will generate an extra slug property of String type, with the same size as title
+  is :slug, :source => :title
+end
+
+Let's Say we need to define a permalink based on a method instead of a property.
+
+class User
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :email, String
+  property :password, String
+  
+  # we only want to strip out the domain name 
+  # and use only the email account name as the permalink
+  def slug_for_email
+    email.split("@").first
+  end
+  
+  # here we define that it should have a slug that uses title as the permalink
+  # it will generate an extra slug property of String type, with the same size as title
+  is :slug, :source => :slug_for_email, :size => 255
+end
+
+You can now find objects by slug like this:
+
+ post = Post.first(:slug => "your_slug")

data/Rakefile

@@ -0,0 +1,54 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'spec/rake/spectask'
+require 'pathname'
+
+ROOT = Pathname(__FILE__).dirname.expand_path
+require ROOT + 'lib/dm-is-slug/is/version'
+
+AUTHOR = "Aaron Qian, Nik Radford"
+EMAIL  = "aaron [a] ekohe [d] com; nik [a] terminaldischarge [d] net"
+GEM_NAME = "dm-is-slug"
+GEM_VERSION = DataMapper::Is::Slug::VERSION
+GEM_DEPENDENCIES = [["dm-core", "~>0.9"]]
+GEM_CLEAN = ["log", "pkg"]
+GEM_EXTRAS = { :has_rdoc => false }
+ 
+PROJECT_NAME = "dm-is-slug"
+PROJECT_URL  = "http://github.com/aq1018/dm-is-slug"
+PROJECT_DESCRIPTION = PROJECT_SUMMARY = "DataMapper plugin that generates unique slugs"
+
+require 'tasks/hoe'
+
+task :default => [ :spec ]
+ 
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+ 
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources", :verbose => false
+end
+ 
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{GEM_NAME} -v#{GEM_VERSION} -I -x", :verbose => false
+end
+ 
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+ 
+  begin
+    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+    t.rcov_opts << '--exclude' << 'spec'
+    t.rcov_opts << '--text-summary'
+    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+  rescue Exception
+    puts 'rcov is not installed. Please install before continuing'
+    exit
+  end
+end

data/TODO

@@ -0,0 +1,4 @@
+TODO
+====
+
+Docs??

data/lib/dm-is-slug.rb

@@ -0,0 +1,36 @@
+# Needed to import datamapper and other gems
+require 'rubygems'
+require 'pathname'
+require 'iconv'
+
+# Add all external dependencies for the plugin here
+gem 'dm-core', '~>0.9.9'
+require 'dm-core'
+
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-slug' / 'is' / 'version.rb'
+
+# Require plugin-files
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-slug' / 'is' / 'slug.rb'
+
+# Include the plugin in Resource
+module DataMapper
+  module Resource
+    module ClassMethods
+      include DataMapper::Is::Slug
+    end # module ClassMethods
+  end # module Resource
+end # module DataMapper
+
+# Include DataMapper::Model#get and DataMapper::Collection#get override
+# So we do user.posts.get("my-shinny-new-post")
+
+module DataMapper
+  module Model
+    include DataMapper::Is::Slug::AliasMethods
+  end
+  
+  class Collection
+    include DataMapper::Is::Slug::AliasMethods
+  end
+end
+

data/lib/dm-is-slug/is/slug.rb

@@ -0,0 +1,164 @@
+module DataMapper
+  module Is
+    module Slug
+      DEFAULT_SLUG_SIZE = 50
+      
+      # @param [String] str A string to escape for use as a slug
+      # @return [String] an URL-safe string
+      def self.escape(str)
+        s = Iconv.conv('ascii//translit//IGNORE', 'utf-8', str)
+        s.gsub!(/\W+/, ' ')
+        s.strip!
+        s.downcase!
+        s.gsub!(/\ +/, '-')
+        s
+      end
+      
+      ##
+      # Methods that should be included in DataMapper::Model.
+      # Normally this should just be your generator, so that the namespace
+      # does not get cluttered. ClassMethods and InstanceMethods gets added
+      # in the specific resources when you fire is :slug
+      ##
+
+      # Defines a +slug+ property on your model with the same size as your 
+      # source property. This property is Unicode escaped, and treated so as 
+      # to be fit for use in URLs.
+      #
+      # ==== Example
+      # Suppose your source attribute was the following string: "Hot deals on 
+      # Boxing Day". This string would be escaped to "hot-deals-on-boxing-day".
+      #
+      # Non-ASCII characters are attempted to be converted to their nearest 
+      # approximate.
+      #
+      # ==== Parameters
+      # +permanent_slug+::
+      #   Permanent slugs are not changed even if the source property has
+      # +source+::
+      #   The property on the model to use as the source of the generated slug
+      # +size+::
+      #   The length of the +slug+ property
+      #
+      # @param [Hash] provide options in a Hash. See *Parameters* for details
+      def is_slug(options)
+        extend  DataMapper::Is::Slug::ClassMethods
+        include DataMapper::Is::Slug::InstanceMethods
+        
+        # merge in default options
+        options = { :permanent_slug => true }.merge(options)
+        
+        # must at least specify a source property to generate the slug
+#        raise 'You must specify a :source to generate slug' unless options.include?(:source)
+        raise 'You must specify a :source to generate slug' unless options[:source]
+        
+        # make sure the source property exsists
+        source_property = properties.detect do |p|
+          p.name == options[:source].to_sym && p.type == String
+        end
+
+        # Find the string length so that slug can adapt size dynamically 
+        # depending on the source property, or use the default slug size.
+        options[:size] ||= source_property &&
+                             source_property.size ||
+                             DataMapper::Is::Slug::DEFAULT_SLUG_SIZE
+        
+        # save as class variable for later...
+        @slug_options = options
+        
+        unless slug_property
+          property :slug, String, :size => options[:size], :unique => true
+        end
+         
+        before :save, :generate_slug
+      end
+
+      module ClassMethods
+        attr_reader :slug_options
+        
+        def permanent_slug?
+          slug_options[:permanent_slug]
+        end
+        
+        def slug_source
+          slug_options[:source].to_sym
+        end
+        
+        def slug_source_property
+          detect_slug_property_by_name(slug_source)
+        end
+        
+        def slug_property
+          detect_slug_property_by_name(:slug)
+        end
+
+        private
+
+        def detect_slug_property_by_name(name)
+          properties.detect do |p|
+            p.name == name && p.type == String
+          end
+        end
+      end # ClassMethods
+
+      module InstanceMethods
+        def to_param
+          [slug]
+        end
+        
+        def permanent_slug?
+          self.class.permanent_slug?
+        end
+        
+        def slug_source
+          self.class.slug_source
+        end
+        
+        def slug_source_property
+          self.class.slug_source_property
+        end
+        
+        def slug_property
+          self.class.slug_property
+        end
+        
+        def generate_slug
+          source = self.send(slug_source)
+          
+          raise ':source is invalid!' unless slug_source_property || self.respond_to?(slug_source)
+                              
+          return if permanent_slug? && self.slug || source.nil?
+          
+          # we turn the source into a slug here
+          self.slug = DataMapper::Is::Slug.escape(source)
+          
+          self.slug = "#{self.slug}-2" if self.class.first(:slug => self.slug)
+
+          while self.class.first(:slug => self.slug) != nil
+            i = self.slug[-1..-1].to_i + 1
+            self.slug = self.slug[0..-2] + i.to_s
+          end
+        end
+      end # InstanceMethods
+      
+      module AliasMethods
+        # override the old get method so that it looks for slugs first
+        # and call the old get if slug is not found
+        def get_with_slug(*key)
+          if respond_to?(:slug_options) && slug_options && key[0].to_s.to_i.to_s != key[0].to_s
+            first(:slug => key[0])
+          else
+            get_without_slug(*key)
+          end
+        end
+        
+        ##
+        # fired when your plugin gets included into Resource
+        def self.included(base)
+          base.send :alias_method, :get_without_slug, :get
+          base.send :alias_method, :get, :get_with_slug
+        end
+      end
+    end # Slug
+  end # Is
+end # DataMapper

data/lib/dm-is-slug/is/version.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module Is
+    module Slug
+      VERSION = "0.9.9"
+    end
+  end
+end

data/spec/integration/slug_spec.rb

@@ -0,0 +1,182 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+  describe 'DataMapper::Is::Slug' do
+ 
+    class User
+      include DataMapper::Resource
+
+      property :id, Serial
+      property :email, String
+      has n, :posts
+      has n, :todos
+ 
+      def slug_for_email
+        email.split("@").first
+      end
+ 
+      is :slug, :source => :slug_for_email, :size => 80, :permanent_slug => false
+    end
+ 
+    class Post
+      include DataMapper::Resource
+
+      property :id, Serial
+      property :title, String, :size => 2000
+      property :content, Text
+
+      belongs_to :user
+
+      is :slug, :source => :title
+    end
+ 
+    class Todo
+      include DataMapper::Resource
+      property :id, Serial
+      property :title, String
+ 
+      belongs_to :user
+    end
+
+    before :all do
+      User.auto_migrate!(:default)
+      Post.auto_migrate!(:default)
+      Todo.auto_migrate!(:default)
+
+      @u1 = User.create(:email => "john@ekohe.com")
+      @p1 = Post.create(:user => @u1, :title => "My first shinny blog post")
+      @p2 = Post.create(:user => @u1, :title => "My second shinny blog post")
+      @p3 = Post.create(:user => @u1, :title => "My third shinny blog post")
+
+      @u2 = User.create(:email => "john@someotherplace.com")
+      @p4 = Post.create(:user => @u2, :title => "My first Shinny blog post")
+      @p5 = Post.create(:user => @u2, :title => "i heart merb and dm")
+      @p6 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p7 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p8 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p9 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p10 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p11 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p12 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p13 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p14 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p15 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p16 = Post.create(:user => @u2, :title => "another productive day!!")
+      @p17 = Post.create(:user => @u2, :title => "A fancy café")
+    end
+ 
+    it "should generate slugs" do
+      User.all.each do |u|
+        u.slug.should_not be_nil
+      end
+ 
+      Post.all.each do |p|
+        p.slug.should_not be_nil
+      end
+    end
+ 
+    it "should generate unique slugs" do
+      @u1.slug.should_not == @u2.slug
+      @p1.slug.should_not == @p4.slug
+    end
+ 
+    it "should generate correct slug for user" do
+      @u1.slug.should == "john"
+      @u2.slug.should == "john-2"
+    end
+ 
+    it "should generate correct slug for post" do
+      @p1.slug.should == "my-first-shinny-blog-post"
+      @p2.slug.should == "my-second-shinny-blog-post"
+      @p3.slug.should == "my-third-shinny-blog-post"
+      @p4.slug.should == "my-first-shinny-blog-post-2"
+      @p5.slug.should == "i-heart-merb-and-dm"
+      @p6.slug.should == "another-productive-day"
+      @p7.slug.should == "another-productive-day-2"
+      @p8.slug.should == "another-productive-day-3"
+      @p9.slug.should == "another-productive-day-4"
+      @p10.slug.should == "another-productive-day-5"
+      @p11.slug.should == "another-productive-day-6"
+      @p12.slug.should == "another-productive-day-7"
+      @p13.slug.should == "another-productive-day-8"
+      @p14.slug.should == "another-productive-day-9"
+      @p15.slug.should == "another-productive-day-10"
+      @p16.slug.should == "another-productive-day-11"
+    end
+ 
+    it "should update slug if :permanent_slug => :false is specified" do
+      user = User.create(:email => "a_person@ekohe.com")
+      user.slug.should == "a_person"
+ 
+      user.should_not be_permanent_slug
+ 
+      user.email = "changed@ekohe.com"
+      user.should be_dirty
+      user.save.should be_true
+      user.slug.should == "changed"
+      user.destroy
+    end
+ 
+    it "should not update slug if :permanent_slug => :true or not specified" do
+      post = Post.create(:user => @u1, :title => "hello world!")
+      post.slug.should ==  "hello-world"
+      post.should be_permanent_slug
+      post.title = "hello universe!"
+      post.should be_dirty
+      post.save.should be_true
+      post.slug.should == "hello-world"
+      post.destroy
+    end
+ 
+    it "should have the right size for properties" do
+      user_slug_property = User.properties.detect{|p| p.name == :slug && p.type == String}
+      user_slug_property.should_not be_nil
+      user_slug_property.size.should == 80
+ 
+      Post.properties.detect{|p| p.name == :title && p.type == String}.size.should == 2000
+      post_slug_property = Post.properties.detect{|p| p.name == :slug && p.type == String}
+      post_slug_property.should_not be_nil
+      post_slug_property.size.should == 2000
+    end
+ 
+    it "should find model using get method with slug" do
+      u = User.get("john")
+      u.should_not be_nil
+      u.should == @u1
+ 
+      Post.get("my-first-shinny-blog-post").should == @p1
+      @u1.posts.get("my-first-shinny-blog-post").should == @p1
+    end
+ 
+    it "should output slug with to_param method" do
+      @u1.to_param.should == ["john"]
+      @p1.to_param.should == ["my-first-shinny-blog-post"]
+    end
+ 
+    it "should find model using get method using id" do
+      u = User.get(@u1.id)
+      u.should_not be_nil
+      u.should == @u1
+
+      Post.get("my-first-shinny-blog-post").should == @p1
+      @u1.posts.get("my-first-shinny-blog-post").should == @p1
+    end
+ 
+    it "should find model using get method using id with non-slug models" do
+      todo = Todo.create(:user => @u1, :title => "blabla")
+      todo.should_not be_nil
+
+      Todo.get(todo.id).should == todo
+      @u1.todos.get(todo.id).should == todo
+    end
+
+    it 'should strip unicode characters from the slug' do
+      @p17.slug.should == 'a-fancy-caf-e'
+    end
+    
+    it 'should have slug_property on instance' do
+      @p1.slug_property.should == @p1.class.properties.detect{|p| p.name == :slug}
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+gem 'rspec', '~>1.1.3'
+require 'spec'
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-is-slug'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, '~>0.9.7'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: aq1018-dm-is-slug
+version: !ruby/object:Gem::Version 
+  version: 0.9.9
+platform: ruby
+authors: 
+- Aaron Qian, Nik Radford
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.9"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: DataMapper plugin that generates unique permalinks / slugs
+email: 
+- aaron [a] ekohe [d] com; nik [a] terminaldischarge [d] net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO
+- lib/dm-is-slug.rb
+- lib/dm-is-slug/is/slug.rb
+- lib/dm-is-slug/is/version.rb
+- spec/integration/slug_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/aq1018/dm-is-slug
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dm-is-slug
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin that generates unique permalinks / slugs
+test_files: []
+