react_on_rails 6.3.5 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78e5d4be2abbd58fca99fd4a02ddbc01bce6aafc
-  data.tar.gz: c83eec060ca67a7bd3c39b807b9318c258b831f9
+  metadata.gz: 6a4f8bdac2245e1f3a17da6fd63341e9ce892b36
+  data.tar.gz: 18f926d01a9634607fa41e217c0981b751ed6dbd
 SHA512:
-  metadata.gz: d6dff6ff73ef1b1d542b82f8abd18ff3b11bcf9447b9ea01c87a97c3d0ec79fc4229f7c545187e04a6e417cb0486d77d8d37958ad7e667916980439ddc394d1d
-  data.tar.gz: a1eb40e9408fd5d7de117e646c90319a8f691acdf9715af70718c75434e14074693afe9a6a122ede08447e301a03e4d56d1c6483f3ed5b125317507d1d95f463
+  metadata.gz: 3c38887fd29781c9342661fc2f3a88cd50fa494610d1aed43342e0b0522d84762ebc1a0aa3b176a75fbec61a149ab6ee7f9c700ba4f109d2ee0d66091f8fa494
+  data.tar.gz: d5cdcc84850799bea50d3d346a45dbbdb6627cb409138e6c0ec4ebbca2f8720018fa35cfac24fccbf5053b8822635d2d4e0a2580f266e68d61bf17b14f5df75e

data/CHANGELOG.md

@@ -6,7 +6,15 @@ Contributors: please follow the recommendations outlined at [keepachangelog.com]
 ## [Unreleased]
 *Please add entries here for your pull requests.*
 
-## [6.3.5] - 2016-1-6
+## [6.4.0] - 2017-1-12
+
+### Fixed
+- Removed foreman as a dependency. [#678](https://github.com/shakacode/react_on_rails/pull/678) by [x2es](https://github.com/x2es).
+
+### Added
+- Automatically generate __i18n__ javascript files for `react-intl` when the serve starts up. [#642](https://github.com/shakacode/react_on_rails/pull/642) by [JasonYCHuang](https://github.com/JasonYCHuang).
+
+## [6.3.5] - 2017-1-6
 ### Fixed
 - The redux generator now creates a HelloWorld component that uses redux rather than local state. [#669](https://github.com/shakacode/react_on_rails/issues/669) by [justin808](https://github.com/justin808).
 
@@ -417,7 +425,8 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/6.3.5...master
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/6.4.0...master
+[6.4.0]: https://github.com/shakacode/react_on_rails/compare/6.3.5...6.4.0
 [6.3.5]: https://github.com/shakacode/react_on_rails/compare/6.3.4...6.3.5
 [6.3.4]: https://github.com/shakacode/react_on_rails/compare/6.3.3...6.3.4
 [6.3.3]: https://github.com/shakacode/react_on_rails/compare/6.3.2...6.3.3

data/CONTRIBUTING.md

@@ -126,11 +126,11 @@ npm install -g phantomjs
 
 Note this *must* be installed globally for the dummy test project rspec runner to see it properly.
 
-### NPM link
-Because the example and dummy apps rely on the react-on-rails node package, they should link directly to your local version to pick up any changes you may have made to that package. To achieve this, switch to the app's root directory and run:
+### Local Node Package
+Because the example and dummy apps rely on the react-on-rails node package, they should link directly to your local version to pick up any changes you may have made to that package. To achieve this, switch to the teat app's root directory and run this command below which runs something like [this script](spec/dummy/package.json#L14)
 
 ```sh
-npm run node_package
+npm run install-react-on-rails
 ```
 
 From now on, the example and dummy apps will use your local node_package folder as the react-on-rails node package. This will also be done automatically for you via the `rake examples:prepare_all` rake task.
@@ -141,6 +141,7 @@ From now on, the example and dummy apps will use your local node_package folder
   resolve: {
     alias: {
       react: path.resolve('./node_modules/react'),
+      'react-dom': path.resolve('./node_modules/react-dom'),
     },
   },
 ```
@@ -182,11 +183,11 @@ npm run test
 
 ```sh
 cd <top level>
-node_package/scripts/ci
+npm run check
 ```
 
 ### 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. If you change the webpack configs, then you need to restart foreman. If you change the JS code for react-on-rails, you need to run `node_package/scripts/build`. Since the react-on-rails package should be sym linked, you don't have to `npm i react-on-rails` after every change.
+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. If you change the webpack configs, then you need to restart foreman. If you change the JS code for react-on-rails, you need to run `npm run build`. Since the react-on-rails package should be sym linked, you don't have to `npm i react-on-rails` after every change.
 
 ### RSpec Testing
 Run `rake` for testing the gem and `spec/dummy`. Otherwise, the `rspec` command only works for testing within the sample apps, like `spec/dummy`.
@@ -217,7 +218,7 @@ The main installer can be run with ```rails generate react_on_rails:install```
 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 for CI. You will need docker and docker-compose installed locally to lint code changes via the lint container. You can lint locally by running `node_package/scripts/lint`
+All linting is performed from the docker container for CI. You will need docker and docker-compose installed locally to lint code changes via the lint container. You can lint locally by running `npm run lint && npm run flow`
 
 * [Install Docker Toolbox for Mac](https://www.docker.com/toolbox)
 * [Install Docker Compose for Linux](https://docs.docker.com/compose/install/)

data/Gemfile

@@ -25,7 +25,7 @@ gem "mini_racer"
 if ENV["ENABLE_TURBOLINKS_5"].nil? || ENV["ENABLE_TURBOLINKS_5"].strip.empty?
   gem "turbolinks", "2.5.3"
 else
-  gem "turbolinks", "~> 5.0.0.beta"
+  gem "turbolinks", "~> 5.0"
 end
 gem "uglifier", ">= 2.7.2"
 gem "web-console", "~> 2.0", group: :development

data/README.md

@@ -50,6 +50,7 @@ React on Rails integrates Facebook's [React](https://github.com/facebook/react)
     - [Installation Summary](#installation-summary)
     - [Initializer Configuration: config/initializers/react_on_rails.rb](#initializer-configuration)
     - [Including your React Component in your Rails Views](#including-your-react-component-in-your-rails-views)
+    - [I18n](#i18n)
 + [How it Works](#how-it-works)
     - [Client-Side Rendering vs. Server-Side Rendering](#client-side-rendering-vs-server-side-rendering)
     - [Building the Bundles](#building-the-bundles)
@@ -120,6 +121,8 @@ We're definitely not doing that. With react_on_rails, webpack is mainly generati
 
 6. Start your Rails server:
 
+  with foreman installed (`gem install foreman`)
+
   ```bash
   foreman start -f Procfile.dev
   ```
@@ -168,7 +171,15 @@ Configure the `config/initializers/react_on_rails.rb`. You can adjust some neces
     // inside your React component
     this.props.name // "Stranger"
   ```
-  
+
+### I18n
+
+You can enable the i18n functionality with [react-intl](https://github.com/yahoo/react-intl).
+
+React on Rails provides an option for automatic conversions of Rails `*.yml` locale files into `*.js` files for `react-intl`.
+
+See the [How to add I18n](docs/basics/i18n.md) for a summary of adding I18n.
+
 ## NPM
 All JavaScript in React On Rails is loaded from npm: [react-on-rails](https://www.npmjs.com/package/react-on-rails). To manually install this (you did not use the generator), assuming you have a standard configuration, run this command:
 
@@ -243,11 +254,6 @@ The `railsContext` has: (see implementation in file [react_on_rails_helper.rb](a
     pathname: uri.path, # /posts
     search: uri.query, # id=30&limit=5
 
-    # Locale settings
-    i18nLocale: I18n.locale,
-    i18nDefaultLocale: I18n.default_locale,
-    httpAcceptLanguage: request.env["HTTP_ACCEPT_LANGUAGE"],
-
     # Other
     serverSide: boolean # Are we being called on the server or client? NOTE, if you conditionally
      # render something different on the server than the client, then React will only show the
@@ -259,9 +265,6 @@ The `railsContext` has: (see implementation in file [react_on_rails_helper.rb](a
 ##### Needing the current url path for server rendering
 Suppose you want to display a nav bar with the current navigation link highlighted by the URL. When you server render the code, you will need to know the current URL/path if that is what you want your logic to be based on. The new `railsContext` has this information so the application of an "active" class can be done server side.
 
-##### Needing the I18n.locale
-Suppose you want to server render your react components with localization applied given the current Rails locale. The `railsContext` contains the I18n.locale.
-
 ##### Configuring different code for server side rendering
 Suppose you want to turn off animation when doing server side rendering. The `serverSide` value is just what you need.
 

data/docs/additional-reading/foreman-issues.md

@@ -0,0 +1,15 @@
+# Foreman Issues
+
+## It is not recomended to include foreman into Gemfile
+
+See: https://github.com/ddollar/foreman
+
+> Ruby users should take care not to install foreman in their project's Gemfile.
+
+## Known issues
+
+ * With `foreman 0.82.0` npm `react-s3-uploader` was failing to finish upload file to S3 when server was started by `foreman -f Procfile.dev`, 
+   at the same time the same code works fine when ruby server started by `bundle exec rails s`.
+
+ * The same Procfile with different versions of `foreman` in combination with different versions of `bundler` may produce different output of `ps aux`.
+   This may brake bash tools which rely on `ps` output.

data/docs/basics/i18n.md

@@ -0,0 +1,90 @@
+# How to add I18n
+
+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) for a complete example.
+
+1. Add `react-intl` & `intl` to `client/package.json`, and remember to `bundle && npm install`.
+
+  ```js
+  "dependencies": {
+    ...
+    "intl": "^1.2.5",
+    "react-intl": "^2.1.5",
+    ...
+  }
+  ```
+
+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.
+  
+  > `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:
+
+  ```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")
+  ```
+
+  Add following lines to `config/application.rb`, this will help you to generate `translations.js` & `default.js` automatically when you starts the server.
+
+  ```js
+  module YourModule
+    class Application < Rails::Application
+      ...
+      config.after_initialize do
+        ReactOnRails::LocalesToJs.new
+      end
+    end
+  end
+  ```
+
+5. In React, you need to initialize `react-intl`, and set parameters for it.
+
+  ```js
+  ...
+  import { addLocaleData } from 'react-intl';
+  import en from 'react-intl/locale-data/en';
+  import de from 'react-intl/locale-data/de';
+  import { translations } from 'path_to/i18n/translations';
+  import { defaultLocale } from 'path_to/i18n/default';
+  ...
+  // Initizalize all locales for react-intl.
+  addLocaleData([...en, ...de]);
+  ...
+  // set locale and messages for IntlProvider.
+  const locale = method_to_get_current_locale() || defaultLocale;
+  const messages = translations[locale];
+  ...
+  return (
+    <IntlProvider locale={locale} key={locale} messages={messages}>
+      <CommentScreen {...{ actions, data }} />
+    </IntlProvider>
+  )
+  ```
+  ```js
+  // In your component.
+  import { defaultMessages } from 'path_to/i18n/default';
+  ...
+  return (
+    { formatMessage(defaultMessages.yourLocaleKeyInCamelCase) }
+  )
+  ```

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

@@ -59,6 +59,12 @@ ReactOnRails.configure do |config|
   config.server_renderer_pool_size = 1 # increase if you're on JRuby
   config.server_renderer_timeout = 20 # seconds
 
+  ################################################################################
+  # I18N OPTIONS
+  ################################################################################
+  # Replace the following line to the location where you keep translation.js & default.js.
+  config.i18n_dir = Rails.root.join("client", "app", "libs", "i18n")
+
   ################################################################################
   # MISCELLANEOUS OPTIONS
   ################################################################################

data/lib/react_on_rails.rb

@@ -16,3 +16,4 @@ require "react_on_rails/test_helper/webpack_assets_compiler"
 require "react_on_rails/test_helper/webpack_assets_status_checker"
 require "react_on_rails/test_helper/ensure_assets_compiled"
 require "react_on_rails/test_helper/node_process_launcher"
+require "react_on_rails/locales_to_js"

data/lib/react_on_rails/configuration.rb

@@ -72,6 +72,7 @@ module ReactOnRails
       server_render_method: "",
       symlink_non_digested_assets_regex: /\.(png|jpg|jpeg|gif|tiff|woff|ttf|eot|svg|map)/,
       npm_build_test_command: "",
+      i18n_dir: "",
       npm_build_production_command: ""
     )
   end
@@ -84,6 +85,7 @@ module ReactOnRails
                   :skip_display_none, :generated_assets_dirs, :generated_assets_dir,
                   :webpack_generated_files, :rendering_extension, :npm_build_test_command,
                   :npm_build_production_command,
+                  :i18n_dir,
                   :server_render_method, :symlink_non_digested_assets_regex
 
     def initialize(server_bundle_js_file: nil, prerender: nil, replay_console: nil,
@@ -94,12 +96,14 @@ module ReactOnRails
                    generated_assets_dir: nil, webpack_generated_files: nil,
                    rendering_extension: nil, npm_build_test_command: nil,
                    npm_build_production_command: nil,
+                   i18n_dir: nil,
                    server_render_method: nil, symlink_non_digested_assets_regex: nil)
       self.server_bundle_js_file = server_bundle_js_file
       self.generated_assets_dirs = generated_assets_dirs
       self.generated_assets_dir = generated_assets_dir
       self.npm_build_test_command = npm_build_test_command
       self.npm_build_production_command = npm_build_production_command
+      self.i18n_dir = i18n_dir
 
       self.prerender = prerender
       self.replay_console = replay_console

data/lib/react_on_rails/locales_to_js.rb

@@ -0,0 +1,119 @@
+require "erb"
+
+module ReactOnRails
+  class LocalesToJs
+    def initialize
+      return unless obsolete?
+      @translations, @defaults = generate_translations
+      convert
+    end
+
+    private
+
+    def obsolete?
+      return true if exist_js_files.empty?
+      js_files_are_outdated
+    end
+
+    def exist_js_files
+      @exist_js_files ||= js_files.select(&File.method(:exist?))
+    end
+
+    def js_files_are_outdated
+      latest_yml = locale_files.map(&File.method(:mtime)).max
+      earliest_js = exist_js_files.map(&File.method(:mtime)).min
+      latest_yml > earliest_js
+    end
+
+    def js_file_names
+      %w(translations default)
+    end
+
+    def js_files
+      @js_files ||= js_file_names.map { |n| js_file(n) }
+    end
+
+    def js_file(name)
+      "#{i18n_dir}/#{name}.js"
+    end
+
+    def locale_files
+      @locale_files ||= Rails.application.config.i18n.load_path
+    end
+
+    def i18n_dir
+      @i18n_dir ||= ReactOnRails.configuration.i18n_dir
+    end
+
+    def default_locale
+      @default_locale ||= I18n.default_locale.to_s || "en"
+    end
+
+    def convert
+      js_file_names.each do |name|
+        template = send("template_#{name}")
+        path = js_file(name)
+        generate_js_file(template, path)
+      end
+    end
+
+    def generate_js_file(template, path)
+      result = ERB.new(template).result()
+      File.open(path, "w") do |f|
+        f.write(result)
+      end
+    end
+
+    def generate_translations
+      translations = {}
+      defaults = {}
+      locale_files.each do |f|
+        translation = YAML.load(File.open(f))
+        key = translation.keys[0]
+        val = flatten(translation[key])
+        translations = translations.deep_merge(key => val)
+        defaults = defaults.deep_merge(flatten_defaults(val)) if key == default_locale
+      end
+      [translations.to_json, defaults.to_json]
+    end
+
+    def format(input)
+      input.to_s.tr(".", "_").camelize(:lower).to_sym
+    end
+
+    def flatten_defaults(val)
+      flatten(val).each_with_object({}) do |(k, v), h|
+        key = format(k)
+        h[key] = { id: k, defaultMessage: v }
+      end
+    end
+
+    def flatten(translations)
+      translations.each_with_object({}) do |(k, v), h|
+        if v.is_a? Hash
+          flatten(v).map { |hk, hv| h["#{k}.#{hk}".to_sym] = hv }
+        else
+          h[k] = v
+        end
+      end
+    end
+
+    def template_translations
+      <<-JS
+export const translations = #{@translations};
+      JS
+    end
+
+    def template_default
+      <<-JS
+import { defineMessages } from 'react-intl';
+
+const defaultLocale = \'#{default_locale}\';
+
+const defaultMessages = defineMessages(#{@defaults});
+
+export { defaultMessages, defaultLocale };
+      JS
+    end
+  end
+end

data/lib/react_on_rails/version.rb

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

data/package.json

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

data/react_on_rails.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |s|
   s.add_dependency "execjs", "~> 2.5"
   s.add_dependency "rainbow", "~> 2.1"
   s.add_dependency "rails", ">= 3.2"
-  s.add_dependency "foreman"
   s.add_dependency "addressable"
 
   s.add_development_dependency "bundler", "~> 1.10"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 6.3.5
+  version: 6.4.0
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: foreman
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -336,6 +322,7 @@ files:
 - docs/LICENSE
 - docs/additional-reading/babel.md
 - docs/additional-reading/code-splitting.md
+- docs/additional-reading/foreman-issues.md
 - docs/additional-reading/heroku-deployment.md
 - docs/additional-reading/hot-reloading-rails-development.md
 - docs/additional-reading/node-dependencies-and-npm.md
@@ -357,6 +344,7 @@ files:
 - docs/api/ruby-api-hot-reload-view-helpers.md
 - docs/api/ruby-api.md
 - docs/basics/generator.md
+- docs/basics/i18n.md
 - docs/basics/installation-overview.md
 - docs/basics/migrating-from-react-rails.md
 - docs/coding-style/style.md
@@ -407,6 +395,7 @@ files:
 - lib/react_on_rails/controller.rb
 - lib/react_on_rails/engine.rb
 - lib/react_on_rails/git_utils.rb
+- lib/react_on_rails/locales_to_js.rb
 - lib/react_on_rails/prerender_error.rb
 - lib/react_on_rails/react_component/options.rb
 - lib/react_on_rails/server_rendering_pool.rb