screenkit 0.0.12 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd0de2fa10f13914e8b0f2b9d8f0f1e295e4d964d54c7e8c045f7a5dc3b7e031
-  data.tar.gz: e16a92ffb88856e3cf482bd9ae1eb5f99d8785a73e632e92b5ad37c688e87f5e
+  metadata.gz: e300f330550b46c23a90c6433c534bb473f65cc71c49c82a97a6d9dde1a35c61
+  data.tar.gz: 8030a806d8daab8ab3df20dfc93b4b315746e330e0c2f11d16ba70725f6f6e21
 SHA512:
-  metadata.gz: b20e2485811c2cd0321251e2e2ea0d7f4402df4979be44bf269ea9fbe71da79d7963146ec39d5634718ef6bc6011887948acafffdcf361c0db172d81455417e6
-  data.tar.gz: 0465a5f3f7b623021b510cd16e8bc927c58e0db8cbc3479363c5b87f5b545d43f969866244ea862875f3f65f4596fa02b223e22fe1056afd0acc50a832c1cab0
+  metadata.gz: ad8cdfd064da26fff6013df15e41562fb8b9463493dcc26510a5f48ddf4880c1b55bcf566c82c34ff1abd77b8102d93092283b4987ff8f62d19b33249e1e6e8b
+  data.tar.gz: 9b9302661f3b0c65a7b4c365a516b2833297d2fc683a2d6d75c84e051bfa70cc1daeeb0b22aa4f53be4aad8597604944100646a4a6d96935092b49f77a2a9b3e

data/CHANGELOG.md

@@ -11,6 +11,16 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## v0.0.14
+
+- [Fixed] Fix file redacting when no API key is defined.
+- [Fixed] Trim transparent pixels from rendered text.
+- [Fixed] Allow concurrency to be specified when generating voiceover.
+
+## v0.0.13
+
+- [Fixed] Redact API key in config log.
+
 ## v0.0.12
 
 - [Fixed] Fix how configuration is merged.

data/DOCUMENTATION.md

@@ -114,8 +114,6 @@ $ docker run \
 Notice that Chrome requires a lot of memory, so you need `--shm-size=2g` (or
 more).
 
-To create a new project:
-
 ---
 
 ## Quick Start
@@ -958,7 +956,7 @@ The engine name is camelized (e.g., `custom_engine` → `CustomEngine`,
 
 > [!TIP]
 >
-> If you host your TTS engine on Github, use the topic `screekit-tts`, so other
+> If you host your TTS engine on Github, use the topic `screenkit-tts`, so other
 > people can find it.
 
 ---
@@ -1320,9 +1318,10 @@ bundle exec screenkit ...
 
 #### TTS not working
 
-- For ElevenLabs: Set `--tts-api-key`
-- For macOS `say`: Verify voice name with `say -v ?`
-- For `espeak`: Ensure `espeak` is installed and in PATH
+- For ElevenLabs: set `--tts-api-key` with valid prefixed key, like
+  `eleven_labs:API_KEY`
+- For macOS `say`: verify voice name with `say -v ?`
+- For `espeak`: ensure `espeak` is installed and in PATH
 
 #### Playwright scripts not working
 

data/lib/screenkit/cli/episode.rb

@@ -69,15 +69,23 @@ module ScreenKit
       def export
         puts Banner.banner if options.banner
 
-        project_config = if File.file?(options.config)
+        episode_config_path = File.join(options.dir, "config.yml")
+        has_project_config = File.file?(options.config)
+        has_episode_config = File.file?(episode_config_path)
+
+        if !has_project_config && !has_episode_config
+          shell.say "Error: No configuration file found.", :red
+          exit 1
+        end
+
+        project_config = if has_project_config
                            Config.load_yaml_file(options.config)
                          else
                            {}
                          end
 
-        episode_config = File.join(options.dir, "config.yml")
-        episode_config = if File.file?(episode_config)
-                           Config.load_yaml_file(episode_config)
+        episode_config = if has_episode_config
+                           Config.load_yaml_file(episode_config_path)
                          else
                            {}
                          end
@@ -95,6 +103,14 @@ module ScreenKit
         )
 
         exporter.export
+      ensure
+        exporter.output_dir.join("logs").glob("*.txt").each do |path|
+          redact_file(path, options.tts_api_key)
+        end
+      end
+
+      no_commands do
+        include RedactFile
       end
     end
   end

data/lib/screenkit/exporter/episode.rb

@@ -4,6 +4,7 @@ module ScreenKit
   module Exporter
     class Episode
       using CoreExt
+      include RedactFile
       include Utils
       include Shell
 
@@ -148,7 +149,8 @@ module ScreenKit
           spinner:,
           list: filtered_segments,
           message: "Exporting voiceovers (%{progress}/%{count})",
-          log_path: logfile.create("%{prefix}", :voiceover)
+          log_path: logfile.create("%{prefix}", :voiceover),
+          concurrency: tts_engine.concurrency
         ).run(&:export_voiceover)
 
         log_elapsed("Generated voiceover in %{elapsed}", elapsed)
@@ -188,7 +190,7 @@ module ScreenKit
                            source.search(watermark.path)
                          else
                            ScreenKit.root_dir
-                                    .join("screenkit/resources/transparent.png")
+                                    .join("resources/transparent.png")
                          end
 
         watermark_width, watermark_height = image_size(watermark_path)
@@ -401,10 +403,11 @@ module ScreenKit
 
       # Logs initial information about the episode export process.
       def prelude
-        logfile.json_log(
+        path = logfile.json_log(
           :config,
-          options.merge(pwd: Dir.pwd, config:)
+          options.merge(pwd: Dir.pwd, config: config.as_json)
         )
+        redact_file(path, options.tts_api_key)
 
         log(
           :info,

data/lib/screenkit/exporter/segment.rb

@@ -74,7 +74,7 @@ module ScreenKit
             .new(
               script_path: content_path,
               options: episode.playwright_options,
-              log_path:,
+              log_path:
             )
             .export(video_path)
         when *ContentType.video

data/lib/screenkit/http.rb

@@ -2,7 +2,10 @@
 
 module ScreenKit
   module HTTP
+    include RedactFile
+
     # Sends a POST request.
+    #
     # @param url [String] The request URL.
     # @param params [Hash] The request parameters.
     # @param headers [Hash] The request headers.
@@ -32,6 +35,7 @@ module ScreenKit
     end
 
     # Sends a JSON POST request.
+    #
     # @param url [String] The request URL.
     # @param params [Hash] The request parameters.
     # @param headers [Hash] The request headers.
@@ -42,17 +46,5 @@ module ScreenKit
       headers = headers.merge(content_type: "application/json")
       post(headers:, **)
     end
-
-    # Redacts sensitive text from a file.
-    # @param path [String] The file path.
-    # @param text [String] The text to redact.
-    # @return [void]
-    def redact_file(path, text)
-      return unless path
-      return unless File.file?(path)
-
-      content = File.read(path).gsub(text, "[REDACTED]")
-      File.write(path, content)
-    end
   end
 end

data/lib/screenkit/image_magick.rb

@@ -94,6 +94,8 @@ module ScreenKit
         image << "-pointsize"
         image << style.size.to_s
         image << "#{type}:#{escape_text_for_image(text)}"
+        image << "-trim"
+        image << "+repage"
         image << "PNG:#{path}"
       end
 

data/lib/screenkit/logfile.rb

@@ -23,6 +23,7 @@ module ScreenKit
       path = create(*args)
       FileUtils.mkdir_p(File.dirname(path))
       File.open(path, "w") { it << message.to_s }
+      path
     end
 
     def json_log(*args)

data/lib/screenkit/parallel_processor.rb

@@ -2,10 +2,11 @@
 
 module ScreenKit
   class ParallelProcessor
-    attr_reader :spinner, :list, :message, :mutex, :count, :log_path
+    attr_reader :spinner, :list, :message, :mutex, :count, :log_path,
+                :concurrency
     attr_accessor :progress
 
-    def initialize(spinner:, list:, message:, log_path: nil)
+    def initialize(spinner:, list:, message:, log_path: nil, concurrency: nil)
       @list = list
       @message = message
       @spinner = spinner
@@ -13,6 +14,7 @@ module ScreenKit
       @progress = 0
       @count = list.size
       @log_path = log_path
+      @concurrency = concurrency || Etc.nprocessors
     end
 
     def run(&block)
@@ -20,7 +22,7 @@ module ScreenKit
       indexed_list = list.map.with_index {|item, index| [item, index] }
       arity = block.arity
 
-      indexed_list.each_slice(Etc.nprocessors) do |slice|
+      indexed_list.each_slice(concurrency) do |slice|
         threads = slice.map do |args|
           thread = Thread.new do
             update_message

data/lib/screenkit/redact_file.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module RedactFile
+    # Redacts sensitive text from a file.
+    # @param path [String] The file path.
+    # @param text [String] The text to redact.
+    # @return [void]
+    def redact_file(path, text)
+      return unless path
+      return unless File.file?(path)
+      return if text.to_s.strip.empty?
+
+      content = File.read(path).gsub(text, "[REDACTED]")
+      File.write(path, content)
+    end
+  end
+end

data/lib/screenkit/tts/base.rb

@@ -55,6 +55,10 @@ module ScreenKit
 
         @api_key = api_key.delete_prefix("#{self.class.engine_name}:")
       end
+
+      def concurrency
+        # to be implemented by subclasses if applicable
+      end
     end
   end
 end

data/lib/screenkit/tts/eleven_labs.rb

@@ -14,6 +14,10 @@ module ScreenKit
         api_key.to_s.start_with?(api_key_prefix)
       end
 
+      def concurrency
+        3
+      end
+
       def all_texts
         @all_texts ||= segments.map(&:script_content)
       end

data/lib/screenkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ScreenKit
-  VERSION = "0.0.12"
+  VERSION = "0.0.14"
 end

data/lib/screenkit.rb

@@ -18,6 +18,7 @@ module ScreenKit
   require_relative "screenkit/duration"
   require_relative "screenkit/core_ext"
   require_relative "screenkit/content_type"
+  require_relative "screenkit/redact_file"
   require_relative "screenkit/anchor"
   require_relative "screenkit/banner"
   require_relative "screenkit/time_formatter"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: screenkit
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.14
 platform: ruby
 authors:
 - Nando Vieira
@@ -348,6 +348,7 @@ files:
 - lib/screenkit/logfile.rb
 - lib/screenkit/parallel_processor.rb
 - lib/screenkit/path_lookup.rb
+- lib/screenkit/redact_file.rb
 - lib/screenkit/resources/callout_styles/social/blog.png
 - lib/screenkit/resources/callout_styles/social/bsky.png
 - lib/screenkit/resources/callout_styles/social/discord.png
@@ -420,10 +421,10 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/fnando/screenkit
   bug_tracker_uri: https://github.com/fnando/screenkit/issues
-  source_code_uri: https://github.com/fnando/screenkit/tree/v0.0.12
-  changelog_uri: https://github.com/fnando/screenkit/tree/v0.0.12/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/screenkit/tree/v0.0.12/README.md
-  license_uri: https://github.com/fnando/screenkit/tree/v0.0.12/LICENSE.md
+  source_code_uri: https://github.com/fnando/screenkit/tree/v0.0.14
+  changelog_uri: https://github.com/fnando/screenkit/tree/v0.0.14/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/screenkit/tree/v0.0.14/README.md
+  license_uri: https://github.com/fnando/screenkit/tree/v0.0.14/LICENSE.md
 rdoc_options: []
 require_paths:
 - lib