fli_video 0.0.2 → 0.1.1

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.0.2
+  version: 0.1.1
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-19 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,31 @@ 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"
+- ".builders/klues/create_project.klue"
+- ".builders/klues/empty_trash.klue"
+- ".builders/klues/episode_path.klue"
+- ".builders/klues/global_config.klue"
+- ".builders/klues/move_ecamm_file.klue"
+- ".builders/klues/move_to_trash.klue"
+- ".builders/klues/open_in_finder.klue"
+- ".builders/klues/project_config.klue"
+- ".builders/klues/project_meta_data_store.klue"
+- ".builders/klues/project_path.klue"
+- ".builders/klues/recording_file_watcher.klue"
+- ".builders/klues/recording_filename.klue"
+- ".builders/klues/restore_from_trash.klue"
+- ".builders/klues/switch_focus.klue"
+- ".builders/klues/text_to_speech.klue"
+- ".builders/klues/transcript_data_store.klue"
 - ".releaserc.json"
 - ".rspec"
 - ".rubocop.yml"
@@ -43,15 +68,28 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.txt
-- README-features.md
 - README.md
 - Rakefile
 - bin/console
+- bin/fli_video
 - bin/setup
+- docs/feature-list.md
+- docs/generated/application-structure.json
+- docs/generated/features-and-components.md
+- docs/generated/technical-design-and-features.md
+- docs/technical-specifications.md
+- fli.rb
 - lib/fli_video.rb
+- lib/fli_video/cli.rb
 - lib/fli_video/version.rb
 - package-lock.json
 - package.json
+- 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:

data/README-features.md

@@ -1,36 +0,0 @@
-Read Global Configuration
-  Access and apply global configuration settings for video asset management and state consistency.
-Project or Project/Episode Management
-  Efficiently handle one video project or episode at a time, ensuring focused and organized workflow.
-Quick Create New Project
-  Rapidly initiate new video project or episode, enabling quick development and setup with minimal steps.
-Change Project/Episode Focus
-  Easily switch between different video projects or episodes to accommodate changing content priorities.
-Read Project Configuration
-  Maintain and retrieve project-specific settings and configurations to resume video projects seamlessly.
-Calculate Location/Filename for Video Recordings
-  Automatically determine and organize storage locations and filenames for video recordings, enhancing asset management.
-Move eCamm File to Project Recordings Folder
-  Seamlessly transfer eCamm recordings into appropriate project or episode folders for streamlined project continuity.
-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' or 'archive' folder and moves them back into the target project folder, allowing for reconsideration or re-evaluation of previously discarded content.
-Finder Integration
-  Quickly access video project and episode folders within the Finder, streamlining file navigation.
-FileWatch Processor for File Event Commands
-  Utilize a FileWatch processor to automate file event responses, directing new recordings to designated folders for efficient content management.
-Generate Chapter Video
-  Compile and review video chapter segments independently, facilitating content evaluation and editing.
-Text to Speech
-  Transcribe spoken content to text, integrating transcriptions into subsequent workflow stages.
-Meta Data Generator
-  Extract and utilize metadata from video transcriptions and file tags for automated post-production processes like keyword generation, B-roll organization, chapter transitions, and time code marking for calls to action.
-Report
-  Generate a detailed report for a specific video project or episode, including the number of files, chapters, a list of recording IDs (chapter sequence + part number), and the name for the next video recording.
-Change Tags
-  Modify tags or keywords associated with a specific recording ID, allowing for dynamic categorization and organization of video content.
-Change Chapter Name
-  Alter the name of a chapter based on its sequence in the project, facilitating better organization and identification of video content.
-Change Chapter Sequence
-  Adjust the chapter sequence for all files within a chapter, for example, changing from 02 to 03, ensuring consistent and accurate organization of video content.