active_permalink 0.3.2 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 243ba41f7bbc808001e4aec17f7212499f5c1fdc938b2e20b72db13f25febca0
-  data.tar.gz: 32b11a18881be60c779b2ad58c96231d21c8ce5e2377a0dfbc6ec8a06cfb8f09
+  metadata.gz: 5fa20c1f3b8d87d139d4a4dd071f4eaf254e920f9c548d8972bee1d039d50447
+  data.tar.gz: fcfc097109ae5c2a061d248047d3afce7846281caca1af726531d957b8ce19a6
 SHA512:
-  metadata.gz: 226c6d785ea23b9bd67d8dea472188985cc992b5406e50163219e9318698eec5cb8612829cddb018e255992058331b3865f39dc55a1a25f2c7dd52c01e1572c1
-  data.tar.gz: de0bc4c7f9201cc9bdd33ff2cb26505ad603ea45c5107f894302f78ebe7f898624a381b153d1429deff36ce00ebe7a8fa041238a0cf820d31f2ac1e202c26c3f
+  metadata.gz: 983b44808444eac00eec9208294601a8dd354e63ea2fe301b1ac6e18e704923d323dab9cb9a04ac1a0ae4ef3d799bdba1cd475083fe82e6b6362853b57e6ea69
+  data.tar.gz: 73f7a8cf127e57656898024e6f6c9f80b7111a1d32a347cfc585ad3dd41327482f428cc826e7dd8c77557298cf8124d7cd196c3d36136389c90bbfdfc2a3a9a9

data/lib/active_permalink.rb

@@ -1,4 +1,3 @@
-require 'stringex'
 require 'active_record'
 require 'active_delegate'
 require 'active_permalink/version'
@@ -12,6 +11,17 @@ module ActivePermalink
   autoload :Localizer
   autoload :Querying
   autoload :Loader
+  autoload :Config
+
+  class << self
+    def config
+      @config ||= Config.new
+    end
+
+    def setup
+      yield config
+    end
+  end
 end
 
 ActiveSupport.on_load(:active_record) do

data/lib/active_permalink/config.rb

@@ -0,0 +1,27 @@
+require 'active_support/configurable'
+
+module ActivePermalink
+  class Config
+    include ActiveSupport::Configurable
+
+    config_accessor(:class_name) { 'ActivePermalink::Permalink' }
+    config_accessor(:querying) { true }
+    config_accessor(:localized) { false }
+    config_accessor(:locale_column) { :locale }
+    config_accessor(:locale_accessors) { true }
+    config_accessor(:fallthrough_accessors) { false }
+    config_accessor(:fallbacks) { false }
+
+    def options_for(**options)
+      options.reverse_merge(
+        class_name:            class_name,
+        querying:              querying,
+        localized:             localized,
+        locale_column:         locale_column,
+        locale_accessors:      locale_accessors,
+        fallthrough_accessors: fallthrough_accessors,
+        fallbacks:             fallbacks
+      )
+    end
+  end
+end

data/lib/active_permalink/generator.rb

@@ -1,6 +1,22 @@
+require 'any_ascii'
+
 module ActivePermalink
   class Generator
+    class << self
+      def generate(record, value, locale = nil)
+        return if value.nil? && !record.slug_should_generate?
+
+        options   = record.permalink_options.merge(locale: locale)
+        generator = Generator.new(record, options)
+        generator.generate(value)
+
+        record.permalinks = generator.permalinks
+      end
+    end
+
     def initialize(record, options = {})
+      options[:locale] = options.fetch(:locale, I18n.locale).to_s
+
       @record  = record
       @options = options
       @field   = options[:field]
@@ -22,7 +38,7 @@ module ActivePermalink
     private
 
     def locale
-      I18n.locale.to_s
+      @options[:locale]
     end
 
     def changed?
@@ -75,7 +91,10 @@ module ActivePermalink
     def slug_from_column
       @slug_from_column ||= begin
         value = @new_value.presence || @record.send(@field)
-        value.to_s.to_url
+        return if value.blank?
+
+        value = AnyAscii.transliterate(value)
+        value.parameterize
       end
     end
 

data/lib/active_permalink/loader.rb

@@ -3,18 +3,13 @@ module ActivePermalink
     extend ActiveSupport::Concern
 
     class_methods do
-      def has_permalink(field, localized: false, locale_column: :locale, **options)
-        include ActiveDelegate
+      def has_permalink(field, **options)
+        options = ActivePermalink.config.options_for(field: field, **options)
 
         class_attribute :permalink_options
+        self.permalink_options = options
 
-        self.permalink_options = options.merge(
-          field:         field,
-          localized:     localized,
-          locale_column: locale_column
-        )
-
-        with_options(as: :sluggable, class_name: 'ActivePermalink::Permalink') do
+        with_options(as: :sluggable, class_name: options[:class_name]) do
           has_many :permalinks,
             dependent: :destroy,
             autosave: true
@@ -22,24 +17,22 @@ module ActivePermalink
           has_many :old_permalinks,
             -> { inactive }
 
-          if localized
+          if options[:localized]
             has_many :active_permalinks,
               -> { active }
 
             has_one :active_permalink,
-              -> { active.where(locale_column => I18n.locale) }
+              -> { active.where(options[:locale_column] => I18n.locale) }
           else
             has_one :active_permalink,
               -> { active }
           end
         end
 
-        delegate_attribute :slug, :string,
-          to: :active_permalink
-
         include Persistence
-        include Querying
-        include Localizer if localized
+
+        include Querying  if options[:querying]
+        include Localizer if options[:localized]
       end
     end
   end

data/lib/active_permalink/localizer.rb

@@ -3,76 +3,91 @@ module ActivePermalink
     extend ActiveSupport::Concern
 
     included do
-      def permalink_reader
-        PermalinkReader.new(permalinks, permalink_options)
+      def slug_backend
+        @slug_backend ||= PermalinkBackend.new(self)
       end
 
-      def slug?
-        permalink_reader.exists?
+      alias permalink_reader slug_backend
+
+      def slug?(locale: nil)
+        slug_backend.exists?(locale || I18n.locale)
       end
 
-      def slug
-        permalink_reader.value
+      def slug(locale: nil)
+        slug_backend.read(locale || I18n.locale)
       end
 
-      I18n.available_locales.each do |locale|
-        define_method(:"slug_#{locale}?") do
-          I18n.with_locale(locale) { slug? }
-        end
+      def slug=(value, locale: nil)
+        slug_backend.write(value, locale || I18n.locale)
+      end
 
-        define_method(:"slug_#{locale}") do
-          I18n.with_locale(locale) { slug }
-        end
+      if permalink_options[:locale_accessors]
+        include SlugLocaleAccessors
+      elsif permalink_options[:fallthrough_accessors]
+        include SlugFallthroughAccessors
+      end
 
-        define_method(:"slug_#{locale}=") do |value|
-          I18n.with_locale(locale) { send(:slug=, value) }
-        end
+      private
+
+      def _generate_permalink_slug(value)
+        slug_backend.write(value, I18n.locale)
       end
     end
 
-    class PermalinkReader
-      attr_reader :permalinks, :options
+    class InvalidLocale < I18n::InvalidLocale
+    end
+
+    class PermalinkBackend
+      attr_reader :record, :permalinks, :options
 
-      def initialize(permalinks, options)
-        @permalinks = permalinks
-        @options    = options
+      def initialize(record)
+        @record     = record
+        @options    = record.permalink_options
+        @permalinks = record.permalinks.to_a
       end
 
       def fallbacks?
         options[:fallbacks].present?
       end
 
-      def exists?
-        find_permalink(I18n.locale).present?
+      def exists?(locale)
+        enforce_available_locales!(locale)
+        find_permalink(locale).present?
+      end
+
+      def read(locale)
+        enforce_available_locales!(locale)
+        find_slug(locale)
       end
 
-      def value
-        find_slug(I18n.locale)
+      def write(value, locale)
+        enforce_available_locales!(locale)
+        update_slug(value, locale)
       end
 
       private
 
+      def enforce_available_locales!(locale)
+        return unless I18n.enforce_available_locales
+        return if I18n.available_locales.include?(locale.to_sym)
+
+        raise InvalidLocale.new(locale)
+      end
+
       def locale_column
         @options[:locale_column]
       end
 
-      def find_permalink(locale)
-        permalinks.find do |permalink|
-          permalink.send(locale_column) == locale.to_s
+      def find_permalink(*locales)
+        permalinks.select(&:active?).find do |permalink|
+          locale = permalink.send(locale_column)
+          locales.include?(locale.to_sym)
         end
       end
 
       def find_fallback(locale)
-        fallbacks = I18n.try(:fallbacks) || {}
-        fallbacks = fallbacks.fetch(locale, [I18n.default_locale])
-        permalink = nil
-
-        fallbacks.find do |fallback|
-          permalink = find_permalink(fallback)
-          permalink.present?
-        end
-
-        permalink
+        locales = I18n.fallbacks[locale]
+        find_permalink(*locales) if locales.present?
       end
 
       def find_slug(locale)
@@ -81,6 +96,53 @@ module ActivePermalink
 
         permalink.try(:slug)
       end
+
+      def update_slug(value, locale)
+        Generator.generate(record, value, locale)
+        @permalinks = record.permalinks.to_a
+      end
+    end
+
+    module SlugLocaleAccessors
+      extend ActiveSupport::Concern
+
+      included do
+        I18n.available_locales.each do |locale|
+          define_method(:"slug_#{locale}?") do
+            slug_backend.exists?(locale)
+          end
+
+          define_method(:"slug_#{locale}") do
+            slug_backend.read(locale)
+          end
+
+          define_method(:"slug_#{locale}=") do |value|
+            slug_backend.write(value, locale)
+          end
+        end
+      end
+    end
+
+    module SlugFallthroughAccessors
+      extend ActiveSupport::Concern
+
+      included do
+        method_name_regex = /\Aslug_([a-z]{2}(_[a-z]{2})?)(=?|\??)\z/.freeze
+
+        define_method :method_missing do |method_name, *arguments, **options, &block|
+          if method_name =~ method_name_regex
+            locale, suffix = $1.split('_')
+            locale = "#{locale}-#{suffix.upcase}" if suffix
+            public_send("slug#{$3}", *arguments, **options, locale: locale.to_sym)
+          else
+            super(method_name, *arguments, &block)
+          end
+        end
+
+        define_method :respond_to_missing? do |method_name, include_private = false|
+          (method_name =~ method_name_regex) || super(method_name, include_private)
+        end
+      end
     end
   end
 end

data/lib/active_permalink/permalink.rb

@@ -2,8 +2,6 @@ module ActivePermalink
   class Permalink < ActiveRecord::Base
     self.table_name = 'permalinks'
 
-    default_scope { order created_at: :desc }
-
     scope :global,   -> { where scope: :global }
     scope :active,   -> { where active: true }
     scope :inactive, -> { where active: false }

data/lib/active_permalink/persistence.rb

@@ -3,21 +3,42 @@ module ActivePermalink
     extend ActiveSupport::Concern
 
     included do
-      before_validation on: :create do
-        self.slug = slug
+      include ActiveDelegate
+
+      delegate_attribute :slug, :string,
+        to: :active_permalink
+
+      before_validation :slug_should_generate!,
+        on: [:create, :update],
+        if: :slug_needs_generate?
+
+      def slug=(value)
+        _generate_permalink_slug(value)
       end
 
-      after_update do
-        permalinks.reload
+      def old_slugs
+        @old_slugs ||= old_permalinks.pluck(:slug)
       end
 
-      def slug=(value)
-        return if value.nil? && !new_record?
+      def slug_should_generate?
+        @slug_should_generate == true
+      end
+
+      private
 
-        generator = Generator.new(self, permalink_options)
-        generator.generate(value)
+      def slug_needs_generate?
+        !slug? && send(:"#{permalink_options[:field]}_changed?")
+      end
+
+      def slug_should_generate!
+        @slug_should_generate = true
+        _generate_permalink_slug(self[:slug])
+      ensure
+        @slug_should_generate = false
+      end
 
-        self.permalinks = generator.permalinks
+      def _generate_permalink_slug(value)
+        Generator.generate(self, value)
       end
     end
   end

data/lib/active_permalink/querying.rb

@@ -36,10 +36,6 @@ module ActivePermalink
       found_by_slug? && found_by_slug != slug
     end
 
-    def old_slugs
-      @old_slugs ||= old_permalinks.pluck(:slug)
-    end
-
     class PermalinkLocator
       attr_reader :model, :options
 

data/lib/active_permalink/version.rb

@@ -1,3 +1,3 @@
 module ActivePermalink
-  VERSION = '0.3.2'
+  VERSION = '0.5.2'
 end

data/lib/generators/active_permalink/install_generator.rb

@@ -13,6 +13,10 @@ module ActivePermalink
       migration_template 'migration.rb', 'db/migrate/create_permalinks.rb'
     end
 
+    def create_config_file
+      template 'initializer.rb', 'config/initializers/active_permalink.rb'
+    end
+
     def self.next_migration_number(dirname)
       ::ActiveRecord::Generators::Base.next_migration_number(dirname)
     end

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

@@ -0,0 +1,8 @@
+ActivePermalink.setup do |config|
+  # config.class_name       = 'ActivePermalink::Permalink'
+  # config.querying         = true
+  # config.localized        = false
+  # config.locale_column    = :locale
+  # config.locale_accessors = true
+  # config.fallbacks        = false
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_permalink
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.2
 platform: ruby
 authors:
 - Jonian Guveli
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -45,19 +45,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: stringex
+  name: any_ascii
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +112,7 @@ files:
 - README.md
 - Rakefile
 - lib/active_permalink.rb
+- lib/active_permalink/config.rb
 - lib/active_permalink/generator.rb
 - lib/active_permalink/loader.rb
 - lib/active_permalink/localizer.rb
@@ -120,12 +121,13 @@ files:
 - lib/active_permalink/querying.rb
 - lib/active_permalink/version.rb
 - lib/generators/active_permalink/install_generator.rb
+- lib/generators/active_permalink/templates/initializer.rb
 - lib/generators/active_permalink/templates/migration.rb
 homepage: https://github.com/hardpixel/active-permalink
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Add permalinks to ActiveRecord models
 test_files: []