opal_hot_reloader 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 865340375e8aa257f1549b30bbd885936945cf4b
-  data.tar.gz: ddeda2019446cfb76d09697480307151448603e1
+  metadata.gz: a867c114bf9d71275cc023f35c644944abe5decc
+  data.tar.gz: 4d0c10c661b6180a2881e5d6fbac3a10d6b77e02
 SHA512:
-  metadata.gz: 368168c04d5cfacb65812fbe28eb7db1234921141546b69da816c479ea0add8de3c60a62b614b4baa8f821014403ac2f47e8695ed83ed9bc0d406b0443e223d7
-  data.tar.gz: baa7598ef9b20d827dbde90d92ac883c7c2f1c05627a189b092207c181bfafa64a148e396a2a973b570ecafb0d98aca8548e91fab7a83dce8d45ce2cdf30c077
+  metadata.gz: 267a9d178686be33693532036a2bd8919f2f15e362f6ab20df3f293c60070eee5b9988dfeb8097519077aafcb7a2f3cf523a1f6e20390d0b55e08478780f2ff3
+  data.tar.gz: 637125fea8cf8526c70c7e84badc5b5587243d3fec496fc9aef8d45c96c530e883d54001e396005b418adea48143ea5e2beea114e66c74213f9d99186cb872e1

data/Changelog.org

@@ -1,3 +1,5 @@
+* 0.1.4
+- make alerts configurable via OpalHotReloader.alerts_off!/OpalHotReloader.alerts_on!
 * 0.1.3
 - handle Rails 5 asset pipeline css change
 * 0.1.2

data/README.md

@@ -70,10 +70,34 @@ If you are using the default port then you can just call:
 OpalHotReloader.listen
 ```
 
+#### Alerts
+
+![Reload Error Alert](images/reload_error.png)
+By default, if there is an error hot loading code, opal_hot_reloader
+will present an alert of the error. The following options can be used
+to turn the alerts on and off:
+
+```ruby
+OpalHotReloader.alerts_on!  # turns on alerts
+OpalHotReloader.alerts_off! # turns off alerts
+
+```
+
+
 This will open up a websocket from the client to the server on the given port. The server-side should already be running.
 
 Enjoy!
 
+#### Run only in development on Rails
+One way to run this only in development on Rails is to change your application.js.rb to application.js.rb.erb and add this to the bottom of the file
+
+```ruby
+<% if Rails.env.development? %>
+    require 'opal_hot_reloader'
+    OpalHotReloader.listen
+<% end %>
+```
+
 ## Vision
 
 Some of you might be asking?  Why do this, isn't this reinventing the

data/lib/opal_hot_reloader/version.rb

@@ -1,3 +1,3 @@
 module OpalHotReloader
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/opal/opal_hot_reloader.rb

@@ -20,6 +20,25 @@ class OpalHotReloader
     }
   end
 
+  def notify_error(reload_request)
+    msg = "OpalHotReloader #{reload_request[:filename]} RELOAD ERROR:\n\n#{$!}"
+    puts msg
+    alert msg if use_alert?
+  end
+
+  @@USE_ALERT = true
+  def self.alerts_on!
+    @@USE_ALERT = true
+  end
+  
+  def self.alerts_off!
+    @@USE_ALERT = false
+  end
+
+  def use_alert?
+    @@USE_ALERT
+  end
+  
   def reload(e)
     reload_request = JSON.parse(`e.data`)
     if reload_request[:type] == "ruby"
@@ -27,7 +46,7 @@ class OpalHotReloader
       begin
         $eval_proc.call reload_request[:source_code]
       rescue
-        alert "OpalHotReloader RELOAD ERROR:\n\n#{$!}"
+        notify_error(reload_request)
       end
       if @reload_post_callback
         @reload_post_callback.call
@@ -42,37 +61,37 @@ class OpalHotReloader
 
   # @param port [Integer] opal hot reloader port to connect to
   # @param reload_post_callback [Proc] optional callback to be called after re evaluating a file for example in react.rb files we want to do a React::Component.force_update!
-  def initialize(port=25222, &reload_post_callback)
-    @port = port
-    @reload_post_callback  = reload_post_callback
-    @css_reloader = CssReloader.new
-  end
-  # Opens a websocket connection that evaluates new files and runs the optional @reload_post_callback
-  def listen
-    connect_to_websocket(@port)
-  end
+def initialize(port=25222, &reload_post_callback)
+  @port = port
+  @reload_post_callback  = reload_post_callback
+  @css_reloader = CssReloader.new
+end
+# Opens a websocket connection that evaluates new files and runs the optional @reload_post_callback
+def listen
+  connect_to_websocket(@port)
+end
 
-  # convenience method to start a listen w/one line
-  # @param port [Integer] opal hot reloader port to connect to. Defaults to 25222 to match opal-hot-loader default
-  # @deprecated reactrb - this flag no longer necessary and will be removed in gem release 0.2
-  def self.listen(port=25222, reactrb=false)
-    return if @server
-    if reactrb
-      warn "OpalHotReloader.listen(#{port}): reactrb flag is deprectated and will be removed in gem release 0.2. React will automatically be detected"
-    end
-    create_framework_aware_server(port)
+# convenience method to start a listen w/one line
+# @param port [Integer] opal hot reloader port to connect to. Defaults to 25222 to match opal-hot-loader default
+# @deprecated reactrb - this flag no longer necessary and will be removed in gem release 0.2
+def self.listen(port=25222, reactrb=false)
+  return if @server
+  if reactrb
+    warn "OpalHotReloader.listen(#{port}): reactrb flag is deprectated and will be removed in gem release 0.2. React will automatically be detected"
   end
-  # Automatically add in framework specific hooks
+  create_framework_aware_server(port)
+end
+# Automatically add in framework specific hooks
 
-  def self.create_framework_aware_server(port)
-    if defined? ::React
-      ReactrbPatches.patch!
-      @server = OpalHotReloader.new(port) { React::Component.force_update! }
-    else
-      puts "No framework detected"
-      @server = OpalHotReloader.new(port)
-    end
-    @server.listen
+def self.create_framework_aware_server(port)
+  if defined? ::React
+    ReactrbPatches.patch!
+    @server = OpalHotReloader.new(port) { React::Component.force_update! }
+  else
+    puts "No framework detected"
+    @server = OpalHotReloader.new(port)
   end
+  @server.listen
+end
 
 end

data/spec-opal/opal_hot_reloader_spec.rb

@@ -0,0 +1,10 @@
+require 'opal_hot_reloader'
+describe OpalHotReloader do
+  context 'alerts' do
+    it 'should be controllable' do
+      expect(subject.use_alert?).to eq true
+      OpalHotReloader.alerts_off!
+      expect(subject.use_alert?).to eq false
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal_hot_reloader
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Forrest Chang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,6 +125,7 @@ files:
 - opal/opal_hot_reloader/socket.rb
 - opal_hot_reloader.gemspec
 - spec-opal/opal_hot_reloader/css_reloader_spec.rb
+- spec-opal/opal_hot_reloader_spec.rb
 homepage: https://github.com/fkchang/opal-hot-reloader
 licenses:
 - MIT