Class: Versionist::VersioningStrategy::Parameter

Inherits:
Base
  • Object
show all
Defined in:
lib/versionist/versioning_strategy/parameter.rb

Overview

Implements the parameter versioning strategy.

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Parameter

Creates a new Parameter VersioningStrategy object. config must contain the following keys:

  • :parameter the parameter hash to inspect

Raises:

  • (ArgumentError) 


8
9
10
11
12
13
 
# File 'lib/versionist/versioning_strategy/parameter.rb', line 8

def initialize(config)
  super
  raise ArgumentError, "you must specify :name in the :parameter configuration Hash" if !config[:parameter].has_key?(:name)
  raise ArgumentError, "you must specify :value in the :parameter configuration Hash" if !config[:parameter].has_key?(:value)
  Versionist.configuration.parameter_versions << self if !Versionist.configuration.parameter_versions.include?(self)
end

Instance Method Details

#==(other) ⇒ Object 



20
21
22
23
24
 
# File 'lib/versionist/versioning_strategy/parameter.rb', line 20

def ==(other)
  super
  return false if !other.is_a?(Versionist::VersioningStrategy::Parameter)
  return self.config[:parameter][:name] == other.config[:parameter][:name] && self.config[:parameter][:value] == other.config[:parameter][:value]
end

#matches?(request) ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
18
 
# File 'lib/versionist/versioning_strategy/parameter.rb', line 15

def matches?(request)
  parameter_string = request.params[config[:parameter][:name]].to_s
  return !parameter_string.blank? && parameter_string == config[:parameter][:value]
end