encoded_id-rails 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cfa444903c74b47cf55b4c8aa45d862f6eecbe843ff0af9b987b713c4b226d4
-  data.tar.gz: 7f530fdd9cd3b8a83a308f45e236c92c2bbdaae394cc8b455178ce1ff3de9802
+  metadata.gz: 599b4c236c59881b00eefbe0feaf4fa6f1a04015573ba5d807f041ba2932e602
+  data.tar.gz: ff6ee760d956606accfb98a75be00cf04a545695e0dcce56e9eb271b1d824fee
 SHA512:
-  metadata.gz: e8e9be56253a8956f1a850905c6a9c53e33f7593d419c7348a158e8ff76e3a0285319c116b8a81bfb22d964ceec6aac85fcbe128b3a4ad8265b0b790be27b83b
-  data.tar.gz: bc63195e7d397c41350b80783526d1733e6109ddc9cd9cbace00d827ff95b19046b287030436da09e359bb3f92774efe702bc17dc4fea006192748463c5eb9b7
+  metadata.gz: 9f176effb4bc926a4aa61dcbb7d0ca0e88b972186438ffe03a96b68d5e78e1eb0b6a485efcad924aff2070097356b8ced016fb1da0253b38f1d9e80eef21e18e
+  data.tar.gz: 2f318e0a04cbd5a45fc3edca02c1a8e053590b70963f4b851f8aac150ea465018aea6f21d3f5951bf4c8f7e31bd650a05a8a46328c2ce0812e8e26d2d4e92099

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-10-11
+## [0.6.0] - 2022-12-21
+
+- Rename mixin to `Model`
+- Introduce optional mixins for overriding `#to_param`
+
+## [0.5.0] - 2022-12-21
+
+- `name_for_encoded_id_slug` no longer uses the return value from name but rather just uses the `class` `name`.
+- If you want to change the name used in the slug, override `name_for_encoded_id_slug`
+
+## [0.4.0] - 2022-12-18
+
+- Refactor internals, remove any methods not actually related to creating `encoded_id`, (eg `slugged_id` was removed).
+
+## [0.3.1] - 2022-12-15
+
+- Fix default config
+
+## [0.3.0] - 2022-12-15
+
+- Updates gem `encoded_id` dependency and fixes configuration
+
+## [0.2.0] - 2022-12-14
+
+- No notes...
+
+## [0.1.0] - 2022-11-17
 
 - Initial release

data/README.md

@@ -6,16 +6,16 @@ EncodedID lets you turn numeric or hex IDs into reversible and human friendly ob
 
 ```ruby
 class User < ApplicationRecord
-  include EncodedId::WithEncodedId
-  
+  include EncodedId::Model
+
   def name_for_encoded_id_slug
-    full_name.parameterize
+    full_name
   end
 end
 
-user = User.find_by_encoded_id("p5w9-z27j")  # => #<User id: 78>
-user.encoded_id  # => "p5w9-z27j"
-user.slugged_encoded_id  # => "bob-smith--p5w9-z27j"
+user = User.find_by_encoded_id("p5w9-z27j") # => #<User id: 78>
+user.encoded_id                             # => "p5w9-z27j"
+user.slugged_encoded_id                     # => "bob-smith--p5w9-z27j"
 ```
 
 # Features
@@ -85,21 +85,45 @@ You can configure:
 
 ### ActiveRecord model setup
 
-Include `EncodedId::WithEncodedId` in your model and optionally specify a encoded id salt (or not if using a global one):
+Include `EncodedId::Model` in your model and optionally specify a encoded id salt (or not if using a global one):
 
 ```ruby
 class User < ApplicationRecord
-  include EncodedId::WithEncodedId
-  
+  include EncodedId::Model
+
   # and optionally the model's salt
   def encoded_id_salt
     "my-user-model-salt"
   end
-  
+
   # ...
 end
 ```
 
+### Optional mixins
+
+You can optionally include one of the following mixins to add default overrides to `#to_param`.
+
+- `EncodedId::PathParam`
+- `EncodedId::SluggedPathParam`
+
+This is so that an instance of the model can be used in path helpers and 
+return the encoded ID string instead of the record ID by default.
+
+```ruby
+class User < ApplicationRecord
+  include EncodedId::Model
+  include EncodedId::SluggedPathParam
+
+  def name_for_encoded_id_slug
+    full_name
+  end
+end
+
+user = User.create(full_name: "Bob Smith")
+Rails.application.routes.url_helpers.user_path(user) # => "/users/bob-smith--p5w9-z27j"
+```
+
 ## Documentation
 
 ### `.find_by_encoded_id`
@@ -164,12 +188,13 @@ Otherwise override this method to return a salt specific to the model.
 
 ```ruby
 class User < ApplicationRecord
-  include EncodedId::WithEncodedId
-  
+  include EncodedId::Model
+
   def encoded_id_salt
     "my-user-model-salt"
   end
 end
+
 User.encoded_id_salt  # => "my-user-model-salt"
 ```
 
@@ -201,8 +226,8 @@ By default it calls `#name` on the instance, or if the instance does not respond
 
 ```ruby
 class User < ApplicationRecord
-  include EncodedId::WithEncodedId
-  
+  include EncodedId::Model
+
   # If User has an attribute `name`, that will be used for the slug, 
   # otherwise `user` will be used as determined by the class name.
 end
@@ -217,8 +242,8 @@ You can optionally override this method to define your own slug:
 
 ```ruby
 class User < ApplicationRecord
-  include EncodedId::WithEncodedId
-  
+  include EncodedId::Model
+
   def name_for_encoded_id_slug
     superhero_name
   end
@@ -232,11 +257,11 @@ user.slugged_encoded_id  # => "super-dev--37nw-8nh7"
 
 Simply add the mixin to your `ApplicationRecord`:
 
-```ruby 
+```ruby
 class ApplicationRecord < ActiveRecord::Base
   self.abstract_class = true
-  include EncodedId::WithEncodedId
-  
+  include EncodedId::Model
+
   ...
 end
 ```

data/Steepfile

@@ -1,5 +1,5 @@
 target :lib do
-  check "lib/encoded_id/rails"
+  check "lib/encoded_id"
   signature "sig"
 
   library "encoded_id"

data/lib/encoded_id/rails/{with_encoded_id.rb → model.rb}

@@ -5,7 +5,7 @@ require "encoded_id"
 
 module EncodedId
   module Rails
-    module WithEncodedId
+    module Model
       def self.included(base)
         base.extend(EncoderMethods)
         base.extend(FinderMethods)

data/lib/encoded_id/rails/path_param.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "encoded_id"
+
+module EncodedId
+  module Rails
+    module PathParam
+      def to_param
+        encoded_id
+      end
+    end
+  end
+end

data/lib/encoded_id/rails/slugged_path_param.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "encoded_id"
+
+module EncodedId
+  module Rails
+    module SluggedPathParam
+      def to_param
+        slugged_encoded_id
+      end
+    end
+  end
+end

data/lib/encoded_id/rails/version.rb

@@ -2,6 +2,6 @@
 
 module EncodedId
   module Rails
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/encoded_id/rails.rb

@@ -9,7 +9,9 @@ require_relative "rails/salt"
 require_relative "rails/encoder_methods"
 require_relative "rails/query_methods"
 require_relative "rails/finder_methods"
-require_relative "rails/with_encoded_id"
+require_relative "rails/path_param"
+require_relative "rails/slugged_path_param"
+require_relative "rails/model"
 
 module EncodedId
   module Rails
@@ -27,5 +29,7 @@ module EncodedId
   end
 
   # Expose directly on EncodedId
-  WithEncodedId = Rails::WithEncodedId
+  Model = Rails::Model
+  PathParam = Rails::PathParam
+  SluggedPathParam = Rails::SluggedPathParam
 end

data/sig/encoded_id/rails.rbs

@@ -2,6 +2,21 @@ module EncodedId
   module Rails
     VERSION: ::String
 
+    class Configuration
+      attr_accessor salt: ::String
+      attr_accessor group_separator: ::String
+      attr_accessor character_group_size: ::Integer
+      attr_accessor alphabet: ::EncodedId::Alphabet
+      attr_accessor id_length: ::Integer
+      attr_accessor slugged_id_separator: ::String
+
+      def initialize: () -> void
+    end
+
+    attr_reader self.configuration: Configuration
+
+    def self.configure: () { (Configuration config) -> void } -> void
+
     class Coder
       def initialize: (salt: ::String, id_length: ::Integer, character_group_size: ::Integer, separator: ::String, alphabet: ::EncodedId::Alphabet) -> void
       def encode: (::Integer | ::Array[::Integer]) -> String
@@ -18,17 +33,6 @@ module EncodedId
       def coder: -> ::EncodedId::ReversibleId
     end
 
-    class Configuration
-      attr_accessor salt: ::String
-      attr_accessor group_separator: ::String
-      attr_accessor character_group_size: ::Integer
-      attr_accessor alphabet: ::EncodedId::Alphabet
-      attr_accessor id_length: ::Integer
-      attr_accessor slugged_id_separator: ::String
-
-      def initialize: () -> void
-    end
-
     class Salt
       def initialize: (Class klass, ::String salt) -> void
 
@@ -56,10 +60,6 @@ module EncodedId
       attr_reader id: ::String?
     end
 
-    attr_reader self.configuration: Configuration
-
-    def self.configure: () { (Configuration config) -> void } -> void
-
     module EncoderMethods
       def encode_encoded_id: (untyped id, ?::Hash[::Symbol, untyped] options) -> ::String
       def decode_encoded_id: (::String slugged_encoded_id, ?::Hash[::Symbol, untyped] options) -> ::Array[::Integer]?
@@ -85,7 +85,7 @@ module EncodedId
       def where_encoded_id: (::String slugged_encoded_id) -> untyped
     end
 
-    module WithEncodedId : ActiveRecord::Base
+    module Model : ActiveRecord::Base
       extend ActiveRecord::FinderMethods
       extend ActiveRecord::QueryMethods
 
@@ -100,5 +100,19 @@ module EncodedId
       def slugged_encoded_id: (?with: ::Symbol) -> ::String
       def name_for_encoded_id_slug: () -> ::String
     end
+
+    interface _ActiveRecordToParam
+      def to_param: () -> ::String
+    end
+
+    module PathParam : Model, _ActiveRecordToParam
+    end
+
+    module SluggedPathParam : Model, _ActiveRecordToParam
+    end
   end
+
+  Model: singleton(Rails::Model)
+  PathParam: singleton(Rails::PathParam)
+  SluggedPathParam: singleton(Rails::SluggedPathParam)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: encoded_id-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
@@ -86,12 +86,14 @@ files:
 - lib/encoded_id/rails/configuration.rb
 - lib/encoded_id/rails/encoder_methods.rb
 - lib/encoded_id/rails/finder_methods.rb
+- lib/encoded_id/rails/model.rb
+- lib/encoded_id/rails/path_param.rb
 - lib/encoded_id/rails/query_methods.rb
 - lib/encoded_id/rails/salt.rb
 - lib/encoded_id/rails/slugged_id.rb
 - lib/encoded_id/rails/slugged_id_parser.rb
+- lib/encoded_id/rails/slugged_path_param.rb
 - lib/encoded_id/rails/version.rb
-- lib/encoded_id/rails/with_encoded_id.rb
 - lib/generators/encoded_id/rails/USAGE
 - lib/generators/encoded_id/rails/install_generator.rb
 - lib/generators/encoded_id/rails/templates/encoded_id.rb