fli_video 0.0.2 → 0.1.0

data/.builders/klues/recording_filename.klue

@@ -0,0 +1,112 @@
+component :recording_filename do
+  desc "Calculate the next video recording file name based on chapter sequence, part number, chapter name, and tags if available."
+
+  pattern "Adapter"
+
+  comments <<~TEXT
+    - File name construction for new and existing video recordings.
+    - Utilizes the chapter and part sequence for systematic naming.
+    - Incorporates the chapter name for descriptive clarity.
+    - Has support for tags in the file name to aid content identification and post-processing workflows.
+    - Set episode & project via the episode if recording belongs to an episode
+    - Set project if recording belongs to a project
+    - Parent returns episode || project
+  TEXT
+
+  accessors :chapter_seq, :part_seq, :chapter_name, :tags, :filename, :episode, :project, :parent
+
+  method :constructor(:chapter_seq, :part_seq, :chapter_name, tags: [], parent: nil)
+  method :instance(:full_path)
+
+  # Use the current chapter sequence if not provided
+  # Part sequence will increment based on the previous part letter in the chapter if not provided
+  # Chapter name will defaults to previous recording chapter name if not provided
+  method :next_filename(:previous_filename, chapter_name: nil, tags: [], chapter_seq: nil, part_seq: nil)
+  method :update_chapter_sequence(:current_chapter_seq, :new_chapter_seq)
+  method :resequence_chapters(:starting_chapter_seq)
+  method :update_tags(:new_tags)
+
+  sample :create_recording_filename, <<~RUBY
+    project_path = ProjectPath.new('a27')
+    project_path.project_path # => "~/video-projects/a27-ac-categorize-mp4-CI"
+
+    # Generate a filename for a new video recording
+    filename1 = RecordingFilename.new(1, 'a' 'introduction', tags: [], parent: project_path)
+    filename1.filename # => "01-a-introduction.mov"
+    filename1.chapter_seq # => 1
+    filename1.part_seq # => "a"
+    filename1.chapter_name # => "introduction"
+    filename1.tags # => []
+    filename1.full_path # => "~/video-projects/a27-ac-categorize-mp4-CI/01-a-introduction.mov"
+  RUBY
+
+  sample :next_recording_filename, <<~RUBY
+    filename1 = "~/video-projects/a27-ac-categorize-mp4-CI/01-a-introduction.mov"
+
+    project = ProjectConfig.new('a27')
+
+    # Class method to generate a filename for a new video recording
+    filename2 = RecordingFilename.next_filename(filename1, chapter_name: 'introduction-more-content', tags: ['GPTIMPROVE'])
+
+    # Fluent method to generate a filename for a new video recording
+    filename3 = filename2.next_filename(chapter_name: 'introduction')
+    filename4 = filename3.next_filename(tags: ['CTA'])
+
+    project.next_chapter('overview')
+
+    filename5 = RecordingFilename.next_filename(project.last_file)
+
+    project.next_chapter('scenario')
+
+    filename6 = RecordingFilename.next_filename(project.last_file, tags: ['TITLE'])
+
+    filename1.filename # => "01-a-introduction-GPTIMPROVE.mov"      # Send transcription to GPT Bot for improvement
+    filename2.filename # => "01-b-introduction-more-content.mov"
+    filename3.filename # => "01-c-introduction.mov"
+    filename4.filename # => "01-d-introduction-CTA.mov"             # Instruction for video editor to add a CTA
+    filename5.filename # => "02-a-overview.mov"
+    filename6.filename # => "03-a-scenario-TITLE.mov"               # Instruction for video editor to add a title slide
+  RUBY
+
+  sample :file_to_recording_filename, <<~RUBY
+    # Convert absolute file to recording filename
+    filename = RecordingFilename.instance('~/video-projects/a27-ac-categorize-mp4-CI/01-a-introduction.mov')
+
+    filename.filename # => "01-a-introduction.mov"
+    filename.chapter_seq # => 1
+    filename.part_seq # => "a"
+    filename.chapter_name # => "introduction"
+    filename.tags # => []
+    filename.full_path # => "~/video-projects/a27-ac-categorize-mp4-CI/01-a-introduction.mov"
+  RUBY
+
+  sample :rename_recording_filename, <<~RUBY
+    filename = RecordingFilename.instance('~/video-projects/a27-ac-categorize-mp4-CI/01-a-introduction.mov')
+    filename.filename # => "01-a-introduction.mov"
+
+    filename.change_filename(chapter_name: 'introduction-trim-23s', tags: ['GPTDALE3'])
+    filename.filename # => "01-a-introduction-trim-23s-GPTDALE3.mov"
+  RUBY
+
+  sample :update_chapter_sequence, <<~RUBY
+    project_path = ProjectPath.new('a27')
+
+    # Update chapter sequence in a project
+    filename = RecordingFilename.new(2, 'b', 'overview', parent: project_path)
+    filename.update_chapter_sequence(2, 3)
+    filename.filename # => "03-b-overview.mov"
+  RUBY
+
+  sample :resequence_chapters, <<~RUBY
+    # Resequence chapters starting from a given sequence
+    filename.resequence_chapters(2)
+    # Adjusts chapter sequence of all subsequent chapters starting from '02'
+  RUBY
+
+  sample :update_tags, <<~RUBY
+    # Update tags for a recording
+    filename = RecordingFilename.new(1, 'a', 'introduction', tags: ['OLD_TAG'], parent: project_path)
+    filename.update_tags(['NEW_TAG'])
+    filename.filename # => "01-a-introduction-NEW_TAG.mov"
+  RUBY
+end

data/.builders/klues/restore_from_trash.klue

@@ -0,0 +1,29 @@
+component :restore_from_trash do
+  desc "Retrieve video takes from '.trash' folder and move them back to the project folder."
+
+  pattern "Command"
+
+  comments <<~TEXT
+    - Restores a specific recording from the trash to the project folder.
+    - If no specific recording is provided, restores the most recently trashed recording.
+    - Facilitates reconsideration or re-evaluation of previously discarded content.
+  TEXT
+
+  constructor(:parent_project)
+
+  method :run(:file_name)
+
+  sample :restore_from_trash, <<~RUBY
+    project_path = ProjectPath.new('a27')
+
+    command = undo_trash.new(project_path)
+
+    # Example of restoring a specific recording from the trash folder
+    command.run('01-a-introduction.mov')
+    # => "~/video-projects/a27-ac-categorize-mp4-CI/01-a-introduction.mov"
+
+    # Example of restoring the most recently trashed recording
+    command.run
+    # => "~/video-projects/a27-ac-categorize-mp4-CI/Ecamm Live Recording on 2023-08-25 at 14.51.58.mov"
+  RUBY
+end

data/.builders/klues/switch_focus.klue

@@ -0,0 +1,24 @@
+component :change_focus do
+  desc "Easily switch between different video projects or episodes to accommodate changing content priorities."
+
+  pattern "Interactor"
+
+  comments <<~TEXT
+    - Allows switching the focus to a different video project or a specific episode within a podcast.
+    - Video recordings belong to a specific project or episode and this interaction ensures that the correct project or episode is in focus.
+    - Ensures seamless transition and updates the working context to the selected project or episode.
+    - Maintains state consistency across switches using the global configuration.
+  TEXT
+
+  method :run(:project_code, episode_code: nil)
+
+  sample :switch_focus_to_video_project, <<~RUBY
+    # Switch focus to a different video project
+    change_focus.run('a20')
+  RUBY
+
+  sample :switch_focus_to_podcast_episode, <<~RUBY
+    # Switch focus to a specific episode within a podcast project
+    change_focus.run('a21', '02')
+  RUBY
+end

data/.builders/klues/text_to_speech.klue

@@ -0,0 +1,29 @@
+component :text_to_speech do
+  desc "Transcribe spoken content to text and store in multiple transcription formats."
+
+  pattern "Command"
+
+  comments <<~TEXT
+    - Transcribes audio content from videos into text.
+    - Supports storing transcriptions in various formats for accessibility and further processing.
+    - Uses the transcript folder under the recording, chapter or post-production folder and stores the transcriptions in a subfolder called 'transcript'.
+  TEXT
+
+  constructor(:parent_project)
+
+  method :run(:recording_file, output_formats:)
+
+  sample :transcribe_audio_to_text, <<~RUBY
+    project_path = ProjectPath.new('a27')
+
+    # ~/video-projects/a27-ac-categorize-mp4-CI/01-a-introduction.mov
+    # Instantiate the component with the parent project
+    tts = text_to_speech.new(project_path)
+
+    # Execute the transcription against
+    tts.run('01-introduction.mov', output_formats: ['txt', 'srt', 'vtt', 'json', 'tsv'])
+
+    # Transcribes '01-introduction.mov' and stores the transcriptions in the specified formats
+    # Output: Transcriptions saved in '~/video-projects/a27-ac-categorize-mp4-CI/recordings/transcript/01-introduction.txt|srt|vtt|json|tsv'
+  RUBY
+end

data/.builders/klues/transcript_data_store.klue

@@ -0,0 +1,28 @@
+component :transcript_data_store do
+  desc "Build a JSON datastore of transcripts for an entire project."
+
+  pattern "Command"
+
+  comments <<~TEXT
+    - Aggregates transcripts from various project levels into a single JSON datastore.
+    - Scans project, episode, recording, chapter, and post-produced folders for existing transcripts.
+    - Facilitates easy access and management of transcript data across the entire project.
+    - Enhances data retrieval and analysis capabilities for the project's transcripts.
+    - Stores data in a JSON file called 'transcripts.json' in the project folder.
+  TEXT
+
+  constructor(:parent_project)
+
+  method :run
+
+  sample :build_transcript_datastore, <<~RUBY
+    project_path = ProjectPath.new('a27')
+
+    # Instantiate the component with the parent project
+    transcript_store = transcript_data_store.new(project_path)
+
+    # Execute the process to aggregate and store transcript data
+    transcript_store.run
+    # Output: '~/video-projects/a27-ac-categorize-mp4-CI/project_transcripts.json'
+  RUBY
+end

data/.rubocop.yml

@@ -14,6 +14,8 @@ AllCops:
   Exclude:
     - ".builders/**/*"
     - "spec/samples/**/*"
+    - "scripts/**/*"
+    - "fli.rb"
 
 Metrics/BlockLength:
   Exclude:

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [0.0.2](https://github.com/klueless-io/fli_video/compare/v0.0.1...v0.0.2) (2023-12-19)
+
+
+### Bug Fixes
+
+* downgrade sem ver ([34c7f77](https://github.com/klueless-io/fli_video/commit/34c7f77bf52b899cbc36e202b71ea9530177e9a7))
+* naming issue ([b573d05](https://github.com/klueless-io/fli_video/commit/b573d056e044c8054ef1f98fc8219041efac86ab))
+* package json issue ([efc9435](https://github.com/klueless-io/fli_video/commit/efc9435d829585db1fc27878f134f5f8b802f5a0))
+* ruby 2.7 ([303d59f](https://github.com/klueless-io/fli_video/commit/303d59f49fd7cbc09e2ac0b2c89ba8538d3dd37b))
+* testing semver1 ([f71b294](https://github.com/klueless-io/fli_video/commit/f71b2944c6bffa8c85859b247dced28f9cc61cdd))
+* testing semver2 ([f0ea217](https://github.com/klueless-io/fli_video/commit/f0ea217416783452db4a0efee0df37ac64391bb1))
+* testing semver3 ([c28ffa8](https://github.com/klueless-io/fli_video/commit/c28ffa8b428216807046acec74935e6fee6f710a))
+* testing semver4 ([c1e260d](https://github.com/klueless-io/fli_video/commit/c1e260d069e88f72b4505dd52050305fd6de64cd))
+* version fixed for semver ([c65bf64](https://github.com/klueless-io/fli_video/commit/c65bf64335b040ca96e6aab495f7b73cfeda4f8d))
+* version fixed for semver ([484225f](https://github.com/klueless-io/fli_video/commit/484225ff32be5dc21a6e9c7231f73c59f6753ada))
+* version fixed for semver ([1011cd9](https://github.com/klueless-io/fli_video/commit/1011cd90daf6631078b22be47c8a37265ab8b6f2))
+* version normalization ([e50f6ac](https://github.com/klueless-io/fli_video/commit/e50f6acf3500ee1b5cc80cb57ea24823a017d905))
+
 ## [Unreleased]
 
 ## [0.1.0] - 2023-12-19

data/README.md

@@ -2,6 +2,8 @@
 
 > FliVideo - Video Asset Management for Content Creators
 
+GPT Link: https://chat.openai.com/c/895a1bf9-8134-4688-8805-b8047af5f3f0
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,13 +24,21 @@ Or install it yourself as:
 gem install fli_video
 ```
 
-## Stories
+## Documentation
+
+### Technical Design Document
+
+The main design document is located here: [Technical Specification](docs/technical-specifications.md)
+
+### Feature List
+
+List of features that are planned for this project: [Feature List](docs/feature-list.md)
 
 ### Main Story
 
 As a content creator, I want to create quality videos quickly, so that I can build my YouTube influence
 
-See all [stories](./STORIES.md)
+See all [stories](./stories.md)
 
 
 ## Usage
@@ -36,7 +46,6 @@ See all [stories](./STORIES.md)
 See all [usage examples](./USAGE.md)
 
 
-
 ## Development
 
 Checkout the repo
@@ -49,25 +58,9 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-```bash
-bin/console
-
-Aaa::Bbb::Program.execute()
-# => ""
-```
-
-`fli_video` is setup with Guard, run `guard`, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.
-
-To release a new version, update the version number in `version.rb`, build the gem and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-```bash
-rake publish
-rake clean
-```
-
 ## Git helpers used by this project
 
-Add the follow helpers to your `alias` file
+Add the follow helpers to your `alias` file so that you can use Semantic Commits and have them automatically pushed to GitHub and have the CI/CD pipeline run.
 
 ```bash
 function kcommit()

data/bin/fli_video

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/fli_video/cli'
+
+FliVideo::CLI.start(ARGV)

data/docs/feature-list.md

@@ -0,0 +1,75 @@
+## Features
+
+### Feature <-> DSL GPTs
+https://chat.openai.com/g/g-AyFi0UOXn-code-simplifier
+
+**Global Configuration**
+Access and apply global configuration settings for video asset management and state consistency.
+
+**Project Configuration**
+Access and apply video or episode settings and state. Infers project settings from existing project folders and files.
+
+**CLI Project Commands**
+Efficiently execute and manage video project commands using a command-line interface, enhancing control and flexibility in project handling.
+
+**FileWatch Processor**
+Utilize a FileWatch processor to automate file event responses, directing new recordings to designated folders for efficient content management.
+
+**Create Project**
+Setup a new video project for standalone YouTube video or Podcast.
+
+**Add Episode**
+Add a new episode to an existing podcast project.
+
+**Switch Video Focus**
+Easily switch between different video projects or episodes to accommodate changing content priorities.
+
+**Move eCamm File**
+Seamlessly transfer eCamm recordings to the current focused video or podcast episode recordings subfolder.
+
+**Project Path**
+Construct and manage project paths dynamically using configurable values and existing folder name segments.
+
+**Episode Path**
+Construct and manage episode paths dynamically using configurable values and existing folder name segments.
+
+**Recording Namer**
+Dynamically generate and update video recording filenames, incorporating chapter and part sequences, chapter names, and tags, with capabilities to modify chapter sequences and tags for improved organization and content identification.
+
+**Change Chapter Name**
+Alter the name of a chapter based on its sequence in the project, facilitating better organization and identification of video content.
+
+**Trash**
+Moves suboptimal video takes to a designated 'trash' or 'archive' folder, optimizing storage and maintaining project clarity by segregating lesser-quality content.
+
+**Trash Undo**
+Retrieves video takes from the '.trash' folder and moves them back into the target project folder, allowing for reconsideration or re-evaluation of previously discarded content.
+
+**Clean Trash**
+Permanently deletes video takes from the 'trash' or 'archive' folder, freeing up storage space and ensuring project clarity.
+
+**Open in Finder**
+Quickly access video project and episode folders within the Finder, streamlining file navigation.
+
+**Create Chapter Video**
+Combine and review video chapter segments independently, facilitating content evaluation and editing.
+
+**Text to Speech**
+Transcribe spoken content to text and store transcriptions folder in multiple transcription formats.
+
+Create a DSL using the interactor pattern for:
+
+**Transcript Data Store**
+Builds a JSON datastore of transcripts for an entire project based on existing transcript folders found within project, episode, recording, chapter and post-produced folders.
+
+**Project Meta Data Store**
+Build a JSON datastore of files for an entire project based on existing project, episode, recording, chapter and post-produced folders and infer metadata based on KEYWORDS, transcripts or other useful data.
+
+## Future Ideas
+
+**Web Command Interface for Video Project Management**
+Introduce a streamlined, web-based interface for managing video project commands, enabling efficient control and organization of project components through simple browser interactions.
+
+**Project Meta Report**
+Generate a detailed report for a specific video project, including the episodes, chapters, recordings, a list of recording IDs (chapter sequence + part sequence), and the name for the next video recording, file sizes.
+This should be extracted to an AstroJS Website or HTML template servered by a local webserver and provide viewing and navigation for all my video projects.

data/docs/generated/application-structure.json

@@ -0,0 +1,57 @@
+[
+  {
+    "name": "spec",
+    "type": "directory",
+    "children": [
+      {
+        "name": "spec_helper.rb",
+        "type": "file",
+        "content": "# frozen_string_literal: true\n\nrequire 'pry'\nrequire 'bundler/setup'\nrequire 'simplecov'\n\nSimpleCov.start\n\nrequire 'fli_video'\n\nRSpec.configure do |config|\n  # Enable flags like --only-failures and --next-failure\n  config.example_status_persistence_file_path = '.rspec_status'\n  config.filter_run_when_matching :focus\n\n  # Disable RSpec exposing methods globally on `Module` and `main`\n  config.disable_monkey_patching!\n\n  config.expect_with :rspec do |c|\n    c.syntax = :expect\n  end\nend\n"
+      },
+      {
+        "name": "fli_video_spec.rb",
+        "type": "file",
+        "content": "# frozen_string_literal: true\n\nRSpec.describe FliVideo do\n  it 'has a version number' do\n    expect(FliVideo::VERSION).not_to be_nil\n  end\nend\n"
+      }
+    ]
+  },
+  {
+    "name": "README.md",
+    "type": "file"
+  },
+  {
+    "name": "readme-current-project-setup.md",
+    "type": "file"
+  },
+  {
+    "name": "lib",
+    "type": "directory",
+    "children": [
+      {
+        "name": "fli_video",
+        "type": "directory",
+        "children": [
+          {
+            "name": "cli.rb",
+            "type": "file",
+            "content": "# frozen_string_literal: true\n\nrequire_relative '../fli_video'\n\nmodule FliVideo\n  class CLI\n    def self.start(args)\n      new(args).execute\n    end\n\n    def initialize(args)\n      @args = args\n    end\n\n    def execute\n      if @args.empty?\n        puts \"FliVideo CLI - No command provided\"\n        return\n      end\n\n      case @args.first\n      when 'version'\n        puts \"FliVideo version #{FliVideo::VERSION}\"\n      else\n        puts \"Unknown command: #{@args.first}\"\n      end\n    end\n  end\nend\n"
+          },
+          {
+            "name": "version.rb",
+            "type": "file",
+            "content": "# frozen_string_literal: true\n\nmodule FliVideo\n  VERSION = '0.0.2'\nend\n"
+          }
+        ]
+      },
+      {
+        "name": "fli_video.rb",
+        "type": "file",
+        "content": "# frozen_string_literal: true\n\nrequire_relative 'fli_video/version'\n\nmodule FliVideo\n  class Error < StandardError; end\n  # Your code goes here...\nend\n"
+      }
+    ]
+  },
+  {
+    "name": "Gemfile",
+    "type": "file"
+  }
+]