react_on_rails 1.1.1 → 1.2.0.rc1

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

@@ -0,0 +1,21 @@
+# Starts SimpleCov for code coverage.
+
+if ENV["COVERAGE"]
+  require "simplecov"
+
+  # Using a command name prevents results from getting clobbered by other test suites
+  example_name = File.basename(File.expand_path("../../../.", __FILE__))
+  SimpleCov.command_name(example_name)
+
+  SimpleCov.start("rails") do
+    # Consider the entire gem project as the root
+    # (typically this will be the folder named "react_on_rails")
+    gem_root_path = File.expand_path("../../../../.", __FILE__)
+    root gem_root_path
+
+    # Don't report anything that has "spec" in the path
+    add_filter do |src|
+      src.filename =~ %r{\/spec\/}
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+# rubocop:disable Style/BlockComments
+=begin
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+# rubocop:enable Style/BlockComments

data/lib/react_on_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactOnRails
-  VERSION = "1.1.1"
+  VERSION = "1.2.0.rc1"
 end

data/rakelib/docker.rake

@@ -0,0 +1,33 @@
+namespace :docker do
+  desc "Run Rubocop linter from docker"
+  task :rubocop do
+    sh "docker-compose run lint rake lint:rubocop"
+  end
+
+  desc "Run ruby-lint linter from docker"
+  task :ruby do
+    sh "docker-compose run lint rake lint:ruby"
+  end
+
+  desc "Run scss-lint linter from docker"
+  task :scss do
+    sh "docker-compose run lint rake lint:scss"
+  end
+
+  desc "Run eslint linter from docker"
+  task :eslint do
+    sh "docker-compose run lint rake lint:eslint"
+  end
+
+  desc "Run jscs linter from docker"
+  task :jscs do
+    sh "docker-compose run lint rake lint:jscs"
+  end
+  desc "Run all linting from docker"
+  task :lint do
+    sh "docker-compose run lint rake lint"
+  end
+end
+
+desc "Runs all linters from docker. Run `rake -D docker` to see all available lint options"
+task docker: ["docker:lint"]

data/rakelib/dummy_apps.rake

@@ -0,0 +1,29 @@
+require_relative "task_helpers"
+include ReactOnRails::TaskHelpers
+
+namespace :dummy_apps do
+  task :dummy_app do
+    dummy_app_dir = File.join(gem_root, "spec/dummy")
+    bundle_install_in(dummy_app_dir)
+    dummy_app_client_dir = File.join(dummy_app_dir, "client")
+    sh_in_dir(dummy_app_client_dir, ["npm install",
+                                     "$(npm bin)/webpack --config webpack.server.js",
+                                     "$(npm bin)/webpack --config webpack.client.js"])
+  end
+
+  task :dummy_react_013_app do
+    dummy_app_dir = File.join(gem_root, "spec/dummy-react-013")
+    bundle_install_in(dummy_app_dir)
+    dummy_app_client_dir = File.join(dummy_app_dir, "client")
+    sh_in_dir(dummy_app_client_dir, ["npm install",
+                                     "$(npm bin)/webpack --config webpack.server.js",
+                                     "$(npm bin)/webpack --config webpack.client.js"])
+  end
+
+  task dummy_apps: [:dummy_app, :dummy_react_013_app] do
+    puts "Prepared all Dummy Apps"
+  end
+end
+
+desc "Prepares all dummy apps by installing dependencies"
+task dummy_apps: ["dummy_apps:dummy_apps"]

data/rakelib/example_type.rb

@@ -0,0 +1,160 @@
+require "rake"
+require "pathname"
+
+require_relative "task_helpers"
+
+# Defines the ExampleType class, where each object represents a unique type of example
+# app that we can generate.
+module ReactOnRails
+  module TaskHelpers
+    class ExampleType
+      def self.all
+        @example_types ||= []
+      end
+
+      def self.namespace_name
+        "examples"
+      end
+
+      attr_reader :name, :generator_options
+
+      def initialize(name:, generator_options:)
+        @name = name
+        @generator_options = generator_options
+        self.class.all << self
+      end
+
+      def name_pretty
+        "#{@name} example app"
+      end
+
+      def server_rendering?
+        generator_options.include?("--server-rendering")
+      end
+
+      def dir
+        File.join(examples_dir, name)
+      end
+
+      def dir_exist?
+        Dir.exist?(dir)
+      end
+
+      def client_dir
+        File.join(dir, "client")
+      end
+
+      def source_package_json
+        File.join(gem_root, "lib/generators/react_on_rails/templates/base/base/client/package.json.tt")
+      end
+
+      def node_modules_dir
+        File.join(client_dir, "node_modules")
+      end
+
+      def webpack_bundles_dir
+        File.join(dir, "app", "assets", "javascripts", "generated")
+      end
+
+      def webpack_bundles
+        bundles = []
+        bundles << File.join(webpack_bundles_dir, "app-bundle.js")
+        bundles << File.join(webpack_bundles_dir, "server-bundle.js") if server_rendering?
+        bundles << File.join(webpack_bundles_dir, "vendor-bundle.js")
+      end
+
+      def gemfile
+        File.join(dir, "Gemfile")
+      end
+
+      def gemfile_lock
+        "#{gemfile}.lock"
+      end
+
+      def package_json
+        File.join(client_dir, "package.json")
+      end
+
+      # Gems we need to add to the Gemfile before bundle installing
+      def required_gems
+        relative_gem_root = Pathname(gem_root).relative_path_from(Pathname(dir))
+        ["gem 'react_on_rails', path: '#{relative_gem_root}'"]
+      end
+
+      # Options we pass when running `rails new` from the command-line
+      def rails_options
+        "--skip-bundle --skip-spring --skip-git --skip-test-unit --skip-active-record"
+      end
+
+      # Methods for retrieving the name of a task specific to the example type
+      %w(gen prepare clean clobber npm_install build_webpack_bundles).each do |task_type|
+        method = "#{task_type}_task_name"      # ex: `clean_task_name`
+        task_name = "#{task_type}_#{name}"     # ex: `clean_basic`
+
+        define_method(method) { "#{self.class.namespace_name}:#{task_name}" }
+        define_method("#{method}_short") { task_name }
+      end
+
+      def rspec_task_name_short
+        "example_#{name}"
+      end
+
+      def rspec_task_name
+        "run_rspec:#{rspec_task_name_short}"
+      end
+
+      def source_files
+        FileList.new(all_files_in_dir(generators_source_dir))
+      end
+
+      # Note: we need to explicitly declare a file we know is supposed to be there
+      # to indicate that the example is in need of being rebuilt in the case of its absence.
+      def generated_files
+        FileList.new(all_files_in_dir(dir)) do |fl|
+          fl.include(gemfile)                          # explicitly declared file (dependency of Gemfile.lock)
+          fl.include(package_json)                     # explicitly declared file (dependency of NPM Install)
+          fl.exclude(%r{client(/node_modules(.+)?)?$}) # leave node_modules folder
+        end
+      end
+
+      def generated_client_files
+        generated_files.exclude { |f| !f.start_with?(client_dir) }
+      end
+
+      # generated files plus explicitly included files resulting from running
+      # bundle install, npm install, and generating the webpack bundles
+      def prepared_files
+        generated_files
+          .include(webpack_bundles)
+          .include(node_modules_dir)
+          .include(gemfile_lock)
+      end
+
+      def clean_files
+        generated_files
+      end
+
+      # Assumes we are inside client folder
+      def build_webpack_bundles_shell_commands
+        webpack_command = File.join("$(npm bin)", "webpack")
+        shell_commands = []
+        shell_commands << "#{webpack_command} --config webpack.server.rails.config.js" if server_rendering?
+        shell_commands << "#{webpack_command} --config webpack.client.rails.config.js"
+      end
+
+      # Assumes we are inside a rails app's folder and necessary gems have been installed
+      def generator_shell_commands
+        shell_commands = []
+        shell_commands << "rails generate react_on_rails:install #{generator_options}"
+        shell_commands << "rails generate react_on_rails:dev_tests #{generator_options}"
+      end
+
+      private
+
+      # Defines globs that scoop up all files (including dotfiles) in given directory
+      def all_files_in_dir(p_dir)
+        [File.join(p_dir, "**", "*"), File.join(p_dir, "**", ".*")]
+      end
+    end
+  end
+end

data/rakelib/examples.rake

@@ -0,0 +1,103 @@
+# Defines tasks related to generating example apps using the gem's generator.
+# Allows us to create and test apps generated using a wide range of options.
+#
+# Also see example_type.rb
+
+require "yaml"
+require_relative "example_type"
+require_relative "task_helpers"
+include ReactOnRails::TaskHelpers
+
+namespace :examples do
+  # Loads data from examples_config.yml and instantiates corresponding ExampleType objects
+  examples_config_file = File.expand_path("../examples_config.yml", __FILE__)
+  examples_config = symbolize_keys(YAML.load(File.read(examples_config_file)))
+  examples_config[:example_type_data].each { |example_type_data| ExampleType.new(symbolize_keys(example_type_data)) }
+
+  # Define tasks for each example type
+  ExampleType.all.each do |example_type|
+    # GENERATED FILES
+    example_type.generated_files.each do |f|
+      file f => example_type.source_files do
+        Rake::Task[example_type.gen_task_name].invoke
+      end
+    end
+
+    # GEMFILE.LOCK
+    file example_type.gemfile_lock => example_type.gemfile do
+      bundle_install_in(example_type.dir)
+    end
+
+    # WEBPACK BUNDLES
+    example_type.webpack_bundles.each do |f|
+      file f => example_type.generated_client_files do
+        Rake::Task[example_type.build_webpack_bundles_task_name].invoke
+      end
+    end
+
+    # BUILD WEBPACK BUNDLES
+    task example_type.build_webpack_bundles_task_name_short => example_type.npm_install_task_name do
+      sh_in_dir(example_type.client_dir, example_type.build_webpack_bundles_shell_commands)
+    end
+
+    # NPM INSTALL
+    task example_type.npm_install_task_name_short => example_type.package_json do
+      unless uptodate?(example_type.node_modules_dir, [example_type.source_package_json])
+        sh_in_dir(example_type.client_dir, "npm install")
+      end
+    end
+
+    # CLEAN
+    desc "Cleans #{example_type.name_pretty}"
+    task example_type.clean_task_name_short do
+      example_type.clean_files.each { |f| rm_rf(f) }
+    end
+
+    # CLOBBER
+    desc "Clobbers (deletes) #{example_type.name_pretty}"
+    task example_type.clobber_task_name_short do
+      rm_rf(example_type.dir)
+    end
+
+    # GENERATE
+    desc "Generates #{example_type.name_pretty}"
+    task example_type.gen_task_name_short => example_type.clean_task_name do
+      mkdir_p(example_type.dir)
+      sh_in_dir(examples_dir, "rails new #{example_type.name} #{example_type.rails_options}")
+      append_to_gemfile(example_type.gemfile, example_type.required_gems)
+      bundle_install_in(example_type.dir)
+      sh_in_dir(example_type.dir, example_type.generator_shell_commands)
+    end
+
+    # PREPARE
+    desc "Prepares #{example_type.name_pretty} (generates example, `npm install`s, and generates webpack bundles)"
+    multitask example_type.prepare_task_name_short => example_type.prepared_files
+  end
+
+  desc "Cleans all example apps"
+  multitask clean: ExampleType.all.map(&:clean_task_name)
+
+  desc "Clobbers (deletes) all example apps"
+  task :clobber do
+    rm_rf(examples_dir)
+  end
+
+  desc "Generates all example apps"
+  multitask gen_all: ExampleType.all.map(&:gen_task_name)
+
+  desc "Prepares all example apps"
+  multitask prepare_all: ExampleType.all.map(&:prepare_task_name)
+end
+
+desc "Prepares all example apps. Run `rake -D examples` to see all available options"
+multitask examples: ["examples:prepare_all"]
+
+private
+
+# Appends each string in an array as a new line of text in the given Gemfile.
+# Automatically adds line returns.
+def append_to_gemfile(gemfile, lines)
+  old_text = File.read(gemfile)
+  new_text = lines.reduce(old_text) { |a, e| a << "#{e}\n" }
+  File.open(gemfile, "w") { |f| f.puts(new_text) }
+end