mongoid-slugs 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-slugs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Evan Sagge
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Mongoid::Slugs
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-slugs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-slugs
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "./spec/**/*_spec.rb"
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = "./spec/**/*_spec.rb"
+  spec.rcov = true
+end

data/lib/mongoid-slugs.rb

@@ -0,0 +1,2 @@
+require "mongoid/slugs"
+require "mongoid/slugs/version"

data/lib/mongoid/slugs.rb

@@ -0,0 +1,64 @@
+module Mongoid::Slugs
+  extend ActiveSupport::Concern
+
+  included do
+    field :slug, type: String
+
+    index({ slug: -1 }, { unique: true })
+
+    before_save :generate_slug
+  end
+
+  module ClassMethods
+    def slug_on(field)
+      @@slug_field ||= {}
+      @@slug_field[self.name] = field.to_sym
+    end
+
+    def slug_field
+      @@slug_field ||= {}
+      @@slug_field[self.name]
+    end
+
+    def find_by_slug(slug)
+      find_by(slug: slug)
+    end
+  end
+
+  def to_param
+    slug
+  end
+
+  protected
+
+  def generate_slug
+    raise Mongoid::Sluggable::Errors::UndefinedField.new(self.class) if self.class.slug_field.blank?
+    raise Mongoid::Sluggable::Errors::UnrecognizedField.new(self.class, self.class.slug_field) unless self.class.fields.has_key?(self.class.slug_field.to_s)
+
+    base_slug = send(self.class.slug_field).parameterize
+
+    pattern = /^#{Regexp.escape(base_slug)}(?:-(\d{1,2}))?$/
+    existing_slugs = self.class.where(slug: pattern).ne(_id: _id).only(:slug).map(&:slug)
+    if existing_slugs.any?
+      max_counter = existing_slugs.map { |s| (pattern.match(s)[1] || 0 ).to_i }.max
+      base_slug << "-#{max_counter + 1}"
+    end
+
+    self.slug = base_slug
+  end
+
+  module Errors
+    class UndefinedField < Mongoid::Errors::MongoidError
+      def initialize(klass)
+        super "Sluggable field needs to be defined on #{klass.name} using :slug_on"
+      end
+    end
+
+    class UnrecognizedField < Mongoid::Errors::MongoidError
+      def initialize(klass, field)
+        super "#{klass.name} needs to have #{field.to_sym} defined as a field to create a slug from it"
+      end
+    end
+  end
+
+end

data/lib/mongoid/slugs/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Slugs
+    VERSION = "0.0.1"
+  end
+end

data/mongoid-slugs.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/slugs/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mongoid-slugs"
+  gem.version       = Mongoid::Slugs::VERSION
+  gem.authors       = ["Evan Sagge"]
+  gem.email         = ["evansagge@gmail.com"]
+  gem.homepage      = %q{http://github.com/evansagge/mongoid-slugs}
+  gem.description   = %q{Simple slugging for Mongoid models}
+  gem.summary       = %q{Simple slugging for Mongoid models}
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rake'
+  gem.add_dependency 'mongoid', '>= 3.0.1'
+  gem.add_dependency 'rspec', '>= 2.9'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
+MODELS = File.join(File.dirname(__FILE__), "models")
+$LOAD_PATH.unshift(MODELS)
+
+require "rubygems"
+require "bundler"
+Bundler.setup
+
+require 'mongoid'
+require 'mongoid/slugs'
+require 'rspec'
+require 'rspec/core'
+require 'rspec/expectations'
+
+Mongoid.configure do |config|
+  config.connect_to("mongoid-slugs-test")
+end
+
+Dir[ File.join(MODELS, "*.rb") ].sort.each { |file| require File.basename(file) }
+
+
+RSpec.configure do |config|
+  config.include RSpec::Matchers
+  config.mock_with :rspec
+  config.after :all do
+    Mongoid::Config.purge!
+  end
+end

data/spec/unit/mongoid/slugs_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Mongoid::Slugs do
+  before do
+    class TestClass
+      include Mongoid::Document
+      include Mongoid::Slugs
+
+      field :title
+    end
+  end
+
+  describe "sluggable model" do
+    it "has a :slug field" do
+      expect(TestClass.fields).to have_key("slug")
+      expect(TestClass.fields["slug"].options[:type]).to eq String
+    end
+
+    describe ".slug_on" do
+      before do
+        TestClass.slug_on :title
+      end
+
+      it "sets the .slug_field" do
+        expect(TestClass.slug_field).to eq :title
+      end
+    end
+  end
+
+  describe "sluggable object" do
+    before do
+      TestClass.slug_on :title
+    end
+
+    let!(:sluggable_object) do
+      TestClass.new(title: "This is a test slug")
+    end
+
+    describe "#save" do
+      before do
+        sluggable_object.save
+      end
+
+      it "sets the slug" do
+        expect(sluggable_object.slug).to eq "this-is-a-test-slug"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-slugs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Evan Sagge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: Simple slugging for Mongoid models
+email:
+- evansagge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid-slugs.rb
+- lib/mongoid/slugs.rb
+- lib/mongoid/slugs/version.rb
+- mongoid-slugs.gemspec
+- spec/spec_helper.rb
+- spec/unit/mongoid/slugs_spec.rb
+homepage: http://github.com/evansagge/mongoid-slugs
+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.23
+signing_key: 
+specification_version: 3
+summary: Simple slugging for Mongoid models
+test_files:
+- spec/spec_helper.rb
+- spec/unit/mongoid/slugs_spec.rb
+has_rdoc: