add some docs

Author: rmosolgo

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'] }

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'
 

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])

lib/react/jsx/template.rb

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

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'
 

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