djin 0.1.0 → 0.5.0

data/djin.gemspec

@@ -1,35 +1,40 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "djin/version"
+require 'djin/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "djin"
+  spec.name          = 'djin'
   spec.version       = Djin::VERSION
-  spec.authors       = ["Carlos Atkinson"]
-  spec.email         = ["carlos.atks@gmail.com"]
+  spec.authors       = ['Carlos Atkinson']
+  spec.email         = ['carlos.atks@gmail.com']
 
-  spec.summary       = %q{djin is a make-like utility for docker containers}
-  spec.homepage      = "https://github.com/catks/djin"
-  spec.license       = "MIT"
+  spec.summary       = 'djin is a make-like utility for docker containers'
+  spec.homepage      = 'https://github.com/catks/djin'
+  spec.license       = 'MIT'
 
   # spec.metadata["homepage_uri"] = spec.homepage
-  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "dry-struct", "~> 1.3.0"
-  spec.add_dependency "dry-cli", "~> 0.5.0"
-  spec.add_dependency "dry-validation", "~> 1.4.0"
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "byebug"
+  spec.add_dependency 'dry-cli', '~> 0.6.0'
+  spec.add_dependency 'dry-struct', '~> 1.3.0'
+  spec.add_dependency 'dry-validation', '~> 1.5.1'
+  spec.add_dependency 'mustache', '~> 1.1.1'
+  spec.add_dependency 'vseries', '~> 0.1.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
 end

data/djin.yml

@@ -1,7 +1,33 @@
+djin_version: '0.5.0'
+
+_default_run_options: &default_run_options
+  options: "--rm --entrypoint=''"
+
 test:
   docker-compose:
     service: app
     run:
-      commands: "cd /usr/src/djin && rspec"
-      options: "--rm --entrypoint=''"
+      commands: "cd /usr/src/djin && rspec {{args}}"
+      <<: *default_run_options
+
+sh:
+  docker-compose:
+    service: app
+    run:
+      commands: "sh"
+      <<: *default_run_options
+run:
+  docker-compose:
+    service: app
+    run:
+      commands: "sh -c '{{args}}'"
+      <<: *default_run_options
+
+release:
+  local:
+    run:
+      - verto tag up {{args}}
+      - rake release
+
+
 

data/examples/djin.yml

@@ -1,4 +1,6 @@
 ---
+djin_version: '0.5.0'
+
 default:
   docker:
     image: "ruby:2.5"
@@ -8,7 +10,7 @@ test:
   docker-compose:
     service: app
     run:
-      command: rspec
+      commands: rspec
       options: "--rm"
 
 script:

data/exe/djin

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Signal.trap('INT') { exit 2 }
 
 require_relative '../lib/djin'
 

data/lib/djin.rb

@@ -1,36 +1,49 @@
-require "djin/version"
-require "pathname"
-require "yaml"
-require "dry-struct"
-require "dry-validation"
-require "dry/cli"
-require "djin/extensions/hash_extensions"
-require "djin/extensions/custom_predicates"
-require "djin/entities/types"
-require "djin/entities/task"
-require "djin/interpreter"
-require "djin/executor"
-require "djin/cli"
-require "djin/task_contract"
+# frozen_string_literal: true
+
+require 'djin/version'
+require 'pathname'
+require 'yaml'
+require 'dry-struct'
+require 'dry-validation'
+require 'vseries'
+require 'dry/cli'
+require 'mustache'
+require 'djin/extensions/hash_extensions'
+require 'djin/entities/types'
+require 'djin/entities/task'
+require 'djin/interpreter/base_command_builder'
+require 'djin/interpreter/docker_command_builder'
+require 'djin/interpreter/docker_compose_command_builder'
+require 'djin/interpreter/local_command_builder'
+require 'djin/interpreter'
+require 'djin/template_renderer'
+require 'djin/executor'
+require 'djin/cli'
+require 'djin/task_contract'
+require 'djin/repositories/task_repository'
 
 module Djin
   class Error < StandardError; end
-  # Your code goes here...
 
   def self.load_tasks!(path = Pathname.getwd.join('djin.yml'))
     abort 'Error: djin.yml not found' unless path.exist?
 
-    djin_file = YAML.load(path.read)
-    @tasks = Djin::Interpreter.load!(djin_file)
+    rendered_djin_file = TemplateRenderer.render(path.read)
+    djin_config = YAML.safe_load(rendered_djin_file, [], [], true)
 
-    CLI.load_tasks!(@tasks)
+    tasks = Interpreter.load!(djin_config)
 
-  rescue Djin::Interpreter::InvalidSyntax => ex
-    abort(ex.message)
+    @task_repository = TaskRepository.new(tasks)
+    CLI.load_tasks!(tasks)
+  rescue Djin::Interpreter::InvalidConfigurationError => e
+    abort(e.message)
   end
 
   def self.tasks
-    @tasks || []
+    task_repository.all
   end
-end
 
+  def self.task_repository
+    @task_repository ||= TaskRepository.new
+  end
+end

data/lib/djin/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Djin
   class CLI
     extend Dry::CLI::Registry
@@ -9,7 +11,7 @@ module Djin
 
           define_method(:task) { task }
 
-          def call(**options)
+          def call(**)
             Executor.new.call(task)
           end
         end
@@ -17,5 +19,15 @@ module Djin
         register task.name, command
       end
     end
+
+    class Version < Dry::CLI::Command
+      desc 'Prints Djin Version'
+
+      def call(*)
+        puts Djin::VERSION
+      end
+    end
+
+    register '--version', Version, aliases: ['-v']
   end
 end

data/lib/djin/entities/task.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Djin
   class Task < Dry::Struct
     attribute :name, Types::String
     attribute :description, Types::String.optional.default(nil)
     attribute :build_command, Types::String.optional.default(nil)
-    attribute :command, Types::String
+    attribute :command, Types::String.optional.default(nil)
+    attribute :depends_on, Types::Array.of(Types::String).optional.default([].freeze)
 
     def ==(other)
       name == other.name &&

data/lib/djin/entities/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Djin
   module Types
     include Dry.Types()

data/lib/djin/executor.rb

@@ -1,16 +1,30 @@
+# frozen_string_literal: true
+
 module Djin
   class Executor
-   def call(*tasks)
-     tasks.each do |task|
-       run task.build_command if task.build_command
-       run task.command
-     end
-   end
+    def initialize(task_repository: Djin.task_repository)
+      @task_repository = task_repository
+    end
+
+    def call(*tasks)
+      tasks.each do |task|
+        run_task(task)
+      end
+    end
+
+    private
+
+    def run_task(task)
+      @task_repository.find_by_names(task.depends_on).each do |dependent_task|
+        run_task dependent_task
+      end
 
-   private
+      run task.build_command if task.build_command
+      run task.command if task.command
+    end
 
-   def run(command)
-     system command
-   end
+    def run(command)
+      system command
+    end
   end
 end

data/lib/djin/extensions/hash_extensions.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Djin
   module HashExtensions
     refine Hash do
       def except(*keys)
-        reject { |key,_| keys.include?(key) }
+        reject { |key, _| keys.include?(key) }
       end
     end
   end

data/lib/djin/interpreter.rb

@@ -1,23 +1,42 @@
+# frozen_string_literal: true
+
 module Djin
   class Interpreter
     using Djin::HashExtensions
 
-    RESERVED_WORDS = %w[_version _default_options].freeze
+    RESERVED_WORDS = %w[djin_version _default_options].freeze
 
-    InvalidSyntax = Class.new(StandardError)
+    InvalidConfigurationError = Class.new(StandardError)
+    MissingVersionError = Class.new(InvalidConfigurationError)
+    VersionNotSupportedError = Class.new(InvalidConfigurationError)
+    InvalidSyntaxError = Class.new(InvalidConfigurationError)
 
     class << self
       def load!(params)
-        task_params = params.except(*RESERVED_WORDS)
+        version = params['djin_version']
+        raise MissingVersionError, 'Missing djin_version' unless version
+        unless version_supported?(version)
+          raise VersionNotSupportedError, "Version #{version} is not supported, use #{Djin::VERSION} or higher"
+        end
+
+        tasks_params = params.except(*RESERVED_WORDS).reject { |task| task.start_with?('_') }
         contract = TaskContract.new
 
-        task_params.map do |task_name, options|
+        tasks_params.map do |task_name, options|
           result = contract.call(options)
 
-          raise InvalidSyntax, result.errors.to_h if result.failure?
+          raise InvalidSyntaxError, { task_name.to_sym => result.errors.to_h } if result.failure?
 
           command, build_command = build_commands(options, task_name: task_name)
-          Djin::Task.new(name: task_name, build_command: build_command, command: command)
+
+          task_params = {
+            name: task_name,
+            build_command: build_command,
+            command: command,
+            depends_on: options['depends_on']
+          }.compact
+
+          Djin::Task.new(**task_params)
         end
       end
 
@@ -27,54 +46,17 @@ module Djin
         # Validate that only one ot the two is passed
         docker_params = params['docker']
         docker_compose_params = params['docker-compose']
+        local_params = params['local']
 
-        return build_docker_commands(docker_params, task_name: task_name) if docker_params
-        build_docker_compose_commands(docker_compose_params) if docker_compose_params
-      end
-
-      def build_docker_commands(params, task_name:)
-        current_folder_name = Pathname.getwd.basename.to_s
-        image = params['image'] || "djin_#{current_folder_name}_#{task_name}"
-
-        build_params = params['build']
-
-        if build_params.is_a?(Hash)
-          build_context = build_params['context']
-          build_options = build_params['options']
-        end
-
-        build_context ||= build_params
-
-        run_command, run_options = build_run_params(params['run'])
+        # TODO: Refactor to use chain of responsability
+        return DockerCommandBuilder.call(docker_params, task_name: task_name) if docker_params
+        return DockerComposeCommandBuilder.call(docker_compose_params) if docker_compose_params
 
-        command = %Q{docker run #{run_options} #{image} sh -c "#{run_command}"}.squeeze(' ')
-
-        build_command = "docker build #{build_context} #{build_options} -t #{image}".squeeze(' ') if build_context
-
-        [command, build_command]
+        LocalCommandBuilder.call(local_params) if local_params
       end
 
-      def build_docker_compose_commands(params)
-        service = params['service']
-
-        compose_options = params['options']
-
-        run_command, run_options = build_run_params(params['run'])
-
-        [%Q{docker-compose #{compose_options} run #{run_options} #{service} sh -c "#{run_command}"}.squeeze(' '), nil]
-      end
-
-      def build_run_params(run_params)
-        run_command = run_params
-
-        if run_params.is_a?(Hash)
-          run_command = run_params['commands']
-          run_options = run_params['options']
-        end
-
-        run_command =  run_command.join(' && ') if run_command.is_a?(Array)
-
-        [run_command, run_options]
+      def version_supported?(version)
+        Vseries::SemanticVersion.new(Djin::VERSION) >= Vseries::SemanticVersion.new(version)
       end
     end
   end

data/lib/djin/interpreter/base_command_builder.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Djin
+  class Interpreter
+    class BaseCommandBuilder
+      def self.call(*options)
+        new.call(*options)
+      end
+
+      private
+
+      def build_run_params(run_params)
+        run_command = run_params
+
+        if run_params.is_a?(Hash)
+          run_command = run_params['commands']
+          run_options = run_params['options']
+        end
+
+        run_command = run_command.join(' && ') if run_command.is_a?(Array)
+
+        [run_command, run_options]
+      end
+    end
+  end
+end

data/lib/djin/interpreter/docker_command_builder.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Djin
+  class Interpreter
+    class DockerCommandBuilder < BaseCommandBuilder
+      def call(params, task_name:)
+        current_folder_name = Pathname.getwd.basename.to_s
+        image = params['image'] || "djin_#{current_folder_name}_#{task_name}"
+
+        build_params = params['build']
+
+        if build_params.is_a?(Hash)
+          build_context = build_params['context']
+          build_options = build_params['options']
+        end
+
+        build_context ||= build_params
+
+        run_command, run_options = build_run_params(params['run'])
+
+        command = %(docker run #{run_options} #{image} sh -c "#{run_command}").squeeze(' ')
+
+        build_command = "docker build #{build_context} #{build_options} -t #{image}".squeeze(' ') if build_context
+
+        [command, build_command]
+      end
+    end
+  end
+end