mm-sluggable 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Richard Livsey
+
+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::Sluggable
+
+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.append_inclusions(MongoMapper::Plugins::Sluggable)
+
+  # add to a specific model
+  plugin MongoMapper::Plugins::Sluggable
+
+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)
+* :index - whether to add an index for the slug (default - true)
+* :method - what method to call on the field to sluggify it (default - :parameterize)
+* :callback - when to trigger the slugging (default - :before_validation_on_create)
+
+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 "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,75 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+require "spec"
+require "spec/rake/spectask"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = %w(--format specdoc --colour)
+  t.libs = ["spec"]
+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-sluggable"
+  s.version           = "0.1.0"
+  s.summary           = "Tiny plugin for MongoMapper to cache a slugged version of a field"
+  s.author            = "Richard Livsey"
+  s.email             = "richard@livsey.org"
+  s.homepage          = "http://github.com/rlivsey/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")
+
+  # 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
+Rake::GemPackageTask.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
+
+task :package => :gemspec
+
+# Generate documentation
+Rake::RDocTask.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,57 @@
+require 'mongo_mapper'
+
+module MongoMapper
+  module Plugins
+    module Sluggable
+      def self.included(model)
+        model.plugin self
+      end
+
+      module ClassMethods
+        def sluggable(to_slug = :title, options = {})
+          @slug_options = {
+            :to_slug      => to_slug,
+            :key          => :slug,
+            :index        => true,
+            :method       => :parameterize,
+            :scope        => nil,
+            :callback     => :before_validation_on_create
+          }.merge(options)
+
+          key @slug_options[:key], String, :index => @slug_options[:index]
+
+          self.send(@slug_options[:callback], :set_slug)
+        end
+
+        class_eval do
+          attr_reader :slug_options
+        end
+      end
+
+      module InstanceMethods
+        def set_slug
+          options = self.class.slug_options
+          return unless self.send(options[:key]).blank?
+
+          to_slug = self[options[:to_slug]]
+          return if to_slug.blank?
+
+          the_slug = raw_slug = to_slug.send(options[:method]).to_s
+
+          conds = {}
+          conds[options[:key]]   = the_slug
+          conds[options[:scope]] = self.send(options[:scope]) if options[:scope]
+
+          # todo - remove the loop and use regex instead so we can do it in one query
+          i = 0
+          while self.class.first(conds)
+            i += 1
+            conds[options[:key]] = the_slug = "#{raw_slug}-#{i}"
+          end
+
+          self.send(:"#{options[:key]}=", the_slug)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: mm-sluggable
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Richard Livsey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-14 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: 
+email: richard@livsey.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- LICENSE
+- Rakefile
+- README.rdoc
+- lib/mm-sluggable.rb
+has_rdoc: true
+homepage: http://github.com/rlivsey/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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Tiny plugin for MongoMapper to cache a slugged version of a field
+test_files: []
+