mm-learnup-sluggable 0.3.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Richard Livsey, Scott Taylor / Learnup Inc.
+
+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,55 @@
+= MongoMapper::Plugins::LearnupSluggable
+
+Tiny plugin for MongoMapper to cache a slugged version of a field
+
+== Usage
+
+Either load it into all models, or individual models:
+
+  # add to all models
+  MongoMapper::Document.plugin(MongoMapper::Plugins::LearnupSluggable)
+
+  # add to a specific model
+  plugin MongoMapper::Plugins::LearnupSluggable
+
+Then call sluggable to configure it
+
+  sluggable :title, :scope => :account_id
+
+== Options
+
+Available options are:
+
+* :scope - scope to a specific field (default - nil)
+* :key - what the slug key is called (default - :slug)
+* :method - what method to call on the field to sluggify it (default - :parameterize)
+* :callback - when to trigger the slugging (default - :before_validation_on_create)
+* :start - what number to start the version numbers (default - 2)
+
+Eg.
+
+  sluggable :title, :scope => :account_id, :key => :title_slug, :method => :to_url, :start => 42
+
+This will slug the title to the title_slug key, scoped to the account, will use String#to_url to slug it and start the versions at 42
+
+== 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 "dave", the slug will be generated as "dave-1"
+
+== 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 in another branch so I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Install
+
+ $ gem install mm-sluggable
+
+== Copyright
+
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,80 @@
+require "rubygems"
+require "rubygems/package_task"
+require "rdoc/task"
+
+require "rspec"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(--format documentation --colour)
+end
+
+task :default => ["spec"]
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "mm-learnup-sluggable"
+  s.version           = "0.3.1"
+  s.summary           = "MongoMapper plugin to cache a slugged version of a field.  Originally forked from mm-sluggable."
+  s.author            = "Scott Taylor"
+  s.email             = "scott@railsnewbie.com"
+  s.homepage          = "http://github.com/GoLearnup/mm-sluggable"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README.rdoc)
+  s.rdoc_options      = %w(--main README.rdoc)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(LICENSE Rakefile README.rdoc) + Dir.glob("{spec,lib/**/*}")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("some_other_gem", "~> 0.1.0")
+
+  s.add_dependency("mongo_mapper", ">= 0.9.0")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("rspec")
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more
+# about that here: http://gemcutter.org/pages/gem_docs
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Build the gemspec file #{spec.name}.gemspec"
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# If you don't want to generate the .gemspec file, just remove this line. Reasons
+# why you might want to generate a gemspec:
+#  - using bundler with a git source
+#  - building the gem without rake (i.e. gem build blah.gemspec)
+#  - maybe others?
+task :package => :gemspec
+
+# Generate documentation
+RDoc::Task.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/lib/mm-sluggable.rb

@@ -0,0 +1,154 @@
+require 'mongo_mapper'
+
+module MongoMapper
+  module Plugins
+    module LearnupSluggable
+      extend ActiveSupport::Concern
+
+      class OldSlugException < StandardError
+        attr_accessor :object
+        attr_accessor :new_slug
+        attr_accessor :old_slug
+      end
+
+      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,
+            :start        => 2,
+            :callback     => :before_validation
+          }.merge(options)
+
+          key slug_options[:key], String
+          key :old_slugs, Array, :default => []
+
+          return_value = slug_options[:callback].is_a?(Array) ?
+            self.send(slug_options[:callback][0], :set_slug, slug_options[:callback][1]) :
+            self.send(slug_options[:callback], :set_slug)
+
+          slug_key = self.slug_options[:key]
+
+          define_method :to_param do
+            self.send(slug_key).blank? ? self.id.to_s : self.send(slug_key)
+          end
+
+          # TODO: Should these be included?  They break specs...
+          # define_method :"#{slug_key}=" do |value|
+          #   v = value.respond_to?(:downcase) ? value.downcase : value
+          #   super(v)
+          # end
+          #
+          # define_method :"#{slug_key}" do
+          #   value = super()
+          #   value.respond_to?(:downcase) ? value.downcase : value
+          # end
+          #
+          # # Silly, custom attribute readers aren't used by form_helpers
+          # # Instead, they use "value_before_type_cast", and we can override
+          # # the behavior with the following method.
+          # # See http://apidock.com/rails/ActionView/Helpers/InstanceTagMethods/ClassMethods/value_before_type_cast
+          # define_method :"#{slug_key}_before_type_cast" do
+          #   value = super()
+          #   value.respond_to?(:downcase) ? value.downcase : value
+          # end
+
+          metaclass = class << self; self; end
+          metaclass.class_eval do
+            define_method :find_by_slug do |slug|
+              if obj = where(slug_key => slug).first
+                obj
+              elsif obj = where(:old_slugs => slug).first
+                raise old_slug_exception(slug, obj)
+              elsif obj = where(slug_key => /^#{Regexp.escape(slug)}$/i).first
+                raise old_slug_exception(slug, obj)
+              else
+                nil
+              end
+            end
+          end
+
+          before_update do
+            if self.send("#{slug_key}_changed?")
+              self.old_slugs = self.old_slugs.reject { |slug| slug == self.send(slug_key) }
+              self.old_slugs << self.send("#{slug_key}_was")
+            end
+
+            true
+          end
+
+          return_value
+        end
+      end
+
+      def set_slug
+        klass = self.class
+        while klass.respond_to?(:single_collection_parent)
+          superclass = klass.single_collection_parent
+          if superclass && superclass.respond_to?(:slug_options)
+            klass = superclass
+          else
+            break
+          end
+        end
+
+        options = klass.slug_options
+
+        to_slug = self[options[:to_slug]]
+        return if to_slug.blank?
+
+        the_slug = raw_slug = to_slug.send(options[:method]).to_s[0...options[:max_length]]
+
+        conds = {}
+        conds[options[:key]]   = the_slug
+        conds[options[:scope]] = self.send(options[:scope]) if options[:scope]
+        conds['_id'] = {
+          '$ne' => self.id
+        }
+
+        # todo - remove the loop and use regex instead so we can do it in one query
+        i = options[:start]
+
+        while klass.first(conds)
+          conds[options[:key]] = the_slug = "#{raw_slug}-#{i}"
+          i += 1
+        end
+
+        self.send(:"#{options[:key]}=", the_slug)
+      end
+    end
+
+    def old_slug_exception(slug, obj)
+      error = MongoMapper::Plugins::LearnupSluggable::OldSlugException.new
+      error.old_slug = slug
+      error.new_slug = obj.slug
+      error.object = obj
+      error
+    end
+
+    def find_by_slug!(slug)
+      if obj = find_by_slug(slug)
+        obj
+      else
+        raise MongoMapper::DocumentNotFound, "Couldn't find #{self} with slug: #{slug}"
+      end
+    end
+
+    def find_by_slug_or_id(slug_or_id)
+      self.find_by_slug(slug_or_id) || self.find_by_id(slug_or_id)
+    end
+
+    def find_by_slug_or_id!(slug_or_id)
+      if obj = find_by_slug_or_id(slug_or_id)
+        obj
+      else
+        raise MongoMapper::DocumentNotFound, "Couldn't find #{self} with slug or id: #{slug_or_id}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: mm-learnup-sluggable
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+  prerelease: 
+platform: ruby
+authors:
+- Scott Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-10 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.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.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: scott@railsnewbie.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- LICENSE
+- Rakefile
+- README.rdoc
+- lib/mm-sluggable.rb
+homepage: http://github.com/GoLearnup/mm-sluggable
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2694983074753819281
+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 cache a slugged version of a field.  Originally forked
+  from mm-sluggable.
+test_files: []