specwrk 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc8e7bf6a7d8bebb0a79a536f403a51fd6cf88948e69e4d03304cd62a039290e
-  data.tar.gz: c0f58e84e321b6407cefb18bad2ad42344f8919ff754471725ab498072e54267
+  metadata.gz: 690eaebf0ec2f7621284bc0ce56d6613001bdffc6297651b9d4f6da7a439971b
+  data.tar.gz: 8d3104699becc543cbe5aaa6f2b6537d931d34d0e931d720b254262d5b2889a9
 SHA512:
-  metadata.gz: 22fc0af6d23a344521e870194f6ea6c943b313c6596ec3b420a103e533a34ad60fe262b5138b8d0dcdbe1644850cdc633e28510c30d4c0ecea07e9607a4c23e3
-  data.tar.gz: 2a0b62e8140bd41efdbc62838bc8972ce56d9b7f3d7cd316479d5264d16909af2aef9f699d4262cb8dcc2960fdd5ae361a978729403a960b3fd55e0e880060fa
+  metadata.gz: 52210c132192267d027e6756e9b34e7871544a968e57627f433d7f5bcef5f8211cd1a548721f6903269397a07c547f65bbd89816a0c4e576e3f9e22a958e777f
+  data.tar.gz: 43132d8f86f99fa6932f479e3bcb0a1c9d224dcd62a2f6b59f18910c9a2ef6d24560d1ad48d35d1c5ce4c7df483ed0d42ebe05663c4d6a94b3899bb0cdb9cda2

data/lib/specwrk/cli.rb

@@ -8,6 +8,7 @@ require "dry/cli"
 
 require "specwrk"
 require "specwrk/hookable"
+require "specwrk/store"
 
 module Specwrk
   module CLI
@@ -136,13 +137,15 @@ module Specwrk
         base.unique_option :output, type: :string, default: ENV.fetch("SPECWRK_OUT", ".specwrk/"), aliases: ["-o"], desc: "Directory where worker or server output is stored. Overrides SPECWRK_OUT"
         base.unique_option :store_uri, type: :string, desc: "Directory where server state is stored. Required for multi-node or multi-process servers."
         base.unique_option :group_by, values: %w[file timings], default: ENV.fetch("SPECWRK_SRV_GROUP_BY", "timings"), desc: "How examples will be grouped for workers; fallback to file if no timings are found. Overrides SPECWRK_SRV_GROUP_BY"
+        base.unique_option :store_serializer, values: %w[json msgpack], default: ENV.fetch("SPECWRK_STORE_SERIALIZER", "json"), desc: "Serializer to use for store payloads. Overrides SPECWRK_STORE_SERIALIZER"
         base.unique_option :verbose, type: :boolean, default: false, desc: "Run in verbose mode"
       end
 
-      on_setup do |port:, bind:, output:, key:, group_by:, verbose:, **opts|
+      on_setup do |port:, bind:, output:, key:, group_by:, verbose:, store_serializer:, **opts|
         ENV["SPECWRK_OUT"] = Pathname.new(output).expand_path(Dir.pwd).to_s
         ENV["SPECWRK_SRV_STORE_URI"] = opts[:store_uri] if opts.key? :store_uri
         ENV["SPECWRK_SRV_VERBOSE"] = "1" if verbose
+        ENV["SPECWRK_STORE_SERIALIZER"] = store_serializer
 
         ENV["SPECWRK_SRV_PORT"] = port
         ENV["SPECWRK_SRV_BIND"] = bind

data/lib/specwrk/store/base_adapter.rb

@@ -11,6 +11,14 @@ module Specwrk
         def with_lock(_uri, _key)
           yield
         end
+
+        def serializer
+          @serializer ||= Serializer.resolve
+        end
+
+        def reset_serializer!
+          @serializer = nil
+        end
       end
 
       def initialize(uri, scope)

data/lib/specwrk/store/file_adapter.rb

@@ -3,14 +3,14 @@
 require "json"
 require "base64"
 require "securerandom"
+require "fileutils"
 
 require "specwrk/store/base_adapter"
+require "specwrk/store/serializer"
 
 module Specwrk
   class Store
     class FileAdapter < BaseAdapter
-      EXT = ".wrk.json"
-
       @work_queue = Queue.new
       @threads = []
 
@@ -45,13 +45,17 @@ module Specwrk
             end
           end
         end
+
+        def ext
+          ".wrk.#{serializer.adapter_name}"
+        end
       end
 
       def [](key)
         content = read(key.to_s)
         return unless content
 
-        JSON.parse(content, symbolize_names: true)
+        self.class.serializer.load(content)
       end
 
       def []=(key, value)
@@ -60,7 +64,7 @@ module Specwrk
           delete(key_string)
         else
           filename = filename_for_key(key_string)
-          write(filename, JSON.generate(value))
+          write(filename, self.class.serializer.dump(value))
         end
       end
 
@@ -99,7 +103,7 @@ module Specwrk
           result = result_queue.pop
           next if result.last.nil?
 
-          results[result.first] = JSON.parse(result.last, symbolize_names: true)
+          results[result.first] = self.class.serializer.load(result.last)
         end
 
         read_keys.map { |key| [key.to_s, results[key.to_s]] if results.key?(key.to_s) }.compact.to_h # respect order requested in the returned hash
@@ -110,7 +114,7 @@ module Specwrk
 
         hash_with_filenames = hash.map { |key, value| [key.to_s, [filename_for_key(key.to_s), value]] }.to_h
         hash_with_filenames.each do |key, (filename, value)|
-          content = JSON.generate(value)
+          content = self.class.serializer.dump(value)
 
           self.class.schedule_work do
             result_queue << write(filename, content)
@@ -137,7 +141,7 @@ module Specwrk
 
       def read(key)
         filename = filename_for_key key
-        File.read(filename)
+        File.binread(filename)
       rescue Errno::ENOENT
         nil
       end
@@ -146,7 +150,7 @@ module Specwrk
         File.join(
           path,
           encode_key(key)
-        ) + EXT
+        ) + self.class.ext
       end
 
       def path
@@ -160,7 +164,7 @@ module Specwrk
       end
 
       def decode_key(key)
-        encoded_key_part = File.basename(key).delete_suffix(EXT)
+        encoded_key_part = File.basename(key).delete_suffix(self.class.ext)
         padding_count = (4 - encoded_key_part.length % 4) % 4
 
         Base64.urlsafe_decode64(encoded_key_part + ("=" * padding_count))
@@ -169,7 +173,7 @@ module Specwrk
       def known_key_pairs
         Dir.entries(path).sort.map do |filename|
           next if filename.start_with? "."
-          next unless filename.end_with? EXT
+          next unless filename.end_with? self.class.ext
 
           file_path = File.join(path, filename)
           [decode_key(filename), file_path]

data/lib/specwrk/store/serializer.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Specwrk
+  class Store
+    module Serializers
+      module JSON
+        module_function
+
+        def adapter_name
+          "json"
+        end
+
+        def dump(value)
+          ::JSON.generate(value)
+        end
+
+        def load(payload)
+          ::JSON.parse(payload, symbolize_names: true)
+        end
+      end
+
+      module MessagePack
+        module_function
+
+        def ensure_loaded!
+          require "msgpack"
+        rescue LoadError
+          raise LoadError, "Unable to use msgpack, gem not found. Add `gem 'msgpack' to your Gemfile and bundle install"
+        end
+
+        module_function
+
+        def adapter_name
+          "msgpack"
+        end
+
+        def dump(value)
+          ensure_loaded!
+
+          ::MessagePack.dump(value)
+        end
+
+        def load(payload)
+          ensure_loaded!
+
+          ::MessagePack.load(payload, symbolize_keys: true)
+        end
+      end
+    end
+
+    module Serializer
+      module_function
+
+      def resolve(name = ENV.fetch("SPECWRK_STORE_SERIALIZER", "json"))
+        return name if name.respond_to?(:dump) && name.respond_to?(:load)
+
+        case name.to_s.downcase
+        when "", "json"
+          Serializers::JSON
+        when "msgpack", "messagepack"
+          Serializers::MessagePack.tap(&:ensure_loaded!)
+        else
+          raise ArgumentError, "Unsupported serializer #{name.inspect}. Choose json or msgpack."
+        end
+      end
+    end
+  end
+end

data/lib/specwrk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Specwrk
-  VERSION = "0.18.0"
+  VERSION = "0.19.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: specwrk
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Daniel Westendorf
@@ -177,6 +177,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  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'
 email:
 - daniel@prowestech.com
 executables:
@@ -217,6 +231,7 @@ files:
 - lib/specwrk/store/memory_adapter.rb
 - lib/specwrk/store/pending_store.rb
 - lib/specwrk/store/processing_store.rb
+- lib/specwrk/store/serializer.rb
 - lib/specwrk/store/worker_store.rb
 - lib/specwrk/version.rb
 - lib/specwrk/watcher.rb