react_on_rails 1.0.0.pre → 1.0.0

data/docs/node_dependencies_and_npm.md

@@ -0,0 +1,29 @@
+# Node Dependencies and NPM
+## Updating
+After installing the files, you may want to update the node dependencies. This is analogous to updating gem versions:
+
+```bash
+cd client
+npm install -g npm-check-updates
+rm npm-shrinkwrap.json
+npm-check-updates -u
+npm install
+npm prune
+npm shrinkwrap
+```
+
+Confirm that the hot replacement dev server and the Rails server both work. You may have to delete `node_modules` and `npm-shrinkwrap.json` and then run `npm shrinkwrap`.
+
+*Note: `npm prune` is required before running `npm shrinkwrap` to remove dependencies that are no longer needed after doing updates.*
+
+## Adding New Dependencies
+Typically, you can add your Node dependencies as you normally would. Occasionally, adding a new dependency may require removing and re-running `npm shrinkwrap`:
+
+```bash
+cd client
+npm install --save module_name@version
+# or
+# npm install --save_dev module_name@version
+rm npm-shrinkwrap.json
+npm shrinkwrap
+```

data/lib/generators/react_on_rails/base_generator.rb

@@ -0,0 +1,116 @@
+require "rails/generators"
+require File.expand_path("../generator_helper", __FILE__)
+include GeneratorHelper
+
+module ReactOnRails
+  module Generators
+    class BaseGenerator < Rails::Generators::Base
+      hide!
+      source_root(File.expand_path("../templates", __FILE__))
+
+      # --server-rendering
+      class_option :server_rendering,
+                   type: :boolean,
+                   default: false,
+                   desc: "Configure for server-side rendering of webpack JavaScript",
+                   aliases: "-S"
+
+      def add_hello_world_route
+        route "get 'hello_world', to: 'hello_world#index'"
+      end
+
+      def create_client_assets_directories
+        empty_directory("client/assets")
+        empty_directory("client/assets/stylesheets")
+        empty_directory_with_keep_file("client/assets/fonts")
+        empty_directory_with_keep_file("client/assets/images")
+      end
+
+      def update_git_ignore
+        data = <<-DATA.strip_heredoc
+          # React on Rails
+          npm-debug.log
+          node_modules
+
+          # Generated js bundles
+          /app/assets/javascripts/generated/*
+        DATA
+
+        dest_file_exists?(".gitignore") ? append_to_file(".gitignore", data) : puts_setup_file_error(".gitignore", data)
+      end
+
+      def update_application_js
+        data = <<-DATA.strip_heredoc
+          // DO NOT REQUIRE jQuery or jQuery-ujs in this file!
+          // DO NOT REQUIRE TREE!
+
+          // CRITICAL that generated/vendor-bundle must be BEFORE bootstrap-sprockets and turbolinks
+          // since it is exposing jQuery and jQuery-ujs
+          //= require react_on_rails
+
+          //= require generated/vendor-bundle
+          //= require generated/app-bundle
+
+          // bootstrap-sprockets depends on generated/vendor-bundle for jQuery.
+          //= require bootstrap-sprockets
+        DATA
+
+        application_js_path = "app/assets/javascripts/application.js"
+        application_js = dest_file_exists?(application_js_path) || dest_file_exists?(application_js_path + ".coffee")
+        if application_js
+          prepend_to_file(application_js, data)
+        else
+          puts_setup_file_error("#{application_js} or #{application_js}.coffee", data)
+        end
+      end
+
+      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, "//= require jquery", "")
+        gsub_file(application_js, "//= require_tree .", "")
+      end
+
+      def strip_application_js_of_double_blank_lines
+        application_js = File.join(destination_root, "app/assets/javascripts/application.js")
+        gsub_file(application_js, /^\n^\n/, "\n")
+      end
+
+      def create_react_directories
+        dirs = %w(components containers startup)
+        dirs.each { |name| empty_directory("client/app/bundles/HelloWorld/#{name}") }
+      end
+
+      def copy_base_files
+        base_path = "base/base/"
+        %w(app/controllers/hello_world_controller.rb
+           config/initializers/react_on_rails.rb
+           client/.babelrc
+           client/index.jade
+           client/npm-shrinkwrap.json
+           client/server.js
+           client/webpack.client.base.config.js
+           client/webpack.client.hot.config.js
+           client/webpack.client.rails.config.js
+           client/app/bundles/HelloWorld/startup/clientGlobals.jsx
+           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) }
+      end
+
+      def template_base_files
+        base_path = "base/base/"
+        %w(Procfile.dev
+           app/views/hello_world/index.html.erb).each { |file| template(base_path + file + ".tt", file) }
+      end
+
+      def install_server_rendering_files_if_enabled
+        return unless options.server_rendering?
+        base_path = "base/server_rendering/"
+        %w(client/webpack.server.rails.config.js
+           client/app/bundles/HelloWorld/startup/serverGlobals.jsx).each { |file| copy_file(base_path + file, file) }
+      end
+    end
+  end
+end

data/lib/generators/react_on_rails/bootstrap_generator.rb

@@ -0,0 +1,84 @@
+require "rails/generators"
+require File.expand_path("../generator_helper", __FILE__)
+include GeneratorHelper
+
+module ReactOnRails
+  module Generators
+    class BootstrapGenerator < Rails::Generators::Base
+      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
+           client/assets/stylesheets/_post-bootstrap.scss
+           client/assets/stylesheets/_pre-bootstrap.scss
+           client/assets/stylesheets/_react-on-rails-sass-helper.scss
+           client/bootstrap-sass.config.js).each { |file| copy_file(base_path + file, file) }
+      end
+
+      def change_application_css_to_scss_if_necessary
+        stylesheets_path = File.join(destination_root, "app/assets/stylesheets")
+        application_css = File.join(stylesheets_path, "application.css")
+        return unless File.exist?(application_css)
+        File.rename(application_css, File.join(stylesheets_path, "application.css.scss"))
+      end
+
+      def prepend_to_application_scss
+        data = <<-DATA.strip_heredoc
+          // DO NOT REQUIRE TREE! It will interfere with load order!
+
+          // Account for differences between Rails and Webpack Sass code.
+          $rails: true;
+
+          // Included from bootstrap-sprockets gem and loaded in app/assets/javascripts/application.rb
+          @import 'bootstrap-sprockets';
+
+          // Customizations - needs to be imported after bootstrap-sprocket but before bootstrap-custom!
+          // The _pre-bootstrap.scss file is located under
+          // client/assets/stylesheets, which has been added to the Rails asset
+          // pipeline search path. See config/application.rb.
+          @import 'pre-bootstrap';
+
+          // These scss files are located under client/assets/stylesheets
+          // (which has been added to the Rails asset pipeline search path in config/application.rb).
+          @import 'bootstrap-custom';
+
+          // This must come after all the boostrap styles are loaded so that these styles can override those.
+          @import 'post-bootstrap';
+
+        DATA
+        append_to_file("app/assets/stylesheets/application.css.scss", data)
+      end
+
+      def strip_application_scss_of_incompatible_sprockets_statements
+        application_scss = File.join(destination_root, "app/assets/stylesheets/application.css.scss")
+        gsub_file(application_scss, "*= require_tree .", "")
+        gsub_file(application_scss, "*= require_self", "")
+      end
+
+      def add_bootstrap_sprockets_to_gemfile
+        gem("bootstrap-sass")
+      end
+
+      def add_bootstrap_sprockets_to_application_js
+        # see base_generator.rb this is done there
+      end
+    end
+  end
+end

data/lib/generators/react_on_rails/generator_helper.rb

@@ -0,0 +1,48 @@
+module GeneratorHelper
+  # Takes a relative path from the destination root, such as `.gitignore` or `app/assets/javascripts/application.js`
+  def dest_file_exists?(file)
+    File.exist?(File.join(destination_root, file)) ? file : nil
+  end
+
+  def dest_dir_exists?(dir)
+    Dir.exist?(File.join(destination_root, dir)) ? 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"
+  end
+
+  def empty_directory_with_keep_file(destination, config = {})
+    empty_directory(destination, config)
+    keep_file(destination)
+  end
+
+  def keep_file(destination)
+    create_file("#{destination}/.keep") unless options[:skip_keeps]
+  end
+
+  # As opposed to Rails::Generators::Testing.create_link, which creates a link pointing to
+  # source_root, this symlinks a file in destination_root to a file also in
+  # destination_root.
+  def symlink_dest_file_to_dest_file(target, link)
+    target_pathname = Pathname.new(File.join(destination_root, target))
+    link_pathname = Pathname.new(File.join(destination_root, link))
+
+    link_directory = link_pathname.dirname
+    link_basename = link_pathname.basename
+    target_relative_path = target_pathname.relative_path_from(link_directory)
+
+    `cd #{link_directory} && ln -s #{target_relative_path} #{link_basename}`
+  end
+
+  def copy_file_and_missing_parent_directories(source_file, destination_file = nil)
+    destination_file = source_file unless destination_file
+    destination_path = Pathname.new(destination_file)
+    parent_directories = destination_path.dirname
+    empty_directory(parent_directories) unless dest_dir_exists?(parent_directories)
+    copy_file source_file, destination_file
+  end
+end

data/lib/generators/react_on_rails/heroku_deployment_generator.rb

@@ -0,0 +1,22 @@
+require "rails/generators"
+require File.expand_path("../generator_helper", __FILE__)
+include GeneratorHelper
+
+module ReactOnRails
+  module Generators
+    class HerokuDeploymentGenerator < Rails::Generators::Base
+      hide!
+      source_root(File.expand_path("../templates", __FILE__))
+
+      def copy_heroku_deployment_files
+        base_path = "heroku_deployment"
+        %w(.buildpacks Procfile).each { |file| copy_file("#{base_path}/#{file}", file) }
+      end
+
+      def add_heroku_production_gems
+        production_gems = "# For Heroku deployment\ngem 'rails_12factor', group: :production\n"
+        append_to_file("Gemfile", production_gems)
+      end
+    end
+  end
+end

data/lib/generators/react_on_rails/install_generator.rb

@@ -0,0 +1,86 @@
+# Install Generator: gem's only public generator
+#
+# Usage:
+#   rails generate react_on_rails:install [options]
+#
+# Options:
+#   [--redux], [--no-redux]
+#     Indicates when to generate with redux
+#   [--server-rendering], [--no-server-rendering]
+#     Indicates whether ability for server-side rendering of webpack output should be enabled
+#   [--skip-linters]
+#     Indicates whether linter files and configs should be installed
+#
+require "rails/generators"
+
+module ReactOnRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      # --redux
+      class_option :redux,
+                   type: :boolean,
+                   default: false,
+                   desc: "Setup Redux files",
+                   aliases: "-R"
+      # --server-rendering
+      class_option :server_rendering,
+                   type: :boolean,
+                   default: false,
+                   desc: "Configure for server-side rendering of webpack JavaScript",
+                   aliases: "-S"
+      # --skip-linters
+      class_option :skip_linters,
+                   type: :boolean,
+                   default: false,
+                   desc: "Don't install linter files",
+                   aliases: "-L"
+
+      def run_generators
+        return unless installation_prerequisites_met?
+        warn_if_nvm_is_not_installed
+        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:linters" unless options.skip_linters?
+        invoke "react_on_rails:bootstrap"
+        invoke "react_on_rails:heroku_deployment"
+      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
+      def installation_prerequisites_met?
+        !(missing_node? || missing_npm? || uncommitted_changes?)
+      end
+
+      def missing_npm?
+        return false unless `which npm`.blank?
+        error = "** npm is required. Please install it before continuing."
+        error << "https://www.npmjs.com/"
+        puts error
+      end
+
+      def missing_node?
+        return false unless `which node`.blank?
+        error = "** nodejs is required. Please install it before continuing."
+        error << "https://nodejs.org/en/"
+        puts error
+      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"
+      end
+    end
+  end
+end

data/lib/generators/react_on_rails/linters_generator.rb

@@ -0,0 +1,38 @@
+require "rails/generators"
+
+module ReactOnRails
+  module Generators
+    class LintersGenerator < Rails::Generators::Base
+      hide!
+      source_root File.expand_path("../templates", __FILE__)
+
+      def add_linter_gems
+        linter_gems = <<-GEMS
+
+# require: false is necessary for the linters as we only want them loaded
+# when used by the linting rake tasks.
+group :development do
+  gem("rubocop", require: false)
+  gem("ruby-lint", require: false)
+  gem("scss_lint", require: false)
+end
+GEMS
+        append_to_file("Gemfile", linter_gems)
+      end
+
+      def copy_linter_config_files
+        base_path = "linters/"
+        %w(client/.eslintrc
+           client/.eslintignore
+           client/.jscsrc).each { |file| copy_file(base_path + file, file) }
+      end
+
+      def copy_linting_and_audting_tasks
+        base_path = "linters/"
+        %w(lib/tasks/brakeman.rake
+           lib/tasks/ci.rake
+           lib/tasks/linters.rake).each { |file| copy_file(base_path + file, file) }
+      end
+    end
+  end
+end

data/lib/generators/react_on_rails/react_no_redux_generator.rb

@@ -0,0 +1,37 @@
+require "rails/generators"
+require File.expand_path("../generator_helper", __FILE__)
+include GeneratorHelper
+
+module ReactOnRails
+  module Generators
+    class ReactNoReduxGenerator < Rails::Generators::Base
+      hide!
+      source_root(File.expand_path("../templates", __FILE__))
+
+      # --server-rendering
+      class_option :server_rendering,
+                   type: :boolean,
+                   default: false,
+                   desc: "Configure for server-side rendering of webpack JavaScript",
+                   aliases: "-S"
+
+      def copy_base_files
+        base_path = "no_redux/base/"
+        %w(client/app/bundles/HelloWorld/components/HelloWorldWidget.jsx
+           client/app/bundles/HelloWorld/containers/HelloWorld.jsx
+           client/app/bundles/HelloWorld/startup/HelloWorldAppClient.jsx).each do |file|
+             copy_file(base_path + file, file)
+           end
+        template("#{base_path}client/package.json", "client/package.json")
+      end
+
+      def copy_server_rendering_files_if_appropriate
+        return unless options.server_rendering?
+        base_path = "no_redux/server_rendering/"
+        %w(client/app/bundles/HelloWorld/startup/HelloWorldAppServer.jsx).each do |file|
+          copy_file(base_path + file, file)
+        end
+      end
+    end
+  end
+end