react_on_rails 2.0.0.beta.1 → 2.0.0.beta.2

data/lib/generators/react_on_rails/generator_helper.rb

@@ -0,0 +1,50 @@
+module GeneratorHelper
+  # Takes a relative path from the destination root, such as `.gitignore` or `app/assets/javascripts/application.js`
+  def dest_file_exists?(file)
+    dest_file = File.join(destination_root, file)
+    File.exist?(dest_file) ? dest_file : nil
+  end
+
+  def dest_dir_exists?(dir)
+    dest_dir = File.join(destination_root, dir)
+    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"
+  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,30 @@
+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
+           config/puma.rb).each { |file| copy_file("#{base_path}/#{file}", file) }
+      end
+
+      def add_heroku_production_gems
+        gem_text = <<-GEMS.strip_heredoc
+
+          # For Heroku deployment
+          gem 'rails_12factor', group: :production
+          gem 'puma', group: :production
+
+        GEMS
+        append_to_file("Gemfile", gem_text)
+      end
+    end
+  end
+end

data/lib/generators/react_on_rails/install_generator.rb

@@ -0,0 +1,99 @@
+require "rails/generators"
+
+module ReactOnRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      # fetch USAGE file for details generator description
+      source_root(File.expand_path("../", __FILE__))
+
+      # --redux
+      class_option :redux,
+                   type: :boolean,
+                   default: false,
+                   desc: "Install Redux gems and Redux version of Hello World Example. Default: false",
+                   aliases: "-R"
+      # --server-rendering
+      class_option :server_rendering,
+                   type: :boolean,
+                   default: false,
+                   desc: "Add necessary files and configurations for server-side rendering. Default: false",
+                   aliases: "-S"
+      # --skip-js-linters
+      class_option :skip_js_linters,
+                   type: :boolean,
+                   default: false,
+                   desc: "Skip installing JavaScript linting files. Default: false",
+                   aliases: "-j"
+      # --ruby-linters
+      class_option :ruby_linters,
+                   type: :boolean,
+                   default: false,
+                   desc: "Install ruby linting files, tasks, and configs. Default: false",
+                   aliases: "-L"
+      # --ruby-linters
+      class_option :heroku_deployment,
+                   type: :boolean,
+                   default: false,
+                   desc: "Install files necessary for deploying to Heroku. Default: false",
+                   aliases: "-H"
+      # --skip-bootstrap
+      class_option :skip_bootstrap,
+                   type: :boolean,
+                   default: false,
+                   desc: "Skip integrating Bootstrap and don't initialize files and regarding configs. Default: false",
+                   aliases: "-b"
+
+      def run_generators
+        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:heroku_deployment" if options.heroku_deployment?
+        invoke "react_on_rails:bootstrap" unless options.skip_bootstrap?
+      end
+
+      # 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/js_linters_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators"
+
+module ReactOnRails
+  module Generators
+    class JsLintersGenerator < Rails::Generators::Base
+      hide!
+      source_root File.expand_path("../templates", __FILE__)
+
+      # NOTE: linter modules are included via template in base/base/client/package.json.tt
+
+      def copy_js_linter_config_files
+        base_path = "js_linters/"
+        %w(client/.eslintrc
+           client/.eslintignore
+           client/.jscsrc).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,40 @@
+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).each do |file|
+             copy_file(base_path + file, file)
+           end
+      end
+
+      def copy_server_rendering_files_if_appropriate
+        return unless options.server_rendering?
+        base_path = "no_redux/server_rendering/"
+        file = "client/app/bundles/HelloWorld/startup/HelloWorldAppServer.jsx"
+        copy_file(base_path + file, file)
+      end
+
+      def template_appropriate_version_of_hello_world_app_client
+        filename = "HelloWorldAppClient.jsx"
+        location = "client/app/bundles/HelloWorld/startup"
+        template("no_redux/base/#{location}/HelloWorldAppClient.jsx.tt", "#{location}/#{filename}")
+      end
+    end
+  end
+end

data/lib/generators/react_on_rails/react_with_redux_generator.rb

@@ -0,0 +1,51 @@
+require "rails/generators"
+
+module ReactOnRails
+  module Generators
+    class ReactWithReduxGenerator < 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 create_redux_directories
+        dirs = %w(actions constants reducers store)
+        dirs.each { |name| empty_directory("client/app/bundles/HelloWorld/#{name}") }
+
+        empty_directory("client/app/lib/middlewares")
+      end
+
+      def copy_base_redux_files
+        base_path = "redux/base/"
+        %w(client/app/bundles/HelloWorld/actions/helloWorldActionCreators.jsx
+           client/app/bundles/HelloWorld/components/HelloWorldWidget.jsx
+           client/app/bundles/HelloWorld/containers/HelloWorld.jsx
+           client/app/bundles/HelloWorld/constants/helloWorldConstants.jsx
+           client/app/bundles/HelloWorld/reducers/helloWorldReducer.jsx
+           client/app/bundles/HelloWorld/reducers/index.jsx
+           client/app/bundles/HelloWorld/store/helloWorldStore.jsx
+           client/app/lib/middlewares/loggerMiddleware.js).each do |file|
+             copy_file(base_path + file, file)
+           end
+      end
+
+      def copy_server_rendering_redux_files
+        return unless options.server_rendering?
+        base_path = "redux/server_rendering/"
+        file = "client/app/bundles/HelloWorld/startup/HelloWorldAppServer.jsx"
+        copy_file(base_path + file, file)
+      end
+
+      def template_appropriate_version_of_hello_world_app_client
+        filename = "HelloWorldAppClient.jsx"
+        location = "client/app/bundles/HelloWorld/startup"
+        template("redux/base/#{location}/HelloWorldAppClient.jsx.tt", "#{location}/#{filename}")
+      end
+    end
+  end
+end

data/lib/generators/react_on_rails/ruby_linters_generator.rb

@@ -0,0 +1,33 @@
+require "rails/generators"
+
+module ReactOnRails
+  module Generators
+    class RubyLintersGenerator < Rails::Generators::Base
+      hide!
+      source_root File.expand_path("../templates", __FILE__)
+
+      def add_ruby_linter_gems_to_gemfile
+        linter_gems = <<-GEMS.strip_heredoc
+
+          # 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_ruby_linting_and_auditing_tasks
+        base_path = "ruby_linters/"
+        %w(lib/tasks/brakeman.rake
+           lib/tasks/ci.rake
+           .rubocop.yml
+           .scss-lint.yml
+           ruby-lint.yml).each { |file| copy_file(base_path + file, file) }
+      end
+    end
+  end
+end

data/lib/generators/react_on_rails/templates/base/base/Procfile.dev.tt

@@ -0,0 +1,4 @@
+web: rails s
+hot: sh -c 'cd client && npm start'
+client: sh -c 'rm app/assets/javascripts/generated/* || true && cd client && npm run build:dev:client'
+<%- if options.server_rendering? %>server: sh -c 'cd client && npm run build:dev:server'<%- end %>

data/lib/generators/react_on_rails/templates/base/base/REACT_ON_RAILS.md

@@ -0,0 +1,16 @@
+The `react_on_rails` gem has been installed. You can view the documentation online at
+[React on Rails](https://github.com/shakacode/react_on_rails).
+
+Also, check out the [example application](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/server.js)
+for a live example and code.
+
+The "Hello World" example has been installed.
+
++ The view is located at `app/views/hello_world/index.html.erb`
++ The controller is located at `app/controllers/hello_world_controller.rb`
+
+See [the documentation](https://github.com/shakacode/react_on_rails) for how to build your bundles and
+install your packages. Then you can view the example as follows:
+
+- Rails Server: [localhost:3000/hello_world](http://localhost:3000/hello_world)
+- Webpack Development Server with HMR: [localhost:4000/hello_world](http://localhost:4000/hello_world)

data/lib/generators/react_on_rails/templates/base/base/app/controllers/hello_world_controller.rb

@@ -0,0 +1,5 @@
+class HelloWorldController < ApplicationController
+  def index
+    @hello_world_props = { name: "Stranger" }
+  end
+end

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

@@ -0,0 +1,4 @@
+<h1 class="alert alert-info this-works"><%= options.server_rendering? ? "Server Rendering" : "Client Rendering" %></h1>
+<%%= react_component("HelloWorldApp",
+                     @hello_world_props,
+                     prerender: <%= options.server_rendering? %>) %>

data/lib/generators/react_on_rails/templates/base/base/client/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015", "stage-0", "react"]
+}

data/lib/generators/react_on_rails/templates/base/base/client/REACT_ON_RAILS_CLIENT_README.md

@@ -0,0 +1,3 @@
+Client folder generated by React on Rails gem.
+
+See documentation [on github](https://github.com/shakacode/react_on_rails) for details on how it is organized.

data/lib/generators/react_on_rails/templates/base/base/client/app/bundles/HelloWorld/startup/clientRegistration.jsx.tt

@@ -0,0 +1,5 @@
+import ReactOnRails from 'react-on-rails';
+import HelloWorldApp from './HelloWorldAppClient';
+
+// This is how react_on_rails can see the HelloWorldApp in the browser.
+ReactOnRails.register({ HelloWorldApp });

data/lib/generators/react_on_rails/templates/base/base/client/index.jade

@@ -0,0 +1,15 @@
+doctype html
+html
+
+  head
+    title Hello, React
+
+  body
+
+    h1.alert.alert-info.this-works webpack dev server (with HMR)
+    #app
+
+    script(src="vendor-bundle.js")
+    script(src="app-bundle.js")
+    script.
+      ReactOnRails.render("HelloWorldApp", {name: "Stranger"}, 'app');

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

@@ -0,0 +1,104 @@
+<%- require 'react_on_rails/version' -%>
+{
+  "name": "react-webpack-rails-tutorial",
+  "version": "1.1.0",
+  "description": "Built using the react_on_rails generator.",
+  "main": "server.js",
+  "engines": {
+    "node": "5.0.0",
+    "npm": "3.5.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/shakacode/react-webpack-rails-tutorial.git"
+  },
+  "keywords": [
+    "react",
+    "tutorial",
+    "comment",
+    "example"
+  ],
+  "author": "justin808",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/shakacode/react-webpack-rails-tutorial/issues"
+  },
+  "homepage": "https://github.com/shakacode/react-webpack-rails-tutorial",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node server.js",
+    "build:client": "NODE_ENV=production webpack --config webpack.client.rails.config.js",
+    "build:server": "NODE_ENV=production webpack --config webpack.server.rails.config.js",
+    "build:dev:client": "webpack -w --config webpack.client.rails.config.js",
+    "build:dev:server": "webpack -w --config webpack.server.rails.config.js"<% unless options.skip_js_linters? -%>,
+    "lint": "npm run eslint && npm run jscs",
+    "eslint": "eslint --ext .js,.jsx .",
+    "jscs": "jscs --verbose ."
+    <%- end -%>
+  },
+  "dependencies": {
+    "babel": "^6.3.26",
+    "babel-cli": "^6.3.17",
+    "babel-core": "^6.3.26",
+    "babel-loader": "^6.2.0",
+    "babel-plugin-syntax-decorators": "^6.3.13",
+    "babel-polyfill": "^6.3.14",
+    "babel-preset-es2015": "^6.3.13",
+    "babel-preset-react": "^6.3.13",
+    "babel-preset-stage-0": "^6.3.13",
+    "es5-shim": "^4.4.1",
+    "expose-loader": "^0.7.1",
+    <%- if options.redux? -%>
+    "immutable": "^3.7.5",
+    <%- end -%>
+    "imports-loader": "^0.6.5",
+    "jquery": "^2.1.4",
+    "jquery-ujs": "^1.1.0-1",
+    "loader-utils": "^0.2.11",
+    <%- if options.redux? -%>
+    "lodash": "^3.10.1",
+    "mirror-creator": "0.0.1",
+    <%- end -%>
+    "react": "^0.14.3",
+    <%- unless options.skip_bootstrap? -%>
+    "react-bootstrap": "^0.28.1",
+    <%- end -%>
+    "react-dom": "^0.14.3",
+    "react-on-rails": "<%= x = ReactOnRails::VERSION.match(/(\d+\.\d+\.\d+)[.\-](.*)/); "#{x[1]}-#{x[2]}" %>",
+    <%- if options.redux? -%>
+    "react-redux": "^4.0.5",
+    "redux": "^3.0.5",
+    "redux-promise": "^0.5.0",
+    "redux-thunk": "^1.0.2",
+    <%- end -%>
+    "webpack": "^1.12.8"
+  },
+  "devDependencies": {
+    <%- unless options.skip_js_linters? -%>
+    "babel-eslint": "^5.0.0-beta6",
+    <%- end -%>
+    "babel-plugin-react-transform": "^2.0.0",
+    <%- unless options.skip_bootstrap? -%>
+    "bootstrap-sass": "^3.3.5",
+    "bootstrap-sass-loader": "^1.0.9",
+    <%- end -%>
+    "css-loader": "^0.23.0",
+    <%- unless options.skip_js_linters? -%>
+    "eslint": "^1.10.3",
+    "eslint-config-airbnb": "^2.0.0",
+    "eslint-plugin-react": "^3.11.3",
+    <%- end -%>
+    "express": "^4.13.3",
+    "file-loader": "^0.8.4",
+    "jade": "^1.11.0",
+    <%- unless options.skip_js_linters? -%>
+    "jscs": "^2.7.0",
+    <%- end -%>
+    "node-sass": "^3.4.2",
+    "react-transform-hmr": "^1.0.1",
+    "sass-loader": "^3.1.1",
+    "style-loader": "^0.13.0",
+    "url-loader": "^0.5.6",
+    "webpack-dev-server": "^1.12.1"
+  }
+}