mongoid-permalinks 0.2.0

data/.gitignore

@@ -0,0 +1,25 @@
+# Because this is a gem, ignore Gemfile.lock:
+
+Gemfile.lock
+
+# And because this is Ruby, ignore the following
+#  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gemspec
+
+gem 'minitest'
+gem 'rake'

data/README.md

@@ -0,0 +1,62 @@
+# mongoid-permalinks
+
+Mongoid::Permalinks adds a permalink based on your document `to_s` method.
+
+## Installation
+
+In your Gemfile:
+
+```ruby
+gem 'mongoid-permalinks'
+```
+
+## Usage
+
+```ruby
+class Document
+  include Mongoid::Document
+  include Mongoid::Permalinks
+  
+  field :name, type: String
+  
+  alias_method :to_s, :name
+end
+```
+
+```ruby
+document = Document.create(name: 'Mongoid::Permalinks is awesome')
+document.permalink # => 'mongoid-permalinks-is-awesome'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+(The MIT license)
+
+Copyright (c) 2012 Mario Uher
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob('spec/**/*_spec.rb')
+end
+
+task(default: :test)

data/lib/mongoid/permalinks/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Permalinks
+    VERSION = '0.2.0'
+  end
+end

data/lib/mongoid/permalinks.rb

@@ -0,0 +1,19 @@
+require 'active_support'
+require 'mongoid'
+
+module Mongoid
+  module Permalinks
+    extend ActiveSupport::Concern
+
+    included do
+      field :permalink, type: String
+
+      before_save :set_permalink
+    end
+
+  private
+    def set_permalink
+      self.permalink = (permalink.presence || to_s).parameterize
+    end
+  end
+end

data/mongoid-permalinks.gemspec

@@ -0,0 +1,17 @@
+require './lib/mongoid/permalinks/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'mongoid-permalinks'
+  gem.version       = Mongoid::Permalinks::VERSION
+  gem.authors       = 'Mario Uher'
+  gem.email         = 'uher.mario@gmail.com'
+  gem.homepage      = 'https://github.com/haihappen/mongoid-permalinks'
+  gem.summary       = 'Permalinks for your Mongoid documents.'
+  gem.description   = 'Mongoid::Permalink adds a permalink based on your document to_s method.'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_path  = 'lib'
+
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'mongoid'
+end

data/spec/permalinks_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Mongoid::Permalinks do
+  it 'adds permalink field' do
+    Document.fields['permalink'].type.must_equal String
+  end
+
+
+  describe 'setting permalink' do
+    subject { Document.create(permalink: permalink, name: 'Name') }
+    let(:value) { subject.permalink }
+
+
+    describe 'providing an empty permalink' do
+      let(:permalink) { '' }
+
+
+      it 'parameterizes name instead' do
+        value.must_equal 'name'
+      end
+    end
+
+
+    describe 'providing an permalink' do
+      let(:permalink) { 'custom permalink' }
+
+
+      it 'parameterizes it' do
+        value.must_equal 'custom-permalink'
+      end
+    end
+
+
+    describe 'providing an permalink with trailing spaces' do
+      let(:permalink) { '  custom permalink  ' }
+
+
+      it 'parameterizes it and removes the spaces' do
+        value.must_equal 'custom-permalink'
+      end
+    end
+
+
+    describe 'providing an permalink with special characters' do
+      let(:permalink) { 'Donald E. Knuth' }
+
+
+      it 'parameterizes it and makes it pretty' do
+        value.must_equal 'donald-e-knuth'
+      end
+    end
+  end
+
+
+  describe 'having localized permalink fields' do
+    subject { Localized.new }
+
+
+    it 'works too' do
+      { en: 'English', de: 'Deutsch' }.each do |locale, permalink|
+        I18n.locale = locale
+        subject.permalink = permalink
+        subject.save
+        
+        subject.permalink.must_equal permalink.parameterize
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/spec'
+
+require './lib/mongoid/permalinks'
+
+# Load support *.rb files in ./support
+Dir[File.expand_path('../support/*.rb', __FILE__)].each { |file| require file }

data/spec/support/connection.rb

@@ -0,0 +1 @@
+Mongoid.load!(File.expand_path('../mongoid.yml', __FILE__), 'test')

data/spec/support/document.rb

@@ -0,0 +1,18 @@
+class Document
+  include Mongoid::Document
+  include Mongoid::Permalinks
+
+  field :name, type: String
+
+  alias_method :to_s, :name
+end
+
+class Localized
+  include Mongoid::Document
+  include Mongoid::Permalinks
+
+  field :name,      type: String, localize: true
+  field :permalink, type: String, localize: true
+
+  alias_method :to_s, :name
+end

data/spec/support/mongoid.yml

@@ -0,0 +1,8 @@
+test:
+  sessions:
+    default:
+      database: mongoid_permalinks_test
+      hosts:
+        - localhost:27017
+      options:
+        consistency: :strong

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-permalinks
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors:
+- Mario Uher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: activesupport
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: mongoid
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Mongoid::Permalink adds a permalink based on your document to_s method.
+email: uher.mario@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/mongoid/permalinks.rb
+- lib/mongoid/permalinks/version.rb
+- mongoid-permalinks.gemspec
+- spec/permalinks_spec.rb
+- spec/spec_helper.rb
+- spec/support/connection.rb
+- spec/support/document.rb
+- spec/support/mongoid.yml
+homepage: https://github.com/haihappen/mongoid-permalinks
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Permalinks for your Mongoid documents.
+test_files: []