uchi 0.1.3 → 0.1.5

data/app/components/uchi/field/belongs_to.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Field
+    class BelongsTo < Field
+      DEFAULT_COLLECTION_QUERY = ->(query) { query }.freeze
+
+      class Edit < Uchi::Field::Base::Edit
+        def associated_repository
+          model = reflection.klass
+          repository_class = Uchi::Repository.for_model(model)
+          repository_class.new
+        end
+
+        def attribute_name
+          reflection.foreign_key
+        end
+
+        def collection
+          query = associated_repository.find_all
+          field.collection_query.call(query)
+        end
+
+        private
+
+        def collection_for_select
+          repository = associated_repository
+          items = []
+          items << ["", nil] if optional?
+          items + collection.map do |item|
+            [repository.title(item), item.id]
+          end
+        end
+
+        # Returns true if the association is optional.
+        def optional?
+          reflection.options[:optional] == true
+        end
+
+        def options
+          options = {
+            attribute: attribute_name,
+            collection: collection_for_select,
+            form: form,
+            label: {content: label}
+          }
+          options[:hint] = {content: hint} if hint.present?
+          options
+        end
+
+        def reflection
+          @reflection ||= record.class.reflect_on_association(field.name)
+        end
+      end
+
+      class Index < Uchi::Field::Base::Index
+      end
+
+      class Show < Uchi::Field::Base::Show
+        def associated_record
+          field.value(record)
+        end
+
+        def associated_repository
+          reflection = record.class.reflect_on_association(field.name)
+          model = reflection.klass
+          repository_class = Uchi::Repository.for_model(model)
+          repository_class.new
+        end
+      end
+
+      def initialize(name)
+        super
+        @collection_query = DEFAULT_COLLECTION_QUERY
+      end
+
+      # Sets or gets a custom query for filtering the collection of associated records.
+      #
+      # When called with an argument, sets the query and returns self for chaining.
+      # When called without arguments, returns the current query.
+      #
+      # @param query_proc [Proc, Symbol] A callable that receives an ActiveRecord query
+      #   and returns a modified query.
+      # @return [self, Proc] Returns self for method chaining when setting,
+      #   or the query proc when getting
+      #
+      # @example Setting
+      #   Field::BelongsTo.new(:company).collection_query(->(query) {
+      #     query.where(active: true)
+      #   })
+      #
+      # @example Getting
+      #   field.collection_query # => #<Proc...>
+      def collection_query(query_proc = Configuration::Unset)
+        return @collection_query if query_proc == Configuration::Unset
+
+        @collection_query = query_proc
+        self
+      end
+
+      def group_as(_action)
+        :attributes
+      end
+
+      def param_key
+        # TODO: This is too naive. We need to match this to the actual foreign
+        # key of the model.
+        :"#{name}_id"
+      end
+    end
+  end
+end

data/app/components/uchi/field/blank/edit.html.erb

@@ -0,0 +1 @@
+?

data/app/components/uchi/field/blank/index.html.erb

@@ -0,0 +1 @@
+...

data/app/components/uchi/field/blank/show.html.erb

@@ -0,0 +1 @@
+.

data/app/components/uchi/field/blank.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Field
+    class Blank < Field
+      class Edit < Uchi::Field::Base::Edit
+      end
+
+      class Index < Uchi::Field::Base::Index
+      end
+
+      class Show < Uchi::Field::Base::Show
+      end
+    end
+  end
+end

data/app/components/uchi/field/boolean/edit.html.erb

@@ -0,0 +1 @@
+<%= render(Flowbite::InputField::Checkbox.new(**options)) %>

data/app/components/uchi/field/boolean/index.html.erb

@@ -0,0 +1,9 @@
+<% if field.value(record) %>
+  <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+    <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8.5 11.5 11 14l4-4m6 2a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"/>
+  </svg>
+<% else %>
+  <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+    <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M7.757 12h8.486M21 12a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"/>
+  </svg>
+<% end %>

data/app/components/uchi/field/boolean/show.html.erb

@@ -0,0 +1,9 @@
+<% if field.value(record) %>
+  <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+    <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M8.5 11.5 11 14l4-4m6 2a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"/>
+  </svg>
+<% else %>
+  <svg class="w-5 h-5" aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="none" viewBox="0 0 24 24">
+    <path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M7.757 12h8.486M21 12a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"/>
+  </svg>
+<% end %>

data/app/components/uchi/field/boolean.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Field
+    class Boolean < Field
+      class Edit < Uchi::Field::Base::Edit
+        private
+
+        def options
+          options = {
+            attribute: field.name,
+            form: form,
+            label: {content: label}
+          }
+          options[:hint] = {content: hint} if hint.present?
+          options
+        end
+      end
+
+      class Index < Uchi::Field::Base::Index
+      end
+
+      class Show < Uchi::Field::Base::Show
+      end
+    end
+  end
+end

data/app/components/uchi/field/date/edit.html.erb

@@ -0,0 +1 @@
+<%= render(Flowbite::InputField::Date.new(**options)) %>

data/app/components/uchi/field/date/index.html.erb

@@ -0,0 +1 @@
+<%= field.value(record) %>

data/app/components/uchi/field/date/show.html.erb

@@ -0,0 +1 @@
+<%= field.value(record) %>

data/app/components/uchi/field/date.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Field
+    class Date < Field
+      class Edit < Uchi::Field::Base::Edit
+        private
+
+        def options
+          options = {
+            attribute: field.name,
+            form: form,
+            label: {content: label}
+          }
+          options[:hint] = {content: hint} if hint.present?
+          options
+        end
+      end
+
+      class Index < Uchi::Field::Base::Index
+      end
+
+      class Show < Uchi::Field::Base::Show
+      end
+    end
+  end
+end

data/app/components/uchi/field/date_time/edit.html.erb

@@ -0,0 +1 @@
+<%= render(Flowbite::InputField::DateTime.new(**options)) %>

data/app/components/uchi/field/date_time/index.html.erb

@@ -0,0 +1 @@
+<%= field.value(record) %>

data/app/components/uchi/field/date_time/show.html.erb

@@ -0,0 +1 @@
+<%= field.value(record) %>

data/app/components/uchi/field/date_time.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Field
+    class DateTime < Field
+      class Edit < Uchi::Field::Base::Edit
+        private
+
+        def options
+          options = {
+            attribute: field.name,
+            form: form,
+            label: {content: label}
+          }
+          options[:hint] = {content: hint} if hint.present?
+          options
+        end
+      end
+
+      class Index < Uchi::Field::Base::Index
+      end
+
+      class Show < Uchi::Field::Base::Show
+      end
+    end
+  end
+end

data/app/components/uchi/field/file/edit.html.erb

@@ -0,0 +1 @@
+<%= render(Flowbite::InputField::File.new(**options)) %>

data/app/components/uchi/field/file/index.html.erb

@@ -0,0 +1,6 @@
+<% attachment = field.value(record) %>
+<% if attachment.attached? %>
+  <%= attachment.filename.to_s %>
+<% else %>
+  <span class="text-gray-400">—</span>
+<% end %>

data/app/components/uchi/field/file/show.html.erb

@@ -0,0 +1,8 @@
+<% attachment = field.value(record) %>
+<% if attachment.attached? %>
+  <%= render Flowbite::Link.new(href: Rails.application.routes.url_helpers.rails_blob_path(attachment, only_path: true)) do %>
+    <%= attachment.filename %>
+  <% end %>
+<% else %>
+  <span class="text-gray-400">—</span>
+<% end %>

data/app/components/uchi/field/file.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Field
+    class File < Field
+      class Edit < Uchi::Field::Base::Edit
+        private
+
+        def options
+          options = {
+            attribute: field.name,
+            form: form,
+            label: {content: label}
+          }
+          options[:hint] = {content: hint} if hint.present?
+          options
+        end
+      end
+
+      class Index < Uchi::Field::Base::Index
+      end
+
+      class Show < Uchi::Field::Base::Show
+      end
+
+      protected
+
+      def default_searchable?
+        false
+      end
+
+      def default_sortable?
+        false
+      end
+    end
+  end
+end

data/app/components/uchi/field/has_and_belongs_to_many/edit.html.erb

@@ -0,0 +1,9 @@
+<%= render(Uchi::Ui::Form::Input::CollectionCheckboxes.new(
+  attribute: field.param_key,
+  collection: collection,
+  form: form,
+  hint: hint,
+  label: label,
+  text_method: :first,
+  value_method: :last,
+)) %>

data/app/components/uchi/field/has_and_belongs_to_many/index.html.erb

@@ -0,0 +1 @@
+<%= field.value(record).count %>

data/app/components/uchi/field/has_and_belongs_to_many/show.html.erb

@@ -0,0 +1,28 @@
+<div class="my-10">
+  <h2 class="px-4 my-6 text-2xl font-bold md:px-0"><%= repository.translate.field_label(field) %></h2>
+
+  <%= render(Uchi::Ui::Index::TurboFrame.new(
+    repository: associated_repository,
+    scope: {
+      field: field.name,
+      id: record.id,
+      inverse_of: inverse_association&.name,
+      model: record.model_name,
+    },
+    src: associated_repository.routes.path_for(
+      :index,
+      scope: {
+        field: field.name,
+        id: record.id,
+        inverse_of: inverse_association&.name,
+        model: record.model_name,
+      },
+    )
+  )) do %>
+    <div class="relative overflow-x-auto bg-white border border-gray-200 shadow-sm md:rounded-lg dark:bg-gray-800 dark:border-gray-700">
+      <div class="grid grid place-items-center p-8">
+        <%= render(Uchi::Ui::Spinner.new(message: repository.translate.loading_message)) %>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/components/uchi/field/has_and_belongs_to_many.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Field
+    class HasAndBelongsToMany < Field
+      DEFAULT_COLLECTION_QUERY = ->(query) { query }.freeze
+
+      class Edit < Uchi::Field::Base::Edit
+        def collection
+          associated_repository = field.associated_repository(record: record)
+
+          field
+            .collection(record: record)
+            .map { |associated_record|
+              [
+                associated_repository.title(associated_record),
+                associated_record.id
+              ]
+            }
+        end
+      end
+
+      class Index < Uchi::Field::Base::Index
+      end
+
+      class Show < Uchi::Field::Base::Show
+        def associated_records
+          records = field.value(record)
+
+          associated_repository.find_all(scope: records)
+        end
+
+        def associated_repository
+          field.associated_repository(record: record)
+        end
+
+        private
+
+        # Returns the Fields to be displayed for each associated record.
+        #
+        # @return [Array<Uchi::Field>]
+        def fields
+          all_fields = associated_repository.fields_for_index
+          return all_fields unless inverse_association
+
+          # Remove the field that represents the inverse association to avoid
+          # a column containing nothing but the scoped record.
+          all_fields.reject { |field| field.name == inverse_association.name }
+        end
+
+        # Returns the inverse association reflection, if any, for this
+        # association.
+        #
+        # @return [ActiveRecord::Reflection, nil]
+        def inverse_association
+          reflection = record.class.reflect_on_association(field.name)
+          reflection&.inverse_of
+        end
+
+        # Returns the ActiveRecord::Reflection for this association.
+        #
+        # @return [ActiveRecord::Reflection]
+        def reflection
+          @reflection ||= record.class.reflect_on_association(field.name)
+        end
+      end
+
+      def associated_repository(record:)
+        reflection = record.class.reflect_on_association(name)
+        model = reflection.klass
+        repository_class = Uchi::Repository.for_model(model)
+        raise NameError, "No repository found for associated model #{model}" unless repository_class
+
+        repository_class.new
+      end
+
+      def collection(record:)
+        query = associated_repository(record: record).find_all
+        @collection_query.call(query)
+      end
+
+      def initialize(name)
+        super
+        @collection_query = DEFAULT_COLLECTION_QUERY
+      end
+
+      # Sets or gets a custom query for filtering the collection of associated records.
+      #
+      # When called with an argument, sets the query and returns self for chaining.
+      # When called without arguments, returns the current query.
+      #
+      # @param query_proc [Proc, Symbol] A callable that receives an ActiveRecord query
+      #   and returns a modified query.
+      # @return [self, Proc] Returns self for method chaining when setting,
+      #   or the query proc when getting
+      #
+      # @example Setting
+      #   Field::HasAndBelongsToMany.new(:tags).collection_query(->(query) {
+      #     query.where(active: true)
+      #   })
+      #
+      # @example Getting
+      #   field.collection_query # => #<Proc...>
+      def collection_query(query_proc = Configuration::Unset)
+        return @collection_query if query_proc == Configuration::Unset
+
+        @collection_query = query_proc
+        self
+      end
+
+      def group_as(_action)
+        :associations
+      end
+
+      # Returns the key to use for this field in params
+      def param_key
+        association.association_foreign_key.pluralize.to_sym
+      end
+
+      def permitted_param
+        {param_key => []}
+      end
+
+      protected
+
+      def association
+        @association ||= repository.model.reflect_on_association(name)
+      end
+    end
+  end
+end

data/app/components/uchi/field/has_many/edit.html.erb

@@ -0,0 +1 @@
+<%# This space intentionally left blank %>

data/app/components/uchi/field/has_many/index.html.erb

@@ -0,0 +1 @@
+<%= field.value(record).count %>

data/app/components/uchi/field/has_many/show.html.erb

@@ -0,0 +1,28 @@
+<div class="my-10">
+  <h2 class="px-4 my-6 text-2xl font-bold md:px-0"><%= repository.translate.field_label(field) %></h2>
+
+  <%= render(Uchi::Ui::Index::TurboFrame.new(
+    repository: associated_repository,
+    scope: {
+      field: field.name,
+      id: record.id,
+      inverse_of: inverse_association&.name,
+      model: record.model_name,
+    },
+    src: associated_repository.routes.path_for(
+      :index,
+      scope: {
+        field: field.name,
+        id: record.id,
+        inverse_of: inverse_association&.name,
+        model: record.model_name,
+      },
+    )
+  )) do %>
+    <div class="relative overflow-x-auto bg-white border border-gray-200 shadow-sm md:rounded-lg dark:bg-gray-800 dark:border-gray-700">
+      <div class="grid grid place-items-center p-8">
+        <%= render(Uchi::Ui::Spinner.new(message: repository.translate.loading_message)) %>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/components/uchi/field/has_many.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Field
+    class HasMany < Field
+      DEFAULT_COLLECTION_QUERY = ->(query) { query }.freeze
+
+      class Edit < Uchi::Field::Base::Edit
+      end
+
+      class Index < Uchi::Field::Base::Index
+      end
+
+      class Show < Uchi::Field::Base::Show
+        def associated_records
+          records = field.value(record)
+
+          associated_repository.find_all(scope: records)
+        end
+
+        def associated_repository
+          reflection = record.class.reflect_on_association(field.name)
+          model = reflection.klass
+          repository_class = Uchi::Repository.for_model(model)
+          raise NameError, "No repository found for associated model #{model}" unless repository_class
+
+          repository_class.new
+        end
+
+        private
+
+        # Returns the Fields to be displayed for each associated record.
+        #
+        # @return [Array<Uchi::Field>]
+        def fields
+          all_fields = associated_repository.fields_for_index
+          return all_fields unless inverse_association
+
+          # Remove the field that represents the inverse association to avoid
+          # a column containing nothing but the scoped record.
+          all_fields.reject { |field| field.name == inverse_association.name }
+        end
+
+        # Returns the inverse association reflection, if any, for this
+        # association.
+        #
+        # @return [ActiveRecord::Reflection, nil]
+        def inverse_association
+          reflection = record.class.reflect_on_association(field.name)
+          reflection&.inverse_of
+        end
+
+        # Returns the ActiveRecord::Reflection for this association.
+        #
+        # @return [ActiveRecord::Reflection]
+        def reflection
+          @reflection ||= record.class.reflect_on_association(field.name)
+        end
+      end
+
+      def initialize(name)
+        super
+        @collection_query = DEFAULT_COLLECTION_QUERY
+      end
+
+      # Sets or gets a custom query for filtering the collection of associated records.
+      #
+      # When called with an argument, sets the query and returns self for chaining.
+      # When called without arguments, returns the current query.
+      #
+      # @param query_proc [Proc, Symbol] A callable that receives an ActiveRecord query
+      #   and returns a modified query.
+      # @return [self, Proc] Returns self for method chaining when setting,
+      #   or the query proc when getting
+      #
+      # @example Setting
+      #   Field::HasMany.new(:users).collection_query(->(query) {
+      #     query.where(active: true)
+      #   })
+      #
+      # @example Getting
+      #   field.collection_query # => #<Proc...>
+      def collection_query(query_proc = Configuration::Unset)
+        return @collection_query if query_proc == Configuration::Unset
+
+        @collection_query = query_proc
+        self
+      end
+
+      def group_as(_action)
+        :associations
+      end
+
+      def param_key
+        # TODO: This is too naive. We need to match this to the actual foreign
+        # key of the model.
+        :"#{name}_id"
+      end
+
+      protected
+
+      def default_on
+        [:show]
+      end
+    end
+  end
+end

data/app/components/uchi/field/id/index.html.erb

@@ -0,0 +1,4 @@
+<%= render(Flowbite::Link.new(
+  href: @repository.routes.path_for(:show, id: record.id),
+  target: "_top").with_content(field.value(record))
+) %>

data/app/components/uchi/field/id/show.html.erb

@@ -0,0 +1,4 @@
+<%= render(Flowbite::Link.new(
+  href: @repository.routes.path_for(:show, id: record.id),
+  target: "_top").with_content(field.value(record))
+) %>

data/app/components/uchi/field/id.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Uchi
+  class Field
+    # The Id field is intended for unique identifiers, such as primary keys. It
+    # contains a link to the records show page, and is not considered editable.
+    # As such it is only displayed in index and show views by default.
+    class Id < Number
+      class Index < Uchi::Field::Base::Index
+      end
+
+      class Show < Uchi::Field::Base::Show
+      end
+
+      protected
+
+      def default_on
+        [:index, :show]
+      end
+
+      def default_searchable?
+        true
+      end
+    end
+  end
+end