sirena 0.1.0

data/lib/tasks/examples.rake

@@ -0,0 +1,468 @@
+# frozen_string_literal: true
+
+namespace :examples do
+  desc "Generate all example SVGs from source files"
+  task :generate do
+    require 'sirena'
+    require 'yaml'
+    require 'fileutils'
+
+    examples_dir = File.expand_path('../../examples', __dir__)
+
+    unless Dir.exist?(examples_dir)
+      puts "⚠️  Examples directory not found: #{examples_dir}"
+      puts "Run 'rake examples:init' to create the directory structure"
+      exit 1
+    end
+
+    # Find all diagram type directories
+    diagram_dirs = Dir.glob(File.join(examples_dir, '*')).select { |f| File.directory?(f) }
+
+    total_generated = 0
+    total_failed = 0
+
+    diagram_dirs.sort.each do |dir|
+      diagram_type = File.basename(dir)
+      next if diagram_type == '.git' || diagram_type.start_with?('.')
+
+      puts "\n📊 Generating examples for #{diagram_type}..."
+
+      # Create generated/ directory
+      generated_dir = File.join(dir, 'generated')
+      FileUtils.mkdir_p(generated_dir)
+
+      # Find all .mmd files
+      mmd_files = Dir.glob(File.join(dir, '*.mmd'))
+
+      if mmd_files.empty?
+        puts "  ⚠️  No examples found for #{diagram_type}"
+        next
+      end
+
+      mmd_files.sort.each do |mmd_file|
+        basename = File.basename(mmd_file, '.mmd')
+        yml_file = File.join(dir, "#{basename}.yml")
+        svg_file = File.join(generated_dir, "#{basename}.svg")
+
+        # Read source
+        source = File.read(mmd_file)
+
+        # Read metadata if exists
+        metadata = File.exist?(yml_file) ? YAML.load_file(yml_file) : {}
+        theme = metadata['theme'] || 'default'
+
+        begin
+          # Render to SVG
+          svg = Sirena.render(source, theme: theme)
+
+          # Write SVG
+          File.write(svg_file, svg)
+
+          puts "  ✓ #{basename}.svg"
+          total_generated += 1
+        rescue => e
+          puts "  ✗ #{basename}.svg - ERROR: #{e.message}"
+          total_failed += 1
+        end
+      end
+    end
+
+    puts "\n" + "=" * 60
+    puts "✅ Example generation complete!"
+    puts "   Generated: #{total_generated}"
+    puts "   Failed: #{total_failed}"
+    puts "=" * 60
+  end
+
+  desc "Copy generated examples to docs/assets/examples"
+  task :copy_to_docs do
+    require 'fileutils'
+
+    examples_dir = File.expand_path('../../examples', __dir__)
+    docs_assets_dir = File.expand_path('../../docs/assets/examples', __dir__)
+
+    FileUtils.mkdir_p(docs_assets_dir)
+
+    total_copied = 0
+
+    # Find all generated/ directories
+    Dir.glob(File.join(examples_dir, '*/generated')).sort.each do |generated_dir|
+      diagram_type = File.basename(File.dirname(generated_dir))
+      target_dir = File.join(docs_assets_dir, diagram_type)
+
+      FileUtils.mkdir_p(target_dir)
+
+      # Copy all SVG files
+      svg_files = Dir.glob(File.join(generated_dir, '*.svg'))
+      svg_files.each do |svg_file|
+        FileUtils.cp(svg_file, target_dir)
+        total_copied += 1
+      end
+
+      puts "✓ Copied #{svg_files.size} #{diagram_type} examples to docs/assets/examples/"
+    end
+
+    puts "\n✅ #{total_copied} examples copied to documentation!"
+  end
+
+  desc "Generate AsciiDoc include files for documentation"
+  task :generate_docs do
+    require 'yaml'
+    require 'fileutils'
+
+    examples_dir = File.expand_path('../../examples', __dir__)
+    docs_examples_dir = File.expand_path('../../docs/_diagram_types/examples', __dir__)
+
+    FileUtils.mkdir_p(docs_examples_dir)
+
+    diagram_dirs = Dir.glob(File.join(examples_dir, '*')).select { |f| File.directory?(f) }
+
+    diagram_dirs.sort.each do |dir|
+      diagram_type = File.basename(dir)
+      next if diagram_type == '.git' || diagram_type.start_with?('.')
+
+      mmd_files = Dir.glob(File.join(dir, '*.mmd')).sort
+      next if mmd_files.empty?
+
+      # Generate AsciiDoc include file
+      adoc_file = File.join(docs_examples_dir, "#{diagram_type}-examples.adoc")
+
+      content = []
+      content << "// Auto-generated examples for #{diagram_type}"
+      content << "// Generated: #{Time.now.strftime('%Y-%m-%d %H:%M:%S')}"
+      content << ""
+
+      mmd_files.each_with_index do |mmd_file, index|
+        basename = File.basename(mmd_file, '.mmd')
+        yml_file = File.join(dir, "#{basename}.yml")
+
+        # Read metadata
+        metadata = File.exist?(yml_file) ? YAML.load_file(yml_file) : {}
+        title = metadata['title'] || basename.split('-').map(&:capitalize).join(' ')
+        description = metadata['description'] || 'Example diagram'
+        complexity = metadata['complexity'] || 'basic'
+        use_cases = metadata['use_cases'] || []
+        keywords = metadata['keywords'] || []
+
+        content << "==== Example #{index + 1}: #{title}"
+        content << ""
+        content << ".#{description}"
+
+        if !use_cases.empty? || complexity != 'basic'
+          content << "[NOTE]"
+          content << "===="
+          content << "Complexity: #{complexity.capitalize}"
+          if !use_cases.empty?
+            content << " +"
+            content << "Use Cases: #{use_cases.join(', ')}"
+          end
+          content << "===="
+        end
+
+        content << ""
+        content << ".Source Code"
+        content << "[source,mermaid]"
+        content << "----"
+        content << File.read(mmd_file).strip
+        content << "----"
+        content << ""
+        content << ".Rendered Output"
+        content << "image::../../assets/examples/#{diagram_type}/#{basename}.svg[#{title},600]"
+        content << ""
+        content << "'''"
+        content << ""
+      end
+
+      File.write(adoc_file, content.join("\n"))
+      puts "✓ Generated #{diagram_type}-examples.adoc (#{mmd_files.size} examples)"
+    end
+
+    puts "\n✅ Documentation includes generated!"
+  end
+
+  desc "Validate all examples (parse and render)"
+  task :validate do
+    require 'sirena'
+
+    examples_dir = File.expand_path('../../examples', __dir__)
+
+    failed = []
+    passed = 0
+    total = 0
+
+    puts "Validating examples..."
+    puts ""
+
+    Dir.glob(File.join(examples_dir, '*/*.mmd')).sort.each do |mmd_file|
+      total += 1
+      source = File.read(mmd_file)
+      relative_path = mmd_file.sub(examples_dir + '/', '')
+
+      begin
+        Sirena.render(source)
+        passed += 1
+        print '.'
+      rescue => e
+        failed << { file: relative_path, error: e.message }
+        print 'F'
+      end
+    end
+
+    puts "\n\n"
+    puts "=" * 60
+    puts "Validation Results"
+    puts "=" * 60
+    puts "Total:  #{total}"
+    puts "Passed: #{passed} (#{(passed.to_f / total * 100).round(1)}%)"
+    puts "Failed: #{failed.size}"
+    puts "=" * 60
+
+    if failed.any?
+      puts "\nFailures:"
+      failed.each do |f|
+        puts "  ✗ #{f[:file]}"
+        puts "    #{f[:error]}"
+      end
+      exit 1
+    else
+      puts "\n✅ All examples validated successfully!"
+    end
+  end
+
+  desc "Generate all examples and copy to docs"
+  task :build => [:generate, :generate_docs, :copy_to_docs]
+
+  desc "Create example template for a diagram type"
+  task :create, [:type, :name] do |t, args|
+    require 'fileutils'
+
+    type = args[:type]
+    name = args[:name]
+
+    if type.nil? || name.nil?
+      puts "Usage: rake examples:create[type,name]"
+      puts "Example: rake examples:create[flowchart,basic-flow]"
+      exit 1
+    end
+
+    examples_dir = File.expand_path('../../examples', __dir__)
+    type_dir = File.join(examples_dir, type)
+
+    FileUtils.mkdir_p(type_dir)
+
+    # Find next number
+    existing = Dir.glob(File.join(type_dir, '*.mmd')).map do |f|
+      File.basename(f).split('-').first.to_i
+    end.max || 0
+    number = existing + 1
+
+    basename = format("%02d-%s", number, name)
+
+    # Create .mmd file
+    mmd_file = File.join(type_dir, "#{basename}.mmd")
+    File.write(mmd_file, "#{type}\n  A --> B\n")
+
+    # Create .yml file
+    yml_file = File.join(type_dir, "#{basename}.yml")
+    yml_content = <<~YAML
+      title: "#{name.split('-').map(&:capitalize).join(' ')}"
+      description: "Description of this example"
+      complexity: basic
+      keywords:
+        - #{type}
+      use_cases:
+        - "Example use case"
+      theme: default
+    YAML
+    File.write(yml_file, yml_content)
+
+    puts "✓ Created #{basename}.mmd"
+    puts "✓ Created #{basename}.yml"
+    puts "\nEdit these files and run: rake examples:generate"
+  end
+
+  desc "List all examples with status"
+  task :list do
+    require 'yaml'
+
+    examples_dir = File.expand_path('../../examples', __dir__)
+
+    unless Dir.exist?(examples_dir)
+      puts "Examples directory not found: #{examples_dir}"
+      puts "Run 'rake examples:init' to create it"
+      exit 1
+    end
+
+    diagram_dirs = Dir.glob(File.join(examples_dir, '*')).select { |f| File.directory?(f) }
+
+    total_examples = 0
+
+    diagram_dirs.sort.each do |dir|
+      diagram_type = File.basename(dir)
+      next if diagram_type == '.git' || diagram_type.start_with?('.')
+
+      examples = Dir.glob(File.join(dir, '*.mmd'))
+      total_examples += examples.size
+
+      puts "\n#{diagram_type.upcase.tr('-', ' ')} (#{examples.size} examples)"
+      puts "─" * 60
+
+      if examples.empty?
+        puts "  (no examples yet)"
+        next
+      end
+
+      examples.sort.each do |mmd_file|
+        basename = File.basename(mmd_file, '.mmd')
+        yml_file = File.join(dir, "#{basename}.yml")
+        svg_file = File.join(dir, 'generated', "#{basename}.svg")
+
+        metadata = File.exist?(yml_file) ? YAML.load_file(yml_file) : {}
+        title = metadata['title'] || basename
+        complexity = metadata['complexity'] || 'basic'
+
+        svg_status = File.exist?(svg_file) ? "✓" : "✗"
+
+        puts "  #{svg_status} #{basename}: #{title} [#{complexity}]"
+      end
+    end
+
+    puts "\n" + "=" * 60
+    puts "Total: #{total_examples} examples across #{diagram_dirs.size} diagram types"
+    puts "=" * 60
+  end
+
+  desc "Initialize examples directory structure"
+  task :init do
+    require 'fileutils'
+
+    examples_dir = File.expand_path('../../examples', __dir__)
+
+    # Create main examples directory
+    FileUtils.mkdir_p(examples_dir)
+
+    # Create README
+    readme_content = <<~README
+      # Sirena Examples
+
+      This directory contains example diagrams for all supported diagram types.
+
+      ## Structure
+
+      Each diagram type has its own directory with:
+      - `*.mmd` - Mermaid source files
+      - `*.yml` - Metadata for each example
+      - `generated/` - Auto-generated SVG files (git-ignored)
+
+      ## Usage
+
+      ```bash
+      # Generate all SVGs
+      rake examples:generate
+
+      # Create a new example
+      rake examples:create[flowchart,my-example]
+
+      # Validate all examples
+      rake examples:validate
+
+      # List all examples
+      rake examples:list
+
+      # Build everything (generate + docs + copy)
+      rake examples:build
+      ```
+
+      ## Adding Examples
+
+      1. Create example files:
+         ```bash
+         rake examples:create[type,name]
+         ```
+
+      2. Edit the `.mmd` and `.yml` files
+
+      3. Generate SVG:
+         ```bash
+         rake examples:generate
+         ```
+
+      4. Build documentation:
+         ```bash
+         rake examples:build
+         ```
+
+      ## Example Metadata
+
+      Each `.yml` file should contain:
+
+      ```yaml
+      title: "Example Title"
+      description: "What this example demonstrates"
+      complexity: basic  # basic, intermediate, advanced
+      keywords:
+        - keyword1
+        - keyword2
+      use_cases:
+        - "Use case description"
+      theme: default  # default, dark, light, high-contrast
+      ```
+    README
+
+    File.write(File.join(examples_dir, 'README.md'), readme_content)
+
+    # Create .gitignore
+    gitignore_content = <<~GITIGNORE
+      # Ignore generated SVG files
+      */generated/
+
+      # Ignore macOS files
+      .DS_Store
+
+      # Ignore editor files
+      *.swp
+      *.swo
+      *~
+    GITIGNORE
+
+    File.write(File.join(examples_dir, '.gitignore'), gitignore_content)
+
+    puts "✓ Created examples/ directory"
+    puts "✓ Created README.md"
+    puts "✓ Created .gitignore"
+    puts "\n✅ Examples directory initialized!"
+    puts "\nNext steps:"
+    puts "  1. Create examples: rake examples:create[type,name]"
+    puts "  2. Generate SVGs: rake examples:generate"
+    puts "  3. Build docs: rake examples:build"
+  end
+
+  desc "Clean all generated files"
+  task :clean do
+    require 'fileutils'
+
+    examples_dir = File.expand_path('../../examples', __dir__)
+    docs_assets_dir = File.expand_path('../../docs/assets/examples', __dir__)
+    docs_examples_dir = File.expand_path('../../docs/_diagram_types/examples', __dir__)
+
+    # Clean generated/ directories
+    Dir.glob(File.join(examples_dir, '*/generated')).each do |dir|
+      FileUtils.rm_rf(dir)
+      puts "✓ Removed #{dir}"
+    end
+
+    # Clean docs assets
+    if Dir.exist?(docs_assets_dir)
+      FileUtils.rm_rf(docs_assets_dir)
+      puts "✓ Removed #{docs_assets_dir}"
+    end
+
+    # Clean docs includes
+    if Dir.exist?(docs_examples_dir)
+      FileUtils.rm_rf(docs_examples_dir)
+      puts "✓ Removed #{docs_examples_dir}"
+    end
+
+    puts "\n✅ Cleaned all generated files!"
+  end
+end