djin 0.2.0 → 0.6.1

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "djin"
+require 'bundler/setup'
+require 'djin'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "djin"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/djin.gemspec

@@ -1,36 +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.5.0"
-  spec.add_dependency "vseries", "~> 0.1.0"
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.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,18 +1,31 @@
-djin_version: '0.2.0'
+djin_version: '0.6.1'
 
 _default_run_options: &default_run_options
   options: "--rm --entrypoint=''"
 
-test:
-  docker-compose:
-    service: app
-    run:
-      commands: "cd /usr/src/djin && rspec"
-      <<: *default_run_options
+tasks:
+  test:
+    docker-compose:
+      service: app
+      run:
+        commands: "cd /usr/src/djin && rspec {{args}}"
+        <<: *default_run_options
 
-sh:
-  docker-compose:
-    service: app
-    run:
-      commands: "sh"
-      <<: *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}}
+        - bundle exec rake release

data/examples/djin.yml

@@ -1,27 +1,29 @@
 ---
-default:
-  docker:
-    image: "ruby:2.5"
-    run:
-      - "ruby -e 'puts \\\" Hello\\\"'"
-test:
-  docker-compose:
-    service: app
-    run:
-      commands: rspec
-      options: "--rm"
+djin_version: '0.6.1'
 
-script:
-  docker:
-    image: "ruby:2.6"
-    run:
-      commands:
-        - "ruby /scripts/my_ruby_script.rb"
-      options: "--rm -v $(pwd)/my_ruby_script.rb:/scripts/my_ruby_script.rb"
+tasks:
+  default:
+    docker:
+      image: "ruby:2.5"
+      run:
+        - "ruby -e 'puts \\\" Hello\\\"'"
+  test:
+    docker-compose:
+      service: app
+      run:
+        commands: rspec
+        options: "--rm"
 
+  script:
+    docker:
+      image: "ruby:2.6"
+      run:
+        commands:
+          - "ruby /scripts/my_ruby_script.rb"
+        options: "--rm -v $(pwd)/my_ruby_script.rb:/scripts/my_ruby_script.rb"
 
-with_build:
-  docker:
-    build: .
-    run:
-      - "ruby -e 'puts \" Hello\"'"
+  with_build:
+    docker:
+      build: .
+      run:
+        - "ruby -e 'puts \" Hello\"'"

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,35 +1,43 @@
-require "djin/version"
-require "pathname"
-require "yaml"
-require "dry-struct"
-require "dry-validation"
-require "vseries"
-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"
-require "djin/repositories/task_repository"
+# 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/config_loader'
+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.safe_load(path.read, [], [], true)
-    tasks = Djin::Interpreter.load!(djin_file)
+    djin_config = ConfigLoader.load!(path.read)
+
+    # TODO: Make all tasks be under 'tasks' key, passing only the tasks here
+    tasks = Interpreter.load!(djin_config)
 
     @task_repository = TaskRepository.new(tasks)
     CLI.load_tasks!(tasks)
-
-  rescue Djin::Interpreter::InvalidConfigurationError => ex
-    abort(ex.message)
+  rescue Djin::Interpreter::InvalidConfigurationError => e
+    error_name = e.class.name.split('::').last
+    abort("[#{error_name}] #{e.message}")
   end
 
   def self.tasks
@@ -40,4 +48,3 @@ module Djin
     @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/config_loader.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Djin
+  # TODO: Refactor this class to be the Interpreter
+  #       class and use the current interpreter as
+  #       a TaskLoader
+  class ConfigLoader
+    using Djin::HashExtensions
+    RESERVED_WORDS = %w[djin_version variables tasks].freeze
+
+    def self.load!(template_file)
+      new(template_file).load!
+    end
+
+    def initialize(template_file)
+      @template_file = template_file
+    end
+
+    def load!
+      validate_version!
+
+      # TODO: Return a DjinConfig Entity
+      tasks
+    end
+
+    private
+
+    def raw_djin_config
+      @raw_djin_config ||= yaml_load(@template_file)
+    rescue Psych::SyntaxError => e
+      raise Interpreter::InvalidConfigFileError, e.message
+    end
+
+    def rendered_djin_config
+      @rendered_djin_config ||= begin
+                                  locals = env.merge(variables)
+
+                                  rendered_yaml = Mustache.render(@template_file,
+                                                                  args: args.join(' '),
+                                                                  args?: args.any?,
+                                                                  **locals)
+                                  yaml_load(rendered_yaml)
+                                end
+    end
+
+    def version
+      # TODO: Deprecates djin_version and use version instead
+      @version || raw_djin_config['djin_version']
+    end
+
+    def variables
+      @variables ||= raw_djin_config['variables']&.symbolize_keys || {}
+    end
+
+    def tasks
+      rendered_djin_config['tasks'] || legacy_tasks
+    end
+
+    def legacy_tasks
+      warn '[DEPRECATED] Root tasks are deprecated and will be removed in Djin 1.0.0,' \
+           ' put the tasks under \'tasks\' keyword'
+
+      rendered_djin_config.except(*RESERVED_WORDS).reject { |task| task.start_with?('_') }
+    end
+
+    def args
+      index = ARGV.index('--')
+
+      return [] unless index
+
+      ARGV.slice((index + 1)..ARGV.size)
+    end
+
+    def env
+      @env ||= ENV.to_h.symbolize_keys
+    end
+
+    def yaml_load(text)
+      YAML.safe_load(text, [], [], true)
+    end
+
+    def version_supported?
+      Vseries::SemanticVersion.new(Djin::VERSION) >= Vseries::SemanticVersion.new(version)
+    end
+
+    def validate_version!
+      raise Interpreter::MissingVersionError, 'Missing djin_version' unless version
+
+      return if version_supported?
+
+      raise Interpreter::VersionNotSupportedError, "Version #{version} is not supported, use #{Djin::VERSION} or higher"
+    end
+  end
+end

data/lib/djin/entities/task.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Djin
   class Task < Dry::Struct
     attribute :name, Types::String

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Djin
   class Executor
     def initialize(task_repository: Djin.task_repository)

data/lib/djin/extensions/hash_extensions.rb

@@ -1,8 +1,14 @@
+# 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
+
+      def symbolize_keys
+        map { |key, value| [key.to_sym, value] }.to_h
       end
     end
   end

data/lib/djin/interpreter.rb

@@ -1,27 +1,24 @@
+# frozen_string_literal: true
+
 module Djin
   class Interpreter
     using Djin::HashExtensions
 
-    RESERVED_WORDS = %w[djin_version _default_options].freeze
-
+    # TODO: Move Errors to ConfigLoader
     InvalidConfigurationError = Class.new(StandardError)
+    InvalidConfigFileError = Class.new(InvalidConfigurationError)
     MissingVersionError = Class.new(InvalidConfigurationError)
     VersionNotSupportedError = Class.new(InvalidConfigurationError)
     InvalidSyntaxError = Class.new(InvalidConfigurationError)
 
     class << self
-      def load!(params)
-        version = params['djin_version']
-        raise MissingVersionError, 'Missing djin_version' unless version
-        raise VersionNotSupportedError, "Version #{version} is not supported, use #{Djin::VERSION} or higher" unless version_supported?(version)
-
-        tasks_params = params.except(*RESERVED_WORDS).reject { |task| task.start_with?('_') }
+      def load!(tasks_params)
         contract = TaskContract.new
 
         tasks_params.map do |task_name, options|
           result = contract.call(options)
 
-          raise InvalidSyntaxError, 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)
 
@@ -42,62 +39,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)
-
-        [run_command, run_options]
-      end
-
-      def validate_version!(version)
-
-      end
+        # 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
 
-      def version_supported?(version)
-        Vseries::SemanticVersion.new(Djin::VERSION) >= Vseries::SemanticVersion.new(version)
+        LocalCommandBuilder.call(local_params) if local_params
       end
     end
   end