screenkit 0.0.0

data/lib/screenkit/utils.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module Utils
+    def fps(path)
+      cmd = "ffprobe -v error -select_streams v:0 -show_entries " \
+            "stream=r_frame_rate -of default=noprint_wrappers=1:nokey=1"
+      rate = `#{cmd} #{path}`.strip
+
+      if rate.include?("/")
+        numerator, denominator = rate.split("/").map(&:to_f)
+        numerator / denominator
+      else
+        rate.to_f
+      end
+    end
+
+    def duration(path)
+      return 0.0 unless path.file?
+
+      cmd = "ffprobe -v error -show_entries format=duration -of " \
+            "default=noprint_wrappers=1:nokey=1"
+      `#{cmd} #{path}`.strip.to_f
+    end
+
+    def elapsed
+      started = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      result = yield
+      finished = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+      [finished - started, result]
+    end
+
+    def relative_path(path, from: Pathname.pwd)
+      path = Pathname(path)
+      candidate = path.relative_path_from(from)
+      parent = ["..", File::SEPARATOR, ".."].join
+
+      return path.expand_path if candidate.to_s.start_with?(parent)
+
+      candidate
+    end
+
+    def image_size(path, hi_res: true)
+      factor = hi_res ? 2 : 1
+      image = MiniMagick::Image.open(path.to_s)
+      [image.width / factor, image.height / factor]
+    end
+
+    def video_file?(path)
+      ContentType.video.include?(File.extname(path).downcase.delete_prefix("."))
+    end
+
+    def calculate_position(
+      anchor:,
+      margin:,
+      width:,
+      height:,
+      base_width: 1920,
+      base_height: 1080
+    )
+      x = case anchor.horizontal
+          when "left"
+            margin.left
+          when "center"
+            ((base_width - width) / 2.0).round
+          when "right"
+            (base_width - width - margin.right)
+          else
+            0
+          end
+
+      y = case anchor.vertical
+          when "top"
+            margin.top
+          when "center"
+            ((base_height - height) / 2.0).round
+          when "bottom"
+            (base_height - height - margin.bottom)
+          else
+            0
+          end
+
+      [x, y]
+    end
+  end
+end

data/lib/screenkit/version.rb

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

data/lib/screenkit/watermark.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  class Watermark
+    # The path to the watermark image.
+    attr_reader :path
+
+    # The margin spacing for the watermark.
+    attr_reader :margin
+
+    # The anchor position for the watermark.
+    attr_reader :anchor
+
+    # The opacity of the watermark.
+    attr_reader :opacity
+
+    def initialize(value)
+      @path = nil
+      @margin = Spacing.new(100)
+      @anchor = Anchor.new(%w[bottom right])
+      @opacity = 0.1
+
+      case value
+      when String
+        @path = value
+      when Hash
+        @path = value[:path] if value[:path]
+        @margin = Spacing.new(value[:margin]) if value[:margin]
+        @anchor = Anchor.new(value[:anchor]) if value[:anchor]
+        @opacity = value[:opacity] if value[:opacity]
+      end
+    end
+  end
+end

data/lib/screenkit.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "screen_kit"

data/screenkit.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative "lib/screenkit/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "screenkit"
+  spec.version = ScreenKit::VERSION
+  spec.authors = ["Nando Vieira"]
+  spec.email   = ["me@fnando.com"]
+  spec.metadata = {"rubygems_mfa_required" => "true"}
+
+  spec.summary     = "Terminal to screencast, simplified"
+  spec.description = spec.summary
+  spec.license     = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.4.0")
+
+  github_url = "https://github.com/fnando/screenkit"
+  github_tree_url = "#{github_url}/tree/v#{spec.version}"
+
+  spec.homepage = github_url
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{github_url}/issues"
+  spec.metadata["source_code_uri"] = github_tree_url
+  spec.metadata["changelog_uri"] = "#{github_tree_url}/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "#{github_tree_url}/README.md"
+  spec.metadata["license_uri"] = "#{github_tree_url}/LICENSE.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject {|f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aitch"
+  spec.add_dependency "demotape"
+  spec.add_dependency "etc"
+  spec.add_dependency "json-schema"
+  spec.add_dependency "mini_magick"
+  spec.add_dependency "openssl"
+  spec.add_dependency "securerandom"
+  spec.add_dependency "thor"
+  spec.add_dependency "thor-completion"
+  spec.add_dependency "tty-spinner"
+  spec.add_dependency "yaml"
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,426 @@
+--- !ruby/object:Gem::Specification
+name: screenkit
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Nando Vieira
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aitch
+  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: demotape
+  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: etc
+  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: json-schema
+  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: mini_magick
+  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: openssl
+  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: securerandom
+  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: thor
+  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: thor-completion
+  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: tty-spinner
+  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: yaml
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-fnando
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Terminal to screencast, simplified
+email:
+- me@fnando.com
+executables:
+- screenkit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/CODEOWNERS"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/ruby-tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- DOCUMENTATION.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/screenkit
+- lib/screen_kit.rb
+- lib/screenkit.rb
+- lib/screenkit/anchor.rb
+- lib/screenkit/animation_filters.rb
+- lib/screenkit/banner.rb
+- lib/screenkit/callout.rb
+- lib/screenkit/callout/styles/base.rb
+- lib/screenkit/callout/styles/default.rb
+- lib/screenkit/callout/styles/inline_block.rb
+- lib/screenkit/callout/text_style.rb
+- lib/screenkit/cli.rb
+- lib/screenkit/cli/base.rb
+- lib/screenkit/cli/episode.rb
+- lib/screenkit/cli/root.rb
+- lib/screenkit/config/base.rb
+- lib/screenkit/config/episode.rb
+- lib/screenkit/config/project.rb
+- lib/screenkit/content_type.rb
+- lib/screenkit/core_ext/json.rb
+- lib/screenkit/core_ext/string.rb
+- lib/screenkit/exporter/demotape.rb
+- lib/screenkit/exporter/episode.rb
+- lib/screenkit/exporter/image.rb
+- lib/screenkit/exporter/intro.rb
+- lib/screenkit/exporter/outro.rb
+- lib/screenkit/exporter/segment.rb
+- lib/screenkit/exporter/video.rb
+- lib/screenkit/generators/episode.rb
+- lib/screenkit/generators/episode/config.yml.erb
+- lib/screenkit/generators/episode/content/001.tape
+- lib/screenkit/generators/episode/scripts/001.txt
+- lib/screenkit/generators/project.rb
+- lib/screenkit/generators/project/Gemfile.erb
+- lib/screenkit/generators/project/resources/backtracks/default.aac
+- lib/screenkit/generators/project/resources/fonts/opensans/OFL.txt
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-Bold.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-BoldItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-ExtraBold.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-ExtraBoldItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-Italic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-Light.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-LightItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-Medium.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-MediumItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-Regular.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-SemiBold.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans-SemiBoldItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-Bold.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-BoldItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-ExtraBold.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-ExtraBoldItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-Italic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-Light.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-LightItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-Medium.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-MediumItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-Regular.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-SemiBold.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_Condensed-SemiBoldItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-Bold.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-BoldItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-ExtraBold.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-ExtraBoldItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-Italic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-Light.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-LightItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-Medium.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-MediumItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-Regular.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-SemiBold.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/OpenSans_SemiCondensed-SemiBoldItalic.ttf
+- lib/screenkit/generators/project/resources/fonts/opensans/README.txt
+- lib/screenkit/generators/project/resources/images/logo.png
+- lib/screenkit/generators/project/resources/images/watermark.png
+- lib/screenkit/generators/project/resources/sounds/chime.mp3
+- lib/screenkit/generators/project/resources/sounds/pop.mp3
+- lib/screenkit/generators/project/resources/sounds/whoosh.mp3
+- lib/screenkit/generators/project/screenkit.yml
+- lib/screenkit/logfile.rb
+- lib/screenkit/parallel_processor.rb
+- lib/screenkit/path_lookup.rb
+- lib/screenkit/resources/mute.mp3
+- lib/screenkit/resources/transparent.png
+- lib/screenkit/schema_validator.rb
+- lib/screenkit/schemas/callouts/default.json
+- lib/screenkit/schemas/callouts/inline_block.json
+- lib/screenkit/schemas/episode.json
+- lib/screenkit/schemas/project.json
+- lib/screenkit/schemas/refs/anchor.json
+- lib/screenkit/schemas/refs/animation.json
+- lib/screenkit/schemas/refs/background.json
+- lib/screenkit/schemas/refs/callout.json
+- lib/screenkit/schemas/refs/color.json
+- lib/screenkit/schemas/refs/directory.json
+- lib/screenkit/schemas/refs/intro.json
+- lib/screenkit/schemas/refs/logo.json
+- lib/screenkit/schemas/refs/outro.json
+- lib/screenkit/schemas/refs/position.json
+- lib/screenkit/schemas/refs/scenes.json
+- lib/screenkit/schemas/refs/size.json
+- lib/screenkit/schemas/refs/sound.json
+- lib/screenkit/schemas/refs/spacing.json
+- lib/screenkit/schemas/refs/text_style.json
+- lib/screenkit/schemas/refs/transition.json
+- lib/screenkit/schemas/refs/tts.json
+- lib/screenkit/schemas/refs/watermark.json
+- lib/screenkit/schemas/tts/elevenlabs.json
+- lib/screenkit/schemas/tts/say.json
+- lib/screenkit/shell.rb
+- lib/screenkit/sound.rb
+- lib/screenkit/spacing.rb
+- lib/screenkit/spinner.rb
+- lib/screenkit/transition.rb
+- lib/screenkit/tts/eleven_labs.rb
+- lib/screenkit/tts/say.rb
+- lib/screenkit/utils.rb
+- lib/screenkit/version.rb
+- lib/screenkit/watermark.rb
+- screenkit.gemspec
+homepage: https://github.com/fnando/screenkit
+licenses:
+- MIT
+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.0
+  changelog_uri: https://github.com/fnando/screenkit/tree/v0.0.0/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/screenkit/tree/v0.0.0/README.md
+  license_uri: https://github.com/fnando/screenkit/tree/v0.0.0/LICENSE.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Terminal to screencast, simplified
+test_files: []