smart_message 0.0.1

data/lib/smart_message/transport/memory_transport.rb

@@ -0,0 +1,69 @@
+# lib/smart_message/transport/memory_transport.rb
+# encoding: utf-8
+# frozen_string_literal: true
+
+module SmartMessage
+  module Transport
+    # In-memory transport for testing and local development
+    # Messages are stored in memory and can be synchronously processed
+    class MemoryTransport < Base
+      attr_reader :messages
+
+      def default_options
+        {
+          auto_process: true,
+          max_messages: 1000
+        }
+      end
+
+      def configure
+        @messages = []
+        @message_mutex = Mutex.new
+      end
+
+      # Publish message to memory queue
+      def publish(message_header, message_payload)
+        @message_mutex.synchronize do
+          # Prevent memory overflow
+          @messages.shift if @messages.size >= @options[:max_messages]
+          
+          @messages << {
+            header: message_header,
+            payload: message_payload,
+            published_at: Time.now
+          }
+        end
+
+        # Auto-process if enabled
+        receive(message_header, message_payload) if @options[:auto_process]
+      end
+
+      # Get all stored messages
+      def all_messages
+        @message_mutex.synchronize { @messages.dup }
+      end
+
+      # Get message count
+      def message_count
+        @message_mutex.synchronize { @messages.size }
+      end
+
+      # Clear all messages
+      def clear_messages
+        @message_mutex.synchronize { @messages.clear }
+      end
+
+      # Process all pending messages
+      def process_all
+        messages_to_process = @message_mutex.synchronize { @messages.dup }
+        messages_to_process.each do |msg|
+          receive(msg[:header], msg[:payload])
+        end
+      end
+
+      def connected?
+        true
+      end
+    end
+  end
+end

data/lib/smart_message/transport/registry.rb

@@ -0,0 +1,59 @@
+# lib/smart_message/transport/registry.rb
+# encoding: utf-8
+# frozen_string_literal: true
+
+module SmartMessage
+  module Transport
+    # Registry for transport implementations
+    # Provides discovery and management of available transport adapters
+    class Registry
+      def initialize
+        @transports = {}
+        register_builtin_transports
+      end
+
+      # Register a transport class
+      # @param name [Symbol, String] Transport identifier
+      # @param transport_class [Class] Transport implementation class
+      def register(name, transport_class)
+        unless transport_class.ancestors.include?(SmartMessage::Transport::Base)
+          raise ArgumentError, "Transport must inherit from SmartMessage::Transport::Base"
+        end
+        @transports[name.to_sym] = transport_class
+      end
+
+      # Get a transport class by name
+      # @param name [Symbol, String] Transport identifier
+      # @return [Class, nil] Transport class or nil if not found
+      def get(name)
+        @transports[name.to_sym]
+      end
+
+      # Check if a transport is registered
+      # @param name [Symbol, String] Transport identifier
+      # @return [Boolean]
+      def registered?(name)
+        @transports.key?(name.to_sym)
+      end
+
+      # List all registered transport names
+      # @return [Array<Symbol>] List of transport identifiers
+      def list
+        @transports.keys
+      end
+
+      # Clear all registered transports
+      def clear
+        @transports.clear
+      end
+
+      private
+
+      def register_builtin_transports
+        # Register built-in transports
+        register(:stdout, SmartMessage::Transport::StdoutTransport)
+        register(:memory, SmartMessage::Transport::MemoryTransport)
+      end
+    end
+  end
+end

data/lib/smart_message/transport/stdout_transport.rb

@@ -0,0 +1,62 @@
+# lib/smart_message/transport/stdout_transport.rb
+# encoding: utf-8
+# frozen_string_literal: true
+
+module SmartMessage
+  module Transport
+    # STDOUT transport for testing and development
+    # This transport outputs messages to STDOUT and optionally loops them back
+    class StdoutTransport < Base
+      def default_options
+        {
+          loopback: false,
+          output: $stdout
+        }
+      end
+
+      def configure
+        @output = @options[:output].is_a?(String) ? File.open(@options[:output], 'w') : @options[:output]
+      end
+
+      # Enable/disable loopback mode
+      def loopback=(enabled)
+        @options[:loopback] = enabled
+      end
+
+      def loopback?
+        @options[:loopback]
+      end
+
+      # Publish message to STDOUT
+      def publish(message_header, message_payload)
+        @output.puts format_message(message_header, message_payload)
+        @output.flush
+
+        # If loopback is enabled, route the message back through the dispatcher
+        receive(message_header, message_payload) if loopback?
+      end
+
+      def connected?
+        !@output.closed?
+      end
+
+      def disconnect
+        @output.close if @output.respond_to?(:close) && @output != $stdout && @output != $stderr
+      end
+
+      private
+
+      def format_message(message_header, message_payload)
+        <<~MESSAGE
+
+          ===================================================
+          == SmartMessage Published via STDOUT Transport
+          == Header: #{message_header.inspect}
+          == Payload: #{message_payload}
+          ===================================================
+
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/smart_message/transport.rb

@@ -0,0 +1,41 @@
+# lib/smart_message/transport.rb
+# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative 'transport/base'
+require_relative 'transport/registry'
+require_relative 'transport/stdout_transport'
+require_relative 'transport/memory_transport'
+
+module SmartMessage
+  # Transport layer abstraction for SmartMessage
+  module Transport
+    class << self
+      # Get the transport registry instance
+      def registry
+        @registry ||= Registry.new
+      end
+
+      # Register a transport adapter
+      def register(name, transport_class)
+        registry.register(name, transport_class)
+      end
+
+      # Get a transport by name
+      def get(name)
+        registry.get(name)
+      end
+
+      # Create a transport instance with options
+      def create(name, **options)
+        transport_class = get(name)
+        transport_class&.new(**options)
+      end
+
+      # List all registered transports
+      def available
+        registry.list
+      end
+    end
+  end
+end

data/lib/smart_message/version.rb

@@ -0,0 +1,7 @@
+# lib/smart_message/version.rb
+# encoding: utf-8
+# frozen_string_literal: true
+
+module SmartMessage
+  VERSION = "0.0.1"
+end

data/lib/smart_message/wrapper.rb

@@ -0,0 +1,43 @@
+# lib/smart_message/wrapper.rb
+# encoding: utf-8
+# frozen_string_literal: true
+
+# TODO: consider having a serializer plugin for the wrapper that is
+#       different than that used for the payload.
+
+require_relative './header.rb'
+
+module SmartMessage
+  module Wrapper
+    # Every smart message has a common wrapper format that contains
+    # information used to support the dispatching of subscribed
+    # messages upon receipt from a transport as well as the serialized
+    # payload.
+    class Base < Hashie::Dash
+      include Hashie::Extensions::IndifferentAccess
+      include Hashie::Extensions::MergeInitializer
+      include Hashie::Extensions::MethodAccess
+
+      # Common attributes of the smart message standard header
+      # Using '_sm_' as a prefix to avoid potential collision with
+      # a user's message definition.
+      property :_sm_header
+      property :_sm_payload
+
+      def initialize(**props, &block)
+        attributes = {
+          _sm_header: SmartMessage::Header.new(
+            uuid:           SecureRandom.uuid,
+            message_class:  self.class.to_s,
+            published_at:   2,
+            publisher_pid:  3
+          )
+        }.merge(props)
+
+        super(attributes, &block)
+      end
+
+
+    end
+  end
+end

data/lib/smart_message.rb

@@ -0,0 +1,54 @@
+# lib/smart_message.rb
+# encoding: utf-8
+# frozen_string_literal: true
+
+# FIXME: handle this better
+class MilClass  # IMO nil is the same as an empty String
+  def to_s
+    ''
+  end
+end
+
+
+require 'active_support/core_ext/string/inflections'
+require 'date'  # STDLIB
+
+# Production logging should use the logger framework, not debug_me
+
+require 'hashie'         # Your friendly neighborhood hash library.
+
+require_relative './simple_stats'
+
+require_relative './smart_message/version'
+require_relative './smart_message/errors'
+
+require_relative './smart_message/dispatcher.rb'
+require_relative './smart_message/transport.rb'
+require_relative './smart_message/base.rb'
+
+# SmartMessage abstracts messages from the backend transport process
+module SmartMessage
+  # The super class of all smart messages
+  # class Base < Dash from the Hashie gem plus mixins
+  # end
+
+  # encapsulates the message transport plugin
+  # module Transport is defined in transport.rb
+
+  # encapsulates the message code/decode serializer
+  module Serializer
+    # the super class of the message serializer
+    class Base
+    end
+  end
+
+  # encapsulates the message logging capability
+  module Logger
+    # the super class of the message logger
+    class Base
+    end
+  end
+end # module SmartMessage
+
+require_relative './smart_message/serializer'
+require_relative './smart_message/logger'

data/smart_message.gemspec

@@ -0,0 +1,53 @@
+# smart_message.gemspec
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'smart_message/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'smart_message'
+  spec.version       = SmartMessage::VERSION
+  spec.authors       = ['Dewayne VanHoozer']
+  spec.email         = ['dvanhoozer@gmail.com']
+
+  spec.homepage      = "https://github.com/MadBomber/smart_message"
+  spec.summary       = %q{An abstraction to protect message content from the backend delivery transport.}
+  spec.description   = <<~DESCRIPTION
+    Much like ActiveRecord abstracts the model as an ORM from the
+    backend data-store, SmartMessage abstracts the message from
+    its backend transport processes.
+  DESCRIPTION
+
+  spec.metadata = {
+    "homepage_uri"      => spec.homepage,
+    "source_code_uri"   => "https://github.com/MadBomber/smart_message",
+    "changelog_uri"     => "https://github.com/MadBomber/smart_message/blob/master/CHANGELOG.md",
+    "bug_tracker_uri"   => "https://github.com/MadBomber/smart_message/issues",
+    "documentation_uri" => "https://github.com/MadBomber/smart_message/blob/master/README.md"
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__, __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'concurrent-ruby'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'mutex_m'
+  spec.add_development_dependency 'shoulda'
+  spec.add_development_dependency 'minitest-power_assert'
+
+  spec.add_development_dependency 'amazing_print'
+  spec.add_development_dependency 'debug_me'
+
+end

metadata

@@ -0,0 +1,252 @@
+--- !ruby/object:Gem::Specification
+name: smart_message
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dewayne VanHoozer
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  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: shoulda
+  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-power_assert
+  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: amazing_print
+  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: debug_me
+  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: |
+  Much like ActiveRecord abstracts the model as an ORM from the
+  backend data-store, SmartMessage abstracts the message from
+  its backend transport processes.
+email:
+- dvanhoozer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- COMMITS.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docs/README.md
+- docs/architecture.md
+- docs/dispatcher.md
+- docs/examples.md
+- docs/getting-started.md
+- docs/ideas_to_think_about.md
+- docs/serializers.md
+- docs/transports.md
+- docs/troubleshooting.md
+- examples/01_point_to_point_orders.rb
+- examples/02_publish_subscribe_events.rb
+- examples/03_many_to_many_chat.rb
+- examples/README.md
+- examples/tmux_chat/README.md
+- examples/tmux_chat/bot_agent.rb
+- examples/tmux_chat/human_agent.rb
+- examples/tmux_chat/room_monitor.rb
+- examples/tmux_chat/shared_chat_system.rb
+- examples/tmux_chat/start_chat_demo.sh
+- examples/tmux_chat/stop_chat_demo.sh
+- lib/simple_stats.rb
+- lib/smart_message.rb
+- lib/smart_message/base.rb
+- lib/smart_message/dispatcher.rb
+- lib/smart_message/dispatcher/.keep
+- lib/smart_message/errors.rb
+- lib/smart_message/header.rb
+- lib/smart_message/logger.rb
+- lib/smart_message/logger/base.rb
+- lib/smart_message/serializer.rb
+- lib/smart_message/serializer/base.rb
+- lib/smart_message/serializer/json.rb
+- lib/smart_message/transport.rb
+- lib/smart_message/transport/base.rb
+- lib/smart_message/transport/memory_transport.rb
+- lib/smart_message/transport/registry.rb
+- lib/smart_message/transport/stdout_transport.rb
+- lib/smart_message/version.rb
+- lib/smart_message/wrapper.rb
+- smart_message.gemspec
+homepage: https://github.com/MadBomber/smart_message
+licenses: []
+metadata:
+  homepage_uri: https://github.com/MadBomber/smart_message
+  source_code_uri: https://github.com/MadBomber/smart_message
+  changelog_uri: https://github.com/MadBomber/smart_message/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/MadBomber/smart_message/issues
+  documentation_uri: https://github.com/MadBomber/smart_message/blob/master/README.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.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: An abstraction to protect message content from the backend delivery transport.
+test_files: []