RubyGems - inertia_rails - Versions diffs - 3.4.0 → 3.6.0 - Mend

inertia_rails 3.4.0 → 3.6.0

Files changed (205) hide show

data/lib/generators/inertia_tw_templates/scaffold/templates/vue/Index.vue.tt ADDED Viewed

@@ -0,0 +1,43 @@
+<template>
+  <Head title="<%= human_name.pluralize %>" />
+  <div className="mx-auto md:w-2/3 w-full px-8 pt-8">
+    <p
+      v-if="flash.notice"
+      class="py-2 px-3 bg-green-50 mb-5 text-green-500 font-medium rounded-lg inline-block"
+    >
+      {{ flash.notice }}
+    </p>
+    <div class="flex justify-between items-center">
+      <h1 class="font-bold text-4xl"><%= human_name.pluralize %></h1>
+      <Link
+        href="<%= js_new_resource_path %>"
+        class="rounded-lg py-3 px-5 bg-blue-600 text-white block font-medium"
+      >
+        New <%= human_name.downcase %>
+      </Link>
+    </div>
+    <div class="min-w-full">
+      <template v-for="<%= singular_table_name %> in <%= plural_table_name %>" :key="<%= singular_table_name %>.id">
+        <<%= inertia_component_name %> :<%= singular_table_name %>="<%= singular_table_name %>" />
+        <p>
+          <Link
+            :href="`<%= js_resource_path %>`"
+            class="ml-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium"
+          >
+            Show this <%= human_name.downcase %>
+          </Link>
+        </p>
+      </template>
+    </div>
+  </div>
+</template>
+<script setup>
+import { Head, Link } from '@inertiajs/vue3'
+import <%= inertia_component_name %> from './<%= inertia_component_name %>.vue'
+const { <%= plural_table_name %>, flash } = defineProps(['<%= plural_table_name %>', 'flash'])
+</script>

data/lib/generators/inertia_tw_templates/scaffold/templates/vue/New.ts.vue.tt ADDED Viewed

@@ -0,0 +1,33 @@
+<template>
+  <Head title="New <%= human_name.downcase %>" />
+  <div className="mx-auto md:w-2/3 w-full px-8 pt-8">
+    <h1 class="font-bold text-4xl">New <%= human_name.downcase %></h1>
+    <Form
+      :<%= singular_table_name %>="<%= singular_table_name %>"
+      submitText="Create <%= human_name %>"
+      @onSubmit="handleSubmit"
+    />
+    <Link
+      href="<%= js_resources_path %>"
+      class="ml-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium"
+    >
+      Back to <%= human_name.pluralize.downcase %>
+    </Link>
+  </div>
+</template>
+<script setup lang="ts">
+import { Head, InertiaForm, Link } from '@inertiajs/vue3'
+import Form from './Form.vue'
+import { <%= inertia_model_form_type %>, <%= inertia_model_type %> } from './types'
+const { <%= singular_table_name %> } = defineProps<{ <%= singular_table_name %>: <%= inertia_model_type %> }>()
+const handleSubmit = (form: InertiaForm<<%= inertia_model_form_type %>>) => {
+  form.transform((data) => ({ <%= singular_table_name %>: data }))
+  form.post('<%= js_resources_path %>')
+}
+</script>

data/lib/generators/inertia_tw_templates/scaffold/templates/vue/New.vue.tt ADDED Viewed

@@ -0,0 +1,32 @@
+<template>
+  <Head title="New <%= human_name.downcase %>" />
+  <div className="mx-auto md:w-2/3 w-full px-8 pt-8">
+    <h1 class="font-bold text-4xl">New <%= human_name.downcase %></h1>
+    <Form
+      :<%= singular_table_name %>="<%= singular_table_name %>"
+      submitText="Create <%= human_name %>"
+      @onSubmit="handleSubmit"
+    />
+    <Link
+      href="<%= js_resources_path %>"
+      class="ml-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium"
+    >
+      Back to <%= human_name.pluralize.downcase %>
+    </Link>
+  </div>
+</template>
+<script setup>
+import { Head, Link } from '@inertiajs/vue3'
+import Form from './Form.vue'
+const { <%= singular_table_name %> } = defineProps(['<%= singular_table_name %>'])
+const handleSubmit = (form) => {
+  form.transform((data) => ({ <%= singular_table_name %>: data }))
+  form.post('<%= js_resources_path %>')
+}
+</script>

data/lib/generators/inertia_tw_templates/scaffold/templates/vue/One.ts.vue.tt ADDED Viewed

@@ -0,0 +1,28 @@
+<template>
+  <div>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+    <p class="my-5">
+      <strong class="block font-medium mb-1"><%= attribute.human_name %>:</strong>
+<% if attribute.attachment? -%>
+      <a v-if="<%= singular_table_name %>.<%= attribute.column_name %>" :href="<%= singular_table_name %>.<%= attribute.column_name %>.url">
+        {{ <%= singular_table_name %>.<%= attribute.column_name %>.filename }}
+      </a>
+    </p>
+<% elsif attribute.attachments? -%>
+    </p>
+    <div v-for="file in <%= singular_table_name %>.<%= attribute.column_name %>">
+      <a :href="file.url">{{ file.filename }}</a>
+    </div>
+<% else -%>
+      {{ <%= singular_table_name %>.<%= attribute.column_name %> }}
+    </p>
+<% end -%>
+<% end -%>
+  </div>
+</template>
+<script setup lang="ts">
+import { <%= inertia_model_type %> } from './types'
+const { <%= singular_table_name %> } = defineProps<{ <%= singular_table_name %>: <%= inertia_model_type %> }>()
+</script>

data/lib/generators/inertia_tw_templates/scaffold/templates/vue/One.vue.tt ADDED Viewed

@@ -0,0 +1,26 @@
+<template>
+  <div>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+    <p class="my-5">
+      <strong class="block font-medium mb-1"><%= attribute.human_name %>:</strong>
+<% if attribute.attachment? -%>
+      <a v-if="<%= singular_table_name %>.<%= attribute.column_name %>" :href="<%= singular_table_name %>.<%= attribute.column_name %>.url">
+        {{ <%= singular_table_name %>.<%= attribute.column_name %>.filename }}
+      </a>
+    </p>
+<% elsif attribute.attachments? -%>
+    </p>
+    <div v-for="file in <%= singular_table_name %>.<%= attribute.column_name %>">
+      <a :href="file.url">{{ file.filename }}</a>
+    </div>
+<% else -%>
+      {{ <%= singular_table_name %>.<%= attribute.column_name %> }}
+    </p>
+<% end -%>
+<% end -%>
+  </div>
+</template>
+<script setup>
+const { <%= singular_table_name %> } = defineProps(['<%= singular_table_name %>'])
+</script>

data/lib/generators/inertia_tw_templates/scaffold/templates/vue/Show.ts.vue.tt ADDED Viewed

@@ -0,0 +1,53 @@
+<template>
+  <Head :title="`<%= human_name %> #${<%= singular_table_name %>.id}`" />
+  <div className="mx-auto md:w-2/3 w-full px-8 pt-8">
+    <div class="mx-auto">
+      <p
+        v-if="flash.notice"
+        class="py-2 px-3 bg-green-50 mb-5 text-green-500 font-medium rounded-lg inline-block"
+      >
+        {{ flash.notice }}
+      </p>
+      <h1 class="font-bold text-4xl"><%= human_name %> #{{ <%= singular_table_name %>.id }}</h1>
+      <<%= inertia_component_name %> :<%= singular_table_name %>="<%= singular_table_name %>" />
+      <Link
+        :href="`<%= js_edit_resource_path %>`"
+        class="ml-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium"
+      >
+        Edit this <%= human_name.downcase %>
+      </Link>
+      <Link
+        href="<%= js_resources_path %>"
+        class="ml-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium"
+      >
+        Back to <%= human_name.pluralize.downcase %>
+      </Link>
+      <div class="inline-block ml-2">
+        <Link
+          :href="`<%= js_resource_path %>`"
+          as="button"
+          method="delete"
+          class="mt-2 rounded-lg py-3 px-5 bg-gray-100 font-medium"
+        >
+          Destroy this <%= human_name.downcase %>
+        </Link>
+      </div>
+    </div>
+  </div>
+</template>
+<script setup lang="ts">
+import { Head, Link } from '@inertiajs/vue3'
+import <%= inertia_component_name %> from './<%= inertia_component_name %>.vue'
+import { <%= inertia_model_type %> } from './types'
+const { <%= singular_table_name %>, flash } = defineProps<{
+  <%= singular_table_name %>: <%= inertia_model_type %>
+  flash: { notice?: string }
+}>()
+</script>

data/lib/generators/inertia_tw_templates/scaffold/templates/vue/Show.vue.tt ADDED Viewed

@@ -0,0 +1,49 @@
+<template>
+  <Head :title="`<%= human_name %> #${<%= singular_table_name %>.id}`" />
+  <div className="mx-auto md:w-2/3 w-full px-8 pt-8">
+    <div class="mx-auto">
+      <p
+        v-if="flash.notice"
+        class="py-2 px-3 bg-green-50 mb-5 text-green-500 font-medium rounded-lg inline-block"
+      >
+        {{ flash.notice }}
+      </p>
+      <h1 class="font-bold text-4xl"><%= human_name %> #{{ <%= singular_table_name %>.id }}</h1>
+      <<%= inertia_component_name %> :<%= singular_table_name %>="<%= singular_table_name %>" />
+      <Link
+        :href="`<%= js_edit_resource_path %>`"
+        class="ml-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium"
+      >
+        Edit this <%= human_name.downcase %>
+      </Link>
+      <Link
+        href="<%= js_resources_path %>"
+        class="ml-2 rounded-lg py-3 px-5 bg-gray-100 inline-block font-medium"
+      >
+        Back to <%= human_name.pluralize.downcase %>
+      </Link>
+      <div class="inline-block ml-2">
+        <Link
+          :href="`<%= js_resource_path %>`"
+          as="button"
+          method="delete"
+          class="mt-2 rounded-lg py-3 px-5 bg-gray-100 font-medium"
+        >
+          Destroy this <%= human_name.downcase %>
+        </Link>
+      </div>
+    </div>
+  </div>
+</template>
+<script setup>
+import { Head, Link } from '@inertiajs/vue3'
+import <%= inertia_component_name %> from './<%= inertia_component_name %>.vue'
+const { <%= singular_table_name %>, flash } = defineProps(['<%= singular_table_name %>', 'flash'])
+</script>

data/lib/generators/inertia_tw_templates/scaffold/templates/vue/types.ts.tt ADDED Viewed

@@ -0,0 +1,19 @@
+export interface <%= inertia_model_type %> {
+  id: number
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+  <%= attribute.column_name %>: <%= ts_type(attribute) %>
+<% end -%>
+}
+export type <%= inertia_model_form_type %> = Omit<<%= inertia_model_type %>, <%= omit_input_attributes.map { |a| "'#{a}'" }.join(' | ') %>><% if custom_form_attributes.any? -%> & {
+<% custom_form_attributes.map do |attribute| -%>
+<% if attribute.password_digest? -%>
+  password: string
+  password_confirmation: string
+<% elsif attribute.attachment? -%>
+  <%= attribute.column_name %>?: File
+<% elsif attribute.attachments? -%>
+  <%= attribute.column_name %>?: File[]
+<% end -%>
+<% end -%>
+}<% end %>

data/lib/inertia_rails/always_prop.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module InertiaRails
+  class AlwaysProp < BaseProp
+  end
+end

data/lib/inertia_rails/base_prop.rb ADDED Viewed

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module InertiaRails
+  # Base class for all props.
+  class BaseProp
+    def initialize(&block)
+      @block = block
+    end
+    def call(controller)
+      controller.instance_exec(&@block)
+    end
+  end
+end

data/lib/inertia_rails/configuration.rb CHANGED Viewed

@@ -16,6 +16,9 @@ module InertiaRails
       # controller configuration.
       layout: true,
+      # Whether to encrypt the history state in the client.
+      encrypt_history: false,
       # SSR options.
       ssr_enabled: false,
       ssr_url: 'http://localhost:13714',
@@ -63,7 +66,7 @@ module InertiaRails
     end
     def component_path_resolver(path:, action:)
-      @options[:component_path_resolver].call(path:, action:)
+      @options[:component_path_resolver].call(path: path, action: action)
     end
     OPTION_NAMES.each do |option|

data/lib/inertia_rails/controller.rb CHANGED Viewed

@@ -123,7 +123,7 @@ module InertiaRails
     end
     def redirect_to(options = {}, response_options = {})
-      capture_inertia_errors(response_options)
+      capture_inertia_session_options(response_options)
       super
     end
@@ -155,10 +155,22 @@ module InertiaRails
       head :conflict
     end
-    def capture_inertia_errors(options)
-      if (inertia_errors = options.dig(:inertia, :errors))
-        session[:inertia_errors] = inertia_errors.to_hash
+    def capture_inertia_session_options(options)
+      return unless (inertia = options[:inertia])
+      if (inertia_errors = inertia[:errors])
+        if inertia_errors.respond_to?(:to_hash)
+          session[:inertia_errors] = inertia_errors.to_hash
+        else
+          InertiaRails.deprecator.warn(
+            "Object passed to `inertia: { errors: ... }` must respond to `to_hash`. Pass a hash-like object instead."
+          )
+          session[:inertia_errors] = inertia_errors
+        end
       end
+      session[:inertia_clear_history] = inertia[:clear_history] if inertia[:clear_history]
     end
   end
 end

data/lib/inertia_rails/defer_prop.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module InertiaRails
+  class DeferProp < IgnoreOnFirstLoadProp
+    DEFAULT_GROUP = 'default'
+    attr_reader :group
+    def initialize(group: nil, merge: nil, &block)
+      super(&block)
+      @group = group || DEFAULT_GROUP
+      @merge = merge
+      @block = block
+    end
+    def merge?
+      @merge
+    end
+  end
+end

data/lib/inertia_rails/generators/controller_template_base.rb ADDED Viewed

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require 'rails/generators/named_base'
+require 'inertia_rails/generators/helper'
+module InertiaRails
+  module Generators
+    class ControllerTemplateBase < Rails::Generators::NamedBase
+      include Helper
+      class_option :frontend_framework, required: true, desc: 'Frontend framework to generate the views for.',
+                                        default: Helper.guess_the_default_framework
+      class_option :typescript, type: :boolean, desc: 'Whether to use TypeScript',
+                                default: Helper.guess_typescript
+      argument :actions, type: :array, default: [], banner: 'action action'
+      def empty_views_dir
+        empty_directory base_path
+      end
+      def copy_view_files
+        actions.each do |action|
+          @action = action
+          @path = File.join(base_path, "#{action.camelize}.#{extension}")
+          template "#{options.frontend_framework}/#{template_filename}.#{extension}", @path
+        end
+      end
+      private
+      def base_path
+        File.join(pages_path, inertia_base_path)
+      end
+      def template_filename
+        'view'
+      end
+      def pages_path
+        "#{root_path}/pages"
+      end
+      def root_path
+        (defined?(ViteRuby) ? ViteRuby.config.source_code_dir : 'app/frontend')
+      end
+      def extension
+        case options.frontend_framework
+        when 'react' then typescript? ? 'tsx' : 'jsx'
+        when 'vue' then 'vue'
+        when 'svelte', 'svelte4' then 'svelte'
+        else
+          raise ArgumentError, "Unknown frontend framework: #{options.frontend_framework}"
+        end
+      end
+      def typescript?
+        options.typescript
+      end
+    end
+  end
+end

data/lib/inertia_rails/generators/helper.rb ADDED Viewed

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+module InertiaRails
+  module Generators
+    module Helper
+      class << self
+        def guess_the_default_framework
+          package = Rails.root.join('package.json').read
+          case package
+          when %r{@inertiajs/react}
+            'react'
+          when %r{@inertiajs/svelte}
+            package.match?(/"svelte": "\^5/) ? 'svelte' : 'svelte4'
+          when %r{@inertiajs/vue3}
+            'vue'
+          else
+            Thor::Shell::Basic.new.say_error 'Could not determine the Inertia.js framework you are using.'
+            exit 1
+          end
+        end
+        def guess_typescript
+          Rails.root.join('tsconfig.json').exist?
+        end
+        def guess_inertia_template
+          if Rails.root.join('tailwind.config.js').exist? || Rails.root.join('tailwind.config.ts').exist?
+            'inertia_tw_templates'
+          else
+            'inertia_templates'
+          end
+        end
+      end
+      def inertia_base_path
+        (class_path + [file_name]).map(&:camelize).join('/')
+      end
+      def inertia_component_name
+        singular_name.camelize
+      end
+      def inertia_model_type
+        "#{inertia_component_name}Type"
+      end
+      def inertia_model_form_type
+        "#{inertia_component_name}FormType"
+      end
+      def attributes_to_serialize
+        [:id] + attributes.reject do |attribute|
+          attribute.password_digest? ||
+            attribute.attachment? ||
+            attribute.attachments?
+        end.map(&:column_name)
+      end
+      def custom_form_attributes
+        attributes.select do |attribute|
+          attribute.password_digest? ||
+            attribute.attachment? ||
+            attribute.attachments?
+        end
+      end
+      def omit_input_attributes
+        ['id'] + attributes.select { |attribute| attribute.attachment? || attribute.attachments? }.map(&:column_name)
+      end
+      def js_resource_path
+        "#{route_url}/${#{singular_table_name}.id}"
+      end
+      def js_edit_resource_path
+        "#{route_url}/${#{singular_table_name}.id}/edit"
+      end
+      def js_new_resource_path
+        "#{route_url}/new"
+      end
+      def js_resources_path
+        route_url
+      end
+      def inertia_js_version
+        @inertia_js_version ||= Gem::Version.new(
+          JSON.parse(`npm ls @inertiajs/core --json`).then do |json|
+            json['dependencies'].values.first['version']
+          end
+        )
+      end
+      def ts_type(attribute)
+        case attribute.type
+        when :float, :decimal, :integer
+          'number'
+        when :boolean
+          'boolean'
+        when :attachment
+          '{ filename: string; url: string }'
+        when :attachments
+          '{ filename: string; url: string }[]'
+        else
+          'string'
+        end
+      end
+      def input_type(attribute)
+        case attribute.type
+        when :text, :rich_text
+          'text_area'
+        when :integer, :float, :decimal
+          'number'
+        when :datetime, :timestamp, :time
+          'datetime-local'
+        when :date
+          'date'
+        when :boolean
+          'checkbox'
+        when :attachments, :attachment
+          'file'
+        else
+          'text'
+        end
+      end
+      def default_value(attribute)
+        case attribute.type
+        when :boolean
+          'false'
+        else
+          "''"
+        end
+      end
+    end
+  end
+end

data/lib/inertia_rails/generators/scaffold_template_base.rb ADDED Viewed

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'rails/generators/resource_helpers'
+require_relative 'controller_template_base'
+module InertiaRails
+  module Generators
+    class ScaffoldTemplateBase < ControllerTemplateBase
+      include Rails::Generators::ResourceHelpers
+      remove_argument :actions
+      argument :attributes, type: :array, default: [], banner: 'field:type field:type'
+      def copy_view_files
+        available_views.each do |view|
+          template "#{options.frontend_framework}/#{view}.#{template_extension}",
+                   File.join(base_path, "#{view}.#{extension}")
+        end
+        template "#{options.frontend_framework}/#{partial_name}.#{template_extension}",
+                 File.join(base_path, "#{inertia_component_name}.#{extension}")
+        template "#{options.frontend_framework}/types.ts", File.join(base_path, 'types.ts') if typescript?
+      end
+      private
+      def template_extension
+        return extension unless typescript?
+        return 'tsx' if options.frontend_framework == 'react'
+        "ts.#{extension}"
+      end
+      def available_views
+        %w[Index Edit Show New Form]
+      end
+      def partial_name
+        'One'
+      end
+    end
+  end
+end

data/lib/inertia_rails/ignore_on_first_load_prop.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module InertiaRails
+  class IgnoreOnFirstLoadProp < BaseProp
+  end
+end