shiplog 0.2.0 → 0.3.1

data/lib/shiplog.rb

@@ -12,5 +12,78 @@ module Shiplog
     def config = (@config ||= Configuration.new)
     def configure = yield(config)
     def reset_config! = (@config = nil)
+
+    # The number of approved features and changes approved after `since`, or all of them while it is nil, capped
+    # at 99. Counted on approved_at (when the entry was approved), not released_on (the list's order). The host supplies the timestamp (Shiplog doesn't know its users): see config.on_changelog_seen.
+    def unseen_count(since: nil) = Entry.unseen_count(since:)
+
+    ACTIVE_STORAGE_TABLES = %w[active_storage_attachments active_storage_blobs].freeze
+
+    # Whether the host loaded Active Storage (its engine and the model macros). The declaration on Entry needs
+    # only this, so it never touches the database.
+    def active_storage_loaded? = !!(defined?(ActiveStorage::Engine) && ActiveRecord::Base.respond_to?(:has_many_attached))
+
+    # Whether screenshots can work: Active Storage is loaded and its tables exist (a host that loads
+    # `rails/all` but never ran active_storage:install would otherwise fail on every query). Without either,
+    # every image feature stays off instead of failing.
+    def active_storage? = active_storage_loaded? && active_storage_tables?
+
+    # Whether the Active Storage tables exist. Checked lazily, on first use, then remembered for the life of the
+    # process, so public pages never look at the schema again. When the database can't be reached (at boot, say)
+    # the answer is "not yet known": false for now, and asked again next time. The reason is logged once.
+    def active_storage_tables?
+      return @active_storage_tables unless @active_storage_tables.nil?
+
+      present = ActiveRecord::Base.with_connection { |connection| ACTIVE_STORAGE_TABLES.all? { |table| connection.data_source_exists?(table) } }
+      log_images_off("Active Storage's tables are missing (#{ACTIVE_STORAGE_TABLES.join(", ")}). Run bin/rails active_storage:install and db:migrate to enable them.") unless present || !config.images
+      @active_storage_tables = present
+    rescue ActiveRecord::ActiveRecordError
+      false
+    end
+
+    # Forgets what was learned about the schema and what was logged (tests, and hosts that create the tables at runtime).
+    def reset_images_checks!
+      @active_storage_tables = nil
+      @images_off_logged = nil
+      @image_variants = nil
+    end
+
+    # Logged once at boot (see Shiplog::Engine): screenshots wanted but Active Storage missing. A missing
+    # table is logged by the check itself, the first time it runs.
+    def log_images_status
+      return unless config.images
+
+      if !active_storage_loaded? then log_images_off("Active Storage is not loaded. Require active_storage/engine to enable them.")
+      else active_storage_tables?
+      end
+    end
+
+    # Whether the admin can show thumbnails as variants: the image_processing gem is loaded and so is a
+    # processor for it (ruby-vips, which must load, or mini_magick). Otherwise the originals are shown.
+    def image_variants?
+      return @image_variants unless @image_variants.nil?
+
+      @image_variants = Gem.loaded_specs.key?("image_processing") && (vips_loads? || Gem.loaded_specs.key?("mini_magick"))
+    end
+
+    # Whether screenshots are in use: config.images and Active Storage.
+    def images? = config.images && active_storage?
+
+    private
+
+    def vips_loads?
+      return true if defined?(::Vips)
+
+      Gem.loaded_specs.key?("ruby-vips") && require("vips")
+    rescue LoadError
+      false
+    end
+
+    def log_images_off(reason)
+      @images_off_logged ||= Set.new
+      return unless @images_off_logged.add?(reason)
+
+      Rails.logger&.info("[shiplog] Screenshots are off: #{reason}")
+    end
   end
 end

data/lib/tasks/shiplog.rake

@@ -0,0 +1,29 @@
+# Shiplog::Engine and Shiplog::Admin::Engine share the gem's root, so Rails loads this file once for each: the
+# guard keeps every task from running twice.
+unless Rake::Task.task_defined?("shiplog:backfill_slugs")
+  namespace :shiplog do
+    desc "Give approved changelog entries that have no permalink slug one (entries approved by code older than 0.3.0 after the migration ran)"
+    task backfill_slugs: :environment do
+      count = Shiplog::Entry.backfill_slugs
+      puts "Shiplog: gave #{count} #{count == 1 ? "entry" : "entries"} a slug."
+    end
+
+    desc "Translate approved entries and area names that have no current translation into config.locales (entries approved before 0.3.0 get none). BATCH_SIZE=100"
+    task translate_approved: :environment do
+      if Shiplog.config.locales.empty?
+        puts "Shiplog: config.locales is empty, nothing to translate."
+      elsif Shiplog.config.rewriter.nil?
+        puts "Shiplog: config.rewriter is not set, so nothing can be translated."
+      else
+        result = Shiplog::Entry.enqueue_missing_translations(batch_size: ENV.fetch("BATCH_SIZE", 100).to_i.clamp(1, 10_000))
+        approved = result[:approved]
+        puts "Shiplog: #{approved} approved #{approved == 1 ? "entry" : "entries"}."
+        result[:enqueued].each do |locale, count|
+          puts "Shiplog: #{locale}: #{count} enqueued, #{approved - count} current."
+        end
+        areas = Shiplog::Area.enqueue_missing_translations
+        puts "Shiplog: #{areas} #{areas == 1 ? "area" : "areas"} enqueued for name translation."
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shiplog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Trackberry
@@ -40,14 +40,25 @@ files:
 - MIT-LICENSE
 - README.md
 - app/controllers/shiplog/admin/application_controller.rb
+- app/controllers/shiplog/admin/area_detections_controller.rb
+- app/controllers/shiplog/admin/area_translations_controller.rb
+- app/controllers/shiplog/admin/areas/merges_controller.rb
+- app/controllers/shiplog/admin/areas/moves_controller.rb
+- app/controllers/shiplog/admin/areas_controller.rb
 - app/controllers/shiplog/admin/boards_controller.rb
 - app/controllers/shiplog/admin/entries/approvals_controller.rb
 - app/controllers/shiplog/admin/entries/discards_controller.rb
+- app/controllers/shiplog/admin/entries/images/moves_controller.rb
+- app/controllers/shiplog/admin/entries/images_controller.rb
 - app/controllers/shiplog/admin/entries/rewrites_controller.rb
+- app/controllers/shiplog/admin/entries/translations/retranslations_controller.rb
+- app/controllers/shiplog/admin/entries/translations_controller.rb
 - app/controllers/shiplog/admin/entries_controller.rb
 - app/controllers/shiplog/admin/inbox_filters.rb
 - app/controllers/shiplog/admin/syncs_controller.rb
 - app/controllers/shiplog/application_controller.rb
+- app/controllers/shiplog/changelog_entries_controller.rb
+- app/controllers/shiplog/changelog_feeds_controller.rb
 - app/controllers/shiplog/changelogs_controller.rb
 - app/controllers/shiplog/frontends_controller.rb
 - app/controllers/shiplog/public_controller.rb
@@ -61,21 +72,38 @@ files:
 - app/helpers/shiplog/application_helper.rb
 - app/helpers/shiplog/callable_helper.rb
 - app/helpers/shiplog/frontend_helper.rb
+- app/helpers/shiplog/head_helper.rb
+- app/helpers/shiplog/head_tags_helper.rb
 - app/helpers/shiplog/host_routes_helper.rb
+- app/helpers/shiplog/permalink_helper.rb
 - app/helpers/shiplog/roadmap_helper.rb
+- app/helpers/shiplog/structured_data_helper.rb
 - app/helpers/shiplog/styling_helper.rb
 - app/helpers/shiplog/switcher_helper.rb
+- app/helpers/shiplog/unseen_helper.rb
 - app/jobs/shiplog/application_job.rb
+- app/jobs/shiplog/detect_areas_job.rb
 - app/jobs/shiplog/refresh_job.rb
 - app/jobs/shiplog/rewrite_entry_job.rb
 - app/jobs/shiplog/scan_changes_job.rb
 - app/jobs/shiplog/sync_job.rb
+- app/jobs/shiplog/translate_area_job.rb
+- app/jobs/shiplog/translate_entry_job.rb
 - app/models/shiplog/application_record.rb
+- app/models/shiplog/area.rb
+- app/models/shiplog/area_detector.rb
+- app/models/shiplog/area_translator.rb
 - app/models/shiplog/board_arrangement.rb
 - app/models/shiplog/change_candidates.rb
 - app/models/shiplog/commit.rb
 - app/models/shiplog/drafter.rb
 - app/models/shiplog/entry.rb
+- app/models/shiplog/entry/images.rb
+- app/models/shiplog/entry_translation.rb
+- app/models/shiplog/image_fetcher.rb
+- app/models/shiplog/image_fetcher/downloader.rb
+- app/models/shiplog/image_fetcher/sources.rb
+- app/models/shiplog/image_type.rb
 - app/models/shiplog/issue.rb
 - app/models/shiplog/issue_form.rb
 - app/models/shiplog/issue_link.rb
@@ -86,17 +114,21 @@ files:
 - app/models/shiplog/rewriter/prompt.rb
 - app/models/shiplog/roadmap.rb
 - app/models/shiplog/roadmap/column_resolver.rb
+- app/models/shiplog/setting.rb
 - app/models/shiplog/sync/commit_scanner.rb
 - app/models/shiplog/sync/issue_importer.rb
 - app/models/shiplog/sync/node_attributes.rb
 - app/models/shiplog/sync/pull_request_importer.rb
 - app/models/shiplog/sync/repository_sync.rb
 - app/models/shiplog/sync/upgrade_detector.rb
+- app/models/shiplog/translator.rb
+- app/models/shiplog/translator/prompt.rb
 - app/models/shiplog/webhook_delivery.rb
 - app/models/shiplog/webhook_signature.rb
 - app/views/layouts/shiplog/admin.html.erb
 - app/views/layouts/shiplog/application.html.erb
 - app/views/shiplog/_empty.html.erb
+- app/views/shiplog/_head_tags.html.erb
 - app/views/shiplog/_page.html.erb
 - app/views/shiplog/_page_header.html.erb
 - app/views/shiplog/_pagination.html.erb
@@ -105,26 +137,39 @@ files:
 - app/views/shiplog/admin/_custom_head.html.erb
 - app/views/shiplog/admin/_nav.html.erb
 - app/views/shiplog/admin/_page.html.erb
+- app/views/shiplog/admin/areas/index.html.erb
 - app/views/shiplog/admin/boards/_card.html.erb
 - app/views/shiplog/admin/boards/show.html.erb
 - app/views/shiplog/admin/entries/_badges.html.erb
 - app/views/shiplog/admin/entries/_entry_row.html.erb
+- app/views/shiplog/admin/entries/_images.html.erb
+- app/views/shiplog/admin/entries/_translations.html.erb
 - app/views/shiplog/admin/entries/edit.html.erb
 - app/views/shiplog/admin/entries/index.html.erb
 - app/views/shiplog/admin/syncs/show.html.erb
+- app/views/shiplog/changelog_entries/show.html.erb
+- app/views/shiplog/changelog_feeds/show.atom.builder
+- app/views/shiplog/changelogs/_areas.html.erb
 - app/views/shiplog/changelogs/_entry.html.erb
+- app/views/shiplog/changelogs/_entry_content.html.erb
 - app/views/shiplog/changelogs/_month.html.erb
 - app/views/shiplog/changelogs/_search.html.erb
 - app/views/shiplog/changelogs/show.html.erb
+- app/views/shiplog/head/_feed.html.erb
+- app/views/shiplog/head/_meta.html.erb
+- app/views/shiplog/head/_open_graph.html.erb
+- app/views/shiplog/head/_structured_data.html.erb
 - app/views/shiplog/roadmaps/_card.html.erb
 - app/views/shiplog/roadmaps/_column.html.erb
 - app/views/shiplog/roadmaps/_shipped.html.erb
 - app/views/shiplog/roadmaps/show.html.erb
 - config/admin_routes.rb
 - config/locales/en.yml
+- config/locales/es.yml
 - config/routes.rb
 - db/migrate/20261026000001_create_shiplog_tables.rb
 - db/migrate/20261027000001_create_shiplog_pull_request_upgrades.rb
+- db/migrate/20261027000002_shiplog_0_3_0.rb
 - lib/generators/shiplog/install/install_generator.rb
 - lib/generators/shiplog/install/templates/initializer.rb.tt
 - lib/generators/shiplog/install/templates/shiplog-feature.yml
@@ -137,6 +182,7 @@ files:
 - lib/shiplog/github/errors.rb
 - lib/shiplog/github/queries.rb
 - lib/shiplog/version.rb
+- lib/tasks/shiplog.rake
 homepage: https://github.com/Trackberry/shiplog
 licenses:
 - MIT