uchi 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d88ecc3805c99b55a1fa5cc94817732f98378328a34be0dfb429bc99072af17
-  data.tar.gz: b56d6050c427211cf45202b60c7d24c5772aabad1242f6cd7a026b25db396142
+  metadata.gz: 92849fb71ff71c56d796e3e43601dd99eabc565180c902ac129feb25f8cc5fc0
+  data.tar.gz: 789df26e207ac6ed7e8857269bafc4bcd06d21c3ec22b6070c1092c222a42d08
 SHA512:
-  metadata.gz: 023fb2f1a38c05cd69a4d2f5e6655e7900afb0160dd8972250212dc9503eacdf228cff5e08be6541444108e0aec235e9ec903a43f901f9022287dc81de17acea
-  data.tar.gz: e9d190e66e174e78883a423880dfef26bd53c3f753e3d6c6fc66c979b79ae59a7a9e05d94db48d50d01c9fdcb3dd44c0f91c852c876db6e6670252df4ab34cda
+  metadata.gz: 146839a586037ec5e0b713aec63ca699b50346c9d0be98935db42a562fe1f78be1bc6d16d4afe9a4ec38431cb440efb4d63b79527b2873db87ce01225f256153
+  data.tar.gz: 002ea4b08886edfefbab4c7580db0524b1776824f2aea0d75077c90ed2331cc3297ed3616121cf6dd86bc9e54cc0556e5d4a00ccc8848a749d1af6b593bf9223

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Fixed
+
+### Removed
+
+
+## [0.1.3]
+
+### Added
+
+- Field::Text for multi-line text content like descriptions, biographies, notes, and comments.
+- Field for HasAndBelongsToMany associations.
+- Better blank slate when a RecordsTable has no records; we also no longer show page navigation when there are no records.
+- A changelog!
+- Everything else up until now ;)
+
+### Fixed
+
+- uchi:controller generator now generates proper controller names when name contains multiple words.

data/docs/fields.md

@@ -0,0 +1,82 @@
+# Fields
+
+## Only show a field on specific pages
+
+Use the `on` method to control what pages to show a field on. For example if your id field should only be visible on the index listing, you can configure it as
+
+```ruby
+Field::Number.new(:id).on(:index)
+```
+
+Possible actions are
+
+- `:index`
+- `:show`
+- `:new`
+- `:edit`
+
+The default is to show all fields on all pages.
+
+## Search
+
+If a repository contains at least one searchable `Field` a search field appears on the index page. By default all text-based fields are considered searchable.
+
+The search is fairly naive and is a bunch of `LIKE '%query%'` (`ILIKE` in PostgreSQL) clauses strung together by `OR`.
+
+### Disable search
+
+To toggle searchability for a field use the `:searchable` option:
+
+```ruby
+Field::String.new(:password).searchable(false)
+```
+
+### Enable search
+
+You can also enable search for fields that don't enable it by default:
+
+```ruby
+Field::Number.new(:id).searchable(true)
+```
+
+Uchi casts whatever datatype the field uses into a string when searching and perform a partial match on it using `LIKE` (`ILIKE` in PostgreSQL), which may or may not yield the results you expect.
+
+
+## Sorting
+
+All fields are considered sortable by default. This means that a link to toggle the order of a column appears for all columns on index pages. How to sort a specific field - or to disable it entirely - is configured using the `:sortable` option.
+
+### Disable sorting
+
+To disable sorting a specific field:
+
+```ruby
+Field::Number.new(:calculated_sum).sortable(false)
+```
+
+### Customize sorting
+
+To customize the query used to sort by a given field, pass a lambda to the `sortable` method:
+
+```ruby
+Field::Number.new(:users_count).sortable(lambda { |query, direction|
+  query.joins(:users).group(:id).order("COUNT(users.id) #{direction}")
+})
+```
+
+The lambda receives 2 arguments:
+
+1. `query`: The `ActiveRecord::Relation` that makes up the current database query
+2. `direction`: A symbol indicating what order to sort; either `:asc` or `:desc`.
+
+The lambda should return an `ActiveRecord::Relation` with the desired sort order added.
+
+### Sorting by columns in another table
+
+Thanks to ActiveRecord we can even sort by columns in other tables/models. If you have an `Employee` model that belongs to a `Company` and you want to allow your users to sort the employee list by company name, you can configure the field like this:
+
+```ruby
+Field::BelongsTo.new(:company).sortable(lambda { |query, direction|
+  query.joins(:office).order(:offices => {:name => direction})
+})
+```

data/docs/repositories.md

@@ -0,0 +1,63 @@
+# Repositories
+
+The cornerstones of Uchi are the repositories. This is where you configure what parts of your models you want to expose and how to do it.
+
+## Models
+
+There's a one-to-one mapping between a repository and a model. So if you have a `User` model that you want to include in Uchi, you must have a `User` repository as well.
+
+## Routes
+
+In order to expose your requests to your users, you need a route for each of them. These routes are added to `config/routes.rb` in your main application under the `uchi` namespace:
+
+```ruby
+namespace :uchi do
+  resources :companies
+end
+```
+
+See [Rails' routing documentation](https://guides.rubyonrails.org/routing.html) for more details.
+
+### Root URL
+
+If you want to expose a repository at the root URL (ie `/uchi/`) you can configure a [`root`](https://guides.rubyonrails.org/routing.html#using-root) for the namespace:
+
+```ruby
+namespace :uchi do
+  root "companies#index"
+end
+```
+
+## Default sort order
+
+Lists of records in a repository are by default sorted by a column called `id`. To customize the default sort order, which is used when a user hasn’t explicitly chosen to sort by a specific field, you can create a `default_sort_order` method in the repository:
+
+```ruby
+module Uchi
+  class CustomersRepository < Uchi::Repository
+    def default_sort_order
+      SortOrder.new(:name, :desc)
+    end
+  end
+end
+```
+
+`default_sort_order` should return a `Uchi::Repository::SortOrder`.
+
+## Avoiding n+1
+
+To avoid n+1 performance issues on your index pages and other lists, you can set up includes for the repository.
+
+```ruby
+module Uchi
+  module Repositories
+    class User < Repository
+      def includes
+        [:account]
+      end
+    end
+  end
+end
+```
+
+See https://api.rubyonrails.org/classes/ActiveRecord/QueryMethods.html#method-i-includes for details.

data/test/components/uchi/field/belongs_to_test.rb

@@ -22,7 +22,7 @@ module Uchi
 
       test "has custom collection_query" do
         custom_query = ->(query) { query.where(active: true) }
-        field = Uchi::Field::BelongsTo.new(:book, collection_query: custom_query)
+        field = Uchi::Field::BelongsTo.new(:book).collection_query(custom_query)
         assert_equal custom_query, field.collection_query
       end
 
@@ -61,7 +61,7 @@ module Uchi
       end
 
       test "#searchable? returns false when explicitly set" do
-        field = Uchi::Field::BelongsTo.new(:book, searchable: false)
+        field = Uchi::Field::BelongsTo.new(:book).searchable(false)
         assert_not field.searchable?
       end
 
@@ -74,7 +74,7 @@ module Uchi
       end
 
       test "#sortable? returns false when explicitly set" do
-        field = Uchi::Field::BelongsTo.new(:book, sortable: false)
+        field = Uchi::Field::BelongsTo.new(:book).sortable(false)
         assert_not field.sortable?
       end
     end

data/test/components/uchi/field/blank_test.rb

@@ -39,7 +39,7 @@ module Uchi
       end
 
       test "#searchable? returns false when explicitly set" do
-        field = Uchi::Field::Blank.new(:separator, searchable: false)
+        field = Uchi::Field::Blank.new(:separator).searchable(false)
         assert_not field.searchable?
       end
 
@@ -52,7 +52,7 @@ module Uchi
       end
 
       test "#sortable? returns false when explicitly set" do
-        field = Uchi::Field::Blank.new(:separator, sortable: false)
+        field = Uchi::Field::Blank.new(:separator).sortable(false)
         assert_not field.sortable?
       end
     end

data/test/components/uchi/field/boolean_test.rb

@@ -39,7 +39,7 @@ module Uchi
       end
 
       test "#searchable? returns false when explicitly set" do
-        field = Uchi::Field::Boolean.new(:active, searchable: false)
+        field = Uchi::Field::Boolean.new(:active).searchable(false)
         assert_not field.searchable?
       end
 
@@ -52,7 +52,7 @@ module Uchi
       end
 
       test "#sortable? returns false when explicitly set" do
-        field = Uchi::Field::Boolean.new(:active, sortable: false)
+        field = Uchi::Field::Boolean.new(:active).sortable(false)
         assert_not field.sortable?
       end
     end

data/test/components/uchi/field/date_test.rb

@@ -39,7 +39,7 @@ module Uchi
       end
 
       test "#searchable? returns false when explicitly set" do
-        field = Uchi::Field::Date.new(:born_on, searchable: false)
+        field = Uchi::Field::Date.new(:born_on).searchable(false)
         assert_not field.searchable?
       end
 
@@ -52,7 +52,7 @@ module Uchi
       end
 
       test "#sortable? returns false when explicitly set" do
-        field = Uchi::Field::Date.new(:born_on, sortable: false)
+        field = Uchi::Field::Date.new(:born_on).sortable(false)
         assert_not field.sortable?
       end
     end

data/test/components/uchi/field/date_time_test.rb

@@ -39,7 +39,7 @@ module Uchi
       end
 
       test "#searchable? returns false when explicitly set" do
-        field = Uchi::Field::DateTime.new(:created_at, searchable: false)
+        field = Uchi::Field::DateTime.new(:created_at).searchable(false)
         assert_not field.searchable?
       end
 
@@ -52,7 +52,7 @@ module Uchi
       end
 
       test "#sortable? returns false when explicitly set" do
-        field = Uchi::Field::DateTime.new(:created_at, sortable: false)
+        field = Uchi::Field::DateTime.new(:created_at).sortable(false)
         assert_not field.sortable?
       end
     end

data/test/components/uchi/field/has_and_belongs_to_many_test.rb

@@ -0,0 +1,144 @@
+require "test_helper"
+require "ostruct"
+
+module Uchi
+  class Field
+    class HasAndBelongsToManyTest < ActiveSupport::TestCase
+      def setup
+        @record = Book.new
+        @form = OpenStruct.new(object: @record)
+
+        @repository = Uchi::Repositories::Book.new
+        @field = Uchi::Field::HasAndBelongsToMany.new(:authors)
+        @field.repository = @repository
+      end
+
+      test "inherits from Uchi::Field" do
+        assert_kind_of Uchi::Field, @field
+      end
+
+      test "has default options specific to HasAndBelongsToMany field" do
+        assert_not @field.searchable?
+        assert @field.sortable?
+      end
+
+      test "has custom collection_query" do
+        custom_query = ->(query) { query.where(published: true) }
+        field = Uchi::Field::HasAndBelongsToMany.new(:categories).collection_query(custom_query)
+        assert_equal custom_query, field.collection_query
+      end
+
+      test "uses default collection_query" do
+        assert_equal Uchi::Field::HasAndBelongsToMany::DEFAULT_COLLECTION_QUERY, @field.collection_query
+      end
+
+      test "#param_key returns foreign key name" do
+        assert_equal :author_ids, @field.param_key
+      end
+
+      test "#permitted_param returns key for strong parameters" do
+        assert_equal({author_ids: []}, @field.permitted_param)
+      end
+
+      test "#group_as returns :associations" do
+        assert_equal :associations, @field.group_as(:show)
+        assert_equal :associations, @field.group_as(:edit)
+      end
+
+      test "#edit_component returns an instance of Edit component" do
+        component = @field.edit_component(form: @form, hint: "Custom hint", label: "Custom label", repository: @repository)
+        assert_equal "Custom hint", component.hint
+        assert_equal "Custom label", component.label
+        assert_equal @field, component.field
+        assert_equal @form, component.form
+        assert_equal @repository, component.repository
+        assert_kind_of Uchi::Field::HasAndBelongsToMany::Edit, component
+      end
+
+      test "#index_component returns an instance of Index component" do
+        component = @field.index_component(record: @form.object, repository: @repository)
+        assert_equal @field, component.field
+        assert_equal @form.object, component.record
+        assert_equal @repository, component.repository
+        assert_kind_of Uchi::Field::HasAndBelongsToMany::Index, component
+      end
+
+      test "#show_component returns an instance of Show component" do
+        component = @field.show_component(record: @form.object, repository: @repository)
+        assert_equal @field, component.field
+        assert_equal @form.object, component.record
+        assert_equal @repository, component.repository
+        assert_kind_of Uchi::Field::HasAndBelongsToMany::Show, component
+      end
+
+      test "#searchable? returns false when explicitly set" do
+        field = Uchi::Field::HasAndBelongsToMany.new(:categories).searchable(false)
+        assert_not field.searchable?
+      end
+
+      test "#sortable? returns false when explicitly set" do
+        field = Uchi::Field::HasAndBelongsToMany.new(:categories).sortable(false)
+        assert_not field.sortable?
+      end
+    end
+
+    class HasAndBelongsToManyEditTest < ViewComponent::TestCase
+      def setup
+        @field = Uchi::Field::HasAndBelongsToMany.new(:categories)
+        @book = Book.new(original_title: "The Hobbit")
+        @repository = Uchi::Repositories::Book.new
+        @view_context = ActionController::Base.new.view_context
+
+        @form = ActionView::Helpers::FormBuilder.new(:book, @book, @view_context, {})
+
+        @component = Uchi::Field::HasAndBelongsToMany::Edit.new(
+          field: @field,
+          form: @form,
+          hint: "Custom hint",
+          label: "Custom label",
+          repository: @repository
+        )
+      end
+
+      test "inherits from Base component" do
+        assert_kind_of Uchi::Field::Base::Edit, @component
+      end
+    end
+
+    class HasAndBelongsToManyIndexTest < ViewComponent::TestCase
+      def setup
+        @field = Uchi::Field::HasAndBelongsToMany.new(:categories)
+        @book = Book.new(original_title: "The Hobbit")
+        @repository = Uchi::Repositories::Book.new
+
+        @component = Uchi::Field::HasAndBelongsToMany::Index.new(
+          field: @field,
+          record: @book,
+          repository: @repository
+        )
+      end
+
+      test "inherits from Base component" do
+        assert_kind_of Uchi::Field::Base::Index, @component
+      end
+    end
+
+    class HasAndBelongsToManyShowTest < ViewComponent::TestCase
+      def setup
+        @field = Uchi::Field::HasAndBelongsToMany.new(:categories)
+        @book = Book.new(original_title: "The Hobbit")
+        @repository = Uchi::Repositories::Book.new
+
+        @component = Uchi::Field::HasAndBelongsToMany::Show.new(
+          field: @field,
+          record: @book,
+          repository: @repository
+        )
+      end
+
+      test "inherits from Base component" do
+        assert_kind_of Uchi::Field::Base::Show, @component
+      end
+    end
+  end
+end

data/test/components/uchi/field/has_many_test.rb

@@ -22,7 +22,7 @@ module Uchi
 
       test "has custom collection_query" do
         custom_query = ->(query) { query.where(published: true) }
-        field = Uchi::Field::HasMany.new(:titles, collection_query: custom_query)
+        field = Uchi::Field::HasMany.new(:titles).collection_query(custom_query)
         assert_equal custom_query, field.collection_query
       end
 
@@ -66,12 +66,12 @@ module Uchi
       end
 
       test "#searchable? returns false when explicitly set" do
-        field = Uchi::Field::HasMany.new(:titles, searchable: false)
+        field = Uchi::Field::HasMany.new(:titles).searchable(false)
         assert_not field.searchable?
       end
 
       test "#sortable? returns false when explicitly set" do
-        field = Uchi::Field::HasMany.new(:titles, sortable: false)
+        field = Uchi::Field::HasMany.new(:titles).sortable(false)
         assert_not field.sortable?
       end
     end

data/test/components/uchi/field/id_test.rb

@@ -42,7 +42,7 @@ module Uchi
       end
 
       test "#searchable? returns false when explicitly set" do
-        field = Uchi::Field::Id.new(:id, searchable: false)
+        field = Uchi::Field::Id.new(:id).searchable(false)
         assert_not field.searchable?
       end
 
@@ -55,7 +55,7 @@ module Uchi
       end
 
       test "#sortable? returns false when explicitly set" do
-        field = Uchi::Field::Id.new(:id, sortable: false)
+        field = Uchi::Field::Id.new(:id).sortable(false)
         assert_not field.sortable?
       end
     end

data/test/components/uchi/field/number_test.rb

@@ -39,7 +39,7 @@ module Uchi
       end
 
       test "#searchable? returns false when explicitly set" do
-        field = Uchi::Field::Number.new(:age, searchable: false)
+        field = Uchi::Field::Number.new(:age).searchable(false)
         assert_not field.searchable?
       end
 
@@ -52,7 +52,7 @@ module Uchi
       end
 
       test "#sortable? returns false when explicitly set" do
-        field = Uchi::Field::Number.new(:age, sortable: false)
+        field = Uchi::Field::Number.new(:age).sortable(false)
         assert_not field.sortable?
       end
     end

data/test/components/uchi/field/string_test.rb

@@ -39,7 +39,7 @@ module Uchi
       end
 
       test "#searchable? returns false when explicitly set" do
-        field = Uchi::Field::String.new(:name, searchable: false)
+        field = Uchi::Field::String.new(:name).searchable(false)
         assert_not field.searchable?
       end
 
@@ -52,7 +52,7 @@ module Uchi
       end
 
       test "#sortable? returns false when explicitly set" do
-        field = Uchi::Field::String.new(:name, sortable: false)
+        field = Uchi::Field::String.new(:name).sortable(false)
         assert_not field.sortable?
       end
     end
@@ -60,7 +60,7 @@ module Uchi
     class StringEditTest < ViewComponent::TestCase
       def setup
         @field = Uchi::Field::String.new(:name)
-        @record = Author.new(name: "J.R.R Tolkien")
+        @record = Author.new(name: "J.R.R. Tolkien")
         @repository = Uchi::Repositories::Author.new
         @view_context = ActionController::Base.new.view_context
 
@@ -111,7 +111,7 @@ module Uchi
     class StringIndexTest < ViewComponent::TestCase
       def setup
         @field = Uchi::Field::String.new(:name)
-        @record = Author.new(name: "J.R.R Tolkien")
+        @record = Author.new(name: "J.R.R. Tolkien")
         @repository = Uchi::Repositories::Author.new
 
         @component = Uchi::Field::String::Index.new(
@@ -128,14 +128,14 @@ module Uchi
       test "renders the field content" do
         result = render_inline(@component)
 
-        assert_includes result.to_html, "J.R.R Tolkien"
+        assert_includes result.to_html, "J.R.R. Tolkien"
       end
     end
 
     class StringShowTest < ViewComponent::TestCase
       def setup
         @field = Uchi::Field::String.new(:name)
-        @record = Author.new(name: "J.R.R Tolkien")
+        @record = Author.new(name: "J.R.R. Tolkien")
         @repository = Uchi::Repositories::Author.new
 
         @component = Uchi::Field::String::Show.new(
@@ -152,7 +152,7 @@ module Uchi
       test "renders the field content" do
         result = render_inline(@component)
 
-        assert_includes result.to_html, "J.R.R Tolkien"
+        assert_includes result.to_html, "J.R.R. Tolkien"
       end
     end
   end

data/test/components/uchi/field/text_test.rb

@@ -0,0 +1,160 @@
+require "test_helper"
+require "ostruct"
+
+module Uchi
+  class Field
+    class TextTest < ActiveSupport::TestCase
+      def setup
+        @field = Uchi::Field::Text.new(:biography)
+        @form = OpenStruct.new(object: OpenStruct.new(biography: "Test Biography"))
+        @repository = Uchi::Repositories::Author.new
+      end
+
+      test "inherits from Uchi::Field" do
+        assert_kind_of Uchi::Field, @field
+      end
+
+      test "has default options" do
+        assert_equal [:edit, :show], @field.on
+        assert @field.searchable?
+        assert @field.sortable?
+      end
+
+      test "#edit_component returns an instance of Edit component" do
+        component = @field.edit_component(form: @form, hint: "Custom hint", label: "Custom label", repository: @repository)
+        assert_equal "Custom hint", component.hint
+        assert_equal "Custom label", component.label
+        assert_equal @field, component.field
+        assert_equal @form, component.form
+        assert_equal @repository, component.repository
+        assert_kind_of Uchi::Field::Text::Edit, component
+      end
+
+      test "#index_component returns an instance of Index component" do
+        component = @field.index_component(record: @form.object, repository: @repository)
+        assert_equal @field, component.field
+        assert_equal @form.object, component.record
+        assert_equal @repository, component.repository
+        assert_kind_of Uchi::Field::Text::Index, component
+      end
+
+      test "#searchable? returns false when explicitly set" do
+        field = Uchi::Field::Text.new(:biography).searchable(false)
+        assert_not field.searchable?
+      end
+
+      test "#show_component returns an instance of Show component" do
+        component = @field.show_component(record: @form.object, repository: @repository)
+        assert_equal @field, component.field
+        assert_equal @form.object, component.record
+        assert_equal @repository, component.repository
+        assert_kind_of Uchi::Field::Text::Show, component
+      end
+
+      test "#sortable? returns false when explicitly set" do
+        field = Uchi::Field::Text.new(:biography).sortable(false)
+        assert_not field.sortable?
+      end
+    end
+
+    class TextEditTest < ViewComponent::TestCase
+      def setup
+        @field = Uchi::Field::Text.new(:biography)
+        @record = Author.new(name: "J.R.R. Tolkien", biography: "Famous author")
+        @repository = Uchi::Repositories::Author.new
+        @view_context = ActionController::Base.new.view_context
+
+        @form = ActionView::Helpers::FormBuilder.new(:author, @record, @view_context, {})
+
+        @component = Uchi::Field::Text::Edit.new(
+          field: @field,
+          form: @form,
+          hint: "Custom hint",
+          label: "Custom label",
+          repository: @repository
+        )
+      end
+
+      test "inherits from Base component" do
+        assert_kind_of Uchi::Field::Base::Edit, @component
+      end
+
+      test "renders a textarea field with the field content" do
+        render_inline(@component)
+
+        assert_selector("textarea[name='author[biography]'][rows='8']", text: "Famous author")
+      end
+
+      test "renders label with specified text" do
+        render_inline(@component)
+
+        assert_selector("label[for='author_biography']", text: "Custom label")
+      end
+
+      test "renders hint when provided" do
+        render_inline(@component)
+
+        assert_selector("p[id=author_biography_hint]", text: "Custom hint")
+      end
+
+      test "initializes the input component with the correct options" do
+        expected_options = {
+          attribute: :biography,
+          form: @form,
+          label: {content: "Custom label"},
+          input: {options: {rows: 8}},
+          hint: {content: "Custom hint"}
+        }
+        assert_equal expected_options, @component.send(:options)
+      end
+    end
+
+    class TextIndexTest < ViewComponent::TestCase
+      def setup
+        @field = Uchi::Field::Text.new(:biography)
+        @record = Author.new(name: "J.R.R. Tolkien", biography: "Famous author of The Lord of the Rings")
+        @repository = Uchi::Repositories::Author.new
+
+        @component = Uchi::Field::Text::Index.new(
+          field: @field,
+          record: @record,
+          repository: @repository
+        )
+      end
+
+      test "inherits from Base component" do
+        assert_kind_of Uchi::Field::Base::Index, @component
+      end
+
+      test "renders the field content" do
+        result = render_inline(@component)
+
+        assert_includes result.to_html, "Famous author of The Lord of the Rings"
+      end
+    end
+
+    class TextShowTest < ViewComponent::TestCase
+      def setup
+        @field = Uchi::Field::Text.new(:biography)
+        @record = Author.new(name: "J.R.R. Tolkien", biography: "Famous author of The Lord of the Rings")
+        @repository = Uchi::Repositories::Author.new
+
+        @component = Uchi::Field::Text::Show.new(
+          field: @field,
+          record: @record,
+          repository: @repository
+        )
+      end
+
+      test "inherits from Base component" do
+        assert_kind_of Uchi::Field::Base::Show, @component
+      end
+
+      test "renders the field content" do
+        result = render_inline(@component)
+
+        assert_includes result.to_html, "Famous author of The Lord of the Rings"
+      end
+    end
+  end
+end

data/test/components/uchi/ui/form/input/collection_checkboxes_test.rb

@@ -0,0 +1,171 @@
+require "test_helper"
+
+module Uchi
+  module Ui
+    module Form
+      module Input
+        class CollectionCheckboxesTest < ViewComponent::TestCase
+          class Tag
+            attr_accessor :id, :name
+
+            def initialize(id, name)
+              @id = id
+              @name = name
+            end
+          end
+
+          def setup
+            @tags = [
+              Tag.new(1, "Ruby"),
+              Tag.new(2, "Rails"),
+              Tag.new(3, "JavaScript")
+            ]
+
+            @record = Author.new(name: "Test Author")
+            @record.define_singleton_method(:tag_ids) { [1, 3] }
+            @record.define_singleton_method(:tag_ids=) { |val| @tag_ids = val }
+
+            @view_context = ActionController::Base.new.view_context
+            @form = ActionView::Helpers::FormBuilder.new(:author, @record, @view_context, {})
+
+            @component = Uchi::Ui::Form::Input::CollectionCheckboxes.new(
+              attribute: :tag_ids,
+              collection: @tags,
+              form: @form,
+              label: "Select Tags",
+              hint: "Choose one or more tags",
+              value_method: :id,
+              text_method: :name
+            )
+          end
+
+          test "renders collection checkboxes" do
+            render_inline(@component)
+
+            assert_selector("input[type='hidden'][name='author[tag_ids][]']", visible: :all, count: 1)
+            assert_selector("input[type='checkbox'][name='author[tag_ids][]']", count: 3)
+          end
+
+          test "renders label when provided" do
+            render_inline(@component)
+
+            assert_selector("label", text: "Select Tags")
+          end
+
+          test "does not render label when not provided" do
+            component = Uchi::Ui::Form::Input::CollectionCheckboxes.new(
+              attribute: :tag_ids,
+              collection: @tags,
+              form: @form
+            )
+            render_inline(component)
+
+            assert_no_selector("label", text: "Select Tags")
+          end
+
+          test "renders hint when provided" do
+            render_inline(@component)
+
+            assert_selector("p", text: "Choose one or more tags")
+          end
+
+          test "does not render hint when not provided" do
+            component = Uchi::Ui::Form::Input::CollectionCheckboxes.new(
+              attribute: :tag_ids,
+              collection: @tags,
+              form: @form
+            )
+            render_inline(component)
+
+            assert_no_selector("p", text: "Choose one or more tags")
+          end
+
+          test "renders checkbox labels for each item" do
+            render_inline(@component)
+
+            assert_selector("label", text: "Ruby")
+            assert_selector("label", text: "Rails")
+            assert_selector("label", text: "JavaScript")
+          end
+
+          test "renders checkboxes with correct values" do
+            render_inline(@component)
+
+            assert_selector("input[type='checkbox'][value='1']")
+            assert_selector("input[type='checkbox'][value='2']")
+            assert_selector("input[type='checkbox'][value='3']")
+          end
+
+          test "applies disabled state to all checkboxes" do
+            component = Uchi::Ui::Form::Input::CollectionCheckboxes.new(
+              attribute: :tag_ids,
+              collection: @tags,
+              form: @form,
+              disabled: true
+            )
+            render_inline(component)
+
+            assert_selector("input[type='checkbox'][disabled]", count: 3)
+          end
+
+          test "renders errors when present" do
+            @record.errors.add(:tag_ids, "must be selected")
+            render_inline(@component)
+
+            assert_selector("p", text: /MUST BE SELECTED/i)
+          end
+
+          test "applies error styling when errors present" do
+            @record.errors.add(:tag_ids, "must be selected")
+            component = Uchi::Ui::Form::Input::CollectionCheckboxes.new(
+              attribute: :tag_ids,
+              collection: @tags,
+              form: @form
+            )
+
+            render_inline(component)
+
+            # Check that error classes are applied to checkboxes
+            assert component.errors?
+          end
+
+          test "uses custom value and text methods" do
+            custom_tags = [
+              OpenStruct.new(identifier: "ruby", title: "Ruby Programming"),
+              OpenStruct.new(identifier: "rails", title: "Rails Framework")
+            ]
+
+            component = Uchi::Ui::Form::Input::CollectionCheckboxes.new(
+              attribute: :tag_ids,
+              collection: custom_tags,
+              form: @form,
+              value_method: :identifier,
+              text_method: :title
+            )
+
+            render_inline(component)
+
+            assert_selector("input[type='checkbox'][value='ruby']")
+            assert_selector("input[type='checkbox'][value='rails']")
+            assert_selector("label", text: "Ruby Programming")
+            assert_selector("label", text: "Rails Framework")
+          end
+
+          test "handles empty collection" do
+            component = Uchi::Ui::Form::Input::CollectionCheckboxes.new(
+              attribute: :tag_ids,
+              collection: [],
+              form: @form
+            )
+
+            render_inline(component)
+
+            # Should only have the hidden field, no checkboxes
+            assert_selector("input[type='hidden'][name='author[tag_ids][]']", visible: :all, count: 1)
+            assert_selector("input[type='checkbox']", count: 0)
+          end
+        end
+      end
+    end
+  end
+end

data/test/controllers/uchi/authors_controller_test.rb

@@ -47,8 +47,9 @@ module Uchi
     end
 
     test "PATCH update redirects to show after successful update" do
+      srand(42)
       patch uchi_author_url(id: @author.id), params: {author: {name: "Updated Name"}}
-      assert_redirected_to uchi_author_url(id: @author.id)
+      assert_redirected_to uchi_author_url(id: @author.id, uniq: 0.3745401188473625)
     end
 
     test "PATCH update responds with 303 after successful update" do
@@ -65,13 +66,13 @@ module Uchi
     test "PATCH update flashes a translated success message after successful update" do
       ::I18n.with_locale(:da) do
         patch uchi_author_url(id: @author.id), params: {author: {name: "Updated Name"}}
-        assert_equal "Dine ændringer til forfatteren blev gemt", flash[:notice]
+        assert_equal "Dine ændringer til forfatteren blev gemt", flash[:success]
       end
     end
 
     test "PATCH update falls back to default success message after successful update" do
       patch uchi_author_url(id: @author.id), params: {author: {name: "Updated Name"}}
-      assert_equal "Your changes have been saved", flash[:notice]
+      assert_equal "Your changes have been saved", flash[:success]
     end
 
     test "PATCH update rerenders the edit view after unsuccessful update" do
@@ -97,7 +98,7 @@ module Uchi
     test "POST create flashes a translated success message after successful creation" do
       ::I18n.with_locale(:da) do
         post uchi_authors_url, params: {author: {name: "New Author"}}
-        assert_equal "Forfatteren er blevet tilføjet", flash[:notice]
+        assert_equal "Forfatteren er blevet tilføjet", flash[:success]
       end
     end
 

data/test/dummy/app/models/author.rb

@@ -1,3 +1,5 @@
 class Author < ApplicationRecord
+  has_and_belongs_to_many :books
+
   validates :name, presence: true
 end

data/test/dummy/app/models/book.rb

@@ -1,3 +1,4 @@
 class Book < ApplicationRecord
+  has_and_belongs_to_many :authors
   has_many :titles
 end

data/test/dummy/app/uchi/repositories/author.rb

@@ -3,10 +3,10 @@ module Uchi
     class Author < Repository
       def fields
         [
-          Field::Number.new(:id, on: [:index, :show]),
+          Field::Number.new(:id).on(:index, :show),
           Field::String.new(:name),
           Field::Date.new(:born_on),
-          Field::String.new(:biography, on: [:edit, :new, :show])
+          Field::Text.new(:biography).on(:edit, :new, :show)
         ]
       end
 

data/test/dummy/config/locales/da.yml

@@ -3,6 +3,7 @@ da:
   uchi:
     common:
       cancel: "Annuller"
+      no_records_found: "Ingen resultater"
       save: "Gem"
     repository:
       common:

data/test/dummy/db/migrate/20251031140958_add_author_books_join_table.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddAuthorBooksJoinTable < ActiveRecord::Migration[8.0]
+  def change
+    create_join_table :authors, :books do |t|
+      t.index [:author_id, :book_id]
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[8.0].define(version: 2025_10_05_131811) do
+ActiveRecord::Schema[8.0].define(version: 2025_10_31_140958) do
   create_table "authors", force: :cascade do |t|
     t.string "name"
     t.text "biography"
@@ -19,6 +19,12 @@ ActiveRecord::Schema[8.0].define(version: 2025_10_05_131811) do
     t.datetime "updated_at", null: false
   end
 
+  create_table "authors_books", id: false, force: :cascade do |t|
+    t.integer "author_id", null: false
+    t.integer "book_id", null: false
+    t.index ["author_id", "book_id"], name: "index_authors_books_on_author_id_and_book_id"
+  end
+
   create_table "books", force: :cascade do |t|
     t.string "original_title"
     t.datetime "created_at", null: false

data/test/uchi/field_test.rb

@@ -30,24 +30,38 @@ class UchiFieldTest < ActiveSupport::TestCase
     assert_equal :name, @field.param_key
   end
 
+  test "#permitted_param returns name as symbol" do
+    assert_equal :name, @field.permitted_param
+  end
+
   test "#searchable? returns false by default" do
     assert_not @field.searchable?
   end
 
   test "#searchable? returns true when explicitly set" do
-    field = Uchi::Field.new(:name, searchable: true)
+    field = Uchi::Field.new(:name).searchable(true)
     assert field.searchable?
   end
 
+  test "#searchable? returns default (false) when explicitly set to nil" do
+    field = Uchi::Field.new(:name).searchable(nil)
+    assert_not field.searchable?
+  end
+
   test "#sortable? returns true by default" do
     assert @field.sortable?
   end
 
   test "#sortable? returns false when explicitly set" do
-    field = Uchi::Field.new(:name, sortable: false)
+    field = Uchi::Field.new(:name).sortable(false)
     assert_not field.sortable?
   end
 
+  test "#sortable? returns default (true) when explicitly set to nil" do
+    field = Uchi::Field.new(:name).sortable(nil)
+    assert field.sortable?
+  end
+
   test "#value uses reader to get value from record" do
     record = OpenStruct.new(name: "Test Name")
     assert_equal "Test Name", @field.value(record)
@@ -55,7 +69,7 @@ class UchiFieldTest < ActiveSupport::TestCase
 
   test "#value uses custom reader when provided" do
     custom_reader = ->(record, field_name) { "Custom: #{record.public_send(field_name)}" }
-    field = Uchi::Field.new(:name, reader: custom_reader)
+    field = Uchi::Field.new(:name).reader(custom_reader)
     record = OpenStruct.new(name: "Test")
 
     assert_equal "Custom: Test", field.value(record)

data/test/uchi/repository/translate_test.rb

@@ -49,9 +49,11 @@ class UchiRepositoryTranslateTest < ActiveSupport::TestCase
   end
 
   test "#destroy_dialog_title returns translation from uchi.repository.author.dialog.destroy.title" do
-    record = Author.new(name: "J. K. Rowling")
-    result = @translate.destroy_dialog_title(record)
-    assert_equal "Er du sikker på, at du vil slette J. K. Rowling?", result
+    I18n.with_locale(:da) do
+      record = Author.new(name: "J. K. Rowling")
+      result = @translate.destroy_dialog_title(record)
+      assert_equal "Er du sikker på, at du vil slette J. K. Rowling?", result
+    end
   end
 
   test "#destroy_dialog_title falls back to default translation" do
@@ -169,6 +171,13 @@ class UchiRepositoryTranslateTest < ActiveSupport::TestCase
     assert_equal "Loading...", result
   end
 
+  test "#no_records_found returns translation from uchi.common.no_records_found" do
+    I18n.with_locale(:da) do
+      result = @translate.no_records_found
+      assert_equal "Ingen resultater", result
+    end
+  end
+
   test "#plural_name returns translation from uchi.repository.author.model with count 2" do
     I18n.with_locale(:da) do
       result = @translate.plural_name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uchi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jakob Skjerning
@@ -9,20 +9,6 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: pagy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 43.0.0.rc1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 43.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -65,8 +51,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+description: Level up your scaffolds with a modern admin backend framework, designed
+  for Rails developers who demand both beauty, functionality, and extensibility. Uchi
+  provides a set of components and conventions for creating user interfaces that are
+  both powerful and easy to use.
 email:
-- jakob@mentalized.net
+- jakob@substancelab.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -74,6 +64,9 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/build.yml"
 - ".github/workflows/lint.yml"
+- CHANGELOG.md
+- docs/fields.md
+- docs/repositories.md
 - package.json
 - sig/uchi.rbs
 - test/components/uchi/field/belongs_to_test.rb
@@ -81,10 +74,13 @@ files:
 - test/components/uchi/field/boolean_test.rb
 - test/components/uchi/field/date_test.rb
 - test/components/uchi/field/date_time_test.rb
+- test/components/uchi/field/has_and_belongs_to_many_test.rb
 - test/components/uchi/field/has_many_test.rb
 - test/components/uchi/field/id_test.rb
 - test/components/uchi/field/number_test.rb
 - test/components/uchi/field/string_test.rb
+- test/components/uchi/field/text_test.rb
+- test/components/uchi/ui/form/input/collection_checkboxes_test.rb
 - test/controllers/uchi/authors_controller_test.rb
 - test/controllers/uchi/repository_controller_test.rb
 - test/controllers/uchi/scoped_repository_controller_test.rb
@@ -136,6 +132,7 @@ files:
 - test/dummy/db/migrate/20251002183635_create_authors.rb
 - test/dummy/db/migrate/20251005131726_create_books.rb
 - test/dummy/db/migrate/20251005131811_create_titles.rb
+- test/dummy/db/migrate/20251031140958_add_author_books_join_table.rb
 - test/dummy/db/schema.rb
 - test/dummy/log/.keep
 - test/dummy/public/400.html
@@ -162,7 +159,7 @@ files:
 homepage: https://github.com/substancelab/uchi
 licenses: []
 metadata:
-  homepage_uri: https://github.com/substancelab/uchi
+  homepage_uri: https://www.uchiadmin.com/
   source_code_uri: https://github.com/substancelab/uchi
 rdoc_options: []
 require_paths:
@@ -180,5 +177,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Some automated admin stuff for Rails apps
+summary: Build usable and extensible admin panels for your Ruby on Rails application
+  in minutes.
 test_files: []