Class: Riak::Link

Inherits:

Object

• Object
• Riak::Link

show all

Includes:

Util::Escape, Util::Translation

Defined in:

riak-client/lib/riak/link.rb

Overview

Instance Attribute Summary (collapse)

• - (String) bucket

  The bucket of the related resource.

• - (String) key

  The key of the related resource.

• - (String) tag (also: #rel)

  The relationship tag (or “rel”) of the other resource to this one.

Class Method Summary (collapse)

• + (Array<Link>) parse(header_string)

  An array of Riak::Link structs parsed from the header.

Instance Method Summary (collapse)

• - (Object) ==(other)
• - (Boolean) eql?(other)
• - (Object) hash
• - (Link) initialize(*args) constructor

  A new instance of Link.

• - (Object) inspect
• - (Object) to_s
• - (Object) to_walk_spec
• - (String) url

  The URL (relative or absolute) of the related resource.

• - (Object) url=(value)

Methods included from Util::Escape

#escape, #unescape

Methods included from Util::Translation

#i18n_scope, #t

55
56
57
58
59
60
61
62

# File 'riak-client/lib/riak/link.rb', line 55

def initialize(*args)
  raise ArgumentError unless (2..3).include?(args.size)
  if args.size == 2
    self.url, @tag = args
  else
    @bucket, @key, @tag = args
  end
end

31
32
33

# File 'riak-client/lib/riak/link.rb', line 31

def bucket
  @bucket
end

34
35
36

# File 'riak-client/lib/riak/link.rb', line 34

def key
  @key
end

26
27
28

# File 'riak-client/lib/riak/link.rb', line 26

def tag
  @tag
end

42
43
44
45
46

# File 'riak-client/lib/riak/link.rb', line 42

def self.parse(header_string)
  header_string.scan(%r{<([^>]+)>\s*;\s*(?:rel|riaktag)=\"([^\"]+)\"}).map do |match|
    new(match[0], match[1])
  end
end

89
90
91

# File 'riak-client/lib/riak/link.rb', line 89

def ==(other)
  other.is_a?(Link) && url == other.url && tag == other.tag
end

85
86
87

# File 'riak-client/lib/riak/link.rb', line 85

def eql?(other)
  self == other
end

81
82
83

# File 'riak-client/lib/riak/link.rb', line 81

def hash
  self.to_s.hash
end

75

# File 'riak-client/lib/riak/link.rb', line 75

def inspect; to_s; end

77
78
79

# File 'riak-client/lib/riak/link.rb', line 77

def to_s
  %Q[<#{url}>; riaktag="#{tag}"]
end

93
94
95
96

# File 'riak-client/lib/riak/link.rb', line 93

def to_walk_spec
  raise t("bucket_link_conversion") if tag == "up" || key.nil?
  WalkSpec.new(:bucket => bucket, :tag => tag)
end

65
66
67

# File 'riak-client/lib/riak/link.rb', line 65

def url
  @url ||= "/riak/#{escape(bucket)}" + (key.blank? ? "" : "/#{escape(key)}")
end

69
70
71
72
73

# File 'riak-client/lib/riak/link.rb', line 69

def url=(value)
  @url = value
  @bucket = unescape($1) if value =~ %r{^/[^/]+/([^/]+)/?}
  @key = unescape($1) if value =~ %r{^/[^/]+/[^/]+/([^/]+)/?}
end