Class: Hanami::Action::BaseParams

Inherits:
Object
  • Object
show all
Defined in:
lib/hanami/action/base_params.rb

Overview

Since:

  • 0.1.0

Direct Known Subclasses

Params

Constant Summary collapse

RACK_INPUT =

The key that returns raw input from the Rack env

Since:

  • 0.7.0

'rack.input'.freeze
ROUTER_PARAMS =

The key that returns router params from the Rack env This is a builtin integration for Hanami::Router

Since:

  • 0.7.0

'router.params'.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(env) ⇒ Params

Initialize the params and freeze them.

Parameters:

  • env (Hash) —

    a Rack env or an hash of params.

Since:

  • 0.7.0



37
38
39
40
41
42
 
# File 'lib/hanami/action/base_params.rb', line 37

def initialize(env)
  @env    = env
  @raw    = _extract_params
  @params = Utils::Hash.new(@raw).deep_dup.symbolize!.to_h
  freeze
end

Instance Attribute Details

#env ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 0.7.0



22
23
24
 
# File 'lib/hanami/action/base_params.rb', line 22

def env
  @env
end

#raw ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 0.7.0



28
29
30
 
# File 'lib/hanami/action/base_params.rb', line 28

def raw
  @raw
end

Instance Method Details

#[](key) ⇒ Object?

Returns the object associated with the given key

Parameters:

  • key (Symbol) —

    the key

Returns:

  • (Object, nil) —

    return the associated object, if found

Since:

  • 0.7.0



51
52
53
 
# File 'lib/hanami/action/base_params.rb', line 51

def [](key)
  @params[key]
end

#each(&blk) ⇒ Object

Iterates through params

Parameters:

  • blk (Proc)

Since:

  • 0.7.1



122
123
124
 
# File 'lib/hanami/action/base_params.rb', line 122

def each(&blk)
  to_h.each(&blk)
end

#get(*keys) ⇒ Object, NilClass Also known as: dig

Get an attribute value associated with the given key. Nested attributes are reached by listing all the keys to get to the value.

Examples:

require 'hanami/controller'

module Deliveries
  class Create
    include Hanami::Action

    def call(params)
      params.get(:customer_name)     # => "Luca"
      params.get(:uknown)            # => nil

      params.get(:address, :city)    # => "Rome"
      params.get(:address, :unknown) # => nil

      params.get(:tags, 0)           # => "foo"
      params.get(:tags, 1)           # => "bar"
      params.get(:tags, 999)         # => nil

      params.get(nil)                # => nil
    end
  end
end

Parameters:

  • keys (Array<Symbol,Integer>) —

    the key

Returns:

  • (Object, NilClass) —

    return the associated value, if found

Since:

  • 0.7.0



86
87
88
 
# File 'lib/hanami/action/base_params.rb', line 86

def get(*keys)
  @params.dig(*keys)
end

#to_h ⇒ ::Hash Also known as: to_hash

Serialize params to Hash

Returns:

  • (::Hash)

Since:

  • 0.7.0



112
113
114
 
# File 'lib/hanami/action/base_params.rb', line 112

def to_h
  @params
end

#valid? ⇒ TrueClass

Provide a common interface with Params

Returns:

  • (TrueClass) —

    always returns true

See Also:

Since:

  • 0.7.0



103
104
105
 
# File 'lib/hanami/action/base_params.rb', line 103

def valid?
  true
end