Parent

Class/Module Index [+]

Quicksearch

Twitter::Base

Attributes

attrs[R]
to_hash[R]

Public Class Methods

attr_reader(*attrs) click to toggle source

Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key

@overload self.attr_reader(attr)

@param attr [Symbol]

@overload self.attr_reader(attrs)

@param attrs [Array<Symbol>]
# File lib/twitter/base.rb, line 15
def self.attr_reader(*attrs)
  attrs.each do |attribute|
    class_eval do
      define_method attribute do
        @attrs[attribute.to_sym]
      end
    end
  end
end
fetch(attrs) click to toggle source

Retrieves an object from the identity map.

@param attrs [Hash] @return [Twitter::Base]

# File lib/twitter/base.rb, line 37
def self.fetch(attrs)
  return unless identity_map
  if object = identity_map.fetch(Marshal.dump(attrs))
    return object
  end
  return yield if block_given?
  raise Twitter::Error::IdentityMapKeyError, "key not found"
end
fetch_or_new(attrs={}) click to toggle source

Retrieves an object from the identity map, or stores it in the identity map if it doesn't already exist.

@param attrs [Hash] @return [Twitter::Base]

# File lib/twitter/base.rb, line 68
def self.fetch_or_new(attrs={})
  return unless attrs
  return new(attrs) unless identity_map

  fetch(attrs) do
    object = new(attrs)
    store(object)
  end
end
from_response(response={}) click to toggle source

Returns a new object based on the response hash

@param response [Hash] @return [Twitter::Base]

# File lib/twitter/base.rb, line 59
def self.from_response(response={})
  fetch_or_new(response[:body])
end
identity_map() click to toggle source

return [Twitter::IdentityMap]

# File lib/twitter/base.rb, line 26
def self.identity_map
  return unless Twitter.identity_map
  @identity_map = Twitter.identity_map.new if @identity_map_class != Twitter.identity_map
  @identity_map_class = Twitter.identity_map
  @identity_map
end
new(attrs={}) click to toggle source

Initializes a new object

@param attrs [Hash] @return [Twitter::Base]

# File lib/twitter/base.rb, line 82
def initialize(attrs={})
  @attrs = attrs
end
store(object) click to toggle source

Stores an object in the identity map.

@param object [Object] @return [Twitter::Base]

# File lib/twitter/base.rb, line 50
def self.store(object)
  return object unless identity_map
  identity_map.store(Marshal.dump(object.attrs), object)
end

Public Instance Methods

[](method) click to toggle source

Fetches an attribute of an object using hash notation

@param method [String, Symbol] Message to send to the object

# File lib/twitter/base.rb, line 89
def [](method)
  send(method.to_sym)
rescue NoMethodError
  nil
end
update(attrs) click to toggle source

Update the attributes of an object

@param attrs [Hash] @return [Twitter::Base]

# File lib/twitter/base.rb, line 99
def update(attrs)
  @attrs.update(attrs)
  self
end

Protected Instance Methods

attr_equal(attr, other) click to toggle source

@param attr [Symbol] @param other [Twitter::Base] @return [Boolean]

# File lib/twitter/base.rb, line 109
def attr_equal(attr, other)
  self.class == other.class && !other.send(attr).nil? && send(attr) == other.send(attr)
end
attrs_equal(other) click to toggle source

@param other [Twitter::Base] @return [Boolean]

# File lib/twitter/base.rb, line 115
def attrs_equal(other)
  self.class == other.class && !other.attrs.empty? && attrs == other.attrs
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.