async-service 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98f13081542982df8eeea93fc2ddf21f442693d1d4f15c48a272677640890edc
+  data.tar.gz: de30016e74b6a9bfd908355c4c7948f7d25c3deb11c1cb96d5b1636472a839bf
+SHA512:
+  metadata.gz: 934012973a75ad970bcfed1de05d17895641dd21f438b78989c019f83c68770358c6b06f2cd153767429e8156b2d15ef0be02d84a74fc01a0d9fc9ce865d6482
+  data.tar.gz: 3a2880a72bd22554c47cce146a5c497e1a12173a967df0650983acaa25c79e20c9cf45bc7bc879fd5cc45cc27956c57afcd3f32f4b6c0dd16ed1d5d9452fbcaa

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+�Q3`������	u�,��rm�h����}�	�~Y��~��8�=yN�����=�����q�r��:���d�Ȟ�+C�"�̿��+�Z�Os�5C�쁦�}VE�c~R9������ 	�-�V���酻r��M��#M�
 ���j��+�5����o��	�(���`=�r
+"�eB�3U���U�L���=��Y������V	��Q�i�7�P�`=o'6K�`�J�
��$���򕎒�8�����$=$��fz�$�;�[��U���E"!H���^`����6
q/C��$t����N�1/Q#l|S�/�`H�}+|Ԏ���԰Xo��%h���o�d�dS�W���2]�h�Ԛ��V/WwY#pj	q��

data/bin/async-service

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require 'async/service'
+
+configuration = Async::Service::Configuration.new
+
+ARGV.each do |path|
+	configuration.load_file(path)
+end
+
+controller = Async::Service::Controller.new(configuration.services)
+
+begin
+	Bundler.require(:preload)
+rescue Bundler::GemfileNotFound
+	# Ignore.
+end
+
+if Process.respond_to?(:warmup)
+	Process.warmup
+elsif GC.respond_to?(:compact)
+	GC.compact
+end
+
+controller.run

data/lib/async/service/configuration.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative 'loader'
+require_relative 'generic'
+
+module Async
+	module Service
+		# Manages environments which describes how to host a specific set of services.
+		#
+		# Environments are key-value maps with lazy value resolution. An environment can inherit from a parent environment, which can provide defaults
+		class Configuration
+			# Initialize an empty configuration.
+			def initialize
+				@environments = []
+			end
+			
+			attr :environments
+			
+			def empty?
+				@environments.empty?
+			end
+			
+			def services
+				return to_enum(:services) unless block_given?
+				
+				@environments.each do |environment|
+					yield Generic.wrap(environment)
+				end
+			end
+			
+			# Add the environment to the configuration.
+			def add(environment)
+				@environments << environment
+			end
+			
+			# Load the specified configuration file. See {Loader#load_file} for more details.
+			def load_file(path)
+				Loader.load_file(self, path)
+			end
+		end
+	end
+end

data/lib/async/service/controller.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'async/container/controller'
+
+module Async
+	module Service
+		class Controller < Async::Container::Controller
+			def initialize(services)
+				@services = services
+			end
+			
+			# Start all named services.
+			def start
+				@services.each do |service|
+					service.start
+				end
+				
+				super
+			end
+			
+			# Setup all named services into the given container.
+			#
+			# @parameter container [Async::Container::Generic]
+			def setup(container)
+				super
+				
+				@services.each do |service|
+					service.setup(container)
+				end
+				
+				return container
+			end
+			
+			# Stop all named services.
+			def stop(graceful = true)
+				@services.each do |service|
+					begin
+						service.stop
+					rescue => error
+						Console.error(self, error)
+					end
+				end
+				
+				super
+			end
+		end
+	end
+end

data/lib/async/service/environment.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Async
+	module Service
+		class Environment
+			class Builder < BasicObject
+				def self.for(initial, block)
+					builder = self.new(initial.dup)
+					
+					builder.instance_exec(&block) if block
+					
+					return builder
+				end
+				
+				def initialize(cache = ::Hash.new)
+					@cache = cache
+				end
+				
+				def include(target)
+					target.to_h.each do |key, value|
+						@cache[key] = value
+					end
+				end
+				
+				def method_missing(name, argument = nil, &block)
+					previous = @cache[name]
+					
+					if block
+						if block.arity == 0
+							@cache[name] = block
+						else
+							# Bind the |previous| argument to the block:
+							@cache[name] = ::Kernel.lambda{self.instance_exec(previous, &block)}
+						end
+					elsif previous.is_a?(::Array)
+						@cache[name] = previous + argument
+					elsif previous.is_a?(::Hash)
+						@cache[name] = previous.merge(argument)
+					else
+						@cache[name] = argument
+					end
+				end
+				
+				def to_h
+					@cache
+				end
+			end
+			
+			def initialize(**initial, &block)
+				@block = block
+				@initial = initial
+			end
+			
+			def builder
+				Builder.for(@initial, @block)
+			end
+			
+			# An evaluator is lazy read-only view of an environment. It allows for the evaluation of procs and other dynamic values.
+			# Those values are cached, and thus the evaluator is not thread safe.
+			class Evaluator < BasicObject
+				def initialize(source)
+					@source = source
+					@cache = {}
+				end
+				
+				def inspect
+					"#<#{Evaluator} #{@source}>"
+				end
+				
+				private def __evaluate__(value)
+					case value
+					when ::Array
+						value.collect{|item| __evaluate__(item)}
+					when ::Hash
+						value.transform_values{|item| __evaluate__(item)}
+					# when ::Symbol
+					# 	self[value]
+					when ::Proc
+						__evaluate__(instance_exec(&value))
+					else
+						value
+					end
+				end
+				
+				def [](key)
+					@cache.fetch(key) do
+						@cache[key] = __evaluate__(@source[key])
+					end
+				end
+				
+				def respond_to?(name, include_all = false)
+					@source.key?(name) || super
+				end
+				
+				def method_missing(name, ...)
+					if @source.key?(name)
+						self[name]
+					else
+						super
+					end
+				end
+				
+				def to_h
+					# Ensure all keys are evaluated:
+					@source.each_key{|key| self[key]}
+					
+					return @cache
+				end
+				
+				def key?(key)
+					@source.key?(key)
+				end
+			end
+			
+			def evaluator
+				Evaluator.new(builder.to_h)
+			end
+			
+			def to_h
+				evaluator.to_h
+			end
+		end
+	end
+end

data/lib/async/service/generic.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Async
+	module Service
+		# Captures the stateful behaviour of a specific service.
+		# Specifies the interfaces required by derived classes.
+		#
+		# Designed to be invoked within an {Async::Controller::Container}.
+		class Generic
+			# Convert the given environment into a service if possible.
+			# @parameter environment [Build::Environment] The environment to use to construct the service.
+			def self.wrap(environment)
+				evaluator = environment.evaluator
+				service_class = evaluator.service_class || self
+				
+				return service_class.new(environment)
+			end
+			
+			# Initialize the service from the given environment.
+			# @parameter environment [Build::Environment]
+			def initialize(environment)
+				@environment = environment
+				@evaluator = @environment.evaluator
+			end
+			
+			def to_h
+				@evaluator.to_h
+			end
+			
+			# The name of the service - used for informational purposes like logging.
+			# e.g. `myapp.com`.
+			def name
+				@evaluator.name
+			end
+			
+			# Start the service.
+			def start
+				Console.debug(self) {"Starting service #{self.name}..."}
+			end
+			
+			# Setup the service into the specified container.
+			# @parameter container [Async::Container::Generic]
+			def setup(container)
+				Console.debug(self) {"Setting up service #{self.name}..."}
+			end
+			
+			# Stop the service.
+			def stop(graceful = true)
+				Console.debug(self) {"Stopping service #{self.name}..."}
+			end
+		end
+	end
+end

data/lib/async/service/loader.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative 'environment'
+
+module Async
+	module Service
+	# The domain specific language for loading configuration files.
+		class Loader
+			# Initialize the loader, attached to a specific configuration instance.
+			# Any environments generated by the loader will be added to the configuration.
+			# @parameter configuration [Configuration]
+			# @parameter root [String] The file-system root path for relative path computations.
+			def initialize(configuration, root = nil)
+				@configuration = configuration
+				@root = root
+			end
+			
+			# The file-system root path which is injected into the environments as required.
+			# @attribute [String]
+			attr :root
+			
+			# Load the specified file into the given configuration.
+			# @parameter configuration [Configuration]
+			# @oaram path [String] The path to the configuration file, e.g. `falcon.rb`.
+			def self.load_file(configuration, path)
+				realpath = ::File.realpath(path)
+				root = ::File.dirname(realpath)
+				
+				loader = self.new(configuration, root)
+				
+				if ::Module.method_defined?(:set_temporary_name)
+					loader.singleton_class.set_temporary_name("#{self}[#{path.inspect}]")
+				end
+				
+				loader.instance_eval(File.read(path), path)
+			end
+			
+			# Create an environment.
+			def environment(**initial, &block)
+				Environment.new(**initial, &block)
+			end
+			
+			# Define a host with the specified name.
+			# Adds `root` and `authority` keys.
+			# @parameter name [String] The name of the environment, usually a hostname.
+			def service(name, &block)
+				@configuration.add(self.environment(name: name, root: @root, &block))
+			end
+		end
+	end
+end

data/lib/async/service/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Async
+	module Service
+		VERSION = "0.1.0"
+	end
+end

data/lib/async/service.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require_relative 'service/configuration'
+require_relative 'service/controller'
+require_relative 'service/version'

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2024, by Samuel Williams.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,23 @@
+# Async::Service
+
+Provides a simple service interface for configuring and running services.
+
+[![Development Status](https://github.com/socketry/async-service/workflows/Test/badge.svg)](https://github.com/socketry/async-service/actions?workflow=Test)
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: async-service
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2024-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  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: async-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+description:
+email:
+executables:
+- async-service
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/async-service
+- lib/async/service.rb
+- lib/async/service/configuration.rb
+- lib/async/service/controller.rb
+- lib/async/service/environment.rb
+- lib/async/service/generic.rb
+- lib/async/service/loader.rb
+- lib/async/service/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/socketry/async-service
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://socketry.github.io/async-service/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: A service layer for Async.
+test_files: []

metadata.gz.sig

@@ -0,0 +1,2 @@
+b
q��3���v�k?ˎ�ݔChb�e���ݟ0���"Eˈ��>�����}{�p�
UҜ�e
+��H�������