rs3vans-dm-is-sluggable 0.3.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Evans
+
+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.rdoc

@@ -0,0 +1,17 @@
+= dm-is-sluggable
+
+Adds slug support to DataMapper models. Slugs are clean, human-readable identifiers that can be used in-place of a more traditional number-based id.
+
+== 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 Ryan Evans. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rs3vans-dm-is-sluggable"
+    gem.summary = %Q{Adds slug support to DataMapper models.}
+    gem.description = %Q{Adds slug support to DataMapper models. Slugs are clean, human-readable identifiers that can be used in-place of a more traditional number-based id.}
+    gem.email = "rs3vans@gmail.com"
+    gem.homepage = "http://github.com/rs3vans/dm-is-sluggable"
+    gem.authors = ["Ryan Evans"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "dm-core", ">= 0.10.2"
+    gem.add_dependency "unidecode", "~> 1.0.0"
+  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
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dm-is-sluggable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/lib/dm-is-sluggable.rb

@@ -0,0 +1,6 @@
+require 'pathname'
+require 'dm-core'
+
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-sluggable' / 'is'/ 'sluggable'
+
+DataMapper::Model.append_extensions DataMapper::Is::Sluggable

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

@@ -0,0 +1,38 @@
+module DataMapper
+  module Is
+    module ClassMethods
+    
+      def slug_property
+        sp = properties[slug_property_name]
+        sp && (sp.type == String ? sp : nil)
+      end
+      
+      def slug_property_name
+        slug_options[:property_name]
+      end
+      
+      def slug_source
+        slug_options[:source]
+      end
+      
+      def slug_permanent?
+        slug_options[:permanent?]
+      end
+      
+      def slug_max_length
+        slug_options[:max_length]
+      end
+            
+      def get slug #_with_slug slug
+        first(slug_property_name => slug)
+      end
+      
+      private
+      
+      def slug_options
+        class_variable_get(:@@dm_is_sluggable_options)
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+require 'unidecode'
+
+module DataMapper
+  module Is
+    module InstanceMethods
+    
+      def slug_property
+        self.class.slug_property
+      end
+      
+      def slug_property_name
+        self.class.slug_property_name
+      end
+      
+      def slug_source
+        self.class.slug_source
+      end
+      
+      def slug_permanent?
+        self.class.slug_permanent?
+      end
+      
+      def slug_max_length
+        self.class.slug_max_length
+      end
+    
+      def slug_value
+        send slug_property_name
+      end
+      alias_method :to_param, :slug_value
+    
+      private
+      
+      def truncate_slug(slug, extra = 0)
+        length = (slug_max_length ? [slug.length, slug_max_length].min : slug.length) - extra
+        slug[0..length - 1]
+      end
+      
+      def sluggify
+        old_slug = slug_value
+        DataMapper.logger.debug ['(dm-is-sluggable) old_slug = ', old_slug].join
+        DataMapper.logger.debug ['(dm-is-sluggable) slugs are permanent?: ', slug_permanent?].join
+        return if slug_permanent? && old_slug
+        new_raw_slug = [slug_source].flatten.map do |ss|
+          send ss.to_sym
+        end.join(' ')
+        attribute_set(slug_property_name, nil) and return unless new_raw_slug
+        base_new_slug = new_raw_slug.to_ascii.downcase.gsub(/\W+/, ' ').strip.gsub(/ +/, '-')
+        if base_new_slug != old_slug
+          exists_opts = {}
+          self.class.key.each do |k|
+            exists_opts[k.name.not] = send(k.name)
+          end unless new?
+          extra = 0
+          new_slug = truncate_slug(base_new_slug)
+          lambda do
+            clash = self.class.first(exists_opts.merge(slug_property_name => new_slug))
+            if clash
+              extra = extra.next
+              new_slug = [truncate_slug(base_new_slug, (extra.to_s.length + 1)), extra].join('-')
+              redo
+            end
+          end.call
+          attribute_set(slug_property_name, new_slug)
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require Pathname(__FILE__).dirname.expand_path / 'class_methods'
+require Pathname(__FILE__).dirname.expand_path / 'instance_methods'
+
+module DataMapper
+  module Is
+    module Sluggable
+      class InvalidSlugError < StandardError; end
+
+      def is_sluggable(source = :to_slug, opts = {})
+        class_variable_set(:@@dm_is_sluggable_options, {})
+      
+        extend ClassMethods
+        include InstanceMethods
+        
+        slug_options[:source] = source
+        
+        property_name = if opts[:property].is_a?(Hash)
+          opts[:property].delete(:name).to_sym
+        else
+          (opts[:property] || :slug).to_sym
+        end
+        property_opts = opts[:property].is_a?(Hash) ? opts[:property] : {}
+        slug_options[:property_name] = property_name
+        property property_name, String, property_opts.merge(:unique_index => true) unless slug_property
+        
+        slug_options[:permanent?] = opts[:permanent?] || false
+        slug_options[:max_length] = opts[:max_length]
+        
+        DataMapper.logger.debug(slug_options.inspect)
+        
+        before :save, :sluggify
+      end
+
+    end
+  end
+end

data/rs3vans-dm-is-sluggable.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rs3vans-dm-is-sluggable}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Evans"]
+  s.date = %q{2010-05-31}
+  s.description = %q{Adds slug support to DataMapper models. Slugs are clean, human-readable identifiers that can be used in-place of a more traditional number-based id.}
+  s.email = %q{rs3vans@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/dm-is-sluggable.rb",
+     "lib/dm-is-sluggable/is/class_methods.rb",
+     "lib/dm-is-sluggable/is/instance_methods.rb",
+     "lib/dm-is-sluggable/is/sluggable.rb",
+     "rs3vans-dm-is-sluggable.gemspec",
+     "test/helper.rb",
+     "test/model_1.rb",
+     "test/model_2.rb",
+     "test/model_3.rb",
+     "test/model_4.rb",
+     "test/model_5.rb",
+     "test/test_dm-is-sluggable.rb"
+  ]
+  s.homepage = %q{http://github.com/rs3vans/dm-is-sluggable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Adds slug support to DataMapper models.}
+  s.test_files = [
+    "test/model_1.rb",
+     "test/model_2.rb",
+     "test/model_3.rb",
+     "test/helper.rb",
+     "test/test_dm-is-sluggable.rb",
+     "test/model_4.rb",
+     "test/model_5.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<dm-core>, [">= 0.10.2"])
+      s.add_runtime_dependency(%q<unidecode>, ["~> 1.0.0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<dm-core>, [">= 0.10.2"])
+      s.add_dependency(%q<unidecode>, ["~> 1.0.0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<dm-core>, [">= 0.10.2"])
+    s.add_dependency(%q<unidecode>, ["~> 1.0.0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+require 'dm-core'
+require 'do_sqlite3'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dm-is-sluggable'
+
+class Test::Unit::TestCase
+end

data/test/model_1.rb

@@ -0,0 +1,8 @@
+class Model1
+  include DataMapper::Resource
+  
+  property :id,   Serial
+  property :name, String
+  
+  is :sluggable, :name
+end

data/test/model_2.rb

@@ -0,0 +1,9 @@
+class Model2
+  include DataMapper::Resource
+  
+  property :id,   Serial
+  property :name, String
+  property :tag,  String
+  
+  is :sluggable, [:name, :tag]
+end

data/test/model_3.rb

@@ -0,0 +1,8 @@
+class Model3
+  include DataMapper::Resource
+  
+  property :id,   Serial
+  property :name, String
+  
+  is :sluggable, :name, :max_length => 9
+end

data/test/model_4.rb

@@ -0,0 +1,8 @@
+class Model4
+  include DataMapper::Resource
+  
+  property :id,   Serial
+  property :name, String
+  
+  is :sluggable, :name, :permanent? => true
+end

data/test/model_5.rb

@@ -0,0 +1,8 @@
+class Model5
+  include DataMapper::Resource
+  
+  property :id,   Serial
+  property :name, String
+  
+  is :sluggable, :name
+end

data/test/test_dm-is-sluggable.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+DataMapper::Logger.new($stdout, :debug)
+DataMapper.setup(:default, 'sqlite3::memory:')
+Dir[File.join(File.dirname(__FILE__), 'model_*.rb')].each {|m| require m}
+DataMapper.auto_migrate!
+
+class TestDmIsSluggable < Test::Unit::TestCase
+  
+  context 'With Model 1' do
+    setup do
+      @m = Model1.create :name => 'Test THIS slugger!'
+    end
+    
+    should 'return true if #slug is correct' do
+      assert 'test-this-slugger' == @m.slug
+    end
+  end
+  
+  context 'With Model 2' do
+    setup do
+      @m = Model2.create :name => 'Test THIS slugger!', :tag => 'SLUG A'
+    end
+    
+    should 'return true if #slug is correct' do
+      assert 'test-this-slugger-slug-a' == @m.slug
+    end
+  end
+  
+  context 'With Model 3' do
+    setup do
+      @m = Model3.create :name => 'Test THIS slugger!'
+    end
+    
+    should 'return true if #slug is correct' do
+      assert 'test-this' == @m.slug
+    end
+  end
+  
+  context 'With Model 4' do
+    setup do
+      @m = Model4.create :name => 'Test THIS slugger!'
+      @m.name = 'Not the same!'
+      @m.save
+    end
+    
+    should 'return true if #slug and #name are correct' do
+      assert 'test-this-slugger' == @m.slug
+      assert 'Not the same!' == @m.name
+    end
+  end
+  
+  context 'With Model 5 (modified get)' do
+    setup do
+      Model5.create :name => 'Test THIS slugger!'
+    end
+    
+    should 'return true if "test-this-slugger" is found using #get' do
+      assert !!Model5.get('test-this-slugger')
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: rs3vans-dm-is-sluggable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
+platform: ruby
+authors: 
+- Ryan Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-31 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 2
+        version: 0.10.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: unidecode
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id003
+description: Adds slug support to DataMapper models. Slugs are clean, human-readable identifiers that can be used in-place of a more traditional number-based id.
+email: rs3vans@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/dm-is-sluggable.rb
+- lib/dm-is-sluggable/is/class_methods.rb
+- lib/dm-is-sluggable/is/instance_methods.rb
+- lib/dm-is-sluggable/is/sluggable.rb
+- rs3vans-dm-is-sluggable.gemspec
+- test/helper.rb
+- test/model_1.rb
+- test/model_2.rb
+- test/model_3.rb
+- test/model_4.rb
+- test/model_5.rb
+- test/test_dm-is-sluggable.rb
+has_rdoc: true
+homepage: http://github.com/rs3vans/dm-is-sluggable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Adds slug support to DataMapper models.
+test_files: 
+- test/model_1.rb
+- test/model_2.rb
+- test/model_3.rb
+- test/helper.rb
+- test/test_dm-is-sluggable.rb
+- test/model_4.rb
+- test/model_5.rb