RubyGems - inertia_rails - Versions diffs - 3.3.0 → 3.5.0 - Mend

inertia_rails 3.3.0 → 3.5.0

Files changed (209) 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/action_filter.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+#
+# Based on AbstractController::Callbacks::ActionFilter
+# https://github.com/rails/rails/blob/v7.2.0/actionpack/lib/abstract_controller/callbacks.rb#L39
+module InertiaRails
+  class ActionFilter
+    def initialize(conditional_key, actions)
+      @conditional_key = conditional_key
+      @actions = Array(actions).map(&:to_s).to_set
+    end
+    def match?(controller)
+      missing_action = @actions.find { |action| !controller.available_action?(action) }
+      if missing_action
+        message = <<~MSG
+          The #{missing_action} action could not be found for the :inertia_share
+          callback on #{controller.class.name}, but it is listed in the controller's
+          #{@conditional_key.inspect} option.
+        MSG
+        raise AbstractController::ActionNotFound.new(message, controller, missing_action)
+      end
+      @actions.include?(controller.action_name)
+    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

@@ -63,7 +63,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

@@ -1,5 +1,6 @@
 require_relative "inertia_rails"
 require_relative "helper"
+require_relative "action_filter"
 module InertiaRails
   module Controller
@@ -14,10 +15,19 @@ module InertiaRails
     end
     module ClassMethods
-      def inertia_share(attrs = {}, &block)
-        @inertia_share ||= []
-        @inertia_share << attrs.freeze unless attrs.empty?
-        @inertia_share << block if block
+      def inertia_share(hash = nil, **props, &block)
+        options = extract_inertia_share_options(props)
+        return push_to_inertia_share(**(hash || props), &block) if options.empty?
+        push_to_inertia_share do
+          next unless options[:if].all? { |filter| instance_exec(&filter) } if options[:if]
+          next unless options[:unless].none? { |filter| instance_exec(&filter)  } if options[:unless]
+          next hash unless block
+          res = instance_exec(&block)
+          hash ? hash.merge(res) : res
+        end
       end
       def inertia_config(**attrs)
@@ -55,6 +65,53 @@ module InertiaRails
           end.freeze
         end
       end
+      private
+      def push_to_inertia_share(**attrs, &block)
+        @inertia_share ||= []
+        @inertia_share << attrs.freeze unless attrs.empty?
+        @inertia_share << block if block
+      end
+      def extract_inertia_share_options(props)
+        options = props.slice(:if, :unless, :only, :except)
+        return options if options.empty?
+        if props.except(:if, :unless, :only, :except).any?
+          raise ArgumentError, "You must not mix shared data and [:if, :unless, :only, :except] options, pass data as a hash or a block."
+        end
+        transform_inertia_share_option(options, :only, :if)
+        transform_inertia_share_option(options, :except, :unless)
+        options.transform_values! do |filters|
+          Array(filters).map!(&method(:filter_to_proc))
+        end
+        options
+      end
+      def transform_inertia_share_option(options, from, to)
+        if (from_value = options.delete(from))
+          filter = InertiaRails::ActionFilter.new(from, from_value)
+          options[to] = Array(options[to]).unshift(filter)
+        end
+      end
+      def filter_to_proc(filter)
+        case filter
+        when Symbol
+          -> { send(filter) }
+        when Proc
+          filter
+        when InertiaRails::ActionFilter
+          -> { filter.match?(self) }
+        else
+          raise ArgumentError, "You must pass a symbol or a proc as a filter."
+        end
+      end
     end
     def default_render
@@ -67,16 +124,7 @@ module InertiaRails
     def redirect_to(options = {}, response_options = {})
       capture_inertia_errors(response_options)
-      super(options, response_options)
-    end
-    def redirect_back(fallback_location:, allow_other_host: true, **options)
-      capture_inertia_errors(options)
-      super(
-        fallback_location: fallback_location,
-        allow_other_host: allow_other_host,
-        **options,
-      )
+      super
     end
     private
@@ -109,7 +157,14 @@ module InertiaRails
     def capture_inertia_errors(options)
       if (inertia_errors = options.dig(:inertia, :errors))
-        session[: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
     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