react_on_rails 1.1.1 → 1.2.0.rc1

data/docs/generator_testing.md

@@ -0,0 +1,20 @@
+# Generator Testing
+We create several applications that are examples of running the generator (see lib/generators/react_on_rails/install_generator.rb) with various different options. We can then run tests with these apps just like we would any Rails app and thus ensure that our generator makes apps that actually function properly.
+
+Special rake tasks in rakelib/examples.rake handle creating the example apps and running a special hidden generator (lib/generators/react_on_rails/dev_tests_generator.rb) that installs the tests we want to run for each app. These tests can be run manually like any Rails app, or they can be run via the `rake run_rspec:examples` command. There are also commands for running each app individually, i.e., `rake run_rspec:example_basic`.
+
+## Travis and Gemfiles
+We are currently using Travis for CI. Because of the way Travis works, it is not possible to `bundle install` multiple Gemfiles. Therefore, we have placed all dependencies for generated apps in the gem's main Gemfile. If you generate an app that has a new gem dependency in its Gemfile, you need to add that dependency to the main Gemfile or it will not work in CI.
+
+## Configuring what Apps are Generated
+You can specify additional apps to generate and test by adding to the rakelib/examples_config.yml file. The necessary build and test tasks will automatically be created for you dynamically at runtime.
+
+## More on the Rake Tasks
+In order to maximize efficiency, we took several steps to improve the performance of the rake tasks that utilize somewhat advanced rake functionality such as task dependencies, `file` tasks, task synthesizing, and concurrent tasks with `multitask`.
+
+For example, re-generating the app, running `npm install`, and re-generating the webpack bundles are all only done when they need to be done. Rake will also run certain tasks, including those that generate multiple applications, concurrently. When running `npm install`, this may produce strange-looking output due to the way the npm's console progress bar works. This is normal.
+
+For more insight, see:
+
+- [Avdi Grimm's series of articles on Rake](http://devblog.avdi.org/2014/04/30/learn-advanced-rake-in-7-episodes/)
+- [Martin Fowler's rake article](http://martinfowler.com/articles/rake.html)

data/lib/generators/react_on_rails/base_generator.rb

@@ -1,5 +1,6 @@
 require "rails/generators"
 require File.expand_path("../generator_helper", __FILE__)
+
 include GeneratorHelper
 
 module ReactOnRails
@@ -33,6 +34,13 @@ module ReactOnRails
                    desc: "Install ruby linting files, tasks, and configs",
                    aliases: "-L"
 
+      # --skip-bootstrap
+      class_option :skip_bootstrap,
+                   type: :boolean,
+                   default: false,
+                   desc: "Skip integrating Bootstrap and don't initialize files and regarding configs",
+                   aliases: "-b"
+
       def add_hello_world_route
         route "get 'hello_world', to: 'hello_world#index'"
       end
@@ -69,9 +77,6 @@ module ReactOnRails
           //= require generated/vendor-bundle
           //= require generated/app-bundle
 
-          // bootstrap-sprockets depends on generated/vendor-bundle for jQuery.
-          //= require bootstrap-sprockets
-
         DATA
 
         app_js_path = "app/assets/javascripts/application.js"
@@ -85,9 +90,9 @@ module ReactOnRails
 
       def strip_application_js_of_incompatible_sprockets_statements
         application_js = File.join(destination_root, "app/assets/javascripts/application.js")
-        gsub_file(application_js, "//= require jquery_ujs", "")
-        gsub_file(application_js, %r{//= require jquery$}, "")
-        gsub_file(application_js, "//= require_tree .", "")
+        gsub_file(application_js, "//= require jquery_ujs", "// require jquery_ujs")
+        gsub_file(application_js, %r{//= require jquery$}, "// require jquery")
+        gsub_file(application_js, %r{//= require_tree \.$}, "// require_tree .")
       end
 
       def strip_application_js_of_double_blank_lines
@@ -106,11 +111,8 @@ module ReactOnRails
            config/initializers/react_on_rails.rb
            client/.babelrc
            client/index.jade
-           client/npm-shrinkwrap.json
            client/server.js
-           client/webpack.client.hot.config.js
            client/webpack.client.rails.config.js
-           lib/tasks/assets.rake
            REACT_ON_RAILS.md
            client/REACT_ON_RAILS_CLIENT_README.md
            package.json).each { |file| copy_file(base_path + file, file) }
@@ -121,10 +123,12 @@ module ReactOnRails
         %w(Procfile.dev
            app/views/hello_world/index.html.erb
            client/webpack.client.base.config.js
+           client/webpack.client.hot.config.js
            client/package.json).each { |file| template(base_path + file + ".tt", file) }
       end
 
       def add_base_gems_to_gemfile
+        return unless options.server_rendering?
         append_to_file("Gemfile", "\ngem 'therubyracer', platforms: :ruby\n")
       end
 
@@ -147,6 +151,42 @@ module ReactOnRails
         return if !options.ruby_linters? && options.skip_js_linters?
         template("base/base/lib/tasks/linters.rake.tt", "lib/tasks/linters.rake")
       end
+
+      def template_assets_rake_file
+        template("base/base/lib/tasks/assets.rake.tt", "lib/tasks/assets.rake")
+      end
+
+      def append_to_assets_initializer
+        data = <<-DATA.strip_heredoc
+          # Add client/assets/ folders to asset pipeline's search path.
+          # If you do not want to move existing images and fonts from your Rails app
+          # you could also consider creating symlinks there that point to the original
+          # rails directories. In that case, you would not add these paths here.
+          Rails.application.config.assets.paths << Rails.root.join("client", "assets", "stylesheets")
+          Rails.application.config.assets.paths << Rails.root.join("client", "assets", "images")
+          Rails.application.config.assets.paths << Rails.root.join("client", "assets", "fonts")
+          Rails.application.config.assets.precompile += %w( generated/server-bundle.js )
+        DATA
+        assets_intializer = File.join(destination_root, "config/initializers/assets.rb")
+        if File.exist?(assets_intializer)
+          append_to_file(assets_intializer, data)
+        else
+          create_file(assets_intializer, data)
+        end
+      end
+
+      # rename to application.scss from application.css or application.css.scss
+      def force_application_scss_naming_if_necessary
+        base_path = "app/assets/stylesheets/"
+        application_css = "#{base_path}application.css"
+        application_css_scss = "#{base_path}application.css.scss"
+
+        bad_name = dest_file_exists?(application_css) || dest_file_exists?(application_css_scss)
+        return unless bad_name
+
+        new_name = File.join(destination_root, "#{base_path}application.scss")
+        File.rename(bad_name, new_name)
+      end
     end
   end
 end

data/lib/generators/react_on_rails/bootstrap_generator.rb

@@ -8,21 +8,6 @@ module ReactOnRails
       hide!
       source_root(File.expand_path("../templates", __FILE__))
 
-      def append_to_assets_initializer
-        data = <<-DATA.strip_heredoc
-          # Add client/assets/ folders to asset pipeline's search path.
-          # If you do not want to move existing images and fonts from your Rails app
-          # you could also consider creating symlinks there that point to the original
-          # rails directories. In that case, you would not add these paths here.
-          Rails.application.config.assets.paths << Rails.root.join("client", "assets", "stylesheets")
-          Rails.application.config.assets.paths << Rails.root.join("client", "assets", "images")
-          Rails.application.config.assets.paths << Rails.root.join("client", "assets", "fonts")
-
-          Rails.application.config.assets.precompile += %w( generated/server-bundle.js )
-        DATA
-        append_to_file("config/initializers/assets.rb", data)
-      end
-
       def copy_bootstrap_files
         base_path = "bootstrap/"
         %w(app/assets/stylesheets/_bootstrap-custom.scss
@@ -32,19 +17,6 @@ module ReactOnRails
            client/bootstrap-sass.config.js).each { |file| copy_file(base_path + file, file) }
       end
 
-      # rename to application.scss from application.css or application.css.scss
-      def force_application_scss_naming_if_necessary
-        base_path = "app/assets/stylesheets/"
-        application_css = "#{base_path}application.css"
-        application_css_scss = "#{base_path}application.css.scss"
-
-        bad_name = dest_file_exists?(application_css) || dest_file_exists?(application_css_scss)
-        return unless bad_name
-
-        new_name = File.join(destination_root, "#{base_path}application.scss")
-        File.rename(bad_name, new_name)
-      end
-
       # if there still is not application.scss, just create one
       def create_application_scss_if_necessary
         path = File.join(destination_root, "app/assets/stylesheets/application.scss")
@@ -97,7 +69,20 @@ module ReactOnRails
       end
 
       def add_bootstrap_sprockets_to_application_js
-        # see base_generator.rb this is done there
+        data = <<-DATA.strip_heredoc
+
+          // bootstrap-sprockets depends on generated/vendor-bundle for jQuery.
+          //= require bootstrap-sprockets
+
+        DATA
+
+        app_js_path = "app/assets/javascripts/application.js"
+        found_app_js = dest_file_exists?(app_js_path) || dest_file_exists?(app_js_path + ".coffee")
+        if found_app_js
+          append_to_file(found_app_js, data)
+        else
+          create_file(app_js_path, data)
+        end
       end
     end
   end

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -0,0 +1,30 @@
+require "rails/generators"
+require_relative "generator_helper"
+include GeneratorHelper
+
+module ReactOnRails
+  module Generators
+    class DevTestsGenerator < Rails::Generators::Base
+      hide!
+      source_root(File.expand_path("../templates/dev_tests", __FILE__))
+
+      def copy_rspec_files
+        %w(spec/spec_helper.rb
+           spec/rails_helper.rb
+           spec/simplecov_helper.rb
+           .rspec).each { |file| copy_file(file) }
+      end
+
+      def copy_tests
+        %w(spec/features/hello_world_spec.rb).each { |file| copy_file(file) }
+      end
+
+      def add_test_related_gems_to_gemfile
+        gem("rspec-rails", group: :test)
+        gem("capybara", group: :test)
+        gem("selenium-webdriver", group: :test)
+        gem("coveralls", require: false)
+      end
+    end
+  end
+end

data/lib/generators/react_on_rails/install_generator.rb

@@ -34,20 +34,31 @@ module ReactOnRails
                    desc: "Install files necessary for deploying to Heroku",
                    aliases: "-H"
 
+      # --skip-bootstrap
+      class_option :skip_bootstrap,
+                   type: :boolean,
+                   default: false,
+                   desc: "Skip integrating Bootstrap and don't initialize files and regarding configs",
+                   aliases: "-b"
+
       def run_generators # rubocop:disable Metrics/CyclomaticComplexity
         return unless installation_prerequisites_met?
         warn_if_nvm_is_not_installed
+        invoke_generators
+      end
+
+      private
+
+      def invoke_generators # rubocop:disable Metrics/CyclomaticComplexity
         invoke "react_on_rails:base"
         invoke "react_on_rails:react_no_redux" unless options.redux?
         invoke "react_on_rails:react_with_redux" if options.redux?
         invoke "react_on_rails:js_linters" unless options.skip_js_linters?
         invoke "react_on_rails:ruby_linters" if options.ruby_linters?
-        invoke "react_on_rails:bootstrap"
         invoke "react_on_rails:heroku_deployment" if options.heroku_deployment?
+        invoke "react_on_rails:bootstrap" unless options.skip_bootstrap?
       end
 
-      private
-
       # NOTE: other requirements for existing files such as .gitignore or application.
       # js(.coffee) are not checked by this method, but instead produce warning messages
       # and allow the build to continue

data/lib/generators/react_on_rails/templates/base/base/app/views/hello_world/index.html.erb.tt

@@ -1,6 +1,5 @@
 <h1 class="alert alert-info this-works"><%= options.server_rendering? ? "Server Rendering" : "Client Rendering" %></h1>
 <%%= react_component("HelloWorldApp",
                      @hello_world_props,
-                     generator_function: false,
-                     prerender: <%= options.server_rendering? %>,
-                     trace: true) %>
+                     generator_function: true,
+                     prerender: <%= options.server_rendering? %>) %>

data/lib/generators/react_on_rails/templates/base/base/client/package.json.tt

@@ -4,8 +4,8 @@
   "description": "Built using the react_on_rails generator.",
   "main": "server.js",
   "engines": {
-    "node": "4.2.0",
-    "npm": "3.3.6"
+    "node": "5.0.0",
+    "npm": "3.5.0"
   },
   "repository": {
     "type": "git",
@@ -38,58 +38,61 @@
   "dependencies": {
     "babel-core": "^5.8.25",
     "babel-loader": "^5.3.2",
-    "es5-shim": "^4.1.14",
+    "body-parser": "^1.14.1",
+    "es5-shim": "^4.3.1",
     "es6-promise": "^3.0.2",
-    "expose-loader": "^0.7.0",
+    "expose-loader": "^0.7.1",
     <%- if options.redux? -%>
     "immutable": "^3.7.5",
     <%- end -%>
-    "imports-loader": "^0.6.4",
+    "imports-loader": "^0.6.5",
     "jquery": "^2.1.4",
     "jquery-ujs": "^1.1.0-1",
-    <%- if options.redux? -%>
-    "lodash": "https://registry.npmjs.org/lodash/-/lodash-3.10.1.tgz",
-    <%- end -%>
     "loader-utils": "^0.2.11",
     <%- if options.redux? -%>
+    "lodash": "^3.10.1",
     "mirror-creator": "0.0.1",
     <%- end -%>
     "react": "^0.14.0",
-    "react-bootstrap": "^0.27.0",
-    "react-dom": "^0.14.0",
+    <%- unless options.skip_bootstrap? -%>
+    "react-bootstrap": "^0.28.1",
+    <%- end -%>
+    "react-dom": "^0.14.3",
     <%- if options.redux? -%>
-    "react-redux": "^3.1.0",
-    "redux": "^3.0.2",
+    "react-redux": "^4.0.0",
+    "redux": "^3.0.4",
     "redux-promise": "^0.5.0",
     "redux-thunk": "^1.0.0",
     <%- end -%>
-    "webpack": "^1.12.2"
+    "webpack": "^1.12.8"
   },
   "devDependencies": {
     <%- unless options.skip_js_linters? -%>
-    "babel-eslint": "^4.1.3",
+    "babel-eslint": "^4.1.5",
     <%- end -%>
     "babel-plugin-react-transform": "^1.1.1",
+    <%- unless options.skip_bootstrap? -%>
     "bootstrap-sass": "^3.3.5",
     "bootstrap-sass-loader": "^1.0.9",
-    "css-loader": "^0.19.0",
+    <%- end -%>
+    "css-loader": "^0.23.0",
     <%- unless options.skip_js_linters? -%>
-    "eslint": "^1.6.0",
-    "eslint-config-airbnb": "0.1.0",
-    "eslint-plugin-react": "^3.5.1",
+    "eslint": "^1.10.1",
+    "eslint-config-airbnb": "1.0.0",
+    "eslint-plugin-react": "^3.10.0",
     <%- end -%>
     "esprima-fb": "^15001.1001.0-dev-harmony-fb",
     "express": "^4.13.3",
     "file-loader": "^0.8.4",
     "jade": "^1.11.0",
     <%- unless options.skip_js_linters? -%>
-    "jscs": "^2.3.0",
+    "jscs": "^2.6.0",
     <%- end -%>
-    "node-sass": "^3.3.3",
+    "node-sass": "^3.4.2",
     "react-transform-hmr": "^1.0.1",
-    "sass-loader": "^3.0.0",
-    "style-loader": "^0.12.4",
+    "sass-loader": "^3.1.1",
+    "style-loader": "^0.13.0",
     "url-loader": "^0.5.6",
-    "webpack-dev-server": "^1.12.0"
+    "webpack-dev-server": "^1.12.1"
   }
 }

data/lib/generators/react_on_rails/templates/base/base/client/{webpack.client.hot.config.js → webpack.client.hot.config.js.tt}

@@ -10,11 +10,13 @@ config.entry.app.push(
 
   // Webpack dev server
   'webpack-dev-server/client?http://localhost:4000',
-  'webpack/hot/dev-server',
+  'webpack/hot/dev-server'<%- unless options.skip_bootstrap? -%>,
 
   // See: https://github.com/shakacode/bootstrap-sass-loader
   // We're using the bootstrap-sass loader.
   'bootstrap-sass!./bootstrap-sass.config.js'
+  <%- end -%>
+
 );
 
 config.output = {

data/lib/generators/react_on_rails/templates/base/base/lib/tasks/{assets.rake → assets.rake.tt}

@@ -15,7 +15,9 @@ namespace :assets do
   desc "Compile assets with webpack"
   task :webpack do
     sh "cd client && npm run build:client"
+    <%- if options[:server_rendering] -%>
     sh "cd client && npm run build:server"
+    <%- end -%>
   end
 
   task :clobber do

data/lib/generators/react_on_rails/templates/base/server_rendering/client/webpack.server.rails.config.js

@@ -10,7 +10,7 @@ module.exports = {
 
   // the project dir
   context: __dirname,
-  entry: ['./app/bundles/HelloWorld/startup/serverGlobals'],
+  entry: ['./app/bundles/HelloWorld/startup/serverGlobals', 'react', 'react-dom/server'],
   output: {
     filename: 'server-bundle.js',
     path: '../app/assets/javascripts/generated',

data/lib/generators/react_on_rails/templates/dev_tests/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/lib/generators/react_on_rails/templates/dev_tests/spec/features/hello_world_spec.rb

@@ -0,0 +1,25 @@
+require_relative "../rails_helper"
+
+feature "Hello World", js: true do
+  scenario "the hello world example works" do
+    visit "/hello_world"
+    expect(heading).to have_text("Rendering")
+    expect(message).to have_text("Stranger")
+    name_input.set("John Doe")
+    expect(message).to have_text("John Doe")
+  end
+end
+
+private
+
+def name_input
+  page.first("input")
+end
+
+def message
+  page.first(:css, "h3")
+end
+
+def heading
+  page.first(:css, "h1")
+end

data/lib/generators/react_on_rails/templates/dev_tests/spec/rails_helper.rb

@@ -0,0 +1,57 @@
+# This file is copied to spec/ when you run "rails generate rspec:install"
+ENV["RAILS_ENV"] ||= "test"
+require_relative "../config/environment"
+require_relative "simplecov_helper"
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require_relative "spec_helper"
+
+# Add additional requires below this line. Rails is not loaded until this point!
+
+require "rspec/rails"
+require "capybara/rspec"
+require "capybara/rails"
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+# ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you"re not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you"re not using ActiveRecord, or you"d prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end