RubyGems - bunny_farm - Versions diffs - 0.1.2 - Mend

bunny_farm 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (106) hide show

checksums.yaml +7 -0
data/.envrc +1 -0
data/.github/workflows/docs.yml +38 -0
data/.gitignore +11 -0
data/.travis.yml +3 -0
data/CHANGELOG.md +61 -0
data/COMMITS.md +196 -0
data/Gemfile +4 -0
data/LICENSE.txt +21 -0
data/README.md +330 -0
data/Rakefile +9 -0
data/bunny_farm.gemspec +30 -0
data/config/bunny.yml.erb +29 -0
data/config/bunny_test.yml.erb +29 -0
data/config/hipchat.yml.erb +12 -0
data/docs/api/configuration.md +9 -0
data/docs/api/consumer.md +8 -0
data/docs/api/message-class.md +419 -0
data/docs/api/publisher.md +9 -0
data/docs/architecture/integration.md +8 -0
data/docs/architecture/message-flow.md +11 -0
data/docs/architecture/overview.md +448 -0
data/docs/architecture/scaling.md +8 -0
data/docs/assets/actions_dsl_flow.svg +109 -0
data/docs/assets/architecture_overview.svg +152 -0
data/docs/assets/best_practices_patterns.svg +203 -0
data/docs/assets/bunny_farm_logo.png +0 -0
data/docs/assets/configuration_api_methods.svg +104 -0
data/docs/assets/configuration_flow.svg +130 -0
data/docs/assets/configuration_hierarchy.svg +70 -0
data/docs/assets/data_processing_pipeline.svg +131 -0
data/docs/assets/debugging_monitoring.svg +165 -0
data/docs/assets/ecommerce_example_flow.svg +145 -0
data/docs/assets/email_campaign_example.svg +127 -0
data/docs/assets/environment_variables_map.svg +78 -0
data/docs/assets/error_handling_flow.svg +114 -0
data/docs/assets/favicon.ico +1 -0
data/docs/assets/fields_dsl_structure.svg +89 -0
data/docs/assets/instance_methods_lifecycle.svg +137 -0
data/docs/assets/integration_patterns.svg +207 -0
data/docs/assets/json_serialization_flow.svg +153 -0
data/docs/assets/logo.svg +4 -0
data/docs/assets/message_api_overview.svg +126 -0
data/docs/assets/message_encapsulation.svg +113 -0
data/docs/assets/message_lifecycle.svg +110 -0
data/docs/assets/message_structure.svg +138 -0
data/docs/assets/publisher_consumer_api.svg +120 -0
data/docs/assets/scaling_deployment_patterns.svg +195 -0
data/docs/assets/smart_routing_diagram.svg +131 -0
data/docs/assets/system_architecture_overview.svg +155 -0
data/docs/assets/task_scheduling_flow.svg +139 -0
data/docs/assets/testing_strategies.svg +146 -0
data/docs/assets/workflow_patterns.svg +183 -0
data/docs/assets/yaml_config_structure.svg +72 -0
data/docs/configuration/environment-variables.md +14 -0
data/docs/configuration/overview.md +373 -0
data/docs/configuration/programmatic-setup.md +10 -0
data/docs/configuration/yaml-configuration.md +12 -0
data/docs/core-features/configuration.md +528 -0
data/docs/core-features/error-handling.md +82 -0
data/docs/core-features/json-serialization.md +545 -0
data/docs/core-features/message-design.md +406 -0
data/docs/core-features/smart-routing.md +467 -0
data/docs/core-features/task-scheduling.md +67 -0
data/docs/core-features/workflow-support.md +112 -0
data/docs/development/contributing.md +345 -0
data/docs/development/roadmap.md +9 -0
data/docs/development/testing.md +14 -0
data/docs/examples/order-processing.md +10 -0
data/docs/examples/overview.md +269 -0
data/docs/examples/real-world.md +8 -0
data/docs/examples/simple-producer-consumer.md +15 -0
data/docs/examples/task-scheduler.md +9 -0
data/docs/getting-started/basic-concepts.md +274 -0
data/docs/getting-started/installation.md +122 -0
data/docs/getting-started/quick-start.md +158 -0
data/docs/index.md +106 -0
data/docs/message-structure/actions-dsl.md +163 -0
data/docs/message-structure/fields-dsl.md +146 -0
data/docs/message-structure/instance-methods.md +115 -0
data/docs/message-structure/overview.md +211 -0
data/examples/README.md +212 -0
data/examples/consumer.rb +41 -0
data/examples/images/message_flow.svg +87 -0
data/examples/images/order_workflow.svg +122 -0
data/examples/images/producer_consumer.svg +96 -0
data/examples/images/task_scheduler.svg +140 -0
data/examples/order_processor.rb +238 -0
data/examples/producer.rb +60 -0
data/examples/simple_message.rb +43 -0
data/examples/task_scheduler.rb +263 -0
data/images/architecture_overview.svg +152 -0
data/images/bunny_farm_logo.png +0 -0
data/images/configuration_flow.svg +130 -0
data/images/message_structure.svg +138 -0
data/lib/bunny_farm/.irbrc +7 -0
data/lib/bunny_farm/generic_consumer.rb +12 -0
data/lib/bunny_farm/hash_ext.rb +37 -0
data/lib/bunny_farm/init_bunny.rb +137 -0
data/lib/bunny_farm/init_hipchat.rb +49 -0
data/lib/bunny_farm/message.rb +218 -0
data/lib/bunny_farm/message_elements.rb +25 -0
data/lib/bunny_farm/version.rb +3 -0
data/lib/bunny_farm.rb +9 -0
data/mkdocs.yml +148 -0
metadata +244 -0

data/examples/task_scheduler.rb ADDED Viewed

@@ -0,0 +1,263 @@
+#!/usr/bin/env ruby
+# Task scheduler example - demonstrates scheduled/delayed message processing
+require 'bundler/setup'
+require 'bunny_farm'
+require 'time'
+# Message class for scheduled tasks
+class ScheduledTask < BunnyFarm::Message
+  fields :task_id, :task_type, :scheduled_for, :payload, :retry_count
+  actions :execute, :retry, :report_failure
+  def execute(*args)
+    scheduled_time = Time.parse(@items[:scheduled_for])
+    current_time = Time.now
+    puts "\n⏰ Executing scheduled task ##{@items[:task_id]}"
+    puts "   Type: #{@items[:task_type]}"
+    puts "   Scheduled for: #{scheduled_time}"
+    puts "   Current time: #{current_time}"
+    # Check if we should execute now
+    if current_time < scheduled_time
+      delay = (scheduled_time - current_time).to_i
+      puts "   ⏳ Too early! Delaying for #{delay} seconds..."
+      # In a real system, you might requeue with a delay
+      # For demo, we'll just sleep
+      sleep [delay, 5].min  # Cap at 5 seconds for demo
+    end
+    # Execute the task based on type
+    case @items[:task_type]
+    when 'email_reminder'
+      send_email_reminder
+    when 'data_backup'
+      perform_backup
+    when 'report_generation'
+      generate_report
+    when 'cleanup'
+      perform_cleanup
+    else
+      failure("Unknown task type: #{@items[:task_type]}")
+      return
+    end
+    success!
+  rescue => e
+    puts "   ❌ Task failed: #{e.message}"
+    # Increment retry count
+    @items[:retry_count] = (@items[:retry_count] || 0) + 1
+    if @items[:retry_count] < 3
+      publish('retry')
+    else
+      publish('report_failure')
+    end
+    failure(e.message)
+  end
+  def retry(*args)
+    puts "\n🔄 Retrying task ##{@items[:task_id]} (attempt #{@items[:retry_count]})"
+    # Add exponential backoff
+    sleep_time = 2 ** @items[:retry_count]
+    puts "   Waiting #{sleep_time} seconds before retry..."
+    sleep sleep_time
+    # Re-execute
+    publish('execute')
+    success!
+  end
+  def report_failure(*args)
+    puts "\n🚨 Task ##{@items[:task_id]} failed after #{@items[:retry_count]} attempts!"
+    puts "   Sending failure notification..."
+    # In a real system, this might send alerts to administrators
+    # Log to error tracking service, send emails, etc.
+    success!  # We successfully handled the failure
+  end
+  private
+  def send_email_reminder
+    puts "   📧 Sending email reminder..."
+    recipient = @items[:payload]['recipient'] || 'user@example.com'
+    subject = @items[:payload]['subject'] || 'Reminder'
+    puts "      To: #{recipient}"
+    puts "      Subject: #{subject}"
+    # Simulate email sending
+    sleep 0.5
+    # Randomly fail sometimes for demo
+    raise "SMTP connection failed" if rand > 0.8
+    puts "   ✅ Email sent successfully"
+  end
+  def perform_backup
+    puts "   💾 Performing data backup..."
+    database = @items[:payload]['database'] || 'main_db'
+    puts "      Database: #{database}"
+    # Simulate backup
+    sleep 1
+    backup_file = "/backups/#{database}_#{Time.now.strftime('%Y%m%d_%H%M%S')}.sql"
+    puts "   ✅ Backup completed: #{backup_file}"
+  end
+  def generate_report
+    puts "   📊 Generating report..."
+    report_type = @items[:payload]['type'] || 'daily_sales'
+    puts "      Type: #{report_type}"
+    # Simulate report generation
+    sleep 0.8
+    puts "   ✅ Report generated and sent to stakeholders"
+  end
+  def perform_cleanup
+    puts "   🧹 Performing cleanup tasks..."
+    target = @items[:payload]['target'] || 'temp_files'
+    puts "      Target: #{target}"
+    # Simulate cleanup
+    sleep 0.3
+    puts "   ✅ Cleaned up #{rand(10..50)} old #{target}"
+  end
+end
+# Main execution
+if __FILE__ == $0
+  require 'optparse'
+  mode = nil
+  OptionParser.new do |opts|
+    opts.banner = "Usage: #{$0} [options]"
+    opts.on("-s", "--scheduler", "Run as task scheduler (producer)") { mode = :scheduler }
+    opts.on("-w", "--worker", "Run as task worker (consumer)") { mode = :worker }
+    opts.on("-h", "--help", "Show this help") do
+      puts opts
+      exit
+    end
+  end.parse!
+  if mode.nil?
+    puts "Please specify --scheduler or --worker mode"
+    exit 1
+  end
+  # Configure BunnyFarm
+  BunnyFarm.config do
+    env 'development'
+    app_id mode == :scheduler ? 'task_scheduler' : 'task_worker'
+    if mode == :worker
+      # Configure to receive all ScheduledTask actions
+      bunny Hashie::Mash.new(
+        YAML.load(
+          ERB.new(
+            File.read(
+              File.join(BunnyFarm::CONFIG.config_dir, BunnyFarm::CONFIG.bunny_file)
+            )
+          ).result, aliases: true
+        )[BunnyFarm::CONFIG.env].merge(
+          'routing_key' => 'ScheduledTask.*'
+        )
+      )
+    end
+  end
+  if mode == :scheduler
+    puts "Task Scheduler"
+    puts "=" * 40
+    puts "Scheduling tasks for execution..."
+    # Create various scheduled tasks
+    tasks = [
+      {
+        task_id: "TASK-#{rand(1000..9999)}",
+        task_type: 'email_reminder',
+        scheduled_for: (Time.now + 2).to_s,  # 2 seconds from now
+        payload: {
+          'recipient' => 'alice@example.com',
+          'subject' => 'Meeting in 15 minutes'
+        },
+        retry_count: 0
+      },
+      {
+        task_id: "TASK-#{rand(1000..9999)}",
+        task_type: 'data_backup',
+        scheduled_for: Time.now.to_s,  # Execute immediately
+        payload: {
+          'database' => 'users_db'
+        },
+        retry_count: 0
+      },
+      {
+        task_id: "TASK-#{rand(1000..9999)}",
+        task_type: 'report_generation',
+        scheduled_for: (Time.now + 5).to_s,  # 5 seconds from now
+        payload: {
+          'type' => 'weekly_analytics'
+        },
+        retry_count: 0
+      },
+      {
+        task_id: "TASK-#{rand(1000..9999)}",
+        task_type: 'cleanup',
+        scheduled_for: (Time.now + 3).to_s,  # 3 seconds from now
+        payload: {
+          'target' => 'log_files'
+        },
+        retry_count: 0
+      }
+    ]
+    tasks.each do |task_data|
+      msg = ScheduledTask.new
+      task_data.each do |key, value|
+        msg[key] = value
+      end
+      if msg.publish('execute')
+        puts "✅ Scheduled task #{task_data[:task_id]} (#{task_data[:task_type]})"
+        puts "   Scheduled for: #{task_data[:scheduled_for]}"
+      else
+        puts "❌ Failed to schedule task: #{msg.errors.join(', ')}"
+      end
+      sleep 0.5
+    end
+    puts "\n📅 All tasks scheduled!"
+    puts "Run with --worker in another terminal to process them."
+  else  # worker mode
+    puts "Task Worker"
+    puts "=" * 40
+    puts "Processing scheduled tasks..."
+    puts "Press Ctrl+C to exit"
+    begin
+      BunnyFarm.manage(false)
+    rescue Interrupt
+      puts "\n\nShutting down task worker..."
+    end
+  end
+  # Clean up
+  if BunnyFarm::CONFIG.connection && BunnyFarm::CONFIG.connection.open?
+    BunnyFarm::CONFIG.connection.close
+  end
+end

data/images/architecture_overview.svg ADDED Viewed

@@ -0,0 +1,152 @@
+<svg width="900" height="600" xmlns="http://www.w3.org/2000/svg">
+  <!-- Background transparent -->
+  <rect width="900" height="600" fill="transparent"/>
+  <!-- Title -->
+  <text x="450" y="35" text-anchor="middle" font-family="Arial, sans-serif" font-size="22" font-weight="bold" fill="#e0e0e0">
+    BunnyFarm Architecture Overview
+  </text>
+  <!-- Ruby Application Layer -->
+  <g>
+    <rect x="50" y="80" width="800" height="120" rx="15" fill="#2d3748" stroke="#68d391" stroke-width="3"/>
+    <text x="450" y="110" text-anchor="middle" font-family="Arial, sans-serif" font-size="18" font-weight="bold" fill="#68d391">
+      Ruby Application Layer
+    </text>
+    <!-- Producer Apps -->
+    <rect x="80" y="130" width="140" height="50" rx="8" fill="#1a202c" stroke="#68d391" stroke-width="1"/>
+    <text x="150" y="150" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#68d391">Web App</text>
+    <text x="150" y="165" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Form Submissions</text>
+    <rect x="240" y="130" width="140" height="50" rx="8" fill="#1a202c" stroke="#68d391" stroke-width="1"/>
+    <text x="310" y="150" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#68d391">API Server</text>
+    <text x="310" y="165" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">REST Endpoints</text>
+    <rect x="400" y="130" width="140" height="50" rx="8" fill="#1a202c" stroke="#68d391" stroke-width="1"/>
+    <text x="470" y="150" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#68d391">Scheduler</text>
+    <text x="470" y="165" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Cron Jobs</text>
+    <!-- Consumer Apps -->
+    <rect x="560" y="130" width="140" height="50" rx="8" fill="#1a202c" stroke="#ed8936" stroke-width="1"/>
+    <text x="630" y="150" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#ed8936">Worker 1</text>
+    <text x="630" y="165" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Background Jobs</text>
+    <rect x="720" y="130" width="140" height="50" rx="8" fill="#1a202c" stroke="#ed8936" stroke-width="1"/>
+    <text x="790" y="150" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#ed8936">Worker 2</text>
+    <text x="790" y="165" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">Microservice</text>
+  </g>
+  <!-- BunnyFarm Library Layer -->
+  <g>
+    <rect x="50" y="240" width="800" height="100" rx="15" fill="#2d3748" stroke="#9f7aea" stroke-width="3"/>
+    <text x="450" y="270" text-anchor="middle" font-family="Arial, sans-serif" font-size="18" font-weight="bold" fill="#9f7aea">
+      BunnyFarm Library
+    </text>
+    <!-- Core Components -->
+    <rect x="80" y="285" width="120" height="40" rx="5" fill="#9f7aea" stroke="#9f7aea" stroke-width="1"/>
+    <text x="140" y="300" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" font-weight="bold" fill="#1a202c">Message</text>
+    <text x="140" y="315" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">Base Class</text>
+    <rect x="220" y="285" width="120" height="40" rx="5" fill="#9f7aea" stroke="#9f7aea" stroke-width="1"/>
+    <text x="280" y="300" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" font-weight="bold" fill="#1a202c">Publisher</text>
+    <text x="280" y="315" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">Send Messages</text>
+    <rect x="360" y="285" width="120" height="40" rx="5" fill="#9f7aea" stroke="#9f7aea" stroke-width="1"/>
+    <text x="420" y="300" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" font-weight="bold" fill="#1a202c">Consumer</text>
+    <text x="420" y="315" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">Receive & Process</text>
+    <rect x="500" y="285" width="120" height="40" rx="5" fill="#9f7aea" stroke="#9f7aea" stroke-width="1"/>
+    <text x="560" y="300" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" font-weight="bold" fill="#1a202c">Config</text>
+    <text x="560" y="315" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">Settings</text>
+    <rect x="640" y="285" width="120" height="40" rx="5" fill="#9f7aea" stroke="#9f7aea" stroke-width="1"/>
+    <text x="700" y="300" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" font-weight="bold" fill="#1a202c">Router</text>
+    <text x="700" y="315" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">Routing Keys</text>
+  </g>
+  <!-- RabbitMQ Layer -->
+  <g>
+    <rect x="50" y="380" width="800" height="120" rx="15" fill="#1a365d" stroke="#2b6cb0" stroke-width="3"/>
+    <text x="450" y="410" text-anchor="middle" font-family="Arial, sans-serif" font-size="18" font-weight="bold" fill="#90cdf4">
+      RabbitMQ Message Broker
+    </text>
+    <!-- Exchange -->
+    <rect x="120" y="430" width="140" height="50" rx="8" fill="#2b6cb0" stroke="#90cdf4" stroke-width="1"/>
+    <text x="190" y="450" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#e6fffa">Exchange</text>
+    <text x="190" y="465" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#bee3f8">Topic Router</text>
+    <!-- Queues -->
+    <rect x="300" y="430" width="100" height="50" rx="8" fill="#2b6cb0" stroke="#90cdf4" stroke-width="1"/>
+    <text x="350" y="450" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#e6fffa">Queue 1</text>
+    <text x="350" y="465" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#bee3f8">Orders</text>
+    <rect x="420" y="430" width="100" height="50" rx="8" fill="#2b6cb0" stroke="#90cdf4" stroke-width="1"/>
+    <text x="470" y="450" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#e6fffa">Queue 2</text>
+    <text x="470" y="465" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#bee3f8">Tasks</text>
+    <rect x="540" y="430" width="100" height="50" rx="8" fill="#2b6cb0" stroke="#90cdf4" stroke-width="1"/>
+    <text x="590" y="450" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#e6fffa">Queue 3</text>
+    <text x="590" y="465" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#bee3f8">Emails</text>
+    <!-- Management -->
+    <rect x="680" y="430" width="100" height="50" rx="8" fill="#2b6cb0" stroke="#90cdf4" stroke-width="1"/>
+    <text x="730" y="450" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#e6fffa">Management</text>
+    <text x="730" y="465" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#bee3f8">Web UI</text>
+  </g>
+  <!-- Storage Layer -->
+  <g>
+    <rect x="50" y="540" width="800" height="50" rx="15" fill="#2d3748" stroke="#4a5568" stroke-width="2"/>
+    <text x="450" y="560" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="#cbd5e0">
+      Persistence & External Services
+    </text>
+    <rect x="100" y="555" width="120" height="30" rx="5" fill="#4a5568"/>
+    <text x="160" y="573" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" fill="#e0e0e0">Database</text>
+    <rect x="240" y="555" width="120" height="30" rx="5" fill="#4a5568"/>
+    <text x="300" y="573" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" fill="#e0e0e0">Email Service</text>
+    <rect x="380" y="555" width="120" height="30" rx="5" fill="#4a5568"/>
+    <text x="440" y="573" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" fill="#e0e0e0">File Storage</text>
+    <rect x="520" y="555" width="120" height="30" rx="5" fill="#4a5568"/>
+    <text x="580" y="573" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" fill="#e0e0e0">APIs</text>
+    <rect x="660" y="555" width="120" height="30" rx="5" fill="#4a5568"/>
+    <text x="720" y="573" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" fill="#e0e0e0">Cache/Redis</text>
+  </g>
+  <!-- Flow Arrows -->
+  <defs>
+    <marker id="arrow-down" markerWidth="10" markerHeight="7" refX="9" refY="3.5" orient="auto">
+      <polygon points="0 0, 10 3.5, 0 7" fill="#68d391"/>
+    </marker>
+    <marker id="arrow-up" markerWidth="10" markerHeight="7" refX="9" refY="3.5" orient="auto">
+      <polygon points="0 0, 10 3.5, 0 7" fill="#ed8936"/>
+    </marker>
+  </defs>
+  <!-- Publishers to BunnyFarm -->
+  <line x1="310" y1="200" x2="310" y2="240" stroke="#68d391" stroke-width="2" marker-end="url(#arrow-down)"/>
+  <text x="320" y="220" font-family="Arial, sans-serif" font-size="10" fill="#68d391">publish</text>
+  <!-- BunnyFarm to RabbitMQ -->
+  <line x1="450" y1="340" x2="450" y2="380" stroke="#9f7aea" stroke-width="2" marker-end="url(#arrow-down)"/>
+  <text x="460" y="360" font-family="Arial, sans-serif" font-size="10" fill="#9f7aea">AMQP</text>
+  <!-- RabbitMQ to BunnyFarm (consumers) -->
+  <line x1="650" y1="380" x2="650" y2="340" stroke="#ed8936" stroke-width="2" marker-end="url(#arrow-up)"/>
+  <text x="660" y="360" font-family="Arial, sans-serif" font-size="10" fill="#ed8936">consume</text>
+  <!-- BunnyFarm to Consumers -->
+  <line x1="650" y1="240" x2="650" y2="200" stroke="#ed8936" stroke-width="2" marker-end="url(#arrow-up)"/>
+  <text x="660" y="220" font-family="Arial, sans-serif" font-size="10" fill="#ed8936">execute</text>
+  <!-- Workers to Storage -->
+  <line x1="720" y1="500" x2="720" y2="540" stroke="#4a5568" stroke-width="2" marker-end="url(#arrow-down)"/>
+  <text x="730" y="520" font-family="Arial, sans-serif" font-size="10" fill="#9ca3af">store/fetch</text>
+</svg>

data/images/bunny_farm_logo.png ADDED Viewed

Binary file

data/images/configuration_flow.svg ADDED Viewed

@@ -0,0 +1,130 @@
+<svg width="800" height="500" xmlns="http://www.w3.org/2000/svg">
+  <!-- Background transparent -->
+  <rect width="800" height="500" fill="transparent"/>
+  <!-- Title -->
+  <text x="400" y="30" text-anchor="middle" font-family="Arial, sans-serif" font-size="20" font-weight="bold" fill="#e0e0e0">
+    BunnyFarm Configuration Options
+  </text>
+  <!-- Environment Variables -->
+  <g>
+    <rect x="50" y="70" width="220" height="180" rx="10" fill="#2d3748" stroke="#68d391" stroke-width="2"/>
+    <text x="160" y="95" text-anchor="middle" font-family="Arial, sans-serif" font-size="14" font-weight="bold" fill="#68d391">Environment Variables</text>
+    <rect x="70" y="110" width="180" height="130" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="75" y="125" font-family="monospace" font-size="10" fill="#68d391">AMQP_HOST</text>
+    <text x="140" y="125" font-family="monospace" font-size="10" fill="#e0e0e0">=localhost</text>
+    <text x="75" y="140" font-family="monospace" font-size="10" fill="#68d391">AMQP_VHOST</text>
+    <text x="140" y="140" font-family="monospace" font-size="10" fill="#e0e0e0">=/</text>
+    <text x="75" y="155" font-family="monospace" font-size="10" fill="#68d391">AMQP_PORT</text>
+    <text x="140" y="155" font-family="monospace" font-size="10" fill="#e0e0e0">=5672</text>
+    <text x="75" y="170" font-family="monospace" font-size="10" fill="#68d391">AMQP_USER</text>
+    <text x="140" y="170" font-family="monospace" font-size="10" fill="#e0e0e0">=guest</text>
+    <text x="75" y="185" font-family="monospace" font-size="10" fill="#68d391">AMQP_PASS</text>
+    <text x="140" y="185" font-family="monospace" font-size="10" fill="#e0e0e0">=guest</text>
+    <text x="75" y="200" font-family="monospace" font-size="10" fill="#68d391">AMQP_EXCHANGE</text>
+    <text x="155" y="200" font-family="monospace" font-size="10" fill="#e0e0e0">=my_exchange</text>
+    <text x="75" y="215" font-family="monospace" font-size="10" fill="#68d391">AMQP_QUEUE</text>
+    <text x="135" y="215" font-family="monospace" font-size="10" fill="#e0e0e0">=my_queue</text>
+    <text x="75" y="230" font-family="monospace" font-size="10" fill="#68d391">AMQP_ROUTING_KEY</text>
+    <text x="175" y="230" font-family="monospace" font-size="10" fill="#e0e0e0">=#</text>
+  </g>
+  <!-- YAML Configuration -->
+  <g>
+    <rect x="300" y="70" width="220" height="180" rx="10" fill="#2d3748" stroke="#4299e1" stroke-width="2"/>
+    <text x="410" y="95" text-anchor="middle" font-family="Arial, sans-serif" font-size="14" font-weight="bold" fill="#4299e1">YAML Configuration</text>
+    <text x="410" y="110" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">config/bunny.yml.erb</text>
+    <rect x="320" y="120" width="180" height="120" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="325" y="135" font-family="monospace" font-size="10" fill="#4299e1">defaults: &defaults</text>
+    <text x="330" y="150" font-family="monospace" font-size="10" fill="#68d391">host:</text>
+    <text x="360" y="150" font-family="monospace" font-size="10" fill="#f6e05e">&lt;%= ENV['AMQP_HOST'] %&gt;</text>
+    <text x="330" y="165" font-family="monospace" font-size="10" fill="#68d391">port:</text>
+    <text x="360" y="165" font-family="monospace" font-size="10" fill="#f6e05e">&lt;%= ENV['AMQP_PORT'] %&gt;</text>
+    <text x="325" y="180" font-family="monospace" font-size="10" fill="#4299e1">development:</text>
+    <text x="330" y="195" font-family="monospace" font-size="10" fill="#e0e0e0">&lt;&lt;: *defaults</text>
+    <text x="325" y="210" font-family="monospace" font-size="10" fill="#4299e1">production:</text>
+    <text x="330" y="225" font-family="monospace" font-size="10" fill="#e0e0e0">&lt;&lt;: *defaults</text>
+  </g>
+  <!-- Programmatic Configuration -->
+  <g>
+    <rect x="550" y="70" width="220" height="180" rx="10" fill="#2d3748" stroke="#9f7aea" stroke-width="2"/>
+    <text x="660" y="95" text-anchor="middle" font-family="Arial, sans-serif" font-size="14" font-weight="bold" fill="#9f7aea">Ruby Configuration</text>
+    <text x="660" y="110" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#e0e0e0">BunnyFarm.config block</text>
+    <rect x="570" y="120" width="180" height="120" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="575" y="135" font-family="monospace" font-size="10" fill="#9f7aea">BunnyFarm.config do</text>
+    <text x="580" y="150" font-family="monospace" font-size="10" fill="#68d391">env</text>
+    <text x="605" y="150" font-family="monospace" font-size="10" fill="#e0e0e0">'production'</text>
+    <text x="580" y="165" font-family="monospace" font-size="10" fill="#68d391">app_id</text>
+    <text x="620" y="165" font-family="monospace" font-size="10" fill="#e0e0e0">'my_worker'</text>
+    <text x="580" y="180" font-family="monospace" font-size="10" fill="#68d391">bunny_file</text>
+    <text x="645" y="180" font-family="monospace" font-size="10" fill="#e0e0e0">'custom.yml'</text>
+    <text x="580" y="195" font-family="monospace" font-size="10" fill="#9ca3af"># Custom settings</text>
+    <text x="575" y="230" font-family="monospace" font-size="10" fill="#9f7aea">end</text>
+  </g>
+  <!-- Configuration Flow -->
+  <g>
+    <rect x="50" y="280" width="700" height="120" rx="10" fill="#2d3748" stroke="#f6e05e" stroke-width="2"/>
+    <text x="400" y="305" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="#f6e05e">Configuration Priority Flow</text>
+    <!-- Priority boxes -->
+    <rect x="80" y="325" width="120" height="60" rx="8" fill="#68d391" stroke="#68d391" stroke-width="1"/>
+    <text x="140" y="345" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#1a202c">1. Defaults</text>
+    <text x="140" y="365" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#1a202c">Built-in values</text>
+    <rect x="220" y="325" width="120" height="60" rx="8" fill="#4299e1" stroke="#4299e1" stroke-width="1"/>
+    <text x="280" y="345" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#1a202c">2. YAML</text>
+    <text x="280" y="365" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#1a202c">Config file</text>
+    <rect x="360" y="325" width="120" height="60" rx="8" fill="#68d391" stroke="#68d391" stroke-width="1"/>
+    <text x="420" y="345" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#1a202c">3. ENV Vars</text>
+    <text x="420" y="365" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#1a202c">Environment</text>
+    <rect x="500" y="325" width="120" height="60" rx="8" fill="#9f7aea" stroke="#9f7aea" stroke-width="1"/>
+    <text x="560" y="345" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#1a202c">4. Ruby Code</text>
+    <text x="560" y="365" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#1a202c">Programmatic</text>
+    <rect x="640" y="325" width="120" height="60" rx="8" fill="#e53e3e" stroke="#e53e3e" stroke-width="1"/>
+    <text x="700" y="345" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#1a202c">Final Config</text>
+    <text x="700" y="365" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" fill="#1a202c">Used by app</text>
+    <!-- Arrows -->
+    <defs>
+      <marker id="arrow-priority" markerWidth="10" markerHeight="7" refX="9" refY="3.5" orient="auto">
+        <polygon points="0 0, 10 3.5, 0 7" fill="#f6e05e"/>
+      </marker>
+    </defs>
+    <line x1="200" y1="355" x2="220" y2="355" stroke="#f6e05e" stroke-width="2" marker-end="url(#arrow-priority)"/>
+    <line x1="340" y1="355" x2="360" y2="355" stroke="#f6e05e" stroke-width="2" marker-end="url(#arrow-priority)"/>
+    <line x1="480" y1="355" x2="500" y2="355" stroke="#f6e05e" stroke-width="2" marker-end="url(#arrow-priority)"/>
+    <line x1="620" y1="355" x2="640" y2="355" stroke="#f6e05e" stroke-width="2" marker-end="url(#arrow-priority)"/>
+  </g>
+  <!-- Example Use Cases -->
+  <g>
+    <rect x="50" y="420" width="700" height="70" rx="10" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="400" y="440" text-anchor="middle" font-family="Arial, sans-serif" font-size="14" font-weight="bold" fill="#f6e05e">Common Configuration Patterns</text>
+    <text x="70" y="460" font-family="Arial, sans-serif" font-size="11" font-weight="bold" fill="#68d391">Development:</text>
+    <text x="150" y="460" font-family="Arial, sans-serif" font-size="11" fill="#e0e0e0">Local RabbitMQ, default settings</text>
+    <text x="400" y="460" font-family="Arial, sans-serif" font-size="11" font-weight="bold" fill="#4299e1">Production:</text>
+    <text x="470" y="460" font-family="Arial, sans-serif" font-size="11" fill="#e0e0e0">Environment variables for security</text>
+    <text x="70" y="475" font-family="Arial, sans-serif" font-size="11" font-weight="bold" fill="#ed8936">Testing:</text>
+    <text x="125" y="475" font-family="Arial, sans-serif" font-size="11" fill="#e0e0e0">Custom config with test-specific settings</text>
+  </g>
+</svg>