react_on_rails 1.2.2 → 2.0.0.beta.1

data/docs/coding-style/style.md

@@ -1,42 +0,0 @@
-# Code Style
-This document describes the coding style of [ShakaCode](http://www.shakacode.com). Yes, it's opinionated, as all style guidelines should be. We shall put as little as possible into this guide and instead rely on:
-
-* Use of linters with our standard linter configuration.
-* References to existing style guidelines that support the linter configuration.
-* Anything additional goes next.
-
-## Client Side JavaScript and React
-* Use [Redux](https://github.com/rackt/redux) for your flux store.
-* Use [Lodash](https://lodash.com/) rather than Underscore.
-* Place all JavaScript for the client app in `/client`
-* Organize your app into high level domains which map to JavaScript bundles. These are like mini-apps that live within your entire app. Create directories named like `/client/app/<bundle>` and configure Webpack to generate different corresponding bundles.
-* Carefully organize your React components into [Smart and Dumb Components](https://medium.com/@dan_abramov/smart-and-dumb-components-7ca2f9a7c7d0#.ygdkh1l7b):
-   1. "dumb" components that live in the `/client/app/<bundle>/components/` directories. These components should take props, including values and callbacks, and should not talk directly to Redux or any AJAX endpoints.
-   2. "smart" components that live in the `/client/app/<bundle>/containers/` directory. These components will talk to the Redux store and AJAX endpoints.
-* Place common code shared across bundles in `/client/app/libs` and configure Webpack to generate a common bundle for this one.
-* Prefix Immutable.js variable names and properties with `$$`. By doing this, you will clearly know that you are dealing with an Immutable.js object and not a standard JavaScript Object or Array.
-* Use ES6 classes rather than `React.createClass`.
-* Bind callbacks passed to react components with `_.bindAll` in the constructor unless you need to bind additional parameters. In that case, you can call `_.bind` within the rendering.
-
-## Style Guides to Follow
-Follow these style guidelines per the linter configuration. Basically, lint your code and if you have questions about the suggested fixes, look here:
-
-### Ruby Coding Standards
-* [RailsOnMaui Ruby Coding Standards](https://github.com/justin808/ruby)
-* [Ruby Documentation](http://guides.rubyonrails.org/api_documentation_guidelines.html)
-
-### JavaScript Coding Standards
-* [AirBnb Javascript](https://github.com/airbnb/javascript)
-* [JSDoc](http://usejsdoc.org/)
-
-### Git coding Standards
-* [Git Coding Standards](http://chlg.co/1GV2m9p)
-
-### Sass Coding Standards
-* [Sass Guidelines](http://sass-guidelin.es/) by [Hugo Giraudel](http://hugogiraudel.com/)
-* [Github Front End Guidelines](http://primercss.io/guidelines/)
-
-# Git Usage
-* Follow a github-flow model where you branch off of master for features.
-* Before merging a branch to master, rebase it on top of master, by using command like `git fetch; git checkout my-branch; git rebase -i origin/master`. Clean up your commit message at this point. Be super careful to communicate with anybody else working on this branch and do not do this when others have uncommitted changes. Ideally, your merge of your feature back to master should be one nice commit.
-* Run hosted CI and code coverage.

data/docs/contributing.md

@@ -1,62 +0,0 @@
-# Tips for Contributors
-
-## Development Setup for Gem Contributors
-
-### Checklist before Committing
-1. `rake ci`: runs all linters and specs (you need Docker setup, see below)
-2. Did you need any more tests for your change?
-3. Did you document your change? Update the README.md?
-
-### Initial Setup
-After checking out the repo, making sure you have rvm and nvm setup (setup ruby and node), cd to `spec/dummy` and run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-### Starting the Dummy App
-To run the test app, it's **CRITICAL** to not just run `rails s`. You have to run `foreman start`. If you don't do this, then `webpack` will not generate a new bundle, and you will be seriously confused when you change JavaScript and the app does not change.
-
-### RSpec Testing
-Run `rake` for testing the gem and `spec/dummy` and `spec/dummy-react-013`. Otherwise, the `rspec` command only works for testing within the sample apps, like `spec/dummy`.
-
-If you run `rspec` at the top level, you'll see this message: `require': cannot load such file -- rails_helper (LoadError)`
-
-After running a test, you can view the coverage results SimpleCov reports by opening `coverage/index.html`.
-
-### Debugging
-Start the sample app like this for some debug printing:
-
-```bash
-TRACE_REACT_ON_RAILS=true && foreman start
-```
-
-### Install Generator
-In your Rails app add this gem with a path to your fork.
-
-```
-gem 'react_on_rails', path: '/your_fork'
-```
-
-The main installer can be run with ```rails generate react_on_rails:install```
-
-### Testing the Generator
-The generators are covered by generator tests using Rails's generator testing helpers, but it never hurts to do a sanity check and explore the API. See [generator_testing_script.md](generator_testing_script.md) for a script on how to run the generator on a fresh project.
-
-### Linting
-All linting is performed from the docker container. You will need docker and docker-compose installed locally to lint code changes via the lint container.
-
-* [Install Docker Toolbox for Mac](https://www.docker.com/toolbox)
-* [Install Docker Compose for Linux](https://docs.docker.com/compose/install/)
-
-Once you have docker and docker-compose running locally, run `docker-compose build lint`. This will build the `reactonrails_lint` docker image and docker-compose `lint` container. The initial build is slow, but after the install, startup is very quick.
-
-### Linting Commands
-Run `rake -D docker` to see all docker linting commands for rake. `rake docker:lint` will run all linters. For individual rake linting commands please refer to `rake -D docker` for the list.
-
-You can run specific linting for directories or files by using `docker-compose run lint rubocop (file path or directory)`, etc.
-
-`docker-compose run lint bash` sets you up to run from the container command line. 
-
-### Docker CI - Test and Linting
-Docker CI and Tests containers have a xvfd server automatically started for headless browser testing with selenium and Firefox.
-
-Run `docker-compose build ci` to build the CI container. Run `docker-compose run ci` to start all rspec tests and linting. `docker-compose run --entrypoint=/bin/bash` will override the default CI action and place you inside the CI container in a bash session. This is what is run on Travis-CI.
-
-Run `docker-compose build tests` to build the tests container. Run `docker-compose run tests` to start all rspec tests.

data/docs/generator_testing.md

@@ -1,20 +0,0 @@
-# Generator Testing
-We create several applications that are examples of running the generator (see lib/generators/react_on_rails/install_generator.rb) with various different options. We can then run tests with these apps just like we would any Rails app and thus ensure that our generator makes apps that actually function properly.
-
-Special rake tasks in rakelib/examples.rake handle creating the example apps and running a special hidden generator (lib/generators/react_on_rails/dev_tests_generator.rb) that installs the tests we want to run for each app. These tests can be run manually like any Rails app, or they can be run via the `rake run_rspec:examples` command. There are also commands for running each app individually, i.e., `rake run_rspec:example_basic`.
-
-## Travis and Gemfiles
-We are currently using Travis for CI. Because of the way Travis works, it is not possible to `bundle install` multiple Gemfiles. Therefore, we have placed all dependencies for generated apps in the gem's main Gemfile. If you generate an app that has a new gem dependency in its Gemfile, you need to add that dependency to the main Gemfile or it will not work in CI.
-
-## Configuring what Apps are Generated
-You can specify additional apps to generate and test by adding to the rakelib/examples_config.yml file. The necessary build and test tasks will automatically be created for you dynamically at runtime.
-
-## More on the Rake Tasks
-In order to maximize efficiency, we took several steps to improve the performance of the rake tasks that utilize somewhat advanced rake functionality such as task dependencies, `file` tasks, task synthesizing, and concurrent tasks with `multitask`.
-
-For example, re-generating the app, running `npm install`, and re-generating the webpack bundles are all only done when they need to be done. Rake will also run certain tasks, including those that generate multiple applications, concurrently. When running `npm install`, this may produce strange-looking output due to the way the npm's console progress bar works. This is normal.
-
-For more insight, see:
-
-- [Avdi Grimm's series of articles on Rake](http://devblog.avdi.org/2014/04/30/learn-advanced-rake-in-7-episodes/)
-- [Martin Fowler's rake article](http://martinfowler.com/articles/rake.html)

data/docs/install_and_releasing.md

@@ -1,24 +0,0 @@
-### Install and Release
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Updating New Versions of the Gem
-See https://github.com/svenfuchs/gem-release
-
-```bash
-gem bump
-cd spec/dummy
-bundle
-git commit -am "Updated Gemfile.lock"
-cd ../..
-gem tag
-gem release
-```
-
-## Testing the Gem before Release from a Rails App
-If you want to test the gem with an application before you release a new version of the gem, you can specify the path to your local version via your test app's Gemfile:
-
-```ruby
-gem "react_on_rails", path: "../path-to-react-on-rails"
-```
-
-Note that you will need to bundle install after making this change, but also that **you will need to restart your Rails application if you make any changes to the gem**.

data/docs/sample_generated_js/README.md

@@ -1,4 +0,0 @@
-Files in this directory show what JS is generated for client and server rendering.
-
-* [client-generated.js](./client-generated.js)
-* [server-generated.js](./server-generated.js)

data/docs/sample_generated_js/client-generated.js

@@ -1,12 +0,0 @@
-(function() {
-  window.__helloWorldData0__ = {"helloWorldData":{"name":"Mr. Server Side Rendering"}};
-  ReactOnRails.clientRenderReactComponent({
-    componentName: 'HelloWorld',
-    domId: 'HelloWorld-react-component-0',
-    propsVarName: '__helloWorldData0__',
-    props: window.__helloWorldData0__,
-    trace: true,
-    generatorFunction: false,
-    expectTurboLinks: true
-  });
-})();

data/docs/sample_generated_js/server-generated.js

@@ -1,25 +0,0 @@
-(function() {
-  var htmlResult = '';
-  var consoleReplayScript = '';
-  var hasErrors = false;
-
-  try {
-    htmlResult =
-      (function() {
-        return this.HelloString.world();
-      })();
-  } catch(e) {
-    htmlResult = ReactOnRails.handleError({e: e, componentName: null,
-      jsCode: 'this.HelloString.world()', serverSide: true});
-    hasErrors = true;
-  }
-
-  consoleReplayScript = ReactOnRails.buildConsoleReplay();
-
-  return JSON.stringify({
-      html: htmlResult,
-      consoleReplayScript: consoleReplayScript,
-      hasErrors: hasErrors
-  });
-
-})()

data/lib/generators/USAGE

@@ -1,99 +0,0 @@
-Description:
-
-The react_on_rails:install generator combined with the example pull requests of
-generator runs will get you up and running efficiently. There's a fair bit of
-setup involved when ~with~ integrating Webpack with Rails. Defaults for options
-are such that the default is for the flag to be off. For example, the default for
-`-R` is that redux is off, and the default of -b means that skip-bootstrap is off.
-
-* Redux
-
-    Passing the --redux generator option causes the generated Hello World example
-    to integrate the Redux state container framework. The necessary node modules
-    will be automatically included for you.
-
-    The generator uses the organizational `paradigm of "bundles"`. These are like
-    application domains and are used for grouping your code into webpack bundles
-    in case you decide to create different bundles for deployment. This is also
-    useful for separating out logical parts of your application. We recommend that
-    that each bundle will have it's own Redux store. If you have code that you
-    want to reuse across bundles, such as middleware or common utilities, place them
-    under `/client/app/lib`. You can then import them in your client code:
-    `import MyModule from 'lib/MyModule'`; since we have configured webpack to
-    automatically resolve the word lib to point to this folder.
-
-* Using Images and Fonts
-
-    The generator has amended the folders created in `client/assets/` to Rails's
-    asset path. We recommend that if you have any existing assets that you want
-    to use with your client code, you should move them to these folders and use
-    webpack as normal. This allows webpack's development server to have access
-    to your assets, as it will not be able to see any assets in the default Rails
-    directories which are above the `/client` directory.
-
-    Alternatively, if you have many existing assets and don't wish to move them,
-    you could consider creating symlinks from `client/assets` that point to your
-    Rails assets folders inside of `app/assets/`. The assets there will then be
-    visible to both Rails and webpack.
-
-* Bootstrap Integration
-
-    React on Rails ships with Twitter Bootstrap already integrated into the build.
-    Note that the generator removes require_tree in both the application.js and
-    application.css.scss files. This is to ensure the correct load order for the
-    bootstrap integration, and is usually a good idea in general. You will therefore
-    need to explicitly require your files.
-
-    How the Bootstrap library is loaded depends upon whether one is using the Rails
-    server or the HMR development server.
-
-    1. Bootstrap via Rails Server
-
-        The Rails server loads bootstrap-sprockets, provided
-        by the bootstrap-sass ruby gem (added automatically to your Gemfile by
-        the generator), via the `app/assets/stylesheets/_bootstrap-custom.scss`
-        partial.
-
-        This allows for using Bootstrap in your regular Rails stylesheets. If you
-        wish to customize any of the Bootstrap variables, you can do so via the
-        `client/assets/stylesheets/_pre-bootstrap.scss` partial.
-
-    2. Bootstrap via Webpack Dev Server
-
-        The webpack dev server does not go through Rails but instead loads bootstrap
-        via the `bootstrap-sass-loader` webpack loader. You can configure the loader
-        via the `client/bootstrap-sass-config.js` file.
-
-    3. Keeping Custom Bootstrap Configurations Synced
-
-        Because the webpack dev server and Rails each load Bootstrap via a different
-        file (explained in the two sections immediately above), any changes to
-        the way components are loaded in one file must also be made to the other
-        file in order to keep styling consistent between the two. For example,
-        if an import is excluded in _bootstrap-custom.scss, the same import should
-        be excluded in `bootstrap-sass-config.js` so that styling in the Rails
-        server and the webpack dev server will be the same.
-
-    4. Skip Bootstrap Integration
-
-        Bootstrap integration is enabled by default, but can be disabled by passing
-        the --skip-bootstrap flag (alias -b). When you don't need Bootstrap in your
-        existing project, just skip it as needed.
-
-* JavaScript Linters
-
-    JavaScript linters are enabled by default, but can be disabled by passing the
-    --skip-js-linters flag (alias j), and those that run in Node have been add to
-    `client/package.json` under devDependencies.
-
-* Ruby Linters
-
-    Ruby linters are disabled by default, but can be enabled by passing the
-    `--ruby-linters` flag when generating. These linters have been added to your
-    Gemfile in addition to the the appropriate Rake tasks.
-
-    We really love using all the linters! Give them a try.
-
-More Details:
-
-    `https://github.com/shakacode/react_on_rails#generator`

data/lib/generators/react_on_rails/base_generator.rb

@@ -1,198 +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 BaseGenerator < Rails::Generators::Base # rubocop:disable Metrics/ClassLength
-      Rails::Generators.hide_namespace(namespace)
-      source_root(File.expand_path("../templates", __FILE__))
-
-      # --redux
-      class_option :redux,
-                   type: :boolean,
-                   default: false,
-                   desc: "Install Redux gems and Redux version of Hello World Example",
-                   aliases: "-R"
-      # --server-rendering
-      class_option :server_rendering,
-                   type: :boolean,
-                   default: false,
-                   desc: "Configure for server-side rendering of webpack JavaScript",
-                   aliases: "-S"
-      # --skip-js-linters
-      class_option :skip_js_linters,
-                   type: :boolean,
-                   default: false,
-                   desc: "Skip installing JavaScript linting files",
-                   aliases: "-j"
-      # --ruby-linters
-      class_option :ruby_linters,
-                   type: :boolean,
-                   default: false,
-                   desc: "Install ruby linting files, tasks, and configs",
-                   aliases: "-L"
-
-      # --skip-bootstrap
-      class_option :skip_bootstrap,
-                   type: :boolean,
-                   default: false,
-                   desc: "Skip integrating Bootstrap and don't initialize files and regarding configs",
-                   aliases: "-b"
-
-      def add_hello_world_route
-        route "get 'hello_world', to: 'hello_world#index'"
-      end
-
-      def create_client_assets_directories
-        empty_directory("client/assets")
-        empty_directory("client/assets/stylesheets")
-        empty_directory_with_keep_file("client/assets/fonts")
-        empty_directory_with_keep_file("client/assets/images")
-      end
-
-      def update_git_ignore
-        data = <<-DATA.strip_heredoc
-          # React on Rails
-          npm-debug.log
-          node_modules
-
-          # Generated js bundles
-          /app/assets/javascripts/generated/*
-        DATA
-
-        if dest_file_exists?(".gitignore")
-          append_to_file(".gitignore", data)
-        else
-          GeneratorErrors.add_error(return_setup_file_error(".gitignore", data))
-        end
-      end
-
-      def update_application_js
-        data = <<-DATA.strip_heredoc
-          // DO NOT REQUIRE jQuery or jQuery-ujs in this file!
-          // DO NOT REQUIRE TREE!
-
-          // CRITICAL that generated/vendor-bundle must be BEFORE bootstrap-sprockets and turbolinks
-          // since it is exposing jQuery and jQuery-ujs
-          //= require react_on_rails
-
-          //= require generated/vendor-bundle
-          //= require generated/app-bundle
-
-        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
-          prepend_to_file(found_app_js, data)
-        else
-          create_file(app_js_path, data)
-        end
-      end
-
-      def strip_application_js_of_incompatible_sprockets_statements
-        application_js = File.join(destination_root, "app/assets/javascripts/application.js")
-        gsub_file(application_js, "//= require jquery_ujs", "// require jquery_ujs")
-        gsub_file(application_js, %r{//= require jquery$}, "// require jquery")
-        gsub_file(application_js, %r{//= require_tree \.$}, "// require_tree .")
-      end
-
-      def strip_application_js_of_double_blank_lines
-        application_js = File.join(destination_root, "app/assets/javascripts/application.js")
-        gsub_file(application_js, /^\n^\n/, "\n")
-      end
-
-      def create_react_directories
-        dirs = %w(components containers startup)
-        dirs.each { |name| empty_directory("client/app/bundles/HelloWorld/#{name}") }
-      end
-
-      def copy_base_files
-        base_path = "base/base/"
-        %w(app/controllers/hello_world_controller.rb
-           config/initializers/react_on_rails.rb
-           client/.babelrc
-           client/index.jade
-           client/server.js
-           client/webpack.client.rails.config.js
-           REACT_ON_RAILS.md
-           client/REACT_ON_RAILS_CLIENT_README.md
-           package.json).each { |file| copy_file(base_path + file, file) }
-      end
-
-      def template_base_files
-        base_path = "base/base/"
-        %w(Procfile.dev
-           app/views/hello_world/index.html.erb
-           client/webpack.client.base.config.js
-           client/webpack.client.hot.config.js
-           client/package.json).each { |file| template(base_path + file + ".tt", file) }
-      end
-
-      def add_base_gems_to_gemfile
-        return unless options.server_rendering?
-        append_to_file("Gemfile", "\ngem 'therubyracer', platforms: :ruby\n")
-      end
-
-      def template_client_globals_file
-        filename = options.server_rendering? ? "clientGlobals.jsx" : "globals.jsx"
-        location = "client/app/bundles/HelloWorld/startup"
-        template("base/base/#{location}/globals.jsx.tt", "#{location}/#{filename}")
-      end
-
-      def install_server_rendering_files_if_enabled
-        return unless options.server_rendering?
-        base_path = "base/server_rendering/"
-        %w(client/webpack.server.rails.config.js
-           client/app/bundles/HelloWorld/startup/serverGlobals.jsx).each do |file|
-          copy_file(base_path + file, file)
-        end
-      end
-
-      def template_linter_files_if_appropriate
-        return if !options.ruby_linters? && options.skip_js_linters?
-        template("base/base/lib/tasks/linters.rake.tt", "lib/tasks/linters.rake")
-      end
-
-      def template_assets_rake_file
-        template("base/base/lib/tasks/assets.rake.tt", "lib/tasks/assets.rake")
-      end
-
-      def append_to_assets_initializer
-        data = <<-DATA.strip_heredoc
-          # Add client/assets/ folders to asset pipeline's search path.
-          # If you do not want to move existing images and fonts from your Rails app
-          # you could also consider creating symlinks there that point to the original
-          # rails directories. In that case, you would not add these paths here.
-          Rails.application.config.assets.paths << Rails.root.join("client", "assets", "stylesheets")
-          Rails.application.config.assets.paths << Rails.root.join("client", "assets", "images")
-          Rails.application.config.assets.paths << Rails.root.join("client", "assets", "fonts")
-          Rails.application.config.assets.precompile += %w( generated/server-bundle.js )
-        DATA
-        assets_intializer = File.join(destination_root, "config/initializers/assets.rb")
-        if File.exist?(assets_intializer)
-          append_to_file(assets_intializer, data)
-        else
-          create_file(assets_intializer, data)
-        end
-      end
-
-      # rename to application.scss from application.css or application.css.scss
-      def force_application_scss_naming_if_necessary
-        base_path = "app/assets/stylesheets/"
-        application_css = "#{base_path}application.css"
-        application_css_scss = "#{base_path}application.css.scss"
-
-        bad_name = dest_file_exists?(application_css) || dest_file_exists?(application_css_scss)
-        return unless bad_name
-
-        new_name = File.join(destination_root, "#{base_path}application.scss")
-        File.rename(bad_name, new_name)
-      end
-    end
-  end
-end