uchi 0.1.0 → 0.1.2

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

@@ -0,0 +1,159 @@
+require "test_helper"
+require "ostruct"
+
+module Uchi
+  class Field
+    class StringTest < ActiveSupport::TestCase
+      def setup
+        @field = Uchi::Field::String.new(:name)
+        @form = OpenStruct.new(object: OpenStruct.new(name: "Test Name"))
+        @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, :index, :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::String::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::String::Index, component
+      end
+
+      test "#searchable? returns false when explicitly set" do
+        field = Uchi::Field::String.new(:name, 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::String::Show, component
+      end
+
+      test "#sortable? returns false when explicitly set" do
+        field = Uchi::Field::String.new(:name, sortable: false)
+        assert_not field.sortable?
+      end
+    end
+
+    class StringEditTest < ViewComponent::TestCase
+      def setup
+        @field = Uchi::Field::String.new(:name)
+        @record = Author.new(name: "J.R.R Tolkien")
+        @repository = Uchi::Repositories::Author.new
+        @view_context = ActionController::Base.new.view_context
+
+        @form = ActionView::Helpers::FormBuilder.new(:author, @record, @view_context, {})
+
+        @component = Uchi::Field::String::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 an input field with the field content" do
+        render_inline(@component)
+
+        assert_selector("input[type='text'][name='author[name]'][value='J.R.R Tolkien']")
+      end
+
+      test "renders label with specified text" do
+        render_inline(@component)
+
+        assert_selector("label[for='author_name']", text: "Custom label")
+      end
+
+      test "renders hint when provided" do
+        render_inline(@component)
+
+        assert_selector("p[id=author_name_hint]", text: "Custom hint")
+      end
+
+      test "initializes the input component with the correct options" do
+        expected_options = {
+          attribute: :name,
+          form: @form,
+          label: {content: "Custom label"},
+          hint: {content: "Custom hint"}
+        }
+        assert_equal expected_options, @component.send(:options)
+      end
+    end
+
+    class StringIndexTest < ViewComponent::TestCase
+      def setup
+        @field = Uchi::Field::String.new(:name)
+        @record = Author.new(name: "J.R.R Tolkien")
+        @repository = Uchi::Repositories::Author.new
+
+        @component = Uchi::Field::String::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, "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")
+        @repository = Uchi::Repositories::Author.new
+
+        @component = Uchi::Field::String::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, "J.R.R Tolkien"
+      end
+    end
+  end
+end

data/test/controllers/uchi/authors_controller_test.rb

@@ -0,0 +1,119 @@
+require "test_helper"
+
+module Uchi
+  class AuthorsControllerTest < ActionDispatch::IntegrationTest
+    setup do
+      @author = Author.create!(name: "Test Author")
+    end
+
+    test "GET edit renders successfully" do
+      get edit_uchi_author_url(id: @author.id)
+      assert_response :success
+    end
+
+    test "GET edit renders the edit view" do
+      get edit_uchi_author_url(id: @author.id)
+      assert_template :edit
+    end
+
+    test "GET index responds successfully" do
+      get uchi_authors_url
+      assert_response :success
+    end
+
+    test "GET index renders the index view" do
+      get uchi_authors_url
+      assert_template :index
+    end
+
+    test "GET new renders successfully" do
+      get new_uchi_author_url
+      assert_response :success
+    end
+
+    test "GET new renders the new view" do
+      get new_uchi_author_url
+      assert_template :new
+    end
+
+    test "GET show responds successfully" do
+      get uchi_author_url(id: @author.id)
+      assert_response :success
+    end
+
+    test "GET show renders the show view" do
+      get uchi_author_url(id: @author.id)
+      assert_template :show
+    end
+
+    test "PATCH update redirects to show after successful update" do
+      patch uchi_author_url(id: @author.id), params: {author: {name: "Updated Name"}}
+      assert_redirected_to uchi_author_url(id: @author.id)
+    end
+
+    test "PATCH update responds with 303 after successful update" do
+      patch uchi_author_url(id: @author.id), params: {author: {name: "Updated Name"}}
+      assert_response :see_other
+    end
+
+    test "PATCH update changes the author's attributes" do
+      patch uchi_author_url(id: @author.id), params: {author: {name: "Updated Name"}}
+      @author.reload
+      assert_equal "Updated Name", @author.name
+    end
+
+    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]
+      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]
+    end
+
+    test "PATCH update rerenders the edit view after unsuccessful update" do
+      patch uchi_author_url(id: @author.id), params: {author: {name: ""}}
+      assert_template :edit
+    end
+
+    test "PATCH responds with 422 after unsuccessful update" do
+      patch uchi_author_url(id: @author.id), params: {author: {name: ""}}
+      assert_response :unprocessable_entity
+    end
+
+    test "POST create redirects to show after successful creation" do
+      post uchi_authors_url, params: {author: {name: "New Author"}}
+      assert_redirected_to uchi_author_url(id: Author.last.id)
+    end
+
+    test "POST create responds with 303 after successful creation" do
+      post uchi_authors_url, params: {author: {name: "New Author"}}
+      assert_response :see_other
+    end
+
+    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]
+      end
+    end
+
+    test "POST create creates a new author" do
+      post uchi_authors_url, params: {author: {name: "New Author"}}
+      assert_equal "New Author", Author.last.name
+    end
+
+    test "POST create rerenders the new view after unsuccessful creation" do
+      post uchi_authors_url, params: {author: {name: ""}}
+      assert_template :new
+    end
+
+    test "POST create responds with 422 after unsuccessful creation" do
+      post uchi_authors_url, params: {author: {name: ""}}
+      assert_response :unprocessable_entity
+    end
+  end
+end

data/test/controllers/uchi/repository_controller_test.rb

@@ -0,0 +1,93 @@
+require "test_helper"
+
+module Uchi
+  class RepositoryControllerTest < ActionDispatch::IntegrationTest
+    setup do
+      @book = Book.create!(original_title: "The Hobbit")
+    end
+
+    test "DELETE destroy deletes the record" do
+      delete uchi_book_url(id: @book.id)
+
+      assert_not Book.exists?(@book.id)
+    end
+
+    test "DELETE destroy redirects to index" do
+      delete uchi_book_url(id: @book.id)
+
+      assert_redirected_to uchi_books_url
+    end
+
+    test "GET edit responds successfully" do
+      get edit_uchi_book_url(id: @book.id)
+      assert_response :success
+    end
+
+    test "GET edit renders a form for updating the model" do
+      get edit_uchi_book_url(id: @book.id)
+      assert_select "form[action=?][method='post']", uchi_book_path(id: @book.id)
+    end
+
+    test "GET edit links back to the model" do
+      get edit_uchi_book_url(id: @book.id)
+      assert_select "a[href=?]", uchi_book_path(id: @book.id), text: "Cancel"
+    end
+
+    test "GET index links to show for each record" do
+      get uchi_books_url
+
+      assert_select "tr td a[data-turbo-frame='_top'][href=?]", uchi_book_path(id: @book.id)
+    end
+
+    test "GET index links to edit for each record" do
+      get uchi_books_url
+      assert_select "tr td a[data-turbo-frame='_top'][href=?]", edit_uchi_book_path(id: @book.id)
+    end
+
+    test "GET new responds successfully" do
+      get new_uchi_book_url
+      assert_response :success
+    end
+
+    test "GET new renders a form to create a new model" do
+      get new_uchi_book_url
+      assert_select "form[action=?][method='post']", uchi_books_path
+    end
+
+    test "GET new links back to the index" do
+      get new_uchi_book_url
+      assert_select "a[href=?]", uchi_books_path, text: "Cancel"
+    end
+
+    test "GET show responds successfully" do
+      get uchi_book_url(id: @book.id)
+      assert_response :success
+    end
+
+    test "GET show renders the show view" do
+      get uchi_book_url(id: @book.id)
+      assert_template :show
+    end
+
+    test "GET show includes a button to delete the record" do
+      get uchi_book_url(id: @book.id)
+      assert_select "form[action=?]", uchi_book_path(id: @book.id), text: "Delete"
+    end
+
+    test "GET show includes a turbo-frame that loads the titles in a scoped index view" do
+      get uchi_book_url(id: @book.id)
+
+      assert_select "turbo-frame[src]" do |node_set|
+        tag = node_set.first
+        src = tag.attributes["src"].value
+        expected_src = uchi_titles_path(scope: {
+          model: "Book",
+          id: @book.id,
+          field: "titles",
+          inverse_of: "book"
+        })
+        assert_equal expected_src, src
+      end
+    end
+  end
+end

data/test/controllers/uchi/scoped_repository_controller_test.rb

@@ -0,0 +1,73 @@
+require "test_helper"
+
+module Uchi
+  class ScopedRepositoryControllerTest < ActionDispatch::IntegrationTest
+    setup do
+      @book = Book.create!(original_title: "The Hobbit")
+      @dk_title = Title.create!(book: @book, locale: "da-DK", title: "Hobbitten")
+      @de_title = Title.create!(locale: "de-DE", title: "Der Hobbit", book: @book)
+
+      @scope = {model: "Book", id: @book.id, field: "titles"}
+    end
+
+    test "GET edit responds successfully" do
+      get edit_uchi_title_url(id: @dk_title.id, scope: @scope)
+      assert_response :success
+    end
+
+    test "GET edit renders a form for updating the model" do
+      get edit_uchi_title_url(id: @dk_title.id, scope: @scope)
+      assert_select "form[action=?][method='post']", uchi_title_path(id: @dk_title.id)
+    end
+
+    test "GET edit links back to the scoped model" do
+      get edit_uchi_title_url(id: @dk_title.id, scope: @scope)
+      assert_select "a[href=?]", uchi_book_path(id: @book.id), text: "Cancel"
+    end
+
+    test "GET new responds successfully" do
+      get new_uchi_title_url(scope: @scope)
+      assert_response :success
+    end
+
+    test "GET new renders a form to create a new model" do
+      get new_uchi_title_url(scope: @scope)
+      assert_select "form[action=?][method='post']", uchi_titles_path
+    end
+
+    test "GET new links back to the scoped model" do
+      get new_uchi_title_url(scope: @scope)
+      assert_select "a[href=?]", uchi_book_path(id: @book.id), text: "Cancel"
+    end
+
+    test "GET index responds successfully" do
+      get uchi_titles_url(scope: @scope)
+      assert_response :success
+    end
+
+    test "GET index renders the index view" do
+      get uchi_titles_url(scope: @scope)
+      assert_template :index
+    end
+
+    test "GET index includes a turbo-frame" do
+      get uchi_titles_url(scope: @scope)
+      assert_select "turbo-frame"
+    end
+
+    test "GET index lists only the records associated with the parent record" do
+      other_book = Book.create!(original_title: "1984")
+      Title.create!(locale: "de-DE", title: "1984", book: other_book)
+
+      get uchi_titles_url(scope: @scope.merge(inverse_of: "book"))
+
+      assert_equal assigns(:records), [@dk_title, @de_title]
+    end
+
+    test "GET index does not include the field for the parent record" do
+      get uchi_titles_url(scope: @scope.merge(inverse_of: "book"))
+
+      assert_not assigns(:columns).find { |column| column.name == :book }
+    end
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,4 @@
+class ApplicationController < ActionController::Base
+  # Only allow modern browsers supporting webp images, web push, badges, import maps, CSS nesting, and CSS :has.
+  allow_browser versions: :modern
+end

data/test/dummy/app/controllers/uchi/authors_controller.rb

@@ -0,0 +1,7 @@
+module Uchi
+  class AuthorsController < Uchi::RepositoryController
+    def repository_class
+      Uchi::Repositories::Author
+    end
+  end
+end

data/test/dummy/app/controllers/uchi/books_controller.rb

@@ -0,0 +1,7 @@
+module Uchi
+  class BooksController < Uchi::RepositoryController
+    def repository_class
+      Uchi::Repositories::Book
+    end
+  end
+end

data/test/dummy/app/controllers/uchi/titles_controller.rb

@@ -0,0 +1,7 @@
+module Uchi
+  class TitlesController < Uchi::RepositoryController
+    def repository_class
+      Uchi::Repositories::Title
+    end
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

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

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end

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

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

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

@@ -0,0 +1,3 @@
+class Book < ApplicationRecord
+  has_many :titles
+end

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

@@ -0,0 +1,3 @@
+class Title < ApplicationRecord
+  belongs_to :book
+end

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

@@ -0,0 +1,20 @@
+module Uchi
+  module Repositories
+    class Author < Repository
+      def fields
+        [
+          Field::Number.new(:id, on: [:index, :show]),
+          Field::String.new(:name),
+          Field::Date.new(:born_on),
+          Field::String.new(:biography, on: [:edit, :new, :show])
+        ]
+      end
+
+      def title(model)
+        return nil unless model
+
+        model.name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Uchi
+  module Repositories
+    class Book < Repository
+      def fields
+        [
+          Field::HasMany.new(:titles),
+          Field::String.new(:original_title)
+        ]
+      end
+
+      def title(model)
+        model.original_title
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Uchi
+  module Repositories
+    class Title < Repository
+      def fields
+        [
+          Field::BelongsTo.new(:book),
+          Field::String.new(:locale),
+          Field::String.new(:title)
+        ]
+      end
+
+      def title(model)
+        model.title
+      end
+    end
+  end
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= content_for(:title) || "Dummy" %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <meta name="apple-mobile-web-app-capable" content="yes">
+    <meta name="mobile-web-app-capable" content="yes">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= yield :head %>
+
+    <%# Enable PWA manifest for installable apps (make sure to enable in config/routes.rb too!) %>
+    <%#= tag.link rel: "manifest", href: pwa_manifest_path(format: :json) %>
+
+    <link rel="icon" href="/icon.png" type="image/png">
+    <link rel="icon" href="/icon.svg" type="image/svg+xml">
+    <link rel="apple-touch-icon" href="/icon.png">
+
+    <%# Includes all stylesheet files in app/assets/stylesheets %>
+    <%= stylesheet_link_tag :app %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/app/views/pwa/manifest.json.erb

@@ -0,0 +1,22 @@
+{
+  "name": "Dummy",
+  "icons": [
+    {
+      "src": "/icon.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    },
+    {
+      "src": "/icon.png",
+      "type": "image/png",
+      "sizes": "512x512",
+      "purpose": "maskable"
+    }
+  ],
+  "start_url": "/",
+  "display": "standalone",
+  "scope": "/",
+  "description": "Dummy.",
+  "theme_color": "red",
+  "background_color": "red"
+}