react_webpack_rails 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9013d3d9ed832b067ef13eef2818ee979c896e96
-  data.tar.gz: 75af140b6ce33183f6917776e5abd6ef790caa39
+  metadata.gz: b7b168e4c9e7963d9286b677dfda26cb75faf04f
+  data.tar.gz: e7c801d0011fc8a2a4ae35dbf1b35af41b4ab4de
 SHA512:
-  metadata.gz: fad1735106799d939a82f8d0eae96697d529eb60647df587bdb92d4399c752d44d079ac336c8480db3538601861bce6f47983e2cdde443207ad739c49b527323
-  data.tar.gz: 2b2debfff85637619d44659abd999efd30ddc437131c66eb50734d4d9201c56c954f3bfbe0d22ab469f9a0c2cc1037de796949ccca3688187d6f026363e6d189
+  metadata.gz: d89a10bb7c891f157a382fbb6c6865043ff142db3094ee6cea4ca714c990ca2af203d2ed62252677891d64683fa1ac3f57ad7644ada1eb37019a7817b21a023f
+  data.tar.gz: 711c3ce95858e08945893afc8e13d5068cbef85bcf13b08fa65ad63da40b2f10e488c96f1b0ca5a0ebaff0a2e839b72fb210250f7f90b20be13ea3690ec9d216

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.0
+* move integration with react-router to external plugin: https://github.com/netguru/rwr-react_router
+* add redux integration by external plugin: https://github.com/netguru/rwr-redux
+* support haml and coffee script in generator
+
 ## 0.2.1
 * Fix Readme typo
 * Fix json loader in generator
@@ -63,7 +68,7 @@ $ rails generate react_webpack_rails:install:server_side
 
   ```
   $ npm i --save-dev babel-core@^6.0.0 babel-loader@^6.0.0 babel-preset-stage-1@^6.0.0 babel-preset-react@^6.0.0 babel-preset-es2015@^6.0.0
-  ```  
+  ```
 
 4. Update babel config file (we use stage-1).
 

data/README.md

@@ -4,6 +4,9 @@
 #### Rails - Webpack setup with React integration.
 This gem provides easy and convenient way to build modern JavaScript stack on top of Rails applications using [Webpack](http://webpack.github.io/) and [React](https://facebook.github.io/react/).
 
+### Development branch!
+See [0.3-stable](https://github.com/netguru/react_webpack_rails/tree/0.3-stable) for latest release.
+
 ## Features
 * [Install Generator](https://github.com/netguru/react_webpack_rails/blob/master/docs/install_generator.md) for quick [Webpack](http://webpack.github.io/) setup.
 * Integrated [react-hot-loader](https://github.com/gaearon/react-hot-loader)
@@ -12,6 +15,10 @@ This gem provides easy and convenient way to build modern JavaScript stack on to
 * [React](https://facebook.github.io/react/) integration with server prerender option.
 * [React-router](https://github.com/rackt/react-router) integration.
 
+### Plugins:
+* [rwr-alt](https://github.com/netguru/rwr-alt) plugin that makes it possible to populate and share Alt stores between react component located in different parts of rails views.
+* [rwr-redux](https://github.com/netguru/rwr-redux) allows to use redux state containers in a rails views.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,44 +35,13 @@ Then run installation:
 
     $ rails g react_webpack_rails:install
 
-This will create following files:
+*read more about [install  generator](https://github.com/netguru/react_webpack_rails/blob/master/docs/install_generator.md) here*
 
-```
-├── app
-│   ├── react
-│   │   ├── components
-│   │   │   ├── hello-world.jsx
-│   │   │   └── hello-world-test.jsx
-│   │   └── index.js
-│   ├── views
-│   │   └── layouts
-│   │       └── _react_hot_assets.html.erb
-│   └── assets
-│       └── javascripts
-│           └──react_bundle.js
-├── webpack
-│   ├── dev.config.js
-│   ├── hot-dev.config.js
-│   ├── production.config.js
-│   └── tests.config.js
-├── .babelrc
-├── karma.conf.js
-├── package.json
-└── webpack.config.js
-```
 
 Establish the node packages (may take a few moments)
 
     $ npm install    # you may see warnings to consider updating the provided package.json file with license and repository
 
-Make sure you have [webpack](https://webpack.github.io/docs/installation.html) installed globally:
-
-    $ npm install webpack -g
-
-Generate `react_bundle` for first time:
-
-    $ webpack
-
 And require integration and bundle files in `application.js`
 
 ```js
@@ -122,19 +98,18 @@ Run webpack in hot-auto-reloading mode using script (to use it you have to add `
 
     $ npm run start-hot-dev
 
-Or manually:
-
-    $ webpack -w --config YOUR_CONFIG
+If you are using server side render in components *(it's enabled by default in generated example)*, run node server:
 
+    $ npm run rwr-node-dev-server
 
 ### Production environment
 Run webpack in production mode before compiling assets using script:
 
     $ npm run build
 
-or manually:
+If you are using server side render *(it's enabled by default in generated example)*, run node server:
 
-    $ webpack -p --config YOUR_CONFIG
+    $ npm run rwr-node-server
 
 #### Deployment
 Check [docs/deployment.md](docs/deployment.md)

data/Rakefile

@@ -14,7 +14,7 @@ namespace :test do
 
   desc 'Run gem tests'
   task :gem do
-    sh %Q(bundle exec rspec spec/react_webpack_rails_spec.rb)
+    sh %Q(bundle exec rspec spec/react_webpack_rails_spec.rb spec/react_webpack_rails)
   end
 
   desc 'Run rspec for rails3 application'

data/docs/install_generator.md

@@ -1,4 +1,4 @@
-Instlall Generator
+Install Generator
 =======
 
 `Install` generator is build from 6 independent generators responsible for different parts of installation process. All steps except core generator can be skipped by passing one of possible [options]().
@@ -50,6 +50,6 @@ And modify:
 * *--no-hot-reload* - skip hot_reload generator
 * *--no-server-side* - skip server_side  generator
 * *--no-karma-setup* - skip karma_setup generator
-* *--react-router* - run react_rotuer generator
+* *--react-router* - run react_rotuer generator [DEPRECIATED since v0.3.0 - use [rwr-react_router](https://github.com/netguru/rwr-react_router) instead]
 
 *Detailed description of generators coming soon...*

data/docs/server_side_rendering.md

@@ -21,7 +21,7 @@ To set the node server address, override this option to a string of your choice:
 <%# A view in erb %>
 <%= react_component('HelloWorld', { name: @name }, server_side: true) %>
 ```
-`HelloWorld` is the name of the react component, which has to be `import`ed and `registered`ed in your `app/react/index.js` like so:
+`HelloWorld` is the name of the react component, which has to be `import`ed and `register`ed in your `app/react/index.js` like so:
 ```js
 import HelloWorld from './components/hello-world';
 RWR.registerComponent('HelloWorld', HelloWorld);

data/js/src/integrations/react-router.js

@@ -1,5 +1,16 @@
 import ReactDOM from 'react-dom';
 
+function deprecationWarning() {
+  if (typeof console !== 'undefined' && console.warn) {
+      const msg = [
+        'Deprecation warning - since v0.3.0: current integration with react-router was extracted and moved to external plugin.',
+        'Use https://github.com/netguru/rwr-react_router instead.'
+      ]
+
+      console.warn(msg.join('\n'));
+    }
+}
+
 class ReactRouterIntegration {
   constructor() {
     this.routers = {};
@@ -7,6 +18,7 @@ class ReactRouterIntegration {
     this.registerRouter = this.registerRouter.bind(this);
     this.getRouter = this.getRouter.bind(this);
     this.renderRouter = this.renderRouter.bind(this);
+    deprecationWarning();
   }
 
   registerRouter(name, route) {

data/js/src/version.js

@@ -1 +1 @@
-export default '0.2.1';
+export default '0.3.0';

data/lib/generators/react_webpack_rails/install/core_generator.rb

@@ -13,6 +13,7 @@ module ReactWebpackRails
       def base
         copy_file '.babelrc', '.babelrc'
         create_file 'app/assets/javascripts/react_bundle.js'
+        require_bundles_in_application_js
         template 'react/index.js', 'app/react/index.js'
       end
 
@@ -42,6 +43,42 @@ module ReactWebpackRails
         copy_file 'webpack/dev.config.js', 'webpack/dev.config.js'
         copy_file 'webpack/production.config.js', 'webpack/production.config.js'
       end
+
+      private
+
+      def require_bundles_in_application_js
+        manifest_file = Dir.glob('app/assets/javascripts/application.*').first
+
+        case manifest_file
+        when /.*\.coffee(\.erb)?$/
+          requires = <<-REQUIRE_STRING.strip_heredoc
+            #= require react_integration
+            #= require react_bundle
+          REQUIRE_STRING
+
+          return if inject_into_file manifest_file, requires, before: '#= require_tree .'
+          append_to_file manifest_file, requires
+        when /.*\.js(\.erb)?$/
+          requires = <<-REQUIRE_STRING.strip_heredoc
+            //= require react_integration
+            //= require react_bundle
+          REQUIRE_STRING
+
+          inject_into_file manifest_file, requires, before: '//= require_tree .'
+          append_to_file manifest_file, requires
+        else
+          manifest_info = <<-NO_MANIFEST.strip_heredoc
+            Missing manifest?
+
+            Javascript manifest (normally application.js) could not be found.
+            Please require following files in your manifest file:
+            react_integration
+            react_bundle
+
+          NO_MANIFEST
+          say_status(:not_found, manifest_info, :red)
+        end
+      end
     end
   end
 end

data/lib/generators/react_webpack_rails/install/hot_reload_generator.rb

@@ -23,10 +23,23 @@ module ReactWebpackRails
 
       def partial
         copy_file 'partial/_react_hot_assets.html.erb', 'app/views/layouts/_react_hot_assets.html.erb'
+        settings = template_language_settings("render 'layouts/react_hot_assets'")
 
-        inject_into_file 'app/views/layouts/application.html.erb', after: "<body>\n" do <<-'HTML'.strip_heredoc
-          <%= render 'layouts/react_hot_assets' %>
-        HTML
+        inject_into_file settings[:layout_file], settings[:parsed_command], after: "#{settings[:body_tag]}\n"
+      end
+
+      private
+
+      def template_language_settings(command)
+        layout_file = Dir.glob('app/views/layouts/application.*').first
+
+        case File.extname(layout_file)
+        when '.slim'
+          return { layout_file: layout_file, body_tag: 'body', parsed_command: "  = #{command}\n" }
+        when '.haml'
+          return { layout_file: layout_file, body_tag: '%body', parsed_command: "  = #{command}\n" }
+        else
+          return { layout_file: layout_file, body_tag: '<body>', parsed_command: "<%= #{command} %>\n" }
         end
       end
     end

data/lib/generators/react_webpack_rails/install_generator.rb

@@ -52,6 +52,7 @@ module ReactWebpackRails
 
     def generate_react_router
       return unless options.react_router
+      deprecation_warning
       generate 'react_webpack_rails:install:react_router --tmp_package'
     end
 
@@ -62,5 +63,17 @@ module ReactWebpackRails
     def cleanup
       remove_file('tmp/package.json')
     end
+
+    private
+
+    def deprecation_warning
+      message = [
+        "\nDEPRECATION WARNING - since v0.3.0:",
+        "current integration with react-router was extracted and moved to external plugin.",
+        "Use https://github.com/netguru/rwr-react_router instead.\n\n",
+      ]
+
+      warn message.join("\n")
+    end
   end
 end

data/lib/generators/react_webpack_rails/templates/packages/core.json

@@ -16,7 +16,7 @@
     "node-sass": "^3.3.3",
     "react": "^0.14.0",
     "react-dom": "^0.14.0",
-    "react-webpack-rails": "^0.2.1",
+    "react-webpack-rails": "^0.3.0",
     "sass-loader": "^3.0.0",
     "webpack": "^1.12.1"
   },

data/lib/react_webpack_rails.rb

@@ -6,4 +6,5 @@ if defined?(Rails)
   require 'react_webpack_rails/node_integration_runner'
   require 'react_webpack_rails/errors/base'
   require 'react_webpack_rails/errors/node_failure'
+  require 'react_webpack_rails/services'
 end

data/lib/react_webpack_rails/services.rb

@@ -0,0 +1 @@
+require 'react_webpack_rails/services/camelize_keys'

data/lib/react_webpack_rails/services/camelize_keys.rb

@@ -0,0 +1,13 @@
+module ReactWebpackRails
+  module Services
+    class CamelizeKeys
+      def self.call(props)
+        return props unless props.is_a?(Hash)
+        props.inject({}) do |h, (k, v)|
+          h[k.to_s.camelize(:lower)] = v.is_a?(Hash) ? self.call(v) : v
+          h
+        end
+      end
+    end
+  end
+end

data/lib/react_webpack_rails/version.rb

@@ -1,3 +1,3 @@
 module ReactWebpackRails
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/react_webpack_rails/view_helpers.rb

@@ -1,3 +1,5 @@
+require_relative 'services/camelize_keys'
+
 module ReactWebpackRails
   module ViewHelpers
     def react_element(integration_name, payload = {}, html_options = {}, &block)
@@ -13,7 +15,7 @@ module ReactWebpackRails
 
     def react_component(name, raw_props = {}, options = {})
       props = raw_props.as_json
-      props = camelize_props_key(props) if Rails.application.config.react.camelize_props
+      props = Services::CamelizeKeys.call(props) if Rails.application.config.react.camelize_props
       if server_side(options.delete(:server_side))
         result = NodeIntegrationRunner.new('react-component', props: props, name: name).run
         react_element('react-component', { props: props, name: name }, options) do
@@ -25,21 +27,24 @@ module ReactWebpackRails
     end
 
     def react_router(name)
+      deprecation_warning
       react_element('react-router', name: name)
     end
 
     private
 
-    def camelize_props_key(props)
-      return props unless props.is_a?(Hash)
-      props.inject({}) do |h, (k, v)|
-        h[k.to_s.camelize(:lower)] = v.is_a?(Hash) ? camelize_props_key(v) : v
-        h
-      end
-    end
-
     def server_side(server_side)
       server_side.nil? ? Rails.application.config.react.server_side : server_side
     end
+
+    def deprecation_warning
+      message = [
+        "\nDEPRECATION WARNING - since v0.3.0:",
+        "current integration with react-router was extracted and moved to external plugin.",
+        "Use https://github.com/netguru/rwr-react_router instead.\n\n",
+      ]
+
+      warn message.join("\n")
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react_webpack_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Rafał Gawlik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,6 +146,8 @@ files:
 - lib/react_webpack_rails/node_integration_runner.rb
 - lib/react_webpack_rails/railtie.rb
 - lib/react_webpack_rails/react_component_renderer.rb
+- lib/react_webpack_rails/services.rb
+- lib/react_webpack_rails/services/camelize_keys.rb
 - lib/react_webpack_rails/version.rb
 - lib/react_webpack_rails/view_helpers.rb
 - package.json