much-slug 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6372c10543d9dba9890742245b1166dd1465626c4f997c5fdf832edf10f62d9e
-  data.tar.gz: 05071c2003b22836474735f9f0fbb2cfbcb3daabdf197a00e62aba9f51300afb
+  metadata.gz: d01ea124052633b468872a2c8ab13273d39999bd8fa4a068fbb009c777b41451
+  data.tar.gz: c1f745df34088bfb001719692c5033deaef9346c857046e9f756da65859c7d23
 SHA512:
-  metadata.gz: 15d9851869d05018c136b65e0d11d91e834ae20af6fe8149b790aeee32607c2a01d2abd24c1f2f987b01c053556d33590768e9a58753163238c856fd1b458ad5
-  data.tar.gz: 91da2c4a9735b817a50238d9ce96842280d9a119c638acbe9188a73a3a7f5708f8af2fa942821c1c6de4ebd056e5806d0582cbb28db920ce77aa9b6bb0aa959a
+  metadata.gz: 95199593bb0065a2d17f926a910cd3175657522f07f07aac8b776c69289693cb4568d3f619f46aa96493763efa1d50250dd9260de0d2f886aaafb780704df984
+  data.tar.gz: d6cdb5f3e2b35665f59b8daf266cd560e3eded1dc30584519b45b2d2769f7db6f38e7d6a31a96d4b58f1792bc3481ce7471c4e687055138297e9d7f730c43164

data/.l.yml

@@ -0,0 +1,8 @@
+# https://github.com/redding/l.rb
+
+linters:
+  - name: "Rubocop"
+    cmd: "bundle exec rubocop"
+    extensions:
+      - ".rb"
+    cli_abbrev: "u"

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  much-style-guide:
+    - "lib/much-style-guide/rubocop.yml"

data/.ruby-version

@@ -0,0 +1 @@
+2.5.8

data/.t.yml

@@ -0,0 +1,4 @@
+- default_cmd: "bundle exec assert"
+  test_dir: "test"
+  test_file_suffixes:
+    - "_tests.rb"

data/Gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-ruby "~> 2.4"
+ruby "~> 2.5"
 
 gemspec
 
-gem "pry", "~> 0.12.2"
+gem "pry"

data/README.md

@@ -11,7 +11,7 @@ MuchSlug creates derived slug values on database records. Typically this means d
 Given a `:slug` field on a record:
 
 ```ruby
-class AddSlugToProjects < ActiveRecord::Migration[5.2]
+class AddSlugToProjects < ActiveRecord::Migration[6.1]
   def change
     add_column(:projects, :slug, :string, index: { unique: true })
   end
@@ -21,14 +21,12 @@ end
 Mix-in `MuchSlug::ActiveRecord` and configure:
 
 ```ruby
-require "much-slug/activerecord"
-
 class ProjectRecord < ApplicationRecord
   self.table_name = "projects"
 
   include MuchSlug::ActiveRecord
   has_slug(
-    source: -> { "#{self.id}-#{self.name}" },
+    source: -> { "#{id}-#{name}" },
   )
 
   # ...
@@ -66,18 +64,16 @@ project.slug # => "124-Do-The-Things"
 By default, the record attribute for a slug is `"slug"`. You can override this when configuring slugs:
 
 ```ruby
-require "much-slug/activerecord"
-
 class ProjectRecord < ApplicationRecord
   self.table_name = "projects"
 
   include MuchSlug::ActiveRecord
   has_slug(
-    source: -> { "#{self.id}-#{self.name}" },
+    source: -> { "#{id}-#{name}" },
   )
   has_slug(
     attribute: :full_slug
-    source:    -> { "#{self.id}-#{self.full_name}" },
+    source:    -> { "#{id}-#{full_name}" },
   )
 
   # ...
@@ -89,19 +85,17 @@ end
 By default, MuchSlug doesn't pre-process the slug value source before generating the slug value. You can specify a custom pre-processor by passing any Proc-like object:
 
 ```ruby
-require "much-slug/activerecord"
-
 class ProjectRecord < ApplicationRecord
   self.table_name = "projects"
 
   include MuchSlug::ActiveRecord
   has_slug(
-    source:       -> { "#{self.id}-#{self.name}" },
+    source:       -> { "#{id}-#{name}" },
     preprocessor: :downcase
   )
   has_slug(
     attribute:    :full_slug
-    source:       -> { "#{self.id}-#{self.full_name}" },
+    source:       -> { "#{id}-#{full_name}" },
     preprocessor: -> { |source_value| source_value[0..30] }
   )
 
@@ -114,14 +108,12 @@ end
 MuchSlug replaces any non-word characters with a separator. This helps make slugs URL-friendly. By default, MuchSlug uses `"-"` for the separator. You can specify a custom separator value when configuring slugs:
 
 ```ruby
-require "much-slug/activerecord"
-
 class ProjectRecord < ApplicationRecord
   self.table_name = "projects"
 
   include MuchSlug::ActiveRecord
   has_slug(
-    source:    -> { "#{self.id}.#{self.name}" },
+    source:    -> { "#{id}.#{name}" },
     separator: "."
   )
 
@@ -140,18 +132,16 @@ project.slug # => "123.Sprockets.2.0"
 By default, MuchSlug doesn't allow underscores in source values and treats them like non-word characters. This means it replaces underscores with the separator. You can override this to allow underscores when configuring slugs:
 
 ```ruby
-require "much-slug/activerecord"
-
 class ProjectRecord < ApplicationRecord
   self.table_name = "projects"
 
   include MuchSlug::ActiveRecord
   has_slug(
-    source: -> { "#{self.id}-#{self.name}" }
+    source: -> { "#{id}-#{name}" }
   )
   has_slug(
     attribute:         :full_slug
-    source:            -> { "#{self.id}-#{self.full_name}" },
+    source:            -> { "#{id}-#{full_name}" },
     allow_underscores: true
 
   # ...
@@ -183,7 +173,7 @@ project.slug # => "123-Sprockets-2-0"
 
 Add this line to your application's Gemfile:
 
-    gem 'much-slug'
+    gem "much-slug"
 
 And then execute:
 

data/lib/much-slug.rb

@@ -1,6 +1,9 @@
-require "much-slug/version"
+# frozen_string_literal: true
+
+require "much-slug/activerecord"
 require "much-slug/has_slug_registry"
 require "much-slug/slug"
+require "much-slug/version"
 
 module MuchSlug
   def self.default_attribute
@@ -12,7 +15,7 @@ module MuchSlug
   end
 
   def self.default_separator
-    "-".freeze
+    "-"
   end
 
   def self.default_allow_underscores
@@ -24,8 +27,8 @@ module MuchSlug
     true
   end
 
-  def self.has_slug_changed_slug_values(record_instance)
-    record_instance.class.much_slug_has_slug_registry.each do |attribute, entry|
+  def self.has_slug_changed_slug_values(record)
+    record.class.much_slug_has_slug_registry.each do |attribute, entry|
       # ArgumentError: no receiver given` raised when calling `instance_exec`
       # on non-lambda Procs, specifically e.g :downcase.to_proc.
       # Can't call `instance_eval` on stabby lambdas b/c `instance_eval` auto
@@ -33,9 +36,9 @@ module MuchSlug
       # lambdas may not expect that and will ArgumentError.
       slug_source_value =
         if entry.source_proc.lambda?
-          record_instance.instance_exec(&entry.source_proc)
+          record.instance_exec(&entry.source_proc)
         else
-          record_instance.instance_eval(&entry.source_proc)
+          record.instance_eval(&entry.source_proc)
         end
 
       slug_value =
@@ -43,9 +46,9 @@ module MuchSlug
           slug_source_value,
           preprocessor:      entry.preprocessor_proc,
           separator:         entry.separator,
-          allow_underscores: entry.allow_underscores
+          allow_underscores: entry.allow_underscores,
         )
-      next if record_instance.send(attribute) == slug_value
+      next if record.public_send(attribute) == slug_value
       yield attribute, slug_value
     end
   end

data/lib/much-slug/activerecord.rb

@@ -1,64 +1,63 @@
-require "much-plugin"
-require "much-slug"
+# frozen_string_literal: true
 
-module MuchSlug
-  module ActiveRecord
-    include MuchPlugin
+require "much-mixin"
+require "much-slug"
 
-    plugin_included do
-      @much_slug_has_slug_registry = MuchSlug::HasSlugRegistry.new
-    end
+module MuchSlug; end
 
-    plugin_class_methods do
-      def has_slug(
-            source:,
-            attribute: nil,
-            preprocessor: nil,
-            separator: nil,
-            allow_underscores: nil,
-            skip_unique_validation: false,
-            unique_scope: nil)
-        registered_attribute =
-          self.much_slug_has_slug_registry.register(
-            attribute: attribute,
-            source: source,
-            preprocessor: preprocessor,
-            separator: separator,
-            allow_underscores: allow_underscores,
-          )
+module MuchSlug::ActiveRecord
+  include MuchMixin
 
-        # since the slug isn't written until an after callback we can't always
-        # validate presence of it
-        validates_presence_of(registered_attribute, :on => :update)
+  mixin_class_methods do
+    def much_slug_has_slug_registry
+      @much_slug_has_slug_registry ||= MuchSlug::HasSlugRegistry.new
+    end
 
-        unless skip_unique_validation
-          validates_uniqueness_of(registered_attribute, {
-            :case_sensitive => true,
-            :scope          => unique_scope,
-            :allow_nil      => true,
-            :allow_blank    => true
-          })
-        end
+    def has_slug(
+          source:,
+          attribute:              nil,
+          preprocessor:           nil,
+          separator:              nil,
+          allow_underscores:      nil,
+          skip_unique_validation: false,
+          unique_scope:           nil)
+      registered_attribute =
+        much_slug_has_slug_registry.register(
+          attribute:         attribute,
+          source:            source,
+          preprocessor:      preprocessor,
+          separator:         separator,
+          allow_underscores: allow_underscores,
+        )
 
-        after_create :much_slug_has_slug_update_slug_values
-        after_update :much_slug_has_slug_update_slug_values
+      # since the slug isn't written until an after callback we can't always
+      # validate presence of it
+      validates_presence_of(registered_attribute, on: :update)
 
-        registered_attribute
+      unless skip_unique_validation
+        validates_uniqueness_of(
+          registered_attribute,
+          case_sensitive: true,
+          scope:          unique_scope,
+          allow_nil:      true,
+          allow_blank:    true,
+        )
       end
 
-      def much_slug_has_slug_registry
-        @much_slug_has_slug_registry
-      end
+      after_create :much_slug_has_slug_update_slug_values
+      after_update :much_slug_has_slug_update_slug_values
+
+      registered_attribute
     end
+  end
 
-    plugin_instance_methods do
-      private
+  mixin_instance_methods do
+    private
 
-      def much_slug_has_slug_update_slug_values
-        MuchSlug.has_slug_changed_slug_values(self) do |attribute, slug_value|
-          self.send("#{attribute}=", slug_value)
-          self.update_column(attribute, slug_value)
-        end
+    def much_slug_has_slug_update_slug_values
+      MuchSlug.has_slug_changed_slug_values(self) do |attribute, slug_value|
+        public_send("#{attribute}=", slug_value)
+        update_column(attribute, slug_value)
       end
     end
   end

data/lib/much-slug/has_slug_registry.rb

@@ -1,32 +1,45 @@
+# frozen_string_literal: true
+
 require "much-slug"
 
-module MuchSlug
-  class HasSlugRegistry < ::Hash
-    def initialize
-      super{ |h, k| h[k] = Entry.new }
-    end
+module MuchSlug; end
 
-    def register(
-          attribute:,
-          source:,
-          preprocessor:,
-          separator:,
-          allow_underscores:)
-      (attribute || MuchSlug.default_attribute).to_s.tap do |a|
-        if allow_underscores.nil?
-          allow_underscores = MuchSlug.default_allow_underscores
-        end
+class MuchSlug::HasSlugRegistry < ::Hash
+  def initialize
+    super(){ |h, k| h[k] = Entry.new }
+  end
 
-        entry = self[a]
-        entry.source_proc       = source.to_proc
-        entry.preprocessor_proc = (preprocessor || MuchSlug.default_preprocessor).to_proc
-        entry.separator         = separator || MuchSlug.default_separator
-        entry.allow_underscores = !!allow_underscores
+  def register(
+        attribute:,
+        source:,
+        preprocessor:,
+        separator:,
+        allow_underscores:)
+    attribute         = (attribute || MuchSlug.default_attribute).to_s
+    source_proc       = source.to_proc
+    preprocessor_proc = (preprocessor || MuchSlug.default_preprocessor).to_proc
+    separator ||= MuchSlug.default_separator
+    allow_underscores =
+      if allow_underscores.nil?
+        MuchSlug.default_allow_underscores
+      else
+        !!allow_underscores
       end
-    end
 
-    class Entry
-      attr_accessor :source_proc, :preprocessor_proc, :separator, :allow_underscores
-    end
+    entry = self[attribute]
+    entry.source_proc       = source_proc
+    entry.preprocessor_proc = preprocessor_proc
+    entry.separator         = separator
+    entry.allow_underscores = allow_underscores
+
+    attribute
   end
+
+  Entry =
+    Struct.new(
+      :source_proc,
+      :preprocessor_proc,
+      :separator,
+      :allow_underscores,
+    )
 end

data/lib/much-slug/slug.rb

@@ -1,18 +1,20 @@
-module MuchSlug
-  module Slug
-    def self.new(string, preprocessor:, separator:, allow_underscores: true)
-      regexp_escaped_sep = Regexp.escape(separator)
+# frozen_string_literal: true
 
-      slug = preprocessor.call(string.to_s.dup)
-      # Turn unwanted chars into the separator
-      slug.gsub!(/[^\w#{regexp_escaped_sep}]+/, separator)
-      # Turn underscores into the separator, unless allowing
-      slug.gsub!(/_/, separator) unless allow_underscores
-      # No more than one of the separator in a row.
-      slug.gsub!(/#{regexp_escaped_sep}{2,}/, separator)
-      # Remove leading/trailing separator.
-      slug.gsub!(/\A#{regexp_escaped_sep}|#{regexp_escaped_sep}\z/, "")
-      slug
-    end
+module MuchSlug; end
+
+module MuchSlug::Slug
+  def self.new(string, preprocessor:, separator:, allow_underscores: true)
+    regexp_escaped_sep = Regexp.escape(separator)
+
+    slug = preprocessor.call(string.to_s.dup)
+    # Turn unwanted chars into the separator
+    slug.gsub!(/[^\w#{regexp_escaped_sep}]+/, separator)
+    # Turn underscores into the separator, unless allowing
+    slug.gsub!(/_/, separator) unless allow_underscores
+    # No more than one of the separator in a row.
+    slug.gsub!(/#{regexp_escaped_sep}{2,}/, separator)
+    # Remove leading/trailing separator.
+    slug.gsub!(/\A#{regexp_escaped_sep}|#{regexp_escaped_sep}\z/, "")
+    slug
   end
 end

data/lib/much-slug/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MuchSlug
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/much-slug.gemspec

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "much-slug/version"
 
@@ -11,17 +13,18 @@ Gem::Specification.new do |gem|
   gem.summary     = "Friendly, human-readable identifiers for database records."
   gem.description = "Friendly, human-readable identifiers for database records."
   gem.homepage    = "https://github.com/redding/much-slug"
-  gem.license     = 'MIT'
+  gem.license     = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = "~> 2.4"
+  gem.required_ruby_version = "~> 2.5"
 
-  gem.add_dependency("much-plugin", ["~> 0.2.1"])
+  gem.add_development_dependency("ardb",             ["~> 0.29.2"])
+  gem.add_development_dependency("assert",           ["~> 2.19.3"])
+  gem.add_development_dependency("much-style-guide", ["~> 0.6.0"])
 
-  gem.add_development_dependency("assert", ["~> 2.18.1"])
-  gem.add_development_dependency("ardb",   ["~> 0.28.3"])
+  gem.add_dependency("much-mixin", ["~> 0.2.4"])
 end