bunny_farm 0.1.2

data/mkdocs.yml

@@ -0,0 +1,148 @@
+site_name: BunnyFarm Documentation
+site_description: Comprehensive documentation for the BunnyFarm Ruby gem - Lightweight AMQP/JSON background job manager for RabbitMQ
+site_author: MadBomber
+site_url: https://madbomber.github.io/bunny_farm
+repo_url: https://github.com/MadBomber/bunny_farm
+repo_name: MadBomber/bunny_farm
+edit_uri: edit/master/docs/
+
+theme:
+  name: material
+  logo: assets/logo.svg
+  favicon: assets/favicon.ico
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: orange
+      accent: deep-orange
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: orange
+      accent: deep-orange
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - navigation.instant
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.sections
+    - navigation.expand
+    - navigation.path
+    - navigation.prune
+    - navigation.indexes
+    - navigation.top
+    - toc.follow
+    - toc.integrate
+    - search.suggest
+    - search.highlight
+    - search.share
+    - header.autohide
+    - content.code.copy
+    - content.code.annotate
+    - content.tabs.link
+
+plugins:
+  - search:
+      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
+
+markdown_extensions:
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - toc:
+      permalink: true
+      toc_depth: 3
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/MadBomber/bunny_farm
+      name: GitHub Repository
+    - icon: fontawesome/solid/gem
+      link: https://rubygems.org/gems/bunny_farm
+      name: RubyGems Package
+  version:
+    provider: mike
+    default: latest
+
+nav:
+  - Home: index.md
+  - Getting Started:
+    - Installation: getting-started/installation.md
+    - Quick Start: getting-started/quick-start.md
+    - Basic Concepts: getting-started/basic-concepts.md
+  - Core Features:
+    - Message-Centric Design: core-features/message-design.md
+    - Smart Routing: core-features/smart-routing.md
+    - JSON Serialization: core-features/json-serialization.md
+    - Configuration: core-features/configuration.md
+    - Workflow Support: core-features/workflow-support.md
+    - Task Scheduling: core-features/task-scheduling.md
+    - Error Handling: core-features/error-handling.md
+  - Message Structure:
+    - Overview: message-structure/overview.md
+    - Fields DSL: message-structure/fields-dsl.md
+    - Actions DSL: message-structure/actions-dsl.md
+    - Instance Methods: message-structure/instance-methods.md
+  - Configuration:
+    - Overview: configuration/overview.md
+    - Environment Variables: configuration/environment-variables.md
+    - YAML Configuration: configuration/yaml-configuration.md
+    - Programmatic Setup: configuration/programmatic-setup.md
+  - API Reference:
+    - Message Class: api/message-class.md
+    - Publisher: api/publisher.md
+    - Consumer: api/consumer.md
+    - Configuration: api/configuration.md
+  - Examples:
+    - Overview: examples/overview.md
+    - Simple Producer/Consumer: examples/simple-producer-consumer.md
+    - Order Processing Workflow: examples/order-processing.md
+    - Task Scheduler: examples/task-scheduler.md
+    - Real World Examples: examples/real-world.md
+  - Architecture:
+    - Overview: architecture/overview.md
+    - Message Flow: architecture/message-flow.md
+    - Scaling Patterns: architecture/scaling.md
+    - Integration Patterns: architecture/integration.md
+  - Development:
+    - Contributing: development/contributing.md
+    - Testing: development/testing.md
+    - Roadmap: development/roadmap.md
+
+copyright: Copyright © 2024 MadBomber - MIT License

metadata

@@ -0,0 +1,244 @@
+--- !ruby/object:Gem::Specification
+name: bunny_farm
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Dewayne VanHoozer
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " A lightweight Ruby gem for managing background jobs using RabbitMQ.
+  Messages are encapsulated as classes with JSON serialization and routing keys in
+  the format MessageClassName.action for simple, organized job processing. "
+email:
+- dvanhoozer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".github/workflows/docs.yml"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- COMMITS.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bunny_farm.gemspec
+- config/bunny.yml.erb
+- config/bunny_test.yml.erb
+- config/hipchat.yml.erb
+- docs/api/configuration.md
+- docs/api/consumer.md
+- docs/api/message-class.md
+- docs/api/publisher.md
+- docs/architecture/integration.md
+- docs/architecture/message-flow.md
+- docs/architecture/overview.md
+- docs/architecture/scaling.md
+- docs/assets/actions_dsl_flow.svg
+- docs/assets/architecture_overview.svg
+- docs/assets/best_practices_patterns.svg
+- docs/assets/bunny_farm_logo.png
+- docs/assets/configuration_api_methods.svg
+- docs/assets/configuration_flow.svg
+- docs/assets/configuration_hierarchy.svg
+- docs/assets/data_processing_pipeline.svg
+- docs/assets/debugging_monitoring.svg
+- docs/assets/ecommerce_example_flow.svg
+- docs/assets/email_campaign_example.svg
+- docs/assets/environment_variables_map.svg
+- docs/assets/error_handling_flow.svg
+- docs/assets/favicon.ico
+- docs/assets/fields_dsl_structure.svg
+- docs/assets/instance_methods_lifecycle.svg
+- docs/assets/integration_patterns.svg
+- docs/assets/json_serialization_flow.svg
+- docs/assets/logo.svg
+- docs/assets/message_api_overview.svg
+- docs/assets/message_encapsulation.svg
+- docs/assets/message_lifecycle.svg
+- docs/assets/message_structure.svg
+- docs/assets/publisher_consumer_api.svg
+- docs/assets/scaling_deployment_patterns.svg
+- docs/assets/smart_routing_diagram.svg
+- docs/assets/system_architecture_overview.svg
+- docs/assets/task_scheduling_flow.svg
+- docs/assets/testing_strategies.svg
+- docs/assets/workflow_patterns.svg
+- docs/assets/yaml_config_structure.svg
+- docs/configuration/environment-variables.md
+- docs/configuration/overview.md
+- docs/configuration/programmatic-setup.md
+- docs/configuration/yaml-configuration.md
+- docs/core-features/configuration.md
+- docs/core-features/error-handling.md
+- docs/core-features/json-serialization.md
+- docs/core-features/message-design.md
+- docs/core-features/smart-routing.md
+- docs/core-features/task-scheduling.md
+- docs/core-features/workflow-support.md
+- docs/development/contributing.md
+- docs/development/roadmap.md
+- docs/development/testing.md
+- docs/examples/order-processing.md
+- docs/examples/overview.md
+- docs/examples/real-world.md
+- docs/examples/simple-producer-consumer.md
+- docs/examples/task-scheduler.md
+- docs/getting-started/basic-concepts.md
+- docs/getting-started/installation.md
+- docs/getting-started/quick-start.md
+- docs/index.md
+- docs/message-structure/actions-dsl.md
+- docs/message-structure/fields-dsl.md
+- docs/message-structure/instance-methods.md
+- docs/message-structure/overview.md
+- examples/README.md
+- examples/consumer.rb
+- examples/images/message_flow.svg
+- examples/images/order_workflow.svg
+- examples/images/producer_consumer.svg
+- examples/images/task_scheduler.svg
+- examples/order_processor.rb
+- examples/producer.rb
+- examples/simple_message.rb
+- examples/task_scheduler.rb
+- images/architecture_overview.svg
+- images/bunny_farm_logo.png
+- images/configuration_flow.svg
+- images/message_structure.svg
+- lib/bunny_farm.rb
+- lib/bunny_farm/.irbrc
+- lib/bunny_farm/generic_consumer.rb
+- lib/bunny_farm/hash_ext.rb
+- lib/bunny_farm/init_bunny.rb
+- lib/bunny_farm/init_hipchat.rb
+- lib/bunny_farm/message.rb
+- lib/bunny_farm/message_elements.rb
+- lib/bunny_farm/version.rb
+- mkdocs.yml
+homepage: https://github.com/MadBomber/bunny_farm
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Simple AMQP/JSON background job manager for RabbitMQ
+test_files: []