dm-is-sluggable 0.9.10

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jakub Stastny aka Botanicus
+
+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.textile

@@ -0,0 +1,22 @@
+h1. About
+
+This is plugin for easy creating unique slugs from other properties.
+
+
+h1. Initialization
+
+You need to have DataMapper model with property slug. To set slug just use before create hook with set_slug model method. This method takes the slug as parameter. Use String#to_slug to get this parameter if you need.
+
+<pre>
+class Post
+  include DataMapper::Resource
+  is :sluggable
+  property :title, String
+  property :slug,  String, :key => true
+  before :create do
+    set_slug(self.title.to_slug)
+  end
+end
+</pre>
+
+So what exactly set_slug does? It look for given slug, if not found than save it, let say as "foo-bar". If found, than increase number of iteraction and tries it again with "foo-bar-2".

data/Rakefile

@@ -0,0 +1,56 @@
+# coding: utf-8
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'lib/dm-is-sluggable/is/version'
+
+GEM_NAME = "dm-is-sluggable"
+AUTHOR = "Jakub Stastny aka Botanicus"
+EMAIL = "knava.bestvinensis@gmail.com"
+HOMEPAGE = "http://101Ideas.cz/"
+SUMMARY = "Creates unique slug from property. For DataMapper ORM."
+GEM_VERSION = DataMapper::Is::Sluggable::VERSION
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.textile", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README.textile Rakefile) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+def sudo_gem(cmd)
+  sh "#{SUDO} #{RUBY} -S gem #{cmd}", :verbose => false
+end
+
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
+task :install => [ :package ] do
+  sudo_gem "install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION}"
+task :uninstall => [ :clobber ] do
+  sudo_gem "uninstall #{GEM_NAME} -v#{GEM_VERSION} -Ix"
+end
+
+require 'spec/rake/spectask'
+desc 'Default: run spec examples'
+task :default => 'spec'

data/TODO

@@ -0,0 +1 @@
+- find a better way how to remove diacritics (not just Czech one)

data/dm-is-sluggable.gemspec

@@ -0,0 +1,23 @@
+begin
+  require "rubygems/specification"
+rescue SecurityError
+  # http://gems.github.com
+end
+
+VERSION  = "0.9.10"
+SPECIFICATION = ::Gem::Specification.new do |s|
+  s.name = "dm-is-sluggable"
+  # s.version = Rango::VERSION
+  s.version = VERSION
+  s.authors = ["Jakub Šťastný aka Botanicus"]
+  s.homepage = "http://github.com/botanicus/dm-is-sluggable"
+  s.summary = "This is plugin for easy creating unique slugs from other properties."
+  # s.description = "" # TODO: long description
+  s.cert_chain = nil
+  s.email = ["knava.bestvinensis", "gmail.com"].join("@")
+  s.files = Dir.glob("**/*") - Dir.glob("pkg/*")
+  s.add_dependency "dm-core"
+  s.require_paths = ["lib"]
+  # s.required_ruby_version = ::Gem::Requirement.new(">= 1.9.1")
+  # s.rubyforge_project = "rango"
+end

data/lib/dm-is-sluggable.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+require 'pathname'
+
+# Add all external dependencies for the plugin here
+gem 'dm-core'
+require 'dm-core'
+
+# Require plugin-files
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-sluggable' / 'is' / 'sluggable.rb'
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-sluggable' / 'string'
+
+# Include the plugin in Resource
+module DataMapper
+  module Model
+    include DataMapper::Is::Sluggable
+  end
+end

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

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+module DataMapper
+  module Is
+    module Sluggable
+      ##
+      # fired when your plugin gets included into Resource
+      #
+      def self.included(base)
+      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 :example
+      ##
+
+      def is_sluggable(options = Hash.new)
+        # Add class-methods
+        extend  DataMapper::Is::Sluggable::ClassMethods
+        # Add instance-methods
+        include DataMapper::Is::Sluggable::InstanceMethods
+      end
+
+      module ClassMethods
+      end
+
+      module InstanceMethods
+        def set_slug(slug, iteraction = 1)
+          raise ArgumentError if slug.nil?
+          new_slug = "#{slug}#{"-#{iteraction}" unless iteraction == 1}"
+          self.attribute_set(:slug, new_slug)
+          if self.class.first(:slug => self.slug)
+            self.set_slug(slug, iteraction.to_i + 1)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# coding: utf-8
+
+module DataMapper
+  module Is
+    module Sluggable
+      VERSION = '0.9.10'
+    end
+  end
+end

data/lib/dm-is-sluggable/string.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+class String
+  # Important: it do not work with self.tr("á", "a") in Ruby 1.8
+  def unicode_chars
+    { "á" => "a", "č" => "c", "ď" => "d",
+      "ě" => "e", "é" => "e", "í" => "i",
+      "ň" => "n", "ó" => "o", "ř" => "r",
+      "š" => "s", "ť" => "t", "ú" => "u",
+      "ů" => "u", "ý" => "y", "ž" => "z",
+      "Á" => "A", "Č" => "C", "Ď" => "D",
+      "Ě" => "E", "É" => "E", "Í" => "I",
+      "Ň" => "N", "Ó" => "O", "Ř" => "R",
+      "Š" => "S", "Ť" => "T", "Ú" => "U",
+      "Ů" => "U", "Ý" => "Y", "Ž" => "Z" }
+  end
+  
+  def to_ascii
+    string = self.dup
+    self.unicode_chars.each do |unicode, ascii|
+      string.gsub!(/#{unicode}/u, ascii)
+    end
+    return string
+  end
+  
+  def to_slug
+    string = self.to_ascii.strip.downcase
+    string.gsub!(/[ \t]+/, "-")    # replace blank chars by "-"
+    string.gsub!(/-*(.+)-*/, '\1') # no "-" at begin or end
+    string.delete!(%q{!@#$%^&*(){}[];:"'\|<>,./?]`~±})
+    return string
+  end
+end

data/spec/dm-is-sluggable/sluggable_spec.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+require File.join(File.dirname(__FILE__), '..', "spec_helper")
+require "dm-is-sluggable"
+
+class Post
+  include DataMapper::Resource
+  is :sluggable
+  property :title, String
+  property :slug,  String, :key => true
+  before :create do
+    set_slug(self.title.to_slug)
+  end
+end
+
+describe DataMapper::Is::Sluggable do
+  before do
+    @post = Post.create(:title => "Hello Bloody World")
+  end
+
+  describe "#set_slug" do
+    it "should create slug" do
+      @post.slug.should eql("hello-bloody-world")
+    end
+
+    it "should create unique slug" do
+      second = Post.create(:title => "Hello Bloody World")
+      second.slug.should eql("hello-bloody-world-2")
+    end
+  end
+end

data/spec/dm-is-sluggable/string_spec.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require File.join(File.dirname(__FILE__), '..', "spec_helper")
+
+describe "String#to_ascii" do
+  it "should remove diacritics" do
+    "Žádná česká znaménka".to_ascii.should eql("Zadna ceska znamenka")
+  end
+end
+
+describe "String#to_slug" do
+  it "should remove diacritics" do
+    "česká".to_slug.should eql("ceska")
+  end
+  
+  it "should downcase slug" do
+    "BIG".to_slug.should eql("big")
+  end
+  
+  it "should remove nonwords chars" do
+    "%^@$".to_slug.should eql("")
+  end
+  
+  it "should works" do
+    " Samolepka   X2 (černá). ".to_slug.should eql("samolepka-x2-cerna")
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format
+progress
+--loadby
+mtime

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# coding: utf-8
+
+$: << File.dirname(__FILE__) + "/../lib"
+
+require "dm-core"
+DataMapper.setup(:default, "sqlite3::memory")
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    DataMapper.auto_migrate!
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-sluggable
+version: !ruby/object:Gem::Version 
+  version: 0.9.10
+platform: ruby
+authors: 
+- "Jakub \xC5\xA0\xC5\xA5astn\xC3\xBD aka Botanicus"
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2009-11-26 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: knava.bestvinensis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- dm-is-sluggable.gemspec
+- lib/dm-is-sluggable/is/sluggable.rb
+- lib/dm-is-sluggable/is/version.rb
+- lib/dm-is-sluggable/string.rb
+- lib/dm-is-sluggable.rb
+- LICENSE
+- Rakefile
+- README.textile
+- spec/dm-is-sluggable/sluggable_spec.rb
+- spec/dm-is-sluggable/string_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- TODO
+has_rdoc: true
+homepage: http://github.com/botanicus/dm-is-sluggable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: This is plugin for easy creating unique slugs from other properties.
+test_files: []
+