swarm 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac77d75a6ccdfd4d0c9109f0cc85e95b17f78531
-  data.tar.gz: 7ec1237fac5184c8f72fb80c53d65c66283378ff
+  metadata.gz: c08aee506af8648cba7e34c9bf1a0f6771da43fb
+  data.tar.gz: fa7e78cf7ccb4c0f134623f8001a8782af141164
 SHA512:
-  metadata.gz: a9d1c231467a7d4635abc5d6534c7792a886d7d05813dbe2e0cc6993c11802eef6e8059d807e8601721db5984b6c18dd76345191c52f01320433f9816a92e025
-  data.tar.gz: aa831187f5085cad88a575d4ca4ef1259386112aa46906d09b6f1501fa579c6bfad34674d1211904cc386f28263c1673def8d8afa5282f76fb8602bdc70431bc
+  metadata.gz: 57e8b887897b7b94f34f0ddec8e90a5ef6024ba9e03deeb03ddb05ca7d802a1e438fcf1b657b750a38020112f7dcfb2fd41ea1b5f9dfbcde4bdc20b00bc0a6e4
+  data.tar.gz: 3cea3598a30320cc93a15d41e827714980b2c2f82bec4e4fe196f7989470be9560662ca6a09f9513ebb67715c83e38b305bf63192c4307084518f9502150c44a

data/README.md

@@ -1,8 +1,12 @@
 # Swarm
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/swarm`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/swarm.svg)](https://badge.fury.io/rb/swarm)
 
-TODO: Delete this and the text above, and describe your gem
+Swarm is a (very much still work-in-progress) workflow engine for Ruby, combining a process definition DSL, a set of built-in expressions, a worker framework to actually run process instances, and a storage mechanism to persist instances and deferred expressions.
+
+Currently it requires Redis as a backend to persist state (though for testing you can use transient in-process memory storage).  The goal is to extract the storage so other backends can be swapped in as the process state repository.
+
+For performing the work itself, Swarm only comes with an in-process memory storage, which means jobs queued up at the time of stopping the worker will be lost.  For a non-volatile worker, you'll want to use [swarm-beanstalk](http://github.com/bumbleworks/swarm-beanstalk), which uses [beanstalkd](http://kr.github.io/beanstalkd/) (via [beaneater](https://github.com/beanstalkd/beaneater)).
 
 ## Installation
 
@@ -22,18 +26,16 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+Instructions coming soon!
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+## Acknowledgements
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Huge thanks to @jmettraux, author of (now discontinued) [ruote](https://github.com/jmettraux/ruote), for getting me excited about workflow engines, and for inspiring this fun and educational project of mine.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/swarm/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 a new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swarm-beanstalk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/swarm.rb

@@ -17,7 +17,8 @@ require "swarm/stored_workitem"
 require "swarm/participants/trace_participant"
 require "swarm/participants/storage_participant"
 require "swarm/pollen/reader"
-require "redis"
+require "swarm/storage"
+
 
 module Swarm
   # Your code goes here...

data/lib/swarm/hive.rb

@@ -1,5 +1,3 @@
-require_relative "storage"
-
 module Swarm
   class Hive
     class MissingTypeError < StandardError; end
@@ -34,7 +32,11 @@ module Swarm
     end
 
     def inspect
-      "#<Swarm::Hive storage: #{storage.backend.class}, work_queue: #{work_queue.name}>"
+      "#<Swarm::Hive storage: #{storage_class}, work_queue: #{work_queue.name}>"
+    end
+
+    def storage_class
+      storage.class.name.split('::').last
     end
 
     def traced

data/lib/swarm/hive_dweller.rb

@@ -55,7 +55,8 @@ module Swarm
     def save
       if new? || changed?
         @id ||= Swarm::Support.uuid_with_timestamp
-        storage[storage_id] = to_hash
+        storage[storage_id] = to_hash.merge(:updated_at => Time.now)
+        reload!
       end
       self
     end
@@ -95,14 +96,22 @@ module Swarm
         super
         subclass.instance_variable_set(:@columns, [])
         subclass.instance_variable_set(:@associations, [])
+        subclass.set_columns :updated_at, :created_at
       end
 
       def set_columns(*args)
-        attr_reader *args
         args.each do |arg|
           define_method("#{arg}=") { |value|
             change_attribute(arg, value)
           }
+
+          define_method(arg) {
+            val = instance_variable_get(:"@#{arg}")
+            if /_at$/.match(arg) && val.is_a?(String)
+              val = Time.parse(val)
+            end
+            val
+          }
         end
         @columns = @columns | args
       end
@@ -121,7 +130,7 @@ module Swarm
       end
 
       def create(hive: Hive.default, **args)
-        new(hive: hive, **args).save
+        new(hive: hive, created_at: Time.now, **args).save
       end
 
       def storage_type

data/lib/swarm/process_definition.rb

@@ -39,7 +39,6 @@ module Swarm
       Process.create(
         args.merge({
           :workitem => workitem,
-          :hive => hive,
           :process_definition_id => id
         })
       )

data/lib/swarm/storage.rb

@@ -1,56 +1,7 @@
-module Swarm
-  class Storage
-    attr_reader :backend
-
-    def initialize(backend)
-      @backend = backend
-    end
-
-    def regex_for_type(type)
-      /^#{type}\:(.*)/
-    end
-
-    def ids_for_type(type)
-      keys = if backend.is_a?(Redis)
-        backend.keys("#{type}:*")
-      else
-        backend.keys.select { |key| key.match(regex_for_type(type)) }
-      end
-      keys.map { |key| key.gsub(regex_for_type(type), '\1') }
-    end
-
-    def serialize(value)
-      return nil if value.nil?
-      value.to_json
-    end
+require_relative "storage/hash_storage"
+require_relative "storage/redis_storage"
 
-    def deserialize(value)
-      return nil if value.nil?
-      JSON.parse(value)
-    end
-
-    def [](key)
-      deserialize(backend[key])
-    end
-
-    def []=(key, value)
-      backend[key] = serialize(value)
-    end
-
-    def delete(key)
-      if backend.respond_to?(:del)
-        backend.del(key)
-      else
-        backend.delete(key)
-      end
-    end
-
-    def truncate
-      if backend.respond_to?(:flushdb)
-        backend.flushdb
-      else
-        backend.clear
-      end
-    end
+module Swarm
+  module Storage
   end
 end

data/lib/swarm/storage/hash_storage.rb

@@ -0,0 +1,20 @@
+require_relative "key_value_storage"
+
+module Swarm
+  module Storage
+    class HashStorage < KeyValueStorage
+      def ids_for_type(type)
+        keys = store.keys.select { |key| key.match(regex_for_type(type)) }
+        keys.map { |key| key.gsub(regex_for_type(type), '\1') }
+      end
+
+      def delete(key)
+        store.delete(key)
+      end
+
+      def truncate
+        store.clear
+      end
+    end
+  end
+end

data/lib/swarm/storage/key_value_storage.rb

@@ -0,0 +1,45 @@
+module Swarm
+  module Storage
+    class KeyValueStorage
+      attr_reader :store
+
+      def initialize(store)
+        @store = store
+      end
+
+      def regex_for_type(type)
+        /^#{type}\:(.*)/
+      end
+
+      def ids_for_type(type)
+        raise "Not implemented yet!"
+      end
+
+      def serialize(value)
+        return nil if value.nil?
+        value.to_json
+      end
+
+      def deserialize(value)
+        return nil if value.nil?
+        JSON.parse(value)
+      end
+
+      def [](key)
+        deserialize(store[key])
+      end
+
+      def []=(key, value)
+        store[key] = serialize(value)
+      end
+
+      def delete(key)
+        raise "Not implemented yet!"
+      end
+
+      def truncate
+        raise "Not implemented yet!"
+      end
+    end
+  end
+end

data/lib/swarm/storage/redis_storage.rb

@@ -0,0 +1,20 @@
+require "redis"
+require_relative "key_value_storage"
+
+module Swarm
+  module Storage
+    class RedisStorage < KeyValueStorage
+      def ids_for_type(type)
+        store.keys("#{type}:*").map { |key| key.gsub(regex_for_type(type), '\1') }
+      end
+
+      def delete(key)
+        store.del(key)
+      end
+
+      def truncate
+        store.flushdb
+      end
+    end
+  end
+end

data/lib/swarm/version.rb

@@ -1,3 +1,3 @@
 module Swarm
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swarm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ravi Gadad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-01 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -168,6 +168,9 @@ files:
 - lib/swarm/process_definition.rb
 - lib/swarm/router.rb
 - lib/swarm/storage.rb
+- lib/swarm/storage/hash_storage.rb
+- lib/swarm/storage/key_value_storage.rb
+- lib/swarm/storage/redis_storage.rb
 - lib/swarm/stored_workitem.rb
 - lib/swarm/support.rb
 - lib/swarm/version.rb