Class: Dominate::Widget

Inherits:
Object show all
Defined in:
lib/dominate/widget.rb,
lib/dominate/widget/event.rb,
lib/dominate/widget/helper.rb,
lib/dominate/widget/middleware.rb

Defined Under Namespace

Modules: Helper Classes: Event, Middleware

Constant Summary collapse

JS_ESCAPE = 
{ '\\' => '\\\\', '</' => '<\/', "\r\n" => '\n', "\n" => '\n', "\r" => '\n', '"' => '\\"', "'" => "\\'" }
PARTIAL_REGEX = 
Regexp.new '([a-zA-Z_]+)$'

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, res, req, name, event) ⇒ Widget

Returns a new instance of Widget.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/dominate/widget.rb', line 12

def initialize app, res, req, name, event
  @app          = app
  @res          = res
  @req          = req
  @name         = name.to_s
  @event        = event
  @widget_state = false

  self.instance_variables.each do |n|
    app.instance_variable_set n, self.instance_variable_get(n)
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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



25
26
27
28
29
30
31
 
# File 'lib/dominate/widget.rb', line 25

def method_missing method, *args, &block
  if app.respond_to? method
    app.send method, *args, &block
  else
    super
  end
end

Class Attribute Details

.events ⇒ Object

Returns the value of attribute events.



210
211
212
 
# File 'lib/dominate/widget.rb', line 210

def events
  @events
end

Instance Attribute Details

#app ⇒ Object

Returns the value of attribute app.



10
11
12
 
# File 'lib/dominate/widget.rb', line 10

def app
  @app
end

#event ⇒ Object

Returns the value of attribute event.



10
11
12
 
# File 'lib/dominate/widget.rb', line 10

def event
  @event
end

#name ⇒ Object

Returns the value of attribute name.



10
11
12
 
# File 'lib/dominate/widget.rb', line 10

def name
  @name
end

#req ⇒ Object

Returns the value of attribute req.



10
11
12
 
# File 'lib/dominate/widget.rb', line 10

def req
  @req
end

#res ⇒ Object

Returns the value of attribute res.



10
11
12
 
# File 'lib/dominate/widget.rb', line 10

def res
  @res
end

#widget_state ⇒ Object

Returns the value of attribute widget_state.



10
11
12
 
# File 'lib/dominate/widget.rb', line 10

def widget_state
  @widget_state
end

Class Method Details

.load_all(app, event, req, res) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/dominate/widget.rb', line 212

def load_all app, event, req, res
  if widget_event = req.params["widget_event"]
    widget_name = req.params["widget_name"]
  end

  unless req.env[:loaded_widgets]
    req.env[:loaded_widgets] ||= {}

    Dominate.config.widgets.each do |name, widget_class_name|
      widget = Object.const_get(widget_class_name).new(
        app, res, req, name, event
      )
      event.register_for_event(event: :trigger, listener: widget, callback: :trigger_event)

      req.env[:loaded_widgets][name] = widget
    end
  end

  [widget_name, widget_event, event]
end

.respond_to(event, opts = {}) ⇒ Object 



233
234
235
236
 
# File 'lib/dominate/widget.rb', line 233

def respond_to event, opts = {}
  @events ||= []
  @events << [event.to_s, opts]
end

.responds_to(*events) ⇒ Object 



238
239
240
241
242
243
 
# File 'lib/dominate/widget.rb', line 238

def responds_to *events
  @events ||= []
  events.each do |event|
    @events << [event, {}]
  end
end

Instance Method Details

#escape(js) ⇒ Object 



103
104
105
 
# File 'lib/dominate/widget.rb', line 103

def escape js
  js.to_s.gsub(/(\\|<\/|\r\n|\\3342\\2200\\2250|[\n\r"'])/) {|match| JS_ESCAPE[match] }
end

#id_for(state) ⇒ Object 



96
97
98
99
100
101
 
# File 'lib/dominate/widget.rb', line 96

def id_for state
  w_name  = name.to_s.gsub(/_/, '-')
  w_state = state.to_s.gsub(/_/, '-')

  "#{w_name}-#{w_state}"
end

#partial(template, locals = {}) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/dominate/widget.rb', line 41

def partial template, locals = {}
  locals[:partial] = template
  resp = render locals

  if resp.is_a? Dominate::Dom
    resp.html
  else
    resp
  end
end

#render(*args) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/dominate/widget.rb', line 170

def render *args
  if args.first.kind_of? Hash
    locals = args.first
    # if it's a partial we add an underscore infront of it
    state = view = locals[:state] ||
      "#{locals.delete(:partial)}".gsub(PARTIAL_REGEX, '_\1')
  else
    state = view = args.first
    locals = args.length > 1 ? args.last : {}
  end

  # set the state and view if it's blank
  if view.blank?
    state = view = caller[0][/`.*'/][1..-2]
  # override state if widget_state set
  elsif !locals[:state] && widget_state
    state = widget_state
  end

  req.env[:widget_name]  = name
  req.env[:widget_state] = state

  view_folder = self.class.to_s.gsub(
    /\w+::Widgets::/, ''
  ).split('::').map(&:underscore).join('/')

  # set the view path to the widget path
  locals[:view_path] = view_path
  # we also don't want a layout
  locals[:layout] = false unless locals.key? :layout
  file = "#{view_folder}/#{view}"

  Dominate::HTML.file(file, self, locals)
end

#render_state(options = {}) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/dominate/widget.rb', line 52

def render_state options = {}
  state = widget_state || options.delete(:state)

  if method(state).parameters.length > 0
    resp = send(state, options.to_deep_ostruct)
  else
    resp = send(state)
  end

  # if resp.is_a? Dominate::Dom
  #   html = "<div id='#{id_for(state)}'>#{resp.html}</div>"
  #   resp.doc.inner_html = html
  #   resp.reset_html
  #   resp.html
  if resp.is_a? String
    html = "<div id='#{id_for(state)}'>#{resp}</div>"
    html
  else
    resp
  end
end

#replace(state, opts = {}) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/dominate/widget.rb', line 74

def replace state, opts = {}
  if !state.is_a? String
    opts[:state] = state
    content = render_state opts
    selector = '#' + id_for(state)
  else
    if !opts.key?(:content) and !opts.key?(:with)
      opts[:state] = caller[0][/`.*'/][1..-2]
      content = render_state opts
    else
      content = opts[:content] || opts[:with]
    end
    selector = state
  end

  res.write '$("' + selector + '").replaceWith("' + escape(content) + '");'
  # scroll to the top of the page just as if we went to the url directly
  # if opts[:scroll_to_top]
  #   res.write 'window.scrollTo(0, 0);'
  # end
end

#reset_state ⇒ Object 



37
38
39
 
# File 'lib/dominate/widget.rb', line 37

def reset_state
  @widget_state = false
end

#set_state(state) ⇒ Object 



33
34
35
 
# File 'lib/dominate/widget.rb', line 33

def set_state state
  @widget_state = state
end

#trigger(widget_event, data = {}) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/dominate/widget.rb', line 107

def trigger widget_event, data = {}
  data        = data.to_h
  widget_name = data.has_key?(:for) ? data.delete(:for) : name

  event.trigger widget_name, widget_event, data.to_h
  # threads = []
  #
  # req.env[:loaded_widgets].each do |n, w|
  #   threads << Thread.new do
  #     ThreadUtility.with_connection do
  #       ap widget_name
  #       w.trigger_event widget_name, widget_event, data.to_deep_ostruct
  #     end
  #   end
  # end
  #
  # threads.map(&:join)
end

#trigger_event(widget_name, widget_event, data = {}) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/dominate/widget.rb', line 126

def trigger_event widget_name, widget_event, data = {}
  if class_events = self.class.events
    class_events.each do |class_event, opts|
      if class_event.to_s == widget_event.to_s && (
       (widget_name.to_s == name.to_s && !opts.has_key?(:for)) or
        opts[:for].to_s == widget_name.to_s
      )
        if not opts[:with]
          e = widget_event
        else
          e = opts[:with]
        end

        # begin
          if method(e) and method(e).parameters.length > 0
            resp = send(e, data)
          else
            resp = send(e)
          end

          # if resp.is_a? Dominate::Dom
          #   html = "<div id='#{id_for(e)}'>#{resp.html}</div>"
          #   resp.doc.inner_html = html
          #   resp.reset_html
          #   res.write resp.html
          if resp.is_a? String
            html = "<div id='#{id_for(e)}'>#{resp}</div>"
            res.write html
          else
            resp
          end
        # rescue NoMethodError
        #   raise "Please add ##{e} to your #{self.class}."
        # end
      end
    end
  end
end

#url_for_event(event, options = {}) ⇒ Object 



165
166
167
168
 
# File 'lib/dominate/widget.rb', line 165

def url_for_event event, options = {}
  widget_name = options.delete(:widget_name) || name
  "http#{req.env['SERVER_PORT'] == '443' ? 's' : ''}://#{req.env['HTTP_HOST']}#{Dominate.config.widget_url}?widget_event=#{event}&widget_name=#{widget_name}" + (options.any?? '&' + URI.encode_www_form(options) : '')
end

#view_path ⇒ Object 



205
206
207
 
# File 'lib/dominate/widget.rb', line 205

def view_path
  Dominate.config.widget_path
end