active_permalink 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da5262296637cea151a12211bbff29a02fdf70ef
+  data.tar.gz: 9a9c55ff2ded150edd62fa0e9fe65de96f4e528e
+SHA512:
+  metadata.gz: 6319685df9f33bb57a64b3e99f13575c23e427caf4427f249f6ed9c25a795cd6bfe045e7a260541f8d84424b3f0452b51f67d465f603e4cc761092ebf04d4cb5
+  data.tar.gz: '04388c30e998ca73cbeca70c729862207c4d21983fa22054887582571d4420d43ddfb1c0be7b99a5086af3bdeae58510cef6d8bd23179f9f1d8f2e0b0eacfbd4'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jonian@hardpixel.eu. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_permalink.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jonian Guveli
+
+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 @@
+# ActivePermalink
+
+Add SEO friendly permalinks to ActiveRecord model with history support.
+
+[![Gem Version](https://badge.fury.io/rb/active_permalink.svg)](https://badge.fury.io/rb/active_permalink)
+[![Build Status](https://travis-ci.org/hardpixel/active-permalink.svg?branch=master)](https://travis-ci.org/hardpixel/active-permalink)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7669a285b9da35143c1f/maintainability)](https://codeclimate.com/github/hardpixel/active-permalink/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_permalink'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_permalink
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/active-permalink. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActivePermalink project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hardpixel/active-permalink/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/active_permalink.rb

@@ -0,0 +1,18 @@
+require 'active_record'
+require 'active_delegate'
+require 'babosa'
+require 'active_permalink/version'
+
+module ActivePermalink
+  extend ActiveSupport::Autoload
+
+  # Autoload base modules
+  autoload :Permalink
+  autoload :Generator
+  autoload :Sluggable
+  autoload :Loader
+end
+
+ActiveSupport.on_load(:active_record) do
+  include ActivePermalink::Loader
+end

data/lib/active_permalink/generator.rb

@@ -0,0 +1,61 @@
+module ActivePermalink
+  class Generator
+    def initialize(record, field, old_value, new_value, options={})
+      @record    = record
+      @field     = field
+      @old_value = old_value
+      @new_value = new_value
+      @options   = options
+      @translit  = options[:transliterations]
+      @scope     = options.fetch :scope, :global
+    end
+
+    def slug_candidates
+      @new_value.present? ? @new_value : @record.send(@field)
+    end
+
+    def slug_from_column
+      @column_slug ||= slug_candidates.to_slug.normalize(transliterations: @translit).to_s
+    end
+
+    def scope_unique_slug
+      unique = slug_from_column
+      index  = 1
+
+      while not Permalink.where(scope: @scope, slug: unique).count.zero?
+        unique = "#{slug_from_column}-#{(index += 1)}"
+      end
+
+      unique
+    end
+
+    def deactivate_old_permalink
+      unless @record.active_permalink.new_record?
+        parameters = { slug: @old_value, active: true }
+        permalink  = @record.old_permalinks.rewhere(parameters).first
+
+        permalink.update_column(:active, false) unless permalink.nil?
+      end
+    end
+
+    def reassign_old_permalink
+      permalink = @record.old_permalinks.find_by(slug: slug_from_column)
+
+      unless permalink.nil?
+        permalink.update(active: true)
+        permalink
+      end
+    end
+
+    def build_new_permalink
+      @record.build_active_permalink(slug: scope_unique_slug, scope: @scope, active: true)
+    end
+
+    def new_permalink
+      deactivate_old_permalink
+      @record.reload_active_permalink
+
+      reassign_old_permalink || build_new_permalink
+    end
+  end
+end

data/lib/active_permalink/loader.rb

@@ -0,0 +1,26 @@
+module ActivePermalink
+  module Loader
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_permalink(field, options={})
+        include ActiveDelegate
+        include Sluggable
+
+        assoc_opts = { as: :sluggable, class_name: 'ActivePermalink::Permalink', dependent: :destroy }
+        has_many :permalinks, assoc_opts
+        has_many :old_permalinks, -> { where active: false }, assoc_opts
+
+        has_one :active_permalink, -> { where active: true }, assoc_opts.merge(autosave: true)
+        delegate_attribute :slug, :string, to: :active_permalink
+
+        before_save do |record|
+          if slug.blank? or slug_changed?
+            premalink_generator   = Generator.new(record, field, slug_was, slug, options)
+            self.active_permalink = premalink_generator.new_permalink
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_permalink/permalink.rb

@@ -0,0 +1,15 @@
+module ActivePermalink
+  class Permalink < ActiveRecord::Base
+    # Set table name
+    self.table_name = 'permalinks'
+
+    # Set default scope
+    default_scope { order created_at: :desc }
+
+    # Set custom scopes
+    scope :global, -> { where scope: :global }
+
+    # Belongs associations
+    belongs_to :sluggable, polymorphic: true, optional: true
+  end
+end

data/lib/active_permalink/sluggable.rb

@@ -0,0 +1,48 @@
+module ActivePermalink
+  module Sluggable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def find_by_slug(value)
+        _find_by_permalinks_slug(value)
+      end
+
+      def find_by_slug!(value)
+        _find_by_permalinks_slug(value, true)
+      end
+
+      private
+
+        def _find_by_permalinks_slug(value, raise_error=false)
+          method = raise_error ? :find_by! : :find_by
+          record = includes(:permalinks).send(method, permalinks: { slug: value })
+
+          unless record.nil?
+            record.found_by_slug = value
+          end
+
+          record
+        end
+    end
+
+    def found_by_slug
+      @found_by_slug
+    end
+
+    def found_by_slug=(value)
+      @found_by_slug = value
+    end
+
+    def found_by_slug?
+      !found_by_slug.nil?
+    end
+
+    def needs_redirect?
+      found_by_slug? and found_by_slug != slug
+    end
+
+    def old_slugs
+      @old_slugs ||= old_permalinks.pluck(:slug)
+    end
+  end
+end

data/lib/active_permalink/version.rb

@@ -0,0 +1,3 @@
+module ActivePermalink
+  VERSION = '0.1.0'
+end

data/lib/generators/active_permalink/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module ActivePermalink
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc 'Generates migrations to add permalinks tables.'
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_migration_file
+      migration_template 'migration.rb', 'db/migrate/create_permalinks.rb'
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+  end
+end

data/lib/generators/active_permalink/templates/migration.rb

@@ -0,0 +1,16 @@
+class CreatePermalinks < ActiveRecord::Migration[5.0]
+  def change
+    create_table :permalinks do |t|
+      t.string  :scope,          default: 'global'
+      t.boolean :active,         default: true
+      t.string  :slug,           null: false
+      t.integer :sluggable_id,   null: false
+      t.string  :sluggable_type, null: false
+
+      t.timestamps
+    end
+
+    add_index :permalinks, [:scope, :slug], unique: true
+    add_index :permalinks, [:sluggable_id, :sluggable_type], name: :index_permalinks_on_sluggable_attribute
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: active_permalink
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonian Guveli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: active_delegate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: babosa
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Add SEO friendly permalinks to ActiveRecord model with history support.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_permalink.rb
+- lib/active_permalink/generator.rb
+- lib/active_permalink/loader.rb
+- lib/active_permalink/permalink.rb
+- lib/active_permalink/sluggable.rb
+- lib/active_permalink/version.rb
+- lib/generators/active_permalink/install_generator.rb
+- lib/generators/active_permalink/templates/migration.rb
+homepage: https://github.com/hardpixel/active-permalink
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Add permalinks to ActiveRecord models
+test_files: []