djin 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e44393cb2f47b9b3a68d2ce59ae997e5e1d6b252e68778293b5e62a7600374b
-  data.tar.gz: 5c02ed7dc956357e31b07c6ade84c5f660cb26469f7434ea0128b42f0ebec74f
+  metadata.gz: 06daa5a16dcd5adf9e7ff60d976689fbe7e146cf58f708b97d3fea8de2113599
+  data.tar.gz: e36aad9524a35db424096893fc2f817306c25160b8afea4fb19bd7c1951053fc
 SHA512:
-  metadata.gz: 1d8d9dbd993757586e35679c12e1d03b98c940e5bca58e6ab2b3b8955c84c78b2fad6ae2053a0430b85aa580217a8540b3196ab3489c0ae76c4426e712142822
-  data.tar.gz: be25638d743e46c62a452891298003d3dd93905ea38b6bbe51420d44549ba001785f7b9a631cc4e4b83c61ffa541688420df9bd9339023b1cb86747ad2ae87c4
+  metadata.gz: 071abc594f4ee1ac16f3983550abba863fb22594afba6c2a0d1b54b92888feb8eda51f55445d6562f061f065b5da12b55e4a964dbe863e33227fb3e421e13cab
+  data.tar.gz: 118d467194cbcad067c942e692794ac48afbcd4295183971e9a3a3c3ef41aec4ec2d693da83e7f86686e70cdfe9369458ae0eee319258b3dd8d3eb54f0761893

data/.github/workflows/ruby.yml

@@ -1,25 +1,37 @@
 name: Ruby
 
-on: [push]
+on: [push, workflow_dispatch]
 
 jobs:
   build:
     runs-on: ubuntu-16.04
     strategy:
       matrix:
-        ruby: [ '2.4', '2.5', '2.6' ]
+        ruby: [ '2.5', '2.6', '2.7' ]
     name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Install Gems
+
+      - name: Setup Code Climate test-reporter
         run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+          ./cc-test-reporter before-build
+
+      - name: Build
+        run: |
+          docker-compose -p djin_ruby_${{ matrix.ruby }} build --build-arg ${{ matrix.ruby }} app
+
       - name: Run tests
-        run: bundle exec rake
+        run: |
+          docker-compose -p djin_ruby_${{ matrix.ruby }} run --rm app rspec
+        env:
+          TMP_TEST_FILE_FOLDER: '/tmp'
+
+      - name: Publish code coverage
+        run: |
+          # TODO: Move to script
+          docker-compose -p djin_ruby_${{ matrix.ruby }} run --rm app 'export GIT_BRANCH="${GITHUB_REF/refs\/heads\//}" && ./cc-test-reporter after-build -r ${{secrets.CC_TEST_REPORTER_ID}}'
 
   lint:
     runs-on: ubuntu-16.04

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 .byebug_history
+.irb_history
 
 # rspec failure tracking
 .rspec_status

data/.irbrc

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+IRB.conf[:SAVE_HISTORY] = 200
+IRB.conf[:HISTORY_FILE] = '~/.irb_history'

data/.rubocop.yml

@@ -3,6 +3,11 @@ inherit_from: .rubocop_todo.yml
 Style/Documentation:
   Enabled: false
 
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
+    - djin.gemspec 

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.11.0 - 14/01/2021
+ * [FEATURE] Remote Configs
+ * [TECH] Adds Test Coverage
+
 ## 0.10.0 - 08/10/2020
  * [FEATURE] -f command option
 

data/Dockerfile

@@ -1,4 +1,5 @@
-FROM ruby:2.6.5-alpine AS builder
+ARG RUBY_VERSION
+FROM ruby:${RUBY_VERSION:-2.6.5}-alpine AS builder
 
 ENV BUILD_PACKAGES build-base git
 
@@ -13,17 +14,23 @@ COPY djin.gemspec Gemfile Gemfile.lock ./
 
 COPY lib/djin/version.rb lib/djin/version.rb
 
-RUN gem install bundler -v 2.0.2
+RUN gem install bundler -v 2.1.4
 
 RUN bundle install
 
+FROM builder AS dev
+
+WORKDIR /usr/src/djin
+
+COPY . .
+
 FROM ruby:2.6.5-alpine
 
 WORKDIR /usr/src/djin
 
 COPY --from=builder /usr/local/bundle/ /usr/local/bundle
 
-RUN gem install bundler -v 2.0.2
+RUN gem install bundler -v 2.1.4
 
 ENV DEPENDENCIES git
 

data/Gemfile

@@ -2,5 +2,9 @@
 
 source 'https://rubygems.org'
 
+group :test do
+  gem 'factory_bot'
+end
+
 # Specify your gem's dependencies in djin.gemspec
 gemspec

data/Gemfile.lock

@@ -1,40 +1,46 @@
 PATH
   remote: .
   specs:
-    djin (0.10.0)
+    djin (0.11.0)
       dry-cli (~> 0.6.0)
       dry-equalizer (~> 0.3.0)
       dry-struct (~> 1.3.0)
       dry-validation (~> 1.5.1)
+      git (~> 1.8.1)
       mustache (~> 1.1.1)
       vseries (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.1)
     byebug (11.1.1)
     concurrent-ruby (1.1.7)
     diff-lcs (1.3)
+    docile (1.3.2)
     dry-cli (0.6.0)
       concurrent-ruby (~> 1.0)
-    dry-configurable (0.11.6)
+    dry-configurable (0.12.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.5.0)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
     dry-initializer (3.0.4)
-    dry-logic (1.0.8)
+    dry-logic (1.1.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-schema (1.5.5)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.5.6)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)
@@ -61,13 +67,22 @@ GEM
       dry-equalizer (~> 0.2)
       dry-initializer (~> 3.0)
       dry-schema (~> 1.5, >= 1.5.2)
+    factory_bot (6.1.0)
+      activesupport (>= 5.0.0)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
+    json (2.3.1)
+    minitest (5.14.3)
     mustache (1.1.1)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
+    rchardet (1.8.0)
     regexp_parser (1.7.1)
     rexml (3.2.4)
     rspec (3.9.0)
@@ -95,8 +110,16 @@ GEM
     rubocop-ast (0.0.3)
       parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     vseries (0.1.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -105,9 +128,11 @@ DEPENDENCIES
   bundler (~> 2.0)
   byebug
   djin!
+  factory_bot
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop
+  simplecov (~> 0.17.0)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -2,6 +2,7 @@
 
 ![](https://github.com/catks/djin/workflows/Ruby/badge.svg?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/824a2e78399813543212/maintainability)](https://codeclimate.com/github/catks/djin/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/824a2e78399813543212/test_coverage)](https://codeclimate.com/github/catks/djin/test_coverage)
 
 Djin is a make-like utility for docker containers
 
@@ -13,7 +14,7 @@ Djin is distributed as a Ruby Gem, to install simple run:
 
 ### With Rbenv
 
-If you use Rbenv you can install djin only once and create a alias in your .basrc, .zshrc, etc:
+If you use Rbenv you can install djin only once and create an alias in your .basrc, .zshrc, etc:
 
 #### ZSH
     $ RBENV_VERSION=$(rbenv global) gem install djin && echo "alias djin='RBENV_VERSION=$(rbenv global) djin'" >> ~/.zshrc
@@ -26,7 +27,7 @@ If you use Rbenv you can install djin only once and create a alias in your .basr
 To use djin first you need to create a djin.yml file:
 
 ```yaml
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 tasks:
   # With a docker image
@@ -53,12 +54,12 @@ You can also set task dependencies with depends_on option:
 
 
 ```yaml
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
 
-tasks: 
+tasks:
   "db:create":
     docker-compose:
       service: app
@@ -82,7 +83,7 @@ tasks:
 Or mix local commands and docker/docker-compose commands:
 
 ```yaml
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -121,7 +122,7 @@ After that you can run `djin {{task_name}}`, like `djin script` or `djin test`
 You can also use environment variables using the '{{YOUR_ENV_HERE}}' syntax, like so:
 
 ```yaml
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -138,7 +139,7 @@ tasks:
 
 Or define some variables to use in multiple locations
 ```yaml
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -162,7 +163,7 @@ tasks:
 It's also possible to pass custom arguments to the command, which means is possible to make a djin task act like the command itself:
 
 ```yaml
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -179,16 +180,16 @@ tasks:
 
 ```
 
-With that you can pass custom args after `--`, eg: `djin rubocop -- --parallel`, which wil make djin runs `rubocop --parallel` inside the service `app`.
+With that, you can pass custom args after `--`, eg: `djin rubocop -- --parallel`, which will make djin runs `rubocop --parallel` inside the service `app`.
 
 Under the hood djin uses [Mustache](https://mustache.github.io/), so you can use other features like conditionals: `{{#IS_ENABLE}} Enabled {{/IS_ENABLE}}` (for args use the `args?`, eg: `{{#args?}} {{args}} --and-other-thing{{/args?}}`), to see more more options you can access this [Link](https://mustache.github.io/mustache.5.html)
 
 ### Reusing tasks
 
-If you have multiple tasks with similar behaviour and with small differences you can use the `include` keyword, so this:
+If you have multiple tasks with similar behavior and with small differences you can use the `include` keyword, so this:
 
 ```yaml
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 tasks:
   "host1:ssh":
@@ -227,7 +228,7 @@ can become this:
 
 ```yaml
 # djin.yml
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 include:
   - file: '.djin/server_tasks.yml'
@@ -249,7 +250,7 @@ include:
 
 ```yaml
 # .djin/server_tasks.yml
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 tasks:
   "{{namespace}}:ssh":
@@ -266,11 +267,30 @@ tasks:
     local:
       run:
         - ssh -t {{ssh_user}}@{{host}} tail -f /var/log/my_log
-  ```
+```
+
+You can also reuse tasks in some git repository, to do that you need to declare a git source and optionally a version:
+
+```yaml
+djin_version: '0.11.0'
+
+include:
+  - git: 'https://github.com/catks/djin.git'
+    version: 'master'
+    file: 'examples/djin_lib/test.yml'
+    context:
+      variables:
+        namespace: 'remote:'
+
+```
+
+After that run `djin remote-config fetch` to fetch the repo and you can start using the tasks (All remote repos are cloned in `~/.djin/remote`)
+
+See `djin remote-config` to learn more.
 
 ### Loading custom files
 
-You can also specify a file to be read by djin with `-f`, eg: 
+You can also specify a file to be read by djin with `-f`, eg:
 
 ```bash
 djin -f my_file.yml # Returns the help for all tasks in my_file
@@ -298,7 +318,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 1. Enable multiple -f options to merge configuration between files
 2. Option to export tasks to Makefile
 3. djin-export docker image to create and sync makefiles
-4. include key option to add tasks in git repositories files (maybe with a local cache)
+4. include a key option to add tasks in git repositories files (maybe with a local cache)
 
 ## Contributing
 

data/Vertofile

@@ -1,4 +1,4 @@
-verto_version '0.8.0'
+verto_version '0.10.0'
 
 config {
   version.prefix = 'v' # Adds a version_prefix
@@ -12,20 +12,10 @@ context(branch('master')) {
   }
 
   before_tag_creation {
-    version_changes = sh(
-      %q#git log --oneline --decorate  | grep -B 100 -m 1 "tag:" | grep "pull request" | awk '{print $1}' | xargs git show --format='%b' | grep -v Approved | grep -v "^$" | grep -E "^[[:space:]]*\[.*\]" | sed 's/^[[:space:]]*\(.*\)/ * \1/'#, output: false
-     ).output
-
-    puts "---------------------------"
-    version_changes = "## #{new_version} - #{Time.now.strftime('%d/%m/%Y')}\n#{version_changes}\n"
-    exit unless confirm("Create new Realease?\n" \
-      "---------------------------\n" \
-      "#{version_changes}" \
-      "---------------------------\n"
-    )
-
-    # CHANGELOG
-    file('CHANGELOG.md').prepend(version_changes)
+    update_changelog(with: :merged_pull_requests_with_bracketed_labels,
+                     confirmation: true,
+                     filename: 'CHANGELOG.md')
+
     git!('add CHANGELOG.md')
 
     files_to_change_version_once = %w[lib/djin/version.rb djin.yml] + Dir['examples/**/*.yml'] + Dir['spec/support/fixtures/**/*.yml']

data/djin.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   # 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(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|docker)/}) }
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   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 'git', '~> 1.8.1'
   spec.add_dependency 'mustache', '~> 1.1.1'
   spec.add_dependency 'vseries', '~> 0.1.0'
   spec.add_development_dependency 'bundler', '~> 2.0'
@@ -38,4 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov', '~> 0.17.0'
 end

data/djin.yml

@@ -1,4 +1,4 @@
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 _default_run_options: &default_run_options
   options: "--rm --entrypoint=''"
@@ -9,11 +9,21 @@ tasks:
     docker-compose:
       service: app
       run:
-        commands: "cd /usr/src/djin && rspec {{args}}"
+        commands: "rspec {{args}}"
         <<: *default_run_options
     aliases:
       - rspec
 
+  lint:
+    description: Lint
+    docker-compose:
+      service: app
+      run:
+        commands: "rubocop {{args}}"
+        <<: *default_run_options
+    aliases:
+      - rubocop
+
   sh:
     description: Enter app service shell
     docker-compose:

data/docker-compose.yml

@@ -1,6 +1,20 @@
-version: '3'
+version: "3.9"
+
 services:
   app:
-    build: .
+    build:
+      context: .
+      target: dev
+    entrypoint: 'sh docker-entrypoint.sh'
+    command: 'djin'
+    tty: true
+    stdin_open: true
     volumes:
       - .:/usr/src/djin
+    depends_on:
+      - gitserver
+
+  gitserver:
+    image: catks/gitserver-http:0.1.0
+    volumes:
+      - ./docker/git_server/repos/:/var/lib/initial/

data/docker-entrypoint.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -e
+
+bundle check || bundle install
+
+exec bundle exec "$@"

data/examples/djin.yml

@@ -1,5 +1,5 @@
 ---
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 include:
   - file: 'djin_lib/test.yml'

data/examples/djin_lib/test.yml

@@ -1,4 +1,4 @@
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 _default_run_options: &default_run_options
   options: "--rm --entrypoint=''"

data/examples/local_tasks/djin.yml

@@ -1,4 +1,4 @@
-djin_version: '0.10.0'
+djin_version: '0.11.0'
 
 include:
   - file: '.djin/server_tasks.yml'

data/examples/remote_tasks/djin.yml

@@ -0,0 +1,9 @@
+djin_version: '0.11.0'
+
+include:
+  - git: 'https://gitserver/myrepo.git'
+    version: 'master'
+    file: 'examples/djin_lib/test.yml'
+    context:
+      variables:
+        namespace: 'remote:'

data/lib/djin.rb

@@ -9,22 +9,26 @@ require 'vseries'
 require 'dry/cli'
 require 'mustache'
 require 'optparse'
+require 'git'
 require 'djin/extensions/hash_extensions'
 require 'djin/extensions/object_extensions'
 require 'djin/entities/types'
 require 'djin/entities/task'
-require 'djin/entities/file_config'
+require 'djin/entities/include_config.rb'
+require 'djin/entities/main_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/include_resolver'
 require 'djin/config_loader'
 require 'djin/executor'
 require 'djin/root_cli_parser'
 require 'djin/cli'
 require 'djin/task_contract'
 require 'djin/repositories/task_repository'
+require 'djin/repositories/remote_config_repository'
 require 'djin/memory_cache'
 
 module Djin
@@ -32,34 +36,66 @@ module Djin
 
   using Djin::ObjectExtensions
 
-  def self.load_tasks!(*file_paths)
-    files = file_paths.presence || RootCliParser.parse![:files] || ['djin.yml']
+  class << self
+    def load_tasks!(*file_paths)
+      files = file_paths.presence || RootCliParser.parse![:files] || ['djin.yml']
 
-    file_config = ConfigLoader.load_files!(*files)
+      file_config = ConfigLoader.load_files!(*files)
 
-    # TODO: Make all tasks be under 'tasks' key, passing only the tasks here
-    tasks = Interpreter.load!(file_config)
+      # 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 => e
-    error_name = e.class.name.split('::').last
-    abort("[#{error_name}] #{e.message}")
-  end
+      @task_repository = TaskRepository.new(tasks)
 
-  def self.tasks
-    task_repository.all
-  end
+      remote_configs = file_config.include_configs.select { |f| f.type == :remote }
+      @remote_config_repository = RemoteConfigRepository.new(remote_configs)
 
-  def self.task_repository
-    @task_repository ||= TaskRepository.new
-  end
+      CLI.load_tasks!(tasks)
+    rescue Djin::Interpreter::InvalidConfigurationError => e
+      error_name = e.class.name.split('::').last
+      abort("[#{error_name}] #{e.message}")
+    end
 
-  def self.cache
-    @cache ||= MemoryCache.new
-  end
+    def tasks
+      task_repository.all
+    end
+
+    def task_repository
+      @task_repository ||= TaskRepository.new
+    end
+
+    def remote_config_repository
+      @remote_config_repository ||= RemoteConfigRepository.new
+    end
+
+    def cache
+      @cache ||= MemoryCache.new
+    end
+
+    def root_path
+      Pathname.new File.expand_path(__dir__ + '/..')
+    end
+
+    def warn(message, type: 'WARNING')
+      stderr.puts "[#{type}] #{message}"
+    end
+
+    def warn_once(message, type: 'WARNING')
+      return if warnings.include?(message)
+
+      warn(message, type: type)
+
+      warnings << message
+    end
+
+    def stderr
+      $stderr
+    end
+
+    private
 
-  def self.root_path
-    Pathname.new File.expand_path(File.dirname(__FILE__) + '/..')
+    def warnings
+      @warnings ||= []
+    end
   end
 end

data/lib/djin/cli.rb

@@ -37,7 +37,33 @@ module Djin
       end
     end
 
+    module RemoteConfig
+      class Fetch < Dry::CLI::Command
+        desc 'Fetchs missing remote configs'
+
+        def call(*)
+          Djin.remote_config_repository.fetch_all
+        end
+      end
+
+      class Clear < Dry::CLI::Command
+        desc 'clear downloaded remote configs'
+        option :all,
+               type: :boolean,
+               default: false,
+               desc: 'Remove all remote configs, not only the ones referenced in the current djin file'
+
+        def call(all:)
+          return Djin.remote_config_repository.clear_all if all
+
+          Djin.remote_config_repository.clear
+        end
+      end
+    end
+
     register '-f', File, aliases: ['--file']
     register '--version', Version, aliases: ['-v']
+    register 'remote-config fetch', RemoteConfig::Fetch
+    register 'remote-config clear', RemoteConfig::Clear
   end
 end

data/lib/djin/config_loader.rb

@@ -4,11 +4,13 @@ module Djin
   # TODO: Refactor this class to be the Interpreter
   #       class and use the current interpreter as
   #       a TaskLoader
+
+  # rubocop:disable Metrics/ClassLength
   class ConfigLoader
     using Djin::HashExtensions
     RESERVED_WORDS = %w[djin_version variables tasks include].freeze
 
-    # CHange Base Error
+    # Change Base Error
     FileNotFoundError = Class.new(Interpreter::InvalidConfigurationError)
 
     def self.load_files!(*files, runtime_config: {}, base_directory: '.')
@@ -25,7 +27,7 @@ module Djin
       @base_directory = Pathname.new(base_directory)
       @template_file = @base_directory.join(template_file_path)
 
-      raise FileNotFoundError, "File '#{@template_file}' not found" unless @template_file.exist?
+      file_not_found!(@template_file) unless @template_file.exist?
 
       @template_file_content = Djin.cache.fetch(@template_file.realpath.to_s) { @template_file.read }
       @runtime_config = runtime_config
@@ -33,6 +35,7 @@ module Djin
 
     def load!
       validate_version!
+      validate_missing_config!
 
       file_config
     end
@@ -40,11 +43,12 @@ module Djin
     private
 
     def file_config
-      FileConfig.new(
+      MainConfig.new(
         djin_version: version,
         variables: variables,
         tasks: tasks,
-        raw_tasks: raw_tasks
+        raw_tasks: raw_tasks,
+        include_configs: @include_configs || []
       )
     end
 
@@ -66,8 +70,11 @@ module Djin
     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'
+      Djin.warn_once(
+        'Root tasks are deprecated and will be removed in Djin 1.0.0,' \
+        ' put the tasks under \'tasks\' keyword',
+        type: 'DEPRECATED'
+      )
 
       rendered_djin_config.except(*RESERVED_WORDS).reject { |task| task.start_with?('_') }
     end
@@ -94,11 +101,37 @@ module Djin
       included_config.raw_tasks
     end
 
+    # TODO: Rename method
     def included_config
-      @included_config ||= raw_djin_config['include']&.map do |tasks_reference|
-        ConfigLoader.load!(tasks_reference['file'], base_directory: @template_file.dirname,
-                                                    runtime_config: tasks_reference['context'] || {})
-      end&.reduce(:deep_merge)
+      @included_config ||= begin
+                             present_include_configs&.map do |present_include|
+                               ConfigLoader.load!(present_include.file, base_directory: @template_file.dirname,
+                                                                        # TODO: Rename to context_config
+                                                                        runtime_config: present_include.context)
+                             end&.reduce(:deep_merge)
+                           end
+    end
+
+    def present_include_configs
+      include_configs&.select(&:present?)
+    end
+
+    def missing_include_configs
+      include_configs&.select(&:missing?)
+    end
+
+    # TODO: Refactor to move include methods to a specific IncludeConfigLoader, maybe rename IncludeResolver
+    def include_configs
+      @include_configs ||= begin
+                             # TODO: Rename the resolved variables
+                             resolver = IncludeResolver.new(base_directory: @template_file.dirname)
+
+                             include_djin_config = raw_djin_config['include'] || []
+
+                             include_djin_config.map do |include_config|
+                               resolver.call(include_config)
+                             end
+                           end
     end
 
     def args
@@ -142,5 +175,26 @@ module Djin
 
       raise Interpreter::VersionNotSupportedError, "Version #{version} is not supported, use #{Djin::VERSION} or higher"
     end
+
+    def validate_missing_config!
+      missing_include_configs.each do |ic|
+        file_not_found!(ic.full_path) if ic.type == :local
+
+        missing_file_remote_error = "#{ic.git} exists but is missing %s," \
+          'if the file exists in upstream run djin remote-config fetch to fix'
+
+        file_not_found!(ic.full_path, missing_file_remote_error) if ic.type == :remote && ic.repository_fetched?
+
+        if ic.type == :remote
+          Djin.warn_once "Missing #{ic.git} with version '#{ic.version}', " \
+            'run `djin remote-config fetch` to fetch the config'
+        end
+      end
+    end
+
+    def file_not_found!(filename, message = "File '%s' not found")
+      raise FileNotFoundError, message % filename
+    end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/djin/entities/include_config.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Djin
+  class IncludeConfig < Dry::Struct
+    attribute :file, Types::String
+    attribute :base_directory, Types::String
+    attribute :context, Types::Hash.default({}.freeze)
+    attribute :git, Types::String.optional.default(nil)
+    attribute :version, Types::String.default('master')
+    attribute :missing, Types::Bool.optional.default(nil)
+
+    using Djin::ObjectExtensions
+
+    include Dry::Equalizer(:git, :version, :file, :context)
+
+    def type
+      @type ||= git.present? ? :remote : :local
+    end
+
+    def present?
+      !missing?
+    end
+
+    def missing?
+      missing
+    end
+
+    def full_path
+      base_directory_pathname.join(file).expand_path
+    end
+
+    def repository_fetched?
+      @repository_fetched ||= base_directory_pathname.join(folder_name).exist?
+    end
+
+    # TODO: Rethink
+    def folder_name
+      @folder_name ||= "#{git.split('/').last.chomp('.git')}@#{version}"
+    end
+
+    private
+
+    def base_directory_pathname
+      @base_directory_pathname ||= Pathname.new(base_directory)
+    end
+  end
+end

data/lib/djin/entities/include_config/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Djin
+  module IncludeConfig
+    class Base < Dry::Struct
+      attribute :file, Types::String
+      attribute :context, Types::Hash.default({}.freeze)
+
+      include Dry::Equalizer(:file, :context)
+
+      def type
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/djin/entities/include_config/local.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Djin
+  module IncludeConfig
+    class Local < Dry::Struct
+      attribute :file, Types::String
+      attribute :context, Types::Hash.default({}.freeze)
+
+      include Dry::Equalizer(:file, :context)
+
+      def type
+        :local
+      end
+    end
+  end
+end

data/lib/djin/entities/{file_config.rb → main_config.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Djin
-  class FileConfig < Dry::Struct
+  class MainConfig < Dry::Struct
     using HashExtensions
 
     attribute :djin_version, Types::String
@@ -9,6 +9,7 @@ module Djin
     attribute :tasks, Types::Hash
     attribute :raw_tasks, Types::Hash
     # TODO: Add env and args
+    attribute :include_configs, Types::Array.of(Djin::IncludeConfig).default([].freeze)
 
     include Dry::Equalizer(:djin_version, :variables, :tasks, :raw_tasks)
 
@@ -19,13 +20,13 @@ module Djin
     def merge(file_config)
       merged_hash = to_h.merge(file_config.to_h)
 
-      FileConfig.new(merged_hash)
+      MainConfig.new(merged_hash)
     end
 
     def deep_merge(file_config)
       merged_hash = to_h.deep_merge(file_config.to_h)
 
-      FileConfig.new(merged_hash)
+      MainConfig.new(merged_hash)
     end
   end
 end

data/lib/djin/include_resolver.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Djin
+  class IncludeResolver
+    using ObjectExtensions
+    using HashExtensions
+
+    def initialize(base_directory: '.', remote_directory: '~/.djin/remote', entity_class: Djin::IncludeConfig)
+      # TODO: Use chain of responsability
+      @base_directory = Pathname.new(base_directory)
+      @remote_directory = Pathname.new(remote_directory)
+      @entity_class = entity_class
+    end
+
+    def call(params)
+      include_config_params = remote_handler(params)
+      include_config_params ||= local_handler(params)
+
+      build_entity(include_config_params)
+    end
+
+    private
+
+    def remote_handler(params)
+      return if params['git'].blank?
+
+      version = params['version'] || 'master'
+      # TODO: Extract RemoteConfig git_folder in IncludeConfig to another place and use it here
+      # Maybe create a optional git_folder attribute and fill it in here?
+      git_folder = "#{params['git'].split('/').last.chomp('.git')}@#{version}"
+
+      # TODO: Use RemoteConfigRepository
+      remote_file = @remote_directory.join(git_folder).join(params['file']).expand_path
+
+      missing = !remote_file.exist?
+
+      params.merge(missing: missing, file: remote_file.to_s, base_directory: @remote_directory.expand_path.to_s)
+    end
+
+    def local_handler(params)
+      # TODO: Mark not existing files as missing and handle all the missing files
+      missing = !@base_directory.join(params['file']).exist?
+      params.merge(missing: missing, base_directory: @base_directory.expand_path.to_s)
+    end
+
+    def build_entity(params)
+      @entity_class.new(**params.symbolize_keys)
+    end
+  end
+end

data/lib/djin/repositories/remote_config_repository.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Djin
+  class RemoteConfigRepository
+    attr_accessor :base_path
+
+    def initialize(remote_configs, base_path: Pathname.new('~/.djin/remote'), stderr: Djin.stderr)
+      @remote_configs = remote_configs
+      @base_path = base_path
+      @stderr = stderr
+    end
+
+    def add(remote_config)
+      remote_configs << remote_config
+    end
+
+    def find(**filters)
+      remote_configs.select do |remote_config|
+        filters.reduce(true) do |memo, (filter_key, filter_value)|
+          memo && remote_config.public_send(filter_key) == filter_value
+        end
+      end
+    end
+
+    def fetch_all
+      remote_configs.each do |rc|
+        git_folder = base_path.join(rc.folder_name).expand_path
+
+        # TODO: Extract STDEER Output, maybe publishing events and subscribing a observer for the logs.
+        stderr.puts "Remote Path: #{base_path.expand_path}"
+        git_repo = rc.missing? ? clone_repo(git_folder, rc) : fetch_repo(git_folder, rc)
+
+        stderr.puts "Checking out to '#{rc.version}'"
+        git_repo.checkout(rc.version)
+        git_repo.pull
+      end
+    end
+
+    def clear
+      remote_configs.each do |rc|
+        git_folder = base_path.join(rc.folder_name)
+
+        stderr.puts "Removing #{rc.folder_name} repository..."
+        `rm -rf #{git_folder}`
+      end
+    end
+
+    def clear_all
+      remove_remote_folder
+    end
+
+    def remote_configs
+      @remote_configs ||= []
+    end
+
+    private
+
+    attr_accessor :stderr
+
+    def remove_remote_folder
+      stderr.puts "Removing #{base_path}..."
+      `rm -rf #{base_path}`
+    end
+
+    def clone_repo(git_folder, remote_config)
+      stderr.puts "Missing #{remote_config.folder_name} repository, cloning in #{git_folder}"
+      Git.clone(remote_config.git, git_folder, progress: true)
+    end
+
+    def fetch_repo(git_folder, remote_config)
+      stderr.puts "#{remote_config.git} repository already cloned, fetching..."
+      git_repo = Git.open(git_folder)
+      git_repo.fetch
+
+      git_repo
+    end
+  end
+end

data/lib/djin/root_cli_parser.rb

@@ -22,6 +22,10 @@ module Djin
             opts.on('-h', '--help') do
               throw :root_cli_exit
             end
+
+            opts.on('--all') do
+              throw :root_cli_exit
+            end
           end.parse(args)
         end
 

data/lib/djin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Djin
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: djin
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Carlos Atkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
 description: 
 email:
 - carlos.atks@gmail.com
@@ -174,6 +202,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".irbrc"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -191,26 +220,33 @@ files:
 - djin.gemspec
 - djin.yml
 - docker-compose.yml
+- docker-entrypoint.sh
 - examples/djin.yml
 - examples/djin_lib/test.yml
 - examples/local_tasks/.djin/server_tasks.yml
 - examples/local_tasks/djin.yml
+- examples/remote_tasks/djin.yml
 - exe/djin
 - lib/djin.rb
 - lib/djin/cli.rb
 - lib/djin/config_loader.rb
-- lib/djin/entities/file_config.rb
+- lib/djin/entities/include_config.rb
+- lib/djin/entities/include_config/base.rb
+- lib/djin/entities/include_config/local.rb
+- lib/djin/entities/main_config.rb
 - lib/djin/entities/task.rb
 - lib/djin/entities/types.rb
 - lib/djin/executor.rb
 - lib/djin/extensions/hash_extensions.rb
 - lib/djin/extensions/object_extensions.rb
+- lib/djin/include_resolver.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/memory_cache.rb
+- lib/djin/repositories/remote_config_repository.rb
 - lib/djin/repositories/task_repository.rb
 - lib/djin/root_cli_parser.rb
 - lib/djin/task_contract.rb
@@ -234,8 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: djin is a make-like utility for docker containers