Class: I3Ipc::Reply

Inherits:
Object
  • Object
show all
Defined in:
lib/i3ipc/reply.rb

Overview

Wrapper for reply from i3-ipc.

Represents response from i3 as object tree.

Able to parse Numeric, String, TrueClass, FalseClass, Array, Hash from passed JSON string.

For example: response = Reply.parse( %Q{ { "name": "LVDS1", "active": true, "current_workspace": "4", "rect": { "x": 0, "y": 0, "width": 1280, "height": 800 } } } )

p response.name # => "LVDS1" p response.active # => true p response.rect.width # => 1280 # ...

response = Reply.parse(%Q{ [{"key1": true, false]} }) p response.data[0].key1 # => true p response.data[0].key2 # => false

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data) ⇒ Reply

Returns a new instance of Reply.



37
38
39
 
# File 'lib/i3ipc/reply.rb', line 37

def initialize(data)
  @data = data.dup
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object 



58
59
60
61
62
63
64
65
 
# File 'lib/i3ipc/reply.rb', line 58

def method_missing(name, *args, &block)
  if @data.include?(name)
    raise ArgumentError.new('wrong number of arguments (%d for 0)' % args.length) if args.length > 0
    return @data[name]
  else
    super
  end
end

Class Method Details

.parse(response) ⇒ Object

Parses response from I3-ipc protocol.

Returns Reply object with dynamically accessed values.

+response+: string, that represents response from i3 in json format.



46
47
48
 
# File 'lib/i3ipc/reply.rb', line 46

def self.parse(response)
  parse_data JSON.parse(response)
end

Instance Method Details

#respond_to?(method_sym, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
70
71
72
73
 
# File 'lib/i3ipc/reply.rb', line 67

def respond_to?(method_sym, include_private = false)
  if @data.include?(method_sym)
    true
  else
    super
  end
end

#success? ⇒ Boolean

Returns false if this reply represents and error from i3-ipc protocol. Otherwise returns true, which meens that request is successful and reply has some data.

Returns:

  • (Boolean) 


54
55
56
 
# File 'lib/i3ipc/reply.rb', line 54

def success?
  not self.respond_to? :error
end

#to_h ⇒ Object 



79
80
81
82
83
84
 
# File 'lib/i3ipc/reply.rb', line 79

def to_h
  data = @data.dup
  data.each do |k, v|
    data[k] = Reply.unparse_data v
  end
end

#to_s ⇒ Object 



75
76
77
 
# File 'lib/i3ipc/reply.rb', line 75

def to_s
  JSON.pretty_generate(to_h)
end