mongoid-urls 0.0.3 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b71d8482958f190295f9a8a0d52ca7cfdf8ef63c
-  data.tar.gz: 22b5ffff3481e0488d74b6b7f4743d7f6bb4fc80
+  metadata.gz: b5712fe3113cb418853a86467166a467ef85e918
+  data.tar.gz: 87fd69af5d300bcaa822616e88f64f5f3f4d97af
 SHA512:
-  metadata.gz: b263576272e13a2c1971355de8c28f5475d8a18aeef4e9a183c3d964a25e4ea43125b36d641b3ea5112eacec5bc088c2a0bb2f090d3c00a7aae171bf412ef9c3
-  data.tar.gz: fa31fde6011957d031e9b82cc9a3db6495c719c4c701f85c5b224a23e63710e6dd1f1cd56d92921f80a0b05d1b2532fc0ca75d6874fb6f50f1d70765019cec99
+  metadata.gz: 9a7a34585091f75f746e903fde578f8a23ac97eed52678239b617613c0de1dc5e1042b467a2f62e64cf84b73d8cc7ff78e33d8a544bcbee431026aaad919f075
+  data.tar.gz: 5a26ba691150d4587738a363f6cb7bfc67f2053218776f43181dd10f15ad6925ecad8c13bf89219fb48d1ced3265c0cce8d7b6af9fc4c9611774a9d2a43169b9

data/.gitignore

@@ -3,3 +3,5 @@
 Gemfile.lock
 pkg/*
 .DS_Store
+/.coveralls.yml
+coverage/*

data/.travis.yml

@@ -1,15 +1,18 @@
 language: ruby
 
 rvm:
-  - 1.9.3
   - 2.1.1
   - 2.2.2
   - ruby-head
-  - jruby-19mode
+  - jruby-head
   - rbx-2
 
+env: CI="travis" JRUBY_OPTS="--2.0 --server -Xcompile.invokedynamic=false -J-XX:+TieredCompilation -J-XX:TieredStopAtLevel=1 -J-noverify -J-Xms512m -J-Xmx1024m"
+
 matrix:
   allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
     - rvm: rbx-2
 
 gemfile:

data/Gemfile

@@ -7,6 +7,7 @@ group :test do
   gem 'guard-rspec'
   gem 'guard-rubocop'
   gem 'rspec', '>= 3.2.0'
+  gem 'coveralls', require: false
   gem 'codeclimate-test-reporter', require: nil
   gem 'mongoid-rspec', git: 'https://github.com/nofxx/mongoid-rspec'
 end

data/README.md

@@ -12,7 +12,7 @@ Mongoid::Urls
 Simple slugs for mongoid models!
 
 
-## Short snappy token ids for Mongoid documents
+## Nice URLs for Mongoid Documents
 
 This library is a quick and simple way to generate slugs
 for your mongoid documents.
@@ -21,7 +21,7 @@ Mongoid::Urls can help turn this:
 
     http://bestappever.com/video/4dcfbb3c6a4f1d4c4a000012
 
-Into something more like this:
+Into something like this:
 
     http://bestappever.com/video/kittens-playing-with-puppies
 
@@ -32,11 +32,11 @@ 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:
+In your Mongoid documents, just add `include Mongoid::Urls`
+and use the `url` method to setup, like so:
 
 ```ruby
-class Article
+class Video
   include Mongoid::Document
   include Mongoid::Urls
 
@@ -53,25 +53,35 @@ listed [below](#configuration).
 
 ## Finders
 
-`Mongoid::Urls` will **never** override `find`.
-There's some helpers for custom fields:
+`Mongoid::Urls` will **never** override `find`!
 
 ```ruby
 Video.find_by_url("the-nice-url")
-Account.find_by_url("acc-123456")
 ```
 
+Or just:
+
+```ruby
+Account.find_url("acc-123456")
+```
 
 ## Configuration
 
 You may choose between two different systems for how your urls are stored:
 
-Default #urls
+Simple: `#url` String only.
 
-Simple #url
+Default to simple + `#urls` Array for history (find when page moved).
 
 
 #### Reserved
 
+Defaults to `%w(new edit)`.
+Have in mind: It's an overwrite, not a merge.
+
 
 # Notes
+
+If you're looking for conflict resolution, check out `mongoid-slugs`.
+This gem intended to be used for manual conflict resolution (duplicates):
+Use your own logic and/or return conflict error to the user.

data/lib/mongoid/urls/version.rb

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

data/lib/mongoid/urls.rb

@@ -24,6 +24,7 @@ module Mongoid
       #
       def url(*args)
         options = args.extract_options!
+        fail 'One #url per model!' if url_key
         self.url_key = args.first.to_s
         self.url_simple = options[:simple]
         self.reserved_words = options[:reserve] || Set.new(%w(new edit))
@@ -31,30 +32,29 @@ module Mongoid
         before_validation :create_urls
       end
 
-      def find_by_url(u)
-        url_simple ? find_by(url: u) : find_by(urls: u)
+      def find_url(u)
+        find_by(url: u) || (!url_simple && find_by(urls: u))
       rescue Mongoid::Errors::DocumentNotFound
         nil
       end
+      alias_method :find_by_url, :find_url
 
       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
+        field :url, type: String
+        index({ url: 1 }, unique: true)
+        return if url_simple
+        field :urls, type: Array, default: []
+        index(urls: 1)
       end
     end # ClassMethods
 
     def to_param
-      urls.last
+      url
     end
 
-    def slug
+    def new_url
       self[url_key].to_slug.normalize.to_s
     end
 
@@ -72,9 +72,10 @@ module Mongoid
 
     def create_urls
       return unless changes.include?(url_key)
-      validate_urls(new_url = slug)
+      validate_urls(new_url)
 
-      return self.url = new_url if url_simple
+      self.url = new_url
+      return if url_simple
       urls << new_url
       urls.uniq!
     end

data/mongoid-urls.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |s|
   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.license     = 'MIT'
 
   s.rubyforge_project = 'mongoid-urls'
   s.add_dependency 'mongoid', '> 4.0.0'
@@ -18,6 +18,6 @@ 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"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 end

data/spec/mongoid/urls_spec.rb

@@ -20,27 +20,28 @@ describe Mongoid::Urls do
     Article.new(title: "I'm an Article!")
   end
 
-  describe '#slug' do
+  describe '#url' do
     before(:each) { document_class.send(:url, :title) }
     it 'should slugize a few stuff' do
-      expect(document.slug).to eq('im-a-document')
+      expect(document.url).to eq('im-a-document')
     end
 
-    it 'should update slug' do
+    it 'should update url' do
       document.title = 'I "quoted"'
-      expect(document.slug).to eq('i-quoted')
+      document.valid?
+      expect(document.url).to eq('i-quoted')
     end
 
-    it 'should keep old slugs' do
+    it 'should keep old urls' do
       article.save
-      article.title = "Hello Ruby!"
+      article.title = 'Hello Ruby!'
       article.save
-      expect(article.urls).to eq ["im-an-article", "hello-ruby"]
+      expect(article.urls).to eq ['im-an-article', 'hello-ruby']
     end
   end
 
   describe '#url' do
-    describe 'default "_id"' do
+    describe 'default ":title"' do
       before(:each) { document_class.send(:url, :title) }
 
       it 'should be created' do
@@ -68,6 +69,19 @@ describe Mongoid::Urls do
         expect(document).to have_field(:urls)
       end
 
+      it 'should accept simple field names' do
+        document_class.send(:url, :sweet, simple: true)
+        expect(document).to_not have_field(:urls)
+        expect(document).to have_field(:url)
+      end
+
+      it 'should create simple field to_param' do
+        document_class.send(:field, :name)
+        document_class.send(:url, :name, simple: true)
+        doc = document_class.create(name: 'nice doc')
+        expect(doc.to_param).to eq('nice-doc')
+      end
+
       it 'should not create custom finders with default id' do
         # A sample model
         class UntaintedDocument
@@ -149,6 +163,32 @@ describe Mongoid::Urls do
     end
   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)
+    end
+
+    it 'should respect default edit' do
+      article.title = 'edit'
+      expect(article.save).to be_falsey
+      expect(article.errors).to include(:title)
+    end
+
+    it 'should match' do
+      article.title = 'anew'
+      expect(article.save).to be_truthy
+    end
+
+    it 'should match' do
+      article.title = 'newa'
+      expect(article.save).to be_truthy
+    end
+  end
+
   describe '(no) collision resolution' do
     before(:each) do
       document_class.send(:url, :title)
@@ -172,20 +212,17 @@ describe Mongoid::Urls do
       end
     end
 
-    context 'with other unique indexes present' do
+    context 'with other url 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)
+          expect { document_class.send(:url, :name) }
+            .to raise_exception(RuntimeError)
         end
       end
     end

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
 # require 'codeclimate-test-reporter'
 # CodeClimate::TestReporter.start
+if ENV['CI']
+  require 'coveralls'
+  Coveralls.wear!
+end
 
 $LOAD_PATH << File.expand_path('../../lib', __FILE__)
 
@@ -12,20 +16,27 @@ require 'mongoid/urls'
 
 ENV['MONGOID_ENV'] = 'test'
 
+db_config = {
+  default: {
+    database: 'mongoid_urls_test',
+    hosts: ["localhost: #{ENV['MONGODB_PORT'] || 27_017}"],
+    options: {}
+  }
+}
+
 Mongoid.configure do |config|
   config.load_configuration(
-    clients: {
-      default: {
-        database: 'mongoid_urls_test',
-        hosts: ["localhost: #{ENV['BOXEN_MONGODB_PORT'] || 27_017}"],
-        options: {}
-      }
-    })
+    if Mongoid::VERSION >= '5'
+      { clients: db_config }
+    else
+      { sessions: db_config }
+    end
+  )
 end
 
 require 'support/models'
 
-Mongo::Logger.logger.level = Logger::INFO
+Mongo::Logger.logger.level = Logger::INFO if Mongoid::VERSION >= '5'
 
 RSpec.configure do |config|
   config.include Mongoid::Matchers

data/spec/support/models.rb

@@ -1,3 +1,4 @@
+# A nice model for a blog!
 class Article
   include Mongoid::Document
   include Mongoid::Urls

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-urls
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.7
 platform: ruby
 authors:
 - Marcos Piccinini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-19 00:00:00.000000000 Z
+date: 2015-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mongoid-urls
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A url sanitizer (slugs) for Mongoid documents.