uchi 0.1.0 → 0.1.3

data/test/uchi/repository/translate_test.rb

@@ -0,0 +1,272 @@
+require "test_helper"
+require_relative "../../dummy/app/uchi/repositories/author"
+
+class UchiRepositoryTranslateTest < ActiveSupport::TestCase
+  def setup
+    @repository = Uchi::Repositories::Author.new
+    @translate = @repository.translate
+    @field = Uchi::Field.new(:name)
+  end
+
+  test "initializes with repository" do
+    assert_equal @repository, @translate.repository
+  end
+
+  test "#breadcrumb_label returns translation from uchi.repository.author.breadcrumb.index.label" do
+    I18n.with_locale(:da) do
+      result = @translate.breadcrumb_label(:index)
+      assert_equal "Forfattere", result
+    end
+  end
+
+  test "#breadcrumb_label for index page defaults to plural name" do
+    result = @translate.breadcrumb_label(:index)
+    assert_equal "Authors", result
+  end
+
+  test "#breadcrumb_label for show page returns translation from uchi.repository.author.breadcrumb.show.label" do
+    I18n.with_locale(:da) do
+      result = @translate.breadcrumb_label(:show, record: Author.new(name: "Test Author"))
+      assert_equal "Vis Test Author", result
+    end
+  end
+
+  test "#breadcrumb_label for show page defaults to record title" do
+    result = @translate.breadcrumb_label(:show, record: Author.new(name: "Test Author"))
+    assert_equal "Test Author", result
+  end
+
+  test "#breadcrumb_label for edit page returns translation from uchi.repository.author.breadcrumb.edit.label" do
+    I18n.with_locale(:da) do
+      result = @translate.breadcrumb_label(:edit, record: Author.new(name: "Test Author"))
+      assert_equal "Rediger Test Author", result
+    end
+  end
+
+  test "#breadcrumb_label for edit page defaults to page name" do
+    result = @translate.breadcrumb_label(:edit, record: Author.new(name: "Test Author"))
+    assert_equal "Edit", result
+  end
+
+  test "#destroy_dialog_title returns translation from uchi.repository.author.dialog.destroy.title" do
+    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
+    result = @translate.destroy_dialog_title(:destroy)
+    assert_equal "Are you sure?", result
+  end
+
+  test "#description returns translation from uchi.repository.author.description.index" do
+    result = @translate.description(:index)
+    assert_nil result
+  end
+
+  test "#description falls back to nil" do
+    result = @translate.description(:index)
+    assert_nil result
+  end
+
+  test "failed_destroy returns translation from uchi.repository.author.destroy.failure" do
+    I18n.with_locale(:da) do
+      result = @translate.failed_destroy
+      assert_equal "Forfatteren kunne ikke slettes", result
+    end
+  end
+
+  test "failed_destroy falls back to default translation" do
+    result = @translate.failed_destroy
+    assert_equal "The record could not be deleted", result
+  end
+
+  test "#field_label returns translation from uchi.repository.author.field.name.label" do
+    I18n.with_locale(:da) do
+      result = @translate.field_label(@field)
+      assert_equal "Navn", result
+    end
+  end
+
+  test "#field_label falls back to human_attribute_name" do
+    result = @translate.field_label(@field)
+    assert_equal "Name", result
+  end
+
+  test "#field_hint returns translation from uchi.repository.author.field.name.hint" do
+    I18n.with_locale(:da) do
+      result = @translate.field_hint(@field)
+      assert_equal "Indtast forfatterens navn", result
+    end
+  end
+
+  test "#field_hint falls back to nil" do
+    result = @translate.field_hint(@field)
+    assert_nil result
+  end
+
+  test "#link_to_cancel returns cancel text" do
+    I18n.with_locale(:da) do
+      result = @translate.link_to_cancel
+      assert_equal "Annuller", result
+    end
+  end
+
+  test "#link_to_cancel falls back to Cancel" do
+    result = @translate.link_to_cancel
+    assert_equal "Cancel", result
+  end
+
+  test "#link_to_destroy returns destroy text" do
+    author = Author.new(name: "Brandon Sanderson")
+    I18n.with_locale(:da) do
+      result = @translate.link_to_destroy(author)
+      assert_equal "Slet Brandon Sanderson", result
+    end
+  end
+
+  test "#link_to_destroy falls back to delete" do
+    author = Author.new(name: "Brandon Sanderson")
+    result = @translate.link_to_destroy(author)
+    assert_equal "Delete", result
+  end
+
+  test "#link_to_edit returns translation from uchi.repository.author.button.link_to_edit" do
+    author = Author.new(name: "Test Author")
+    I18n.with_locale(:da) do
+      result = @translate.link_to_edit(author)
+      assert_equal "Rediger", result
+    end
+  end
+
+  test "#link_to_edit falls back to Edit" do
+    author = Author.new(name: "Test Author")
+    result = @translate.link_to_edit(author)
+    assert_equal "Edit", result
+  end
+
+  test "#link_to_new returns translation from uchi.repository.author.button.link_to_new" do
+    I18n.with_locale(:da) do
+      result = @translate.link_to_new
+      assert_equal "Ny forfatter", result
+    end
+  end
+
+  test "#link_to_new falls back to New %{model}" do
+    result = @translate.link_to_new
+    assert_equal "New Author", result
+  end
+
+  test "#loading_message returns translation from uchi.repository.common.loading" do
+    I18n.with_locale(:da) do
+      result = @translate.loading_message
+      assert_equal "Indlæser...", result
+    end
+  end
+
+  test "#loading_message falls back to Loading..." do
+    result = @translate.loading_message
+    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
+      assert_equal "Forfattere", result
+    end
+  end
+
+  test "#plural_name falls back to humanized plural model name" do
+    result = @translate.plural_name
+    assert_equal "Authors", result
+  end
+
+  test "#submit_button returns translation from uchi.common.save" do
+    I18n.with_locale(:da) do
+      result = @translate.submit_button
+      assert_equal "Gem", result
+    end
+  end
+
+  test "#submit_button falls back to Save" do
+    result = @translate.submit_button
+    assert_equal "Save", result
+  end
+
+  test "successful_create returns translation from uchi.repository.author.create.success" do
+    I18n.with_locale(:da) do
+      result = @translate.successful_create
+      assert_equal "Forfatteren er blevet tilføjet", result
+    end
+  end
+
+  test "successful_create falls back to default translation" do
+    result = @translate.successful_create
+    assert_equal "Your changes have been saved", result
+  end
+
+  test "successful_destroy returns translation from uchi.repository.author.destroy.success" do
+    I18n.with_locale(:da) do
+      result = @translate.successful_destroy
+      assert_equal "Forfatteren er blevet slettet", result
+    end
+  end
+
+  test "successful_destroy falls back to default translation" do
+    result = @translate.successful_destroy
+    assert_equal "The record has been deleted", result
+  end
+
+  test "successful_update returns translation from uchi.repository.author.update.success" do
+    I18n.with_locale(:da) do
+      result = @translate.successful_update
+      assert_equal "Dine ændringer til forfatteren blev gemt", result
+    end
+  end
+
+  test "successful_update falls back to default translation" do
+    result = @translate.successful_update
+    assert_equal "Your changes have been saved", result
+  end
+
+  test "#title returns repository title for show page with record" do
+    author = Author.new(name: "Test Author")
+    result = @translate.title(:show, record: author)
+    assert_equal "Test Author", result
+  end
+
+  test "#title returns translation from uchi.repository.author.index.title for index page" do
+    I18n.with_locale(:da) do
+      result = @translate.title(:index)
+      assert_equal "Forfattere", result
+    end
+  end
+
+  test "#title returns translation from uchi.repository.author.edit.title for edit page" do
+    I18n.with_locale(:da) do
+      result = @translate.title(:edit)
+      assert_equal "Rediger forfatter", result
+    end
+  end
+
+  test "#title returns translation from uchi.repository.author.new.title for new page" do
+    I18n.with_locale(:da) do
+      result = @translate.title(:new)
+      assert_equal "Ny forfatter", result
+    end
+  end
+
+  test "#title falls back to plural_name" do
+    result = @translate.title(:index)
+    assert_equal "Authors", result
+  end
+end

data/test/uchi/repository_test.rb

@@ -0,0 +1,137 @@
+require "test_helper"
+
+require_relative "../dummy/app/uchi/repositories/author"
+
+class UchiRepositoryTest < ActiveSupport::TestCase
+  test ".all returns all Uchi::Repository's" do
+    repositories = Uchi::Repository.all
+
+    assert_equal \
+      repositories.sort_by(&:name),
+      [Uchi::Repositories::Author, Uchi::Repositories::Book, Uchi::Repositories::Title]
+  end
+
+  test ".for_model returns the repository for the given model" do
+    assert_equal Uchi::Repositories::Author, Uchi::Repository.for_model(Author)
+    assert_equal Uchi::Repositories::Author, Uchi::Repository.for_model("Author")
+    assert_equal Uchi::Repositories::Author, Uchi::Repository.for_model(:Author)
+  end
+
+  test ".model returns the model class the repository manages" do
+    assert_equal Author, Uchi::Repositories::Author.model
+  end
+
+  test "#build returns a new, unsaved instance of the model the repository manages" do
+    author = author_repository.build(name: "Alice")
+
+    assert author.is_a?(Author)
+    assert_equal "Alice", author.name
+    assert author.new_record?
+  end
+
+  test "#controller_name returns a URL slug for the controller" do
+    assert_equal "authors", author_repository.controller_name
+  end
+
+  test "#default_sort_order returns a sort by id ascending" do
+    sort_order = author_repository.default_sort_order
+
+    assert sort_order.is_a?(Uchi::SortOrder)
+    assert_equal :id, sort_order.name
+    assert_equal :asc, sort_order.direction
+  end
+
+  test "#fields_for_edit returns fields to include on the edit page" do
+    fields = author_repository.fields_for_edit
+
+    assert_equal [:name, :born_on, :biography], fields.map(&:name)
+  end
+
+  test "#fields_for_index returns fields to include on the index page" do
+    fields = author_repository.fields_for_index
+
+    assert_equal [:id, :name, :born_on], fields.map(&:name)
+  end
+
+  test "#fields_for_show returns fields to include on the show page" do
+    fields = author_repository.fields_for_show
+
+    assert_equal [:id, :name, :born_on, :biography], fields.map(&:name)
+  end
+
+  test "#find_all returns all records of the model the repository manages" do
+    alice = Author.create!(name: "Alice")
+    bob = Author.create!(name: "Bob")
+
+    authors = author_repository.find_all
+
+    assert_equal [alice, bob], authors
+  end
+
+  # TODO: How to test this?
+  # test "#find_all applies includes if given"
+
+  test "#find_all applies a search query if given" do
+    alice = Author.create!(name: "Alice")
+    _bob = Author.create!(name: "Bob")
+
+    authors = author_repository.find_all(search: "IC")
+
+    assert_equal [alice], authors
+  end
+
+  test "#find_all applies a sort order if given" do
+    alice = Author.create!(name: "Alice")
+    bob = Author.create!(name: "Bob")
+
+    authors = author_repository.find_all(sort_order: Uchi::SortOrder.new(:name, :desc))
+
+    assert_equal [bob, alice], authors
+  end
+
+  test "#find returns a single record by its ID" do
+    alice = Author.create!(name: "Alice")
+
+    result = author_repository.find(alice.id)
+
+    assert_equal alice, result
+  end
+
+  test "#find raises ActiveRecord::RecordNotFound when the record is not found" do
+    assert_raises(ActiveRecord::RecordNotFound) do
+      author_repository.find(42)
+    end
+  end
+
+  test "#model returns the model class the repository manages" do
+    assert_equal Author, author_repository.model
+  end
+
+  test "#routes returns an instance of the routes helper" do
+    assert_instance_of Uchi::Repository::Routes, author_repository.routes
+  end
+
+  test "#searchable? returns true if the repository has searchable fields" do
+    assert author_repository.searchable?
+  end
+
+  test "#title returns a string representation of the record" do
+    author = Author.new(name: "Alice")
+
+    assert_equal "Alice", author_repository.title(author)
+  end
+
+  test "#title returns nil when record is nil" do
+    assert_nil author_repository.title(nil)
+  end
+
+  test "#translate returns the translate helper" do
+    assert_instance_of Uchi::Repository::Translate, author_repository.translate
+  end
+
+  private
+
+  def author_repository
+    Uchi::Repositories::Author.new
+  end
+end

data/test/uchi/sort_order_test.rb

@@ -0,0 +1,47 @@
+require "test_helper"
+
+class UchiSortOrderTest < ActiveSupport::TestCase
+  test ".from_params returns nil when no params are given" do
+    assert_nil Uchi::SortOrder.from_params({})
+  end
+
+  test ".from_params defaults to ascending when direction isn't given" do
+    sort_order = Uchi::SortOrder.from_params(sort: {by: :name})
+    assert_instance_of Uchi::SortOrder, sort_order
+    assert_equal :name, sort_order.name
+    assert_equal :asc, sort_order.direction
+  end
+
+  test ".from_params returns a new SortOrder when both 'by' and 'direction' are given" do
+    sort_order = Uchi::SortOrder.from_params(sort: {by: :born_on, direction: :desc})
+    assert_instance_of Uchi::SortOrder, sort_order
+    assert_equal :born_on, sort_order.name
+    assert_equal :desc, sort_order.direction
+  end
+
+  test "#ascending? returns true when direction is :asc" do
+    assert Uchi::SortOrder.new(:id, :asc).ascending?
+  end
+
+  test "#ascending? returns false when direction is :desc" do
+    assert_not Uchi::SortOrder.new(:id, :desc).ascending?
+  end
+
+  test "#apply applies the sort order to the given query" do
+    sort_order = Uchi::SortOrder.new(:name, :desc)
+    query = Author.all
+
+    sorted_query = sort_order.apply(query)
+
+    assert_includes sorted_query.to_sql, "ORDER BY \"authors\".\"name\" DESC"
+    assert_equal sorted_query, query.order(name: :desc)
+  end
+
+  test "#descending? returns false when direction is :asc" do
+    assert_not Uchi::SortOrder.new(:id, :asc).descending?
+  end
+
+  test "#descending? returns true when direction is :desc" do
+    assert Uchi::SortOrder.new(:id, :desc).descending?
+  end
+end

data/test/uchi_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class UchiTest < ActiveSupport::TestCase
+  test "it has a version number" do
+    assert Uchi::VERSION
+  end
+end

metadata

@@ -1,29 +1,165 @@
 --- !ruby/object:Gem::Specification
 name: uchi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Jakob Skjerning
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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: []
 files:
-- README.md
-- Rakefile
-- lib/uchi.rb
-- lib/uchi/version.rb
+- ".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
+- test/components/uchi/field/blank_test.rb
+- 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
+- test/dummy/Rakefile
+- test/dummy/app/assets/images/.keep
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/controllers/uchi/authors_controller.rb
+- test/dummy/app/controllers/uchi/books_controller.rb
+- test/dummy/app/controllers/uchi/titles_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/jobs/application_job.rb
+- test/dummy/app/mailers/application_mailer.rb
+- test/dummy/app/models/application_record.rb
+- test/dummy/app/models/author.rb
+- test/dummy/app/models/book.rb
+- test/dummy/app/models/concerns/.keep
+- test/dummy/app/models/title.rb
+- test/dummy/app/uchi/repositories/author.rb
+- test/dummy/app/uchi/repositories/book.rb
+- test/dummy/app/uchi/repositories/title.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/layouts/mailer.html.erb
+- test/dummy/app/views/layouts/mailer.text.erb
+- test/dummy/app/views/pwa/manifest.json.erb
+- test/dummy/app/views/pwa/service-worker.js
+- test/dummy/bin/dev
+- test/dummy/bin/rails
+- test/dummy/bin/rake
+- test/dummy/bin/setup
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/cable.yml
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/content_security_policy.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/locales/da.yml
+- test/dummy/config/locales/en.yml
+- test/dummy/config/puma.rb
+- test/dummy/config/routes.rb
+- test/dummy/config/storage.yml
+- 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
+- test/dummy/public/404.html
+- test/dummy/public/406-unsupported-browser.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/icon.png
+- test/dummy/public/icon.svg
+- test/dummy/storage/.keep
+- test/dummy/test/fixtures/authors.yml
+- test/dummy/test/models/author_test.rb
+- test/dummy/tmp/.keep
+- test/dummy/tmp/pids/.keep
+- test/dummy/tmp/storage/.keep
+- test/test_helper.rb
+- test/uchi/field_test.rb
+- test/uchi/i18n_test.rb
+- test/uchi/repository/routes_test.rb
+- test/uchi/repository/translate_test.rb
+- test/uchi/repository_test.rb
+- test/uchi/sort_order_test.rb
+- test/uchi_test.rb
 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:
@@ -41,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: []

data/README.md

@@ -1,35 +0,0 @@
-# Uchi
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/uchi`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/koppen/uchi.

data/Rakefile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "standard/rake"
-
-task default: :standard

data/lib/uchi/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module Uchi
-  VERSION = "0.1.0"
-end