react_on_rails 2.0.0.rc.1 → 2.0.0.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a3532d98dcdbf8b585e955a5c605d9c884ac6df
-  data.tar.gz: f7b3342e9599a2ba77087bb44b4004ac38eac4df
+  metadata.gz: f249c2ba093b9c1f2099bb6b5d9be21c932023e1
+  data.tar.gz: 8fa0f6dae77949df12cdaea2d4e5bfe176e68bd6
 SHA512:
-  metadata.gz: d6524e9358002a3124ffbf24620de5b7c4234ce78bf2a2851f8b32093c0d75f8189602b0a972ba94e0f4df7808fe1e29922fe680283e4ce655b7a8c9f3c2a466
-  data.tar.gz: 35510b925a6828dac60290ad1cb6ca803e2726f412d032d06c4338bc18fa0373b8a5261c15519c8b648a3197609e86ef76da045fedd4beede3f42bd3f5792603
+  metadata.gz: 8217b7fa116f964384bcecfb176eeb9036ad990da12d545ec8a2d52d3bc36f0be9edf73b23d3311962748ab72f4f75dc6f41e9e99d4d6bc547785baa3751f079
+  data.tar.gz: 7d5ce3efd0ada7e7d9b722c6fb14e7cfa89466db9c58d95ff5773a7a6a929cf834ef95864749e080092878de8e50ce11de6974a10be8f93c9f278928730d7400

data/.eslintrc

@@ -1,7 +1,7 @@
 ---
 parser: babel-eslint
 
-extends: eslint-config-airbnb
+extends: eslint-config-shakacode
 
 plugins:
   - react

data/.rubocop.yml

@@ -57,7 +57,7 @@ Metrics/ParameterLists:
 # Offense count: 9
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 38
+  Max: 41
 
 # Offense count: 1
 # Configuration parameters: CountComments.

data/.travis.yml

@@ -12,8 +12,7 @@ gemfile:
   - spec/dummy/Gemfile
 
 env:
-  - export RAILS_ENV=test
-  - export DRIVER=selenium_chrome
+  - export RAILS_ENV=test DRIVER=selenium_chrome
 
 before_install:
   - sudo apt-get update

data/CHANGELOG.md

@@ -1,6 +1,52 @@
 # Change Log
 All notable changes to this project will be documented in this file. Items under `Unreleased` is upcoming features that will be out in next version.
 
+## v2.0.0
+- Move JavaScript part of react_on_rails to npm package 'react-on-rails'.
+- Converted JavaScript code to ES6! with tests!
+- No global namespace pollution. ReactOnRails is the only global added.
+- New API. Instead of placing React components on the global namespace, you instead call ReactOnRails.register, passing an object where keys are the names of your components.
+  ```
+  import ReactOnRails from 'react-on-rails';
+  ReactOnRails.registerComponent({name: component});
+  ```
+  Best done with Object destructing
+  ```
+  import ReactOnRails from 'react-on-rails';
+  ReactOnRails.registerComponent(
+    {
+      Component1,
+      Component2
+    }
+  );
+  ```
+  Previously, you used 
+  ```
+  window.Component1 = Component1;
+  window.Component2 = Component2;
+  ```
+  This would pollute the global namespace. See details in the README.md for more information.
+- Your jade template for the WebpackDevServer setup should use the new API:
+  ```
+  ReactOnRails.render(componentName, props, domNodeId);
+  ```
+  such as:
+  ```
+  ReactOnRails.render("HelloWorldApp", {name: "Stranger"}, 'app');
+  ```
+- All npm dependency libraries updated. Most notable is going to Babel 6.
+- Dropped support for react 0.13.
+- JS Linter uses ShakaCode JavaScript style: https://github.com/shakacode/style-guide-javascript 
+- Generators account these differences.
+
+## v1.2.2
+### Fixed
+- Missing Lodash from generated package.json [#175](https://github.com/shakacode/react_on_rails/pull/175)
+- Rails 3.2 could not run generators [#182](https://github.com/shakacode/react_on_rails/pull/182)
+- Better placement of jquery_ujs dependency [#171](https://github.com/shakacode/react_on_rails/pull/171)
+- Add more detailed description when adding --help option to generator [#161](https://github.com/shakacode/react_on_rails/pull/161)
+- Lots of better docs.
+
 ## v1.2.0
 ### Added
 - Support `--skip-bootstrap` or `-b` option for generator.

data/Gemfile

@@ -7,7 +7,6 @@ gemspec
 # They must be defined here because of the way Travis CI works, in that it will only
 # bundle install from a single Gemfile. Therefore, all gems that we will need for any dummy/example
 # app have to be manually added to this file.
-gem "awesome_print"
 gem "bootstrap-sass"
 gem "capybara"
 gem "capybara-screenshot"
@@ -17,12 +16,6 @@ gem "jbuilder", "~> 2.0"
 gem "jquery-rails"
 gem "launchy"
 gem "poltergeist"
-gem "pry"
-gem "pry-byebug"
-gem "pry-doc"
-gem "pry-rails"
-gem "pry-rescue"
-gem "pry-stack_explorer"
 gem "puma"
 gem "rails", "4.2.5"
 gem "rails_12factor"

data/README.md

@@ -1,5 +1,13 @@
 [![Build Status](https://travis-ci.org/shakacode/react_on_rails.svg?branch=master)](https://travis-ci.org/shakacode/react_on_rails) [![Coverage Status](https://coveralls.io/repos/shakacode/react_on_rails/badge.svg?branch=master&service=github)](https://coveralls.io/github/shakacode/react_on_rails?branch=master) [![Dependency Status](https://gemnasium.com/shakacode/react_on_rails.svg)](https://gemnasium.com/shakacode/react_on_rails) [![Gem Version](https://badge.fury.io/rb/react_on_rails.svg)](https://badge.fury.io/rb/react_on_rails)
 
+# NEWS
+2.0 is about to ship! Please grab the latest and let us know if you see any issues!
+
+* https://rubygems.org/gems/react_on_rails
+* https://www.npmjs.com/package/react-on-rails
+* Branch: https://github.com/shakacode/react_on_rails/tree/npm-react-on-rails-js
+* PR: https://github.com/shakacode/react_on_rails/pull/148
+
 # React on Rails
 React on Rails integrates Facebook's [React](https://github.com/facebook/react) front-end framework with Rails. Currently, both React v0.14 and v0.13 are supported, with server rendering. [Redux](https://github.com/rackt/redux) and [React-Router](https://github.com/rackt/react-redux) are supported as well. See the Rails on Maui [blog post](http://www.railsonmaui.com/blog/2014/10/03/integrating-webpack-and-the-es6-transpiler-into-an-existing-rails-project/) that started it all!
 
@@ -106,10 +114,16 @@ 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"
+  gem "react_on_rails", "~> 2.0.0"
+  ```
+
+2. See help for the generator:
+
+  ```bash
+  rails generate react_on_rails:install --help
   ```
 
-2. Run the generator with a simple "Hello World" example:
+2. Run the generator with a simple "Hello World" example (more options below):
 
   ```bash
   rails generate react_on_rails:install

data/Rakefile

@@ -4,4 +4,4 @@ require "coveralls/rake/task"
 Coveralls::RakeTask.new
 
 desc "Run all tests and linting"
-task default: ["run_rspec", "docker:lint", "coveralls:push"]
+task default: ["run_rspec", "lint", "coveralls:push"]

data/docs/additional_reading/manual_installation.md

@@ -44,7 +44,7 @@ See the next section for a sample webpack.server.rails.config.js.
   entry: ['./app/startup/serverRegistration'],
   ```
 3. Ensure the name of your ouput file (shown [here](https://github.com/shakacode/react-webpack-rails-tutorial/blob/537c985dc82faee333d80509343ca32a3965f9dd/client/webpack.server.rails.config.js#L9)) of your server bundle corresponds to the configuration of the gem. The default path is `app/assets/javascripts/generated`. See below for customization of configuration variables.
-4. Expose `React` in your webpack config, like [this](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/webpack.server.rails.config.js#L23)
+4. Expose `React` in your webpack config, like [this](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/webpack.server.rails.build.config.js#L54-L55)
 
 ```javascript
 { test: require.resolve('react'), loader: 'expose?React' },
@@ -52,9 +52,8 @@ See the next section for a sample webpack.server.rails.config.js.
 // For React 0.14
 { test: require.resolve('react-dom/server'), loader: 'expose?ReactDOMServer' }, // not in client one, only server
 ```
-
-### Sample webpack.server.rails.config.js (ONLY for server rendering)
-Be sure to check out the latest example version of [client/webpack.server.rails.config.js](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/webpack.server.rails.config.js).
+### Sample webpack.server.rails.build.config.js (ONLY for server rendering)
+Be sure to check out the latest example version of [client/webpack.server.rails.build.config.js](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/webpack.server.rails.build.config.js).
 
 ```javascript
 // Common webpack configuration for server bundle

data/lib/generators/react_on_rails/base_generator.rb

@@ -1,12 +1,12 @@
 require "rails/generators"
-require File.expand_path("../generator_helper", __FILE__)
-
-include GeneratorHelper
+require_relative "generator_messages"
+require_relative "generator_helper"
 
 module ReactOnRails
   module Generators
     class BaseGenerator < Rails::Generators::Base # rubocop:disable Metrics/ClassLength
-      hide!
+      include GeneratorHelper
+      Rails::Generators.hide_namespace(namespace)
       source_root(File.expand_path("../templates", __FILE__))
 
       # --redux
@@ -62,7 +62,11 @@ module ReactOnRails
           /app/assets/javascripts/generated/*
         DATA
 
-        dest_file_exists?(".gitignore") ? append_to_file(".gitignore", data) : puts_setup_file_error(".gitignore", data)
+        if dest_file_exists?(".gitignore")
+          append_to_file(".gitignore", data)
+        else
+          GeneratorMessages.add_error(setup_file_error(".gitignore", data))
+        end
       end
 
       def update_application_js
@@ -111,6 +115,7 @@ module ReactOnRails
            client/.babelrc
            client/index.jade
            client/server.js
+           client/webpack.client.base.config.js
            client/webpack.client.rails.config.js
            REACT_ON_RAILS.md
            client/REACT_ON_RAILS_CLIENT_README.md
@@ -120,8 +125,9 @@ module ReactOnRails
       def template_base_files
         base_path = "base/base/"
         %w(Procfile.dev
+           Procfile.dev-hot
            app/views/hello_world/index.html.erb
-           client/webpack.client.base.config.js
+           client/app/bundles/HelloWorld/components/HelloWorldWidget.jsx
            client/webpack.client.hot.config.js
            client/package.json).each { |file| template(base_path + file + ".tt", file) }
       end

data/lib/generators/react_on_rails/bootstrap_generator.rb

@@ -1,11 +1,12 @@
 require "rails/generators"
-require File.expand_path("../generator_helper", __FILE__)
-include GeneratorHelper
+require_relative "generator_helper"
+require_relative "generator_messages"
 
 module ReactOnRails
   module Generators
     class BootstrapGenerator < Rails::Generators::Base
-      hide!
+      include GeneratorHelper
+      Rails::Generators.hide_namespace(namespace)
       source_root(File.expand_path("../templates", __FILE__))
 
       def copy_bootstrap_files
@@ -54,7 +55,7 @@ module ReactOnRails
         if File.exist?(application_scss)
           append_to_file(application_scss, data)
         else
-          puts_setup_file_error(application_scss, data)
+          GeneratorMessages.add_error(setup_file_error(application_scss, data))
         end
       end
 

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -1,11 +1,11 @@
 require "rails/generators"
 require_relative "generator_helper"
-include GeneratorHelper
 
 module ReactOnRails
   module Generators
     class DevTestsGenerator < Rails::Generators::Base
-      hide!
+      include GeneratorHelper
+      Rails::Generators.hide_namespace(namespace)
       source_root(File.expand_path("../templates/dev_tests", __FILE__))
 
       def copy_rspec_files
@@ -28,6 +28,24 @@ module ReactOnRails
         File.open(package_json, "w+") { |f| f.puts new_contents }
       end
 
+      def change_webpack_client_base_config_to_include_fallback
+        text = <<-TEXT
+  },
+
+  // This fixes an issue with resolving 'react' when using a local symlinked version
+  // of the node_package folder
+  resolveLoader: {
+    fallback: [path.join(__dirname, 'node_modules')],
+  },
+  plugins: [
+TEXT
+        sentinel = /^\s\s},\n\s\splugins: \[\n/
+        config = File.join(destination_root, "client", "webpack.client.base.config.js")
+        old_contents = File.read(config)
+        new_contents = old_contents.gsub(sentinel, text)
+        File.open(config, "w+") { |f| f.puts new_contents }
+      end
+
       def add_test_related_gems_to_gemfile
         gem("rspec-rails", group: :test)
         gem("capybara", group: :test)

data/lib/generators/react_on_rails/generator_helper.rb

@@ -1,3 +1,5 @@
+require "rainbow"
+
 module GeneratorHelper
   # Takes a relative path from the destination root, such as `.gitignore` or `app/assets/javascripts/application.js`
   def dest_file_exists?(file)
@@ -10,11 +12,12 @@ module GeneratorHelper
     Dir.exist?(dest_dir) ? dest_dir : nil
   end
 
-  # Takes the missing file and the
-  def puts_setup_file_error(file, data)
-    puts "** #{file} was not found."
-    puts "Please add the following content to your #{file} file:"
-    puts "\n#{data}\n"
+  def setup_file_error(file, data)
+    <<-MSG
+#{file} was not found.
+Please add the following content to your #{file} file:
+#{data}
+    MSG
   end
 
   def empty_directory_with_keep_file(destination, config = {})

data/lib/generators/react_on_rails/generator_messages.rb

@@ -0,0 +1,39 @@
+module GeneratorMessages
+  class << self
+    def output
+      @output ||= []
+    end
+
+    def add_error(message)
+      output << format_error(message)
+    end
+
+    def add_warning(message)
+      output << format_warning(message)
+    end
+
+    def add_info(message)
+      output << format_info(message)
+    end
+
+    def errors
+      output
+    end
+
+    def format_error(msg)
+      Rainbow("ERROR: #{msg}").red
+    end
+
+    def format_warning(msg)
+      Rainbow("WARNING: #{msg}").orange
+    end
+
+    def format_info(msg)
+      Rainbow("#{msg}").green
+    end
+
+    def clear
+      @output = []
+    end
+  end
+end

data/lib/generators/react_on_rails/heroku_deployment_generator.rb

@@ -1,11 +1,11 @@
 require "rails/generators"
-require File.expand_path("../generator_helper", __FILE__)
-include GeneratorHelper
+require_relative "generator_helper"
 
 module ReactOnRails
   module Generators
     class HerokuDeploymentGenerator < Rails::Generators::Base
-      hide!
+      include GeneratorHelper
+      Rails::Generators.hide_namespace(namespace)
       source_root(File.expand_path("../templates", __FILE__))
 
       def copy_heroku_deployment_files

data/lib/generators/react_on_rails/install_generator.rb

@@ -1,8 +1,12 @@
 require "rails/generators"
+require_relative "generator_helper"
+require_relative "generator_messages"
 
 module ReactOnRails
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      include GeneratorHelper
+
       # fetch USAGE file for details generator description
       source_root(File.expand_path("../", __FILE__))
 
@@ -43,14 +47,32 @@ module ReactOnRails
                    desc: "Skip integrating Bootstrap and don't initialize files and regarding configs. Default: false",
                    aliases: "-b"
 
+      # --ignore-warnings
+      class_option :ignore_warnings,
+                   type: :boolean,
+                   default: false,
+                   desc: "Skip warnings. Default: false"
+
       def run_generators
-        return unless installation_prerequisites_met?
-        warn_if_nvm_is_not_installed
-        invoke_generators
+        if installation_prerequisites_met? || options.ignore_warnings?
+          invoke_generators
+        else
+          error = "react_on_rails generator prerequisites not met!"
+          GeneratorMessages.add_error(error)
+          # fail("react_on_rails generator prerequisites not met!")
+        end
+      ensure
+        print_errors
       end
 
+      # Everything here is not run automatically b/c it's private
+
       private
 
+      def print_errors
+        GeneratorMessages.errors.each { |errors| puts errors }
+      end
+
       def invoke_generators # rubocop:disable Metrics/CyclomaticComplexity
         invoke "react_on_rails:base"
         invoke "react_on_rails:react_no_redux" unless options.redux?
@@ -70,29 +92,27 @@ module ReactOnRails
 
       def missing_npm?
         return false unless `which npm`.blank?
-        error = "** npm is required. Please install it before continuing."
+        error = "npm is required. Please install it before continuing. "
         error << "https://www.npmjs.com/"
-        puts error
+        GeneratorMessages.add_error(error)
+        true
       end
 
       def missing_node?
         return false unless `which node`.blank?
-        error = "** nodejs is required. Please install it before continuing."
+        error = "** nodejs is required. Please install it before continuing. "
         error << "https://nodejs.org/en/"
-        puts error
+        GeneratorMessages.add_error(error)
+        true
       end
 
       def uncommitted_changes?
         return false if ENV["COVERAGE"]
         status = `git status`
         return false if status.include?("nothing to commit, working directory clean")
-        error = "** You have uncommitted code. Please commit or stash your changes before continuing"
-        puts error
-      end
-
-      def warn_if_nvm_is_not_installed
-        return true unless `which nvm`.blank?
-        puts "** nvm is advised. Please consider installing it. https://github.com/creationix/nvm"
+        error = "You have uncommitted code. Please commit or stash your changes before continuing"
+        GeneratorMessages.add_error(error)
+        true
       end
     end
   end