shoko 0.1.3 → 0.1.5

data/lib/shoko/core/ports/outbound/progress_repository.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Port interface for persisted reading progress.
+        module ProgressRepository
+          # @param book_path [String]
+          # @param chapter_index [Integer]
+          # @param line_offset [Integer]
+          # @return [Core::Models::ReadingProgress]
+          def save_for_book(book_path, chapter_index:, line_offset:)
+            raise NotImplementedError, "#{self.class} must implement #save_for_book"
+          end
+
+          # @param book_path [String]
+          # @return [Core::Models::ReadingProgress, nil]
+          def find_by_book_path(book_path)
+            raise NotImplementedError, "#{self.class} must implement #find_by_book_path"
+          end
+
+          # @return [Hash<String, Core::Models::ReadingProgress>]
+          def find_all
+            raise NotImplementedError, "#{self.class} must implement #find_all"
+          end
+
+          # @param book_path [String]
+          # @return [Boolean]
+          def exists_for_book?(book_path)
+            raise NotImplementedError, "#{self.class} must implement #exists_for_book?"
+          end
+
+          # @param book_path [String]
+          # @return [Time, nil]
+          def last_updated_at(book_path)
+            raise NotImplementedError, "#{self.class} must implement #last_updated_at"
+          end
+
+          # @param limit [Integer, nil]
+          # @return [Array<String>]
+          def recent_books(limit: nil)
+            raise NotImplementedError, "#{self.class} must implement #recent_books"
+          end
+
+          # @param book_path [String]
+          # @param chapter_index [Integer]
+          # @param line_offset [Integer]
+          # @return [Core::Models::ReadingProgress]
+          def save_if_further(book_path, chapter_index:, line_offset:)
+            raise NotImplementedError, "#{self.class} must implement #save_if_further"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/reader_chapter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Strict chapter contract used by reader domain services.
+        module ReaderChapter
+          def title
+            raise NotImplementedError, "#{self.class} must implement #title"
+          end
+
+          def lines
+            raise NotImplementedError, "#{self.class} must implement #lines"
+          end
+
+          def metadata
+            raise NotImplementedError, "#{self.class} must implement #metadata"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/reader_document.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Strict reader document contract used by core/application services.
+        module ReaderDocument
+          def canonical_path
+            raise NotImplementedError, "#{self.class} must implement #canonical_path"
+          end
+
+          def cached?
+            raise NotImplementedError, "#{self.class} must implement #cached?"
+          end
+
+          def chapter_count
+            raise NotImplementedError, "#{self.class} must implement #chapter_count"
+          end
+
+          def get_chapter(_index)
+            raise NotImplementedError, "#{self.class} must implement #get_chapter"
+          end
+
+          def toc_entries
+            raise NotImplementedError, "#{self.class} must implement #toc_entries"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/reader_intent_executor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Outbound contract used by application intent handlers to execute reader intents.
+        module ReaderIntentExecutor
+          def execute(intent_symbol:, payload: nil)
+            raise NotImplementedError, "#{self.class} must implement #execute"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/reader_launch_state.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Runtime launch-state contract for reader bootstrap/workflow handoff.
+        module ReaderLaunchState
+          def preloaded_document
+            raise NotImplementedError, "#{self.class} must implement #preloaded_document"
+          end
+
+          def set_preloaded_document(_document)
+            raise NotImplementedError, "#{self.class} must implement #set_preloaded_document"
+          end
+
+          def clear_preloaded_document
+            raise NotImplementedError, "#{self.class} must implement #clear_preloaded_document"
+          end
+
+          def background_worker
+            raise NotImplementedError, "#{self.class} must implement #background_worker"
+          end
+
+          def set_background_worker(_worker)
+            raise NotImplementedError, "#{self.class} must implement #set_background_worker"
+          end
+
+          def clear_background_worker
+            raise NotImplementedError, "#{self.class} must implement #clear_background_worker"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/reader_navigation_reader.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Application-facing contract for reader pagination/navigation reads.
+        module ReaderNavigationReader
+          def current_chapter
+            raise NotImplementedError, "#{self.class} must implement #current_chapter"
+          end
+
+          def total_chapters
+            raise NotImplementedError, "#{self.class} must implement #total_chapters"
+          end
+
+          def current_page_index
+            raise NotImplementedError, "#{self.class} must implement #current_page_index"
+          end
+
+          def left_page
+            raise NotImplementedError, "#{self.class} must implement #left_page"
+          end
+
+          def right_page
+            raise NotImplementedError, "#{self.class} must implement #right_page"
+          end
+
+          def single_page
+            raise NotImplementedError, "#{self.class} must implement #single_page"
+          end
+
+          def current_page
+            raise NotImplementedError, "#{self.class} must implement #current_page"
+          end
+
+          def page_map
+            raise NotImplementedError, "#{self.class} must implement #page_map"
+          end
+
+          def total_pages
+            raise NotImplementedError, "#{self.class} must implement #total_pages"
+          end
+
+          def pending_progress
+            raise NotImplementedError, "#{self.class} must implement #pending_progress"
+          end
+
+          def book_path
+            raise NotImplementedError, "#{self.class} must implement #book_path"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/reader_render_requester.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Port for requesting a reader render pass from application orchestration.
+        module ReaderRenderRequester
+          class RenderRequestError < StandardError; end
+
+          def request_render(reason:)
+            raise NotImplementedError, "#{self.class} must implement #request_render"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/reader_runner.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Boundary for launching reader mode with a resolved path.
+        module ReaderRunner
+          def run_reader(path)
+            raise NotImplementedError, "#{self.class} must implement #run_reader"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/reader_state_writer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Application-facing contract for reader state mutations.
+        module ReaderStateWriter
+          def update_reader(attrs)
+            raise NotImplementedError, "#{self.class} must implement #update_reader"
+          end
+
+          def update_navigation(attrs)
+            raise NotImplementedError, "#{self.class} must implement #update_navigation"
+          end
+
+          def update_bookmarks(bookmarks)
+            raise NotImplementedError, "#{self.class} must implement #update_bookmarks"
+          end
+
+          def update_sidebar(attrs)
+            raise NotImplementedError, "#{self.class} must implement #update_sidebar"
+          end
+
+          def update_config(attrs)
+            raise NotImplementedError, "#{self.class} must implement #update_config"
+          end
+
+          def clear_selection
+            raise NotImplementedError, "#{self.class} must implement #clear_selection"
+          end
+
+          def quit_to_menu
+            raise NotImplementedError, "#{self.class} must implement #quit_to_menu"
+          end
+
+          def update_reader_meta(attrs)
+            raise NotImplementedError, "#{self.class} must implement #update_reader_meta"
+          end
+
+          def update_terminal_size(width, height)
+            raise NotImplementedError, "#{self.class} must implement #update_terminal_size"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/recent_files_repository.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Port interface for managing recent file history.
+        module RecentFilesRepository
+          # Add a recent file path.
+          def add(path)
+            raise NotImplementedError, "#{self.class} must implement #add"
+          end
+
+          # Load recent file entries.
+          def load
+            raise NotImplementedError, "#{self.class} must implement #load"
+          end
+
+          # Clear recent file history.
+          def clear
+            raise NotImplementedError, "#{self.class} must implement #clear"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/render_state_writer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Port interface for render-related state updates.
+        module RenderStateWriter
+          # Clear rendered lines at the start of a new frame.
+          def clear_rendered_lines
+            raise NotImplementedError, "#{self.class} must implement #clear_rendered_lines"
+          end
+
+          # Update rendered lines after rendering completes.
+          def update_rendered_lines(rendered_lines)
+            raise NotImplementedError, "#{self.class} must implement #update_rendered_lines"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/rendered_content_reader.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Port interface for reading rendered content state.
+        # Adapters implementing this interface provide access to rendered lines
+        # without coupling core services to application state selectors.
+        #
+        # @example Implementing this port
+        #   class RenderedContentReaderAdapter
+        #     include Shoko::Core::Ports::Outbound::RenderedContentReader
+        #
+        #     def initialize(state)
+        #       @state = state
+        #     end
+        #
+        #     def rendered_lines
+        #       ReaderSelectors.rendered_lines(@state)
+        #     end
+        #   end
+        module RenderedContentReader
+          # Get the currently rendered lines
+          #
+          # @return [Array] Array of rendered line data
+          def rendered_lines
+            raise NotImplementedError, "#{self.class} must implement #rendered_lines"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/runtime_config.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Port interface for process-level runtime configuration.
+        # Implementations adapt environment variables or other runtime sources.
+        module RuntimeConfig
+          # @return [Boolean]
+          def skip_progress_overlay?
+            raise NotImplementedError, "#{self.class} must implement #skip_progress_overlay?"
+          end
+
+          # @return [String, nil] e.g. "sqlite"
+          def dictionary_backend_override
+            raise NotImplementedError, "#{self.class} must implement #dictionary_backend_override"
+          end
+
+          # @return [Integer]
+          def rexml_entity_expansion_limit
+            raise NotImplementedError, "#{self.class} must implement #rexml_entity_expansion_limit"
+          end
+
+          # @return [Integer]
+          def rexml_entity_expansion_text_limit
+            raise NotImplementedError, "#{self.class} must implement #rexml_entity_expansion_text_limit"
+          end
+
+          # @return [Boolean]
+          def debug_perf_enabled?
+            raise NotImplementedError, "#{self.class} must implement #debug_perf_enabled?"
+          end
+
+          # @return [Boolean]
+          def text_metrics_cache_disabled?
+            raise NotImplementedError, "#{self.class} must implement #text_metrics_cache_disabled?"
+          end
+
+          # @return [Boolean]
+          def wrap_plain_text_cache_disabled?
+            raise NotImplementedError, "#{self.class} must implement #wrap_plain_text_cache_disabled?"
+          end
+
+          # @return [Boolean]
+          def text_metrics_ascii_fast_path_disabled?
+            raise NotImplementedError, "#{self.class} must implement #text_metrics_ascii_fast_path_disabled?"
+          end
+
+          # @return [Boolean]
+          def wrapping_window_range_cache_disabled?
+            raise NotImplementedError, "#{self.class} must implement #wrapping_window_range_cache_disabled?"
+          end
+
+          # @return [Boolean]
+          def fast_manifest_lookup_disabled?
+            raise NotImplementedError, "#{self.class} must implement #fast_manifest_lookup_disabled?"
+          end
+
+          # @return [Boolean]
+          def manifest_rows_cache_disabled?
+            raise NotImplementedError, "#{self.class} must implement #manifest_rows_cache_disabled?"
+          end
+
+          # @return [Boolean]
+          def line_assembler_tokenize_cache_disabled?
+            raise NotImplementedError, "#{self.class} must implement #line_assembler_tokenize_cache_disabled?"
+          end
+
+          # @return [Boolean]
+          def line_assembler_token_width_hints_disabled?
+            raise NotImplementedError, "#{self.class} must implement #line_assembler_token_width_hints_disabled?"
+          end
+
+          # @return [Boolean]
+          def fast_ascii_frame_write_disabled?
+            raise NotImplementedError, "#{self.class} must implement #fast_ascii_frame_write_disabled?"
+          end
+
+          # @return [Boolean]
+          def line_content_compose_cache_disabled?
+            raise NotImplementedError, "#{self.class} must implement #line_content_compose_cache_disabled?"
+          end
+
+          # @return [Boolean]
+          def line_geometry_cell_cache_disabled?
+            raise NotImplementedError, "#{self.class} must implement #line_geometry_cell_cache_disabled?"
+          end
+
+          # @return [Boolean]
+          def debug_geometry_enabled?
+            raise NotImplementedError, "#{self.class} must implement #debug_geometry_enabled?"
+          end
+
+          # @return [Integer]
+          def zip_max_entry_uncompressed_bytes
+            raise NotImplementedError, "#{self.class} must implement #zip_max_entry_uncompressed_bytes"
+          end
+
+          # @return [Integer]
+          def zip_max_entry_compressed_bytes
+            raise NotImplementedError, "#{self.class} must implement #zip_max_entry_compressed_bytes"
+          end
+
+          # @return [Integer]
+          def zip_max_total_uncompressed_bytes
+            raise NotImplementedError, "#{self.class} must implement #zip_max_total_uncompressed_bytes"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/sidebar_state_reader.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Application-facing contract for sidebar state reads.
+        module SidebarStateReader
+          def sidebar_visible?
+            raise NotImplementedError, "#{self.class} must implement #sidebar_visible?"
+          end
+
+          def sidebar_active_tab
+            raise NotImplementedError, "#{self.class} must implement #sidebar_active_tab"
+          end
+
+          def sidebar_toc_selected
+            raise NotImplementedError, "#{self.class} must implement #sidebar_toc_selected"
+          end
+
+          def sidebar_toc_collapsed
+            raise NotImplementedError, "#{self.class} must implement #sidebar_toc_collapsed"
+          end
+
+          def sidebar_bookmarks_selected
+            raise NotImplementedError, "#{self.class} must implement #sidebar_bookmarks_selected"
+          end
+
+          def sidebar_annotations_selected
+            raise NotImplementedError, "#{self.class} must implement #sidebar_annotations_selected"
+          end
+
+          def sidebar_prev_view_mode
+            raise NotImplementedError, "#{self.class} must implement #sidebar_prev_view_mode"
+          end
+
+          def sidebar_toc_filter
+            raise NotImplementedError, "#{self.class} must implement #sidebar_toc_filter"
+          end
+
+          def sidebar_toc_filter_active?
+            raise NotImplementedError, "#{self.class} must implement #sidebar_toc_filter_active?"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/terminal_capabilities.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Port interface for detecting terminal hardware capabilities.
+        # Abstracts the detection of terminal features like Kitty graphics protocol,
+        # separating hardware detection from configuration state.
+        #
+        # Note: This is distinct from DisplayCapabilities which checks if features
+        # are ENABLED in configuration. TerminalCapabilities detects if the
+        # terminal SUPPORTS the features at a hardware/protocol level.
+        #
+        # @example Implementing this port
+        #   class TerminalCapabilitiesAdapter
+        #     include Shoko::Core::Ports::Outbound::TerminalCapabilities
+        #
+        #     def kitty_graphics_supported?
+        #       ENV.key?('KITTY_WINDOW_ID')
+        #     end
+        #   end
+        module TerminalCapabilities
+          # Check if the terminal supports Kitty graphics protocol.
+          # This is a hardware/environment detection, not a config check.
+          #
+          # @return [Boolean] True if Kitty graphics are supported
+          def kitty_graphics_supported?
+            raise NotImplementedError, "#{self.class} must implement #kitty_graphics_supported?"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/terminal_session.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Runtime boundary for terminal session lifecycle operations.
+        module TerminalSession
+          def setup
+            raise NotImplementedError, "#{self.class} must implement #setup"
+          end
+
+          def cleanup
+            raise NotImplementedError, "#{self.class} must implement #cleanup"
+          end
+
+          def size
+            raise NotImplementedError, "#{self.class} must implement #size"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/text_metrics.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Port interface for text measurement and wrapping.
+        module TextMetrics
+          # Wrap a plain text line to the given width.
+          #
+          # @param line [String] input line
+          # @param width [Integer] maximum line width
+          # @return [Array<String>] wrapped segments
+          def wrap_plain_text(_line, _width)
+            raise NotImplementedError, "#{self.class} must implement #wrap_plain_text"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/text_sanitizer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Port interface for sanitizing text for safe display.
+        # Adapters implementing this interface should handle removing
+        # or replacing control characters and unsafe content.
+        module TextSanitizer
+          # Sanitize text for safe display
+          #
+          # @param text [String] Text to sanitize
+          # @param preserve_newlines [Boolean] Whether to keep newline characters
+          # @param max_length [Integer, nil] Maximum output length (nil for unlimited)
+          # @return [String] Sanitized text
+          def sanitize(text, preserve_newlines: true, max_length: nil)
+            raise NotImplementedError, "#{self.class} must implement #sanitize"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoko/core/ports/outbound/ui_loading_writer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Shoko
+  module Core
+    module Ports
+      module Outbound
+        # Application-facing contract for mutating transient UI loading state.
+        module UiLoadingWriter
+          def update_ui_loading(attrs)
+            raise NotImplementedError, "#{self.class} must implement #update_ui_loading"
+          end
+        end
+      end
+    end
+  end
+end