acts_as_permalink 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79b83c3c0ba10ccec249d1c405e3698cdd970576
-  data.tar.gz: 049e0167743b55c9b3859362fe2815ba68dc1fb2
+  metadata.gz: 0d55be1df515e3a84a052fda0f34d2889d1c5969
+  data.tar.gz: ef5a117a72ff179f479bb51dd21be2ec5c086ba0
 SHA512:
-  metadata.gz: 8f110218a78e430d5f6bfa50809856727c90db58a0356f683d2a6b02e85cd5d6c3e0a961e8f0503a7b2d53c9b8fbc0585048321adfa10fde4ff5d5e44adcebc8
-  data.tar.gz: 634054054c3f9b20f7db283ced3b00f72833dda4b90cb6e466fd9e4358c12b1ce34ea99d60c927a08c9e3c7d90b6fccb69c4d7a4c7be8ce61c011866fac05121
+  metadata.gz: 5ba4be9a30fe6aa69be591befc022df3b6107c46371fe6f1d5daaae6fd15bec50666709dc3b1d7b2a2a1fadfcf815b4b6d163a8bebc43f91f08749b562a0d093
+  data.tar.gz: 8d3c9bd3cde2c57c90b90ea1c2214db561dceacc089cf61249376c923dd55084447cbc0d63c48fddf198f68c7d9c21f19156b8185c8e1830290a5533d79a4927

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 [name of plugin creator]
+Copyright (c) 2016 Kevin McPhillips
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -4,7 +4,7 @@
 
 Manages permalink field on an ActiveRecord model to be used in place of the id field in Rails.
 
-Written by [Kevin McPhillips](https://github.com/kmcphillips) ([github@kevinmcphillips.ca](mailto:github@kevinmcphillips.ca))
+[Kevin McPhillips](https://github.com/kmcphillips) ([github@kevinmcphillips.ca](mailto:github@kevinmcphillips.ca))
 
 
 ## Installation
@@ -29,7 +29,7 @@ $ gem install acts_as_permalink
 
 ## Usage
 
-This gem works with ActiveRecord, and by convention looks for a `title` method and a `permalink` string field on the model:
+This gem works with `ActiveRecord`, and by convention looks for a `title` method and a `permalink` string field on the model:
 
 And then just call it in your model:
 
@@ -68,6 +68,20 @@ class User < ActiveRecord::Base
 end
 ```
 
+Permalinks can be generated using `String#to_permalink` like so:
+
+```ruby
+"Hello, world!".to_permalink
+> "hello_world"
+```
+
+And the patch to string can be avoided by doing a `require: "base"` in the `Gemfile` of the application. Conversion is always available through:
+
+```ruby
+Acts::Permalink::Conversion.convert("Hello, world!")
+> "hello_world"
+```
+
 
 ## Tests
 
@@ -78,6 +92,8 @@ $ bundle exec rspec
 
 ## Changelog
 
+* 1.2.1  --  Separate out `String#to_permalink` patch. Can `require: 'base'`.
+
 * 1.2.0  --  Add the `allow_update` flag. (by @garethson)
 
 * 1.1.0  --  Allow the option to `scope: :column_id` for uniquness.

data/lib/acts_as_permalink.rb

@@ -1,72 +1,2 @@
 require "string"
-require "config"
-
-module Acts
-  module Permalink
-    extend ActiveSupport::Concern
-
-    class_methods do
-      def acts_as_permalink(options={})
-        cattr_accessor :acts_as_permalink_config
-        self.acts_as_permalink_config = Acts::Permalink::Config.new(options)
-
-        before_validation :update_permalink, on: :create
-
-        unless self.acts_as_permalink_config.allow_update
-          attr_readonly self.acts_as_permalink_config.to
-        end
-
-        if self.acts_as_permalink_config.scope
-          validates self.acts_as_permalink_config.to, uniqueness: {scope: self.acts_as_permalink_config.scope}
-        else
-          validates self.acts_as_permalink_config.to, uniqueness: true
-        end
-
-
-        include Acts::Permalink::InstanceMethods
-      end
-    end
-
-    module InstanceMethods
-      def to_param
-        self.public_send(self.class.base_class.acts_as_permalink_config.to)
-      end
-
-      def update_permalink
-        self.public_send("#{ self.class.base_class.acts_as_permalink_config.to }=", build_permalink)
-        true
-      end
-
-      def build_permalink
-        config = self.class.base_class.acts_as_permalink_config
-
-        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)
-
-        # scope it if one is present
-        conditions = {}
-        conditions[config.scope] = self.public_send(config.scope) if config.scope.present?
-
-        # Attempt to find the object by the permalink, and if so there is a collision and we need to de-collision it
-        if self.class.base_class.where(conditions.merge(config.to => text)).any?
-          candidate_text = nil
-
-          # This will fail if you have a million records with the same name
-          (1..999999).each do |num|
-            suffix = "#{ config.separator }#{ num }"
-            candidate_text = [text[0...(config.max_length - suffix.length)], suffix].join("")
-            break unless self.class.base_class.where(conditions.merge(config.to => candidate_text)).any?
-          end
-
-          text = candidate_text
-        end
-
-        text
-      end
-    end
-
-  end
-end
-
-ActiveRecord::Base.send(:include, Acts::Permalink)
+require "base"

data/lib/acts_as_permalink/version.rb

@@ -1,5 +1,5 @@
 module Acts
   module Permalink
-    VERSION = "1.2.0"
+    VERSION = "1.2.1"
   end
 end

data/lib/base.rb

@@ -0,0 +1,5 @@
+require "config"
+require "conversion"
+require "concern"
+
+ActiveRecord::Base.send(:include, Acts::Permalink)

data/lib/concern.rb

@@ -0,0 +1,67 @@
+module Acts
+  module Permalink
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_permalink(options={})
+        cattr_accessor :acts_as_permalink_config
+        self.acts_as_permalink_config = Acts::Permalink::Config.new(options)
+
+        before_validation :update_permalink, on: :create
+
+        unless self.acts_as_permalink_config.allow_update
+          attr_readonly self.acts_as_permalink_config.to
+        end
+
+        if self.acts_as_permalink_config.scope
+          validates self.acts_as_permalink_config.to, uniqueness: {scope: self.acts_as_permalink_config.scope}
+        else
+          validates self.acts_as_permalink_config.to, uniqueness: true
+        end
+
+
+        include Acts::Permalink::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      def to_param
+        self.public_send(self.class.base_class.acts_as_permalink_config.to)
+      end
+
+      def update_permalink
+        self.public_send("#{ self.class.base_class.acts_as_permalink_config.to }=", build_permalink)
+        true
+      end
+
+      def build_permalink
+        config = self.class.base_class.acts_as_permalink_config
+
+        text = self.public_send(config.from)
+        text = [self.class.base_class.to_s, rand(10000)].join(config.separator) if text.blank?
+        text = Acts::Permalink::Conversion.convert(text, separator: config.separator, max_length: config.max_length)
+
+        # scope it if one is present
+        conditions = {}
+        conditions[config.scope] = self.public_send(config.scope) if config.scope.present?
+
+        # Attempt to find the object by the permalink, and if so there is a collision and we need to de-collision it
+        if self.class.base_class.where(conditions.merge(config.to => text)).any?
+          candidate_text = nil
+
+          # This will fail if you have a million records with the same name
+          (1..999999).each do |num|
+            suffix = "#{ config.separator }#{ num }"
+            candidate_text = [text[0...(config.max_length - suffix.length)], suffix].join("")
+            break unless self.class.base_class.where(conditions.merge(config.to => candidate_text)).any?
+          end
+
+          text = candidate_text
+        end
+
+        text
+      end
+    end
+
+  end
+end

data/lib/conversion.rb

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

data/lib/string.rb

@@ -1,15 +1,5 @@
 class String
   def to_permalink(max_length: nil, separator: "-")
-    text = self.dup
-
-    text = ActiveSupport::Inflector.transliterate(text)  # convert to simplified characters
-    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
+    Acts::Permalink::Conversion.convert(self.dup, max_length: max_length, separator: separator)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_permalink
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Kevin McPhillips
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-18 00:00:00.000000000 Z
+date: 2016-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -93,7 +93,10 @@ files:
 - Rakefile
 - lib/acts_as_permalink.rb
 - lib/acts_as_permalink/version.rb
+- lib/base.rb
+- lib/concern.rb
 - lib/config.rb
+- lib/conversion.rb
 - lib/string.rb
 homepage: http://github.com/kmcphillips/acts_as_permalink
 licenses: []