kennel 2.15.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5e56bdcd6a89e07d259e9babdb5a25dd1d2e6b28fad74b4eccaa35348a4ade5
-  data.tar.gz: b1ace19a2a6b768a73c941d70d930ba8d4b07111618af83547f58c38133f080b
+  metadata.gz: 3f5c11c126af9e586c2e7f48564760b8625248626204bdd76359001d78cd2038
+  data.tar.gz: 7ec6271b5eb235c8ee4b0bbaf3b9d59dc3b3f8796c5cf8288f6d753094e99a3c
 SHA512:
-  metadata.gz: b311d407973c9773e4070d98870f02292cbc165dd94d91adb1f9b12df1998defd13ea38d1d490941b6297ed5d0a52fbc3825619184b576cb242771678b805f0e
-  data.tar.gz: 77ae75c61c8a38892e91b341a8d98fc1ee6115a8040d42ddf2618c0e7ba90fac596a24dc2b5dcc5c535fb5510b8d92b6a08f90c95a0e9fc62b6407da50dbc4de
+  metadata.gz: 6778c767c1b28ad451f42e0a7f86557382e93627bfee517d7fcd857f90a674bd63294d67253704975c5653d4de616f731524eaf37bd11ff41822635dfcf78c8a
+  data.tar.gz: 626e57f6a9e8a8c8080defd2496d983fa93e0a9fcdf63e5ad87aad662c3f4aaca42ff7e5b0c6c9cb0d94fc66d43808fd10dee65add9d0ca3d1d60b76d2c801e9

data/lib/kennel/filter.rb

@@ -2,6 +2,7 @@
 
 module Kennel
   class Filter
+    ID_SEPARATOR = ":"
     attr_reader :project_filter
 
     def initialize
@@ -22,23 +23,18 @@ module Kennel
       !project_filter.nil?
     end
 
-    def matches_project_id?(project_id)
+    def filters_project_id?(project_id)
       !filtering? || project_filter.include?(project_id)
     end
 
-    def matches_tracking_id?(tracking_id)
+    def filters_tracking_id?(tracking_id)
       return true unless filtering?
       return tracking_id_filter.include?(tracking_id) if tracking_id_filter
 
-      project_id = tracking_id.split(":").first
+      project_id = tracking_id.split(ID_SEPARATOR, 2).first
       project_filter.include?(project_id)
     end
 
-    def tracking_id_for_path(tracking_id)
-      return tracking_id unless tracking_id.end_with?(".json")
-      tracking_id.sub("generated/", "").sub(".json", "").sub("/", ":")
-    end
-
     private
 
     attr_reader :tracking_id_filter
@@ -46,7 +42,7 @@ module Kennel
     # needs to be called after read_tracking_id_filter_from_env
     def read_project_filter_from_env
       project_names = ENV["PROJECT"]&.split(",")&.sort&.uniq
-      tracking_project_names = tracking_id_filter&.map { |id| id.split(":", 2).first }&.sort&.uniq
+      tracking_project_names = tracking_id_filter&.map { |id| id.split(ID_SEPARATOR, 2).first }&.sort&.uniq
       if project_names && tracking_project_names && project_names != tracking_project_names
         # avoid everything being filtered out
         raise "do not set a different PROJECT= when using TRACKING_ID="
@@ -57,8 +53,8 @@ module Kennel
     def read_tracking_id_filter_from_env
       return unless (tracking_id = ENV["TRACKING_ID"])
       tracking_id.split(",").map do |id|
-        # allow users to paste the generated/ path of an objects to update it without manually converting
-        tracking_id_for_path(id)
+        # allow using the generated/ path from `git diff` to update objects without manually converting
+        id.include?(ID_SEPARATOR) ? id : PartsSerializer.tracking_id_for_path(id)
       end.sort.uniq
     end
 

data/lib/kennel/parts_serializer.rb

@@ -2,6 +2,9 @@
 
 module Kennel
   class PartsSerializer
+    FILE_EXTENSION = ".json"
+    FOLDER = "generated"
+
     def initialize(filter:)
       @filter = filter
     end
@@ -9,8 +12,15 @@ module Kennel
     def write(parts)
       Progress.progress "Storing" do
         existing = existing_files_and_folders
-        used = write_changed(parts)
-        FileUtils.rm_rf(existing - used)
+        used, changed = write_changed(parts)
+        FileUtils.rm_rf(existing - used) # cleanup abandoned
+        suggest_using_project_filter(changed)
+      end
+    end
+
+    class << self
+      def tracking_id_for_path(path)
+        path.sub("#{FOLDER}/", "").sub(FILE_EXTENSION, "").sub("/", ":")
       end
     end
 
@@ -20,28 +30,29 @@ module Kennel
 
     def write_changed(parts)
       used = []
+      changed = []
 
       Utils.parallel(parts, max: 2) do |part|
         path = path_for_tracking_id(part.tracking_id)
 
+        # match paths returned from existing_files_and_folders
         used << File.dirname(path) # we have 1 level of sub folders, so this is enough
         used << path
 
         content = part.as_json.merge(api_resource: part.class.api_resource)
-        write_file_if_necessary(path, content)
+        changed << path if write_file_if_necessary(path, content)
       end
-
-      used
+      [used, changed]
     end
 
     def existing_files_and_folders
-      paths = Dir["generated/**/*"]
+      paths = Dir["#{FOLDER}/**/*"] # we rely on this returning folders and files, see write_changed
 
       # when filtering we only need the files we are going to write
       if filter.filtering?
         paths.select! do |path|
-          tracking_id = filter.tracking_id_for_path(path)
-          filter.matches_tracking_id?(tracking_id)
+          tracking_id = self.class.tracking_id_for_path(path)
+          filter.filters_tracking_id?(tracking_id)
         end
       end
 
@@ -49,7 +60,7 @@ module Kennel
     end
 
     def path_for_tracking_id(tracking_id)
-      "generated/#{tracking_id.tr("/", ":").sub(":", "/")}.json"
+      "#{FOLDER}/#{tracking_id.tr("/", ":").sub(":", "/")}#{FILE_EXTENSION}"
     end
 
     def write_file_if_necessary(path, content)
@@ -58,13 +69,21 @@ module Kennel
 
       # 99% case
       begin
-        return if File.read(path) == content
-      rescue Errno::ENOENT
+        return false if File.read(path) == content
+      rescue Errno::ENOENT # file or even folder did not exist
         FileUtils.mkdir_p(File.dirname(path))
       end
 
       # slow 1% case
       File.write(path, content)
+      true
+    end
+
+    def suggest_using_project_filter(changed)
+      return if filter.filtering?
+      projects = changed.map { |path| path.split("/")[1] }.uniq
+      return if projects.size != 1
+      warn "Hint: Using PROJECT=#{projects[0]} is faster"
     end
   end
 end

data/lib/kennel/projects_provider.rb

@@ -12,7 +12,8 @@ module Kennel
     #   All requested projects. This is a slow operation when loading all projects.
     def projects
       load_requested
-      loaded_projects.map(&:new)
+      projects = loaded_projects.map(&:new)
+      @filter.filter_projects projects # in case we loaded more though dependencies
     end
 
     private

data/lib/kennel/syncer/resolver.rb

@@ -27,7 +27,7 @@ module Kennel
           # ignore when deleted from the codebase
           # (when running with filters we cannot see the other resources in the codebase)
           api_resource = a.fetch(:klass).api_resource
-          next if !id_map.get(api_resource, tracking_id) && filter.matches_tracking_id?(tracking_id)
+          next if !id_map.get(api_resource, tracking_id) && filter.filters_tracking_id?(tracking_id)
 
           id_map.set(api_resource, tracking_id, a.fetch(:id))
           if a.fetch(:klass).api_resource == "synthetics/tests"

data/lib/kennel/syncer.rb

@@ -179,7 +179,7 @@ module Kennel
 
       actual.select! do |a|
         tracking_id = a.fetch(:tracking_id)
-        tracking_id.nil? || filter.matches_tracking_id?(tracking_id)
+        tracking_id.nil? || filter.filters_tracking_id?(tracking_id)
       end
     end
   end

data/lib/kennel/version.rb

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

data/lib/kennel.rb

@@ -69,7 +69,9 @@ module Kennel
 
     def generate
       parts = generated
-      PartsSerializer.new(filter: filter).write(parts) if ENV["STORE"] != "false" # quicker when debugging
+      if ENV["STORE"] != "false" # quicker when debugging
+        PartsSerializer.new(filter: filter).write(parts)
+      end
       parts
     end
 
@@ -109,8 +111,7 @@ module Kennel
     def generated(**kwargs)
       @generated ||= begin
         projects = Progress.progress "Loading projects", **kwargs do
-          projects = ProjectsProvider.new(filter: filter).projects
-          filter.filter_projects projects
+          ProjectsProvider.new(filter: filter).projects
         end
 
         parts = Progress.progress "Finding parts", **kwargs do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kennel
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.16.0
 platform: ruby
 authors:
 - Michael Grosser