react_on_rails 1.2.2 → 2.0.0.beta.1

data/lib/generators/react_on_rails/bootstrap_generator.rb

@@ -1,91 +0,0 @@
-require "rails/generators"
-require File.expand_path("../generator_helper", __FILE__)
-require File.expand_path("../generator_errors", __FILE__)
-include GeneratorHelper
-include GeneratorErrors
-
-module ReactOnRails
-  module Generators
-    class BootstrapGenerator < Rails::Generators::Base
-      Rails::Generators.hide_namespace(namespace)
-      source_root(File.expand_path("../templates", __FILE__))
-
-      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
-
-      # 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")
-        return if File.exist?(path)
-        File.open(path, "w") { |f| f.puts "// Created by React on Rails gem\n\n" }
-      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
-
-        application_scss = File.join(destination_root, "app/assets/stylesheets/application.scss")
-
-        if File.exist?(application_scss)
-          append_to_file(application_scss, data)
-        else
-          GeneratorErrors.add_error(return_setup_file_error(application_scss, data))
-        end
-      end
-
-      def strip_application_scss_of_incompatible_sprockets_statements
-        application_scss = File.join(destination_root, "app/assets/stylesheets/application.scss")
-        gsub_file(application_scss, "*= require_tree .", "")
-        gsub_file(application_scss, "*= require_self", "")
-      end
-
-      def add_bootstrap_sprockets_to_gemfile
-        append_to_file("Gemfile", "gem 'bootstrap-sass'\n")
-      end
-
-      def add_bootstrap_sprockets_to_application_js
-        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
-end

data/lib/generators/react_on_rails/dev_tests_generator.rb

@@ -1,30 +0,0 @@
-require "rails/generators"
-require_relative "generator_helper"
-include GeneratorHelper
-
-module ReactOnRails
-  module Generators
-    class DevTestsGenerator < Rails::Generators::Base
-      Rails::Generators.hide_namespace(namespace)
-      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/generator_errors.rb

@@ -1,15 +0,0 @@
-module GeneratorErrors
-  class << self
-    def output
-      @output ||= []
-    end
-
-    def add_error(message)
-      output << message
-    end
-
-    def errors
-      output
-    end
-  end
-end

data/lib/generators/react_on_rails/generator_helper.rb

@@ -1,58 +0,0 @@
-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 return_setup_file_error(file, data)
-    error = ""
-    error << "** #{file} was not found.\n"
-    error << "Please add the following content to your #{file} file:\n"
-    error << "\n#{data}\n"
-    error
-  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

@@ -1,30 +0,0 @@
-require "rails/generators"
-require File.expand_path("../generator_helper", __FILE__)
-include GeneratorHelper
-
-module ReactOnRails
-  module Generators
-    class HerokuDeploymentGenerator < Rails::Generators::Base
-      Rails::Generators.hide_namespace(namespace)
-      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

@@ -1,111 +0,0 @@
-require "rails/generators"
-require File.expand_path("../generator_helper", __FILE__)
-require File.expand_path("../generator_errors", __FILE__)
-include GeneratorHelper
-include GeneratorErrors
-
-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 # rubocop:disable Metrics/CyclomaticComplexity
-        unless installation_prerequisites_met?
-          print_errors
-          return
-        end
-        warn_if_nvm_is_not_installed
-        invoke_generators
-        print_errors
-      end
-
-      private
-
-      def print_errors
-        GeneratorErrors.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?
-        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/"
-        GeneratorErrors.add_error(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/"
-        GeneratorErrors.add_error(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"
-        GeneratorErrors.add_error(error)
-      end
-
-      def warn_if_nvm_is_not_installed
-        return true unless `which nvm`.blank?
-        GeneratorErrors.add_error("** 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

@@ -1,19 +0,0 @@
-require "rails/generators"
-
-module ReactOnRails
-  module Generators
-    class JsLintersGenerator < Rails::Generators::Base
-      Rails::Generators.hide_namespace(namespace)
-      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

@@ -1,41 +0,0 @@
-require "rails/generators"
-require File.expand_path("../generator_helper", __FILE__)
-include GeneratorHelper
-
-module ReactOnRails
-  module Generators
-    class ReactNoReduxGenerator < Rails::Generators::Base
-      Rails::Generators.hide_namespace(namespace)
-      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/"
-        %w(client/app/bundles/HelloWorld/startup/HelloWorldAppServer.jsx).each do |file|
-          copy_file(base_path + file, file)
-        end
-      end
-
-      def template_appropriate_version_of_hello_world_app_client
-        filename = options.server_rendering? ? "HelloWorldAppClient.jsx" : "HelloWorldApp.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

@@ -1,52 +0,0 @@
-require "rails/generators"
-
-module ReactOnRails
-  module Generators
-    class ReactWithReduxGenerator < Rails::Generators::Base
-      Rails::Generators.hide_namespace(namespace)
-      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/"
-        %w(client/app/bundles/HelloWorld/startup/HelloWorldAppServer.jsx).each do |file|
-          copy_file(base_path + file, file)
-        end
-      end
-
-      def template_appropriate_version_of_hello_world_app_client
-        filename = options.server_rendering? ? "HelloWorldAppClient.jsx" : "HelloWorldApp.jsx"
-        location = "client/app/bundles/HelloWorld/startup"
-        template("redux/base/#{location}/HelloWorldAppClient.jsx.tt", "#{location}/#{filename}")
-      end
-    end
-  end
-end