Class: Faraday::Options

Inherits:
Struct
  • Object
show all
Defined in:
lib/faraday/options.rb

Overview

Subclasses Struct with some special helpers for converting from a Hash to a Struct.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.attribute_options ⇒ Object

Internal



170
171
172
 
# File 'lib/faraday/options.rb', line 170

def self.attribute_options
  @attribute_options ||= {}
end

.fetch_error_class ⇒ Object 



208
209
210
211
212
213
214
 
# File 'lib/faraday/options.rb', line 208

def self.fetch_error_class
  @fetch_error_class ||= if Object.const_defined?(:KeyError)
                           ::KeyError
                         else
                           ::IndexError
                         end
end

.from(value) ⇒ Object

Public



8
9
10
 
# File 'lib/faraday/options.rb', line 8

def self.from(value)
  value ? new.update(value) : new
end

.inherited(subclass) ⇒ Object 



202
203
204
205
206
 
# File 'lib/faraday/options.rb', line 202

def self.inherited(subclass)
  super
  subclass.attribute_options.update(attribute_options)
  subclass.memoized_attributes.update(memoized_attributes)
end

.memoized(key, &block) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/faraday/options.rb', line 174

def self.memoized(key, &block)
  unless block_given?
    raise ArgumentError, '#memoized must be called with a block'
  end

  memoized_attributes[key.to_sym] = block
  class_eval <<-RUBY, __FILE__, __LINE__ + 1
    def #{key}() self[:#{key}]; end
  RUBY
end

.memoized_attributes ⇒ Object 



185
186
187
 
# File 'lib/faraday/options.rb', line 185

def self.memoized_attributes
  @memoized_attributes ||= {}
end

.options(mapping) ⇒ Object

Internal



160
161
162
 
# File 'lib/faraday/options.rb', line 160

def self.options(mapping)
  attribute_options.update(mapping)
end

.options_for(key) ⇒ Object

Internal



165
166
167
 
# File 'lib/faraday/options.rb', line 165

def self.options_for(key)
  attribute_options[key]
end

Instance Method Details

#[](key) ⇒ Object 



189
190
191
192
193
194
195
196
 
# File 'lib/faraday/options.rb', line 189

def [](key)
  key = key.to_sym
  if (method = self.class.memoized_attributes[key])
    super(key) || (self[key] = instance_eval(&method))
  else
    super
  end
end

#clear ⇒ Object

Public



46
47
48
 
# File 'lib/faraday/options.rb', line 46

def clear
  members.each { |member| delete(member) }
end

#deep_dup ⇒ Object

Public



71
72
73
 
# File 'lib/faraday/options.rb', line 71

def deep_dup
  self.class.from(self)
end

#delete(key) ⇒ Object

Public



39
40
41
42
43
 
# File 'lib/faraday/options.rb', line 39

def delete(key)
  value = send(key)
  send("#{key}=", nil)
  value
end

#each ⇒ Object

Public



13
14
15
16
17
18
19
 
# File 'lib/faraday/options.rb', line 13

def each
  return to_enum(:each) unless block_given?

  members.each do |key|
    yield(key.to_sym, send(key))
  end
end

#each_key ⇒ Object

Public



106
107
108
109
110
111
112
 
# File 'lib/faraday/options.rb', line 106

def each_key
  return to_enum(:each_key) unless block_given?

  keys.each do |key|
    yield(key)
  end
end

#each_value ⇒ Object

Public



122
123
124
125
126
127
128
 
# File 'lib/faraday/options.rb', line 122

def each_value
  return to_enum(:each_value) unless block_given?

  values.each do |value|
    yield(value)
  end
end

#empty? ⇒ Boolean

Public

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/faraday/options.rb', line 101

def empty?
  keys.empty?
end

#fetch(key, *args) ⇒ Object

Public



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/faraday/options.rb', line 76

def fetch(key, *args)
  unless symbolized_key_set.include?(key.to_sym)
    key_setter = "#{key}="
    if !args.empty?
      send(key_setter, args.first)
    elsif block_given?
      send(key_setter, yield(key))
    else
      raise self.class.fetch_error_class, "key not found: #{key.inspect}"
    end
  end
  send(key)
end

#inspect ⇒ Object

Internal



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/faraday/options.rb', line 148

def inspect
  values = []
  members.each do |member|
    value = send(member)
    values << "#{member}=#{value.inspect}" if value
  end
  values = values.empty? ? '(empty)' : values.join(', ')

  %(#<#{self.class} #{values}>)
end

#key?(key) ⇒ Boolean Also known as: has_key?

Public

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/faraday/options.rb', line 115

def key?(key)
  keys.include?(key)
end

#keys ⇒ Object

Public



96
97
98
 
# File 'lib/faraday/options.rb', line 96

def keys
  members.reject { |member| send(member).nil? }
end

#merge(other) ⇒ Object

Public



66
67
68
 
# File 'lib/faraday/options.rb', line 66

def merge(other)
  dup.merge!(other)
end

#merge!(other) ⇒ Object

Public



51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/faraday/options.rb', line 51

def merge!(other)
  other.each do |key, other_value|
    self_value = send(key)
    sub_options = self.class.options_for(key)
    new_value = if self_value && sub_options && other_value
                  self_value.merge(other_value)
                else
                  other_value
                end
    send("#{key}=", new_value) unless new_value.nil?
  end
  self
end

#symbolized_key_set ⇒ Object 



198
199
200
 
# File 'lib/faraday/options.rb', line 198

def symbolized_key_set
  @symbolized_key_set ||= Set.new(keys.map(&:to_sym))
end

#to_hash ⇒ Object

Public



138
139
140
141
142
143
144
145
 
# File 'lib/faraday/options.rb', line 138

def to_hash
  hash = {}
  members.each do |key|
    value = send(key)
    hash[key.to_sym] = value unless value.nil?
  end
  hash
end

#update(obj) ⇒ Object

Public



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/faraday/options.rb', line 22

def update(obj)
  obj.each do |key, value|
    sub_options = self.class.options_for(key)
    if sub_options
      new_value = sub_options.from(value) if value
    elsif value.is_a?(Hash)
      new_value = value.dup
    else
      new_value = value
    end

    send("#{key}=", new_value) unless new_value.nil?
  end
  self
end

#value?(value) ⇒ Boolean Also known as: has_value?

Public

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/faraday/options.rb', line 131

def value?(value)
  values.include?(value)
end

#values_at(*keys) ⇒ Object

Public



91
92
93
 
# File 'lib/faraday/options.rb', line 91

def values_at(*keys)
  keys.map { |key| send(key) }
end