react_on_rails 6.1.0 → 6.1.1.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72ff43753d92d5152c1904fefec146611cb131c0
-  data.tar.gz: dc1a7c39e2bc236ddd8c3332658591fa898a0e39
+  metadata.gz: 8c1a4b95d529e2b5d95bd5cd92822138f8a5017c
+  data.tar.gz: c77aeda6b4a99c2be1b02719729be8e49fd53179
 SHA512:
-  metadata.gz: e23da97d02dcfe67f2696d227af396041622fbed07d9d5da70440c8adb5bfac51d807e099e66d4481b25de215e85e92a1c79e7cd9309539969e4e02a1ddb5b63
-  data.tar.gz: c92cc09eab269a74d6920144eca5ee5803a6521ffca285a6f8588ab9ae7d9dbc58524f01231ceae9afb6c0f2c67d8dce656c4e90158b3a35d5aa4b814b84ed62
+  metadata.gz: 58c496affefbff52af047529ab85cea488f78bfd325cc2d12ee85fd0106340ff2ab174d82a9c92c8d0e8ceba007c987cd4047222546b9c867f038fefe6cef216
+  data.tar.gz: 774fd6cf92855b04a79e6eea058212e7744677b10c492e083ff169746f4a432d4c38be0bc93d19b3530548450f6eb2d6b49ea465808767c120df14ee861baa38

data/.bookignore

@@ -0,0 +1,16 @@
+# Directories to ignore
+app/*
+gen-examples/*
+lib/*
+node_package/"
+rakelib/*
+script/*
+spec/*
+
+# files in repo root to ignore
+Gemfile
+npm-shrinkwrap.json
+package.json
+Rakefile
+react_on_rails.gemspec
+ruby-lint.yml

data/CONTRIBUTING.md

@@ -36,6 +36,12 @@ From [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/
 bundle && npm i && rake examples:prepare_all && rake node_package && rake
 ```
 
+In order to run tests in browser
+```
+npm i -g browserify babelify tape-run faucet
+browserify -t babelify node_package/tests/*.js | tape-run | faucet
+```
+
 See Dev Initial Setup, below for, well... initial setup.
 
 # IDE/IDE SETUP

data/NEWS.md

@@ -3,6 +3,7 @@
 *We'll keep a history of the news. A few bullets at the top will also show on the [README.md](./README.md).*
 
 * Always see the [CHANGELOG.md](./CHANGELOG.md) for the latest project changes.
+* 2016-08-27: We now have a [Documentation Gitbook](https://shakacode.gitbooks.io/react-on-rails/content/) for improved readability & reference.
 * 2016-08-21: v6.1 ships with serveral new features and bug fixes. See the [Changelog](CHANGELOG.md).
 * 2016-06-13: 6.0.4 shipped with a critical fix regarding a missing polyfill for `clearTimeout`, used by babel-polyfill.
 * 2016-06-06: 6.0.2 shipped with a critical fix if you are fragment caching the server generated React.

data/README.md

@@ -13,6 +13,7 @@ Your support keeps this project going.
 (Want to become a contributor? [Contact us](mailto:contact@shakacode.com) for an Slack team invite! Also, see ["easy" issues](https://github.com/shakacode/react_on_rails/labels/easy) and [issues for the full tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/issues?q=is%3Aissue+is%3Aopen+label%3Aeasy).)
 
 # NEWS
+* 2016-08-27: We now have a [Documentation Gitbook](https://shakacode.gitbooks.io/react-on-rails/content/) for improved readability & reference.
 * 2016-08-21: v6.1 ships with serveral new features and bug fixes. See the [Changelog](CHANGELOG.md).
 * 2016-07-28: If you're doing server rendering, be sure to use mini\_racer! See [issues/428](https://github.com/shakacode/react_on_rails/issues/428). It's supposedly much faster than `therubyracer`.
 * *See [NEWS.md](NEWS.md) for more notes over time.*
@@ -75,7 +76,7 @@ We're definitely not doing that. With react_on_rails, webpack is mainly generati
 1. Add the following to your Gemfile and bundle install.
 
   ```ruby
-  gem "react_on_rails", "~> 5"
+  gem "react_on_rails", "~> 6"
   ```
 
 2. Commit this to git (you cannot run the generator unless you do this).
@@ -447,7 +448,8 @@ If you are using [jquery-ujs](https://github.com/rails/jquery-ujs) for AJAX call
 ## Integration with Node
 Node.js can be used as the backend for server-side rendering instead of [execJS](https://github.com/rails/execjs). Before you try this, consider the tradeoff of extra complexity with your deployments versus *potential* performance gains. We've found that using ExecJS with [mini_racer](https://github.com/discourse/mini_racer) to be "fast enough" so far. That being said, we've heard of other large websites using Node.js for better server rendering performance. See [Node.js for Server Rendering](docs/additional-reading/node-server-rendering.md) for more information.
 
-## Additional Documentation
+## Additional Documentation 
+**Try out our new [Documentation Gitbook](https://shakacode.gitbooks.io/react-on-rails/content/) for improved readability & reference!**
 + **Rails**
   + [Rails Assets](docs/additional-reading/rails-assets.md)
   + [Rails View Rendering from Inline JavaScript](docs/additional-reading/rails_view_rendering_from_inline_javascript.md)

data/SUMMARY.md

@@ -0,0 +1,49 @@
+# Table of Content
+
+### **Rails**
+ * [Rails Assets](docs/additional-reading/rails-assets.md)
+ * [Rails View Rendering from Inline JavaScript](docs/additional-reading/rails_view_rendering_from_inline_javascript.md)
+ * [RSpec Configuration](docs/additional-reading/rspec-configuration.md)
+ * [Turbolinks](docs/additional-reading/turbolinks.md)
+
+### **Javascript**
+ * [Node Dependencies and NPM](docs/additional-reading/node-dependencies-and-npm.md)
+ * [Babel](docs/additional-reading/babel.md)
+ * [React Router](docs/additional-reading/react-router.md)
+ * [React & Redux](docs/additional-reading/react-and-redux.md)
+ * [Webpack](docs/additional-reading/webpack.md)
+ * [Webpack Configuration](docs/additional-reading/webpack.md)
+ * [Webpack Cookbook](https://christianalfoni.github.io/react-webpack-cookbook/index.html)
+ * [Developing with the Webpack Dev Server](docs/additional-reading/webpack-dev-server.md)
+ * [Node Server Rendering](docs/additional-reading/node-server-rendering.md)
+ * [Server Rendering Tips](docs/additional-reading/server-rendering-tips.md)
+
+### **Development**
+ * [React on Rails Basic Installation Tutorial](docs/tutorial.md) ([live demo](https://hello-react-on-rails.herokuapp.com))
+ * [Installation Overview](docs/basics/installation-overview.md)
+ * [Migration from react-rails](docs/basics/migrating-from-react-rails.md)
+ * [Recommended Project Structure](docs/additional-reading/recommended-project-structure.md)
+ * [Generator Tips](docs/basics/generator.md)
+ * [Hot Reloading of Assets For Rails Development](docs/additional-reading/hot-reloading-rails-development.md)
+ * [Heroku Deployment](docs/additional-reading/heroku-deployment.md)
+ * [Updating Dependencies](docs/additional-reading/updating-dependencies.md)
+
+### **API**
+ * [JavaScript API](docs/api/javascript-api.md)
+ * [Ruby API](docs/api/ruby-api.md)
+ * [Setting up Hot Reloading during Rails Development, API docs](docs/api/ruby-api-hot-reload-view-helpers.md)
+
+### **CONTRIBUTING**
+ * [Contributing](CONTRIBUTING.MD)
+ * [Generator Testing](docs/contributor-info/generator-testing.md)
+ * [Linting](docs/contributor-info/linters.md)
+ * [Releasing](docs/contributor-info/releasing.md)
+
+### **Misc**
+ * [Tips](docs/additional-reading/tips.md)
+ * [Changelog](CHANGELOG.md)
+ * [Projects](PROJECTS.md)
+ * [Shaka Code Style](docs/coding-style/style.md)
+ * [React on Rails, Slides](http://www.slideshare.net/justingordon/react-on-rails-v4032)
+ * [Code of Conduct](docs/misc/code_of_conduct.md)
+ * [The React on Rails Doctrine](https://medium.com/@railsonmaui/the-react-on-rails-doctrine-3c59a778c724)

data/book.json

@@ -0,0 +1,18 @@
+{
+  "gitbook": "3.1.1",
+  "title": "React on Rails Documentation",
+  "plugins": ["prism", "-highlight", "github"],
+  "pluginsConfig": {
+    "github": {
+      "url": "https://github.com/shakacode/react_on_rails/"
+    },
+    "sharing": {
+      "facebook":   true,
+      "twitter":    true,
+      "google":     true,
+      "weibo":      true,
+      "instapaper": true,
+      "vk":         true
+    }
+  }
+}

data/lib/react_on_rails/assets_precompile.rb

@@ -1,5 +1,7 @@
 module ReactOnRails
   class AssetsPrecompile
+    class SymlinkTargetDoesNotExistException < StandardError; end
+
     # Used by the rake task
     def default_asset_path
       dir = File.join(Rails.configuration.paths["public"].first,
@@ -20,30 +22,35 @@ module ReactOnRails
     def symlink_file(target, symlink)
       target_path = @assets_path.join(target)
       symlink_path = @assets_path.join(symlink)
+
       target_exists = File.exist?(target_path)
+      raise SymlinkTargetDoesNotExistException, "Target Path was: #{target_path}" unless target_exists
 
       # File.exist?(symlink_path) will check the file the sym is pointing to is existing
       # File.lstat(symlink_path).symlink? confirms that this is a symlink
-      symlink_already_there_and_valid = File.exist?(symlink_path) &&
-                                        File.lstat(symlink_path).symlink?
-      if symlink_already_there_and_valid
-        puts "React On Rails: Digested #{symlink} already exists indicating #{target} did not change."
-      elsif target_exists
-        if File.exist?(symlink_path) && File.lstat(symlink_path).symlink?
-          puts "React On Rails: Removing invalid symlink #{symlink_path}"
-          `cd #{@assets_path} && rm #{symlink}`
-        end
-        # Might be like:
-        # "images/5cf5db49df178f9357603f945752a1ef.png":
-        # "images/5cf5db49df178f9357603f945752a1ef-033650e1d6193b70d59bb60e773f47b6d9aefdd56abc7cc.png"
-        # need to cd to directory and then symlink
-        target_sub_path, _divider, target_filename = target.rpartition("/")
-        _symlink_sub_path, _divider, symlink_filename = symlink.rpartition("/")
-        puts "React On Rails: Symlinking \"#{target}\" to \"#{symlink}\""
-        dest_path = File.join(@assets_path, target_sub_path)
-        FileUtils.chdir(dest_path) do
-          File.symlink(target_filename, symlink_filename)
-        end
+      valid_symlink_already_exists = File.exist?(symlink_path) && File.lstat(symlink_path).symlink?
+
+      if valid_symlink_already_exists
+        puts "React On Rails: Digested version of #{symlink} already exists indicating #{target} did not change."
+        return
+      end
+
+      if file_or_symlink_exists_at_path?(symlink_path)
+        puts "React On Rails: Removing existing invalid symlink or file #{symlink_path}"
+        `rm -f "#{symlink_path}"`
+      end
+
+      # Might be like:
+      # "images/5cf5db49df178f9357603f945752a1ef.png":
+      # "images/5cf5db49df178f9357603f945752a1ef-033650e1d6193b70d59bb60e773f47b6d9aefdd56abc7cc.png"
+      # need to cd to directory and then symlink
+      target_sub_path, _divider, target_filename = target.rpartition("/")
+      _symlink_sub_path, _divider, symlink_filename = symlink.rpartition("/")
+      dest_path = File.join(@assets_path, target_sub_path)
+
+      puts "React On Rails: Symlinking \"#{target}\" to \"#{symlink}\""
+      FileUtils.chdir(dest_path) do
+        File.symlink(target_filename, symlink_filename)
       end
     end
 
@@ -74,8 +81,10 @@ module ReactOnRails
           # already been symlinked by Webpack
           symlink_file(rails_digested_filename, original_filename)
 
-          # We want the gz ones as well
-          symlink_file("#{rails_digested_filename}.gz", "#{original_filename}.gz")
+          # We want the gz ones as well if they exist
+          if File.exist?(@assets_path.join("#{rails_digested_filename}.gz"))
+            symlink_file("#{rails_digested_filename}.gz", "#{original_filename}.gz")
+          end
         end
       end
     end
@@ -108,5 +117,14 @@ module ReactOnRails
         puts "Could not find generated_assets_dir #{dir} defined in react_on_rails initializer: "
       end
     end
+
+    private
+
+    def file_or_symlink_exists_at_path?(path)
+      File.lstat(path)
+      true
+    rescue
+      false
+    end
   end
 end

data/lib/react_on_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ReactOnRails
-  VERSION = "6.1.0".freeze
+  VERSION = "6.1.1.rc.1".freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "6.1.0",
+  "version": "6.1.1-rc.1",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {
@@ -11,6 +11,7 @@
     "babel-core": "^6.7.4",
     "babel-loader": "^6.2.4",
     "babel-plugin-react-transform": "^2.0.2",
+    "babel-plugin-transform-flow-strip-types": "^6.8.0",
     "babel-plugin-transform-runtime": "^6.6.0",
     "babel-preset-es2015": "^6.6.0",
     "babel-preset-react": "^6.5.0",
@@ -25,6 +26,7 @@
     "eslint-plugin-import": "^1.13.0",
     "eslint-plugin-jsx-a11y": "^2.1.0",
     "eslint-plugin-react": "^6.1.2",
+    "flow-bin": "^0.30.0",
     "jscs": "^2.11.0",
     "jsdom": "^8.2.0",
     "react": "^15.0.0",
@@ -45,14 +47,16 @@
     "node_package/lib"
   ],
   "scripts": {
-    "test": "node_package/scripts/test",
-    "clean": "node_package/scripts/clean",
+    "test": "babel-tape-runner node_package/tests/*.js | tap-spec",
+    "clean": "rm -rf node_package/lib",
     "prepublish": "npm run build",
-    "build": "node_package/scripts/build",
+    "babel": "babel --out-dir node_package/lib node_package/src",
+    "build": "npm run clean && npm run babel",
     "build-watch": "babel --watch --out-dir node_package/lib node_package/src",
     "eslint": "eslint .",
     "jscs": "jscs -e -v .",
-    "lint": "npm run eslint && npm run jscs",
+    "flow": "flow check node_package",
+    "lint": "npm run eslint && npm run jscs && npm run flow",
     "lint:fix": "node_package/scripts/lint-fix",
     "check": "npm run lint && npm run test",
     "prerelease": "npm run check && npm run clean && npm run build",

data/rakelib/lint.rake

@@ -28,8 +28,13 @@ namespace :lint do
     sh_in_dir(gem_root, "npm run jscs")
   end
 
-  desc "Run all eslint, jscs, rubocop linters. Skip ruby-lint and scss"
-  task lint: [:eslint, :jscs, :rubocop] do
+  desc "Run flow from shell"
+  task :flow do
+    sh_in_dir(gem_root, "npm run flow")
+  end
+
+  desc "Run all eslint, jscs, flow, rubocop linters. Skip ruby-lint and scss"
+  task lint: [:eslint, :jscs, :flow, :rubocop] do
     puts "Completed all linting"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.1.rc.1
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-22 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -311,6 +311,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bookignore"
 - ".coveralls.yml"
 - ".dockerignore"
 - ".eslintignore"
@@ -330,7 +331,9 @@ files:
 - PROJECTS.md
 - README.md
 - Rakefile
+- SUMMARY.md
 - app/helpers/react_on_rails_helper.rb
+- book.json
 - docs/LICENSE
 - docs/additional-reading/babel.md
 - docs/additional-reading/heroku-deployment.md
@@ -452,9 +455,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1