breezy 0.9.0 → 0.14.0

data/lib/install/templates/web/actions.js

@@ -0,0 +1,3 @@
+// Example:
+//
+// export const CLEAR_FORM_ERRORS = 'CLEAR_FORM_ERRORS'

data/lib/install/templates/web/application.js

@@ -1,18 +1,21 @@
 import React from 'react'
 import {combineReducers, createStore, applyMiddleware, compose} from 'redux'
+import reduceReducers from 'reduce-reducers'
 import thunk from 'redux-thunk'
 import { Provider } from 'react-redux'
 import { render } from 'react-dom'
-import createHistory from 'history/createBrowserHistory'
+import { createBrowserHistory } from 'history'
 import Breezy from '@jho406/breezy'
 import Nav from '@jho406/breezy/dist/NavComponent'
+import ujsHandlers from '@jho406/breezy/dist/utils/ujs'
+import applicationReducer from './reducer'
 
 // Mapping between your props template to Component
 // e.g {'posts/new': PostNew}
-const screenToComponentMapping = {
+const identifierToComponentMapping = {
 }
 
-const history = createHistory({})
+const history = createBrowserHistory({})
 const initialPage = window.BREEZY_INITIAL_PAGE_STATE
 const baseUrl = ''
 
@@ -27,20 +30,30 @@ const {reducer, initialState, initialPageKey, connect} = Breezy.start({
 
 const composeEnhancers = window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ || compose
 
+const {
+  breezy: breezyReducer,
+  pages: pagesReducer,
+} = reducer
+
 const store = createStore(
   combineReducers({
-    ...reducer,
+    breezy: breezyReducer,
+    pages: reduceReducers(pagesReducer, applicationReducer),
   }),
   initialState,
   composeEnhancers(applyMiddleware(thunk))
 )
 
+const navigatorRef = React.createRef()
+
 connect(store)
 
 class App extends React.Component {
   render() {
     return <Provider store={store}>
       <Nav
+        store={store}
+        ref={navigatorRef}
         mapping={this.props.mapping}
         history={history}
         initialPageKey={initialPageKey}
@@ -50,5 +63,17 @@ class App extends React.Component {
 }
 
 document.addEventListener("DOMContentLoaded", function() {
-  render(<App mapping={screenToComponentMapping}/>, document.getElementById('app'))
+  const appEl = document.getElementById('app')
+  if (appEl) {
+    const {onClick, onSubmit} = ujsHandlers({
+      navigatorRef,
+      store,
+      ujsAttributePrefix: 'data-bz'
+    })
+
+    appEl.addEventListener('click', onClick)
+    appEl.addEventListener('submit', onSubmit)
+
+    render(<App mapping={identifierToComponentMapping}/>, appEl)
+  }
 })

data/lib/install/templates/web/application.json.props

@@ -0,0 +1,25 @@
+path = param_to_search_path(params[:bzq])
+
+json.data(search: path) do
+  yield json
+end
+
+json.component_identifier local_assigns[:virtual_path_of_template]
+json.defers json.deferred!
+json.fragments json.fragments!
+json.assets [
+  asset_pack_path('application.js'),
+  asset_path('application.css')
+]
+
+if protect_against_forgery?
+  json.csrf_token form_authenticity_token
+end
+
+if path
+  json.action 'graft'
+  json.path search_path_to_camelized_param(path)
+end
+
+json.flash flash.to_h
+

data/lib/install/templates/web/initializer.rb

@@ -1,6 +1 @@
-require 'breezy_template/core_ext'
-
-Breezy.configure do |config|
-  config.track_sprockets_assets = ['application.js', 'application.css']
-  config.track_pack_assets = ['application.js']
-end
+require 'props_template/core_ext'

data/lib/install/templates/web/reducer.js

@@ -0,0 +1,28 @@
+// Example:
+//
+// import {
+//   CLEAR_FORM_ERRORS
+// } from './actions'
+// import produce from "immer"
+//
+// export default function (state = {}, action) {
+//   switch(action.type) {
+//   case CLEAR_FORM_ERRORS: {
+//     const {pageKey} = action.payload
+//
+//     return produce(state, draft => {
+//       const currentPage = draft[pageKey]
+//       delete currentPage.errors
+//     })
+//   }
+//   default:
+//     return state
+//   }
+// }
+
+export default function (state = {}, action) {
+  switch(action.type) {
+  default:
+    return state
+  }
+}

data/lib/install/web.rb

@@ -1,14 +1,11 @@
 require "webpacker/configuration"
 
-babelrc = Rails.root.join(".babelrc")
+babel_config = Rails.root.join("babel.config.js")
 
 def append_js_tags
   app_html = 'app/views/layouts/application.html.erb'
   js_tag = <<-JS_TAG
-
-    <script type="text/javascript">
-      window.BREEZY_INITIAL_PAGE_STATE=<%= breezy_snippet %>;
-    </script>
+    <%= yield :initial_state %>
   JS_TAG
 
   inject_into_file app_html, after: '<head>' do
@@ -24,60 +21,49 @@ def add_member_methods
   inject_into_file "app/models/application_record.rb", after: "class ApplicationRecord < ActiveRecord::Base\n" do
     <<-RUBY
   def self.member_at(index)
-    offset(index).limit(1)
+    offset(index).limit(1).first
   end
 
   def self.member_by(attr, value)
-    find_by(Hash[attr, val])
+    find_by(Hash[attr, value])
   end
-
     RUBY
   end
 end
 
-
-if File.exist?(babelrc)
-  react_babelrc = JSON.parse(File.read(babelrc))
-  react_babelrc["presets"] ||= []
-  react_babelrc["plugins"] ||= []
-
-  if !react_babelrc["presets"].include?("react")
-    react_babelrc["presets"].push("react")
-    say "Copying react preset to your .babelrc file"
-
-    File.open(babelrc, "w") do |f|
-      f.puts JSON.pretty_generate(react_babelrc)
-    end
-  end
-
-  if !react_babelrc["plugins"].any?{|plugin| Array(plugin).include?("module-resolver")}
-    react_babelrc["plugins"].push(["module-resolver", {
+say "Copying module-resolver preset to your babel.config.js"
+resolver_snippet = <<~JAVASCRIPT
+  [
+    require('babel-plugin-module-resolver').default, {
       "root": ["./app"],
       "alias": {
         "views": "./app/views",
         "components": "./app/components",
-        "javascripts": "./app/javascripts"
+        "javascript": "./app/javascript"
       }
-    }])
+    }
+  ],
+JAVASCRIPT
+insert_into_file "babel.config.js", resolver_snippet, after: /plugins: \[\n/
 
-    say "Copying module-resolver preset to your .babelrc file"
+say "Copying application.js file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/templates/web/application.js", "#{Webpacker.config.source_entry_path}/application.js"
 
-    File.open(babelrc, "w") do |f|
-      f.puts JSON.pretty_generate(react_babelrc)
-    end
-  end
+say "Copying reducer.js file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/templates/web/reducer.js", "#{Webpacker.config.source_entry_path}/reducer.js"
 
-else
-  say "Copying .babelrc to app root directory"
-  copy_file "#{__dir__}/templates/web/babelrc", ".babelrc"
-end
+say "Copying action_creators.js file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/templates/web/action_creators.js", "#{Webpacker.config.source_entry_path}/action_creators.js"
 
-say "Copying application.js file to #{Webpacker.config.source_entry_path}"
-copy_file "#{__dir__}/templates/web/application.js", "#{Webpacker.config.source_entry_path}/application.js"
+say "Copying actions.js file to #{Webpacker.config.source_entry_path}"
+copy_file "#{__dir__}/templates/web/actions.js", "#{Webpacker.config.source_entry_path}/actions.js"
 
 say "Copying Breezy initializer"
 copy_file "#{__dir__}/templates/web/initializer.rb", "config/initializers/breezy.rb"
 
+say "Copying application.json.props"
+copy_file "#{__dir__}/templates/web/application.json.props", "app/views/layouts/application.json.props"
+
 say "Appending js tags to your application.html.erb"
 append_js_tags
 
@@ -85,9 +71,10 @@ say "Adding required member methods to ApplicationRecord"
 add_member_methods
 
 say "Installing React, Redux, and Breezy"
-run "yarn add babel-plugin-module-resolver babel-preset-react formik history prop-types react-redux redux-thunk redux react react-dom @jho406/breezy --save"
+run "yarn add babel-plugin-module-resolver babel-preset-react history prop-types react-redux redux-thunk redux reduce-reducers react react-dom immer @jho406/breezy --save"
 
-say "Updating webpack paths to include .jsx file extension"
+say "Updating webpack config to include .jsx file extension and resolved_paths"
 insert_into_file Webpacker.config.config_path, "    - .jsx\n", after: /extensions:\n/
+insert_into_file Webpacker.config.config_path, "'app/views', 'app/components'", after: /resolved_paths: \[/
 
 say "Webpacker now supports breezy.js 🎉", :green

data/lib/tasks/install.rake

@@ -10,6 +10,16 @@ namespace :breezy do
     end
   end
 
+  desc "Verifies if any version of react is in package.json"
+  task :verify_react do
+    package_json = JSON.parse(File.read(Rails.root.join("package.json")))
+
+    if package_json['dependencies']['react'].nil?
+      $stderr.puts "React not installed. Did you run `rails webpacker:install:react`?"
+      $stderr.puts "Exiting!" && exit!
+    end
+  end
+
   desc "Verifies webpacker has been installed"
   task "verify_webpacker" do
     begin
@@ -23,16 +33,10 @@ namespace :breezy do
 
   namespace :install do
     desc "Install everything needed for breezy web"
-    task 'web' => ["breezy:verify_webpacker", "webpacker:verify_install"] do
+    task 'web' => ["breezy:verify_webpacker", "webpacker:verify_install", "breezy:verify_react"] do
       template = File.expand_path("../install/web.rb", __dir__)
       exec "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{template}"
     end
-
-    desc "Install everything needed for breezy mobile"
-    task 'mobile' => ["breezy:verify_yarn"] do
-      template = File.expand_path("../install/mobile.rb", __dir__)
-      exec "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{template}"
-    end
   end
 end
 

data/test/helpers_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class HelpersTest < ActiveSupport::TestCase
+  include Breezy::Helpers
+
+  test 'clean_bzq returns nil if qry is nil' do
+    qry = nil
+
+    assert_nil param_to_search_path(qry)
+  end
+
+  test 'clean_bzq returns a refined qry' do
+    qry = 'foo...bar/?)()-'
+
+    assert_equal param_to_search_path(qry), ['foo', 'bar']
+  end
+
+  test 'camelize_path' do
+    path = ['foo_bar', 'foo_bar=1', 'foo_baz_roo']
+
+    assert_equal search_path_to_camelized_param(path), 'fooBar.fooBar=1.fooBazRoo'
+  end
+end

data/test/render_test.rb

@@ -4,14 +4,14 @@ class RenderController < TestController
   require 'action_view/testing/resolvers'
 
   append_view_path(ActionView::FixtureResolver.new(
-    'render/action.js.breezy' => 'json.author "john smith"',
-    'render/action.html.erb' => 'john smith',
-    'render/implied_render_with_breezy.js.breezy' => 'json.author "john smith"',
-    'render/implied_render_with_breezy.html.erb' => 'john smith',
+    'render/simple_render_with_breezy.json.props' => 'json.author "john smith"',
+    'render/simple_render_with_breezy_with_bad_layout.json.props' => 'json.author "john smith"',
+    'layouts/application.json.props' => 'json.data {yield json}',
+    'layouts/does_not_exist.html.erb' => '',
     'layouts/application.html.erb' => <<~HTML
       <html>
         <head>
-          <script><%= breezy_snippet %></script>
+          <script><%= @initial_state.strip.html_safe %></script>
         </head>
         <body><%=yield%></body>
       </html>
@@ -20,21 +20,18 @@ class RenderController < TestController
 
   layout 'application'
 
-  before_action :use_breezy, only: [:simple_render_with_breezy, :implied_render_with_breezy]
-
   def render_action
     render :action
   end
 
   def simple_render_with_breezy
-    render :action
+    @initial_state = render_to_string(formats: [:json], layout: true)
+    render inline: '', layout: true
   end
 
-  def implied_render_with_breezy
-  end
-
-  def render_action_with_breezy_false
-    render :action
+  def simple_render_with_breezy_with_bad_layout
+    @initial_state = render_to_string(formats: [:json], layout: 'does_not_exist')
+    render inline: '', layout: true
   end
 
   def form_authenticity_token
@@ -47,102 +44,38 @@ class RenderTest < ActionController::TestCase
 
 
   setup do
-    Breezy.configuration.track_sprockets_assets = ['app.js']
-    Breezy.configuration.track_pack_assets = ['app.js']
-  end
-
-  teardown do
-    Breezy.configuration.track_sprockets_assets = []
-    Breezy.configuration.track_pack_assets = []
-  end
-
-  test "render action via get" do
-    get :render_action
-    assert_normal_render 'john smith'
+    if Rails.version >= '6'
+      # In rails 6, the fixture orders the templates based on their appearance in the handler
+      # This doesn't happen IRL, so I'm going to explicitly set the handler here.
+      #
+      # Note that the original is the following
+      # @controller.lookup_context.handlers = [:raw, :breezy, :erb, :js, :html, :builder, :ruby]
+      @controller.lookup_context.handlers = [:props, :erb]
+    end
   end
 
   test "simple render with breezy" do
     get :simple_render_with_breezy
-    assert_breezy_html({author: "john smith"}, screen: 'render/action')
-  end
-
-  test "implied render with breezy" do
-    get :implied_render_with_breezy
-    assert_breezy_html({author: "john smith"}, screen: 'render/implied_render_with_breezy')
-  end
-
-  test "simple render with breezy via get js" do
-    @request.accept = 'application/javascript'
-    get :simple_render_with_breezy
-    assert_breezy_js({author: "john smith"})
-  end
-
-  test "render action via xhr and get js" do
-    @request.accept = 'application/javascript'
-    get :simple_render_with_breezy, xhr: true
-    assert_breezy_js({author: "john smith"})
-  end
-
-  test "render with breezy false" do
-    get :render_action_with_breezy_false
-    assert_normal_render("john smith")
-  end
-
-  test "render with breezy false via xhr get" do
-    @request.accept = 'text/html'
-    get :render_action_with_breezy_false, xhr: true
-    assert_normal_render("john smith")
-  end
-
-  test "render action via xhr and put" do
-    @request.accept = 'text/html'
-    put :render_action, xhr: true
-    assert_normal_render 'john smith'
-  end
 
-  private
-
-  def assert_breezy_html(content, opts={})
     assert_response 200
-
     rendered = <<~HTML
       <html>
         <head>
-          <script>(function(){var joints={};var cache={};var defers=[];return ({"data":#{content.to_json},"screen":"#{opts[:screen]}","csrf_token":"secret","assets":["/app.js"],"joints":joints,"defers":defers});})();</script>
+          <script>{"data":{"author":"john smith"}}</script>
         </head>
         <body></body>
       </html>
     HTML
 
     assert_equal rendered, @response.body
-    assert_equal 'text/html', @response.content_type
-  end
-
-  def assert_breezy_js(content)
-    assert_response 200
-    assert_equal '(function(){var joints={};var cache={};var defers=[];return ({"data":' + content.to_json + ',"screen":"render/action","csrf_token":"secret","assets":["/app.js"],"joints":joints,"defers":defers});})()', @response.body
-    assert_equal 'text/javascript', @response.content_type
-  end
-
-  def assert_breezy_replace_js(content)
-    assert_response 200
-    assert_equal 'Breezy.replace((function(){return ({"data":' + content.to_json + ',"csrf_token":"secret","assets":["/app.js"]});})());', @response.body
-    assert_equal 'text/javascript', @response.content_type
+    assert_equal 'text/html', @response.media_type
   end
 
-  def assert_normal_render(content)
-    assert_response 200
-
-    rendered = <<~HTML
-      <html>
-        <head>
-          <script></script>
-        </head>
-        <body>#{content}</body>
-      </html>
-    HTML
+  test "simple render when the layout doesn't exist" do
+    err = assert_raise ActionView::MissingTemplate do |e|
+      get :simple_render_with_breezy_with_bad_layout
+    end
 
-    assert_equal rendered, @response.body
-    assert_equal 'text/html', @response.content_type
+    assert_equal(true, err.message.starts_with?('Missing template layouts/does_not_exist with {:locale=>[:en], :formats=>[:json], :variants=>[], :handlers=>[:props, :erb]}.'))
   end
 end