katalyst-koi 4.0.0

data/lib/koi/middleware/url_redirect.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Koi
+  class UrlRedirect
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+
+      current_path = env["REQUEST_PATH"]
+
+      if status.to_i == 404 && current_path.exclude?("mini-profiler-resources") &&
+          (new_path = find_redirect(current_path))
+        request = ActionDispatch::Request.new(env)
+
+        # Close the body as we will not use it for a 301 redirect
+        body.close
+
+        # Issue a "Moved permanently" response with the redirect location
+        [301, { "Location" => new_location(current_path, new_path, request) },
+         ["#{current_path} moved. The document has moved to #{new_path}"]]
+      else
+        # Not a 404 or no redirect found, just send the response as is
+        [status, headers, body]
+      end
+    end
+
+    private
+
+    def new_location(current_path, new_path, request)
+      if %r{\Ahttps{0,1}://}.match?(new_path)
+        new_path
+      else
+        request.original_url.gsub(current_path, new_path)
+      end
+    end
+
+    def find_redirect(path)
+      UrlRewrite.redirect_path_for(path)
+    end
+  end
+end

data/lib/koi/release.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Koi
+  module Release
+    def version
+      @version ||= read(::Rails.root.join("VERSION"))
+    end
+
+    module_function :version
+
+    def revision
+      @revision ||= read(::Rails.root.join("REVISION"))
+    end
+
+    module_function :revision
+
+    def meta_tags(context)
+      ReleaseMetaTagsBuilder.new(context).render
+    end
+
+    module_function :meta_tags
+
+    def read(file)
+      return "HEAD" if Rails.env.development?
+      return "unknown" unless File.exist?(file)
+
+      File.read(file).strip
+    end
+
+    module_function :read
+  end
+
+  class ReleaseMetaTagsBuilder
+    delegate_missing_to :@context
+
+    def initialize(context)
+      @context = context
+    end
+
+    def version
+      tag.meta(name: "application-version", content: Koi::Release.version)
+    end
+
+    def revision
+      tag.meta(name: "application-revision", content: Koi::Release.revision)
+    end
+
+    def render
+      version + revision
+    end
+  end
+end

data/lib/koi/version.rb

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

data/lib/koi.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "importmap-rails"
+require "katalyst/govuk/formbuilder"
+require "govuk_design_system_formbuilder/concerns/file_element"
+require "govuk_design_system_formbuilder/elements/document"
+require "govuk_design_system_formbuilder/elements/image"
+require "katalyst/tables"
+require "pagy"
+require "stimulus-rails"
+require "turbo-rails"
+require "webauthn"
+
+require "koi/form_builder"
+require "koi/menu"
+require "koi/caching"
+require "koi/config"
+require "koi/engine"
+require "koi/release"
+
+require "katalyst/content"
+require "katalyst/kpop"
+require "katalyst/navigation"
+
+require "view_component"
+
+module Koi
+  extend self
+
+  def config
+    @config ||= Config.new
+  end
+
+  def configure
+    yield config
+  end
+end

data/spec/factories/admins.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :admin, class: "Admin::User" do
+    email { Faker::Internet.email }
+    name { Faker::Name.name }
+    password { Faker::Internet.password }
+  end
+end

data/spec/factories/url_rewrites.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :url_rewrite do
+    from { URI.parse(Faker::Internet.url).path }
+    to { Faker::Internet.url }
+    active { true }
+  end
+end

metadata

@@ -0,0 +1,430 @@
+--- !ruby/object:Gem::Specification
+name: katalyst-koi
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Katalyst Interactive
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: importmap-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: stimulus-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: 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: bcrypt
+  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: webauthn
+  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: katalyst-govuk-formbuilder
+  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: pagy
+  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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: katalyst-content
+  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: katalyst-kpop
+  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: katalyst-navigation
+  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: katalyst-tables
+  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'
+description:
+email:
+- developers@katalyst.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Upgrade.md
+- app/assets/builds/koi/admin.css
+- app/assets/builds/koi/nav_items.css
+- app/assets/config/koi.js
+- app/assets/images/koi/application/chevron-right.svg
+- app/assets/images/koi/application/glyphicons-halflings-white.png
+- app/assets/images/koi/application/glyphicons-halflings.png
+- app/assets/images/koi/application/icon-collapse-down.png
+- app/assets/images/koi/application/icon-collapse-up.png
+- app/assets/images/koi/application/icon-file-doc.png
+- app/assets/images/koi/application/icon-file-img.png
+- app/assets/images/koi/application/icon-file-pdf.png
+- app/assets/images/koi/application/icon-file-ppt.png
+- app/assets/images/koi/application/icon-file-unknown.png
+- app/assets/images/koi/application/icon-file-xls.png
+- app/assets/images/koi/application/icon-file-zip.png
+- app/assets/images/koi/application/icon-form-date-picker.png
+- app/assets/images/koi/application/icon-form-error.png
+- app/assets/images/koi/application/icon-index-sort-ascending.png
+- app/assets/images/koi/application/icon-index-sort-descending.png
+- app/assets/images/koi/application/icon-index-sort.png
+- app/assets/images/koi/application/icon-index-sortable.png
+- app/assets/images/koi/application/icon-menu-cursor.png
+- app/assets/images/koi/application/icon-overlay-add.png
+- app/assets/images/koi/application/icon-overlay-close.png
+- app/assets/images/koi/application/icon-sortable.png
+- app/assets/images/koi/application/jcrop.gif
+- app/assets/images/koi/application/loading.gif
+- app/assets/images/koi/application/select-arrow.svg
+- app/assets/images/koi/application/select_arrow.png
+- app/assets/images/koi/application/sort-ascending.png
+- app/assets/images/koi/application/sort-descending.png
+- app/assets/javascripts/koi/admin.js
+- app/assets/javascripts/koi/controllers/application.js
+- app/assets/javascripts/koi/controllers/document_field_controller.js
+- app/assets/javascripts/koi/controllers/file_field_controller.js
+- app/assets/javascripts/koi/controllers/flash_controller.js
+- app/assets/javascripts/koi/controllers/form_request_submit_controller.js
+- app/assets/javascripts/koi/controllers/image_field_controller.js
+- app/assets/javascripts/koi/controllers/index.js
+- app/assets/javascripts/koi/controllers/index_actions_controller.js
+- app/assets/javascripts/koi/controllers/keyboard_controller.js
+- app/assets/javascripts/koi/controllers/navigation_controller.js
+- app/assets/javascripts/koi/controllers/navigation_toggle_controller.js
+- app/assets/javascripts/koi/controllers/show_hide_controller.js
+- app/assets/javascripts/koi/controllers/sluggable_controller.js
+- app/assets/javascripts/koi/controllers/webauthn_authentication_controller.js
+- app/assets/javascripts/koi/controllers/webauthn_registration_controller.js
+- app/assets/javascripts/koi/utils/transition.js
+- app/assets/stylesheets/koi/admin.scss
+- app/assets/stylesheets/koi/base/_button.scss
+- app/assets/stylesheets/koi/base/_icon.scss
+- app/assets/stylesheets/koi/base/_index.scss
+- app/assets/stylesheets/koi/base/_input.scss
+- app/assets/stylesheets/koi/base/_link.scss
+- app/assets/stylesheets/koi/base/_list.scss
+- app/assets/stylesheets/koi/base/_typography.scss
+- app/assets/stylesheets/koi/components/_actions-group.scss
+- app/assets/stylesheets/koi/components/_image-field.scss
+- app/assets/stylesheets/koi/components/_index-actions.scss
+- app/assets/stylesheets/koi/components/_index-table.scss
+- app/assets/stylesheets/koi/components/_index.scss
+- app/assets/stylesheets/koi/components/_item-table.scss
+- app/assets/stylesheets/koi/components/_pagy.scss
+- app/assets/stylesheets/koi/layouts/_banner.scss
+- app/assets/stylesheets/koi/layouts/_content.scss
+- app/assets/stylesheets/koi/layouts/_flash.scss
+- app/assets/stylesheets/koi/layouts/_header.scss
+- app/assets/stylesheets/koi/layouts/_index.scss
+- app/assets/stylesheets/koi/layouts/_main.scss
+- app/assets/stylesheets/koi/layouts/_navigation.scss
+- app/assets/stylesheets/koi/layouts/_stack.scss
+- app/assets/stylesheets/koi/pages/_index.scss
+- app/assets/stylesheets/koi/pages/_login.scss
+- app/assets/stylesheets/koi/themes/_content.scss
+- app/assets/stylesheets/koi/themes/_govuk.scss
+- app/assets/stylesheets/koi/themes/_index.scss
+- app/assets/stylesheets/koi/themes/_kpop.scss
+- app/assets/stylesheets/koi/themes/_navigation.scss
+- app/assets/stylesheets/koi/themes/_trix.scss
+- app/assets/stylesheets/koi/utils/_breakpoints.scss
+- app/assets/stylesheets/koi/utils/_hide.scss
+- app/assets/stylesheets/koi/utils/_index.scss
+- app/assets/stylesheets/koi/utils/_typography.scss
+- app/components/koi/header/edit_component.rb
+- app/components/koi/header/index_component.rb
+- app/components/koi/header/new_component.rb
+- app/components/koi/header/show_component.rb
+- app/components/koi/header_component.html.erb
+- app/components/koi/header_component.rb
+- app/components/koi/index_table_component.rb
+- app/controllers/admin/admin_users_controller.rb
+- app/controllers/admin/application_controller.rb
+- app/controllers/admin/caches_controller.rb
+- app/controllers/admin/credentials_controller.rb
+- app/controllers/admin/dashboards_controller.rb
+- app/controllers/admin/sessions_controller.rb
+- app/controllers/admin/url_rewrites_controller.rb
+- app/controllers/concerns/koi/controller/has_admin_users.rb
+- app/controllers/concerns/koi/controller/has_webauthn.rb
+- app/controllers/concerns/koi/controller/is_admin_controller.rb
+- app/helpers/katalyst/content/editor/errors.rb
+- app/helpers/katalyst/navigation/editor/errors.rb
+- app/helpers/koi/application_helper.rb
+- app/helpers/koi/date_helper.rb
+- app/helpers/koi/definition_list_helper.rb
+- app/helpers/koi/index_actions_helper.rb
+- app/jobs/koi/application_job.rb
+- app/mailers/koi/application_mailer.rb
+- app/models/admin/credential.rb
+- app/models/admin/user.rb
+- app/models/application_record.rb
+- app/models/concerns/koi/model/archivable.rb
+- app/models/url_rewrite.rb
+- app/views/admin/admin_users/_admin.html+row.erb
+- app/views/admin/admin_users/_authentication.html.erb
+- app/views/admin/admin_users/_fields.html.erb
+- app/views/admin/admin_users/edit.html.erb
+- app/views/admin/admin_users/index.html.erb
+- app/views/admin/admin_users/new.html.erb
+- app/views/admin/admin_users/show.html.erb
+- app/views/admin/credentials/new.html.erb
+- app/views/admin/dashboards/show.html.erb
+- app/views/admin/sessions/new.html.erb
+- app/views/admin/shared/icons/_close.html.erb
+- app/views/admin/shared/icons/_cross.html.erb
+- app/views/admin/shared/icons/_menu.html.erb
+- app/views/admin/shared/icons/_refresh.html.erb
+- app/views/admin/url_rewrites/_form_fields.html.erb
+- app/views/admin/url_rewrites/_url_rewrite.html+row.erb
+- app/views/admin/url_rewrites/edit.html.erb
+- app/views/admin/url_rewrites/index.html.erb
+- app/views/admin/url_rewrites/new.html.erb
+- app/views/admin/url_rewrites/show.html.erb
+- app/views/katalyst/content/asides/_aside.html+form.erb
+- app/views/katalyst/content/columns/_column.html+form.erb
+- app/views/katalyst/content/contents/_content.html+form.erb
+- app/views/katalyst/content/figures/_figure.html+form.erb
+- app/views/katalyst/content/groups/_group.html+form.erb
+- app/views/katalyst/content/items/_item.html+form.erb
+- app/views/katalyst/content/sections/_section.html+form.erb
+- app/views/katalyst/navigation/items/_button.html.erb
+- app/views/katalyst/navigation/items/_heading.html.erb
+- app/views/katalyst/navigation/items/_link.html.erb
+- app/views/katalyst/navigation/menus/edit.html.erb
+- app/views/katalyst/navigation/menus/new.html.erb
+- app/views/katalyst/navigation/menus/show.html.erb
+- app/views/layouts/koi/_environment.html.erb
+- app/views/layouts/koi/_flash.html.erb
+- app/views/layouts/koi/_header.html.erb
+- app/views/layouts/koi/_navigation.html.erb
+- app/views/layouts/koi/_navigation_collapse.html.erb
+- app/views/layouts/koi/_navigation_header.html.erb
+- app/views/layouts/koi/_navigation_item.html.erb
+- app/views/layouts/koi/application.html.erb
+- app/views/layouts/koi/login.html.erb
+- config/importmap.rb
+- config/initializers/flipper.rb
+- config/initializers/pagy.rb
+- config/initializers/time_formats.rb
+- config/locales/koi.en.yml
+- config/locales/pagy.en.yml
+- config/routes.rb
+- db/migrate/20120220130849_devise_create_admins.rb
+- db/migrate/20130509235316_add_url_rewriter.rb
+- db/migrate/20230213053854_convert_devise_admins_to_rails.rb
+- db/migrate/20230412023411_create_admin_user_credentials.rb
+- db/migrate/20230531063707_update_admin_users.rb
+- db/migrate/20230602033610_add_archived_to_admin_users.rb
+- db/seeds.rb
+- lib/generators/koi/active_record/active_record_generator.rb
+- lib/generators/koi/admin/USAGE
+- lib/generators/koi/admin/admin_generator.rb
+- lib/generators/koi/admin_controller/USAGE
+- lib/generators/koi/admin_controller/admin_controller_generator.rb
+- lib/generators/koi/admin_controller/templates/controller.rb.tt
+- lib/generators/koi/admin_controller/templates/controller_spec.rb.tt
+- lib/generators/koi/admin_route/admin_route_generator.rb
+- lib/generators/koi/admin_views/USAGE
+- lib/generators/koi/admin_views/admin_views_generator.rb
+- lib/generators/koi/admin_views/templates/_fields.html.erb.tt
+- lib/generators/koi/admin_views/templates/_record.html+row.erb.tt
+- lib/generators/koi/admin_views/templates/edit.html.erb.tt
+- lib/generators/koi/admin_views/templates/index.html.erb.tt
+- lib/generators/koi/admin_views/templates/new.html.erb.tt
+- lib/generators/koi/admin_views/templates/show.html.erb.tt
+- lib/govuk_design_system_formbuilder/concerns/file_element.rb
+- lib/govuk_design_system_formbuilder/elements/document.rb
+- lib/govuk_design_system_formbuilder/elements/image.rb
+- lib/katalyst/koi.rb
+- lib/koi.rb
+- lib/koi/caching.rb
+- lib/koi/config.rb
+- lib/koi/engine.rb
+- lib/koi/form_builder.rb
+- lib/koi/menu.rb
+- lib/koi/menu/builder.rb
+- lib/koi/middleware/url_redirect.rb
+- lib/koi/release.rb
+- lib/koi/version.rb
+- spec/factories/admins.rb
+- spec/factories/url_rewrites.rb
+homepage: https://github.com/katalyst/koi
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: Koi CMS admin framework
+test_files: []