bidding 0.0.1 → 0.0.2

data/README.md

@@ -105,13 +105,79 @@ Command.parse("nop the_type 12345 awesome%20stuff!").execute()
 Each parameter is separated with a space. If you would like to add parameter values that contain spaces I recommend URI encoding them first.
 This allows you to handle strings that might contain spaces.
 
-### Executor
+### Components
 
-The commands executor simply takes a hash of commands from a queue and executes them in order. Successfull commands are pushed to a log.
-If the commands are not successfull the commands are left on the queue.
+Appart from the Command structure bidding has 3 major components. All quite simple in their implementations.
+
+The Executor, the command queue and the transaction log.
+The executor executes commands and if they are successfull the commands are pushed to the transaction log. The command queue keeps a queue of commands to be executed in order.
 
 The gem contains an inmemory queue and log for testing purposes.
 
+The TransactionLog and the queue should be implemented as need be.
+
+#### The queue
+
+Pushing a command to the queue is done simply by calling
+
+```ruby
+
+Bidding.command_queue.pushCommands {"commands"=>["nop"]}
+
+```
+
+You can change which implementation for the queue to use by setting which queue to use in bidding.
+
+
+```ruby
+
+Bidding.command_queue = MyOwnImplementationOfTheQueue.new
+
+```
+
+#### Executor
+
+The commands executor takes a hash of commands from a queue and executes them in order. Successfull commands are pushed to a log.
+If the commands are not successfull the commands are left on the queue.
+
+Commands can be executed immidiatly by calling execute commands
+
+
+```ruby
+
+Bidding.execute_commands {"commands"=>["nop"]}
+
+```
+
+The example above will send the commands directly to the executor without passing the queue.
+
+The executor implementation can also be changed.
+
+```ruby
+
+Bidding.executor = MyOwnImplementationOfTheExecutor.new
+
+```
+
+#### The transaction log
+
+The log keeps track of which commands that have been successfully been executed and in which order.
+
+> The concept of the transaction log is inspired by Event Sourcing. If you want to use events as a termonology I would recommend looking into changing the implementation of the executor. The reason I didn't go all in is a wish to start simple. Bidding might support event sourcing in the future.
+
+Bidding contains some helper tools that should help you create rake files to import and or export transaction logs to JSON files.
+
+These JSON files help you to keep a backup of the command logs on disc. They also allow you to completley replay all commands in the system, effectivlly allowing you to change details of the history.
+
+Which log implementation to use can be changed similar to the other components.
+
+
+```ruby
+
+Bidding.transaction_log = MyOwnImplementationOfTheTransactionLog.new
+
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/morkeleb/bidding/fork )

data/lib/bidding.rb

@@ -9,6 +9,37 @@ require 'bidding/tools/exporter'
 require 'bidding/tools/importer'
 
 module Bidding
-  # Your code goes here...
+
+	@@executor = CommandsExecutor.new
+	@@log = TransactionLog.new
+	@@queue = CommandQueue.new
+
+	def self.executor=(executor)
+		@@executor = executor
+	end
+
+
+	def self.execute_commands commands
+		@@executor.execute commands
+	end
+
+	def self.transaction_log=(log)
+		@@log = log
+	end
+
+	def self.command_queue=(queue)
+		@@queue = queue
+	end
+
+	def self.command_queue
+		@@queue
+	end
+
+	def self.log_commands commands
+		@@log.push commands
+	end
+
+	
+
 
 end

data/lib/bidding/command_queue.rb

@@ -1,7 +1,6 @@
 require 'observer'
 
 class CommandQueue
-	include Observable
 
 	def initialize
 		@list = []
@@ -13,9 +12,9 @@ class CommandQueue
 
 	def pushCommands(commands)
 		@list.push commands
-		changed
-		notify_observers commands 
-
+		if(Bidding.execute_commands commands)
+			@list.delete commands
+		end
 	end
 
 	def length

data/lib/bidding/commands_executor.rb

@@ -1,22 +1,17 @@
-class CommandsExecutor
-	def initialize(queue, transactionLog)
-		@queue = queue
-		@transactionLog = transactionLog
-		@queue.add_observer(self)
-	end
 
-	def update(commands)
-		transaction = @queue.next
-		transaction["commands"].each {|c|
-			co = Command.parse(c, transaction["user"])
+class CommandsExecutor
+	def execute(commands)
+		commands["commands"].each {|c|
+			co = Command.parse(c, commands["user"])
 			co.execute()
 		}
-		@transactionLog.push transaction
+		Bidding.log_commands commands
+		return true
 		rescue Exception
 			p 'EXCEPTION'
 			p $!.to_s
 			p $!.backtrace
-			@queue.return transaction
+			return false
 	end
 
 

data/lib/bidding/version.rb

@@ -1,3 +1,3 @@
 module Bidding
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: bidding
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Morten Nielsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2014-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,15 +46,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Lets you create commands that will parse from oneline strings, and execute
@@ -59,39 +66,40 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - lib/bidding.rb
-- lib/bidding/command.rb
 - lib/bidding/command_queue.rb
-- lib/bidding/commands/nop.rb
 - lib/bidding/commands_executor.rb
+- lib/bidding/transaction_log.rb
+- lib/bidding/version.rb
 - lib/bidding/in_memory_transaction_log.rb
+- lib/bidding/commands/nop.rb
 - lib/bidding/tools/exporter.rb
 - lib/bidding/tools/importer.rb
-- lib/bidding/transaction_log.rb
-- lib/bidding/version.rb
+- lib/bidding/command.rb
+- README.md
 homepage: https://github.com/morkeleb/bidding
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A small library for handling commands
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 5d5697d795874fbac30fd7513e22eccaed0ff1dc
-  data.tar.gz: 6549800b7a60c5d993c263d84570ecafecfbb0e9
-SHA512:
-  metadata.gz: ed39d7e778f30cd4015923f8e8c20b39d2b4e6c13acca76a24fec18c42ae3d15557fa0055da96e668c70c209471c6827d81108be5a3dec1ae60cb92b06c8588a
-  data.tar.gz: e78b7fa2c025e9c80cc5d7fc1a6fc22bcc934ca6f91234d6262150a568bed697454035e0c647ec757d4ea8e6ab20fc7b070767a47d3f15c7bb45c78c18c39783