djin 0.3.0 → 0.7.0

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,41 @@
-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-equalizer', '~> 0.3.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,33 @@
-djin_version: '0.2.0'
+djin_version: '0.7.0'
 
 _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:
+    description: Runs Specs
+    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:
+    description: Enter app service shell
+    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.7.0'
 
-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,44 @@
-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/entities/file_config'
+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)
+    file_config = ConfigLoader.load!(path.read)
+
+    # TODO: Make all tasks be under 'tasks' key, passing only the tasks here
+    tasks = Interpreter.load!(file_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 +49,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
@@ -5,23 +7,21 @@ module Djin
     def self.load_tasks!(tasks)
       tasks.each do |task|
         command = Class.new(Dry::CLI::Command) do
-          desc "Runs: #{task.command}"
+          desc task.description
 
           define_method(:task) { task }
 
-          def call(**options)
+          def call(**)
             Executor.new.call(task)
           end
         end
 
         register task.name, command
-
-
       end
     end
 
     class Version < Dry::CLI::Command
-      desc "Prints Djin Version"
+      desc 'Prints Djin Version'
 
       def call(*)
         puts Djin::VERSION

data/lib/djin/config_loader.rb

@@ -0,0 +1,106 @@
+# 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!
+
+      file_config
+    end
+
+    private
+
+    def file_config
+      FileConfig.new(
+        djin_version: version,
+        variables: variables,
+        tasks: tasks,
+        raw_tasks: raw_tasks
+      )
+    end
+
+    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 raw_tasks
+      raw_djin_config['tasks'] || legacy_raw_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 legacy_raw_tasks
+      raw_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 validate_version!
+      raise Interpreter::MissingVersionError, 'Missing djin_version' unless version
+
+      return if file_config.version_supported?
+
+      raise Interpreter::VersionNotSupportedError, "Version #{version} is not supported, use #{Djin::VERSION} or higher"
+    end
+  end
+end

data/lib/djin/entities/file_config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Djin
+  class FileConfig < Dry::Struct
+    attribute :djin_version, Types::String
+    attribute :variables, Types::Hash.optional.default({}.freeze)
+    attribute :tasks, Types::Hash
+    attribute :raw_tasks, Types::Hash
+    # TODO: Add env and args
+
+    include Dry::Equalizer(:djin_version, :variables, :tasks, :raw_tasks)
+
+    def version_supported?
+      Vseries::SemanticVersion.new(Djin::VERSION) >= Vseries::SemanticVersion.new(djin_version)
+    end
+  end
+end

data/lib/djin/entities/task.rb

@@ -1,15 +1,14 @@
+# 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.optional.default(nil)
+    attribute :raw_command, Types::String.optional.default(nil)
     attribute :depends_on, Types::Array.of(Types::String).optional.default([].freeze)
 
-    def ==(other)
-      name == other.name &&
-        command == other.command &&
-        build_command == other.build_command
-    end
+    include Dry::Equalizer(:name, :command, :build_command)
   end
 end

data/lib/djin/entities/types.rb

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