checkoff 0.58.1 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2b8e1f32a572bfcd4797199e3e8bf40a8bacfe3f20eb117a13f52e5f69feab5
-  data.tar.gz: fe61f004dcc81088a23acee2f2fe03c8cec9fc107d1850cc6450d6bde99bdbdc
+  metadata.gz: 19a77e1d0a58d1d80b234b2dca2654bd2b37f289bd5ad7ee3ad6973459032e5a
+  data.tar.gz: '09ab639d4ddb008e09069ba819004b631bc6b0fc735b5332235d94d2b3671e7e'
 SHA512:
-  metadata.gz: 2e77e9c93328415564d60bc1b3b1ca29bb678ce425477137392acd26d92acd81823a9fa9e6db189ce2a22045ca6dc45df32a8548a9265889e95f86196d238b1e
-  data.tar.gz: 516063b25c108b17ac6039c3890cf375a623078b913a33fecb019ae4c9a4f76e2a1f3995fae4cb3c529d5dddcb2d9076f5ec07e940a464ed13330c5b63ab3fbd
+  metadata.gz: 3f49402138523699db239d85718dfbce19c588bc283354b7fd2efe48045512dd314fedbfa3e92d4e7b8874bb29895a6ae10348b094db7e156744fbd9162f22f5
+  data.tar.gz: 9d4c80f6a663a0b26053f904e8860b545775cbb13386d64e229e60d84abb765b1887c2811273df27801ab05503baff8402a38660af6daa45dec9280da9228321

data/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    checkoff (0.58.1)
+    checkoff (0.59.0)
       activesupport
       asana (> 0.10.0)
       cache_method

data/lib/checkoff/internal/project_selector_evaluator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'selector_classes/common'
+require_relative 'selector_classes/project'
+require_relative 'selector_evaluator'
+
+module Checkoff
+  # Evaluates project selectors against a project
+  class ProjectSelectorEvaluator < SelectorEvaluator
+    # @param project [Asana::Resources::Project]
+    # @param projects [Checkoff::Projects]
+    def initialize(project:,
+                   projects: Checkoff::Projects.new)
+      @item = project
+      @projects = projects
+      super()
+    end
+
+    private
+
+    FUNCTION_EVALUTORS = [
+      Checkoff::SelectorClasses::Common::CustomFieldValueContainsAnyValueFunctionEvaluator,
+    ].freeze
+
+    # @return [Array<Class<ProjectSelectorClasses::FunctionEvaluator>>]
+    def function_evaluators
+      FUNCTION_EVALUTORS
+    end
+
+    # @return [Hash]
+    def initializer_kwargs
+      { projects: projects }
+    end
+
+    # @return [Asana::Resources::Project]
+    attr_reader :item
+    # @return [Checkoff::Projects]
+    attr_reader :projects
+  end
+end

data/lib/checkoff/internal/selector_classes/common/function_evaluator.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require_relative '../function_evaluator'
+
+module Checkoff
+  module SelectorClasses
+    module Common
+      # Base class to evaluate a project selector function given fully evaluated arguments
+      class FunctionEvaluator < ::Checkoff::SelectorClasses::FunctionEvaluator
+        # @param selector [Array<(Symbol, Array)>,String]
+        def initialize(selector:, **_kwargs)
+          @selector = selector
+          super()
+        end
+
+        private
+
+        # @param project [Asana::Resources::Project]
+        # @param field_name [Symbol]
+        #
+        # @sg-ignore
+        # @return [Date, nil]
+        def pull_date_field_by_name(project, field_name)
+          if field_name == :modified
+            return Time.parse(project.modified_at).to_date unless project.modified_at.nil?
+
+            return nil
+          end
+
+          if field_name == :due
+            return Time.parse(project.due_at).to_date unless project.due_at.nil?
+
+            return Date.parse(project.due_on) unless project.due_on.nil?
+
+            return nil
+          end
+
+          raise "Teach me how to handle field #{field_name}"
+        end
+
+        # @param project [Asana::Resources::Project]
+        # @param field_name [Symbol]
+        #
+        # @sg-ignore
+        # @return [Date, Time, nil]
+        def pull_date_or_time_field_by_name(project, field_name)
+          if field_name == :due
+            return Time.parse(project.due_at) unless project.due_at.nil?
+
+            return Date.parse(project.due_on) unless project.due_on.nil?
+
+            return nil
+          end
+
+          if field_name == :start
+            return Time.parse(project.start_at) unless project.start_at.nil?
+
+            return Date.parse(project.start_on) unless project.start_on.nil?
+
+            return nil
+          end
+
+          raise "Teach me how to handle field #{field_name}"
+        end
+
+        # @sg-ignore
+        # @param project [Asana::Resources::Project]
+        # @param custom_field_gid [String]
+        # @return [Hash]
+        def pull_custom_field_or_raise(project, custom_field_gid)
+          # @type [Array<Hash>]
+          custom_fields = project.custom_fields
+          if custom_fields.nil?
+            raise "Could not find custom_fields under project (was 'custom_fields' included in 'extra_fields'?)"
+          end
+
+          # @sg-ignore
+          # @type [Hash, nil]
+          matched_custom_field = custom_fields.find { |data| data.fetch('gid') == custom_field_gid }
+          if matched_custom_field.nil?
+            raise "Could not find custom field with gid #{custom_field_gid} " \
+                  "in project #{project.gid} with custom fields #{custom_fields}"
+          end
+
+          matched_custom_field
+        end
+
+        # @return [Array<(Symbol, Array)>]
+        attr_reader :selector
+
+        # @sg-ignore
+        # @param custom_field [Hash]
+        # @return [Array<String>]
+        def pull_enum_values(custom_field)
+          resource_subtype = custom_field.fetch('resource_subtype')
+          case resource_subtype
+          when 'enum'
+            [custom_field.fetch('enum_value')]
+          when 'multi_enum'
+            custom_field.fetch('multi_enum_values')
+          else
+            raise "Teach me how to handle resource_subtype #{resource_subtype}"
+          end
+        end
+
+        # @param custom_field [Hash]
+        # @param enum_value [Object, nil]
+        # @return [Array<String>]
+        def find_gids(custom_field, enum_value)
+          if enum_value.nil?
+            []
+          else
+            raise "Unexpected enabled value on custom field: #{custom_field}" if enum_value.fetch('enabled') == false
+
+            [enum_value.fetch('gid')]
+          end
+        end
+
+        # @param project [Asana::Resources::Project]
+        # @param custom_field_gid [String]
+        # @return [Array<String>]
+        def pull_custom_field_values_gids(project, custom_field_gid)
+          custom_field = pull_custom_field_or_raise(project, custom_field_gid)
+          pull_enum_values(custom_field).flat_map do |enum_value|
+            find_gids(custom_field, enum_value)
+          end
+        end
+
+        # @sg-ignore
+        # @param project [Asana::Resources::Project]
+        # @param custom_field_name [String]
+        # @return [Hash, nil]
+        def pull_custom_field_by_name(project, custom_field_name)
+          custom_fields = project.custom_fields
+          if custom_fields.nil?
+            raise "custom fields not found on project - did you add 'custom_fields' in your extra_fields argument?"
+          end
+
+          # @sg-ignore
+          # @type [Hash, nil]
+          custom_fields.find { |field| field.fetch('name') == custom_field_name }
+        end
+
+        # @param project [Asana::Resources::Project]
+        # @param custom_field_name [String]
+        # @return [Hash]
+        def pull_custom_field_by_name_or_raise(project, custom_field_name)
+          custom_field = pull_custom_field_by_name(project, custom_field_name)
+          if custom_field.nil?
+            raise "Could not find custom field with name #{custom_field_name} " \
+                  "in project #{project.gid} with custom fields #{project.custom_fields}"
+          end
+          custom_field
+        end
+      end
+    end
+  end
+end

data/lib/checkoff/internal/selector_classes/common.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+require_relative 'common/function_evaluator'
+
+module Checkoff
+  module SelectorClasses
+    module Common
+      # :and function
+      class AndFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :and
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        # @param _resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @param lhs [Object]
+        # @param rhs [Object]
+        # @return [Object]
+        def evaluate(_resource, lhs, rhs)
+          lhs && rhs
+        end
+      end
+
+      # :or function
+      #
+      # Does not yet shortcut, but may in future - be careful with side
+      # effects!
+      class OrFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :or
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        # @param _resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @param lhs [Object]
+        # @param rhs [Object]
+        # @return [Object]
+        def evaluate(_resource, lhs, rhs)
+          lhs || rhs
+        end
+      end
+
+      # :not function
+      class NotFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :not
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        # @param _resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @param subvalue [Object]
+        # @return [Boolean]
+        def evaluate(_resource, subvalue)
+          !subvalue
+        end
+      end
+
+      # :nil? function
+      class NilPFunctionEvaluator < FunctionEvaluator
+        def matches?
+          fn?(selector, :nil?)
+        end
+
+        # @param _resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @param subvalue [Object]
+        # @return [Boolean]
+        def evaluate(_resource, subvalue)
+          subvalue.nil?
+        end
+      end
+
+      # :equals? function
+      class EqualsPFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :equals?
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        # @param _resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @param lhs [Object]
+        # @param rhs [Object]
+        # @return [Boolean]
+        def evaluate(_resource, lhs, rhs)
+          lhs == rhs
+        end
+      end
+
+      # :custom_field_value function
+      class CustomFieldValueFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :custom_field_value
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        # @param _index [Integer]
+        def evaluate_arg?(_index)
+          false
+        end
+
+        # @param resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @param custom_field_name [String]
+        # @return [String, nil]
+        def evaluate(resource, custom_field_name)
+          custom_field = pull_custom_field_by_name(resource, custom_field_name)
+          return nil if custom_field.nil?
+
+          custom_field['display_value']
+        end
+      end
+
+      # :custom_field_gid_value function
+      class CustomFieldGidValueFunctionEvaluator < FunctionEvaluator
+        def matches?
+          fn?(selector, :custom_field_gid_value)
+        end
+
+        def evaluate_arg?(_index)
+          false
+        end
+
+        # @sg-ignore
+        # @param resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @param custom_field_gid [String]
+        # @return [String, nil]
+        def evaluate(resource, custom_field_gid)
+          custom_field = pull_custom_field_or_raise(resource, custom_field_gid)
+          custom_field['display_value']
+        end
+      end
+
+      # :custom_field_gid_value_contains_any_gid function
+      class CustomFieldGidValueContainsAnyGidFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :custom_field_gid_value_contains_any_gid
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        def evaluate_arg?(_index)
+          false
+        end
+
+        # @param resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @param custom_field_gid [String]
+        # @param custom_field_values_gids [Array<String>]
+        # @return [Boolean]
+        def evaluate(resource, custom_field_gid, custom_field_values_gids)
+          actual_custom_field_values_gids = pull_custom_field_values_gids(resource, custom_field_gid)
+
+          actual_custom_field_values_gids.any? do |custom_field_value|
+            custom_field_values_gids.include?(custom_field_value)
+          end
+        end
+      end
+
+      # :custom_field_value_contains_any_value
+      class CustomFieldValueContainsAnyValueFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :custom_field_value_contains_any_value
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        def evaluate_arg?(_index)
+          false
+        end
+
+        # @param resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @param custom_field_name [String]
+        # @param custom_field_values [Array<String>]
+        # @return [Boolean]
+        def evaluate(resource, custom_field_name, custom_field_values)
+          custom_field = pull_custom_field_by_name(resource, custom_field_name)
+
+          return false if custom_field.nil?
+
+          custom_field_values.include?(custom_field.fetch('display_value'))
+        end
+      end
+
+      # :custom_field_gid_value_contains_all_gids function
+      class CustomFieldGidValueContainsAllGidsFunctionEvaluator < FunctionEvaluator
+        FUNCTION_NAME = :custom_field_gid_value_contains_all_gids
+
+        def matches?
+          fn?(selector, FUNCTION_NAME)
+        end
+
+        def evaluate_arg?(_index)
+          false
+        end
+
+        # @param resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @param custom_field_gid [String]
+        # @param custom_field_values_gids [Array<String>]
+        # @return [Boolean]
+        def evaluate(resource, custom_field_gid, custom_field_values_gids)
+          actual_custom_field_values_gids = pull_custom_field_values_gids(resource, custom_field_gid)
+
+          custom_field_values_gids.all? do |custom_field_value|
+            actual_custom_field_values_gids.include?(custom_field_value)
+          end
+        end
+      end
+
+      # String literals
+      class StringLiteralEvaluator < FunctionEvaluator
+        def matches?
+          selector.is_a?(String)
+        end
+
+        # @sg-ignore
+        # @param _resource [Asana::Resources::Task,Asana::Resources::Project]
+        # @return [String]
+        def evaluate(_resource)
+          selector
+        end
+      end
+    end
+  end
+end

data/lib/checkoff/internal/selector_classes/function_evaluator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Checkoff
+  module SelectorClasses
+    # Base class to evaluate types of selector functions
+    class FunctionEvaluator
+      # @sg-ignore
+      # @param _index [Integer]
+      def evaluate_arg?(_index)
+        true
+      end
+
+      # @sg-ignore
+      # @return [Boolean]
+      def matches?
+        raise 'Override me!'
+      end
+
+      # @param _task [Asana::Resources::Task]
+      # @param _args [Array<Object>]
+      # @return [Object]
+      # @sg-ignore
+      def evaluate(_task, *_args)
+        raise 'Implement me!'
+      end
+
+      private
+
+      # @param object [Object]
+      # @param fn_name [Symbol]
+      def fn?(object, fn_name)
+        object.is_a?(Array) && !object.empty? && [fn_name, fn_name.to_s].include?(object[0])
+      end
+    end
+  end
+end

data/lib/checkoff/internal/selector_classes/project/function_evaluator.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require_relative '../function_evaluator'
+
+module Checkoff
+  module SelectorClasses
+    module Project
+      # Base class to evaluate a project selector function given fully evaluated arguments
+      class FunctionEvaluator < ::Checkoff::SelectorClasses::FunctionEvaluator
+        # @param selector [Array<(Symbol, Array)>,String]
+        # @param projects [Checkoff::Projects]
+        def initialize(selector:,
+                       projects:)
+          @selector = selector
+          @projects = projects
+          super()
+        end
+
+        private
+
+        # @param project [Asana::Resources::Project]
+        # @param field_name [Symbol]
+        #
+        # @sg-ignore
+        # @return [Date, nil]
+        def pull_date_field_by_name(project, field_name)
+          if field_name == :modified
+            return Time.parse(project.modified_at).to_date unless project.modified_at.nil?
+
+            return nil
+          end
+
+          if field_name == :due
+            return Time.parse(project.due_at).to_date unless project.due_at.nil?
+
+            return Date.parse(project.due_on) unless project.due_on.nil?
+
+            return nil
+          end
+
+          raise "Teach me how to handle field #{field_name}"
+        end
+
+        # @param project [Asana::Resources::Project]
+        # @param field_name [Symbol]
+        #
+        # @sg-ignore
+        # @return [Date, Time, nil]
+        def pull_date_or_time_field_by_name(project, field_name)
+          if field_name == :due
+            return Time.parse(project.due_at) unless project.due_at.nil?
+
+            return Date.parse(project.due_on) unless project.due_on.nil?
+
+            return nil
+          end
+
+          if field_name == :start
+            return Time.parse(project.start_at) unless project.start_at.nil?
+
+            return Date.parse(project.start_on) unless project.start_on.nil?
+
+            return nil
+          end
+
+          raise "Teach me how to handle field #{field_name}"
+        end
+
+        # @sg-ignore
+        # @param project [Asana::Resources::Project]
+        # @param custom_field_gid [String]
+        # @return [Hash]
+        def pull_custom_field_or_raise(project, custom_field_gid)
+          # @type [Array<Hash>]
+          custom_fields = project.custom_fields
+          if custom_fields.nil?
+            raise "Could not find custom_fields under project (was 'custom_fields' included in 'extra_fields'?)"
+          end
+
+          # @sg-ignore
+          # @type [Hash, nil]
+          matched_custom_field = custom_fields.find { |data| data.fetch('gid') == custom_field_gid }
+          if matched_custom_field.nil?
+            raise "Could not find custom field with gid #{custom_field_gid} " \
+                  "in project #{project.gid} with custom fields #{custom_fields}"
+          end
+
+          matched_custom_field
+        end
+
+        # @return [Array<(Symbol, Array)>]
+        attr_reader :selector
+
+        # @sg-ignore
+        # @param custom_field [Hash]
+        # @return [Array<String>]
+        def pull_enum_values(custom_field)
+          resource_subtype = custom_field.fetch('resource_subtype')
+          case resource_subtype
+          when 'enum'
+            [custom_field.fetch('enum_value')]
+          when 'multi_enum'
+            custom_field.fetch('multi_enum_values')
+          else
+            raise "Teach me how to handle resource_subtype #{resource_subtype}"
+          end
+        end
+
+        # @param custom_field [Hash]
+        # @param enum_value [Object, nil]
+        # @return [Array<String>]
+        def find_gids(custom_field, enum_value)
+          if enum_value.nil?
+            []
+          else
+            raise "Unexpected enabled value on custom field: #{custom_field}" if enum_value.fetch('enabled') == false
+
+            [enum_value.fetch('gid')]
+          end
+        end
+
+        # @param project [Asana::Resources::Project]
+        # @param custom_field_gid [String]
+        # @return [Array<String>]
+        def pull_custom_field_values_gids(project, custom_field_gid)
+          custom_field = pull_custom_field_or_raise(project, custom_field_gid)
+          pull_enum_values(custom_field).flat_map do |enum_value|
+            find_gids(custom_field, enum_value)
+          end
+        end
+
+        # @sg-ignore
+        # @param project [Asana::Resources::Project]
+        # @param custom_field_name [String]
+        # @return [Hash, nil]
+        def pull_custom_field_by_name(project, custom_field_name)
+          custom_fields = project.custom_fields
+          if custom_fields.nil?
+            raise "custom fields not found on project - did you add 'custom_fields' in your extra_fields argument?"
+          end
+
+          # @sg-ignore
+          # @type [Hash, nil]
+          custom_fields.find { |field| field.fetch('name') == custom_field_name }
+        end
+
+        # @param project [Asana::Resources::Project]
+        # @param custom_field_name [String]
+        # @return [Hash]
+        def pull_custom_field_by_name_or_raise(project, custom_field_name)
+          custom_field = pull_custom_field_by_name(project, custom_field_name)
+          if custom_field.nil?
+            raise "Could not find custom field with name #{custom_field_name} " \
+                  "in project #{project.gid} with custom fields #{project.custom_fields}"
+          end
+          custom_field
+        end
+      end
+    end
+  end
+end

data/lib/checkoff/internal/selector_classes/project.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'project/function_evaluator'
+
+module Checkoff
+  module SelectorClasses
+    # Project selector classes
+    module Project; end
+  end
+end