acts_as_permalink 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4633aa91665c5b810b32f1c2e748674d74c5d66c
-  data.tar.gz: e06d13bcdb3f1a032b71ff1659b391eb5dedb945
+  metadata.gz: a688f2777a3102e366b6caa9c9b4a820dcbe1dbd
+  data.tar.gz: aa13d167b062e6aa5d68c81e717fe2be53dc7b33
 SHA512:
-  metadata.gz: 663b5f0f6df7dd2527a32b17f090118a0213c8c280db92bc5abfd5c2cce23b06bd1fe73fdf49c830135775117369509cf727710cfea9e09b39cb2f793921f0e7
-  data.tar.gz: 20c6178a41efd0379dff74a4f3151f7116e06593cb9ada693253ef0c91b4a0589431cc4d5ed4f7ee37b8ea3d9c05b6422df553e3fb7c627187672ce1227165c2
+  metadata.gz: 5dfcbb6895a593a348402b31cfae60bc08df806b55285110c9b239434ea16aac07297ce20c5592365a7ad009544c1e5c6ac53c7e1e29026160cebca9943ad385
+  data.tar.gz: 214c634039408be7bbb7b1751a7f894f1358687f69f32c96593526461db0e1b8feae1bd624110ad93d358ad8e8e22b74a86fadfb64db14f63365db843de86585

data/{README.markdown → README.md}

@@ -21,6 +21,12 @@ Or stand alone:
 $ gem install acts_as_permalink
 ```
 
+## Requirements
+
+* Ruby 2.0 or higher
+* Rails 4.0 or higher
+
+
 ## Usage
 
 This gem works with ActiveRecord, and by convention looks for a `title` method and a `permalink` string field on the model:
@@ -68,6 +74,8 @@ $ bundle exec rspec
 
 ## Changelog
 
+* 1.0.0  --  Internal refactor. Require Rails 4.0 or above and Ruby 2.0 or above. Full release, only took 6 years!
+
 * 0.6.0  --  Switch default replacement character to a dash, but allow the `underscore: true` property to go back to the old format
 
 * 0.5.0  --  Fix bugs in `max_length` property which would sometimes allow the permalink to be longer than the value

data/lib/acts_as_permalink.rb

@@ -1,69 +1,47 @@
-# ActsAsPermalink
-module Acts #:nodoc:
-  module Permalink #:nodoc:
+require "string"
+require "config"
 
-    def self.included(base)
-      base.extend ClassMethods
-    end
+module Acts
+  module Permalink
+    extend ActiveSupport::Concern
 
-    module ClassMethods
+    class_methods do
       def acts_as_permalink(options={})
-        # Read and scrub option for the column which will save the permalink
-        self.base_class.instance_variable_set('@permalink_column_name', options[:to].try(:to_sym) || :permalink)
-
-        # Read and scrub the option for the column or function which will generate the permalink
-        self.base_class.instance_variable_set('@permalink_source', (options[:from].try(:to_sym) || :title))
-
-        # Set the underscore character
-        self.base_class.instance_variable_set('@permalink_underscore', options[:underscore])
+        cattr_accessor :acts_as_permalink_config
+        self.acts_as_permalink_config = Acts::Permalink::Config.new(options)
 
-        # Read and validate the maximum length of the permalink
-        max_length = options[:max_length].to_i rescue 0
-        max_length = 60 unless max_length && max_length > 0
-        self.base_class.instance_variable_set('@permalink_length', max_length)
-
-        if Rails.version >= "3"
-          before_validation :update_permalink, on: :create
-        else
-          before_validation_on_create :update_permalink
-        end
+        before_validation :update_permalink, on: :create
+        validates_uniqueness_of self.acts_as_permalink_config.to
+        attr_readonly self.acts_as_permalink_config.to
+      end
+    end
 
-        validates_uniqueness_of @permalink_column_name
-        attr_readonly @permalink_column_name
+    included do
+      def to_param
+        self.public_send(self.class.base_class.acts_as_permalink_config.to)
+      end
 
-        include Acts::Permalink::InstanceMethods
-        extend Acts::Permalink::SingletonMethods
+      def update_permalink
+        self.public_send("#{ self.class.base_class.acts_as_permalink_config.to }=", build_permalink)
+        true
       end
 
-      # Returns the unique permalink string for the passed in object.
-      def generate_permalink_for(obj)
-        column_name = obj.class.base_class.instance_variable_get('@permalink_column_name')
-        text = obj.send(obj.class.base_class.instance_variable_get('@permalink_source'))
-        max_length = obj.class.base_class.instance_variable_get('@permalink_length')
-        separator = obj.class.base_class.instance_variable_get('@permalink_underscore') ? "_" : "-"
+      def build_permalink
+        config = self.class.base_class.acts_as_permalink_config
 
-        # If it is blank then generate a random link
-        if text.blank?
-          text = obj.class.base_class.to_s.downcase + rand(10000).to_s
-
-        # If it is not blank, scrub
-        else
-          text = text.downcase.strip                  # make the string lowercase and scrub white space on either side
-          text = text.gsub(/[^a-z0-9\w]/, separator)  # make any character that is not nupermic or alphabetic into a special character
-          text = text.squeeze(separator)              # removes any consecutive duplicates of the special character
-          text = text[0...max_length]                 # trim to length
-          text = text.sub(Regexp.new("^#{ separator }+"), "")  # remove leading special characters
-          text = text.sub(Regexp.new("#{ separator }+$"), "")  # remove trailing special characters
-        end
+        text = self.public_send(config.from)
+        text = [self.class.base_class.to_s, rand(10000)].join(config.separator) if text.blank?
+        text = text.to_permalink(separator: config.separator, max_length: config.max_length)
 
         # Attempt to find the object by the permalink, and if so there is a collision and we need to de-collision it
-        if obj.class.base_class.where(column_name => text).first
+        if self.class.base_class.where(config.to => text).first
           candidate_text = nil
 
+          # This will fail if you have a million records with the same name
           (1..999999).each do |num|
-            suffix = "#{ separator }#{ num }"
-            candidate_text = [text[0...(max_length - suffix.length)], suffix].join("")
-            break unless obj.class.base_class.where(column_name => candidate_text).first
+            suffix = "#{ config.separator }#{ num }"
+            candidate_text = [text[0...(config.max_length - suffix.length)], suffix].join("")
+            break unless self.class.base_class.where(config.to => candidate_text).first
           end
 
           text = candidate_text
@@ -73,22 +51,6 @@ module Acts #:nodoc:
       end
     end
 
-    module SingletonMethods
-    end
-
-    module InstanceMethods
-
-      # Override this method so that find searches by permalink and not by id
-      def to_param
-        self.send(self.class.base_class.instance_variable_get('@permalink_column_name'))
-      end
-
-      # Generate the permalink and assign it directly via callback
-      def update_permalink
-        self.send("#{ self.class.base_class.instance_variable_get('@permalink_column_name') }=", self.class.base_class.generate_permalink_for(self))
-        true
-      end
-    end
   end
 end
 

data/lib/acts_as_permalink/version.rb

@@ -1,5 +1,5 @@
 module Acts
   module Permalink
-    VERSION = "0.6.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/config.rb

@@ -0,0 +1,18 @@
+module Acts
+  module Permalink
+    class Config
+      attr_reader :to, :from, :separator, :max_length
+
+      def initialize(options={})
+        @config = options.with_indifferent_access
+
+        @to = @config[:to].try(:to_sym) || :permalink
+        @from = @config[:from].try(:to_sym) || :title
+        @separator = @config[:underscore] ? "_" : "-"
+
+        @max_length = @config[:max_length].to_i rescue 0
+        @max_length = 60 unless @max_length > 0
+      end
+    end
+  end
+end

data/lib/string.rb

@@ -0,0 +1,14 @@
+class String
+  def to_permalink(max_length: nil, separator: "-")
+    text = self.dup
+
+    text = text.downcase.strip                           # make the string lowercase and scrub white space on either side
+    text = text.gsub(/[^a-z0-9]/, separator)             # make any character that is not nupermic or alphabetic into a special character
+    text = text.squeeze(separator)                       # removes any consecutive duplicates of the special character
+    text = text.sub(Regexp.new("^#{ separator }+"), "")  # remove leading special characters
+    text = text.sub(Regexp.new("#{ separator }+$"), "")  # remove trailing special characters
+    text = text[0...max_length] if max_length            # trim to length
+
+    text
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_permalink
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Kevin McPhillips
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,10 +75,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - lib/acts_as_permalink.rb
 - lib/acts_as_permalink/version.rb
+- lib/config.rb
+- lib/string.rb
 homepage: http://github.com/kmcphillips/acts_as_permalink
 licenses: []
 metadata: {}