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

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

data/rakelib/examples_config.yml

@@ -0,0 +1,19 @@
+example_type_data:
+  -
+    name: basic
+    generator_options: ""
+  -
+    name: basic-server-rendering
+    generator_options: --server-rendering
+  -
+    name: redux
+    generator_options: --redux --server-rendering
+  -
+    name: redux-server-rendering
+    generator_options: --redux --server-rendering
+  -
+    name: heroku-deployment
+    generator_options: --heroku-deployment
+  -
+    name: skip-bootstrap
+    generator_options: --skip-bootstrap

data/rakelib/lint.rake

@@ -0,0 +1,37 @@
+require_relative "task_helpers"
+include ReactOnRails::TaskHelpers
+
+namespace :lint do
+  desc "Run Rubocop as shell"
+  task :rubocop do
+    sh_in_dir(gem_root, "rubocop .")
+  end
+
+  desc "Run ruby-lint as shell"
+  task :ruby do
+    sh_in_dir(gem_root, "ruby-lint app spec lib")
+  end
+
+  desc "Run scss-lint as shell"
+  task :scss do
+    sh_in_dir(gem_root, "scss-lint spec/dummy/app/assets/stylesheets/")
+  end
+
+  desc "Run eslint as shell"
+  task :eslint do
+    sh_in_dir(gem_root, "eslint . --ext .jsx and .js")
+  end
+
+  desc "Run jscs from shell"
+  task :jscs do
+    sh_in_dir(gem_root, "jscs -e -v .")
+  end
+
+  desc "Run all eslint, jscs, rubocop linters. Skip ruby-lint and scss"
+  task lint: [:eslint, :jscs, :rubocop] do
+    puts "Completed all linting"
+  end
+end
+
+desc "Runs all linters. Run `rake -D lint` to see all available lint options"
+task lint: ["lint:lint"]

data/rakelib/node_package.rake

@@ -0,0 +1,11 @@
+require_relative "task_helpers"
+include ReactOnRails::TaskHelpers
+
+namespace :node_package do
+  task :build do
+    sh 'npm run build'
+  end
+end
+
+desc "Prepares all node_package by building"
+task node_package: ["node_package:build"]

data/rakelib/run_rspec.rake

@@ -0,0 +1,65 @@
+require "coveralls/rake/task"
+require "pathname"
+
+require_relative "task_helpers"
+require_relative "example_type"
+
+include ReactOnRails::TaskHelpers
+
+namespace :run_rspec do
+  desc "Run RSpec for top level only"
+  task :gem do
+    run_tests_in("", rspec_args: "spec/react_on_rails")
+  end
+
+  task dummy: ["dummy_apps:dummy_app"] do
+    run_tests_in("spec/dummy", env_vars: "DRIVER=selenium_firefox")
+  end
+
+  # Dynamically define Rake tasks for each example app found in the examples directory
+  ExampleType.all.each do |example_type|
+    desc "Runs RSpec for #{example_type.name_pretty} only"
+    task example_type.rspec_task_name_short => example_type.prepare_task_name do
+      run_tests_in("#{File.basename(examples_dir)}/#{example_type.name}") # have to use relative path
+    end
+  end
+
+  desc "Runs Rspec for example apps only"
+  task examples: "examples:prepare_all" do
+    ExampleType.all.each { |example_type| Rake::Task[example_type.rspec_task_name].invoke }
+  end
+
+  desc "(HACK) Run RSpec on spec/empty_spec in order to have SimpleCov generate a coverage report from cache"
+  task :empty do
+    sh %(COVERAGE=true rspec spec/empty_spec.rb)
+  end
+
+  Coveralls::RakeTask.new
+
+  desc "run all tests"
+  task run_rspec: [:gem, :dummy, :examples, :empty, :js_tests, "coveralls:push"] do
+    puts "Completed all RSpec tests"
+  end
+end
+
+desc "js tests (same as 'npm run test')"
+task :js_tests do
+  sh "npm run test"
+end
+
+desc "Runs all tests. Run `rake -D run_rspec` to see all available test options"
+task run_rspec: ["run_rspec:run_rspec"]
+
+private
+
+# Runs rspec in the given directory (if string is passed, assumed to be relative
+# to root of the gem.
+# TEST_ENV_COMMAND_NAME is used to make SimpleCov.command_name unique in order to
+# prevent a name collision. Defaults to the given directory's name.
+def run_tests_in(dir, options = {})
+  dir = Pathname.new(File.join(gem_root, dir)) if dir.is_a?(String)
+  command_name = options.fetch(:command_name, dir.basename)
+  rspec_args = options.fetch(:rspec_args, "")
+  env_vars = %(#{options.fetch(env_vars, '')} COVERAGE=true TEST_ENV_COMMAND_NAME="#{command_name}")
+  sh_in_dir(dir, "#{env_vars} bundle exec rspec #{rspec_args}")
+end

data/rakelib/task_helpers.rb

@@ -0,0 +1,44 @@
+module ReactOnRails
+  module TaskHelpers
+    # Returns the root folder of the react_on_rails gem
+    def gem_root
+      File.expand_path("../../.", __FILE__)
+    end
+
+    # Returns the folder where examples are located
+    def examples_dir
+      File.join(gem_root, "examples")
+    end
+
+    def dummy_app_dirs
+      File.join(gem_root, "spec/dummy")
+    end
+
+    # Executes a string or an array of strings in a shell in the given directory
+    def sh_in_dir(dir, shell_commands)
+      shell_commands = [shell_commands] if shell_commands.is_a?(String)
+      shell_commands.each { |shell_command| sh %(cd #{dir} && #{shell_command.strip}) }
+    end
+
+    def bundle_install_in(dir)
+      sh_in_dir(dir, "bundle install")
+    end
+
+    # Runs bundle exec using that directory's Gemfile
+    def bundle_exec(dir:, args:, env_vars: "")
+      sh_in_dir(dir, "#{env_vars} #{args}")
+    end
+
+    def generators_source_dir
+      File.join(gem_root, "lib/generators/react_on_rails")
+    end
+
+    def symbolize_keys(hash)
+      hash.each_with_object({}) do |(key, value), new_hash|
+        new_key = key.is_a?(String) ? key.to_sym : key
+        new_value = value.is_a?(Hash) ? symbolize_keys(value) : value
+        new_hash[new_key] = new_value
+      end
+    end
+  end
+end

data/react_on_rails.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'react_on_rails/version'
+
+Gem::Specification.new do |s|
+  s.name          = "react_on_rails"
+  s.version       = ReactOnRails::VERSION
+  s.authors       = ["Justin Gordon"]
+  s.email         = ["justin@shakacode.com"]
+
+  s.summary       = %q{Rails with react server rendering with webpack. }
+  s.description   = %q{See README.md}
+  s.homepage      = "https://github.com/shakacode/react_on_rails"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples|node_modules|node_package|coverage)/}) }
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", ">= 3.2"
+  s.add_dependency "execjs", "~> 2.5"
+  s.add_dependency "connection_pool"
+
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "generator_spec"
+end

data/ruby-lint.yml

@@ -0,0 +1,24 @@
+# Not currently using ruby-lint
+---
+presenter: syntastic
+
+directories:
+  - app
+  - lib
+  - spec
+
+ignore_paths:
+  - client
+  - node_modules
+  - coverage
+  - examples
+
+analysis_classes:
+  #  - argument_amount
+  - pedantics
+  - shadowing_variables
+  # Too many false positives for these
+  #  - undefined_methods
+  #  - undefined_variables
+  #  - unused_variables
+  - useless_equality_checks

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.1
+  version: 2.0.0.beta.2
 platform: ruby
 authors:
 - Justin Gordon
@@ -128,7 +128,124 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".coveralls.yml"
+- ".dockerignore"
+- ".eslintignore"
+- ".eslintrc"
+- ".gitignore"
+- ".jscsrc"
+- ".npmignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".scss-lint.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Dockerfile_tests
+- Gemfile
+- README.md
+- Rakefile
+- app/helpers/react_on_rails_helper.rb
+- docker-compose.yml
+- docs/LICENSE
+- docs/additional_reading/heroku_deployment.md
+- docs/additional_reading/manual_installation.md
+- docs/additional_reading/node_dependencies_and_npm.md
+- docs/additional_reading/optional_configuration.md
+- docs/additional_reading/react-and-redux.md
+- docs/additional_reading/react_router.md
+- docs/additional_reading/server_rendering_tips.md
+- docs/additional_reading/tips.md
+- docs/additional_reading/webpack.md
+- docs/code_of_conduct.md
+- docs/coding-style/linters.md
+- docs/coding-style/style.md
+- docs/contributing.md
+- docs/generator_testing.md
+- docs/releasing.md
+- lib/generators/USAGE
+- lib/generators/react_on_rails/base_generator.rb
+- lib/generators/react_on_rails/bootstrap_generator.rb
+- lib/generators/react_on_rails/dev_tests_generator.rb
+- lib/generators/react_on_rails/generator_helper.rb
+- lib/generators/react_on_rails/heroku_deployment_generator.rb
+- lib/generators/react_on_rails/install_generator.rb
+- lib/generators/react_on_rails/js_linters_generator.rb
+- lib/generators/react_on_rails/react_no_redux_generator.rb
+- lib/generators/react_on_rails/react_with_redux_generator.rb
+- lib/generators/react_on_rails/ruby_linters_generator.rb
+- lib/generators/react_on_rails/templates/base/base/Procfile.dev.tt
+- lib/generators/react_on_rails/templates/base/base/REACT_ON_RAILS.md
+- lib/generators/react_on_rails/templates/base/base/app/controllers/hello_world_controller.rb
+- lib/generators/react_on_rails/templates/base/base/app/views/hello_world/index.html.erb.tt
+- lib/generators/react_on_rails/templates/base/base/client/.babelrc
+- lib/generators/react_on_rails/templates/base/base/client/REACT_ON_RAILS_CLIENT_README.md
+- lib/generators/react_on_rails/templates/base/base/client/app/bundles/HelloWorld/startup/clientRegistration.jsx.tt
+- lib/generators/react_on_rails/templates/base/base/client/index.jade
+- lib/generators/react_on_rails/templates/base/base/client/package.json.tt
+- lib/generators/react_on_rails/templates/base/base/client/server.js
+- lib/generators/react_on_rails/templates/base/base/client/webpack.client.base.config.js.tt
+- lib/generators/react_on_rails/templates/base/base/client/webpack.client.hot.config.js.tt
+- lib/generators/react_on_rails/templates/base/base/client/webpack.client.rails.config.js
+- lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb
+- lib/generators/react_on_rails/templates/base/base/lib/tasks/assets.rake.tt
+- lib/generators/react_on_rails/templates/base/base/lib/tasks/linters.rake.tt
+- lib/generators/react_on_rails/templates/base/base/package.json
+- lib/generators/react_on_rails/templates/base/server_rendering/client/app/bundles/HelloWorld/startup/serverRegistration.jsx
+- lib/generators/react_on_rails/templates/base/server_rendering/client/webpack.server.rails.config.js
+- lib/generators/react_on_rails/templates/bootstrap/app/assets/stylesheets/_bootstrap-custom.scss
+- lib/generators/react_on_rails/templates/bootstrap/client/assets/stylesheets/_post-bootstrap.scss
+- lib/generators/react_on_rails/templates/bootstrap/client/assets/stylesheets/_pre-bootstrap.scss
+- lib/generators/react_on_rails/templates/bootstrap/client/assets/stylesheets/_react-on-rails-sass-helper.scss
+- lib/generators/react_on_rails/templates/bootstrap/client/bootstrap-sass.config.js
+- lib/generators/react_on_rails/templates/dev_tests/.rspec
+- lib/generators/react_on_rails/templates/dev_tests/spec/features/hello_world_spec.rb
+- lib/generators/react_on_rails/templates/dev_tests/spec/rails_helper.rb
+- lib/generators/react_on_rails/templates/dev_tests/spec/simplecov_helper.rb
+- lib/generators/react_on_rails/templates/dev_tests/spec/spec_helper.rb
+- lib/generators/react_on_rails/templates/heroku_deployment/.buildpacks
+- lib/generators/react_on_rails/templates/heroku_deployment/Procfile
+- lib/generators/react_on_rails/templates/heroku_deployment/config/puma.rb
+- lib/generators/react_on_rails/templates/js_linters/client/.eslintignore
+- lib/generators/react_on_rails/templates/js_linters/client/.eslintrc
+- lib/generators/react_on_rails/templates/js_linters/client/.jscsrc
+- lib/generators/react_on_rails/templates/no_redux/base/client/app/bundles/HelloWorld/components/HelloWorldWidget.jsx
+- lib/generators/react_on_rails/templates/no_redux/base/client/app/bundles/HelloWorld/containers/HelloWorld.jsx
+- lib/generators/react_on_rails/templates/no_redux/base/client/app/bundles/HelloWorld/startup/HelloWorldAppClient.jsx.tt
+- lib/generators/react_on_rails/templates/no_redux/server_rendering/client/app/bundles/HelloWorld/startup/HelloWorldAppServer.jsx
+- lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/actions/helloWorldActionCreators.jsx
+- lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/components/HelloWorldWidget.jsx
+- lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/constants/helloWorldConstants.jsx
+- lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/containers/HelloWorld.jsx
+- lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/reducers/helloWorldReducer.jsx
+- lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/reducers/index.jsx
+- lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/startup/HelloWorldAppClient.jsx.tt
+- lib/generators/react_on_rails/templates/redux/base/client/app/bundles/HelloWorld/store/helloWorldStore.jsx
+- lib/generators/react_on_rails/templates/redux/base/client/app/lib/middlewares/loggerMiddleware.js
+- lib/generators/react_on_rails/templates/redux/server_rendering/client/app/bundles/HelloWorld/startup/HelloWorldAppServer.jsx
+- lib/generators/react_on_rails/templates/ruby_linters/.rubocop.yml
+- lib/generators/react_on_rails/templates/ruby_linters/.scss-lint.yml
+- lib/generators/react_on_rails/templates/ruby_linters/lib/tasks/brakeman.rake
+- lib/generators/react_on_rails/templates/ruby_linters/lib/tasks/ci.rake
+- lib/generators/react_on_rails/templates/ruby_linters/ruby-lint.yml
+- lib/react_on_rails.rb
+- lib/react_on_rails/configuration.rb
+- lib/react_on_rails/engine.rb
+- lib/react_on_rails/prerender_error.rb
+- lib/react_on_rails/server_rendering_pool.rb
+- lib/react_on_rails/version.rb
+- package.json
+- rakelib/docker.rake
+- rakelib/dummy_apps.rake
+- rakelib/example_type.rb
+- rakelib/examples.rake
+- rakelib/examples_config.yml
+- rakelib/lint.rake
+- rakelib/node_package.rake
+- rakelib/run_rspec.rake
+- rakelib/task_helpers.rb
+- react_on_rails.gemspec
+- ruby-lint.yml
 homepage: https://github.com/shakacode/react_on_rails
 licenses:
 - MIT