Module: ComponentTestHelpers

Defined in:
lib/hyper-spec/component_helpers.rb

Constant Summary collapse

TOP_LEVEL_COMPONENT_PATCH =

ComponentTestHelpers.compile_to_opal do

lambda { |&block| Opal.compile(block.source.split("\n")[1..-2].join("\n"))}.call do #ComponentTestHelpers.compile_to_opal do
  module React
    class TopLevelRailsComponent

      class << self
        attr_accessor :event_history

        def callback_history_for(proc_name)
          event_history[proc_name]
        end

        def last_callback_for(proc_name)
          event_history[proc_name].last
        end

        def clear_callback_history_for(proc_name)
          event_history[proc_name] = []
        end

        def event_history_for(event_name)
          event_history["_on#{event_name.event_camelize}"]
        end

        def last_event_for(event_name)
          event_history["_on#{event_name.event_camelize}"].last
        end

        def clear_event_history_for(event_name)
          event_history["_on#{event_name.event_camelize}"] = []
        end

      end

      def component
        return @component if @component
        paths_searched = []
        if params.component_name.start_with? "::"
          paths_searched << params.component_name.gsub(/^\:\:/,"")
          @component = params.component_name.gsub(/^\:\:/,"").split("::").inject(Module) { |scope, next_const| scope.const_get(next_const, false) } rescue nil
          return @component if @component && @component.method_defined?(:render)
        else
          self.class.search_path.each do |path|
            # try each path + params.controller + params.component_name
            paths_searched << "#{path.name + '::' unless path == Module}#{params.controller}::#{params.component_name}"
            @component = "#{params.controller}::#{params.component_name}".split("::").inject(path) { |scope, next_const| scope.const_get(next_const, false) } rescue nil
            return @component if @component && @component.method_defined?(:render)
          end
          self.class.search_path.each do |path|
            # then try each path + params.component_name
            paths_searched << "#{path.name + '::' unless path == Module}#{params.component_name}"
            @component = "#{params.component_name}".split("::").inject(path) { |scope, next_const| scope.const_get(next_const, false) } rescue nil
            return @component if @component && @component.method_defined?(:render)
          end
        end
        @component = nil
        raise "Could not find component class '#{params.component_name}' for params.controller '#{params.controller}' in any component directory. Tried [#{paths_searched.join(", ")}]"
      end

      before_mount do
        TopLevelRailsComponent.event_history = Hash.new {|h,k| h[k] = [] }
        @render_params = params.render_params
        component.validator.rules.each do |name, rules|
          if rules[:type] == Proc
            TopLevelRailsComponent.event_history[name] = []
            @render_params[name] =  lambda { |*args|  TopLevelRailsComponent.event_history[name] << args } #args.collect { |arg| Native(arg).to_n } }
          end
        end
      end

      def render
        present component, @render_params
      end
    end
  end
end

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.current_example ⇒ Object

Returns the value of attribute current_example.



232
233
234
 
# File 'lib/hyper-spec/component_helpers.rb', line 232

def current_example
  @current_example
end

.description_displayed ⇒ Object

Returns the value of attribute description_displayed.



233
234
235
 
# File 'lib/hyper-spec/component_helpers.rb', line 233

def description_displayed
  @description_displayed
end

Class Method Details

.compile_to_opal(&block) ⇒ Object 



11
12
13
 
# File 'lib/hyper-spec/component_helpers.rb', line 11

def self.compile_to_opal(&block)
  Opal.compile(block.source.split("\n")[1..-2].join("\n"))
end

.display_example_description ⇒ Object 



234
235
236
 
# File 'lib/hyper-spec/component_helpers.rb', line 234

def display_example_description
  "<script type='text/javascript'>console.log(console.log('%c#{current_example.description}','color:green; font-weight:bold; font-size: 200%'))</script>"
end

Instance Method Details

#add_class(class_name, style) ⇒ Object 



301
302
303
 
# File 'lib/hyper-spec/component_helpers.rb', line 301

def add_class(class_name, style)
  @client_code = "#{@client_code}ComponentHelpers.add_class '#{class_name}', #{style}\n"
end

#add_opal_block(str, block) ⇒ Object 



191
192
193
194
195
196
197
198
 
# File 'lib/hyper-spec/component_helpers.rb', line 191

def add_opal_block(str, block)
  # big assumption here is that we are going to follow this with a .to
  # hence .children.first followed by .children.last
  # probably should do some kind of "search" to make this work nicely
  return str unless block
  "#{str}\n"\
  "#{Unparser.unparse Parser::CurrentRuby.parse(block.source).children.first.children.last}"
end

#build_test_url_for(controller) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
164
165
166
167
168
169
170
171
172
 
# File 'lib/hyper-spec/component_helpers.rb', line 92

def build_test_url_for(controller)

  unless controller
    Object.const_set("ReactTestController", Class.new(ApplicationController)) unless defined?(::ReactTestController)
    controller = ::ReactTestController
  end

  route_root = controller.name.gsub(/Controller$/,"").underscore

  unless controller.method_defined? :test
    controller.class_eval do
      define_method(:test) do
        route_root = self.class.name.gsub(/Controller$/,"").underscore
        test_params = Rails.cache.read("/#{route_root}/#{params[:id]}")
        @component_name = test_params[0]
        @component_params = test_params[1]
        render_params = test_params[2]
        render_on = render_params.delete(:render_on) || :client_only
        mock_time = render_params.delete(:mock_time)
        style_sheet = render_params.delete(:style_sheet)
        javascript = render_params.delete(:javascript)
        code = render_params.delete(:code)
        page = "<%= react_component @component_name, @component_params, { prerender: #{render_on != :client_only} } %>"
        page = "<script type='text/javascript'>\n#{TOP_LEVEL_COMPONENT_PATCH}\n</script>\n#{page}"

        if code
          page = "<script type='text/javascript'>\n#{code}\n</script>\n"+page
        end

        #TODO figure out how to auto insert this line????  something like:
        #page = "<%= javascript_include_tag 'reactrb-router' %>\n#{page}"


        if true || Lolex.initialized?
          page = "<%= javascript_include_tag 'time_cop' %>\n"+page
        end
        if (render_on != :server_only && !render_params[:layout]) || javascript
          #page = "<script src='/assets/application.js?ts=#{Time.now.to_f}'></script>\n"+page
          page = "<%= javascript_include_tag '#{javascript || 'application'}' %>\n"+page
        end
        if !render_params[:layout] || style_sheet
          page = "<%= stylesheet_link_tag '#{style_sheet || 'application'}' %>\n"+page
        end
        if render_on == :server_only # so that test helper wait_for_ajax works
          page = "<script type='text/javascript'>window.jQuery = {'active': 0}</script>\n#{page}"
        else
          page = "<%= javascript_include_tag 'jquery' %>\n<%= javascript_include_tag 'jquery_ujs' %>\n#{page}"
        end
        page = "<script type='text/javascript'>go = function() {window.hyper_spec_waiting_for_go = false}</script>\n#{page}"
        title = view_context.escape_javascript(ComponentTestHelpers.current_example.description)
        title = "#{title}...continued." if ComponentTestHelpers.description_displayed
        page = "<script type='text/javascript'>console.log(console.log('%c#{title}','color:green; font-weight:bold; font-size: 200%'))</script>\n#{page}"
        ComponentTestHelpers.description_displayed = true
        render_params[:inline] = page
        render render_params
      end
    end

    # test_routes = Proc.new do
    #   get "/#{route_root}/:id", to: "#{route_root}#test"
    # end
    # Rails.application.routes.eval_block(test_routes)

    begin
      routes = Rails.application.routes
      routes.disable_clear_and_finalize = true
      routes.clear!
      routes.draw do
        get "/#{route_root}/:id", to: "#{route_root}#test"
      end
      Rails.application.routes_reloader.paths.each{ |path| load(path) }
      routes.finalize!
      ActiveSupport.on_load(:action_controller) { routes.finalize! }
    ensure
      routes.disable_clear_and_finalize = false
    end
  end

  "/#{route_root}/#{@test_id = (@test_id || 0) + 1}"

end

#client_option(opts = {}) ⇒ Object Also known as: client_options 



244
245
246
247
 
# File 'lib/hyper-spec/component_helpers.rb', line 244

def client_option(opts = {})
  @client_options ||= {}
  @client_options.merge! opts
end

#debugger ⇒ Object 



226
227
228
229
 
# File 'lib/hyper-spec/component_helpers.rb', line 226

def debugger
  `debugger`
  nil
end

#evaluate_ruby(str = "", opts = {}, &block) ⇒ Object 



179
180
181
182
183
184
 
# File 'lib/hyper-spec/component_helpers.rb', line 179

def evaluate_ruby(str="", opts={}, &block)
  insure_mount
  str = "#{str}\n#{Unparser.unparse Parser::CurrentRuby.parse(block.source).children.last}" if block
  js = Opal.compile(str).gsub("\n","").gsub("(Opal);","(Opal)")
  JSON.parse(evaluate_script("[#{js}].$to_json()"), opts).first
end

#expect_evaluate_ruby(str = '', opts = {}, &block) ⇒ Object 



186
187
188
189
 
# File 'lib/hyper-spec/component_helpers.rb', line 186

def expect_evaluate_ruby(str = '', opts = {}, &block)
  insure_mount
  expect(evaluate_ruby(add_opal_block(str, block), opts))
end

#expect_promise(str = '', opts = {}, &block) ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/hyper-spec/component_helpers.rb', line 200

def expect_promise(str = '', opts = {}, &block)
  insure_mount
  str = add_opal_block(str, block)
  str = "#{str}.then { |args| args = [args]; `window.hyper_spec_promise_result = args` }"
  js = Opal.compile(str).gsub("\n","").gsub("(Opal);","(Opal)")
  page.evaluate_script("window.hyper_spec_promise_result = false")
  page.execute_script(js)
  Timeout.timeout(Capybara.default_max_wait_time) do
    loop do
      sleep 0.25
      break if page.evaluate_script("!!window.hyper_spec_promise_result")
    end
  end
  expect(JSON.parse(page.evaluate_script("window.hyper_spec_promise_result.$to_json()"), opts).first)
end

#insure_mount ⇒ Object 



239
240
241
242
 
# File 'lib/hyper-spec/component_helpers.rb', line 239

def insure_mount
  # rescue in case page is not defined...
  mount unless page.instance_variable_get("@hyper_spec_mounted") #rescue nil
end

#isomorphic(&block) ⇒ Object 



174
175
176
177
 
# File 'lib/hyper-spec/component_helpers.rb', line 174

def isomorphic(&block)
  yield
  on_client(&block)
end

#mount(component_name = nil, params = nil, opts = {}, &block) ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/hyper-spec/component_helpers.rb', line 251

def mount(component_name = nil, params = nil, opts = {}, &block)
unless params
  params = opts
  opts = {}
end
opts = client_options opts
test_url = build_test_url_for(opts.delete(:controller))
if block || @client_code || component_name.nil?
  block_with_helpers = <<-code
    module ComponentHelpers
      def self.js_eval(s)
        `eval(s)`
      end
      def self.dasherize(s)
        `s.replace(/[-_\\s]+/g, '-')
          .replace(/([A-Z\\d]+)([A-Z][a-z])/g, '$1-$2')
          .replace(/([a-z\\d])([A-Z])/g, '$1-$2')
          .toLowerCase()`
      end
      def self.add_class(class_name, styles={})
        style = styles.collect { |attr, value| "\#{dasherize(attr)}:\#{value}"}.join("; ")
        s = "<style type='text/css'> .\#{class_name}{ \#{style} } </style>"
        `$(\#{s}).appendTo("head");`
      end
    end
    class React::Component::HyperTestDummy < React::Component::Base
      def render; end
    end
    #{@client_code}
    #{Unparser.unparse(Parser::CurrentRuby.parse(block.source).children.last) if block}
  code
  opts[:code] = Opal.compile(block_with_helpers)
end
component_name ||= 'React::Component::HyperTestDummy'
Rails.cache.write(test_url, [component_name, params, opts])
visit test_url
wait_for_ajax unless opts[:no_wait]
page.instance_variable_set("@hyper_spec_mounted", true)
Lolex.init(self, client_options[:time_zone], client_options[:clock_resolution])
end

#on_client(&block) ⇒ Object 



222
223
224
 
# File 'lib/hyper-spec/component_helpers.rb', line 222

def on_client(&block)
  @client_code = "#{@client_code}#{Unparser.unparse Parser::CurrentRuby.parse(block.source).children.last}\n"
end

#open_in_chrome ⇒ Object 



305
306
307
308
309
310
311
312
313
314
 
# File 'lib/hyper-spec/component_helpers.rb', line 305

def open_in_chrome
  if false && ['linux', 'freebsd'].include?(`uname`.downcase)
    `google-chrome http://#{page.server.host}:#{page.server.port}#{page.current_path}`
  else
    `open http://#{page.server.host}:#{page.server.port}#{page.current_path}`
  end
  while true
    sleep 1.hour
  end
end

#pause(message = nil) ⇒ Object 



316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/hyper-spec/component_helpers.rb', line 316

def pause(message = nil)
  if message
    puts message
    page.evaluate_ruby "puts #{message.inspect}.to_s + ' (type go() to continue)'"
  end
  page.evaluate_script("window.hyper_spec_waiting_for_go = true")
  loop do
    sleep 0.25
    break unless page.evaluate_script("window.hyper_spec_waiting_for_go")
  end
end

#ppr(str) ⇒ Object 



216
217
218
219
 
# File 'lib/hyper-spec/component_helpers.rb', line 216

def ppr(str)
  js = Opal.compile(str).gsub("\n","").gsub("(Opal);","(Opal)")
  execute_script("console.log(#{js})")
end

#run_on_client(&block) ⇒ Object 



296
297
298
299
 
# File 'lib/hyper-spec/component_helpers.rb', line 296

def run_on_client(&block)
  script = Opal.compile(Unparser.unparse Parser::CurrentRuby.parse(block.source).children.last)
  execute_script(script)
end

#size_window(width = nil, height = nil) ⇒ Object 



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/hyper-spec/component_helpers.rb', line 328

def size_window(width=nil, height=nil)
  width, height = [height, width] if width == :portrait
  width, height = width if width.is_a? Array
  portrait = true if height == :portrait
  case width
  when :small
    width, height = [480, 320]
  when :mobile
    width, height = [640, 480]
  when :tablet
    width, height = [960, 640]
  when :large
    width, height = [1920, 6000]
  when :default, nil
    width, height = [1024, 768]
  end
  if portrait
    width, height = [height, width]
  end
  if page.driver.browser.respond_to?(:manage)
    page.driver.browser.manage.window.resize_to(width, height)
  elsif page.driver.respond_to?(:resize)
    page.driver.resize(width, height)
  end
end