mongoid-urls 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b71d8482958f190295f9a8a0d52ca7cfdf8ef63c
+  data.tar.gz: 22b5ffff3481e0488d74b6b7f4743d7f6bb4fc80
+SHA512:
+  metadata.gz: b263576272e13a2c1971355de8c28f5475d8a18aeef4e9a183c3d964a25e4ea43125b36d641b3ea5112eacec5bc088c2a0bb2f090d3c00a7aae171bf412ef9c3
+  data.tar.gz: fa31fde6011957d031e9b82cc9a3db6495c719c4c701f85c5b224a23e63710e6dd1f1cd56d92921f80a0b05d1b2532fc0ca75d6874fb6f50f1d70765019cec99

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--tty
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.1.1
+  - 2.2.2
+  - ruby-head
+  - jruby-19mode
+  - rbx-2
+
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+
+gemfile:
+  - Gemfile
+
+services:
+  - mongodb
+
+env: CI="travis"
+
+script: "bundle exec rspec"

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'rspec', '>= 3.2.0'
+  gem 'codeclimate-test-reporter', require: nil
+  gem 'mongoid-rspec', git: 'https://github.com/nofxx/mongoid-rspec'
+end

data/Guardfile

@@ -0,0 +1,22 @@
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+
+# guard :rubocop do
+guard :rubocop, all_on_start: false, keep_failed: false, cli: ['-D'] do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(/^generators\/(.+)\.rb$/) { |_m| 'spec/schemaless/worker_spec' }
+
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/MIT-LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Marcos Piccinini
+
+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,77 @@
+Mongoid::Urls
+=============
+
+[![Gem Version](https://badge.fury.io/rb/mongoid-urls.png)](http://badge.fury.io/rb/mongoid-urls)
+[![Dependency Status](https://gemnasium.com/nofxx/mongoid-urls.svg)](https://gemnasium.com/nofxx/mongoid-urls)
+[![Build Status](https://secure.travis-ci.org/nofxx/mongoid-urls.png)](http://travis-ci.org/nofxx/mongoid-urls)
+[![Code Climate](https://codeclimate.com/github/nofxx/mongoid-urls.png)](https://codeclimate.com/github/nofxx/mongoid-urls)
+[![Coverage Status](https://coveralls.io/repos/nofxx/mongoid-urls/badge.svg)](https://coveralls.io/r/nofxx/mongoid-urls)
+
+## Mongoid::Urls
+
+Simple slugs for mongoid models!
+
+
+## Short snappy token ids for Mongoid documents
+
+This library is a quick and simple way to generate slugs
+for your mongoid documents.
+
+Mongoid::Urls can help turn this:
+
+    http://bestappever.com/video/4dcfbb3c6a4f1d4c4a000012
+
+Into something more like this:
+
+    http://bestappever.com/video/kittens-playing-with-puppies
+
+
+## Getting started
+
+In your gemfile, add:
+
+    gem 'mongoid-urls'
+
+In your Mongoid documents, just add `include Mongoid::Urls` and the
+`url` method will take care of all the setup, like so:
+
+```ruby
+class Article
+  include Mongoid::Document
+  include Mongoid::Urls
+
+  field :title
+
+  url :title
+end
+
+```
+
+And that's it! There's some configuration options too - which are all
+listed [below](#configuration).
+
+
+## Finders
+
+`Mongoid::Urls` will **never** override `find`.
+There's some helpers for custom fields:
+
+```ruby
+Video.find_by_url("the-nice-url")
+Account.find_by_url("acc-123456")
+```
+
+
+## Configuration
+
+You may choose between two different systems for how your urls are stored:
+
+Default #urls
+
+Simple #url
+
+
+#### Reserved
+
+
+# Notes

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/benchmarks/benchmark.rb

@@ -0,0 +1,3 @@
+$: << File.expand_path("../../lib", __FILE__)
+
+# Maybe benchmark stringex vs babosa just for fun...

data/lib/mongoid/urls/version.rb

@@ -0,0 +1,6 @@
+module Mongoid
+  # Mongoid::Urls::VERSION
+  module Urls
+    VERSION = '0.0.3'
+  end
+end

data/lib/mongoid/urls.rb

@@ -0,0 +1,82 @@
+require 'mongoid'
+require 'babosa'
+
+module Mongoid
+  # Creates friendly urls for mongoid models!
+  module Urls
+    extend ActiveSupport::Concern
+    included do
+      cattr_accessor :reserved_words,
+                     :url_simple,
+                     :url_scope,
+                     :url_key
+    end
+
+    # Methods avaiable at the model
+    module ClassMethods
+      #
+      # The #url
+      #
+      #  url :title
+      #
+      #  :simple    ->   Only one url per instance
+      #  :reserve   ->   Defaults to %w( new edit )
+      #
+      def url(*args)
+        options = args.extract_options!
+        self.url_key = args.first.to_s
+        self.url_simple = options[:simple]
+        self.reserved_words = options[:reserve] || Set.new(%w(new edit))
+        create_url_fields
+        before_validation :create_urls
+      end
+
+      def find_by_url(u)
+        url_simple ? find_by(url: u) : find_by(urls: u)
+      rescue Mongoid::Errors::DocumentNotFound
+        nil
+      end
+
+      private
+
+      def create_url_fields
+        if url_simple
+          field :url, type: String
+          index({ url: 1 }, unique: true)
+        else
+          field :urls, type: Array, default: []
+          index(urls: 1)
+        end
+      end
+    end # ClassMethods
+
+    def to_param
+      urls.last
+    end
+
+    def slug
+      self[url_key].to_slug.normalize.to_s
+    end
+
+    protected
+
+    def validate_urls(u)
+      if self.class.find_by_url(u)
+        errors.add(:title, :uniqueness)
+      elsif reserved_words.include?(u)
+        errors.add(:title, :reserved)
+      else
+        true
+      end
+    end
+
+    def create_urls
+      return unless changes.include?(url_key)
+      validate_urls(new_url = slug)
+
+      return self.url = new_url if url_simple
+      urls << new_url
+      urls.uniq!
+    end
+  end # Urls
+end # Mongoid

data/mongoid-urls.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'mongoid/urls/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'mongoid-urls'
+  s.version     = Mongoid::Urls::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Marcos Piccinini']
+  s.homepage    = 'http://github.com/nofxx/mongoid-urls'
+  s.licenses    = ['MIT']
+  s.summary     = 'A url sanitizer (slugs) for Mongoid documents.'
+  s.description = 'Mongoid Urls creates unique sanitized URLs for Mongoid documents. Simple and great for making URLs look good.'
+
+  s.rubyforge_project = 'mongoid-urls'
+  s.add_dependency 'mongoid', '> 4.0.0'
+  s.add_dependency 'babosa', '> 1.0.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/mongoid/urls_spec.rb

@@ -0,0 +1,193 @@
+require 'spec_helper'
+
+describe Mongoid::Urls do
+  let(:document_class) do
+    Object.send(:remove_const, :Document) if Object.const_defined?(:Document)
+    # A sample model
+    class Document
+      include Mongoid::Document
+      include Mongoid::Urls
+      field :title
+    end
+    Class.new(Document)
+  end
+
+  let(:document) do
+    document_class.create(title: "I'm a Document!")
+  end
+
+  let(:article) do
+    Article.new(title: "I'm an Article!")
+  end
+
+  describe '#slug' do
+    before(:each) { document_class.send(:url, :title) }
+    it 'should slugize a few stuff' do
+      expect(document.slug).to eq('im-a-document')
+    end
+
+    it 'should update slug' do
+      document.title = 'I "quoted"'
+      expect(document.slug).to eq('i-quoted')
+    end
+
+    it 'should keep old slugs' do
+      article.save
+      article.title = "Hello Ruby!"
+      article.save
+      expect(article.urls).to eq ["im-an-article", "hello-ruby"]
+    end
+  end
+
+  describe '#url' do
+    describe 'default "_id"' do
+      before(:each) { document_class.send(:url, :title) }
+
+      it 'should be created' do
+        expect(document).to have_field(:urls)
+      end
+
+      it 'should be valid' do
+        expect(document).to be_valid
+      end
+
+      it 'should be persisted' do
+        document.save
+        # why the anonymous #document_class doesn't work?
+        expect(Document.count).to eq(1)
+      end
+
+      it 'should create secondary index' do
+        expect(document.index_specifications).to_not be_empty
+      end
+    end
+
+    describe 'options' do
+      it 'should accept custom field names' do
+        document_class.send(:url, :sweet)
+        expect(document).to have_field(:urls)
+      end
+
+      it 'should not create custom finders with default id' do
+        # A sample model
+        class UntaintedDocument
+          include Mongoid::Document
+          include Mongoid::Urls
+          field :name
+        end
+        dc = Class.new(UntaintedDocument)
+
+        dc.send(:url, :name)
+        expect(dc.public_methods).to include(:find_by_url)
+      end
+
+      it 'should change `to_param`' do
+        document_class.send(:url,  :title)
+        expect(document.to_param).to eq document.urls.first
+      end
+    end
+  end
+
+  describe 'callbacks' do
+    context 'when the article is a new record' do
+      it 'should create the urls after being saved' do
+        expect(article.urls).to be_empty
+      end
+
+      it 'should create the urls after being saved' do
+        article.save
+        expect(article.urls).to eq ['im-an-article']
+      end
+    end
+
+    context 'when the article is not a new record' do
+      it 'should not change the title after being saved' do
+        title_before = article.title
+        article.save
+        expect(article.title).to eq title_before
+      end
+
+      it 'should create a new title after being saved' do
+        article.title = 'Fresh new tomato'
+        article.save
+        expect(article.urls).to include 'fresh-new-tomato'
+      end
+
+      context 'when the article is initialized with a title' do
+        it 'should not change the title after being saved' do
+          title = 'test title'
+          expect(Article.create!(title: title).title).to eq title
+        end
+      end
+    end
+
+    context 'when the article is cloned' do
+      it 'should set the title to nil' do
+        d2 = article.clone
+        expect(d2.urls).to be_empty
+      end
+    end
+  end
+
+  describe 'finders' do
+    it 'should create a custom find method' do
+      document_class.send(:url, :title)
+      expect(document.class.public_methods).to include(:find_by_url)
+    end
+
+    it 'should find something with the custom find method' do
+      article.save
+      from_db = Article.find_by_url(article.urls.first)
+      expect(from_db.id).to eq(article.id)
+    end
+  end
+
+  describe '.to_param' do
+    it 'should respond with last valid url' do
+      document_class.send(:url, :title)
+      expect(document.to_param).to eq 'im-a-document'
+    end
+  end
+
+  describe '(no) collision resolution' do
+    before(:each) do
+      document_class.send(:url, :title)
+      document_class.create_indexes
+    end
+
+    context 'when creating a new record' do
+      it 'should raise when collisions can\'t be resolved on save' do
+        article.save
+        d2 = article.clone
+        expect(d2).to_not be_valid
+        expect(d2.save).to be_falsey
+        expect(d2.errors.messages).to include(:title)
+      end
+
+      it 'should raise when collisions can\'t be resolved on create!' do
+        article.title = '1234'
+        article.save
+        dup = Article.create(title: '1234')
+        expect(dup.errors.messages).to_not be_empty
+      end
+    end
+
+    context 'with other unique indexes present' do
+      before(:each) do
+        document_class.send(:field, :name)
+        document_class.send(:url, :name)
+        document_class.send(:index, { name: 1 }, unique: true)
+        document_class.create_indexes
+      end
+
+      context 'when violating the other index' do
+        it 'should raise an operation failure' do
+          duplicate_name = 'Got Duped.'
+          document_class.create!(name: duplicate_name)
+          expect { document_class.create!(name: duplicate_name) }
+            .to raise_exception(Mongo::Error::OperationFailure)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+# require 'codeclimate-test-reporter'
+# CodeClimate::TestReporter.start
+
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+
+# require 'pry'
+# require 'database_cleaner'
+require 'mongoid'
+require 'mongoid-rspec'
+
+require 'mongoid/urls'
+
+ENV['MONGOID_ENV'] = 'test'
+
+Mongoid.configure do |config|
+  config.load_configuration(
+    clients: {
+      default: {
+        database: 'mongoid_urls_test',
+        hosts: ["localhost: #{ENV['BOXEN_MONGODB_PORT'] || 27_017}"],
+        options: {}
+      }
+    })
+end
+
+require 'support/models'
+
+Mongo::Logger.logger.level = Logger::INFO
+
+RSpec.configure do |config|
+  config.include Mongoid::Matchers
+
+  config.before(:each) do
+    Mongoid.purge!
+  end
+
+  config.after(:suite) do
+    puts "\n# With Mongoid v#{Mongoid::VERSION}"
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,6 @@
+class Article
+  include Mongoid::Document
+  include Mongoid::Urls
+  field :title
+  url :title
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-urls
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Marcos Piccinini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: babosa
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Mongoid Urls creates unique sanitized URLs for Mongoid documents. Simple
+  and great for making URLs look good.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- benchmarks/benchmark.rb
+- lib/mongoid/urls.rb
+- lib/mongoid/urls/version.rb
+- mongoid-urls.gemspec
+- spec/mongoid/urls_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+homepage: http://github.com/nofxx/mongoid-urls
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mongoid-urls
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: A url sanitizer (slugs) for Mongoid documents.
+test_files:
+- spec/mongoid/urls_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb