holodekk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3a5914a607604f7d009d25096a445f157fc5f387e292a52ca660482e491104b
+  data.tar.gz: 8041f27c22120bd272aff93c6773584958d22d66d3b65d62d7f3f9d239140e05
+SHA512:
+  metadata.gz: 7d96652bde4be22c0d86e479e5bcd0975fcfa3760cc30a2aa6ca32011cb9ca712b4c5bb3e5974dd8cdf2a779cb3b2576f0df6493e1029df948a490438f340d0e
+  data.tar.gz: 365afddd2f53cdc1f8d4e2f02ccd79c4ba42fb9b6935ea59ae248f35f6ea448f3150c60cef0ec6a1d59f16843d1a82b2a9c76bd1e9a64dda0ff688d169f8a997

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Josh Williams <jdubz@holodekk.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,6 @@
+Holodekk
+====
+![License](https://img.shields.io/gitlab/license/holodekk/holodekk-ruby?gitlab_url=https%3A%2F%2Fgit.dubzland.net)
+![Pipeline](https://img.shields.io/gitlab/pipeline-status/holodekk/holodekk-ruby?branch=main&gitlab_url=https%3A%2F%2Fgit.dubzland.net)
+![Coverage](https://img.shields.io/gitlab/pipeline-coverage/holodekk/holodekk-ruby?branch=main&gitlab_url=https%3A%2F%2Fgit.dubzland.net)
+![Gem](https://img.shields.io/gem/v/holodekk)

data/bin/holodekk-ruby

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'holodekk'
+
+target_file = File.expand_path(ARGV[0])
+ARGV.shift
+
+load target_file

data/holodekk.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'lib/holodekk/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'holodekk'
+  s.platform    = Gem::Platform::RUBY
+  s.version     = Holodekk::VERSION
+  s.description = 'Ruby interfaces for the Holodekk platform.'
+  s.summary     = s.description
+  s.authors     = ['Josh Williams']
+  s.email       = 'jdubz@holodekk.io'
+  s.files       = %w[holodekk.gemspec] + Dir['*.md', 'bin/*', 'lib/**/*.rb']
+  s.homepage    = 'https://holodekk.io'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.6.0'
+
+  s.executables << 'holodekk-ruby'
+
+  s.add_runtime_dependency('activemodel', '~> 6.0')
+  s.add_runtime_dependency('activesupport', '~> 6.0')
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/holodekk/builder/instruction.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Holodekk
+  class Builder
+    class Instruction
+      include ActiveModel::Model
+      include ActiveModel::Validations
+
+      class << self
+        def build
+          raise NotImplementedError
+        end
+
+        def instruction_tag(tag)
+          @tag = tag
+        end
+
+        def tag
+          @tag ||= name.demodulize.upcase
+        end
+      end
+
+      def tag
+        self.class.tag
+      end
+
+      def as_json(options = {})
+        raise NotImplementedError
+      end
+
+      def to_json(*args)
+        as_json.to_json(*args)
+      end
+
+      protected
+
+      def add_option(builder, key)
+        val = send key
+        builder.option(key, val) unless val.nil?
+      end
+    end
+  end
+end

data/lib/holodekk/builder/option.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Holodekk
+  class Builder
+    class Option
+      include ActiveModel::Model
+      include ActiveModel::Validations
+
+      def as_dockerfile(options = {})
+        raise NotImplementedError
+      end
+
+      def as_json(options = {})
+        raise NotImplementedError
+      end
+
+      def to_json(*args)
+        as_json.to_json(*args)
+      end
+    end
+  end
+end

data/lib/holodekk/builder.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'builder/instruction'
+require_relative 'builder/option'
+
+module Holodekk
+  class Builder
+    class << self
+      def instruction(klass)
+        method_name = klass.name.split('::').last.underscore
+        define_method method_name do |*args, **kwargs, &block|
+          ins = klass.build(*args, **kwargs, &block)
+          @instructions << ins
+        end
+      end
+
+      def option(klass)
+        method_name = klass.name.split('::').last.underscore
+        define_method method_name do |*args, **kwargs, &block|
+          raise "option #{method_name} invoked, but no options target supplied to builder." if @options.nil?
+
+          opt = klass.build(*args, **kwargs, &block)
+          @options << opt
+        end
+      end
+    end
+
+    def initialize(instructions, options = nil)
+      @instructions = instructions
+      @options = options
+    end
+  end
+end

data/lib/holodekk/docker/dockerfile/instruction_builder/flag.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Holodekk
+  module Docker
+    module Dockerfile
+      class InstructionBuilder
+        class Flag
+          attr_accessor :name, :value, :display_state
+
+          alias display_state? display_state
+
+          def initialize(name = '', value = '', display_state: false)
+            @name = name
+            @value = value
+            @display_state = display_state
+          end
+
+          def enabled?
+            value ? true : false
+          end
+
+          def output
+            return "--#{name}=#{enabled?}" if display_state.eql?(:always)
+
+            if enabled?
+              return "--#{name}=#{enabled?}" if display_state?
+
+              return "--#{name}"
+            end
+
+            ''
+          end
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/docker/dockerfile/instruction_builder/key_pair.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Holodekk
+  module Docker
+    module Dockerfile
+      class InstructionBuilder
+        class KeyPair
+          attr_accessor :key, :value
+
+          def initialize(key = '', value = '')
+            @key = key.is_a?(String) ? RawValue.new(key) : key
+            @value = value.is_a?(String) ? RawValue.new(value) : value
+          end
+
+          def output
+            "#{key.output}=#{value.output}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/docker/dockerfile/instruction_builder/option.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Holodekk
+  module Docker
+    module Dockerfile
+      class InstructionBuilder
+        class Option
+          attr_accessor :key, :value
+
+          def initialize(key = '', value = '')
+            @key = key
+            @value = value
+          end
+
+          def output
+            "--#{key}=#{value}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/docker/dockerfile/instruction_builder/quoted_string.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Holodekk
+  module Docker
+    module Dockerfile
+      class InstructionBuilder
+        class QuotedString
+          attr_accessor :value
+
+          def initialize(value = '')
+            @value = value
+          end
+
+          def output
+            "\"#{value}\""
+          end
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/docker/dockerfile/instruction_builder/raw_value.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Holodekk
+  module Docker
+    module Dockerfile
+      class InstructionBuilder
+        class RawValue
+          attr_accessor :value
+
+          def initialize(value = '')
+            @value = value
+          end
+
+          def output
+            value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/docker/dockerfile/instruction_builder/value_array.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Holodekk
+  module Docker
+    module Dockerfile
+      class InstructionBuilder
+        class ValueArray
+          attr_accessor :values
+
+          def initialize(*values)
+            @values = values
+          end
+
+          def output
+            "[#{values.map(&:output).join(', ')}]"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/docker/dockerfile/instruction_builder/value_list.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Holodekk
+  module Docker
+    module Dockerfile
+      class InstructionBuilder
+        class ValueList
+          attr_accessor :values
+
+          def initialize(*values)
+            @values = values
+          end
+
+          def output
+            values.map(&:output).join(' ').to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/docker/dockerfile/instruction_builder.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative 'instruction_builder/flag'
+require_relative 'instruction_builder/key_pair'
+require_relative 'instruction_builder/option'
+require_relative 'instruction_builder/quoted_string'
+require_relative 'instruction_builder/raw_value'
+require_relative 'instruction_builder/value_array'
+require_relative 'instruction_builder/value_list'
+
+module Holodekk
+  module Docker
+    module Dockerfile
+      class InstructionBuilder
+        attr_accessor :tag
+
+        def initialize(instruction = nil)
+          @tag = instruction.present? ? instruction.class.tag : 'UNKNOWN'
+        end
+
+        def flag(name, enabled, **kwargs)
+          elements << Flag.new(name, enabled, **kwargs)
+        end
+
+        def key_pair(key, value, **kwargs)
+          elements << KeyPair.new(key, value, **kwargs)
+        end
+
+        def option(key, value)
+          elements << Option.new(key, value)
+        end
+
+        def quoted_string(value)
+          elements << QuotedString.new(value)
+        end
+
+        def raw_value(value)
+          elements << RawValue.new(value)
+        end
+
+        def value_array(*values)
+          elements << ValueArray.new(*values)
+        end
+
+        def value_list(*values)
+          elements << ValueList.new(*values)
+        end
+
+        def elements
+          @elements ||= []
+        end
+
+        def output
+          chunks = []
+          chunks << tag
+          elements.each do |e|
+            o = e.output
+            chunks << o unless o.blank?
+          end
+          chunks.join(' ')
+        end
+
+        def output!
+          res = output
+          elements.clear
+          res
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/docker/dockerfile.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'dockerfile/instruction_builder'

data/lib/holodekk/docker.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'docker/dockerfile'

data/lib/holodekk/image/instructions/add.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Holodekk
+  class Image
+    module Instructions
+      class Add < Holodekk::Builder::Instruction
+        attr_accessor :sources, :target, :chown, :checksum, :keep_git_dir, :link
+
+        alias keep_git_dir? keep_git_dir
+        alias link? link
+
+        validates_presence_of :sources, :target
+        validate :validate_sources
+        validates :chown, format: { with: Holodekk::CHOWN_RE }, allow_blank: true
+        validates :keep_git_dir, inclusion: { in: [true, false] }, allow_blank: true
+        validates :link, inclusion: { in: [true, false] }, allow_blank: true
+
+        def self.build(sources, target, **kwargs)
+          s = *sources
+          new({ sources: s, target: target }.merge(kwargs))
+        end
+
+        def to_dockerfile
+          builder = Docker::Dockerfile::InstructionBuilder.new(self)
+          builder.flag('link', link)
+          builder.flag('keep-git-dir', keep_git_dir, display_state: true)
+          add_option(builder, 'chown')
+          add_option(builder, 'checksum')
+          builder.value_list(*sources.map do |s|
+            Docker::Dockerfile::InstructionBuilder::QuotedString.new(s)
+          end)
+          builder.quoted_string(target)
+          builder.output
+        end
+
+        protected
+
+        def validate_sources
+          invalid_sources = sources.select(&:empty?)
+          errors.add(:sources, 'invalid source') unless invalid_sources.empty?
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/image/instructions/arg.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Holodekk
+  class Image
+    module Instructions
+      class Arg < Holodekk::Builder::Instruction
+        attr_accessor :arg, :default
+
+        validates_presence_of :arg
+
+        def self.build(arg, **kwargs)
+          new({ arg: arg }.merge(kwargs))
+        end
+
+        def to_dockerfile
+          builder = Docker::Dockerfile::InstructionBuilder.new(self)
+          if default.nil?
+            builder.raw_value(arg)
+          else
+            builder.key_pair(arg, default)
+          end
+          builder.output
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/image/instructions/cmd.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Holodekk
+  class Image
+    module Instructions
+      class Cmd < Holodekk::Builder::Instruction
+        attr_accessor :cmd
+
+        validates_presence_of :cmd
+
+        def self.build(cmd)
+          new(cmd: cmd)
+        end
+
+        def to_dockerfile
+          builder = Docker::Dockerfile::InstructionBuilder.new(self)
+          if cmd.is_a?(Array)
+            builder.value_array(*cmd.map { |c| Docker::Dockerfile::InstructionBuilder::QuotedString.new(c) })
+          else
+            builder.raw_value(cmd)
+          end
+          builder.output
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/image/instructions/copy.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Holodekk
+  class Image
+    module Instructions
+      class Copy < Holodekk::Builder::Instruction
+        attr_accessor :sources, :target, :chown, :link, :from
+
+        alias link? link
+
+        validates_presence_of :sources, :target
+        validate :validate_sources
+        validates :chown, format: { with: Holodekk::CHOWN_RE }, allow_blank: true
+        validates :link, inclusion: { in: [true, false] }, allow_blank: true
+
+        def self.build(sources, target, **kwargs)
+          s = *sources
+          new({ sources: s, target: target }.merge(kwargs))
+        end
+
+        def to_dockerfile
+          builder = Docker::Dockerfile::InstructionBuilder.new(self)
+          builder.flag('link', link)
+          add_option(builder, 'chown')
+          add_option(builder, 'from')
+          builder.value_list(*sources.map do |s|
+            Docker::Dockerfile::InstructionBuilder::QuotedString.new(s)
+          end)
+          builder.quoted_string(target)
+          builder.output
+        end
+
+        protected
+
+        def validate_sources
+          invalid_sources = sources.select(&:empty?)
+          errors.add(:sources, 'invalid source') unless invalid_sources.empty?
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/image/instructions/entrypoint.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Holodekk
+  class Image
+    module Instructions
+      class Entrypoint < Cmd
+        instruction_tag 'ENTRYPOINT'
+      end
+    end
+  end
+end

data/lib/holodekk/image/instructions/env.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Holodekk
+  class Image
+    module Instructions
+      class Env < Holodekk::Builder::Instruction
+        attr_accessor :env
+
+        validates_presence_of :env
+
+        def self.build(env)
+          new({ env: env })
+        end
+
+        def to_dockerfile
+          builder = Docker::Dockerfile::InstructionBuilder.new(self)
+          env.each_pair do |key, value|
+            builder.key_pair(key, Docker::Dockerfile::InstructionBuilder::QuotedString.new(value))
+          end
+          builder.output
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/image/instructions/expose.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Holodekk
+  class Image
+    module Instructions
+      class Expose < Holodekk::Builder::Instruction
+        attr_accessor :ports
+
+        validates_presence_of :ports
+
+        def self.build(ports)
+          p = *ports
+          new({ ports: p })
+        end
+
+        def to_dockerfile
+          builder = Docker::Dockerfile::InstructionBuilder.new(self)
+          builder.value_list(*ports.map { |p| Docker::Dockerfile::InstructionBuilder::RawValue.new(p) })
+          builder.output
+        end
+      end
+    end
+  end
+end

data/lib/holodekk/image/instructions/from.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Holodekk
+  class Image
+    module Instructions
+      class From < Holodekk::Builder::Instruction
+        attr_accessor :image
+
+        validates :image, presence: true
+
+        def self.build(image)
+          new({ image: image })
+        end
+
+        def to_dockerfile(_options = {})
+          builder = Docker::Dockerfile::InstructionBuilder.new(self)
+          builder.raw_value(image)
+          builder.output
+        end
+
+        def as_json(_options = {})
+          {
+            type: 'From',
+            image: image
+          }
+        end
+      end
+    end
+  end
+end