leifcr-mm-sluggable 0.2.5

data/Gemfile

@@ -0,0 +1,19 @@
+source :rubygems
+gem 'rake'
+gem 'bson_ext', '>= 1.6.4'
+gem 'multi_json', '>= 1.3.6'
+
+group :test do
+  # gem 'jnunemaker-matchy', '>= 0.4', :require => 'matchy'
+  # gem 'shoulda',           '>= 3.1.1'
+  # gem 'mocha',             '>= 0.12.3'
+  gem 'rspec'
+  gem 'database_cleaner',  '>= 0.8.0'
+end
+
+group :development do
+  gem "wirble"
+  gem "hirb"
+  gem "awesome_print"  
+end
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Richard Livsey
+Copyright (c) 2012 Leif Ringstad
+
+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,75 @@
+= MongoMapper::Plugins::Sluggable
+
+Add slugs to your fields. And use it for URLS...
+
+== Usage
+
+Either load it into all models, or individual models:
+
+Add to all models
+  #initializers/mongo.rb
+  MongoMapper::Document.plugin(MongoMapper::Plugins::Sluggable)
+
+Add to a specific model
+  #app/models/my_model.rb
+  plugin MongoMapper::Plugins::Sluggable
+
+Then call sluggable to configure it
+  sluggable :title, :scope => :account_id
+
+NOTE: The slugs will always be updated if you change the field it creates 
+the slugs from. see options to change behaviour
+
+Free slugs will be reused
+Example: you have my-title-1 and my-title-3 creating a new slug will generate my-title-2
+
+  Why always change slugs? Feels better to have same slug as title...
+
+== Improve performance on your models
+
+This is important to get fast queries! (you will regret if you don't add it...)
+
+Read up on indexes here:
+https://github.com/jnunemaker/mongomapper/issues/337
+
+Easiest is to add db/indexes.rb to your app, then add this to that file:
+  # db/indexes.rb
+  MyModel.ensure_index(:slug_key)
+  
+== Options
+
+Available options are:
+
+* :scope - scope to a specific field (default - nil)
+* :key - what the slug key is called (default - :slug) - NOTE, don't change this one
+* :method - what method to call on the field to sluggify it (default - :parameterize)
+* :callback - when to trigger the slugging (default - :before_validation_on_create)
+* :always_update - Always update the slug on update/save/create etc.
+
+Eg.
+
+  sluggable :title, :scope => :account_id, :key => :title_slug, :method => :to_url, :index => false
+  
+This will slug the title to the title_slug key, scoped to the account, will use String#to_url to slug it and won't add an index to the key
+
+== Versioning
+
+If an item with the same slug exists, it will add a version number to the slug.
+
+IE assuming we already have an item with the slug of "monkey", the slug will be generated as "monkey-1"
+
+== Note on Patches/Pull Requests
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it.
+
+== Install
+Bundler: (You are most likely using bundler in your app...)
+  gem 'mm-sluggable', :git => 'http://github.com/luuf/mm-sluggable.git'
+
+== Thanks
+* Richard Livsey for creating the original mm-sluggable
+* John Nunemaker, Brandon Keepers & Others for MongoMapper
+
+== Copyright
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+require File.join(File.dirname(__FILE__), '/lib/sluggable/version')
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+gemspec = eval(File.read("mm-sluggable.gemspec"))

data/lib/mm-sluggable.rb

@@ -0,0 +1,83 @@
+require 'mongo_mapper'
+
+module MongoMapper
+  module Plugins
+    module Sluggable
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def sluggable(to_slug = :title, options = {})
+          class_attribute :slug_options
+
+          self.slug_options = {
+            :to_slug      => to_slug,
+            :key          => :slug,
+            :method       => :parameterize,
+            :scope        => nil,
+            :max_length   => 256,
+            :always_update => true, # allow always updating slug...
+            :callback      => :before_validation,
+            :callback_on   => nil,            
+          }.merge(options)
+          key slug_options[:key], String
+
+          #before_validation :set_slug
+          self.send(slug_options[:callback], :set_slug, {:on => slug_options[:callback_on]}) if slug_options[:callback] && slug_options[:callback_on]
+          self.send(slug_options[:callback], :set_slug) if slug_options[:callback] && slug_options[:callback_on].nil?          
+        end
+      end
+
+      def set_slug
+        options = self.class.slug_options
+        
+        if options[:always_update] == false
+          return unless self.send(options[:key]).blank? 
+        end
+
+        to_slug = self[options[:to_slug]]
+        return if to_slug.blank?
+
+        # previous_slug = self[:key]
+
+        the_slug = raw_slug = to_slug.send(options[:method]).to_s[0...options[:max_length]]
+
+        # no need to set, so return
+        return if (self.send(options[:key]) == the_slug)
+        # also do a regexp check,
+        # verify if the previous slug is "almost" the same as we want without digits/extras
+        return if (/(#{the_slug}-\d+)/.match(self.send(options[:key])) != nil)
+
+        conds = {}
+        conds[options[:key]]   = the_slug
+        conds[options[:scope]] = self.send(options[:scope]) if options[:scope]
+
+        # first see if there is a equal slug
+        used_slugs = self.class.where(conds)
+        if (used_slugs.count > 0)
+          last_digit = 0 # zero for last one...
+          # if we are updating, check if the current slug is same as the one we want
+          conds[options[:key]] = /(#{the_slug}-\d+)/
+          used_slugs = self.class.where(conds).sort(options[:key].asc)
+          new_slug_set = false
+          used_slugs.each do |used_slug|
+            # get the last digit through regex
+            next_digit = used_slug.send(options[:key])[/(\d+)$/]
+            if (!next_digit.nil?)
+              # catch any numbers that are in between and free
+              if ((next_digit.to_i - last_digit.to_i) > 1)
+                the_slug = "#{raw_slug}-#{last_digit+1}"
+                new_slug_set = true
+                break # set a new slug, so all is good
+              end
+              last_digit = next_digit.to_i
+              # puts last_digit.inspect
+            end
+          end
+          the_slug = "#{raw_slug}-#{last_digit+1}" if new_slug_set == false
+        end
+
+        self.send(:"#{options[:key]}=", the_slug)
+      end
+    end
+  end
+end

data/lib/sluggable/version.rb

@@ -0,0 +1,3 @@
+module Sluggable
+  VERSION = '0.2.5'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: leifcr-mm-sluggable
+version: !ruby/object:Gem::Version
+  version: 0.2.5
+  prerelease: 
+platform: ruby
+authors:
+- Leif Ringstad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- leifcr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mm-sluggable.rb
+- lib/sluggable/version.rb
+- Gemfile
+- Rakefile
+- LICENSE
+- README.rdoc
+homepage: http://github.com/leifcr/mm-sluggable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: MongoMapper Plugin to store a slugged version of of a field.
+test_files: []