Class: EncodedId::Encoders::HashidConfiguration

Inherits:

BaseConfiguration

• Object
• BaseConfiguration
• EncodedId::Encoders::HashidConfiguration

Defined in:

lib/encoded_id/encoders/hashid_configuration.rb

Overview

Configuration for Hashids encoder Hashids requires a salt for encoding/decoding

Instance Attribute Summary

• #salt ⇒ Object readonly

  : String.

Attributes inherited from BaseConfiguration

#alphabet, #blocklist, #blocklist_max_length, #blocklist_mode, #hex_digit_encoding_group_size, #max_inputs_per_id, #max_length, #min_length, #split_at, #split_with

Instance Method Summary

• #create_encoder ⇒ Object

  Create the Hashid encoder instance.

• #initialize(salt:, **options) ⇒ HashidConfiguration constructor

  A new instance of HashidConfiguration.

Constructor Details

#initialize(salt:, **options) ⇒ HashidConfiguration

Returns a new instance of HashidConfiguration.

# File 'lib/encoded_id/encoders/hashid_configuration.rb', line 13

def initialize(salt:, **options)
  @salt = validate_salt(salt)
  super(**options)
end

Instance Attribute Details

#salt ⇒ Object (readonly)

: String

# File 'lib/encoded_id/encoders/hashid_configuration.rb', line 10

def salt
  @salt
end

Instance Method Details

#create_encoder ⇒ Object

Create the Hashid encoder instance

# File 'lib/encoded_id/encoders/hashid_configuration.rb', line 20

def create_encoder
  Hashid.new(salt, min_length, alphabet, blocklist, blocklist_mode, blocklist_max_length)
end