frails 0.5.0 → 0.8.1

data/index.js

@@ -1,35 +1,14 @@
-const path = require('path')
-
-const rootPath = path.resolve(__dirname, '../../../')
-const publicOutputPath = process.env.FRAILS_PUBLIC_OUTPUT_PATH || 'assets'
-
-// Ensure that the publicPath includes our asset host so dynamic imports
-// (code-splitting chunks and static assets) load from the CDN instead of a relative path.
-const getPublicPathWithAssetHost = () => {
-  const rootUrl = process.env.RAILS_ASSET_HOST || '/'
-  let packPath = `${publicOutputPath}/`
-
-  // Add relative root prefix to pack path.
-  if (process.env.RAILS_RELATIVE_URL_ROOT) {
-    let relativeRoot = process.env.RAILS_RELATIVE_URL_ROOT
-    relativeRoot = relativeRoot.startsWith('/') ? relativeRoot.substr(1) : relativeRoot
-    packPath = `${ensureTrailingSlash(relativeRoot)}${packPath}`
-  }
-
-  return (rootUrl.endsWith('/') ? rootUrl : `${rootUrl}/`) + packPath
-}
+const config = require("./package/config");
 
 module.exports = {
-  // Configuration
-  publicOutputPath,
-  manifestPath: process.env.FRAILS_MANIFEST_PATH || 'manifest.json',
-  devServerPort: process.env.FRAILS_DEV_SERVER_PORT || '8080',
-  devServerHost: process.env.FRAILS_DEV_SERVER_HOST || 'localhost',
+  config,
 
   // The local ident name required for loading component styles.
-  cssLocalIdentName: process.env.NODE_ENV == 'development' ? '[path][name]__[local]___[md5:hash:hex:6]' : '[local]-[md5:hash:hex:6]',
-
-  getPublicPathWithAssetHost,
-  sideLoadEntry: require('./package/side_load'),
-  components: require('./package/components')
-}
+  cssLocalIdentName:
+    config.railsEnv == "development"
+      ? "[path][name]__[local]___[md5:hash:hex:6]"
+      : "[local]-[md5:hash:hex:6]",
+
+  sideLoadEntry: require("./package/side_load"),
+  components: require("./package/components"),
+};

data/lib/frails.rb

@@ -4,11 +4,6 @@ require 'frails/version'
 require 'active_support/core_ext/module'
 require 'active_support/core_ext/module/attribute_accessors'
 
-# ENV['FRAILS_DEV_SERVER_PORT'] ||= '8080'
-# ENV['FRAILS_DEV_SERVER_HOST'] ||= 'localhost'
-# ENV['FRAILS_PUBLIC_OUTPUT_PATH'] ||= 'assets'
-# ENV['FRAILS_MANIFEST_PATH'] ||= 'manifest.json'
-
 module Frails
   extend self
 
@@ -20,12 +15,41 @@ module Frails
     @manifest ||= Frails::ManifestManager.new
   end
 
-  def public_output_path
-    ENV['FRAILS_PUBLIC_OUTPUT_PATH'] || 'assets'
+  # Path of where webpack build output will be emitted, relative to the Rails public directory.
+  mattr_accessor :public_output_path
+  @@public_output_path = 'assets'
+
+  # Path and name of manifest file.
+  mattr_accessor :manifest_path
+  @@manifest_path = 'manifest.json'
+
+  # Hostname where the Webpack dev webpack server should run.
+  mattr_accessor :dev_server_host
+  @@dev_server_host = 'localhost'
+
+  # Post number where the Webpack dev webpack server should run.
+  mattr_accessor :dev_server_port
+  @@dev_server_port = 8080
+
+  def self.setup
+    yield self
+  end
+
+  def config
+    {
+      public_output_path: @@public_output_path,
+      dev_server_host: @@dev_server_host,
+      dev_server_port: @@dev_server_port,
+      manifest_path: @@manifest_path
+    }
+  end
+
+  def config_as_json
+    config.merge({ rails_env: Rails.env }).transform_keys { |key| key.to_s.camelize :lower }.to_json
   end
 
-  def manifest_path
-    ENV['FRAILS_MANIFEST_PATH'] || 'manifest.json'
+  def components_path
+    @components_path ||= Rails.root.join('app', 'components')
   end
 end
 

data/lib/frails/component.rb

@@ -3,9 +3,20 @@
 module Frails::Component
 end
 
+module ActionView
+  extend ActiveSupport::Autoload
+
+  # Make sure ActionView::SyntaxErrorInTemplate is loaded.
+  eager_autoload do
+    autoload_at 'action_view/template/error' do
+      autoload :SyntaxErrorInTemplate
+    end
+  end
+end
+
 require 'frails/component/renderer_concerns'
-require 'frails/component/component_renderer'
-require 'frails/component/react_component_renderer'
-require 'frails/component/abstract_component'
-require 'frails/component/plain_component'
-require 'frails/component/react_component'
+require 'frails/component/renderer'
+require 'frails/component/react_renderer'
+require 'frails/component/abstract'
+require 'frails/component/base'
+require 'frails/component/react'

data/lib/frails/component/{abstract_component.rb → abstract.rb}

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-class Frails::Component::AbstractComponent
+class Frails::Component::Abstract
   include ActiveSupport::Callbacks
 
   define_callbacks :render
 
-  def initialize(view, options)
-    @view, @options = view, options
+  def initialize(view, path, options)
+    @view = view
+    @path = path
+    @options = options
 
     expand_instance_vars
   end
@@ -24,19 +26,19 @@ class Frails::Component::AbstractComponent
   # rubocop:disable Lint/ShadowedException, Style/MissingRespondToMissing
   def method_missing(method, *args, &block)
     super
-  rescue NoMethodError, NameError => e1
+  rescue NoMethodError, NameError => e
     # the error is not mine, so just releases it as is.
-    raise e1 if e1.name != method
+    raise e if e.name != method
 
     begin
       @view.send method, *args, &block
-    rescue NoMethodError => e2
-      raise e2 if e2.name != method
+    rescue NoMethodError => e
+      raise e if e.name != method
 
       raise NoMethodError.new("undefined method `#{method}' for either #{self} or #{@view}",
                               method)
-    rescue NameError => e2
-      raise e2 if e2.name != method
+    rescue NameError => e
+      raise e if e.name != method
 
       raise NameError.new("undefined local variable `#{method}' for either #{self} or #{@view}",
                           method)

data/lib/frails/component/{plain_component.rb → base.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-class Frails::Component::PlainComponent < Frails::Component::AbstractComponent
-  PRIVATE_METHODS = %i[render method_missing locals].freeze
+class Frails::Component::Base < Frails::Component::Abstract
+  PRIVATE_METHODS = %i[render method_missing locals to_partial_path].freeze
 
-  def initialize(view, options)
+  def initialize(view, path, options)
     super
 
     @locals = @options.fetch(:locals, @options)
@@ -16,4 +16,8 @@ class Frails::Component::PlainComponent < Frails::Component::AbstractComponent
     end
     hash.merge @locals
   end
+
+  def to_partial_path
+    "#{@path}/index"
+  end
 end

data/lib/frails/component/{react_component.rb → react.rb}

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
-class Frails::Component::ReactComponent < Frails::Component::AbstractComponent
+class Frails::Component::React < Frails::Component::Abstract
   attr_accessor :class_name, :props, :tag, :prerender, :content_loader
 
-  def initialize(view, options)
-    @view, @options = view, options
+  def initialize(view, path, options)
+    super
 
     @class_name = @options.fetch(:class, nil)
     @props = @options.fetch(:props, {})
     @tag = @options.fetch(:tag, :div)
     @prerender = @options.fetch(:prerender, false)
     @content_loader = @options.fetch(:content_loader, false)
-
-    expand_instance_vars
   end
 end

data/lib/frails/component/{react_component_renderer.rb → react_renderer.rb}

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
-class Frails::Component::ReactComponentRenderer
+require 'frails/utils'
+
+class Frails::Component::ReactRenderer
   include Frails::Component::RendererConcerns
 
   def render(context, options, &block)
     @view = context
-    @component = options.delete(:component).to_s
-    @presenter = presenter_class.new(@view, options)
+    @component = options.delete(:component)
+
+    klass = presenter_class
+    @presenter = klass.new(@view, @component, options)
 
     @children = @view.capture(&block) if block_given?
 
@@ -15,27 +19,27 @@ class Frails::Component::ReactComponentRenderer
 
   private
 
-    # rubocop:disable Rails/OutputSafety
     def render_with_callbacks
       @presenter.run_callbacks :render do
         @prerender = @presenter.prerender
         @content_loader = @presenter.content_loader
         @props = camelize_keys(@presenter.props)
-        @props[:children] = @children if @children
+        @props[:children] = @children if instance_variable_defined?(:@children)
 
         @prerender && render_inline_styles
 
-        rendered_tag = content_tag do
-          @prerender ? React::Renderer.new.render(@component, @props).html_safe : loader
-        end
+        rendered_tag = if @prerender
+                         content_tag { React::Renderer.new.render(@component, @props).html_safe }
+                       else
+                         loader || content_tag { nil }
+                       end
 
         @prerender ? move_console_replay_script(rendered_tag) : rendered_tag
       end
     end
-    # rubocop:enable Rails/OutputSafety
 
     def presenter_class
-      super || Frails::Component::ReactComponent
+      super || Frails::Component::React
     end
 
     def data_for_content_tag
@@ -49,28 +53,30 @@ class Frails::Component::ReactComponentRenderer
     end
 
     def content_tag(&block)
-      classes = "js__reactComponent #{@presenter.class_name}"
-      @view.content_tag @presenter.tag, class: classes, data: data_for_content_tag, &block
+      class_names = "js__reactComponent #{@presenter.class_name}"
+      @view.content_tag @presenter.tag, class: class_names, data: data_for_content_tag, &block
     end
 
     def camelize_keys(data)
-      data.deep_transform_keys { |key| key.to_s.camelize :lower }
+      data.deep_transform_keys do |key|
+        Frails::Utils.camelize key.to_s, :lower, convert_slashes: false
+      end
     end
 
     def loader
       return unless @content_loader
 
-      @view.render "shared/content_loaders/#{@content_loader == true ? 'code' : @content_loader}"
+      @view.render @content_loader, class_name: 'js__reactComponent', data: data_for_content_tag
     end
 
     # Grab the server-rendered console replay script and move it outside the container div.
     #
-    # rubocop:disable Rails/OutputSafety, Style/RegexpLiteral
+    # rubocop:disable Style/RegexpLiteral
     def move_console_replay_script(rendered_tag)
       regex = /\n(<script class="js__reactServerConsoleReplay">.*<\/script>)<\/(\w+)>$/m
       rendered_tag.sub(regex, '</\2>\1').html_safe
     end
-    # rubocop:enable Rails/OutputSafety, Style/RegexpLiteral
+    # rubocop:enable Style/RegexpLiteral
 
     def stylesheet_entry_file
       "#{@component.tr('/', '-')}-index-entry-jsx"

data/lib/frails/component/{component_renderer.rb → renderer.rb}

@@ -1,29 +1,56 @@
 # frozen_string_literal: true
 
-class Frails::Component::ComponentRenderer < ActionView::PartialRenderer
+class Frails::Component::Renderer < ActionView::PartialRenderer
   include Frails::Component::RendererConcerns
 
+  # Overwritten to make sure we don't lookup partials. Even though this inherits from the
+  # PartialRenderer, component templates do not have the underscore prefix that partials have.
+  #
+  # Additionally, this will ensure that ONLY the app/components directory is used as the only view
+  # path to search within when looking up the component template.
+  def find_template(path, locals)
+    path_count = @lookup_context.view_paths.size
+    @lookup_context.view_paths.unshift Frails.components_path
+    old_paths = @lookup_context.view_paths.pop(path_count)
+
+    prefixes = path.include?('/') ? [] : @lookup_context.prefixes
+    result = @lookup_context.find_template(path, prefixes, false, locals, @details)
+
+    @lookup_context.view_paths.unshift(*old_paths)
+    @lookup_context.view_paths.pop
+
+    result
+  end
+
+  # rubocop:disable Metrics/AbcSize
   def render(context, options, &block)
     @view = context
-    @component = options.delete(:component).to_s
-    @presenter = presenter_class.new(@view, options)
+    @component = options.delete(:component)
+
+    klass = presenter_class
+    @presenter = klass.new(@view, @component, options)
+
+    @children = block_given? ? @view.capture(&block) : nil
+    options[:partial] = @presenter
 
     result = @presenter.run_callbacks :render do
       if @presenter.respond_to?(:render)
         @presenter.render(&block)
       else
         options[:locals] = @presenter.locals
+        options[:locals][:children] = @children
         super context, options, block
       end
     end
 
     apply_styles((result.respond_to?(:body) ? result.body : result) || nil)
   end
+  # rubocop:enable Metrics/AbcSize
 
   private
 
     def presenter_class
-      super || Frails::Component::PlainComponent
+      super || Frails::Component::Base
     end
 
     def apply_styles(content)
@@ -54,6 +81,7 @@ class Frails::Component::ComponentRenderer < ActionView::PartialRenderer
       class_names.to_s.split.map { |class_name| build_ident class_name }
     end
 
+    # rubocop:disable Metrics/AbcSize
     def build_ident(local_name)
       hash_digest = Digest::MD5.hexdigest("#{stylesheet_path}+#{local_name}")[0, 6]
 
@@ -64,11 +92,12 @@ class Frails::Component::ComponentRenderer < ActionView::PartialRenderer
       ident.prepend("#{stylesheet_path.dirname.to_s.tr('/', '-')}-")
       ident
     end
+    # rubocop:enable Metrics/AbcSize
 
     def stylesheet_path
       @stylesheet_path ||= begin
         style_file = "#{@component}/index.css"
-        Rails.root.join('app', 'components', style_file).relative_path_from(Rails.root)
+        Frails.components_path.join(style_file).relative_path_from(Rails.root)
       end
     end
 end

data/lib/frails/component/renderer_concerns.rb

@@ -6,7 +6,13 @@ module Frails::Component::RendererConcerns
   private
 
     def presenter_class
-      klass_file = Rails.root.join('app', 'components', "#{@component}_component.rb")
+      if @component.is_a?(Class) && @component < Frails::Component::Base
+        klass = @component
+        @component = @component.to_s.underscore
+        return klass
+      end
+
+      klass_file = Frails.components_path.join("#{@component}_component.rb")
       klass_file.exist? && "#{@component.to_s.camelcase}Component".constantize
     end
 
@@ -17,13 +23,13 @@ module Frails::Component::RendererConcerns
       # Don't inline the styles if already inlined.
       return if inlined_stylesheets.include?(@component)
 
-      Frails.manifest.read!(stylesheet_entry_file, :stylesheet) do |path, src|
+      Frails.manifest.read(stylesheet_entry_file, :stylesheet) do |path, src|
         @view.content_for :component_styles do
           @view.content_tag(:style, src, { data: { href: path } }, false)
         end
-      end
 
-      inlined_stylesheets << @component
+        inlined_stylesheets << @component
+      end
     end
 
     def inlined_stylesheets

data/lib/frails/component/test_helpers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Frails
+  module Component
+    module TestHelpers
+      def render_inline(options = {}, locals = {}, &block)
+        Nokogiri::HTML(controller.view_context.render(options, locals, &block))
+      end
+
+      def controller
+        @controller ||= ApplicationController.new.tap { |c| c.request = request }
+      end
+
+      def request
+        @request ||= ActionDispatch::TestRequest.create
+      end
+    end
+  end
+end

data/lib/frails/dev_server.rb

@@ -15,10 +15,10 @@ class Frails::DevServer
   end
 
   def host
-    ENV['FRAILS_DEV_SERVER_HOST'] || 'localhost'
+    Frails.dev_server_host
   end
 
   def port
-    ENV['FRAILS_DEV_SERVER_PORT'] || 8080
+    Frails.dev_server_port
   end
 end