react_on_rails 1.1.1 → 1.2.0.rc1

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/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
+
+  desc "Run RSpec for spec/dummy only"
+  task dummy: ["dummy_apps:dummy_app"] do
+    run_tests_in("spec/dummy", env_vars: "DRIVER=selenium_firefox")
+  end
+
+  desc "Run RSpec for spec/dummy_react_013 only"
+  task dummy_react_013: ["dummy_apps:dummy_react_013_app"] do
+    run_tests_in("spec/dummy-react-013", 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
+
+  task run_rspec: [:gem, :dummy, :dummy_react_013, :examples, :empty, "coveralls:push"] do
+    puts "Completed all RSpec tests"
+  end
+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
+      %w(spec/dummy spec/dummy-react-013).map { |rel_dir| File.join(gem_root, rel_dir) }
+    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/ruby-lint.yml

@@ -11,6 +11,7 @@ ignore_paths:
   - client
   - node_modules
   - coverage
+  - examples
 
 analysis_classes:
   #  - argument_amount

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0.rc1
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-27 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -140,7 +140,6 @@ files:
 - ".rubocop.yml"
 - ".scss-lint.yml"
 - ".travis.yml"
-- Dockerfile_ci
 - Dockerfile_tests
 - Gemfile
 - README.md
@@ -157,17 +156,19 @@ files:
 - 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_script.md
+- docs/generator_testing.md
 - docs/install_and_releasing.md
 - docs/sample_generated_js/README.md
 - docs/sample_generated_js/client-generated.js
 - docs/sample_generated_js/server-generated.js
 - 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
@@ -187,10 +188,10 @@ files:
 - 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
+- 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
+- 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/serverGlobals.jsx
@@ -200,7 +201,11 @@ files:
 - 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/client/README.md
+- 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
@@ -232,6 +237,14 @@ files:
 - lib/react_on_rails/prerender_error.rb
 - lib/react_on_rails/server_rendering_pool.rb
 - lib/react_on_rails/version.rb
+- rakelib/docker.rake
+- rakelib/dummy_apps.rake
+- rakelib/example_type.rb
+- rakelib/examples.rake
+- rakelib/examples_config.yml
+- rakelib/lint.rake
+- rakelib/run_rspec.rake
+- rakelib/task_helpers.rb
 - react_on_rails.gemspec
 - ruby-lint.yml
 homepage: https://github.com/shakacode/react_on_rails
@@ -249,9 +262,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.0

data/Dockerfile_ci

@@ -1,12 +0,0 @@
-FROM dylangrafmyre/docker-ci
-
-WORKDIR /app/
-
-COPY ["/lib/react_on_rails/version.rb", "/app/lib/react_on_rails/"]
-COPY ["Gemfile", "Gemfile.lock", "react_on_rails.gemspec", "/app/"]
-COPY ["/spec/dummy/Gemfile", "/spec/dummy/Gemfile.lock", "/app/spec/dummy/"]
-RUN  bundle install --gemfile=spec/dummy/Gemfile
-
-ENV DISPLAY :99
-ENTRYPOINT service xvfd start \
-           && rake ci

data/docs/generator_testing_script.md

@@ -1,49 +0,0 @@
-Per running steps:
-​
-From directory of `react_on_rails`, with a test app named "react_on_rails_gen"
-
-```bash
-cd ..
-rails new react_on_rails_gen
-cd react_on_rails_gen
-git init
-git add .
-git commit -m "Rails new plus react_on_rails"
-```
-​
-Edit the Gemfile, adding these 2 lines:
-
-```ruby
-gem 'react_on_rails', path: '../react_on_rails'
-```
-
-Note the relative path to the react_on_rails gem.
-​
-```bash
-bundle
-git commit -am "added react_on_rails gem"
-```
-​
-You can now mess around with the generator:
-
-```bash
-# See available options
-rails generate react_on_rails:install --help
-# Actual install, for example, with Redux
-rails generate react_on_rails:install --redux
-```
-
-If you do actually run the generator, then you can see the changes that the generator made, ready for a commit.
-​
-Then run:
-​
-```bash
-cd client
-npm install
-cd ..
-foreman start -f Procfile.dev
-```
-​
-Then visit `localhost:3000/hello_world` to see it.
-​
-That's it!

data/lib/generators/react_on_rails/templates/client/README.md

@@ -1,97 +0,0 @@
-Example NPM Package
-===========================
-We've included an example package.json from https://github.com/shakacode/react-webpack-rails-tutorial which should get you started with your React project.
-
-Starting the node.js server:
-```
-npm start
-```
-
-Building client javascript files for production:
-```
-npm run build:client
-```
-
-Building server javascript files for production:
-```
-npm run build:server
-```
-
-Building client javascript files for development:
-```
-npm run build:dev:client
-```
-
-Building server javascript files for development:
-```
-npm run build:dev:server
-```
-
-Running all linters:
-```
-npm run lint
-```
-
-Running eslint:
-```
-npm run eslint
-```
-
-Running jscs:
-```
-npm run jscs
-```
-
-dependencies vs devDependencies
-===========================
-Anything needed for heroku deployment needs to go in "dependencies", and anything not needed for heroku deployment should go in "devDependencies".
-
-
-Updating Node Dependencies
-===========================
-
-```
-npm install -g npm-check-updates
-```
-
-Then run this to update the dependencies (starting at the top level).
-
-```
-# Make sure you are in the top directory, then run:
-cd client
-rm npm-shrinkwrap.json
-npm-check-updates -u
-npm install
-npm prune
-npm shrinkwrap
-```
-
-Then confirm that the hot reload server and the rails server both work fine. 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 Node Modules
-=====================================
-Suppose you want to add a dependency to "module_name"....
-
-Before you do so, consider:
-
-1. Do we really need the module and the extra JS code?
-2. Is the module well maintained?
-
-```bash
-cd client
-npm install --save module_name@version
-# or
-# npm install --save_dev module_name@version
-rm npm-shrinkwrap.json
-npm shrinkwrap
-```
-
-Setting Up a Basic REST API
-=====================================
-See server.js in our tutorial at
-https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/client/server.js