mongoid-urls 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5712fe3113cb418853a86467166a467ef85e918
-  data.tar.gz: 87fd69af5d300bcaa822616e88f64f5f3f4d97af
+  metadata.gz: 025093f44d0ac503c479d29b060fbdc6b02bce2d
+  data.tar.gz: 047fde3fdbb3ce920d3ecfb0fc10edf7014d25c9
 SHA512:
-  metadata.gz: 9a7a34585091f75f746e903fde578f8a23ac97eed52678239b617613c0de1dc5e1042b467a2f62e64cf84b73d8cc7ff78e33d8a544bcbee431026aaad919f075
-  data.tar.gz: 5a26ba691150d4587738a363f6cb7bfc67f2053218776f43181dd10f15ad6925ecad8c13bf89219fb48d1ced3265c0cce8d7b6af9fc4c9611774a9d2a43169b9
+  metadata.gz: 516d37fffdfc84b839498510a5160532aaf34697718cc095f29362ef895b0378d69163b42a9c02830aaac466ed70728455471fbcf988426ec3458ddd26dfd1ed
+  data.tar.gz: aca47cb090d946b6436f18abec6bb9947e3a94f576a7045273e2d06bab2ea39171eb536b54989df0f3e84edbe4cf01abece67038657bb93beefd95cab32789b7

data/.travis.yml

@@ -24,3 +24,5 @@ services:
 env: CI="travis"
 
 script: "bundle exec rspec"
+
+sudo: false

data/Gemfile

@@ -1,5 +1,7 @@
 source 'http://rubygems.org'
 
+gem 'mongoid', '>=5.0.0.beta'
+
 gemspec
 
 group :test do

data/Guardfile

@@ -9,14 +9,14 @@
 
 # guard :rubocop do
 guard :rubocop, all_on_start: false, keep_failed: false, cli: ['-D'] do
-  watch(%r{.+\.rb$})
+  watch(/.+\.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(%r{^generators/(.+)\.rb$}) { |_m| 'spec/schemaless/worker_spec' }
 
   watch('spec/spec_helper.rb')  { 'spec' }
 end

data/README.md

@@ -1,21 +1,23 @@
 Mongoid::Urls
 =============
 
-[![Gem Version](https://badge.fury.io/rb/mongoid-urls.png)](http://badge.fury.io/rb/mongoid-urls)
+[![Gem Version](https://badge.fury.io/rb/mongoid-urls.svg)](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)
+[![Build Status](https://secure.travis-ci.org/nofxx/mongoid-urls.svg)](http://travis-ci.org/nofxx/mongoid-urls)
+[![Code Climate](https://codeclimate.com/github/nofxx/mongoid-urls.svg)](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!
+Set the fields you want to try to make an URL out of,
+when impossible, use your logic or set the url directly.
 
 
 ## Nice URLs for Mongoid Documents
 
-This library is a quick and simple way to generate slugs
-for your mongoid documents.
+This library is a quick and simple way to generate URLs (slugs)
+for your Mongoid documents.
 
 Mongoid::Urls can help turn this:
 
@@ -36,13 +38,15 @@ In your Mongoid documents, just add `include Mongoid::Urls`
 and use the `url` method to setup, like so:
 
 ```ruby
-class Video
+class Company
   include Mongoid::Document
   include Mongoid::Urls
 
-  field :title
+  field :nickname
+  field :fullname
+  ...
 
-  url :title
+  url :nickname, :fullname, ...
 end
 
 ```

data/benchmarks/benchmark.rb

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

data/lib/mongoid/urls/version.rb

@@ -1,6 +1,6 @@
 module Mongoid
   # Mongoid::Urls::VERSION
   module Urls
-    VERSION = '0.0.7'
+    VERSION = '0.0.9'
   end
 end

data/lib/mongoid/urls.rb

@@ -8,8 +8,8 @@ module Mongoid
     included do
       cattr_accessor :reserved_words,
                      :url_simple,
-                     :url_scope,
-                     :url_key
+                     # :url_scope,
+                     :url_keys
     end
 
     # Methods avaiable at the model
@@ -20,16 +20,24 @@ module Mongoid
       #  url :title
       #
       #  :simple    ->   Only one url per instance
-      #  :reserve   ->   Defaults to %w( new edit )
+      #  :reserve   ->   Defaults to %w( new edit ) + I18n.locales
       #
       def url(*args)
         options = args.extract_options!
-        fail 'One #url per model!' if url_key
-        self.url_key = args.first.to_s
+        fail 'One #url per model!' if url_keys
+        self.url_keys = args # .first.to_s
         self.url_simple = options[:simple]
-        self.reserved_words = options[:reserve] || Set.new(%w(new edit))
         create_url_fields
+        create_url_validations(options)
+      end
+
+      def create_url_validations(options)
         before_validation :create_urls
+        reserve = Set.new(%w(new edit)) + (options[:reserved] || [])
+        reserve << I18n.available_locales if Object.const_defined?('I18n')
+        self.reserved_words = reserve.flatten
+        validates :url, uniqueness: true, presence: true,
+                        format: { with: /[a-z\d-]+/ }
       end
 
       def find_url(u)
@@ -44,6 +52,9 @@ module Mongoid
       def create_url_fields
         field :url, type: String
         index({ url: 1 }, unique: true)
+        define_method('url=') do |val|
+          self[:url] = val.to_slug.normalize.to_s
+        end
         return if url_simple
         field :urls, type: Array, default: []
         index(urls: 1)
@@ -55,28 +66,30 @@ module Mongoid
     end
 
     def new_url
-      self[url_key].to_slug.normalize.to_s
+      url_keys.each do |key|
+        val = send(key)
+        next if val.blank?
+        url = val.to_slug.normalize.to_s
+        next if self.class.find_url(url)
+        return url
+      end
+      nil
     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
+    def validate_url(slug)
+      return unless reserved_words.include?(slug)
+      errors.add(:url, :reserved)
     end
 
     def create_urls
-      return unless changes.include?(url_key)
-      validate_urls(new_url)
+      return unless (slug = new_url)
+      validate_url(slug)
 
-      self.url = new_url
+      self.url = slug
       return if url_simple
-      urls << new_url
+      urls << slug
       urls.uniq!
     end
   end # Urls

data/mongoid-urls.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'mongoid/urls/version'
 
 Gem::Specification.new do |s|
@@ -18,6 +18,5 @@ Gem::Specification.new do |s|
 
   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

@@ -8,12 +8,13 @@ describe Mongoid::Urls do
       include Mongoid::Document
       include Mongoid::Urls
       field :title
+      field :doc
     end
     Class.new(Document)
   end
 
   let(:document) do
-    document_class.create(title: "I'm a Document!")
+    document_class.create(title: "I'm a Document!", doc: '123')
   end
 
   let(:article) do
@@ -41,6 +42,18 @@ describe Mongoid::Urls do
   end
 
   describe '#url' do
+    it 'should accept custom field names' do
+      document_class.send(:url, :doc)
+      expect(document).to have_field(:url)
+      expect(document).to have_field(:urls)
+    end
+
+    it 'should accept simple field names' do
+      document_class.send(:url, :title, simple: true)
+      expect(document).to_not have_field(:urls)
+      expect(document).to have_field(:url)
+    end
+
     describe 'default ":title"' do
       before(:each) { document_class.send(:url, :title) }
 
@@ -65,15 +78,18 @@ describe Mongoid::Urls do
 
     describe 'options' do
       it 'should accept custom field names' do
-        document_class.send(:url, :sweet)
-        expect(document).to have_field(:urls)
+        document_class.send(:url, :title)
+        expect(document).to have_field(:url)
       end
 
       it 'should accept simple field names' do
-        document_class.send(:url, :sweet, simple: true)
+        document_class.send(:url, :title, simple: true)
         expect(document).to_not have_field(:urls)
         expect(document).to have_field(:url)
       end
+    end
+
+    describe 'index field' do
 
       it 'should create simple field to_param' do
         document_class.send(:field, :name)
@@ -164,18 +180,16 @@ describe Mongoid::Urls do
   end
 
   describe 'reserved words' do
-    before(:each) do
-    end
     it 'should respect default new' do
       article.title = 'new'
       expect(article.save).to be_falsey
-      expect(article.errors).to include(:title)
+      expect(article.errors).to include(:url)
     end
 
     it 'should respect default edit' do
       article.title = 'edit'
       expect(article.save).to be_falsey
-      expect(article.errors).to include(:title)
+      expect(article.errors).to include(:url)
     end
 
     it 'should match' do
@@ -201,15 +215,41 @@ describe Mongoid::Urls do
         d2 = article.clone
         expect(d2).to_not be_valid
         expect(d2.save).to be_falsey
-        expect(d2.errors.messages).to include(:title)
+        expect(d2.errors.messages).to include(:url)
       end
 
       it 'should raise when collisions can\'t be resolved on create!' do
         article.title = '1234'
         article.save
+        expect(article.reload.url).to eq '1234'
         dup = Article.create(title: '1234')
+        expect(dup.url).to be nil
         expect(dup.errors.messages).to_not be_empty
       end
+
+      it 'should be possible to edit the url directly' do
+        article.title = '1234'
+        article.save
+        expect(article.reload.url).to eq '1234'
+        dup = Article.create(title: '1234')
+        expect(dup.url).to be nil
+        dup.url = 'onetwo'
+        dup.save
+        expect(dup.errors.messages).to be_empty
+        expect(dup.reload.url).to eq('onetwo')
+      end
+
+      it 'should be safe to edit the url directly' do
+        article.title = '1234'
+        article.save
+        expect(article.reload.url).to eq '1234'
+        dup = Article.create(title: '1234')
+        expect(dup.url).to be nil
+        dup.url = 'One Two'
+        dup.save
+        expect(dup.errors.messages).to be_empty
+        expect(dup.reload.url).to eq('one-two')
+      end
     end
 
     context 'with other url present' do
@@ -227,4 +267,54 @@ describe Mongoid::Urls do
       end
     end
   end
+
+  describe 'Dynamic' do
+    it 'should create' do
+      com = Company.create(name: 'ACME Corp LLC', nick: 'ACME')
+      expect(com.url).to eq 'acme'
+    end
+
+    it 'should create w/o one' do
+      com = Company.create(name: 'ACME Corp LLC')
+      expect(com.url).to eq 'acme-corp-llc'
+    end
+
+    it 'should assign attr' do
+      com = Company.new
+      com.assign_attributes(name: 'ACME Corp LLC', nick: 'ACME')
+      com.save
+      expect(com.url).to eq 'acme'
+      expect(Company.count).to eq 1
+    end
+
+    it 'should assign second attr when first is taken' do
+      com1 = Company.create!(name: 'ACME One', nick: 'ACME')
+      com2 = Company.create!(name: 'ACME Two', nick: 'ACME')
+      expect(com1.url).to eq 'acme'
+      expect(com2.url).to eq 'acme-two'
+    end
+
+    it 'should assign third attr when second is taken' do
+      com1 = Company.create!(name: 'Common Name', nick: 'ACME')
+      com2 = Company.create!(name: 'Common Name', nick: 'ACME')
+      com3 = Company.create!(name: 'Common Name', nick: 'ACME')
+      expect(com1.url).to eq 'acme'
+      expect(com2.url).to eq 'common-name'
+      expect(com3.url).to eq 'acme-common-name'
+    end
+
+    it 'should assign attr' do
+      com = Company.new
+      com.assign_attributes(name: 'ACME Corp LLC', nick: nil)
+      com.save
+      expect(com.url).to eq 'acme-corp-llc'
+    end
+
+    it 'should build up' do
+      com = Company.new
+      com.nick = 'ACME'
+      com.valid?
+      expect(com.url).to eq 'acme'
+    end
+  end
 end

data/spec/support/models.rb

@@ -5,3 +5,18 @@ class Article
   field :title
   url :title
 end
+
+# A model with dynamic key
+class Company
+  include Mongoid::Document
+  include Mongoid::Urls
+  field :name
+  field :nick
+
+  url :nick, :name, :fullname
+
+  def fullname
+    return nick + ' - ' + name if nick && name
+    nick || name
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-urls
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Marcos Piccinini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -88,3 +88,4 @@ test_files:
 - spec/mongoid/urls_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
+has_rdoc: