permalink 1.2.0 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b59f20670f6bcfbd6b204ad5e23aefcce7abf477b6b574d165d87e892e9b6afc
+  data.tar.gz: dfdee1e9df89d3d11e9d9240811c00a4307abf1a22accc6346e992b092326225
+SHA512:
+  metadata.gz: 79d9f75edc2fd001ffe2cc4544ba5bd0fbc38a7a842641f5d656136961233aa926a72e9ad2e5d387641e354d5b4dd919f92567289d84a137644ed7edab782857
+  data.tar.gz: '080cb2da608b09403a9e4aae8d42f1465a0cb33b3902aadf2f4747c50c72bd21bd361f91dc1abce55503df7d5488d5332099e20cc9755938ae54f8a5045cd9a3'

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+---
+github: [fnando]
+custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.gitignore

@@ -1 +1,3 @@
-pkg
+pkg
+*.lock
+coverage

data/.rubocop.yml

@@ -0,0 +1,13 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+cache: bundler
+sudo: false
+rvm:
+  - "2.7.1"
+  - "2.6.5"
+notifications:
+  email: false

data/Gemfile

@@ -1,2 +1,4 @@
-source :rubygems
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -0,0 +1,118 @@
+# Permalink
+
+[![Code Climate](https://codeclimate.com/github/fnando/permalink.svg)](https://codeclimate.com/github/fnando/permalink)
+[![Build Status](https://travis-ci.org/fnando/permalink.svg)](https://travis-ci.org/fnando/permalink)
+[![Gem](https://img.shields.io/gem/v/permalink.svg)](https://rubygems.org/gems/permalink)
+[![Gem](https://img.shields.io/gem/dt/permalink.svg)](https://rubygems.org/gems/permalink)
+
+## Installation
+
+    gem install permalink
+
+## Usage
+
+Add the method call `permalink` to your model. Your model should have a
+`permalink` attribute.
+
+```ruby
+class Page < ActiveRecord::Base
+  permalink :title
+end
+```
+
+You can specify the permalink field:
+
+```ruby
+class page < ActiveRecord::Base
+  permalink :title, to: "title_permalink"
+end
+```
+
+If you don't want to use `permalink`, you can call
+`Permalink.generate("some text")` string method and manage the permalink process
+by yourself.
+
+Permalinks are not unique by default. `permalink` overrides `to_param` as
+following:
+
+```ruby
+def to_param
+  "#{id}-#{permalink}"
+end
+```
+
+You can define the `to_param` format:
+
+```ruby
+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:
+
+```ruby
+class Page < ActiveRecord::Base
+  permalink :title, unique: true, to_param: "permalink"
+end
+```
+
+The permalink can be tied to a given scope. Let's say you want to have unique
+permalinks by user. Just set the `:scope` option.
+
+```ruby
+class Page < ActiveRecord::Base
+  belongs_to :user
+  permalink :title, unique: true, scope: "user_id"
+end
+
+user = User.first
+another_user = User.last
+
+page = user.pages.create(title: 'Hello')
+page.permalink #=> hello
+
+another_page = another_user.pages.create(title: 'Hello')
+another_page.permalink #=> hello
+```
+
+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.
+
+```ruby
+class Page < ActiveRecord::Base
+  permalink :title, force: true
+end
+```
+
+## License
+
+Copyright (c) 2011-2015 Nando Vieira, released under the 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/Rakefile

@@ -1,5 +1,15 @@
-require "bundler"
-Bundler::GemHelper.install_tasks
+# frozen_string_literal: true
 
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/permalink.rb

@@ -1,8 +1,38 @@
-require "permalink/string_ext"
-require "permalink/orm/base"
-require "permalink/orm/active_record"
-require "permalink/orm/mongo_mapper"
-require "permalink/orm/mongoid"
-
-ActiveRecord::Base.send(:include, Permalink::Orm::ActiveRecord) if defined?(ActiveRecord)
-Mongoid::Document::ClassMethods.send(:include, Permalink::Orm::Mongoid) if defined?(Mongoid)
+# frozen_string_literal: true
+
+require "active_record"
+require "permalink/active_record"
+require "permalink/normalizations/contraction"
+require "permalink/normalizations/downcase"
+require "permalink/normalizations/leading_trailing_dashes"
+require "permalink/normalizations/multiple_dashes"
+require "permalink/normalizations/non_alphanumeric"
+require "permalink/normalizations/transliteration"
+
+module Permalink
+  DEFAULT_NORMALIZATIONS = [
+    Normalizations::Transliteration,
+    Normalizations::Downcase,
+    Normalizations::Contraction,
+    Normalizations::NonAlphanumeric,
+    Normalizations::MultipleDashes,
+    Normalizations::LeadingTrailingDashes
+  ].freeze
+
+  DEFAULT_OPTIONS = {
+    normalizations: DEFAULT_NORMALIZATIONS,
+    separator: "-"
+  }.freeze
+
+  def self.generate(input, options = DEFAULT_OPTIONS)
+    options = DEFAULT_OPTIONS.merge(options)
+
+    options[:normalizations].each do |normalization|
+      input = normalization.call(input, options)
+    end
+
+    input
+  end
+end
+
+ActiveRecord::Base.include Permalink::ActiveRecord

data/lib/permalink/active_record.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Permalink
+  module ActiveRecord
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.extend(Permalink::ActiveRecord::ClassMethods)
+      base.cattr_accessor :permalink_options
+    end
+
+    module ClassMethods
+      # permalink :title
+      # permalink :title, to: :custom_permalink_field
+      # permalink :title, to: :permalink, to_param: [:id, :permalink]
+      # permalink :title, unique: true
+      # permalink :title, separator: "_"
+      # permalink :title, normalizations: array_of_normalizations
+      def permalink(from_column, options = {})
+        include InstanceMethods
+
+        options = options.reverse_merge(
+          to_param: %i[id permalink],
+          to: :permalink,
+          unique: false,
+          force: false,
+          separator: "-",
+          normalizations: Permalink::DEFAULT_NORMALIZATIONS
+        )
+
+        self.permalink_options = {
+          from_column_name: from_column,
+          to_column_name: options[:to],
+          to_param: [options[:to_param]].flatten,
+          unique: options[:unique],
+          force: options[:force],
+          scope: options[:scope],
+          separator: options[:separator],
+          normalizations: options[:normalizations]
+        }
+
+        before_validation :create_permalink
+        before_save :create_permalink
+      end
+    end
+
+    module InstanceMethods
+      def to_param
+        to_param_option = permalink_options[:to_param]
+
+        to_param_option.compact.map do |name|
+          respond_to?(name) ? public_send(name).to_s : name.to_s
+        end.reject(&:blank?).join(permalink_options[:separator])
+      end
+
+      private def next_available_permalink(permalink)
+        unique_permalink = permalink
+        scope = build_scope_for_permalink
+
+        if permalink_options[:unique]
+          suffix = 2
+
+          while scope.where(to_permalink_name => unique_permalink).first
+            unique_permalink =
+              [permalink, suffix].join(permalink_options[:separator])
+
+            suffix += 1
+          end
+        end
+
+        unique_permalink
+      end
+
+      private def build_scope_for_permalink
+        search_scope = permalink_options[:scope]
+        scope = self.class.unscoped
+
+        if search_scope
+          scope = scope.where(search_scope => public_send(search_scope))
+        end
+
+        scope
+      end
+
+      private def from_permalink_name
+        permalink_options[:from_column_name]
+      end
+
+      private def to_permalink_name
+        permalink_options[:to_column_name]
+      end
+
+      private def from_permalink_value
+        read_attribute(from_permalink_name)
+      end
+
+      private def to_permalink_value
+        read_attribute(to_permalink_name)
+      end
+
+      private def update_permalink?
+        changes[from_permalink_name] &&
+        (permalink_options[:force] || to_permalink_value.blank?)
+      end
+
+      private def create_permalink
+        return unless update_permalink?
+
+        permalink = Permalink.generate(
+          from_permalink_value.to_s,
+          permalink_generator_options
+        )
+
+        write_attribute(
+          to_permalink_name,
+          next_available_permalink(permalink)
+        )
+      end
+
+      private def permalink_generator_options
+        {
+          separator: permalink_options[:separator],
+          normalizations: permalink_options[:normalizations]
+        }
+      end
+    end
+  end
+end

data/lib/permalink/normalizations/contraction.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Permalink
+  module Normalizations
+    module Contraction
+      def self.call(input, _options = nil)
+        input.gsub(/['’]/, "")
+      end
+    end
+  end
+end

data/lib/permalink/normalizations/downcase.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Permalink
+  module Normalizations
+    module Downcase
+      def self.call(input, _options = nil)
+        input.downcase
+      end
+    end
+  end
+end

data/lib/permalink/normalizations/leading_trailing_dashes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Permalink
+  module Normalizations
+    module LeadingTrailingDashes
+      def self.call(input, _options = nil)
+        input.gsub(/^-?(.*?)-?$/, '\1')
+      end
+    end
+  end
+end

data/lib/permalink/normalizations/multiple_dashes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Permalink
+  module Normalizations
+    module MultipleDashes
+      def self.call(input, options = DEFAULT_OPTIONS)
+        input.gsub(/-+/sm, options[:separator])
+      end
+    end
+  end
+end

data/lib/permalink/normalizations/non_alphanumeric.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Permalink
+  module Normalizations
+    module NonAlphanumeric
+      def self.call(input, options = DEFAULT_OPTIONS)
+        regex = /[^#{options[:separator]}a-z0-9]/sim
+        input.gsub(regex, options[:separator])
+      end
+    end
+  end
+end

data/lib/permalink/normalizations/transliteration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Permalink
+  module Normalizations
+    module Transliteration
+      def self.call(input, _options = nil)
+        input
+          .unicode_normalize(:nfkd)
+          .gsub(/[^\x00-\x7F]/, "")
+          .to_s
+      end
+    end
+  end
+end

data/lib/permalink/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Permalink
   module Version
-    MAJOR = 1
-    MINOR = 2
+    MAJOR = 2
+    MINOR = 1
     PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end