djin 0.1.1 → 0.6.0

data/lib/djin/interpreter.rb

@@ -1,23 +1,34 @@
+# frozen_string_literal: true
+
 module Djin
   class Interpreter
     using Djin::HashExtensions
 
-    RESERVED_WORDS = %w[_version _default_options].freeze
-
-    InvalidSyntax = Class.new(StandardError)
+    # TODO: Move Errors to ConfigLoader
+    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)
+      def load!(tasks_params)
         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 +38,13 @@ 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'])
-
-        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]
-      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)
+        # 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
 
-        [run_command, run_options]
+        LocalCommandBuilder.call(local_params) if local_params
       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

data/lib/djin/interpreter/docker_compose_command_builder.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Djin
+  class Interpreter
+    class DockerComposeCommandBuilder < BaseCommandBuilder
+      def call(params, **_)
+        service = params['service']
+
+        compose_options = params['options']
+
+        run_command, run_options = build_run_params(params['run'])
+
+        [%(docker-compose #{compose_options} run #{run_options} #{service} sh -c "#{run_command}").squeeze(' '), nil]
+      end
+    end
+  end
+end

data/lib/djin/interpreter/local_command_builder.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Djin
+  class Interpreter
+    class LocalCommandBuilder < BaseCommandBuilder
+      def call(params, **_)
+        build_run_params(params['run'])
+      end
+    end
+  end
+end

data/lib/djin/repositories/task_repository.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class TaskRepository
+  def initialize(tasks = [])
+    @tasks = tasks
+  end
+
+  def add(*tasks)
+    @tasks += tasks
+  end
+
+  def all
+    @tasks
+  end
+
+  def find_by_names(names)
+    @tasks.select { |task| names.include?(task.name) }
+  end
+end

data/lib/djin/task_contract.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Djin
   class TaskContract < Dry::Validation::Contract
-    NOT_EMPTY = -> (value) { ! value.empty? }
-    OK = -> (_) { true }
+    NOT_EMPTY = ->(value) { !value.empty? }
+    OK = ->(_) { true }
+    NOT_OK = ->(_) { false }
 
     BuildSchema = Dry::Schema.Params do
       required(:context).filled(:string)
@@ -13,6 +16,10 @@ module Djin
       required(:options).filled(:string)
     end
 
+    RunLocalSchema = Dry::Schema.Params do
+      required(:commands).filled
+    end
+
     DockerSchema = Dry::Schema.Params do
       optional(:image).maybe(:string)
       optional(:build)
@@ -25,30 +32,49 @@ module Djin
       required(:run).filled
     end
 
+    LocalSchema = Dry::Schema.Params do
+      required(:run).filled
+    end
+
     params do
       optional(:docker).filled do
         hash(DockerSchema)
       end
+
       optional(:"docker-compose").filled do
         hash(DockerComposeSchema)
       end
+
+      optional(:local).filled do
+        hash(LocalSchema)
+      end
+
+      optional(:depends_on).each(:str?)
     end
 
-    rule(:docker, :"docker-compose") do
-      key.failure('docker or docker-compose key is required') unless values[:docker] || values[:"docker-compose"]
+    rule(:docker, :"docker-compose", :local, :depends_on) do
+      unless values[:docker] || values[:"docker-compose"] || values[:depends_on] || values[:local]
+        key.failure('docker, docker-compose, local or depends_on key is required')
+      end
     end
 
-    rule(:'docker-compose',docker: [:image, :build])  do
-      key.failure('image or build param is required for docker tasks') unless values.dig(:docker, :image) || values.dig(:docker, :build) || values[:'docker-compose']
+    rule(:depends_on, :'docker-compose', :local, docker: %i[image build]) do
+      key.failure('image or build param is required for docker tasks') unless values.dig(:docker, :image) ||
+                                                                              values.dig(:docker, :build) ||
+                                                                              values[:'docker-compose'] ||
+                                                                              values[:depends_on] ||
+                                                                              values.dig(:local, :run)
     end
 
+    # TODO: Extract validations to command builders
+
     rule(docker: :build) do
       result, errors = validate_for(value, Hash => BuildSchema, String => NOT_EMPTY, NilClass => OK)
 
       key.failure(errors) unless result
     end
 
-    rule(:'docker-compose' => :run) do
+    rule('docker-compose': :run) do
       result, errors = validate_for(value, Hash => RunSchema, Array => NOT_EMPTY, NilClass => OK)
 
       key.failure(errors) unless result
@@ -60,6 +86,12 @@ module Djin
       key.failure(errors) unless result
     end
 
+    rule(local: :run) do
+      result, errors = validate_for(value, Hash => RunLocalSchema, Array => NOT_EMPTY, NilClass => OK)
+
+      key.failure(errors) unless result
+    end
+
     private
 
     def validate_for(value, validations)

data/lib/djin/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Djin
-  VERSION = "0.1.1"
+  VERSION = '0.6.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: djin
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Carlos Atkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: dry-struct
   requirement: !ruby/object:Gem::Requirement
@@ -25,33 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
-  name: dry-cli
+  name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
-  name: dry-validation
+  name: mustache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: vseries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,15 +158,20 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- Vertofile
 - bin/console
 - bin/setup
 - djin.gemspec
@@ -134,12 +181,17 @@ files:
 - exe/djin
 - lib/djin.rb
 - lib/djin/cli.rb
+- lib/djin/config_loader.rb
 - lib/djin/entities/task.rb
 - lib/djin/entities/types.rb
 - lib/djin/executor.rb
-- lib/djin/extensions/custom_predicates.rb
 - lib/djin/extensions/hash_extensions.rb
 - lib/djin/interpreter.rb
+- lib/djin/interpreter/base_command_builder.rb
+- lib/djin/interpreter/docker_command_builder.rb
+- lib/djin/interpreter/docker_compose_command_builder.rb
+- lib/djin/interpreter/local_command_builder.rb
+- lib/djin/repositories/task_repository.rb
 - lib/djin/task_contract.rb
 - lib/djin/version.rb
 homepage: https://github.com/catks/djin