kennel 1.113.2 → 1.114.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adf4f9d7bbb7ca7762d12c2dfc2f77faf2ad22dd5ea0179130ac793d56d66b06
-  data.tar.gz: 6346728be4090edba0d00b8830517ac8e9ca3df4c16255638520b4133fcaff14
+  metadata.gz: 248d75d411fad53dd8011982ec16d2104547991ec35480bf9d085feaed419285
+  data.tar.gz: fe11bc68ac149ff7ef989c8bd2b2b497eb465f6f0eccc66d5fbf304de9801666
 SHA512:
-  metadata.gz: 7fc4b90e41dcaafa071fe13b2a7324f9fa0d2ea5d5041d75e6d8e2afbd5b8ab85106ed715964b717282beefe4fa6aeb442ff7721fde5d727343aba1702b85e39
-  data.tar.gz: 948288a0179b596477b7034ee03341d34ff1d8fd0f3be5f53a9fdb6a8c9a3892d10e50aa1b2aab843f77e1449066c0192e178cd3cb5b0083d6f9f4a0dddfe248
+  metadata.gz: d9888da18e41995160fb03516fc02037cb07f43acae46b298941952ec053df4b2ca62ea918a5b1b17664c76d926bb702b6e28a375af1f3047451e2463f88226c
+  data.tar.gz: 92917f89e251d9345f1cf580ebb0206b1206882abe036d1e44284835c025ca61822e261d35a120fe7194303ede139e3c56db48b878fdb137f8d176cc4796441f

data/Readme.md

@@ -72,6 +72,95 @@ end
  - `parts/` monitors/dashboards/etc that are used by multiple projects
  - `generated/` projects as json, to show current state and proposed changes in PRs
 
+## About the models
+
+Kennel provides several classes which act as models for different purposes:
+
+* `Kennel::Models::Dashboard`, `Kennel::Models::Monitor`, `Kennel::Models::Slo`, `Kennel::Models::SyntheticTest`;
+  these models represent the various Datadog objects
+* `Kennel::Models::Project`; a container for a collection of Datadog objects
+* `Kennel::Models::Team`; provides defaults and values (e.g. tags, mentions) for the other models.
+
+After loading all the `*.rb` files under `projects/`, Kennel's starting point
+is to find all the subclasses of `Kennel::Models::Project`, and for each one,
+create an instance of that subclass (via `.new`) and then call `#parts` on that
+instance. `parts` should return a collection of the Datadog-objects (Dashboard / Monitor / etc).
+
+### Model Settings
+
+Each of the models defines various settings; for example, a Monitor has `name`, `message`,
+`type`, `query`, `tags`, and many more.
+
+When defining a subclass of a model, one can use `defaults` to provide default values for
+those settings:
+
+```Ruby
+class MyMonitor < Kennel::Models::Monitor
+  defaults(
+    name: "Error rate",
+    type: "query alert",
+    critical: 5.0,
+    query: -> {
+      "some datadog metric expression > #{critical}"
+    },
+    # ...
+  )
+end
+```
+
+This is equivalent to defining instance methods of those names, which return those values:
+
+```Ruby
+class MyMonitor < Kennel::Models::Monitor
+  def name
+    "Error rate"
+  end
+
+  def type
+    "query alert"
+  end
+
+  def critical
+    5.0
+  end
+
+  def query
+    "some datadog metric expression > #{critical}"
+  end
+end
+```
+
+except that `defaults` will complain if you try to use a setting name which doesn't
+exist. Note also that you can use either plain values (`critical: 5.0`), or procs
+(`query: -> { ... }`). Using a plain value is equivalent to using a proc which returns
+that same value; use whichever suits you best.
+
+When you _instantiate_ a model class, you can pass settings in the constructor, after
+the project:
+
+```Ruby
+project = Kennel::Models::Project.new
+my_monitor = MyMonitor.new(
+  project,
+  critical: 10.0,
+  message: -> {
+    <<~MESSAGE
+      Something bad is happening and you should be worried.
+
+      #{super()}
+    MESSAGE
+  },
+)
+```
+
+This works just like `defaults` (it checks the setting names, and it accepts
+either plain values or procs), but it applies just to this instance of the class,
+rather than to the class as a whole (i.e. it defines singleton methods, rather
+than instance methods).
+
+Most of the examples in this Readme use the proc syntax (`critical: -> { 5.0 }`) but
+for simple constants you may prefer to use the plain syntax (`critical: 5.0`).
+
 ## Workflows
 <!-- ONLY IN template/Readme.md
 

data/lib/kennel/models/monitor.rb

@@ -211,6 +211,10 @@ module Kennel
       def validate_json(data)
         super
 
+        if data[:name]&.start_with?(" ")
+          invalid! "name cannot start with a space"
+        end
+
         type = data.fetch(:type)
 
         # do not allow deprecated type that will be coverted by datadog and then produce a diff
@@ -241,6 +245,10 @@ module Kennel
         unless ALLOWED_PRIORITY_CLASSES.include?(priority.class)
           invalid! "priority needs to be an Integer"
         end
+
+        if data.dig(:options, :timeout_h)&.> 24
+          invalid! "timeout_h must be <= 24"
+        end
       end
 
       # verify is_match/is_exact_match and {{foo.name}} uses available variables

data/lib/kennel/models/project.rb

@@ -11,6 +11,8 @@ module Kennel
       def self.file_location
         @file_location ||= begin
           method_in_file = instance_methods(false).first
+          return if method_in_file.nil?
+
           instance_method(method_in_file).source_location.first.sub("#{Bundler.root}/", "")
         end
       end

data/lib/kennel/settings_as_methods.rb

@@ -3,6 +3,20 @@ module Kennel
   module SettingsAsMethods
     SETTING_OVERRIDABLE_METHODS = [].freeze
 
+    AS_PROCS = ->(options) do
+      # Fragile; depends on the fact that in both locations where AS_PROCS is
+      # used, we're 2 frames away from the user code.
+      file, line, = caller(2..2).first.split(":", 3)
+
+      options.transform_values do |v|
+        if v.class == Proc
+          v
+        else
+          eval "-> { v }", nil, file, line.to_i
+        end
+      end
+    end
+
     def self.included(base)
       base.extend ClassMethods
       base.instance_variable_set(:@settings, [])
@@ -31,7 +45,7 @@ module Kennel
       end
 
       def defaults(options)
-        options.each do |name, block|
+        AS_PROCS.call(options).each do |name, block|
           validate_setting_exist name
           define_method name, &block
         end
@@ -58,12 +72,7 @@ module Kennel
         raise ArgumentError, "Expected #{self.class.name}.new options to be a Hash, got a #{options.class}"
       end
 
-      options.each do |k, v|
-        next if v.class == Proc
-        raise ArgumentError, "Expected #{self.class.name}.new option :#{k} to be Proc, for example `#{k}: -> { 12 }`"
-      end
-
-      options.each do |name, block|
+      AS_PROCS.call(options).each do |name, block|
         self.class.send :validate_setting_exist, name
         define_singleton_method name, &block
       end

data/lib/kennel/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Kennel
-  VERSION = "1.113.2"
+  VERSION = "1.114.1"
 end

data/template/Readme.md

@@ -56,6 +56,95 @@ end
  - `parts/` monitors/dashboards/etc that are used by multiple projects
  - `generated/` projects as json, to show current state and proposed changes in PRs
 
+## About the models
+
+Kennel provides several classes which act as models for different purposes:
+
+* `Kennel::Models::Dashboard`, `Kennel::Models::Monitor`, `Kennel::Models::Slo`, `Kennel::Models::SyntheticTest`;
+  these models represent the various Datadog objects
+* `Kennel::Models::Project`; a container for a collection of Datadog objects
+* `Kennel::Models::Team`; provides defaults and values (e.g. tags, mentions) for the other models.
+
+After loading all the `*.rb` files under `projects/`, Kennel's starting point
+is to find all the subclasses of `Kennel::Models::Project`, and for each one,
+create an instance of that subclass (via `.new`) and then call `#parts` on that
+instance. `parts` should return a collection of the Datadog-objects (Dashboard / Monitor / etc).
+
+### Model Settings
+
+Each of the models defines various settings; for example, a Monitor has `name`, `message`,
+`type`, `query`, `tags`, and many more.
+
+When defining a subclass of a model, one can use `defaults` to provide default values for
+those settings:
+
+```Ruby
+class MyMonitor < Kennel::Models::Monitor
+  defaults(
+    name: "Error rate",
+    type: "query alert",
+    critical: 5.0,
+    query: -> {
+      "some datadog metric expression > #{critical}"
+    },
+    # ...
+  )
+end
+```
+
+This is equivalent to defining instance methods of those names, which return those values:
+
+```Ruby
+class MyMonitor < Kennel::Models::Monitor
+  def name
+    "Error rate"
+  end
+
+  def type
+    "query alert"
+  end
+
+  def critical
+    5.0
+  end
+
+  def query
+    "some datadog metric expression > #{critical}"
+  end
+end
+```
+
+except that `defaults` will complain if you try to use a setting name which doesn't
+exist. Note also that you can use either plain values (`critical: 5.0`), or procs
+(`query: -> { ... }`). Using a plain value is equivalent to using a proc which returns
+that same value; use whichever suits you best.
+
+When you _instantiate_ a model class, you can pass settings in the constructor, after
+the project:
+
+```Ruby
+project = Kennel::Models::Project.new
+my_monitor = MyMonitor.new(
+  project,
+  critical: 10.0,
+  message: -> {
+    <<~MESSAGE
+      Something bad is happening and you should be worried.
+
+      #{super()}
+    MESSAGE
+  },
+)
+```
+
+This works just like `defaults` (it checks the setting names, and it accepts
+either plain values or procs), but it applies just to this instance of the class,
+rather than to the class as a whole (i.e. it defines singleton methods, rather
+than instance methods).
+
+Most of the examples in this Readme use the proc syntax (`critical: -> { 5.0 }`) but
+for simple constants you may prefer to use the plain syntax (`critical: 5.0`).
+
 ## Workflows
 
 ### Setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 1.113.2
+  version: 1.114.1
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday