react-rails-hot-loader 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87d38a21b1f7917eb29e27a54592a9018402baeb
-  data.tar.gz: 88269e19352ab97728fd47c4dd8fb21bd4021d4a
+  metadata.gz: 120d5f5ea466039d5d1aea66acdfd7a6b2d2b47c
+  data.tar.gz: 10591893cb60c6fdc558ec3efeece0910b79be9d
 SHA512:
-  metadata.gz: 53c3b2306215e96d4fa626ee9f933c4aea0689d917b97365baf922e50f390b953b68dee8d53a71b65595c64dda0e5a52bf0b06b9c04a8f0c436e4804dc7ceda7
-  data.tar.gz: 55291a15d02363ebe0bb1b671ec9458e51e55c76268230edcf6478a3cf103c5fb3b498f5de9f066e1ef2ea440ba02de969cf59143a5e104b8adf2de10a1586c0
+  metadata.gz: 243026941a4eed56d3b40af15007b960a9779d4fc04a491af319bc1f053069c70399f527f670e9f5059c49880ac837e397fce283ce1ff6dd9d80fa12faa4d257
+  data.tar.gz: 5f541a0af462ef1a961250cdf2573acffe7e7c1de737962a0ff86c46d52485c54d5fc10e294d369692f54412abf05b2e3ee823a2a57e1bcf636eab8a688a2bbc

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.2.0
 before_install: gem install bundler -v 1.10.3
+addons:
+  code_climate:
+    repo_token: 89617e5ca8a5789349231b46f543b5666f139bfb23d5946bc4517609926071f9

data/Guardfile

@@ -3,3 +3,15 @@ guard :minitest do
   watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
   watch(%r{^test/test_helper\.rb$})      { 'test' }
 end
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end

data/README.md

@@ -1,7 +1,11 @@
-# React::Rails::HotLoader
+# React::Rails::HotLoader 
 
 Reload React.js components with Ruby on Rails & [`react-rails`](http://github.com/reactjs/react-rails).
 
+When you edit components, they'll be reloaded by the browser & re-mounted in the page.
+
+[![Gem Version](https://badge.fury.io/rb/react-rails-hot-loader.svg)](http://badge.fury.io/rb/react-rails-hot-loader) [![Build Status](https://travis-ci.org/rmosolgo/react-rails-hot-loader.svg)](https://travis-ci.org/rmosolgo/react-rails-hot-loader) [![Code Climate](https://codeclimate.com/github/rmosolgo/react-rails-hot-loader/badges/gpa.svg)](https://codeclimate.com/github/rmosolgo/react-rails-hot-loader) [![Test Coverage](https://codeclimate.com/github/rmosolgo/react-rails-hot-loader/badges/coverage.svg)](https://codeclimate.com/github/rmosolgo/react-rails-hot-loader/coverage) 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,24 +24,28 @@ Or install it yourself as:
 
 ## Usage
 
-- Add an initializer (eg, `app/config/initializers/react_rails_hot_loader.rb`):
+- Add an initializer:
 
   ```ruby
+  # app/config/initializers/react_rails_hot_loader.rb
   if Rails.env.development?
     React::Rails::HotLoader.start()
   end
   ```
 
-- Include the Javascript (eg, in `app/assets/javascripts/application.js`):
+- Include the JavaScript:
 
   ```js
-  //= require react_rails_hot_loader
+  // app/assets/javascripts/application.js
+  //= require react-rails-hot-loader
   ```
 
   (When not `Rails.env.development?`, this requires an empty file, so don't worry about leaving it in production deploys.)
 
 - Restart your development server
 
+- Edit files in `/app/assets/javascripts` & save changes -- they'll be reloaded in the client and React components will be remounted.
+
 ## Doeses & Doesn'ts
 
 `react-rails-hot-loader` ...
@@ -53,7 +61,6 @@ Or install it yourself as:
 
 - Handle Passenger occasionally killing background threads :(
 - Replace pinging with file watching
-- Test Server, AssetPath
 - Add `rails g react-rails-hot-loader:install` to add initializer and JS
 
 ## License

data/lib/assets/react-rails-hot-loader.js

@@ -1,22 +1,33 @@
-ReactRailsHotLoader = {
+var ReactRailsHotLoader = {
   since: null,
   port: 8082,
-  host: window.location.host,
+  host: window.location.hostname,
   shouldLog: true,
 
   start: function() {
     this._resetSince()
     var wsURL = "ws://" + this.host + ":" + this.port
-    this.log(" connecting to " + wsURL)
+    this.log("connecting to " + wsURL)
     this._socket = new WebSocket(wsURL)
 
     var _this = this
 
+    this._socket.onopen =   function() { _this.log("connected") }
+    this._socket.onclose =  function() { _this.log("disconnected") }
+
     this._socket.onmessage = function(message) {
       var changes = JSON.parse(message.data)
-      _this.log("updating " + changes.changed_asset_paths.length + " assets")
-      changes.changed_asset_paths.forEach(_this._reloadAsset, _this)
+      _this.log("updating: " + changes.changed_file_names.join(", ") )
+      changes.changed_asset_contents.forEach(function(jsCode) {
+        try {
+          eval.call(window, jsCode)
+        } catch (err) {
+          _this.log(err)
+        }
+      })
+      ReactRailsUJS.mountComponents()
       _this._resetSince()
+      _this.log("update finished")
     }
 
     this._interval = setInterval(function() {
@@ -33,27 +44,6 @@ ReactRailsHotLoader = {
     clearInterval(this._interval)
   },
 
-  _reloadAsset: function(path) {
-    var _this = this
-    var _handleResponse = function(js) {
-      try {
-        eval.call(window, js)
-      } catch (err) {
-        _this.log(err)
-      }
-      ReactRailsUJS.mountComponents()
-      var name = path.split("/").pop()
-      _this.log("reloaded " + name)
-    }
-
-    $.ajax({
-      type: "GET",
-      url: path,
-      success: _handleResponse,
-      error: _handleResponse,
-    })
-  },
-
   _resetSince: function() {
     // Ruby prefers seconds.
     this.since = Date.now() / 1000

data/lib/hot_loader.rb

@@ -2,19 +2,30 @@ module React
   module Rails
     module HotLoader
       mattr_accessor :server
-      def self.start(*args)
-        self.server = Server.new(*args)
-        server.restart
+
+      # Create a new server with `options` & start it
+      def self.start(options={})
+        server_class = options.delete(:server_class) || Server
+        self.server = server_class.new(options)
+        restart
       end
 
+      # Restart the server with the same options
       def self.restart
         server.restart
       rescue StandardError => err
-        log("failed to restart: #{err}")
+        React::Rails::HotLoader.error(err)
       end
 
       def self.log(message)
-        ::Rails.logger.info("[HotLoader] #{message}")
+        msg = "[HotLoader] #{message}"
+        ::Rails.logger.info(msg)
+        ::Rails.logger.flush
+      end
+
+      def self.error(err)
+        msg = "#{err.class.name}: #{err}\n #{err.backtrace.join("\n")}"
+        log(msg)
       end
     end
   end

data/lib/hot_loader/asset_change_set.rb

@@ -2,26 +2,31 @@ module React
   module Rails
     module HotLoader
       class AssetChangeSet
-        attr_reader :since, :path, :changed_files, :changed_asset_paths
+        attr_reader :since, :path, :changed_files, :changed_file_names, :changed_asset_contents
         # initialize with a path and time
         # to find files which changed since that time
         def initialize(since:, path: ::Rails.root.join("app/assets/javascripts"))
           @since = since
           @path = path.to_s
-          asset_glob = path.to_s + "/**/*.js.*"
+          asset_glob = path.to_s + "/**/*.js*"
           @changed_files = Dir.glob(asset_glob).select { |f| File.mtime(f) >= since }
-          @changed_asset_paths = changed_files.map {|f| f.sub(path.to_s, "/assets").sub(/\.js.*/, ".js")}
+          @changed_file_names = changed_files.map { |f| f.split("/").last }
+          @changed_asset_contents = changed_files.map do |f|
+            logical_path = f.sub(path.to_s, "").sub(/^\//, '')
+            ::Rails.application.assets[logical_path].to_s
+          end
         end
 
         def any?
-          changed_asset_paths.any?
+          changed_files.any?
         end
 
         def as_json(options={})
           {
             since: since,
             path: path,
-            changed_asset_paths: changed_asset_paths,
+            changed_file_names: changed_file_names,
+            changed_asset_contents: changed_asset_contents,
           }
         end
       end

data/lib/hot_loader/asset_path.rb

@@ -1,7 +1,9 @@
 module React
   module Rails
     module HotLoader
+      # We want to include different files in dev/prod. The production (dummy) file is empty!
       class AssetPath
+
         GEM_LIB_PATH = Pathname.new('../../').expand_path(__FILE__)
 
         attr_reader :to_s

data/lib/hot_loader/railtie.rb

@@ -3,8 +3,6 @@ module React
     module HotLoader
       class Railtie < ::Rails::Railtie
         config.before_initialize do |app|
-          # We want to include different files in dev/prod.
-          # The production file is empty!
           asset_path = React::Rails::HotLoader::AssetPath.new(dummy: !(::Rails.env.development?))
           app.config.assets.paths << asset_path.to_s
         end
@@ -14,7 +12,7 @@ module React
             begin
               React::Rails::HotLoader.restart
             rescue StandardError => err
-              React::Rails::HotLoader.log("to_prepare failed: #{err}\n#{err.backtrace.join("\n")}")
+              React::Rails::HotLoader.error(err)
             end
           end
         end

data/lib/hot_loader/server.rb

@@ -10,49 +10,58 @@ module React
           @host = host
           @port = port
           @change_set_class = change_set_class
-          @thread = nil
         end
 
+        # Restarts the server _if_ it has stopped
         def restart
-          if @thread.blank? || @thread.stop?
-            "[HotLoader] restarting: #{@thread}, #{@thread.try(:status)}"
-            @thread = Thread.new do
-              begin
-                serve
-              rescue StandardError => err
-                React::Rails::HotLoader.log("failed to serve: #{err}\n#{err.backtrace.join("\n")}")
-              end
+          return if running?
+          start
+        rescue StandardError => err
+          React::Rails::HotLoader.error(err)
+        end
+
+        private
+
+        def running?
+          @server_thread && @server_thread.alive?
+        end
+
+        def start
+          @server_thread = Thread.new do
+            begin
+              serve
+            rescue StandardError => err
+              React::Rails::HotLoader.error(err)
             end
           end
         end
 
         def serve
           EM.run {
-            React::Rails::HotLoader.log("starting WS server...")
+            React::Rails::HotLoader.log("starting WS server: ws://#{host}:#{port}")
 
             EM::WebSocket.run(host: host, port: port) do |ws|
-              ws.onopen { React::Rails::HotLoader.log("opened a connection") }
-
-              ws.onmessage { |msg|
-                begin
-                  since_time =  Time.at(msg.to_i)
-                  changes = change_set_class.new(since: since_time)
-                  if changes.any?
-                    React::Rails::HotLoader.log("received message: #{msg}")
-                    React::Rails::HotLoader.log("sent response: #{changes.to_json}")
-                    ws.send(changes.to_json)
-                  end
-                rescue StandardError => err
-                  React::Rails::HotLoader.log("message error: #{err}\n #{err.backtrace.join("\n")}")
-                end
-              }
-
-              ws.onclose { React::Rails::HotLoader.log("closed a connection") }
+              ws.onopen     { React::Rails::HotLoader.log("opened a connection") }
+              ws.onmessage  { |msg| handle_message(ws, msg) }
+              ws.onclose    { React::Rails::HotLoader.log("closed a connection") }
             end
 
             React::Rails::HotLoader.log("started WS server")
           }
         end
+
+        # Check for any changes since `msg`, respond if there are any changes
+        def handle_message(ws, msg)
+          # React::Rails::HotLoader.log("received message: #{msg}")
+          since_time =  Time.at(msg.to_i)
+          changes = change_set_class.new(since: since_time)
+          if changes.any?
+            React::Rails::HotLoader.log("sent changes: #{changes.changed_file_names}")
+            ws.send(changes.to_json)
+          end
+        rescue StandardError => err
+          React::Rails::HotLoader.error(err)
+        end
       end
     end
   end

data/lib/hot_loader/version.rb

@@ -1,7 +1,7 @@
 module React
   module Rails
     module HotLoader
-      VERSION = '0.0.1'
+      VERSION = '0.1.0'
     end
   end
 end

data/react-rails-hot-loader.gemspec

@@ -17,12 +17,19 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.1.0'
+
   spec.add_runtime_dependency "em-websocket"
+  spec.add_runtime_dependency "rails"
   spec.add_runtime_dependency "react-rails"
 
   spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
   spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "websocket-client-simple"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react-rails-hot-loader
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Robert Mosolgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-websocket
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: react-rails
   requirement: !ruby/object:Gem::Requirement
@@ -53,21 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,6 +122,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Tie into the `react-rails` gem to notify the client of changed files
   & reload assets on the client when they are changed.
 email:
@@ -147,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="