react_on_rails 6.7.1 → 6.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c58c7ed04a4a64f4e0215a9d409f8628a66a988
-  data.tar.gz: a12a656c9a33e5f6c3fbdb71e4f0811a60b99ad5
+  metadata.gz: 2f90e045e3a38a60fd6d8c18a5fdc0f4394aa823
+  data.tar.gz: 20a924ea4c4c26fb07fb142a5735b3375e793299
 SHA512:
-  metadata.gz: ac418a4fc783db738ced2316c41e8f4031dcfd01eb50bf3afe0cce47470362ac0d212384a93be4a6d566cd110d2027205e7bd4fc840ee8c9b5952366fc26b749
-  data.tar.gz: a26293687d1ff59f02287ff5fb469b907f5eff5325d62833e2df1899d4bff6a2bf2d781826ffd4dda8b7ef6d1dd95f7207633bc9f069a4964283fefe72442b27
+  metadata.gz: 702935c99d5931284d920de52796f9479225055506a8833f525ac2e9fb7a4072aaf43277a5ce18ee3378ae6a0c9bdc1abeb06dc450b99253b6ac0d753129cde6
+  data.tar.gz: 1ea4f4477fac7e352ab972ea141fbbbcf5c0fde0d730063adaaa3daee8d363003154786f26ef46095992f796a0a4c9d8902b78ed2354b29f02453cda01783981

data/CHANGELOG.md

@@ -5,9 +5,28 @@ Contributors: please follow the recommendations outlined at [keepachangelog.com]
 
 ## [Unreleased]
 *Please add entries here for your pull requests.*
+## [6.7.2] - 2017-03-05
+### Improved
+- Improve i18n Integration with a better error message if the value of the i18n directory is invalid. [#748](https://github.com/shakacode/react_on_rails/pull/748) by [justin808](https://github.com/justin808).
+
+## [6.7.1] - 2017-02-28
+No changes other than a test fix.
 
 ## [6.7.0] - 2017-02-28
 
+### IMPORTANT
+- If you installed 6.6.0, you will need to comment out the line matching i18n_dir unless you are using this feature. 6.7.1 will give you an error like:
+
+```
+Errno::ENOENT: No such file or directory @ rb_sysopen - /tmp/build_1444a5bb9dd16ddb2561c7aff40f0fc7/my-app-816d31e9896edd90cecf1402acd002c724269333/client/app/libs/i18n/translations.js
+```
+
+Commenting out this line addresses the issue:
+
+```
+config.i18n_dir = Rails.root.join("client", "app", "libs", "i18n")
+``` 
+
 ### Added
 - Allow using rake task to generate javascript locale files. The test helper automatically creates the localization files when needed. [#717](https://github.com/shakacode/react_on_rails/pull/717) by [JasonYCHuang](https://github.com/JasonYCHuang).
 
@@ -190,7 +209,7 @@ Here is the addition to the generated config file:
 - Support for Node.js server side rendering. See [#380](https://github.com/shakacode/react_on_rails/pull/380) by [alleycat](https://github.com/alleycat-at-git) and [doc](https://github.com/shakacode/react_on_rails/blob/master/docs/additional-reading/node-server-rendering.md)
 
 ##### Removed
-- Generator removals to simplify installer. See [#363](https://github.com/shakacode/react_on_rails/pull/363) by [jbhatab](https://github.com/jbhatab).
+- Generator removals to simplify installer. See [#364](https://github.com/shakacode/react_on_rails/pull/364) by [jbhatab](https://github.com/jbhatab).
   - Removed options for heroku, boostrap, and the linters from generator.
   - Removed install for the Webpack Dev Server, as we can now do hot reloading with Rails, so the complexity of this feature is not justified. Nevertheless, the setup of React on Rails still supports this setup, just not with the generator.
   - Documentation added for removed installer options.
@@ -461,7 +480,9 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/6.7.0...master
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/6.7.2...master
+[6.7.2]: https://github.com/shakacode/react_on_rails/compare/6.7.1...6.7.2
+[6.7.1]: https://github.com/shakacode/react_on_rails/compare/6.7.0...6.7.1
 [6.7.0]: https://github.com/shakacode/react_on_rails/compare/6.6.0...6.7.0
 [6.6.0]: https://github.com/shakacode/react_on_rails/compare/6.5.1...6.6.0
 [6.5.1]: https://github.com/shakacode/react_on_rails/compare/6.5.0...6.5.1

data/PROJECTS.md

@@ -22,11 +22,15 @@
 
 ## Open Source Projects Live
 * [github.com/empirical-org/Empirical-Core](https://github.com/empirical-org/Empirical-Core): [Quill.org](https://quill.org/) Provides free tools to make your students better writers.
+* **[Coderwall](https://coderwall.com/)**: The latest development and design tips, tools, and projects from our developer community. Source at [github.com/coderwall/coderwall-next](https://github.com/coderwall/coderwall-next)
+* [department-of-veterans-affairs/caseflow](https://github.com/department-of-veterans-affairs/caseflow): Caseflow is a web application that enables the tracking and processing of appealed claims at the Board of Veterans' Appeals.
 
 ## Demos and Tutorials
 * [reactrails.com](http://www.reactrails.com), source code [github.com/shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/)
 * [Relay Rails Blog](https://github.com/gauravtiwari/relay-rails-blog): Tutorial to learn Relay with Rails.
-* [Hot Module Replacement with react_on_rails](https://medium.com/@hrishio/lesson-5-hot-module-replacement-for-react-in-rails-using-the-react-on-rails-gem-643c5b01f3d7#.ehevxok16) : Step-by-step tutorial for a quick basic set up of hot asset reloading with HMR in a Rails 5 app. [Code on Github](https://github.com/learnetto/calreact-hmr)
+* [Hot Module Replacement with react_on_rails](https://medium.com/@hrishio/lesson-5-hot-module-replacement-for-react-in-rails-using-the-react-on-rails-gem-643c5b01f3d7#.ehevxok16) : Step-by-step tutorial for a quick basic set up of hot asset reloading with HMR in a Rails 5 app. [Code on Github](https://github.com/learnetto/calreact-hmr).....
+
+## Per Github.
 
 --------
 

data/README.md

@@ -47,6 +47,7 @@ For more testimonials, see [Live Projects](PROJECTS.md) and [Kudos](./KUDOS.md).
 * [284 Ruby Rogues: React on Rails with Justin Gordon and Rob Wise](https://devchat.tv/ruby-rogues/284-rr-react-on-rails-with-justin-gordon-and-rob-wise)
 
 # NEWS
+* 2017-03-02: Demo of internationalization (i18n) is live at [reactrails.com](https://www.reactrails.com/). Docs [here](docs/basics/i18n.md).
 * 2017-02-28: See [discussions here on Webpacker](https://github.com/rails/webpacker/issues/139) regarding how Webpacker will allow React on Rails to avoid using the asset pipeline in the near future.
 * 2017-02-28: Upgrade to Webpack v2 or use the `--bail` option in your webpack script for test and production builds. See the discussion on [PR #730](https://github.com/shakacode/react_on_rails/pull/730).
 * 2016-11-03: Spoke at [LA Ruby: "React on Rails: Why, What, and How?"](http://www.meetup.com/laruby/events/234825187/). [Video and pictures in this article](https://blog.shakacode.com/my-react-on-rails-talk-at-the-la-ruby-rails-meetup-november-10-2016-eaaa83aff800#.ej6h4eglp).

data/SUMMARY.md

@@ -6,6 +6,7 @@
   + [Rails View Rendering from Inline JavaScript](./docs/additional-reading/rails_view_rendering_from_inline_javascript.md)
   + [RSpec Configuration](./docs/additional-reading/rspec-configuration.md)
   + [Turbolinks](./docs/additional-reading/turbolinks.md)
+  + [React on Rails Internationalization (I18n)](https://github.com/shakacode/react_on_rails/blob/master/docs/basics/i18n.md)
 
 ### **Javascript**
   + [Node Dependencies, NPM, and Yarn](./docs/additional-reading/node-dependencies-and-npm.md)

data/docs/additional-reading/recommended-project-structure.md

@@ -42,3 +42,8 @@ This technique involves customization of the webpack config files to generate CS
 1. You can use [CSS modules](https://github.com/css-modules/css-modules), which is super compelling once you seen the benefits.
 1. You can do hot reloading of your assets. Thus, you do not have to refresh your web page to see asset change, including changing styles.
 1. You can run your client code on a mocked out express server for super fast prototyping. In other words, your client application can somewhat more easily be move to a different application server.
+
+#### Updates 2017-03-04 Regarding CSS handled by Webpack
+* See article [Best practices for CSS and CSS Modules using Webpack](https://forum.shakacode.com/t/best-practices-for-css-and-css-modules-using-webpack/799).
+* In the near future, all docs will be updated to Webpack v2 and probably recommended to move all CSS handling to Webpack v2 for advanced users. In the near term, global CSS handled by Rails will be best for simple projects. Another data point is that Rails is moving in direction of handling JavaScript, but not CSS, with [Webpacker](https://github.com/rails/webpacker).
+

data/docs/basics/i18n.md

@@ -2,7 +2,7 @@
 
 Here's a summary of adding the I18n functionality.
 
-You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) and [PR #340](https://github.com/shakacode/react-webpack-rails-tutorial/pull/340) for a complete example.
+You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial) and [PR #340](https://github.com/shakacode/react-webpack-rails-tutorial/pull/340), [commmited](https://github.com/shakacode/react-webpack-rails-tutorial/commit/ef369ed9d922aea5116ca7e50208169fd7831389) for a complete example.
 
 1. Add `react-intl` & `intl` to `client/package.json`, and remember to `bundle && yarn install`.
 
@@ -15,40 +15,23 @@ You can refer to [react-webpack-rails-tutorial](https://github.com/shakacode/rea
   }
   ```
 
-2. In `client/webpack.client.base.config.js`, set `react-intl` as an entry point.
-
-  ```js
-  module.exports = {
-    ...
-    entry: {
-      ...
-      vendor: [
-        ...
-        'react-intl',
-      ],
-      ...
-  ```
-
-3. `react-intl` requires locale files in json format. React on Rails will help you to generate or update `translations.js` & `default.js` automatically after you configured the following settings.
+2. Add `config.i18n_dir` in `config/initializers/react_on_rails.rb`
   
-  > `translations.js`: All your locales in json format.
-  >
-  > `default.js`: Default settings in json format.
-  >
-  > You can add them to `.gitignore` and `.eslintignore`.
-  
-  Update settings in `config/initializers/react_on_rails.rb` to what you need:
+  `react-intl` requires locale files in json format. React on Rails will generate `translations.js` & `default.js` automatically after you configured your `config.i18n_dir` in `config/initializers/react_on_rails.rb`.
 
   ```ruby
   # Replace the following line to the location where you keep translation.js & default.js.
   config.i18n_dir = Rails.root.join("PATH_TO", "YOUR_JS_I18N_FOLDER")
   ```
+  
+  `translations.js`: All your locales in json format.
+  `default.js`: Default settings in json format.
 
+3. Add `translations.js` and `default.js` to your `.gitignore` and `.eslintignore`.
+  
 4. Javascript locale files must be generated before `yarn build`. 
   
-  Once you setup `config.i18n_dir` as in the previous step, react_on_rails will help you to do this for testing and for production deployments. For development, you should adjust your Procfiles so that they run `bundle exec rake react_on_rails:locale` before running the `yarn run build:development` (webpack watch process)
-
-  If you create your own Procfile files, you must add `bundle exec rake react_on_rails:locale` before `yarn build`.
+  Once you setup `config.i18n_dir` as in the previous step, react_on_rails will automatically do this for testing (if using the `ReactOnRails::TestHelper.configure_rspec_to_compile_assets` and for production deployments if using the [default precompile rake hook](../additional-reading/heroku-deployment.md). For development, you should adjust your startup scripts (Procfiles) so that they run `bundle exec rake react_on_rails:locale` before running any webpack watch process (`yarn run build:development`).
 
 5. In React, you need to initialize `react-intl`, and set parameters for it.
 

data/docs/tutorial.md

@@ -1,18 +1,14 @@
 # React on Rails Basic Tutorial
 
-This tutorial setups up a new Rails app with **React on Rails**, demonstrating Rails + React + Redux + Server Rendering.
+This tutorial setups up a new Rails app with **React on Rails**, demonstrating Rails + React + Redux + Server Rendering. It is updated to 6.7.1.
 
 After finishing this tutorial you will get application that can do the following (live on Heroku):
 
 ![example](https://cloud.githubusercontent.com/assets/371302/17368567/111cc722-596b-11e6-9b72-ac5967a60e42.gif)
 
 You can find here:
-* [Source code for this app](https://github.com/dzirtusss/hello-react-on-rails)
-* [Live on Heroku](https://hello-react-on-rails.herokuapp.com/)
-
-Old version of this app is here:
-* [Source code](https://github.com/justin808/test-react-on-rails-3)
-* [Live on Heroku](https://shakacode-react-on-rails.herokuapp.com/hello_world)
+* [Source code for this app in PR, using the --redux option](https://github.com/shakacode/react_on_rails-test-new-redux-generation/pull/15) and [for Heroku](https://github.com/shakacode/react_on_rails-test-new-redux-generation/pull/16).
+* [Live on Heroku](https://react-on-rails-redux-generator.herokuapp.com/)
 
 By the time you read this, the latest may have changed. Be sure to check the versions here:
 
@@ -69,7 +65,7 @@ git add -A
 git commit -m "Initial commit"
 ```
 
-update dependencies and generate empty app via `react_on_rails:install`. If you haven't done first git commit it will generate error and you just need to commit.
+update dependencies and generate empty app via `react_on_rails:install` or `react_on_rails:install --redux`. You need to first git commit your files before running the generator, or else it will generate an error.
 
 ```
 bundle
@@ -181,6 +177,32 @@ root "hello_world#index"
 
 ![09](https://cloud.githubusercontent.com/assets/20628911/17465018/1f3b685e-5cf4-11e6-93f8-105fc48517d0.png)
 
+Next, configure your app for Puma, per the [instructions on Heroku](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server).
+
+`Procfile`
+```
+web: bundle exec puma -C config/puma.rb
+```
+
+`config/puma.rb`
+```rb
+workers Integer(ENV['WEB_CONCURRENCY'] || 2)
+threads_count = Integer(ENV['RAILS_MAX_THREADS'] || 5)
+threads threads_count, threads_count
+
+preload_app!
+
+rackup      DefaultRackup
+port        ENV['PORT']     || 3000
+environment ENV['RACK_ENV'] || 'development'
+
+on_worker_boot do
+  # Worker specific setup for Rails 4.1+
+  # See: https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server#on-worker-boot
+  ActiveRecord::Base.establish_connection
+end
+```
+
 Then after all changes are done don't forget to commit them with git and finally you can push your app to Heroku!
 
 ```
@@ -191,9 +213,11 @@ git push heroku master
 
 ![10](https://cloud.githubusercontent.com/assets/20628911/17465017/1f38fbaa-5cf4-11e6-8d86-a3d91e3878e0.png)
 
-Here it is:
+## Links
+These are updated for 6.7.1:
 
-* [Source code for this sample app](https://github.com/dzirtusss/hello-react-on-rails)
+* [PR for using the generator with the Redux option](https://github.com/shakacode/react_on_rails-test-new-redux-generation/pull/15)
+* [PR showing the changes to deploy to Heroku](https://github.com/shakacode/react_on_rails-test-new-redux-generation/pull/16)
 * [Live on Heroku](https://hello-react-on-rails.herokuapp.com/)
 
 Feedback is greatly appreciated! As are stars on github! If you want personalized help, don't hesitate to get in touch with us at [contact@shakacode.com](mailto:contact@shakacode.com).

data/lib/generators/react_on_rails/templates/base/base/config/initializers/react_on_rails.rb.tt

@@ -62,7 +62,8 @@ ReactOnRails.configure do |config|
   ################################################################################
   # I18N OPTIONS
   ################################################################################
-  # Replace the following line to the location where you keep translation.js & default.js.
+  # Replace the following line to the location where you keep translation.js & default.js for use
+  # by the npm packages react-intl. Be sure this directory exists!
   # config.i18n_dir = Rails.root.join("client", "app", "libs", "i18n")
 
   ################################################################################

data/lib/react_on_rails/configuration.rb

@@ -11,6 +11,16 @@ module ReactOnRails
     configure_generated_assets_dirs_deprecation
     ensure_generated_assets_dir_present
     ensure_server_bundle_js_file_has_no_path
+    check_i18n_directory_exists
+  end
+
+  def self.check_i18n_directory_exists
+    return unless @configuration.i18n_dir.present?
+    return if Dir.exist?(@configuration.i18n_dir)
+
+    raise "Error configuring /config/react_on_rails.rb: invalid value for `config.i18n_dir`. "\
+        "Directory does not exist: #{@configuration.i18n_dir}. Set to value to nil or comment it "\
+        "out if not using this i18n with React on Rails."
   end
 
   def self.ensure_generated_assets_dir_present

data/lib/react_on_rails/locales_to_js.rb

@@ -3,6 +3,7 @@ require "erb"
 module ReactOnRails
   class LocalesToJs
     def initialize
+      return unless i18n_dir.present?
       return unless obsolete?
       @translations, @defaults = generate_translations
       convert
@@ -38,7 +39,8 @@ module ReactOnRails
     end
 
     def locale_files
-      @locale_files ||= Rails.application.config.i18n.load_path
+      @locale_files ||=
+        (Rails.application && Rails.application.config.i18n.load_path).presence
     end
 
     def i18n_dir

data/lib/react_on_rails/test_helper/ensure_assets_compiled.rb

@@ -27,9 +27,7 @@ module ReactOnRails
         # Be sure we don't do this again.
         self.class.has_been_run = true
 
-        if ReactOnRails.configuration.i18n_dir.present? && Rails.application.present?
-          ReactOnRails::LocalesToJs.new
-        end
+        ReactOnRails::LocalesToJs.new
 
         stale_gen_files = webpack_assets_status_checker.stale_generated_webpack_files
 

data/lib/react_on_rails/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ReactOnRails
-  VERSION = "6.7.1".freeze
+  VERSION = "6.7.2".freeze
 end

data/lib/tasks/locale.rake

@@ -7,8 +7,6 @@ This task generates javascript locale files: `translations.js` & `default.js` an
 the "ReactOnRails.configuration.i18n_dir".
   DESC
   task locale: :environment do
-    if ReactOnRails.configuration.i18n_dir.present?
-      ReactOnRails::LocalesToJs.new
-    end
+    ReactOnRails::LocalesToJs.new
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "6.7.1",
+  "version": "6.7.2",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {

data/react_on_rails.gemspec

@@ -42,4 +42,17 @@ Gem::Specification.new do |s|
   s.add_development_dependency "binding_of_caller"
   s.add_development_dependency "awesome_print"
   s.add_development_dependency "gem-release"
+
+  s.post_install_message = %(
+    React on Rails installed! See https://github.com/shakacode/react_on_rails for documentation
+    and source code.
+
+    You can email contact@shakacode.com for support questions or access to our public slack room.
+
+    For custom application development work or coaching on integrating React with Rails,
+    visit http://www.shakacode.com
+
+    For more information on the generators, run:
+      rails generate react_on_rails:install --help
+  )
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 6.7.1
+  version: 6.7.2
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -435,7 +435,12 @@ homepage: https://github.com/shakacode/react_on_rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\n    React on Rails installed! See https://github.com/shakacode/react_on_rails
+  for documentation\n    and source code.\n\n    You can email contact@shakacode.com
+  for support questions or access to our public slack room.\n\n    For custom application
+  development work or coaching on integrating React with Rails,\n    visit http://www.shakacode.com\n\n
+  \   For more information on the generators, run:\n      rails generate react_on_rails:install
+  --help\n  "
 rdoc_options: []
 require_paths:
 - lib