permalinker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fdbb2252814e5694f69d92fa52b24f6c5aa619ed
+  data.tar.gz: ea376952402d9b759caebc7f0b4799c78cb332ec
+SHA512:
+  metadata.gz: 0512d88fdfe8b621420f01cbcf8bb3441f7c2dfb8845074a6b5bee3d07283fe6a6f7519f88677c5e5c0bc07023c61c3ebf89be373bd55b9cfd131d1fcc225532
+  data.tar.gz: 181f1c70f3fff90a0bacdfbd3409da02739e09ff4b96a92548132552c724e65a13605d770a81adc01d5e861f3631f9d73825912185163b78bbf1b61e2bcd1f9f

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    permalink (1.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    awesome_print (1.1.0)
+    bson (1.8.6)
+    bson_ext (1.8.6)
+      bson (~> 1.8.6)
+    builder (3.0.4)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    i18n (0.6.1)
+    method_source (0.8.1)
+    mongo (1.8.6)
+      bson (~> 1.8.6)
+    mongo_mapper (0.12.0)
+      activemodel (~> 3.0)
+      activesupport (~> 3.0)
+      plucky (~> 0.5.2)
+    mongoid (3.1.4)
+      activemodel (~> 3.2)
+      moped (~> 1.4)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.5.0)
+    multi_json (1.7.3)
+    origin (1.1.0)
+    plucky (0.5.2)
+      mongo (~> 1.5)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-meta (0.0.5)
+      awesome_print
+      pry
+      pry-nav
+      pry-remote
+    pry-nav (0.2.3)
+      pry (~> 0.9.10)
+    pry-remote (0.1.7)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    slop (3.4.5)
+    sqlite3 (1.3.7)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    test-unit (2.5.5)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bson_ext
+  mongo_mapper
+  mongoid
+  permalink!
+  pry-meta
+  rake
+  rspec
+  sqlite3-ruby
+  test-unit

data/README.markdown

@@ -0,0 +1,80 @@
+Permalink
+=========
+
+Instalation
+-----------
+
+    gem install permalink
+
+Usage
+-----
+
+Add the method call `permalink` to your model. Your model should have a `permalink` attribute.
+
+    class Page < ActiveRecord::Base
+      permalink :title
+    end
+
+You can specify the permalink field:
+
+    class page < ActiveRecord::Base
+      permalink :title, :to => :title_permalink
+    end
+
+If you don't want to use `permalink`, you can call `'some text'.to_permalink` string method and
+manage the permalink process by yourself.
+
+Permalinks are not unique by default. `permalink` overrides `to_param` as following:
+
+    def to_param
+      "#{id}-#{permalink}"
+    end
+
+You can define the `to_param` format:
+
+    class Page < ActiveRecord::Base
+      permalink :title, :to_param => %w(id permalink page)
+    end
+
+The above settings will generate something link `100-some-title-page`. By overriding `to_param` method you don't have to change a thing on your app routes.
+
+If you want to generate unique permalink, use the `:unique` option:
+
+    class Page < ActiveRecord::Base
+      permalink :title, :unique => true, :to_param => :permalink
+    end
+
+The permalink is generated using `ActiveSupport::Multibyte::Chars` class; this means that characters will properly replaced from `áéíó` to `aeio`, for instance.
+
+The permalink is created when `before_validation` callback is evaluated. This plugin also tries
+to generate a permalink when `before_save` callback is evaluated and the instance has no permalink set.
+
+You can force the permalink generation by setting the `:force` option.
+
+    class Page < ActiveRecord::Base
+      permalink :title, :force => true
+    end
+
+## License
+
+Copyright (c) 2011 Nando Vieira, released under the MIT license
+Modified 2014 - Florian Eck
+
+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,5 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new

data/lib/permalinker.rb

@@ -0,0 +1,5 @@
+require "permalinker/string_ext"
+require "permalinker/orm/base"
+require "permalinker/orm/active_record"
+
+ActiveRecord::Base.send(:include, Permalinker::Orm::ActiveRecord) if defined?(ActiveRecord)

data/lib/permalinker/orm/active_record.rb

@@ -0,0 +1,26 @@
+module Permalinker
+  module Orm
+    module ActiveRecord
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.extend(Permalinker::Orm::Base::ClassMethods)
+        class << base; attr_accessor :permalink_options; end
+      end
+
+      module ClassMethods
+        # permalink :title
+        # permalink :title, :to => :custom_permalink_field
+        # permalink :title, :to => :permalink, :to_param => [:id, :permalink]
+        # permalink :title, :unique => true
+        def permalink(from, options={})
+          include Permalinker::Orm::Base::InstanceMethods
+          setup_permalink(
+            {:to_param => [:id, :permalink]},
+            from,
+            options
+          )
+        end
+      end
+    end
+  end
+end

data/lib/permalinker/orm/base.rb

@@ -0,0 +1,75 @@
+module Permalinker
+  module Orm
+    module Base
+      module ClassMethods
+        def setup_permalink(orm_options, from, options)
+          options.reverse_merge!(orm_options)
+          options.reverse_merge!({
+            :to     => :permalink,
+            :unique => false,
+            :force  => false
+          })
+
+          self.permalink_options = {
+            :from_column_name => from,
+            :to_column_name   => options[:to],
+            :to_param         => [options[:to_param]].flatten,
+            :unique           => options[:unique],
+            :force            => options[:force]
+          }
+          
+          self.send(:attr_accessor, :overwrite_permalink)
+          
+          before_validation :create_permalink
+          before_save :create_permalink
+        end
+      end
+
+      module InstanceMethods
+        def to_param
+          to_param_option = self.class.permalink_options[:to_param]
+
+          to_param_option.compact.collect do |name|
+            if respond_to?(name)
+              send(name).to_s
+            else
+              name.to_s
+            end
+          end.reject(&:blank?).join("-")
+        end
+        
+        def permalink_value_without_id
+          self.permalink.to_s.gsub(/\A[0-9]{1,}-/, "")
+        end  
+        
+        private
+
+        def from_permalink_name
+          self.class.permalink_options[:from_column_name]
+        end
+
+        def to_permalink_name
+          self.class.permalink_options[:to_column_name]
+        end
+
+        def from_permalink_value
+          read_attribute(from_permalink_name)
+        end
+
+        def to_permalink_value
+          read_attribute(to_permalink_name)
+        end
+        
+       
+
+
+        def create_permalink
+          # Getting Permalinker data
+          # Check overwrite
+          value = self.overwrite_permalink.blank? ? self.to_param : self.overwrite_permalink
+            write_attribute(to_permalink_name, "#{self.id}-#{value}".to_permalink)
+        end
+      end
+    end
+  end
+end

data/lib/permalinker/string_ext.rb

@@ -0,0 +1,11 @@
+class String
+  def to_permalink
+    str = self.de_2_int
+    str.gsub!(/'/, "")
+    str.gsub!(/[^-\w\d]+/sim, "-")
+    str.gsub!(/-+/sm, "-")
+    str.gsub!(/^-?(.*?)-?$/, '\1')
+    str.downcase!
+    str
+  end
+end

data/lib/permalinker/version.rb

@@ -0,0 +1,8 @@
+module Permalinker
+  module Version
+    MAJOR = 1
+    MINOR = 2
+    PATCH = 1
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/permalinker.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require "./lib/permalinker/version"
+
+Gem::Specification.new do |s|
+  s.name        = "permalinker"
+  s.version     = "1.0.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Florian Eck"]
+  s.email       = ["it-support@friends-systems.de"]
+  s.homepage    = "http://rubygems.org/gems/permalinker"
+  s.summary     = "Generate permalink attributes on ActiveRecord, based on Permalink gem by Nando Vieira"
+  s.description = s.summary
+
+  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.add_dependency "friendly_extensions"
+  
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "sqlite3-ruby"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "mongoid"
+  s.add_development_dependency "mongo_mapper"
+  s.add_development_dependency "bson_ext"
+  s.add_development_dependency "pry-meta"
+  s.add_development_dependency "rake"
+end

data/spec/permalink/active_record_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Permalinker::Orm::ActiveRecord do
+  let(:model) { Post }
+  it_behaves_like "orm"
+
+  it "overrides to_param method" do
+    model.permalink :title
+
+    record = model.create(:title => "Some nice post")
+    expect(record.to_param).to eql("#{record.id}-some-nice-post")
+  end
+end

data/spec/permalink/string_spec.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require "spec_helper"
+
+describe "String#to_permalink" do
+  {
+    'This IS a Tripped out title!!.!1  (well/ not really)' => 'this-is-a-tripped-out-title-1-well-not-really',
+    '////// meph1sto r0x ! \\\\\\' => 'meph1sto-r0x',
+    'āčēģīķļņū' => 'acegiklnu',
+    '中文測試 chinese text' => 'chinese-text',
+    'some-)()()-ExtRa!/// .data==?>    to \/\/test' => 'some-extra-data-to-test',
+    'http://simplesideias.com.br/tags/' => 'http-simplesideias-com-br-tags',
+    "Don't Repeat Yourself (DRY)" => 'dont-repeat-yourself-dry',
+    "Text\nwith\nline\n\n\tbreaks" => 'text-with-line-breaks',
+    "can't do it" => "cant-do-it",
+    "i'm a dog" => "im-a-dog"
+  }.each do |from, to|
+    it "creates permalink for #{from}" do
+      expect(from.to_permalink).to eql(to)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "mongo_mapper"
+require "mongoid"
+require "rspec"
+require "active_record"
+require "permalink"
+
+# Setup ActiveRecord
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+load("support/schema.rb")
+require "support/shared"
+require "support/post"

data/spec/support/post.rb

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

data/spec/support/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts do |t|
+    t.string :title, :permalink, :description, :slug
+  end
+end

data/spec/support/shared.rb

@@ -0,0 +1,117 @@
+shared_examples_for "orm" do
+  before do
+    model.delete_all
+    model.permalink :title
+  end
+
+  it "should respond to options" do
+    model.should respond_to(:permalink_options)
+  end
+
+  it "should use default options" do
+    model.permalink :title
+    record = model.create(:title => "Some nice post")
+    record.permalink.should == "some-nice-post"
+  end
+
+  it "should use custom attribute" do
+    model.permalink :title, :to => :slug
+    record = model.create(:title => "Some nice post")
+    record.slug.should == "some-nice-post"
+  end
+
+  it "should set permalink before_save" do
+    record = model.new(:title => "Some nice post")
+    record.permalink.should be_nil
+    record.valid?
+    record.permalink.should == "some-nice-post"
+  end
+
+  it "should create unique permalinks" do
+    model.permalink :title, :unique => true
+
+    record = model.create(:title => "Some nice post")
+    record.permalink.should == "some-nice-post"
+
+    record = model.create(:title => "Some nice post")
+    record.permalink.should == "some-nice-post-2"
+
+    record = model.create(:title => "Some nice post")
+    record.permalink.should == "some-nice-post-3"
+  end
+
+  it "should return to_param for unique permalink" do
+    model.permalink :title, :to_param => :permalink, :unique => true
+
+    record = model.create(:title => "Ruby")
+    record.to_param.should == "ruby"
+
+    record = model.create(:title => "Ruby")
+    record.to_param.should == "ruby-2"
+  end
+
+  it "should override to_param with custom fields" do
+    model.permalink :title, :to => :slug, :to_param => [:slug, :id, "page"]
+
+    record = model.create(:title => "Some nice post")
+    record.to_param.should == "some-nice-post-#{record.id}-page"
+  end
+
+  it "should ignore blank attributes from to_param" do
+    model.permalink :title, :to_param => [:id, "    ", nil, "\t", :permalink]
+
+    record = model.create(:title => "Some nice post")
+    record.to_param.should == "#{record.id}-some-nice-post"
+  end
+
+  it "should set permalink if permalink is blank" do
+    record = model.create(:title => "Some nice post", :permalink => "  ")
+    record.permalink.should == "some-nice-post"
+  end
+
+  it "should keep defined permalink" do
+    record = model.create(:title => "Some nice post", :permalink => "awesome-post")
+    record.permalink.should == "awesome-post"
+  end
+
+  it "should create unique permalinks for number-ended titles" do
+    model.permalink :title, :unique => true
+
+    record = model.create(:title => "Rails 3")
+    record.permalink.should == "rails-3"
+
+    record = model.create(:title => "Rails 3")
+    record.permalink.should == "rails-3-2"
+  end
+
+  it "should force permalink" do
+    model.permalink :title, :force => true
+
+    record = model.create(:title => "Some nice post")
+    record.update_attributes :title => "Awesome post"
+
+    record.permalink.should == "awesome-post"
+  end
+
+  it "should force permalink and keep unique" do
+    model.permalink :title, :force => true, :unique => true
+
+    record = model.create(:title => "Some nice post")
+
+    record.update_attributes :title => "Awesome post"
+    record.permalink.should == "awesome-post"
+
+    record = model.create(:title => "Awesome post")
+    record.permalink.should == "awesome-post-2"
+  end
+
+  it "should keep same permalink when another field changes" do
+    model.permalink :title, :force => true, :unique => true
+
+    record = model.create(:title => "Some nice post")
+    record.update_attributes :description => "some description"
+
+    record.permalink.should == "some-nice-post"
+  end
+
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: permalinker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Florian Eck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: friendly_extensions
+  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: activerecord
+  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: sqlite3-ruby
+  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: test-unit
+  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: rspec
+  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: mongoid
+  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: mongo_mapper
+  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: bson_ext
+  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: pry-meta
+  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: Generate permalink attributes on ActiveRecord, based on Permalink gem
+  by Nando Vieira
+email:
+- it-support@friends-systems.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- lib/permalinker.rb
+- lib/permalinker/orm/active_record.rb
+- lib/permalinker/orm/base.rb
+- lib/permalinker/string_ext.rb
+- lib/permalinker/version.rb
+- permalinker.gemspec
+- spec/permalink/active_record_spec.rb
+- spec/permalink/string_spec.rb
+- spec/spec_helper.rb
+- spec/support/post.rb
+- spec/support/schema.rb
+- spec/support/shared.rb
+homepage: http://rubygems.org/gems/permalinker
+licenses: []
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Generate permalink attributes on ActiveRecord, based on Permalink gem by
+  Nando Vieira
+test_files:
+- spec/permalink/active_record_spec.rb
+- spec/permalink/string_spec.rb
+- spec/spec_helper.rb
+- spec/support/post.rb
+- spec/support/schema.rb
+- spec/support/shared.rb
+has_rdoc: