breezy 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04390cdac77569e25cbc5b620e83f4ee91bf52bf
-  data.tar.gz: dc5fd6c5012c40372178ec383c79cd47ed20f82a
+  metadata.gz: 416b99e2708b578ba122dd323bf680a6a18678e1
+  data.tar.gz: 8ca2f73b07f48aa9d9d41cdd9cc9faebdc0ecd97
 SHA512:
-  metadata.gz: 46e782dc395622b456ba87ba5015add0c96d7f27420719b314c483d08978e6527aee94af131dbc5345bc627d4b8d355fa138f57e771dc933a5b881c5c00cc153
-  data.tar.gz: 251b1c6d31803306e78d4859045be5835d69ad07061971075ea9b2ec65ce651fc79c2eb635e4d6ff9045f5cc97e2c0eaa6946fdc8c474c5f7da2b336b66e8da0
+  metadata.gz: a500e2f721234fb089a81996d00cb39bf09b3f07bdf1c87c0108d7349481e21da36d08467083d46bc300e74301ca72f55ba8106eaa537ff24ac4815c004ab483
+  data.tar.gz: cc7ec2319b970c95c17ea4ee3d98d7c40be99d06767daa623894fc0fb29c51a5c41e1207d43e3a67d29964a6fc8d546d109513bfc32eb9af09c570bb33b85d9c

data/lib/breezy.rb

@@ -1,12 +1,12 @@
 require 'breezy/version'
 require 'breezy/xhr_headers'
-require 'breezy/xhr_redirect'
 require 'breezy/xhr_url_for'
 require 'breezy/cookies'
 require 'breezy/x_domain_blocker'
 require 'breezy/render'
 require 'breezy/helpers'
 require 'breezy/configuration'
+require 'breezy_template'
 
 module Breezy
   module Controller
@@ -14,10 +14,10 @@ module Breezy
 
     def self.included(base)
       if base.respond_to?(:before_action)
-        base.before_action :set_xhr_redirected_to, :set_request_method_cookie
+        base.before_action :set_response_url, :set_request_method_cookie
         base.after_action :abort_xdomain_redirect
       else
-        base.before_filter :set_xhr_redirected_to, :set_request_method_cookie
+        base.before_filter :set_response_url, :set_request_method_cookie
         base.after_filter :abort_xdomain_redirect
       end
 
@@ -35,6 +35,14 @@ module Breezy
     config.breezy = ActiveSupport::OrderedOptions.new
     config.breezy.auto_include = true
 
+    if Rails::VERSION::MAJOR >= 4
+      generators do |app|
+        Rails::Generators.configure! app.config.generators
+        Rails::Generators.hidden_namespaces.uniq!
+        require 'generators/rails/scaffold_controller_generator'
+      end
+    end
+
     initializer :breezy do |app|
       ActiveSupport.on_load(:action_controller) do
         next if self != ActionController::Base
@@ -51,9 +59,6 @@ module Breezy
         end
 
         require 'action_dispatch/routing/redirection'
-        ActionDispatch::Routing::Redirect.class_eval do
-          prepend XHRRedirect
-        end
 
         (ActionView::RoutingUrlFor rescue ActionView::Helpers::UrlHelper).module_eval do
           prepend XHRUrlFor

data/lib/breezy/render.rb

@@ -11,7 +11,14 @@ module Breezy
     def render(*args, &block)
       render_options = args.extract_options!
       breezy = render_options.delete(:breezy)
-      breezy = {} if breezy == true || @_use_breezy_html
+
+      if breezy == true
+        breezy = {}
+      end
+
+      if !breezy && @_use_breezy_html
+        breezy = {}
+      end
 
       if breezy
         view_parts = _prefixes.reverse.push(action_name)[1..-1]

data/lib/breezy/version.rb

@@ -1,3 +1,3 @@
 module Breezy
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/lib/breezy/xhr_headers.rb

@@ -1,20 +1,9 @@
 module Breezy
-  # Intercepts calls to _compute_redirect_to_location (used by redirect_to) for two purposes.
-  #
-  # 1. Corrects the behavior of redirect_to with the :back option by using the X-XHR-Referer
-  # request header instead of the standard Referer request header.
-  #
-  # 2. Stores the return value (the redirect target url) to persist through to the redirect
-  # request, where it will be used to set the X-XHR-Redirected-To response header.  The
-  # Breezy script will detect the header and use replaceState to reflect the redirected
-  # url.
   module XHRHeaders
     if Rails.version >= '5.0'
       def redirect_back(fallback_location:, **args)
         if referer = request.headers["X-XHR-Referer"]
-          rsp = redirect_to referer, **args
-          store_for_breezy(self.location)
-          rsp
+          redirect_to referer, **args
         else
           super
         end
@@ -24,25 +13,23 @@ module Breezy
     def _compute_redirect_to_location(*args)
       options, request = _normalize_redirect_params(args)
 
-      store_for_breezy begin
+      url = begin
         if options == :back && request.headers["X-XHR-Referer"]
           super(*[(request if args.length == 2), request.headers["X-XHR-Referer"]].compact)
         else
           super(*args)
         end
       end
-    end
 
-    private
-      def store_for_breezy(url)
-        session[:_breezy_redirect_to] = url if session && request.headers["X-XHR-Referer"]
-        url
+      if request.xhr? && request.headers["X-BREEZY-REQUEST"]
+        self.status = 200
+        response.headers["X-BREEZY-LOCATION"] = url
       end
+    end
 
-      def set_xhr_redirected_to
-        if session && session[:_breezy_redirect_to]
-          response.headers['X-XHR-Redirected-To'] = session.delete :_breezy_redirect_to
-        end
+    private
+      def set_response_url
+        response.headers['X-RESPONSE-URL'] = request.fullpath
       end
 
       # Ensure backwards compatibility

data/lib/generators/breezy/view/view_generator.rb

@@ -29,12 +29,12 @@ DESC
           @content_path =  File.join(destination, "#{@action}.js.props")
 
           if options[:target] == 'mobile'
-            @view_ext = 'jsx'
+            @view_ext = 'jsx.mobile'
           else
-            @view_ext = 'js' #todo fix me
+            @view_ext = 'jsx.web' #todo fix me
           end
 
-          @view_path = File.join(destination, "#{@action}.#{@view_ext}")
+          @view_path = File.join(destination, "#{@action}.jsx")
 
           template "view.#{@view_ext}", @view_path
           template 'view.js.breezy', @content_path

data/lib/generators/rails/breezy_generator.rb

@@ -0,0 +1,103 @@
+require 'rails/generators/named_base'
+require 'rails/generators/resource_helpers'
+
+module Rails
+  module Generators
+    class BreezyGenerator < NamedBase # :nodoc:
+      include Rails::Generators::ResourceHelpers
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :attributes, type: :array, default: [], banner: 'field:type field:type'
+      class_option :platform, type: :string, default: 'web', enum: ['web', 'mobile']
+
+      def create_root_folder
+        path = File.join('app/views', controller_file_path)
+        empty_directory path unless File.directory?(path)
+      end
+
+      def copy_view_files
+        %w(index show new edit).each do |view|
+          @action_name = view
+          filename = filename_with_extensions(view)
+          template filename, File.join('app/views', controller_file_path, filename)
+        end
+
+        %w(index show new edit).each do |view|
+          @action_name = view
+          filename = filename_with_jsx_extensions(view)
+          if options[:platform] == 'mobile'
+            template 'mobile/' + filename, File.join('app/views', controller_file_path, filename)
+          else
+            template 'web/' + filename, File.join('app/views', controller_file_path, filename)
+          end
+        end
+
+        js_filename = [plural_table_name, 'form.jsx'].map(&:camelcase).join
+        if options[:platform] == 'mobile'
+          template 'mobile/form.jsx', File.join('app/components', js_filename)
+          template 'mobile/elements.js', File.join('app/components', 'elements.js')
+        else
+          template 'web/form.jsx', File.join('app/components', js_filename)
+          template 'web/base.jsx', File.join('app/components', 'BaseScreen.jsx')
+        end
+
+        %w(index show new edit).each do |view|
+          append_mapping(view)
+        end
+        # template filename_with_extensions('partial'), File.join('app/views', controller_file_path, filename_with_extensions("_#{singular_table_name}"))
+      end
+
+
+      protected
+        def append_mapping(action)
+          if options[:platform] == 'mobile'
+            app_js = 'App.js'
+          else
+            app_js = 'app/javascript/packs/application.js'
+          end
+
+          base_parts = class_path + [file_name]
+          destination =  File.join("views", base_parts)
+
+          @js_filename = [plural_table_name, action].map(&:camelcase).join
+
+          inject_into_file app_js, after: "from '@jho406/breezy'" do
+            "\nimport #{@js_filename} from 'views/#{controller_file_path}/#{action}'"
+          end
+
+          inject_into_file app_js, after: 'const mapping = {' do
+            "\n  #{@js_filename},"
+          end
+        end
+
+        def action_name
+          @action_name
+        end
+
+        def attributes_names
+          [:id] + super
+        end
+
+        def filename_with_extensions(name)
+          [name, :js, :props] * '.'
+        end
+
+        def filename_with_jsx_extensions(name)
+          [name, :jsx] * '.'
+        end
+
+        def attributes_list_with_timestamps
+          attributes_list(attributes_names + %w(created_at updated_at))
+        end
+
+        def attributes_list(attributes = attributes_names)
+          if self.attributes.any? {|attr| attr.name == 'password' && attr.type == :digest}
+            attributes = attributes.reject {|name| %w(password password_confirmation).include? name}
+          end
+
+          attributes
+        end
+    end
+  end
+end

data/lib/generators/rails/scaffold_controller_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+
+module Rails
+  module Generators
+    class ScaffoldControllerGenerator
+      source_paths << File.expand_path('../templates', __FILE__)
+      class_option :platform, type: :string, desc:'Indicates to generate React web or native components', default: 'web', enum: ['web', 'mobile']
+
+      hook_for :breezy, type: :boolean, default: true
+    end
+  end
+end

data/lib/generators/rails/templates/controller.rb.tt

@@ -0,0 +1,85 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+  # `use_breezy_html` returns a blank template, allowing for JS to take over
+  # on application.html.erb
+  before_action :use_breezy_html
+
+  # GET <%= route_url %>
+  def index
+    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
+  end
+
+  # GET <%= route_url %>/1
+  def show
+  end
+
+  # GET <%= route_url %>/new
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+  end
+
+  # GET <%= route_url %>/1/edit
+  def edit
+  end
+
+  # POST <%= route_url %>
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+
+    if @<%= orm_instance.save %>
+      <%- if options[:platform] == 'mobile' -%>
+      redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully created.'" %>
+      <%- else -%>
+      redirect_to @<%= singular_table_name %>, notice: <%= "'#{human_name} was successfully created.'" %>
+      <%- end -%>
+    else
+      response.set_header("content-location", new_<%= singular_table_name %>_path)
+      render :new, breezy: {screen: '<%= plural_table_name.camelize %>New'}
+    end
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  def update
+    if @<%= orm_instance.update("#{singular_table_name}_params") %>
+      <%- if options[:platform] == 'mobile' -%>
+      redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully updated.'" %>
+      <%- else -%>
+      redirect_to @<%= singular_table_name %>, notice: <%= "'#{human_name} was successfully updated.'" %>
+      <%- end -%>
+    else
+      response.set_header("content-location", edit_<%= singular_table_name %>_path(@<%= singular_table_name %>))
+      render :edit, breezy: {screen: '<%= plural_table_name.camelize %>Edit'}
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  def destroy
+    @<%= orm_instance.destroy %>
+    <%- if options[:platform] == 'mobile' -%>
+    redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %>
+    <%- else -%>
+    redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %>
+    <%- end -%>
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_<%= singular_table_name %>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def <%= "#{singular_table_name}_params" %>
+      <%- if attributes_names.empty? -%>
+      params.fetch(:<%= singular_table_name %>, {})
+      <%- else -%>
+      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      <%- end -%>
+    end
+end
+<% end -%>

data/lib/generators/rails/templates/edit.js.props

@@ -0,0 +1,18 @@
+<%- attributes_list_with_timestamps.each do |attr| -%>
+json.<%=attr%> @<%= singular_table_name %>.<%=attr%>
+<%- end -%>
+
+if @<%= singular_table_name %>.errors.any?
+  json.errors @<%= singular_table_name %>.errors.to_h
+end
+
+json.attributes_for_form do
+<%- attributes_list.select{|attr| attr != :id }.each do |attr| -%>
+  json.<%=attr%> @<%= singular_table_name %>.<%=attr%>
+<%- end -%>
+end
+
+json.meta do
+  json.show_path <%=singular_table_name%>_path(@<%=singular_table_name%>)
+  json.index_path <%= plural_table_name %>_path
+end

data/lib/generators/rails/templates/index.js.props

@@ -0,0 +1,20 @@
+json.<%= plural_table_name %> do
+  json.array! @<%= plural_table_name %> do |<%= singular_table_name %>|
+    <%- attributes_list_with_timestamps.each do |attr| -%>
+    json.<%=attr%> <%= singular_table_name %>.<%=attr%>
+    <%- end -%>
+    json.meta do
+      json.edit_path edit_<%=singular_table_name%>_path(<%=singular_table_name%>)
+      json.show_path <%=singular_table_name%>_path(<%=singular_table_name%>)
+      json.delete_path <%=singular_table_name%>_path(<%=singular_table_name%>)
+    end
+  end
+end
+
+if notice
+  json.notice notice
+end
+
+json.meta do
+  json.new_path new_<%= singular_table_name %>_path
+end

data/lib/generators/rails/templates/mobile/edit.jsx

@@ -0,0 +1,76 @@
+import React from 'react'
+import {submit} from 'redux-form'
+import {Header} from 'react-native-elements'
+import {SubmissionError} from 'redux-form'
+import {View} from 'react-native'
+import {connect} from 'react-redux'
+import {delInPage} from '@jho406/breezy/dist/action_creators'
+import {mapStateToProps, mapDispatchToProps} from '@jho406/breezy'
+import <%= plural_table_name.camelize %>Form from 'components/<%= plural_table_name.camelize %>Form'
+import {Container, BarSaveAndGoBack, BarCancel} from 'components/elements'
+
+class <%= plural_table_name.camelize %>Edit extends React.Component {
+  constructor (props) {
+    super(props)
+    this.submit = this.submit.bind(this)
+    this.remoteSubmit = this.remoteSubmit.bind(this)
+  }
+
+  submit (body) {
+    const options = {
+      method: 'PATCH',
+      body: JSON.stringify(body),
+      contentType: 'application/json'
+    }
+
+    this.props.delInPage({pathQuery: this.props.pathQuery, keypath: 'errors'})
+    return this.props.visit('/<%= plural_table_name %>/' + this.props.id, options).then((rsp) => {
+      if (this.props.errors) {
+        throw new SubmissionError({
+          ...this.props.errors
+        })
+      }
+      if (rsp.canNavigate) {
+        return this.props.navigation.goBack()
+      } else {
+        // There can only ve one visit at a time, if `canNavigate`
+        // is false, then this request is being ignored for a more
+        // recent visit. Do Nothing.
+        return
+      }
+
+    }).catch((err) => {
+      if (err instanceof SubmissionError) {
+        throw err
+      } else {
+        //handle other errors here
+      }
+    })
+  }
+
+  remoteSubmit () {
+    this.props.remoteSubmit('<%=plural_table_name%>_form')
+  }
+
+  render () {
+    const headerOptions = {
+      leftComponent: (<BarSaveAndGoBack onPress={this.remoteSubmit} />),
+      rightComponent: (<BarCancel onPress={e => this.props.navigation.goBack()} />)
+    }
+    return (
+      <View>
+        <Header {...headerOptions}/>
+        <Container>
+          <<%= plural_table_name.camelize %>Form error={this.props.error} onSubmit={this.submit} initialValues={this.props.attributes_for_form}/>
+        </Container>
+      </View>
+    )
+  }
+}
+
+export default connect(
+  mapStateToProps,
+  {...mapDispatchToProps, remoteSubmit: submit, delInPage}
+)(<%= plural_table_name.camelize %>Edit)
+
+