react-rails-hot-loader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87d38a21b1f7917eb29e27a54592a9018402baeb
+  data.tar.gz: 88269e19352ab97728fd47c4dd8fb21bd4021d4a
+SHA512:
+  metadata.gz: 53c3b2306215e96d4fa626ee9f933c4aea0689d917b97365baf922e50f390b953b68dee8d53a71b65595c64dda0e5a52bf0b06b9c04a8f0c436e4804dc7ceda7
+  data.tar.gz: 55291a15d02363ebe0bb1b671ec9458e51e55c76268230edcf6478a3cf103c5fb3b498f5de9f066e1ef2ea440ba02de969cf59143a5e104b8adf2de10a1586c0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in react-rails-hot-loader.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Robert Mosolgo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# React::Rails::HotLoader
+
+Reload React.js components with Ruby on Rails & [`react-rails`](http://github.com/reactjs/react-rails).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'react-rails-hot-loader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install react-rails-hot-loader
+
+## Usage
+
+- Add an initializer (eg, `app/config/initializers/react_rails_hot_loader.rb`):
+
+  ```ruby
+  if Rails.env.development?
+    React::Rails::HotLoader.start()
+  end
+  ```
+
+- Include the Javascript (eg, in `app/assets/javascripts/application.js`):
+
+  ```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
+
+## Doeses & Doesn'ts
+
+`react-rails-hot-loader` ...
+
+- __does__ set up a WebSocket server & client
+- __does__ reload JS assets when they change (from `/app/assets/javascripts/*.js*`)
+- __does__ remount components (via `ReactRailsUJS`) after reloading assets
+- __does__ preserve state & props (because `React.render` does that out of the box)
+- __doesn't__ reload Rails view files (`html`, `erb`, `slim`, etc)
+- __doesn't__ reload CSS (although that could be fixed)
+
+## TODO
+
+- 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
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "react/rails/hot/loader"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

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

@@ -0,0 +1,3 @@
+// This file is blank intentionally
+// so that you can safely require react-rails-hot-loader
+// in development, and not worry about what happens in production.

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

@@ -0,0 +1,69 @@
+ReactRailsHotLoader = {
+  since: null,
+  port: 8082,
+  host: window.location.host,
+  shouldLog: true,
+
+  start: function() {
+    this._resetSince()
+    var wsURL = "ws://" + this.host + ":" + this.port
+    this.log(" connecting to " + wsURL)
+    this._socket = new WebSocket(wsURL)
+
+    var _this = this
+
+    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._resetSince()
+    }
+
+    this._interval = setInterval(function() {
+      if (_this._socket.readyState == WebSocket.OPEN) {
+        _this._socket.send(_this.since)
+      } else {
+        _this.log("WebSocket not ready, readyState: " + _this._socket.readyState)
+      }
+    }, 1500)
+  },
+
+  stop: function() {
+    this._socket.close()
+    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
+  },
+
+  log: function(msg) {
+    if (this.shouldLog) {
+      console.log("[HotLoader] " + msg)
+    }
+  }
+}
+
+ReactRailsHotLoader.start()

data/lib/hot_loader.rb

@@ -0,0 +1,21 @@
+module React
+  module Rails
+    module HotLoader
+      mattr_accessor :server
+      def self.start(*args)
+        self.server = Server.new(*args)
+        server.restart
+      end
+
+      def self.restart
+        server.restart
+      rescue StandardError => err
+        log("failed to restart: #{err}")
+      end
+
+      def self.log(message)
+        ::Rails.logger.info("[HotLoader] #{message}")
+      end
+    end
+  end
+end

data/lib/hot_loader/asset_change_set.rb

@@ -0,0 +1,30 @@
+module React
+  module Rails
+    module HotLoader
+      class AssetChangeSet
+        attr_reader :since, :path, :changed_files, :changed_asset_paths
+        # 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.*"
+          @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")}
+        end
+
+        def any?
+          changed_asset_paths.any?
+        end
+
+        def as_json(options={})
+          {
+            since: since,
+            path: path,
+            changed_asset_paths: changed_asset_paths,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/hot_loader/asset_path.rb

@@ -0,0 +1,16 @@
+module React
+  module Rails
+    module HotLoader
+      class AssetPath
+        GEM_LIB_PATH = Pathname.new('../../').expand_path(__FILE__)
+
+        attr_reader :to_s
+
+        def initialize(dummy: false)
+          asset_path = dummy ? "assets/dummy": "assets"
+          @to_s = File.join(GEM_LIB_PATH, asset_path)
+        end
+      end
+    end
+  end
+end

data/lib/hot_loader/railtie.rb

@@ -0,0 +1,24 @@
+module React
+  module Rails
+    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
+
+        config.after_initialize do |app|
+          ActionDispatch::Reloader.to_prepare do
+            begin
+              React::Rails::HotLoader.restart
+            rescue StandardError => err
+              React::Rails::HotLoader.log("to_prepare failed: #{err}\n#{err.backtrace.join("\n")}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hot_loader/server.rb

@@ -0,0 +1,59 @@
+require 'em-websocket'
+
+module React
+  module Rails
+    module HotLoader
+      class Server
+        attr_reader :host, :port, :change_set_class
+
+        def initialize(host:  "0.0.0.0", port: 8082, change_set_class: React::Rails::HotLoader::AssetChangeSet)
+          @host = host
+          @port = port
+          @change_set_class = change_set_class
+          @thread = nil
+        end
+
+        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
+            end
+          end
+        end
+
+        def serve
+          EM.run {
+            React::Rails::HotLoader.log("starting WS server...")
+
+            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") }
+            end
+
+            React::Rails::HotLoader.log("started WS server")
+          }
+        end
+      end
+    end
+  end
+end

data/lib/hot_loader/version.rb

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

data/lib/react-rails-hot-loader.rb

@@ -0,0 +1,6 @@
+require 'hot_loader'
+require 'hot_loader/asset_change_set'
+require 'hot_loader/asset_path'
+require 'hot_loader/server'
+require 'hot_loader/railtie'
+require 'hot_loader/version'

data/react-rails-hot-loader.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hot_loader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "react-rails-hot-loader"
+  spec.version       = React::Rails::HotLoader::VERSION
+  spec.authors       = ["Robert Mosolgo"]
+  spec.email         = ["rdmosolgo@gmail.com"]
+
+  spec.summary       = %q{Live-reload React.js components with Ruby on Rails}
+  spec.description   = %q{Tie into the `react-rails` gem to notify the client of changed files & reload assets on the client when they are changed.}
+  spec.homepage      = "http://github.com/rmosolgo/react-rails-hot-loader"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "em-websocket"
+  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 "guard"
+  spec.add_development_dependency "guard-minitest"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: react-rails-hot-loader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Mosolgo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  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
+    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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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: guard
+  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: guard-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'
+description: Tie into the `react-rails` gem to notify the client of changed files
+  & reload assets on the client when they are changed.
+email:
+- rdmosolgo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/assets/dummy/react-rails-hot-loader.js
+- lib/assets/react-rails-hot-loader.js
+- lib/hot_loader.rb
+- lib/hot_loader/asset_change_set.rb
+- lib/hot_loader/asset_path.rb
+- lib/hot_loader/railtie.rb
+- lib/hot_loader/server.rb
+- lib/hot_loader/version.rb
+- lib/react-rails-hot-loader.rb
+- react-rails-hot-loader.gemspec
+homepage: http://github.com/rmosolgo/react-rails-hot-loader
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Live-reload React.js components with Ruby on Rails
+test_files: []