postjob 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 4fcc6c18ad2be617abafbdfb1dc6258a435223a0fbd0110d86806b6da47fc5d6
-  data.tar.gz: 98a5384f074100eb291d6357993969fea6da7b058177ba513f79329bc558d9c9
+SHA1:
+  metadata.gz: ddb381c651727adfa2e654b8e9902510ede3dad3
+  data.tar.gz: e84c5cace159a3b39ce3cb34fc479d882eb4147a
 SHA512:
-  metadata.gz: 212977ecccd8f11df6d0e4950155cc47f18c1d6c979b045109b5f981d5eb1e7a68c90aefae78708385458d102870f3d3c9357d8861fa9a54fd5f58c8db9f4f2b
-  data.tar.gz: c31025b4869355c9dd13ed5e119c43133b9ae794eecaa2c12f92eb07c1e476f48c32cefa182757358b7236b64febe34283183d5f492a71116e86569adb36e724
+  metadata.gz: 7d05ff63ead66235f51259cf86ff4565fc2aa8cee2583dcf83bcfc3767b9685b6c91c100b9d86e230f888eb9ca28e4d1a5aae36a4d9b18bf25d23de9314ff703
+  data.tar.gz: de96874a8e293a2357bda35885f55aa14b152e9f849d796de98596edeec8a6481bea7c354a293dcaa02bd570ae94a58c96d0134a897a7e75273a04c5f26be48d

data/lib/postjob/queue/associations.rb

@@ -0,0 +1,46 @@
+# This is a pretty generic association loader.
+module Postjob::Queue::Associations
+  extend self
+
+  #
+  # returns a Hash workflow_id => [ associated ]
+  #
+  def load(entities, association, model, foreign_key, singular: false)
+    expect! entities => Array
+    expect! association => Symbol
+    expect! model => %w(postjobs events)
+    expect! foreign_key => Symbol
+
+    return entities if entities.empty?
+
+    entity_ids = entities.pluck(:id)
+
+    # Load all matching associated objects
+    scope = ::Postjob::Queue.search(model, foreign_key => entity_ids).order_by("id")
+
+    associated = ::Simple::SQL.all(scope, into: Hash)
+    associated_by_id = stable_group_by_key(associated, foreign_key)
+
+    # Distribute the associated objects amongst the entities
+    if singular
+      entities.each do |entity|
+        entity[association] = associated_by_id[entity[:id]].last
+      end
+    else
+      entities.each do |entity|
+        entity[association] = associated_by_id[entity[:id]]
+      end
+    end
+  end
+
+  private
+
+  def stable_group_by_key(ary, key)
+    hsh = Hash.new { |h, k| h[k] = [] }
+    ary.each do |entity|
+      group = entity[key]
+      hsh[group] << entity
+    end
+    hsh
+  end
+end

data/lib/postjob/queue/search/scope_builder.rb

@@ -0,0 +1,99 @@
+require_relative "./database_info"
+
+module Postjob::Queue::Search
+  class ScopeBuilder
+    DatabaseInfo = ::Postjob::Queue::DatabaseInfo
+
+    SCHEMA_NAME = ::Postjob::Queue::SCHEMA_NAME
+
+    class << self
+      def build(model:, filter:, attributes:)
+        attributes ||= default_search_attributes(model)
+
+        builder(model).send(:scope, filter: filter, attributes: attributes)
+      end
+
+      private
+
+      # describes which attributes should be returned in addition to a model's columns.
+      EXTRA_SEARCH_ATTRIBUTES = {
+        "postjobs" => [
+          "workflow || COALESCE('@' || workflow_version, '') || args AS job",
+          "COALESCE((results->0)::varchar, error_message) AS result",
+          "(now() at time zone 'utc') - created_at AS age",
+          "updated_at - created_at AS runtime"
+        ]
+      }
+
+      def default_search_attributes(model)
+        DatabaseInfo.table_columns("#{SCHEMA_NAME}.#{model}") + (EXTRA_SEARCH_ATTRIBUTES[model] || [])
+      end
+
+      # Returns the name of the column used for dynamic filtering.
+      def dynamic_filter(model)
+        case model
+        when "postjobs" then "tags"
+        else "attributes"
+        end
+      end
+
+      def builder(model)
+        @builders ||= {}
+        @builders[model] ||= new(model: model, dynamic_filter: dynamic_filter(model))
+      end
+    end
+
+    private
+
+    def initialize(model:, dynamic_filter:)
+      @model      = model
+      @table_name = "#{SCHEMA_NAME}.#{model}"
+      @column_types = DatabaseInfo.column_types(@table_name)
+      @dynamic_filter = dynamic_filter
+    end
+
+    def scope(filter:, attributes:)
+      expect! filter => [Hash, nil]
+      expect! attributes => Array
+
+      # build Scope
+      scope = Simple::SQL::Scope.new("SELECT #{attributes.join(", ")} FROM #{@table_name}")
+      scope = apply_filters(scope, filter) if filter && !filter.empty?
+      scope
+    end
+
+    # apply the filter hash onto the passed in scope. This matches all filters
+    # with a name which is matching a column name against the column values.
+    # It matches every other filter value against an entry in the
+    # dynamic_filter column.
+    def apply_filters(scope, filter)
+      filter.each_key do |key|
+        expect! key => [Symbol, String]
+      end
+
+      converted_filters = filter.inject({}) do |hsh, (key, value)|
+        matches = convert_filter_value(value, key: key)
+        matches = matches.first if matches.length == 1
+        hsh.update key => matches
+      end
+
+      column_filters, tags_filters = converted_filters.partition { |key, _| !@column_types[key].nil? }
+
+      scope = scope.where(Hash[column_filters]) unless column_filters.empty?
+      scope = scope.where(@dynamic_filter => Hash[tags_filters]) unless tags_filters.empty?
+
+      scope
+    end
+
+    def convert_filter_value(value, key:)
+      value = Array(value)
+
+      case @column_types[key]
+      when "bigint"   then value.map { |v| Integer(v) }
+      when "integer"  then value.map { |v| Integer(v) }
+      when nil        then value.map(&:to_s) + value.grep(/\A-?\d+\z/).map(&:to_i)
+      else                 value.map(&:to_s)
+      end
+    end
+  end
+end

data/lib/postjob/queue/search.rb

@@ -1,120 +1,30 @@
-require_relative "./database_info"
+require_relative "search/scope_builder"
 
 module Postjob::Queue
-  class ScopeBuilder
-    SCHEMA_NAME = ::Postjob::Queue::SCHEMA_NAME
-
-    class << self
-      def build(model:, filter:, attributes:)
-        builder(model).send(:scope, filter: filter, attributes: attributes)
-      end
-
-      private
-
-      # Returns the name of the column used for dynamic filtering.
-      def dynamic_filter(model)
-        case model
-        when "postjobs" then "tags"
-        else "attributes"
-        end
-      end
-
-      def builder(model)
-        @builders ||= {}
-        @builders[model] ||= new(model: model, dynamic_filter: dynamic_filter(model))
-      end
-    end
-
-    private
-
-    def initialize(model:, dynamic_filter:)
-      @model      = model
-      @table_name = "#{SCHEMA_NAME}.#{model}"
-      @column_types = ::Postjob::Queue::DatabaseInfo.column_types(@table_name)
-      @dynamic_filter = dynamic_filter
-    end
-
-    def scope(filter:, attributes:)
+  module Search
+    # Builds a search scope (see Simple::SQL::Scope) for the passed in filter criteria.
+    #
+    # Parameters:
+    #
+    # - model: the name of the postjob model, e.g. "postjobs", "events", ..
+    # - filter: a Hash of filter values and other options. options are denoted
+    #           by a Symbol key.
+    #
+    # Note that the search scope is unsorted.
+    def search(model, filter = {})
+      expect! model => String
       expect! filter => [Hash, nil]
-      expect! attributes => Array
-
-      # build Scope
-      scope = Simple::SQL::Scope.new("SELECT #{attributes.join(", ")} FROM #{@table_name}")
-      scope = apply_filters(scope, filter) if filter && !filter.empty?
-      scope
-    end
-
-    # apply the filter hash onto the passed in scope. This matches all filters
-    # with a name which is matching a column name against the column values.
-    # It matches every other filter value against an entry in the
-    # dynamic_filter column.
-    def apply_filters(scope, filter)
-      filter.each_key do |key|
-        expect! key => [Symbol, String]
-      end
 
-      converted_filters = filter.inject({}) do |hsh, (key, value)|
-        matches = convert_filter_value(value, key: key)
-        matches = matches.first if matches.length == 1
-        hsh.update key => matches
-      end
+      filter = filter ? filter.dup : {}
 
-      column_filters, tags_filters = converted_filters.partition { |key, _| !@column_types[key].nil? }
-
-      scope = scope.where(Hash[column_filters]) unless column_filters.empty?
-      scope = scope.where(@dynamic_filter => Hash[tags_filters]) unless tags_filters.empty?
+      root_only  = filter.delete(:root_only)
+      attributes = filter.delete(:attributes)
 
+      scope = ScopeBuilder.build(model: model, filter: filter, attributes: attributes)
+      scope = scope.where("root_id=id") if root_only && model == "postjobs"
       scope
     end
-
-    def convert_filter_value(value, key:)
-      value = Array(value)
-
-      case @column_types[key]
-      when "bigint"   then value.map { |v| Integer(v) }
-      when "integer"  then value.map { |v| Integer(v) }
-      when nil        then value.map(&:to_s) + value.grep(/\A-?\d+\z/).map(&:to_i)
-      else                 value.map(&:to_s)
-      end
-    end
-  end
-
-  # Builds a search scope (see Simple::SQL::Scope) for the passed in filter criteria.
-  #
-  # Parameters:
-  #
-  # - model: the name of the postjob model, e.g. "postjobs", "events", ..
-  # - filter: a Hash of filter values and other options. options are denoted
-  #           by a Symbol key.
-  #
-  # Note that the search scope is unsorted.
-  def search(model, filter = {})
-    expect! model => String
-    expect! filter => [Hash, nil]
-
-    filter = filter ? filter.dup : {}
-
-    root_only  = filter.delete(:root_only)
-    attributes = filter.delete(:attributes) || default_search_attributes(model)
-
-    scope = ScopeBuilder.build(model: model, filter: filter, attributes: attributes)
-    scope = scope.where("root_id=id") if root_only && model == "postjobs"
-    scope
   end
 
-  private
-
-  # describes which attributes should be returned in addition to a model's columns.
-  EXTRA_SEARCH_ATTRIBUTES = {
-    "postjobs" => [
-      "workflow || COALESCE('@' || workflow_version, '') || args AS job",
-      "COALESCE((results->0)::varchar, error_message) AS result",
-      "(now() at time zone 'utc') - created_at AS age",
-      "updated_at - created_at AS runtime"
-    ]
-  }
-
-  def default_search_attributes(model)
-    DatabaseInfo.table_columns("#{SCHEMA_NAME}.#{model}") + (EXTRA_SEARCH_ATTRIBUTES[model] || [])
-  end
+  extend Search
 end

data/lib/postjob/queue.rb

@@ -15,6 +15,7 @@ end
 require_relative "queue/encoder"
 require_relative "queue/notifications"
 require_relative "queue/search"
+require_relative "queue/associations"
 require_relative "queue/settings"
 
 module Postjob::Queue

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postjob
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - radiospiel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-26 00:00:00.000000000 Z
+date: 2018-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -261,10 +261,12 @@ files:
 - lib/postjob/migrations/018_heartbeat.sql
 - lib/postjob/migrations/019_heartbeat_indices.sql
 - lib/postjob/queue.rb
-- lib/postjob/queue/database_info.rb
+- lib/postjob/queue/associations.rb
 - lib/postjob/queue/encoder.rb
 - lib/postjob/queue/notifications.rb
 - lib/postjob/queue/search.rb
+- lib/postjob/queue/search/database_info.rb
+- lib/postjob/queue/search/scope_builder.rb
 - lib/postjob/queue/settings.rb
 - lib/postjob/record.rb
 - lib/postjob/registry.rb
@@ -315,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: restartable, asynchronous, and distributed processes