fli_video 0.1.0 → 0.1.1

data/docs/generated/features-and-components.md

@@ -3,13 +3,16 @@
 ### Feature <-> DSL GPTs
 https://chat.openai.com/g/g-AyFi0UOXn-code-simplifier
 
-**Read Global Configuration**
+**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.
+Access and apply video or episode settings and state. Infers project settings from existing project folders and files.
 
-**FileWatch Processor for File Event Commands**
+**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**
@@ -64,9 +67,6 @@ Build a JSON datastore of files for an entire project based on existing project,
 
 ## Future Ideas
 
-**CLI Project Management Interface**
-Efficiently execute and manage video project commands using a command-line interface, enhancing control and flexibility in project handling.
-
 **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.
 
@@ -75,15 +75,15 @@ Generate a detailed report for a specific video project, including the episodes,
 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.
 
 
-## Klue Components
 
+## Klue Components
 Klue Component: `add_episode.klue`
 
 ```ruby
 component :add_episode do
   desc "Add a new episode to an existing podcast project."
 
-  pattern "Interactor"
+  pattern "Command"
 
   comments <<~TEXT
     - Facilitates the addition of a new episode to a specific podcast project.
@@ -105,8 +105,8 @@ component :add_episode do
     # ~/video-projects/a21-ac-some-podcast/01-episode-about-something/.trash
   RUBY
 end
-```
 
+```
 Klue Component: `change_chapter_name.klue`
 
 ```ruby
@@ -142,8 +142,8 @@ component :change_chapter_name do
     # 01-d-intro-CTA.mov
   RUBY
 end
-```
 
+```
 Klue Component: `create_chapter_video.klue`
 
 ```ruby
@@ -181,15 +181,15 @@ component :create_chapter_video do
     # Output: '~/video-projects/a27-ac-some-podcast/chapters/01-intro-custom.mov'
   RUBY
 end
-```
 
+```
 Klue Component: `create_project.klue`
 
 ```ruby
 component :create_project do
   desc "Setup a new video project for standalone YouTube video or Podcast."
 
-  pattern "Interactor"
+  pattern "Command"
 
   comments <<~TEXT
     - Allows the creation of a new project, specifying if it's for a YouTube video or a Podcast.
@@ -223,8 +223,8 @@ component :create_project do
     # ~/video-projects/a21-ac-some-podcast/.fv.json
     RUBY
 end
-```
 
+```
 Klue Component: `empty_trash.klue`
 
 ```ruby
@@ -252,8 +252,8 @@ component :empty_trash do
     # Empties the entire .trash folder in "~/video-projects/a27-ac-categorize-mp4-CI/.trash/
   RUBY
 end
-```
 
+```
 Klue Component: `episode_path.klue`
 
 ```ruby
@@ -334,8 +334,8 @@ component :episode_path do
     episode_path.keywords # => ["TODO"]
   RUBY
 end
-```
 
+```
 Klue Component: `global_config.klue`
 
 ```ruby
@@ -370,8 +370,8 @@ component :global_configuation do
   method :load
   method :save
 end
-```
 
+```
 Klue Component: `move_ecamm_file.klue`
 
 ```ruby
@@ -396,8 +396,8 @@ component :move_ecamm_file do
     # ~/video-projects/a20-ad-some-video/recordings/Ecamm Live Recording on 2023-08-25 at 14.51.58.mov
   RUBY
 end
-```
 
+```
 Klue Component: `move_to_trash.klue`
 
 ```ruby
@@ -414,9 +414,9 @@ component :move_to_trash do
 
   constructure(:parent_project)
 
-  method :run(:file_name)
+  method :run(:file_name = nil)
 
-  sample :move_video_to_trash, <<~RUBY
+  sample :move_named_video_to_trash, <<~RUBY
     project_path = ProjectPath.new('a27')
 
     command = move_to_trash.new(project_path)
@@ -424,14 +424,20 @@ component :move_to_trash do
     # Example of moving a specific suboptimal video take to the trash folder
     command.run('01-a-introduction.mov')
     # => "~/video-projects/a27-ac-categorize-mp4-CI/.trash/01-a-introduction.mov"
+  RUBY
+
+  sample :move_last_ecamm__video_to_trash, <<~RUBY
+    project_path = ProjectPath.new('a27')
 
+    command = move_to_trash.new(project_path)
+  
     # Example of moving the last suboptimal video take to the trash folder
     command.run
     # => "~/video-projects/a27-ac-categorize-mp4-CI/.trash/Ecamm Live Recording on 2023-08-25 at 14.51.58.mov
   RUBY
 end
-```
 
+```
 Klue Component: `open_in_finder.klue`
 
 ```ruby
@@ -460,8 +466,8 @@ component :open_in_finder do
     # Opens the folder for episode '01' of project 'a27' in Finder
   RUBY
 end
-```
 
+```
 Klue Component: `project_config.klue`
 
 ```ruby
@@ -588,8 +594,8 @@ component :project_configuration do
   }
   JSON
 end
-```
 
+```
 Klue Component: `project_meta_data_store.klue`
 
 ```ruby
@@ -621,8 +627,8 @@ component :project_meta_data_store do
     # Output: '~/video-projects/a27-ac-categorize-mp4-CI/project_metadata.json'
     RUBY
 end
-```
 
+```
 Klue Component: `project_path.klue`
 
 ```ruby
@@ -703,8 +709,8 @@ component :project_path do
     project_path.keywords # => "CI"
   RUBY
 end
-```
 
+```
 Klue Component: `recording_file_watcher.klue`
 
 ```ruby
@@ -736,8 +742,8 @@ component :filewatch_processor do
     filewatch_processor.move_file
   RUBY
 end
-```
 
+```
 Klue Component: `recording_filename.klue`
 
 ```ruby
@@ -853,8 +859,8 @@ component :recording_filename do
     filename.filename # => "01-a-introduction-NEW_TAG.mov"
   RUBY
 end
-```
 
+```
 Klue Component: `restore_from_trash.klue`
 
 ```ruby
@@ -887,8 +893,8 @@ component :restore_from_trash do
     # => "~/video-projects/a27-ac-categorize-mp4-CI/Ecamm Live Recording on 2023-08-25 at 14.51.58.mov"
   RUBY
 end
-```
 
+```
 Klue Component: `switch_focus.klue`
 
 ```ruby
@@ -916,8 +922,8 @@ component :change_focus do
     change_focus.run('a21', '02')
   RUBY
 end
-```
 
+```
 Klue Component: `text_to_speech.klue`
 
 ```ruby
@@ -950,8 +956,8 @@ component :text_to_speech do
     # Output: Transcriptions saved in '~/video-projects/a27-ac-categorize-mp4-CI/recordings/transcript/01-introduction.txt|srt|vtt|json|tsv'
   RUBY
 end
-```
 
+```
 Klue Component: `transcript_data_store.klue`
 
 ```ruby
@@ -983,5 +989,5 @@ component :transcript_data_store do
     # Output: '~/video-projects/a27-ac-categorize-mp4-CI/project_transcripts.json'
   RUBY
 end
-```
 
+```

data/docs/generated/technical-design-and-features.md

@@ -1,6 +1,20 @@
+# FliVideo
+
 ## Application Overview
 
-This document provides an overview of a specialized application designed primarily for video content creators using Ecamm Live on the Mac, and adaptable for OBS users. Tailored for projects ranging from individual YouTube videos to episodes in a podcast series, the application fits seamlessly into the workflow between video recording and editing. It streamlines the post-recording process, encompassing file organization, renaming, and assembly of video recordings, thereby enhancing the efficiency and structure of content creation.
+FliVideo is a Video Asset Managment tool created by a YouTuber `@AppyDave` for YouTubers.
+
+It provides a set of image, video and workflow management tools to help its creator 'AppyDave' to automate and systemetize the video production process.
+
+The intiial idea behind FliVideo was Zappier for YouTubers, but it is evolving with a range of capabilities around script, b-roll and presenation canvas automation.
+
+### Video Recording Managment
+
+FliVideo initially targeted video content creators using Ecamm Live on the Mac, and adaptable for OBS users.
+
+Tailored for projects ranging from individual YouTube videos to episodes in a podcast series, the application fits seamlessly into the workflow between video recording and editing. 
+
+It streamlines the post-recording process, encompassing file organization, renaming, and assembly of video recordings, thereby enhancing the efficiency and structure of content creation.
 
 ### Core Functionality
 
@@ -74,8 +88,8 @@ a29-ac-gpts-analyze-pdf-transations
 
 ### Sample project codes
 
-- `ac` - AppyCast
 - `ad` - AppyDave
+- `ac` - AppyDaveCoding
 - `fv` - FliVideo
 - `wp` - WinningPrompts
 - `c9` - Carnivore90
@@ -343,18 +357,23 @@ project-name/recordings/03-a-outro.mov
 project-name/recordings/03-b-outro-cta.mov
 project-name/recordings/03-c-outro.mov
 ```
+
+
 ## Features
 
 ### Feature <-> DSL GPTs
 https://chat.openai.com/g/g-AyFi0UOXn-code-simplifier
 
-**Read Global Configuration**
+**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.
+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 for File Event Commands**
+**FileWatch Processor**
 Utilize a FileWatch processor to automate file event responses, directing new recordings to designated folders for efficient content management.
 
 **Create Project**
@@ -409,12 +428,10 @@ Build a JSON datastore of files for an entire project based on existing project,
 
 ## Future Ideas
 
-**CLI Project Management Interface**
-Efficiently execute and manage video project commands using a command-line interface, enhancing control and flexibility in project handling.
-
 **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/technical-specifications.md

@@ -2,7 +2,19 @@
 
 ## Application Overview
 
-This document provides an overview of a specialized application designed primarily for video content creators using Ecamm Live on the Mac, and adaptable for OBS users. Tailored for projects ranging from individual YouTube videos to episodes in a podcast series, the application fits seamlessly into the workflow between video recording and editing. It streamlines the post-recording process, encompassing file organization, renaming, and assembly of video recordings, thereby enhancing the efficiency and structure of content creation.
+FliVideo is a Video Asset Managment tool created by a YouTuber `@AppyDave` for YouTubers.
+
+It provides a set of image, video and workflow management tools to help its creator 'AppyDave' to automate and systemetize the video production process.
+
+The intiial idea behind FliVideo was Zappier for YouTubers, but it is evolving with a range of capabilities around script, b-roll and presenation canvas automation.
+
+### Video Recording Managment
+
+FliVideo initially targeted video content creators using Ecamm Live on the Mac, and adaptable for OBS users.
+
+Tailored for projects ranging from individual YouTube videos to episodes in a podcast series, the application fits seamlessly into the workflow between video recording and editing. 
+
+It streamlines the post-recording process, encompassing file organization, renaming, and assembly of video recordings, thereby enhancing the efficiency and structure of content creation.
 
 ### Core Functionality
 
@@ -345,3 +357,4 @@ project-name/recordings/03-a-outro.mov
 project-name/recordings/03-b-outro-cta.mov
 project-name/recordings/03-c-outro.mov
 ```
+

data/lib/fli_video/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FliVideo
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "fli_video",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "fli_video",
-      "version": "0.1.0",
+      "version": "0.1.1",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.3",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fli_video",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "FliVideo - Video Asset Management for Content Creators",
   "scripts": {
     "release": "semantic-release"

data/scripts/01-get-technical-design-and-feature-list.md

@@ -0,0 +1,5 @@
+## Prompt:
+
+Write a Ruby script to read `docs/technical-specifictions.md` and `docs/feature-list.md`, 
+and  merge their content into `docs/generated/technical-design-and-features.md` and copy it to the clipboard.
+

data/scripts/01-get-technical-design-and-feature-list.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+# Method to read file contents
+def read_file(file_path)
+  begin
+    File.read(file_path)
+  rescue => e
+    puts "Error reading file #{file_path}: #{e}"
+    ""
+  end
+end
+
+# Method to write content to a file
+def write_file(file_path, *contents)
+  merged_content = contents.join("\n")
+  begin
+    # Ensure the directory exists
+    Dir.mkdir(File.dirname(file_path)) unless Dir.exist?(File.dirname(file_path))
+    File.write(file_path, merged_content)
+  rescue => e
+    puts "Error writing to file #{file_path}: #{e}"
+  end
+end
+
+# Method to copy content to clipboard
+def copy_to_clipboard(content)
+  IO.popen('pbcopy', 'w') { |clip| clip.puts content }
+end
+
+# Main execution
+technical_design = read_file('docs/technical-specifications.md')
+feature_list = read_file('docs/feature-list.md')
+output_file = 'docs/generated/technical-design-and-features.md'
+
+# Merge and write the content to the output file
+write_file(output_file, technical_design, feature_list)
+
+# Copy content to clipboard
+copy_to_clipboard("#{technical_design}\n#{feature_list}")

data/scripts/02-get-feature-list-and-components.md

@@ -0,0 +1,26 @@
+## Prompt:
+
+Write a Ruby script to read `docs/feature-list.md` and merge it with content from `.builders/klues/*.klue` files.
+Write the result to `docs/generated/features-and-components.md` and copy it to the clipboard.
+
+The Klue files should need a heading: "Klue Components"
+
+The content from each Klue file have a simple heading and be wraped with in a code block with the language set to ruby.
+
+Example:
+
+
+## Klue Components
+
+Klue Component: `add_episode.klue`
+
+```ruby
+# content of add_episode.klue goes here
+```
+
+Klue Component: `change_chapter_name.klue`
+
+```ruby
+# content of change_chapter_name.klue goes here
+```
+

data/scripts/02-get-feature-list-and-components.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+require 'find'
+
+# Method to read file contents
+def read_file(file_path)
+  begin
+    File.read(file_path)
+  rescue => e
+    puts "Error reading file #{file_path}: #{e}"
+    ""
+  end
+end
+
+# Method to write content to a file
+def write_file(file_path, content)
+  begin
+    # Ensure the directory exists
+    Dir.mkdir(File.dirname(file_path)) unless Dir.exist?(File.dirname(file_path))
+    File.write(file_path, content)
+  rescue => e
+    puts "Error writing to file #{file_path}: #{e}"
+  end
+end
+
+# Method to combine Klue files
+def combine_klue_files(klue_dir)
+  klue_components = "## Klue Components\n"
+  Find.find(klue_dir) do |path|
+    if path =~ /.*\.klue$/
+      klue_file_content = read_file(path)
+      klue_components += "Klue Component: `#{File.basename(path)}`\n\n```ruby\n#{klue_file_content}\n```\n"
+    end
+  end
+  klue_components
+end
+
+# Method to copy content to clipboard
+def copy_to_clipboard(content)
+  IO.popen('pbcopy', 'w') { |clip| clip.puts content }
+end
+
+# Read the feature list
+feature_list = read_file('docs/feature-list.md')
+
+# Combine Klue files
+klue_components = combine_klue_files('.builders/klues')
+
+# Merge contents
+merged_content = "#{feature_list}\n\n#{klue_components}"
+
+# Output file path
+output_file = 'docs/generated/features-and-components.md'
+
+# Write the merged content to the output file and copy to clipboard
+write_file(output_file, merged_content)
+copy_to_clipboard(merged_content)

data/scripts/03-get-code-structure.md

@@ -0,0 +1,33 @@
+## Prompt:
+
+Create a Ruby script to scan a project's directory, ignoring specific folders and files. For the remaining files generate a JSON file with their structure and content and write to `docs/generated/application-structure.json`
+
+Store a copy of the data in the clipboard
+
+For some files, eg. ` *.rb` I would like you to read the content and put it in the JSON
+
+### Sample Structure
+```json
+[
+  {
+    "name": ".rspec_status",
+    "type": "file"
+  },
+  {
+    "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"
+      }
+    ]
+  },
+]
+```

data/scripts/03-get-code-structure.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+require 'json'
+require 'find'
+
+# Method to read file contents based on inclusion patterns
+def read_file_contents(file_path, include_content_for)
+  return nil unless include_content_for.any? { |pattern| File.fnmatch(pattern[:pattern], File.basename(file_path)) }
+  File.read(file_path)
+end
+
+# Method to write JSON content to a file
+def write_structure_to_file(file_path, content)
+  File.write(file_path, JSON.pretty_generate(content))
+end
+
+# Method to copy content to clipboard
+def copy_to_clipboard(content)
+  IO.popen('pbcopy', 'w') { |clip| clip.puts content }
+end
+
+# Method to scan and structure directory contents
+def scan_directory(dir, ignore_folders, ignore_files, include_content_for)
+  Dir.children(dir).map do |entry|
+    path = "#{dir}/#{entry}"
+    next if ignore_folders.include?(File.basename(path)) || ignore_files.include?(File.basename(path))
+
+    if File.directory?(path)
+      { 'name' => entry, 'type' => 'directory', 'children' => scan_directory(path, ignore_folders, ignore_files, include_content_for) }
+    else
+      file_data = { 'name' => entry, 'type' => 'file' }
+      file_data['content'] = read_file_contents(path, include_content_for) if include_content_for.any? { |pattern| File.fnmatch(pattern[:pattern], entry) }
+      file_data
+    end
+  end.compact
+end
+
+# Method to build content for GPT clipboard
+def build_gpt_content(structure)
+  JSON.pretty_generate(structure)
+end
+
+# Usage example:
+ignore_folders = ['coverage', 'tmp', 'log', '.git', '.githooks', '.github', 'bin', 'sig', 'node_modules', '.builders', 'docs', 'scripts']
+
+ignore_files = [
+  'fli.rb',
+  'application-structure.json',
+  '.rspec_status',
+  '.releaserc.json',
+  'CODE_OF_CONDUCT.md',
+  'Guardfile',
+  '.rspec',
+  'CHANGELOG.md',
+  '.tool-versions',
+  'Rakefile',
+  'Gemfile.lock',
+  '.gitignore',
+  'package-lock.json',
+  'package.json',
+  '.rubocop.yml',
+  'LICENSE.txt',
+  'fli_video.gemspec',
+  '01-get-structure.rb'
+]
+include_content_for = [
+  { pattern: '*.rb' },
+]
+
+structure = scan_directory('.', ignore_folders, ignore_files, include_content_for)
+write_structure_to_file('docs/generated/application-structure.json', structure)
+gpt_content = build_gpt_content(structure)
+copy_to_clipboard(gpt_content)
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fli_video
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-24 00:00:00.000000000 Z
+date: 2024-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_log
@@ -34,6 +34,12 @@ files:
 - ".builders/_.rb"
 - ".builders/boot.rb"
 - ".builders/generators/01-bootstrap.rb"
+- ".builders/generators/back/scripts/01-get-technical-design-and-feature-list.rb"
+- ".builders/generators/back/scripts/02-get-feature-list-and-components.rb"
+- ".builders/generators/back/scripts/03-get-structure.rb"
+- ".builders/generators/back/scripts/generated/application-structure.json"
+- ".builders/generators/back/scripts/generated/features-and-components.md"
+- ".builders/generators/back/scripts/generated/technical-design-and-features.md"
 - ".builders/klues/add_episode.klue"
 - ".builders/klues/change_chapter_name.klue"
 - ".builders/klues/create_chapter_video.klue"
@@ -78,9 +84,12 @@ files:
 - lib/fli_video/version.rb
 - package-lock.json
 - package.json
-- scripts/01-get-structure.rb
-- scripts/02-get-features-and-components.rb
-- scripts/03-get-technical-design-and-features.rb
+- scripts/01-get-technical-design-and-feature-list.md
+- scripts/01-get-technical-design-and-feature-list.rb
+- scripts/02-get-feature-list-and-components.md
+- scripts/02-get-feature-list-and-components.rb
+- scripts/03-get-code-structure.md
+- scripts/03-get-code-structure.rb
 - sig/fli_video.rbs
 homepage: http://appydave.com/gems/fli_video
 licenses: