buildkite-builder 3.8.2 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e65dcfa8d56f8779fcea38cd8781936c81a345030b0d42beb8a9b3107df1d3d
-  data.tar.gz: 89ba3c3f054d3147eb171a0adeae6b2e8f33386e1e07293177d1e6f1d8a9d305
+  metadata.gz: 38dd50aa0554deb37552ff778d49fd94bd4e22e242ae72ccf179fdcf3460cf25
+  data.tar.gz: a134a4f33462478c35b965c4dbbdb4451cfd4b383817150fc192301fada635af
 SHA512:
-  metadata.gz: e255c6d59f6eeac2d7d98333302e4ad7b9bd9142441f9c8497c2cf81176dae920deba573d38a83dc5e4bcca15205689924afe38822ceb8e82c35ee429e9efc39
-  data.tar.gz: 3122928b318900c555bbca30fca1e14bf0a0f5e559942eb1d8bbcac3f44830d3f9ed64e99b44add9d94e76aa0b834472d894b6398b414ea4da68e5f21631d412
+  metadata.gz: '02599590709a1ca3f7e19da232889b3bf26ff316ff48dc10b8ec3751efc1e08c39a3bf05c6eee21bc2d6463b296d8d777d1d89f5b55abd6ad1667ec89925fa8f'
+  data.tar.gz: a8b4e2b45030b631e1bbb9da80954a7debc9d056945e1e57f36b1df51e88fa68812bb3c99e3826536df356a0520d3e0fe830aa98fd7bea7f88a02dece853253e

data/VERSION

@@ -1 +1 @@
-3.8.2
+3.9.0

data/lib/buildkite/builder/commands/run.rb

@@ -15,7 +15,7 @@ module Buildkite
 
           # This entrypoint is for running on CI. It expects certain environment
           # variables to be set. It also uploads the pipeline to Buildkite.
-          log.info "+++ 🧰 #{'Buildkite Builder'.color(:springgreen)} ─ #{relative_pipeline_path.to_s.yellow}"
+          log.info "+++ 🧰 #{'Buildkite Builder'.color(:springgreen)} v#{Buildkite::Builder.version} ─ #{relative_pipeline_path.to_s.yellow}"
 
           if Buildkite::Pipelines::Command.meta_data(:exists, Builder::META_DATA.fetch(:job))
             log.info 'Pipeline already uploaded'.color(:dimgray)

data/lib/buildkite/builder/extensions/plugins.rb

@@ -0,0 +1,47 @@
+module Buildkite
+  module Builder
+    module Extensions
+      class Plugins < Extension
+        attr_reader :manager
+
+        dsl do
+          def plugin(name, uri, default_attributes = {})
+            context.extensions.find(Buildkite::Builder::Extensions::Plugins).manager.add(name, uri, default_attributes)
+          end
+        end
+
+        def prepare
+          @manager = PluginManager.new
+        end
+
+        def build
+          context.data.steps.each(:command) do |step|
+            next unless step.has?(:plugins)
+
+            step.get(:plugins).map! do |plugin|
+              resource, attributes = extract_resource_and_attributes(plugin)
+              resource.is_a?(Symbol) ? manager.build(resource, attributes) : plugin
+            end
+          end
+
+          context.data.pipelines.each do |pipeline|
+            pipeline.data.steps.each(:command) do |step|
+              next unless step.has?(:plugins)
+
+              step.get(:plugins).map! do |plugin|
+                resource, attributes = extract_resource_and_attributes(plugin)
+                resource.is_a?(Symbol) ? manager.build(resource, attributes) : plugin
+              end
+            end
+          end
+        end
+
+        private
+
+        def extract_resource_and_attributes(plugin)
+          [plugin.keys.first, plugin.values.first]
+        end
+      end
+    end
+  end
+end

data/lib/buildkite/builder/extensions/steps.rb

@@ -3,10 +3,7 @@ module Buildkite
     module Extensions
       class Steps < Extension
         def prepare
-          context.data.steps = StepCollection.new(
-            TemplateManager.new(context.root),
-            PluginManager.new
-          )
+          context.data.steps = StepCollection.new(TemplateManager.new(context.root))
         end
 
         dsl do
@@ -18,11 +15,7 @@ module Buildkite
               label = [emoji, label].compact.join(' ')
             end
 
-            context.data.steps.push(Buildkite::Builder::Group.new(label, context.data.steps, &block))
-          end
-
-          def plugin(name, uri, default_attributes = {})
-            context.data.steps.plugins.add(name, uri, default_attributes)
+            context.data.steps.push(Buildkite::Builder::Group.new(label, context, &block))
           end
 
           def block(template = nil, **args, &block)

data/lib/buildkite/builder/extensions/sub_pipelines.rb

@@ -28,10 +28,7 @@ module Buildkite
             @context = context
             @name = name
             @data = Data.new
-            @data.steps = StepCollection.new(
-              context.data.steps.templates,
-              context.data.steps.plugins
-            )
+            @data.steps = StepCollection.new(context.data.steps.templates)
             @data.notify = []
             @data.env = {}
 

data/lib/buildkite/builder/extensions.rb

@@ -8,6 +8,7 @@ module Buildkite
       autoload :Notify, File.expand_path('extensions/notify', __dir__)
       autoload :SubPipelines, File.expand_path('extensions/sub_pipelines', __dir__)
       autoload :Steps, File.expand_path('extensions/steps', __dir__)
+      autoload :Plugins, File.expand_path('extensions/plugins', __dir__)
       autoload :Use, File.expand_path('extensions/use', __dir__)
     end
   end

data/lib/buildkite/builder/group.rb

@@ -13,18 +13,17 @@ module Buildkite
         name.split('::').last.downcase.to_sym
       end
 
-      def initialize(label, steps, &block)
+      def initialize(label, context, &block)
         @label = label
         @data = Data.new
-        @data.steps = StepCollection.new(
-          steps.templates,
-          steps.plugins
-        )
+        @data.steps = StepCollection.new(context.data.steps.templates)
         @data.notify = []
 
-        @dsl = Dsl.new(self)
-        @dsl.extend(Extensions::Steps)
-        @dsl.extend(Extensions::Notify)
+        # Use `clone` to copy over dsl's extended extensions
+        @dsl = context.dsl.clone
+        # Override dsl context to current group
+        @dsl.instance_variable_set(:@context, self)
+
         instance_eval(&block) if block_given?
         self
       end

data/lib/buildkite/builder/pipeline.rb

@@ -38,6 +38,7 @@ module Buildkite
         use(Extensions::Env)
         use(Extensions::Notify)
         use(Extensions::Steps)
+        use(Extensions::Plugins)
         use(Extensions::SubPipelines)
       end
 

data/lib/buildkite/builder/plugin.rb

@@ -3,16 +3,16 @@
 module Buildkite
   module Builder
     class Plugin
-      attr_reader :uri, :source, :version, :attributes
+      attr_reader \
+        :uri,
+        :source,
+        :version,
+        :default_attributes
 
-      def initialize(uri, attributes = {})
+      def initialize(uri, default_attributes = {})
         @uri = uri
         @source, @version = uri.split('#')
-        @attributes = attributes
-      end
-
-      def to_h
-        Buildkite::Pipelines::Helpers.sanitize(uri => (attributes&.empty? ? nil : attributes))
+        @default_attributes = default_attributes
       end
     end
   end

data/lib/buildkite/builder/plugin_manager.rb

@@ -7,23 +7,16 @@ module Buildkite
 
       def add(name, uri, default_attributes = {})
         name = name.to_s
+        raise(ArgumentError, "Plugin already defined: #{name}") if @plugins.key?(name)
 
-        if @plugins.key?(name)
-          raise ArgumentError, "Plugin already defined: #{name}"
-        end
-
-        @plugins[name] = {
-          uri: uri,
-          default_attributes: default_attributes
-        }
+        @plugins[name] = Plugin.new(uri, default_attributes)
       end
 
-      def fetch(name)
-        @plugins[name]
-      end
+      def build(name, attributes = {})
+        plugin = @plugins[name.to_s]
+        raise(ArgumentError, "Plugin is not registered: #{resource}") unless plugin
 
-      def to_definition
-        # No-op
+        { plugin.uri => plugin.default_attributes.merge(attributes) }
       end
     end
   end

data/lib/buildkite/builder/step_collection.rb

@@ -2,12 +2,10 @@ module Buildkite
   module Builder
     class StepCollection
       attr_reader :templates
-      attr_reader :plugins
       attr_reader :steps
 
-      def initialize(templates, plugins)
+      def initialize(templates)
         @templates = templates
-        @plugins = plugins
         @steps = []
       end
 

data/lib/buildkite/builder.rb

@@ -18,7 +18,6 @@ module Buildkite
     autoload :Processors, File.expand_path('builder/processors', __dir__)
     autoload :Rainbow, File.expand_path('builder/rainbow', __dir__)
     autoload :Plugin, File.expand_path('builder/plugin', __dir__)
-    autoload :PluginCollection, File.expand_path('builder/plugin_collection', __dir__)
     autoload :StepCollection, File.expand_path('builder/step_collection', __dir__)
     autoload :PipelineCollection, File.expand_path('builder/pipeline_collection', __dir__)
     autoload :TemplateManager, File.expand_path('builder/template_manager', __dir__)
@@ -35,6 +34,10 @@ module Buildkite
         @root ||= find_buildkite_directory(start_path)
       end
 
+      def version
+        @version ||= File.read(File.expand_path('../../VERSION', __dir__)).strip
+      end
+
       def template(&block)
         Definition::Template.new(&block) if block_given?
       end

data/lib/buildkite/pipelines/helpers/plugins.rb

@@ -5,12 +5,7 @@ module Buildkite
     module Helpers
       module Plugins
         def plugin(name_or_source, plugin_attributes = {})
-          attributes['plugins'] ||= Buildkite::Builder::PluginCollection.new(step_collection.plugins)
-          attributes['plugins'].add(name_or_source, plugin_attributes)
-        end
-
-        def plugins
-          attributes['plugins']
+          append(:plugins, { name_or_source => plugin_attributes })
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 3.8.2
+  version: 3.9.0
 platform: ruby
 authors:
 - Ngan Pham
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-23 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -113,6 +113,7 @@ files:
 - lib/buildkite/builder/extensions/env.rb
 - lib/buildkite/builder/extensions/lib.rb
 - lib/buildkite/builder/extensions/notify.rb
+- lib/buildkite/builder/extensions/plugins.rb
 - lib/buildkite/builder/extensions/steps.rb
 - lib/buildkite/builder/extensions/sub_pipelines.rb
 - lib/buildkite/builder/extensions/use.rb
@@ -125,7 +126,6 @@ files:
 - lib/buildkite/builder/pipeline.rb
 - lib/buildkite/builder/pipeline_collection.rb
 - lib/buildkite/builder/plugin.rb
-- lib/buildkite/builder/plugin_collection.rb
 - lib/buildkite/builder/plugin_manager.rb
 - lib/buildkite/builder/rainbow.rb
 - lib/buildkite/builder/step_collection.rb
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A gem for programmatically creating Buildkite pipelines.

data/lib/buildkite/builder/plugin_collection.rb

@@ -1,49 +0,0 @@
-module Buildkite
-  module Builder
-    class PluginCollection
-      attr_reader :plugin_manager
-
-      def initialize(plugin_manager)
-        @plugin_manager = plugin_manager
-        @collection = []
-      end
-
-      def add(resource, attributes = {})
-        plugin =
-          case resource
-          when Symbol
-            registered_plugin = plugin_manager.fetch(resource.to_s)
-
-            raise ArgumentError, "Plugin `#{resource}` does not exist" unless registered_plugin
-
-            Plugin.new(registered_plugin[:uri], registered_plugin[:default_attributes].merge(attributes))
-          when String
-            Plugin.new(resource, attributes)
-          when Plugin
-            resource
-          else
-            raise ArgumentError, "Unknown plugin `#{resource.inspect}`"
-          end
-
-        @collection.push(plugin).last
-      end
-
-      def find(source)
-        source_string =
-          case source
-          when String then source
-          when Plugin then source.source
-          else raise ArgumentError, "Unknown source #{source.inspect}"
-          end
-
-        @collection.select do |plugin|
-          plugin.source == source_string
-        end
-      end
-
-      def to_definition
-        @collection.map(&:to_h)
-      end
-    end
-  end
-end