agens 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 740c18cfd45be6fd7e9531f72f3be2ac9e6a5455
+  data.tar.gz: 7327d202fbfce1ab50b0b9747b647477eaa53bf0
+SHA512:
+  metadata.gz: 6fbc9aec62703e049b9d6b85d9201ae4375118f4588e78cd60689d1169155d10d3e127866680a2231bdbea3c352d337f2425c521fa5c44343cf60ce22ec4f4db
+  data.tar.gz: f52fe4aa072e6132098b4aecd55005182832b6767e06ff313f61b71c26efdb6223be655220b14253f04a2f2a2a14dc9d9327e12f0125cb25bc8d703e2720d1c4

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Tomas Jukin
+
+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.rdoc

@@ -0,0 +1,23 @@
+= Agens - Framework for Multi-Agent Systems in Ruby
+
+Agents is a framework for building Multi-Agent Systems (MAS) in Ruby. With support of COPL (Concurrency-Oriented Programming Language - thx to Celluloid) and Neurals Nets (thx to ai4r).
+
+We have built Agens in order to design Multi-Agent System (MAS) to drive our #Probee Open Hardware robot. We wanted to build this MAS in Ruby - our beloved language.
+
+Build with love in Prague.
+
+== Contributing to Agens
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2016 Tomas Jukin. See LICENSE.txt for
+further details.
+

data/lib/agens.rb

@@ -0,0 +1,5 @@
+require 'agens/agent'
+require 'agens/mas'
+require 'agens/world'
+require 'agens/sensor'
+require 'agens/actuator'

data/lib/agens/actuator.rb

@@ -0,0 +1,7 @@
+require 'celluloid/current'
+
+class Actuator
+	include Celluloid
+
+
+end

data/lib/agens/agent.rb

@@ -0,0 +1,75 @@
+require 'celluloid/current'
+
+class Agent
+	include Celluloid
+	include Celluloid::Internals::Logger
+	
+	class NotImplementedError < StandardError; end
+	
+	def initialize
+		@sensor_classes = {}
+		@actuator_classes = {}
+		@sensors = {}
+		@actuators = {}
+		
+		setup
+		
+		@sensor_classes.each do |name, sensor_clazz|
+			sensor = sensor_clazz.new_link
+			@sensors[name] = sensor
+		end
+		
+		@actuator_classes.each do |name, actuator_clazz|
+			actuator = actuator_clazz.new_link
+			@actuators[name] = actuator
+		end
+		
+		self.async.think_loop
+	end
+
+	def to_s
+		s = "Agent #{self.class.name}:\n"
+		s << "	Sensors:\n"
+		@sensor_classes.each {|n, _| s << "		<- #{n}\n"}
+		s << "	Actuators:\n"
+		@actuator_classes.each {|n, _| s << "		-> #{n}\n"}
+		
+		s
+	end
+	
+	private
+		def think_loop
+			while true
+				perform_reasoning
+				
+				sleep(1)
+			end
+		end
+		
+		def idle
+			info "[#{self.class.name}] Idling..."
+		end
+	
+	protected
+		def setup
+			warn "[#{self.class.name}] I do not have any setup...(give me some sensors and actuators please)"
+		end
+		
+		def perform_reasoning
+			raise NotImplementedError, "[#{self.class.name}] My reasoning is not implemented yet..."
+		end
+		
+		#region DSL
+		def sensor(sensor_clazz, name = nil)
+			name = sensor_clazz.name.to_sym if name == nil
+			
+			@sensor_classes[name] = sensor_clazz
+		end
+		
+		def actuator(actuator_clazz, name = nil)
+			name = actuator_clazz.name.to_sym if name == nil
+			
+			@actuator_classes[name] = actuator_clazz
+		end
+		#endregion DSL
+end

data/lib/agens/mas.rb

@@ -0,0 +1,111 @@
+require 'celluloid/current'
+require 'celluloid/supervision'
+
+class AgentConfigRecipe
+	attr_reader :type, :name, :args
+	
+	def initialize(type, name, args = [])
+		@type = type
+		@name = name
+		@args = args
+	end
+end
+
+class MAS
+	@@counters = {}
+	@@recipes = []
+	
+	def initialize
+		@config = Celluloid::Supervision::Configuration.new
+		@names = []
+		
+		@@recipes.each do |agent_recipe|
+			if !agent_recipe.args.nil? && agent_recipe.args.any?
+				@config.define(type: agent_recipe.type, as: agent_recipe.name, args: agent_recipe.args)
+			else
+				@config.define(type: agent_recipe.type, as: agent_recipe.name)
+			end
+			
+			@names << agent_recipe.name
+		end
+	end
+	
+	def run
+		puts "Running MAS #{self.class.name}..."
+		@config.deploy
+	end
+	
+	def shutdown
+		puts "Stoping MAS #{self.class.name}..."
+		@config.shutdown
+	end
+	
+	def world
+		World.new(@names)
+	end
+	
+	def add_agent(agent, options = {})
+		recipe << self.generate_recipe(agent, options)
+		
+		if !recipe.args.nil? && recipe.args.any?
+			@config.add(type: recipe.type, as: recipe.name, args: recipe.args)
+		else
+			@config.add(type: recipe.type, as: recipe.name)
+		end
+		
+		self
+	end
+	
+	#region DSL
+	# agent MyAgent
+	# agent MyAgent, as: :james_bond
+	# agent MyAgent, as: :james_bond, args: [1, 2]
+	def self.agent(agent, options = {})
+		@@recipes << self.generate_recipe(agent, options)
+	end
+	
+	# agents MyAgent
+	# agents MyAgent, as: :james_bonds
+	# agents MyAgent, count: 10
+	# agents MyAgent, as: :james_bonds, count: 10
+	# agents MyAgent, as: :james_bonds, count: 10, args: [1, 2]
+	def self.agents(agent, options = {})
+		mas_name = self.name.to_sym
+		pool_name = "#{agent.class.name.to_sym}_pool"
+		@@counters[pool_name] ||= 0
+		@@counters[pool_name] += 1
+		
+		name = options.key?(:as) ? options[:as] : "#{mas_name}_#{pool_name}_#{@@counters[pool_name]}"
+		count = options.key?(:count) ? options[:count] : nil
+		
+		count = 2 if count == nil
+		
+		count.times do
+			self.agent(agent, args: options[:args])
+		end
+		
+		# TODO add support for new celluloid supervision pools (when they will be documented, see https://github.com/celluloid/celluloid-supervision)
+		# if count == nil
+		# 	pool agent, as: name
+		# else
+		# 	pool agent, as: name, size: count
+		# end
+	end
+	#endregion DSL
+	
+	def self.generate_recipe(agent, options = {})
+		name = nil
+		if options.key?(:as)
+			name = options[:as]
+		else
+			mas_name = self.name.to_sym
+			agent_name = agent.name.to_sym
+			@@counters[agent_name] ||= 0
+			@@counters[agent_name] += 1
+			
+			name = "#{mas_name}_#{agent_name}_#{@@counters[agent_name]}"
+		end
+		
+		AgentConfigRecipe.new(agent, name, options[:args])
+	end
+end

data/lib/agens/sensor.rb

@@ -0,0 +1,7 @@
+require 'celluloid/current'
+
+class Sensor
+	include Celluloid
+	
+	
+end

data/lib/agens/world.rb

@@ -0,0 +1,27 @@
+require 'celluloid/current'
+
+class World
+	include Enumerable
+	
+	def initialize(names)
+		@names = names
+	end
+	
+	def [](agent)
+		Celluloid::Actor[agent]
+	end
+	
+	def each
+		@names.each do |agent|
+			yield self[agent]
+		end
+	end
+	
+	def dump
+		puts 'World contains:'
+		
+		self.each do |agent|
+			puts agent.to_s
+		end
+	end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: agens
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Jukin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+- !ruby/object:Gem::Dependency
+  name: celluloid-supervision
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.5
+- !ruby/object:Gem::Dependency
+  name: ai4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: |-
+  Agents is a framework for building Multi-Agent Systems (MAS) in Ruby. With support of COPL (Concurrency-Oriented Programming Language - thx to Celluloid) and Neural Nets (thx to ai4r).
+
+  We have built Agens in order to design Multi-Agent System (MAS) to drive our Probee Open Hardware robot. We wanted to build this MAS in Ruby.
+
+  Build with love in Prague.
+email: tomas.jukin@juicymo.cz
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- LICENSE.txt
+- README.rdoc
+- lib/agens.rb
+- lib/agens/actuator.rb
+- lib/agens/agent.rb
+- lib/agens/mas.rb
+- lib/agens/sensor.rb
+- lib/agens/world.rb
+homepage: http://github.com/Inza/agens
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: Framework for Multi-Agent Systems in Ruby
+test_files: []