react-rails 1.7.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 317dcc49fd51fff94c69147c9cb9a66863af8cc1
-  data.tar.gz: 747c8e7a64afc813f317ee0e87c687b510027ace
+  metadata.gz: 14415b72eed9bf0a03780737bbaad51eee104435
+  data.tar.gz: 2b2a2dd99a46a493ae2597ebb1f5c031e30eec99
 SHA512:
-  metadata.gz: dece437df496cb2260286e513821886ea394a1f445b26b2d435b4b87444365ba14055ce2748aa282343992b80751b6a0178e062ab4b9a6ccb94db1cdba314d46
-  data.tar.gz: 59c476692c2cc549607a01bd662c57f5c0c1786af55ebcc8a75696ecf6a816aec001508cda55ab4ec309d884e2c2e2c98f71ddee9fa2544b87a71e72fe7be2a2
+  metadata.gz: 0b59ba10ae649678f0ae74a6e427e7911da83e212df6b26593818778c30d6100d93f5797e8632e584e02cf873a5289e2fefc318bc922693fef12fb405e9ca63d
+  data.tar.gz: e7525c73b8ce2262b555295510af870f715886c441b3614f5b8fd223fae372c34583a2bb676faeef3824e27bfb6ce6248840dc1fb819128eb329ca52f287020b

data/CHANGELOG.md

@@ -8,7 +8,18 @@
 
 #### Bug Fixes
 
-## 1.7.2 (Jun3 19, 2016)
+## 1.8.0 (June 29, 2016)
+
+#### New Features
+
+- Sprockets 4 Support 🎉 #560
+- Depend on Railties, not Rails #558
+- Don't depend on `sprockets/railtie` #558
+- Expose `React.camelize_props(props_hash)` #556
+- Add `rails generate react:ujs --output=...` for copying the UJS into your app #557
+- Support Babel 6 module exports & extension point `ReactRailsUJS.getConstructor` #503
+
+## 1.7.2 (June 19, 2016)
 
 #### New Features
 

data/lib/assets/javascripts/react_ujs_mount.js

@@ -42,6 +42,30 @@
       }
     },
 
+    // Get the constructor for a className
+    getConstructor: function(className) {
+      // Assume className is simple and can be found at top-level (window).
+      // Fallback to eval to handle cases like 'My.React.ComponentName'.
+      // Also, try to gracefully import Babel 6 style default exports
+      //
+      var constructor;
+
+      // Try to access the class globally first
+      constructor = window[className];
+
+      // If that didn't work, try eval
+      if (!constructor) {
+        constructor = eval.call(window, className);
+      }
+
+      // Lastly, if there is a default attribute try that
+      if (constructor && constructor.default) {
+        constructor = constructor.default;
+      }
+
+      return constructor;
+    },
+
     // Within `searchSelector`, find nodes which should have React components
     // inside them, and mount them with their props.
     mountComponents: function(searchSelector) {
@@ -50,10 +74,7 @@
       for (var i = 0; i < nodes.length; ++i) {
         var node = nodes[i];
         var className = node.getAttribute(window.ReactRailsUJS.CLASS_NAME_ATTR);
-
-        // Assume className is simple and can be found at top-level (window).
-        // Fallback to eval to handle cases like 'My.React.ComponentName'.
-        var constructor = window[className] || eval.call(window, className);
+        var constructor = this.getConstructor(className);
         var propsJson = node.getAttribute(window.ReactRailsUJS.PROPS_ATTR);
         var props = propsJson && JSON.parse(propsJson);
 

data/lib/generators/react/ujs_generator.rb

@@ -0,0 +1,44 @@
+module React
+  module Generators
+    class UjsGenerator < ::Rails::Generators::Base
+      desc "Create a custom copy of react_ujs for your application"
+
+      class_option :output, required: true, desc: "File path for new react_ujs.js"
+
+      class_option :turbolinks, type: :boolean, default: true, desc: "Include Turbolinks 5 support?"
+      class_option :turbolinks_classic, type: :boolean, default: true, desc: "Include Turbolinks 2.4 / 3 support?"
+      class_option :turbolinks_classic_deprecated, type: :boolean, default: true, desc: "Include Turbolinks < 2.4 support?"
+      class_option :pjax, type: :boolean, default: true, desc: "Include PJAX support?"
+      class_option :native, type: :boolean, default: true, desc: "Include native events support?"
+
+      EVENT_SUPPORT_OPTIONS = [
+        :turbolinks,
+        :turbolinks_classic,
+        :turbolinks_classic_deprecated,
+        :pjax,
+        :native,
+      ]
+
+      def create_ujs_file
+        files_to_merge = ["react_ujs_mount.js"]
+
+        EVENT_SUPPORT_OPTIONS.each do |event_support_option|
+          if options[event_support_option]
+            files_to_merge << "react_ujs_#{event_support_option}.js"
+          end
+        end
+
+        files_to_merge << "react_ujs_event_setup.js"
+
+        asset_dir = File.expand_path("../../../assets/javascripts", __FILE__)
+
+        custom_ujs_content = files_to_merge
+          .map { |filename| File.read(File.join(asset_dir, filename)) }
+          .join("\n")
+
+        new_ujs_path = options[:output]
+        create_file(new_ujs_path, custom_ujs_content)
+      end
+    end
+  end
+end

data/lib/react-rails.rb

@@ -1,4 +1,4 @@
+require 'react'
 require 'react/jsx'
 require 'react/rails'
 require 'react/server_rendering'
-

data/lib/react.rb

@@ -0,0 +1,19 @@
+module React
+  # Recursively camelize `props`, returning a new Hash
+  # @param props [Object] If it's a Hash or Array, it will be recursed. Otherwise it will be returned.
+  # @return [Hash] a new hash whose keys are camelized strings
+  def self.camelize_props(props)
+    case props
+    when Hash
+      props.each_with_object({}) do |(key, value), new_props|
+        new_key = key.to_s.camelize(:lower)
+        new_value = camelize_props(value)
+        new_props[new_key] = new_value
+      end
+    when Array
+      props.map { |item| camelize_props(item) }
+    else
+      props
+    end
+  end
+end

data/lib/react/jsx/babel_transformer.rb

@@ -1,6 +1,7 @@
 require 'babel/transpiler'
 module React
   module JSX
+    # A {React::JSX}-compliant transformer which uses `Babel::Transpiler` to transform JSX.
     class BabelTransformer
       DEPRECATED_OPTIONS = [:harmony, :strip_types, :asset_path]
       DEFAULT_TRANSFORM_OPTIONS = { blacklist: ['spec.functionName', 'validation.react', 'strict'] }

data/lib/react/jsx/jsx_transformer.rb

@@ -1,5 +1,6 @@
 module React
   module JSX
+    # A {React::JSX}-compliant transformer which uses the deprecated `JSXTransformer.js` to transform JSX.
     class JSXTransformer
       DEFAULT_ASSET_PATH = 'JSXTransformer.js'
 

data/lib/react/jsx/processor.rb

@@ -1,5 +1,6 @@
 module React
   module JSX
+    # A Sprockets 3+-compliant processor
     class Processor
       def self.call(input)
         JSX::transform(input[:data])

data/lib/react/jsx/template.rb

@@ -2,7 +2,7 @@ require 'tilt'
 
 module React
   module JSX
-
+    # Sprockets 2-compliant processor
     class Template < Tilt::Template
       self.default_mime_type = 'application/javascript'
 

data/lib/react/rails/asset_variant.rb

@@ -1,13 +1,23 @@
 module React
   module Rails
+    # This class accepts some options for which build you want, then exposes where you can find
+    # them. In general, these paths should be added to the sprockets environment.
     class AssetVariant
       GEM_ROOT = Pathname.new('../../../../').expand_path(__FILE__)
-      attr_reader :react_build, :react_directory, :jsx_directory
+      # @return [String] "production" or "development"
+      attr_reader :react_build
 
+      # @return [String] The path which contains the specified React.js build as "react.js"
+      attr_reader :react_directory
+
+      # @return [String] The path which contains the JSX Transformer
+      attr_reader :jsx_directory
+
+      # @param [Hash] Options for the asset variant
+      # @option variant [Symbol] if `:production`, use the minified React.js build
+      # @option addons [Boolean] if true, use a React.js build with all addons
       def initialize(options={})
-        # We want to include different files in dev/prod. The development builds
-        # contain console logging for invariants and logging to help catch
-        # common mistakes. These are all stripped out in the production build.
+
         @react_build = options[:variant] == :production ? 'production' : 'development'
         options[:addons] && @react_build += '-with-addons'
 

data/lib/react/rails/component_mount.rb

@@ -24,7 +24,9 @@ module React
       # on the client.
       def react_component(name, props = {}, options = {}, &block)
         options = {:tag => options} if options.is_a?(Symbol)
-        props = camelize_props_key(props) if camelize_props_switch
+        if camelize_props_switch
+          props = React.camelize_props(props)
+        end
 
         prerender_options = options[:prerender]
         if prerender_options
@@ -45,23 +47,6 @@ module React
 
         content_tag(html_tag, '', html_options, &block)
       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)] = case v
-          when Hash
-            camelize_props_key(v)
-          when Array
-            v.map {|i| camelize_props_key(i) }
-          else
-            v
-          end
-          h
-        end
-      end
     end
   end
 end

data/lib/react/rails/controller_renderer.rb

@@ -1,18 +1,35 @@
-class React::Rails::ControllerRenderer
-  include React::Rails::ViewHelper
-  include ActionView::Helpers::TagHelper
-  include ActionView::Helpers::TextHelper
+module React
+  module Rails
+    # A renderer class suitable for `ActionController::Renderers`.
+    # It is associated to `:component` in the Railtie.
+    #
+    # It is prerendered with {React::ServerRendering}.
+    #
+    # @example Rendering a component from a controller
+    #   class TodosController < ApplicationController
+    #     def index
+    #       @todos = Todo.all
+    #       render component: 'TodoList', props: { todos: @todos }, tag: 'span', class: 'todo'
+    #     end
+    #   end
+    class ControllerRenderer
+      include React::Rails::ViewHelper
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
 
-  attr_accessor :output_buffer
+      attr_accessor :output_buffer
 
-  def initialize(options={})
-    controller = options[:controller]
-    @__react_component_helper = controller.__react_component_helper
-  end
+      def initialize(options={})
+        controller = options[:controller]
+        @__react_component_helper = controller.__react_component_helper
+      end
 
-  def call(name, options, &block)
-    props = options.fetch(:props, {})
-    options = options.slice(:data, :aria, :tag, :class, :id).merge(prerender: true)
-    react_component(name, props, options, &block)
+      # @return [String] Prerendered HTML for `component_name` with `options[:props]`
+      def call(component_name, options, &block)
+        props = options.fetch(:props, {})
+        options = options.slice(:data, :aria, :tag, :class, :id).merge(prerender: true)
+        react_component(component_name, props, options, &block)
+      end
+    end
   end
 end

data/lib/react/rails/railtie.rb

@@ -59,8 +59,10 @@ module React
           addons: app.config.react.addons,
         })
 
-        sprockets_env = app.assets || app.config.assets # sprockets-rails 3.x attaches this at a different config
-        sprockets_env.version = [sprockets_env.version, "react-#{asset_variant.react_build}",].compact.join('-')
+        sprockets_env = app.assets || app.config.try(:assets) # sprockets-rails 3.x attaches this at a different config
+        if !sprockets_env.nil?
+          sprockets_env.version = [sprockets_env.version, "react-#{asset_variant.react_build}",].compact.join('-')
+        end
 
       end
 
@@ -70,8 +72,10 @@ module React
           addons: app.config.react.addons,
         })
 
-        app.config.assets.paths << asset_variant.react_directory
-        app.config.assets.paths << asset_variant.jsx_directory
+        if app.config.respond_to?(:assets)
+          app.config.assets.paths << asset_variant.react_directory
+          app.config.assets.paths << asset_variant.jsx_directory
+        end
       end
 
       config.after_initialize do |app|
@@ -93,14 +97,20 @@ module React
       end
 
       initializer "react_rails.setup_engine", :group => :all do |app|
-        sprockets_env = app.assets || Sprockets # Sprockets 3.x expects this in a different place
-        if Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new("4.x")
-          sprockets_env.register_mime_type("application/jsx", extensions: [".jsx", ".js.jsx", ".es.jsx", ".es6.jsx"])
-          sprockets_env.register_transformer("application/jsx", "application/javascript", React::JSX::Processor)
-        elsif Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new("3.0.0")
-          sprockets_env.register_engine(".jsx", React::JSX::Processor, mime_type: "application/javascript")
-        else
-          sprockets_env.register_engine(".jsx", React::JSX::Template)
+        # Sprockets 3.x expects this in a different place
+        sprockets_env = app.assets || defined?(Sprockets) && Sprockets
+
+        if !sprockets_env.nil?
+          if Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new("4.x")
+            sprockets_env.register_mime_type("application/jsx", extensions: [".jsx", ".js.jsx", ".es.jsx", ".es6.jsx"])
+            sprockets_env.register_transformer("application/jsx", "application/javascript", React::JSX::Processor)
+            sprockets_env.register_mime_type("application/jsx+coffee", extensions: [".jsx.coffee", ".js.jsx.coffee"])
+            sprockets_env.register_transformer("application/jsx+coffee", "application/jsx", Sprockets::CoffeeScriptProcessor)
+          elsif Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new("3.0.0")
+            sprockets_env.register_engine(".jsx", React::JSX::Processor, mime_type: "application/javascript")
+          else
+            sprockets_env.register_engine(".jsx", React::JSX::Template)
+          end
         end
       end
     end

data/lib/react/rails/version.rb

@@ -2,6 +2,6 @@ module React
   module Rails
     # If you change this, make sure to update VERSIONS.md
     # And the version hint in README.md, if needed
-    VERSION = '1.7.2'
+    VERSION = "1.8.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react-rails
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Paul O’Shannessy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: coffee-script-source
   requirement: !ruby/object:Gem::Requirement
@@ -221,7 +235,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -307,10 +321,12 @@ files:
 - lib/assets/react-source/production/react.js
 - lib/generators/react/component_generator.rb
 - lib/generators/react/install_generator.rb
+- lib/generators/react/ujs_generator.rb
 - lib/generators/templates/component.es6.jsx
 - lib/generators/templates/component.js.jsx
 - lib/generators/templates/component.js.jsx.coffee
 - lib/react-rails.rb
+- lib/react.rb
 - lib/react/jsx.rb
 - lib/react/jsx/babel_transformer.rb
 - lib/react/jsx/jsx_transformer.rb