Module: Hashid::Rails

Defined in:
lib/hashid/rails.rb,
lib/hashid/rails/version.rb,
lib/hashid/rails/configuration.rb

Defined Under Namespace

Modules: ClassMethods Classes: Configuration

Constant Summary collapse

HASHID_TOKEN =

Arbitrary value to verify hashid en.wikipedia.org/wiki/Phrases_from_The_Hitchhiker%27s_Guide_to_the_Galaxy#On_the_Internet_and_in_software

42
VERSION = 
"1.4.1"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.configuration ⇒ Object

Get configuration or load defaults



19
20
21
 
# File 'lib/hashid/rails.rb', line 19

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Set configuration settings with a block

Yields:



24
25
26
 
# File 'lib/hashid/rails.rb', line 24

def self.configure
  yield(configuration)
end

.included(base) ⇒ Object 



14
15
16
 
# File 'lib/hashid/rails.rb', line 14

def self.included(base)
  base.extend ClassMethods
end

.reset ⇒ Object

Reset gem configuration to defaults



29
30
31
 
# File 'lib/hashid/rails.rb', line 29

def self.reset
  @configuration = Configuration.new
end

Instance Method Details

#hashid ⇒ Object 



33
34
35
 
# File 'lib/hashid/rails.rb', line 33

def hashid
  self.class.encode_id(id)
end

#to_param ⇒ Object 



37
38
39
 
# File 'lib/hashid/rails.rb', line 37

def to_param
  self.class.hashid_configuration.override_to_param ? hashid : super
end