mongoid_permalink_extension 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 98afc802b3412519f89bbbbd3c1f0ea16fcb470f
+  data.tar.gz: c26b501ab8d2fcf8fb9fbae808f5fda225f0df85
+SHA512:
+  metadata.gz: 058569701ff2b746af74119d686a188b4373d2955a0dfc4acb85fb4b387b561c432d6ef50f650003e8a736541bd59c5e248ab59365cedfd753e3339ef9c766a1
+  data.tar.gz: 140277531935221ef8dbc2b4650626d4026bf4bfaa5b22131ce78662153e915f9242991b6db44b146324ebe05b34f5202abe58a710653da25e5893c0af65d209

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

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/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+rvm:
+  - 1.9.3
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tomas Celizna
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tomas Celizna
+
+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,43 @@
+# Mongoid Permalink Extension
+
+[![Build Status](https://travis-ci.org/tomasc/mongoid_permalink_extension.svg)](https://travis-ci.org/tomasc/mongoid_permalink_extension) [![Coverage Status](https://img.shields.io/coveralls/tomasc/mongoid_permalink_extension.svg)](https://coveralls.io/r/tomasc/mongoid_permalink_extension)
+
+A [Mongoid](https://github.com/mongoid/mongoid) field extension that stores any String as a permalink slug.
+
+* converts spaces to hyphens
+* converts to camel case
+* converts all dashes to hyphens
+* remove non-alphanumeric characters
+* removes accents
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_permalink_extension'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_permalink_extension
+
+## Usage
+
+Add to Mongoid models as:
+
+    field :permalink, type: MongoidPermalinkExtension::Permalink
+    
+Produces slugs in the form of:
+
+    A-Hard-Days-Night
+
+## 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,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*/*_test.rb'
+end
+ 
+task :default => :test

data/lib/mongoid_permalink_extension.rb

@@ -0,0 +1,3 @@
+require 'mongoid_permalink_extension/permalink'
+require 'mongoid_permalink_extension/version'
+

data/lib/mongoid_permalink_extension/permalink.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require 'stringex'
+
+module MongoidPermalinkExtension
+  class Permalink
+
+    class << self
+
+      def demongoize value
+        value
+      end
+
+      def mongoize value
+        return if value.nil?
+        value.to_s.
+          gsub(/[–—]/, '-').
+          gsub(/\s+/, '-').
+          gsub(/[^\p{Alnum} -]/, '').
+          gsub(/\b\w/){ $&.upcase }.
+          to_ascii
+      end
+
+    end
+
+  end
+end

data/lib/mongoid_permalink_extension/version.rb

@@ -0,0 +1,3 @@
+module MongoidPermalinkExtension
+  VERSION = "0.0.1"
+end

data/mongoid_permalink_extension.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_permalink_extension/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_permalink_extension"
+  spec.version       = MongoidPermalinkExtension::VERSION
+  spec.authors       = ["Tomas Celizna"]
+  spec.email         = ["tomas.celizna@gmail.com"]
+  spec.description   = %q{Custom field type for Mongoid that automatically converts strings to URL slugs.}
+  spec.summary       = %q{Custom field type for Mongoid that automatically converts strings to URL slugs.}
+  spec.homepage      = "https://github.com/tomasc/mongoid_permalink_extension"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mongoid", ">= 4.0"
+  spec.add_dependency "stringex"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

data/test/mongoid_permalink_extension/permalink_test.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+require 'test_helper'
+
+# ---------------------------------------------------------------------
+  
+class MongoidPermalinkExtensionTest
+  include Mongoid::Document
+  field :permalink, type: MongoidPermalinkExtension::Permalink
+end
+
+# ---------------------------------------------------------------------
+  
+module MongoidPermalinkExtension
+  describe Permalink do
+    
+    subject { MongoidPermalinkExtensionTest.new }
+
+    describe '.demongoize' do
+      let(:permalink_value) { 'something stored in the database' }
+      it 'does not change the value' do
+        MongoidPermalinkExtension::Permalink.demongoize(permalink_value).must_equal permalink_value
+      end
+    end
+
+    describe '.mongoize' do
+      it 'converts anything to string' do
+        MongoidPermalinkExtension::Permalink.mongoize(12).must_equal '12'
+      end
+      it 'stores transformed string' do
+        MongoidPermalinkExtension::Permalink.mongoize("some some").must_be :present?
+      end
+      it 'stores nil if nil passed' do
+        MongoidPermalinkExtension::Permalink.mongoize(nil).must_be_nil
+      end
+      it 'converts spaces to hyphens' do
+        MongoidPermalinkExtension::Permalink.mongoize(" ").must_equal '-'
+        MongoidPermalinkExtension::Permalink.mongoize("    ").must_equal '-'
+      end
+      it 'converts to camel case' do
+        MongoidPermalinkExtension::Permalink.mongoize("hello hello").wont_include 'h'
+      end
+      it 'converts all dashes to hyphens' do
+        MongoidPermalinkExtension::Permalink.mongoize("–").must_equal '-'
+        MongoidPermalinkExtension::Permalink.mongoize("—").must_equal '-'
+      end
+      it 'remove non-alphanumeric characters' do
+        %w(?!@#$%^&*()+=/.,;<>[]).shuffle.each do |i|
+          MongoidPermalinkExtension::Permalink.mongoize(i).wont_include i
+        end
+      end
+      it 'preserves accented characters' do
+        MongoidPermalinkExtension::Permalink.mongoize('Bienále Brno Česká republika').must_equal 'Bienale-Brno-Ceska-Republika'
+      end
+      it 'produces nice slugs' do
+        MongoidPermalinkExtension::Permalink.mongoize('Future Vocabularies?').must_equal 'Future-Vocabularies'
+        MongoidPermalinkExtension::Permalink.mongoize('2011 space odyssey').must_equal '2011-Space-Odyssey'
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'mongoid'
+require 'mongoid_permalink_extension'
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'coveralls'
+
+Coveralls.wear!

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_permalink_extension
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: stringex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Custom field type for Mongoid that automatically converts strings to
+  URL slugs.
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid_permalink_extension.rb
+- lib/mongoid_permalink_extension/permalink.rb
+- lib/mongoid_permalink_extension/version.rb
+- mongoid_permalink_extension.gemspec
+- test/mongoid_permalink_extension/permalink_test.rb
+- test/test_helper.rb
+homepage: https://github.com/tomasc/mongoid_permalink_extension
+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: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Custom field type for Mongoid that automatically converts strings to URL
+  slugs.
+test_files:
+- test/mongoid_permalink_extension/permalink_test.rb
+- test/test_helper.rb
+has_rdoc: