bidding 0.0.1

checksums.yaml

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

data/README.md

@@ -0,0 +1,121 @@
+# Bidding
+
+Bidding is a small gem for handling the command pattern.
+The goal is to let the commands be easy to implement, and to provide basic infrastructure for executing commands.
+
+The infrastructure is a command queue, a command executor which executes transactions and a transaction log which keeps a record of all executed commands.
+
+It's inspried from the CQRS movement, except it is left up to the implementor to decide if the commands should issue events and thus use eventsourcing.
+Or if it simple should keep a record of all executed commands.
+
+The gem uses an in memory transaction log and queue. Right now the idea is that adapters to different queues and storage backed logs should be implemented outside the gem.
+Thus keeping the gem dependencies as small as possible.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bidding'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bidding
+
+## Usage
+
+When you require 'bidding' you get access to a bunch of classes.
+The most important one is the Command class.
+
+### Commands
+To create a command simple inherit from the Command class and add an execute method.
+
+```ruby
+
+class Nop < Command
+
+	def execute 
+		# this code executes what the command does
+	end
+
+end
+
+```
+
+This will allow you to execute the nop command simply by parsing and executing the command.
+
+
+```ruby
+
+Command.parse("nop").execute()
+
+```
+
+#### Parameters
+
+A command wouldn't be much use unless it could take a few paramters. Since the focus here is to have the command code as readable as possible.
+You simple specify the arguments of the command in order in which they appear.
+
+```ruby
+
+class Nop < Command
+
+	parameters :type, :id, :title
+
+	def execute 
+		# this code executes what the command does
+		# you can use type, id and title here.
+	end
+
+end
+
+```
+
+the parameters method adds properties to the command which correspond to the location of the arguments in the commandline string.
+The code above has 3 parameters: type, id and title. These are all available in the execute method.
+
+Example:
+
+```ruby
+
+class Nop < Command
+
+	parameters :type, :id, :title
+
+	def execute 
+		p type
+		p id
+		p URI.unescape(title)
+	end
+
+end
+
+Command.parse("nop the_type 12345 awesome%20stuff!").execute()
+
+# outputs
+# > the_type
+# > 12345
+# > awesome!
+
+```
+
+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
+
+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.
+
+The gem contains an inmemory queue and log for testing purposes.
+
+## Contributing
+
+1. Fork it ( http://github.com/morkeleb/bidding/fork )
+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

data/lib/bidding/command.rb

@@ -0,0 +1,36 @@
+class Command
+  attr_accessor :name, :arguments, :user, :commandline
+
+  def self.parameters(*args)
+    args.each do |arg|
+      self.class_eval("def #{arg};arguments["+args.index(arg).to_s+"];end")  
+    end
+  end
+
+  def self.parse(commandline, user)
+    parts = commandline.split(" ")
+    name = camel_case parts.shift
+    command = Kernel.const_get(name).new
+    command.name = name
+    command.user = user
+    command.arguments = parts
+    command.commandline = commandline
+    return command
+  end
+
+  def self.camel_case(s)
+    return s if s !~ /_/ && s =~ /[A-Z]+.*/
+    s.split('_').map{|e| e.capitalize}.join
+  end
+
+
+  def execute
+    raise 'execute method not implemented for class: ' + self.class.name
+  end
+
+  def replay
+    @replay = true
+    execute
+  end
+
+end

data/lib/bidding/command_queue.rb

@@ -0,0 +1,37 @@
+require 'observer'
+
+class CommandQueue
+	include Observable
+
+	def initialize
+		@list = []
+	end
+
+	def list
+		@list
+	end
+
+	def pushCommands(commands)
+		@list.push commands
+		changed
+		notify_observers commands 
+
+	end
+
+	def length
+		@list.length
+	end
+
+	def return(transaction)
+		@list.insert(0, transaction)
+	end
+
+	def next
+		@list.shift
+	end
+
+	def exists? (id)
+		@list.index { |item| item[:id] == id} != nil
+	end
+
+end

data/lib/bidding/commands/nop.rb

@@ -0,0 +1,7 @@
+
+class Nop < Command
+
+	def execute 
+	end
+
+end

data/lib/bidding/commands_executor.rb

@@ -0,0 +1,23 @@
+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"])
+			co.execute()
+		}
+		@transactionLog.push transaction
+		rescue Exception
+			p 'EXCEPTION'
+			p $!.to_s
+			p $!.backtrace
+			@queue.return transaction
+	end
+
+
+end

data/lib/bidding/in_memory_transaction_log.rb

@@ -0,0 +1,30 @@
+class InMemoryTransactionLog
+
+	def initialize
+		@list = []
+	end
+
+	def push(transaction)
+		@list.push(transaction)
+	end
+
+	def from(date)
+		@list.select { |entry| entry["date"] < date}
+	end
+
+
+	def containsId? (id)
+		 @list.index { |trans| trans["id"] == id  } != nil
+	end
+
+	def delete(entry)
+		@list.delete_if { |entry| entry["id"] == entry}
+	end
+
+	# for testing purposes only
+	def log
+		@list
+	end
+
+
+end

data/lib/bidding/tools/exporter.rb

@@ -0,0 +1,37 @@
+require 'json'
+require 'date'
+
+class Exporter
+
+	def initialize(log)
+		@log = log
+	end
+
+	def export_from(date)
+		entries = (@log.from date.to_f).to_a
+		write entries, to(file_by date)
+
+		delete entries
+	end
+
+	def write(entries, path)
+		File.open(path, "w") { |file| 
+			file.write JSON entries
+		 }
+	end
+
+	def delete(entries)
+		entries.each do |entry|
+			@log.delete entry
+		end
+	end
+
+	def to(file)
+		file
+	end
+
+	def file_by(date)
+		return "./tmp/log-" + Time.now.utc.to_date.to_s + ".json"
+	end
+
+end

data/lib/bidding/tools/importer.rb

@@ -0,0 +1,22 @@
+
+Dir["./lib/commands/**/*.rb"].sort.each {|f| require f}
+Dir["./lib/models/**/*.rb"].sort.each {|f| require f}
+class Importer
+
+	def import file
+		p 'importing file ' + file
+		transaction = JSON File.read file
+
+		transaction.each { |trans| 
+			commands = trans["commands"]
+			commands.each { |command_string| 
+				command = Command.parse command_string, trans["user"]
+				command.replay
+				}
+		 }
+
+		File.delete file
+
+	end
+
+end

data/lib/bidding/transaction_log.rb

@@ -0,0 +1,18 @@
+require 'date'
+
+class TransactionLog
+
+
+	def adapter=(adapter)
+		@adapter = adapter
+	end
+
+	def adapter
+		@adapter ||= InMemoryTransactionLog.new
+	end
+
+	def push(transaction)
+		transaction["date"] = Time.now.utc.to_f
+		adapter.push(transaction)
+	end
+end

data/lib/bidding/version.rb

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

data/lib/bidding.rb

@@ -0,0 +1,14 @@
+require "bidding/version"
+require 'bidding/command'
+require 'bidding/command_queue'
+require 'bidding/commands_executor'
+require 'bidding/transaction_log'
+require 'bidding/in_memory_transaction_log'
+require 'bidding/commands/nop'
+require 'bidding/tools/exporter'
+require 'bidding/tools/importer'
+
+module Bidding
+  # Your code goes here...
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: bidding
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Morten Nielsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !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'
+description: Lets you create commands that will parse from oneline strings, and execute
+  them.
+email: morten@morkeleb.com
+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/in_memory_transaction_log.rb
+- lib/bidding/tools/exporter.rb
+- lib/bidding/tools/importer.rb
+- lib/bidding/transaction_log.rb
+- lib/bidding/version.rb
+homepage: https://github.com/morkeleb/bidding
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A small library for handling commands
+test_files: []