djin 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a40e01844f1a9b034d592696cf6af915622c834a9e231f0c56209c03d11660ad
-  data.tar.gz: facbe98a7362ec81b5f819af27a554807790a1445c7cc47161a85d5f0d5b7276
+  metadata.gz: 35900c4ab60e94710d24194ea2192edbf4e806527af87fe9d53e693bcec03704
+  data.tar.gz: 53a1b1caabf4ff2e7a708fa1e31ccd7b552514cc6eb882d7152ba015bb58db01
 SHA512:
-  metadata.gz: 72f5ea393c498311acf74a482b02670d94f11704a75032e31e914e68b947de694bec077ba03e22b75fd73c9307f9f98242ea35009f5341c2ab9b3d1af0314901
-  data.tar.gz: 4bf6650c80d7defc1dd3b2850c21b74c54ecdb7f4dd374c0a98dd3bfe2610c7175f7102a71de53d6367a4dfd1fcdae47437a2db24bee83bc1c195a4c0fea9da7
+  metadata.gz: 3cb346575e3426446ad0c2ea2043d386a6112b9414d84927b24a5f0e3dec6062c361a9a6f0910c34fb13819d978d1721d882f53fe36fcf4a5aa5231eac4b6cc3
+  data.tar.gz: 34888b78f7f7af5792fc75f373870792d41986f818bfef643ad8d27f954b9f5e92791226c282933e0f3d7fa57acc42a0f71838df45acff47d48b424d53c24051

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.6.0 - 22/07/2020
+ * [FEATURE] Djin Variables
+
 ## 0.5.0 - 13/07/2020
  * [FEATURE] Adds local command task
  * [FEATURE] Template Args for entire djin.yml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    djin (0.5.0)
+    djin (0.6.0)
       dry-cli (~> 0.6.0)
       dry-struct (~> 1.3.0)
       dry-validation (~> 1.5.1)
@@ -53,7 +53,7 @@ GEM
       dry-equalizer (~> 0.3)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.5.1)
+    dry-validation (1.5.2)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
       dry-core (~> 0.4)

data/README.md

@@ -1,6 +1,7 @@
 # Djin
 
 ![](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)
 
 Djin is a make-like utility for docker containers
 
@@ -25,139 +26,164 @@ 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.5.0'
-
-# With a docker image
-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"
-
-# Using a docker-compose service
-test:
+djin_version: '0.6.0'
+
+tasks:
+  # With a docker image
+  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"
+
+  # Using a docker-compose service
+  test:
   docker-compose:
     service: app
     run:
       commands: rspec
       options: "--rm"
-
 ```
 
 You can also set task dependencies with depends_on option:
 
 
 ```yaml
-djin_version: '0.5.0'
+djin_version: '0.6.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
 
-"db:create":
-  docker-compose:
-    service: app
-    run:
-      commands: rake db:create
-      <<: *default_run_options
-
-"db:migrate":
-  docker-compose:
-    service: app
-    run:
-      commands: rake db:migrate
-      <<: *default_run_options
-
-"db:setup":
-  depends_on:
-    - "db:create"
-    - "db:migrate"
-
+tasks: 
+  "db:create":
+    docker-compose:
+      service: app
+      run:
+        commands: rake db:create
+        <<: *default_run_options
+
+  "db:migrate":
+    docker-compose:
+      service: app
+      run:
+        commands: rake db:migrate
+        <<: *default_run_options
+
+  "db:setup":
+    depends_on:
+      - "db:create"
+      - "db:migrate"
 ```
 
 Or mix local commands and docker/docker-compose commands:
 
 ```yaml
-djin_version: '0.5.0'
+djin_version: '0.6.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
 
-"db:create":
-  docker-compose:
-    service: app
-    run:
-      commands: rake db:create
-      <<: *default_run_options
+tasks:
+  "db:create":
+    docker-compose:
+      service: app
+      run:
+        commands: rake db:create
+        <<: *default_run_options
+
+  "db:migrate":
+    docker-compose:
+      service: app
+      run:
+        commands: rake db:migrate
+        <<: *default_run_options
+
+  "setup:copy_samples":
+    local:
+      run:
+        - cp config/database.yml.sample config/database.yml
+
+  "setup":
+    depends_on:
+      - "setup:copy_samples"
+      - "db:create"
+      - "db:migrate"
+```
 
-"db:migrate":
-  docker-compose:
-    service: app
-    run:
-      commands: rake db:migrate
-      <<: *default_run_options
+After that you can run `djin {{task_name}}`, like `djin script` or `djin test`
 
-"setup:copy_samples":
-  local:
-    run:
-      - cp config/database.yml.sample config/database.yml
+## Using Environment variables, custom variables and custom args in djin.yml tasks
 
-"setup":
-  depends_on:
-    - "setup:copy_samples"
-    - "db:create"
-    - "db:migrate"
+You can also use environment variables using the '{{YOUR_ENV_HERE}}' syntax, like so:
 
-```
+```yaml
+djin_version: '0.6.0'
 
-After that you can run `djin {{task_name}}`, like `djin script` or `djin test`
+_default_run_options: &default_run_options
+  options: "--rm"
 
-## Using Environment variables and custom args in djin.yml run tasks
+tasks:
+  "db:migrate":
+    docker-compose:
+      service: app
+      run:
+        commands: ENV={{ENV}} rake db:migrate
+        <<: *default_run_options
 
-You can also use environment variables using the '{{YOUR_ENV_HERE}}' syntax, like so:
+```
 
+Or define some variables to use in multiple locations
 ```yaml
-djin_version: '0.5.0'
+djin_version: '0.6.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
 
-"db:migrate":
-  docker-compose:
-    service: app
-    run:
-      commands: ENV={{ENV}} rake db:migrate
-      <<: *default_run_options
+variables:
+  my_ssh_user: user
+  some_host: test.local
 
+tasks:
+  "some_host:ssh":
+    local:
+      run:
+        - ssh {{my_ssh_user}}@{{some_host}}
+
+  "some_host:logs":
+    local:
+      run:
+        - ssh -t {{my_ssh_user}}@{{some_host}} 'tail -f /var/log/syslog'
 ```
 
-It's also possible to pass custom arguments to the command, wich means is possible to make a djin task act like the command itself:
+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.5.0'
+djin_version: '0.6.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
 
-"rubocop":
-  docker-compose:
-    service: app
-    run:
-      commands: rubocop {{args}}
-      <<: *default_run_options
+tasks:
+  "rubocop":
+    docker-compose:
+      service: app
+      run:
+        commands: rubocop {{args}}
+        <<: *default_run_options
 
 ```
 
 With that you can pass custom args after `--`, eg: `djin rubocop -- --parallel`, which wil 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)
+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)
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, run `djin release -- {{increment_option}}` (where {{incremment_option}} can be `--patch`, `--minor` or `major`), which will change version, update the CHANGELOG.md, create a new commit, create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## TODO:
 

data/djin.yml

@@ -1,33 +1,31 @@
-djin_version: '0.5.0'
+djin_version: '0.6.0'
 
 _default_run_options: &default_run_options
   options: "--rm --entrypoint=''"
 
-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
-run:
-  docker-compose:
-    service: app
-    run:
-      commands: "sh -c '{{args}}'"
-      <<: *default_run_options
-
-release:
-  local:
-    run:
-      - verto tag up {{args}}
-      - rake release
-
+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
+  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,29 +1,29 @@
 ---
-djin_version: '0.5.0'
+djin_version: '0.6.0'
 
-default:
-  docker:
-    image: "ruby:2.5"
-    run:
-      - "ruby -e 'puts \\\" Hello\\\"'"
-test:
-  docker-compose:
-    service: app
-    run:
-      commands: rspec
-      options: "--rm"
+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"
+  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/lib/djin.rb

@@ -16,7 +16,7 @@ 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/config_loader'
 require 'djin/executor'
 require 'djin/cli'
 require 'djin/task_contract'
@@ -28,9 +28,9 @@ module Djin
   def self.load_tasks!(path = Pathname.getwd.join('djin.yml'))
     abort 'Error: djin.yml not found' unless path.exist?
 
-    rendered_djin_file = TemplateRenderer.render(path.read)
-    djin_config = YAML.safe_load(rendered_djin_file, [], [], true)
+    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)

data/lib/djin/config_loader.rb

@@ -0,0 +1,92 @@
+# 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)
+    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/extensions/hash_extensions.rb

@@ -6,6 +6,10 @@ module Djin
       def except(*keys)
         reject { |key, _| keys.include?(key) }
       end
+
+      def symbolize_keys
+        map { |key, value| [key.to_sym, value] }.to_h
+      end
     end
   end
 end

data/lib/djin/interpreter.rb

@@ -4,22 +4,14 @@ module Djin
   class Interpreter
     using Djin::HashExtensions
 
-    RESERVED_WORDS = %w[djin_version _default_options].freeze
-
+    # 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)
-        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?('_') }
+      def load!(tasks_params)
         contract = TaskContract.new
 
         tasks_params.map do |task_name, options|
@@ -54,10 +46,6 @@ module Djin
 
         LocalCommandBuilder.call(local_params) if local_params
       end
-
-      def version_supported?(version)
-        Vseries::SemanticVersion.new(Djin::VERSION) >= Vseries::SemanticVersion.new(version)
-      end
     end
   end
 end

data/lib/djin/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: djin
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Carlos Atkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -181,6 +181,7 @@ 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
@@ -192,7 +193,6 @@ files:
 - lib/djin/interpreter/local_command_builder.rb
 - lib/djin/repositories/task_repository.rb
 - lib/djin/task_contract.rb
-- lib/djin/template_renderer.rb
 - lib/djin/version.rb
 homepage: https://github.com/catks/djin
 licenses:

data/lib/djin/template_renderer.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Djin
-  class TemplateRenderer
-    def self.render(template_file)
-      new(template_file).render
-    end
-
-    def initialize(template_file)
-      @template_file = template_file
-    end
-
-    def render
-      Mustache.render(@template_file,
-                      args: args.join(' '),
-                      args?: args.any?,
-                      **env)
-    end
-
-    private
-
-    def args
-      index = ARGV.index('--')
-
-      return [] unless index
-
-      ARGV.slice((index + 1)..ARGV.size)
-    end
-
-    def env
-      @env ||= ENV.to_h.map { |k, v| [k.to_sym, v] }.to_h
-    end
-  end
-end