djin 0.1.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b1c6e4a65fd3d45dda2ccea34bafb2a33e927d59b25d273486152968629956d
-  data.tar.gz: 7d5bac09875862642943dcf43bdfb61e9874203b6264c16aceeb918669fd4939
+  metadata.gz: 35900c4ab60e94710d24194ea2192edbf4e806527af87fe9d53e693bcec03704
+  data.tar.gz: 53a1b1caabf4ff2e7a708fa1e31ccd7b552514cc6eb882d7152ba015bb58db01
 SHA512:
-  metadata.gz: 0ab09434fc83b94f14a2f2eed6bc23cbb1319a36083e9d110621e71b540953294e62eca5d59d7d4daa667066bd713d20595079c742aa8fe60d41d709e1f9323b
-  data.tar.gz: 85628587736a959d29946c56ffea2e9379bd9184a0f6b9ad939967630d8a71b3004c276a203086bf3b510bfe11902c9c24d3ad279569044686af750a0ec17577
+  metadata.gz: 3cb346575e3426446ad0c2ea2043d386a6112b9414d84927b24a5f0e3dec6062c361a9a6f0910c34fb13819d978d1721d882f53fe36fcf4a5aa5231eac4b6cc3
+  data.tar.gz: 34888b78f7f7af5792fc75f373870792d41986f818bfef643ad8d27f954b9f5e92791226c282933e0f3d7fa57acc42a0f71838df45acff47d48b424d53c24051

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-16.04
+    strategy:
+      matrix:
+        ruby: [ '2.4', '2.5', '2.6' ]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake
+
+  lint:
+    runs-on: ubuntu-16.04
+    name: Lint
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+      - run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rubocop
+

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-07-14 01:12:35 UTC using RuboCop version 0.86.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 19

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## 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
+
+## 0.4.0 - 25/06/2020
+ * [FEATURE] Adds Custom Args and Environment support in djin.yml
+
+## 0.3.1 - 29/05/2020
+ * [PATCH] Handles Ctrl + C
+ * [TECH] Adds Vertofile
+
+## 0.3.0 - 19/05/2020
+ * [FEATURE] Adds Version Option
+ * [PATCH] Add task name in djin.yml parse errors
+

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in djin.gemspec
 gemspec

data/Gemfile.lock

@@ -1,20 +1,23 @@
 PATH
   remote: .
   specs:
-    djin (0.1.1)
-      dry-cli (~> 0.5.0)
+    djin (0.6.0)
+      dry-cli (~> 0.6.0)
       dry-struct (~> 1.3.0)
-      dry-validation (~> 1.5.0)
+      dry-validation (~> 1.5.1)
+      mustache (~> 1.1.1)
+      vseries (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
     byebug (11.1.1)
     concurrent-ruby (1.1.6)
     diff-lcs (1.3)
-    dry-cli (0.5.1)
+    dry-cli (0.6.0)
       concurrent-ruby (~> 1.0)
-    dry-configurable (0.11.3)
+    dry-configurable (0.11.6)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
       dry-equalizer (~> 0.2)
@@ -30,7 +33,7 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-schema (1.5.0)
+    dry-schema (1.5.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)
@@ -50,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.0)
+    dry-validation (1.5.2)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
       dry-core (~> 0.4)
@@ -58,7 +61,14 @@ GEM
       dry-initializer (~> 3.0)
       dry-schema (~> 1.5)
     ice_nine (0.11.2)
-    rake (10.5.0)
+    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)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -72,6 +82,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+    vseries (0.1.1)
 
 PLATFORMS
   ruby
@@ -80,8 +104,9 @@ DEPENDENCIES
   bundler (~> 2.0)
   byebug
   djin!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
+  rubocop
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -1,47 +1,193 @@
 # 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
+
 ## Installation
 
 Djin is distributed as a Ruby Gem, to install simple run:
 
     $ gem install djin
 
+### With Rbenv
+
+If you use Rbenv you can install djin only once and create a alias in your .basrc, .zshrc, etc:
+
+#### ZSH
+    $ RBENV_VERSION=$(rbenv global) gem install djin && echo "alias djin='RBENV_VERSION=$(rbenv global) djin'" >> ~/.zshrc
+
+### Bash
+    $ RBENV_VERSION=$(rbenv global) gem install djin && echo "alias djin='RBENV_VERSION=$(rbenv global) djin'" >> ~/.bashrc
+
 ## Usage
 
 To use djin first you need to create a djin.yml file:
 
 ```yaml
-# 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.6.0'
+
+_default_run_options: &default_run_options
+  options: "--rm"
+
+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.6.0'
+
+_default_run_options: &default_run_options
+  options: "--rm"
+
+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"
 ```
 
 After that you can run `djin {{task_name}}`, like `djin script` or `djin test`
 
+## Using Environment variables, custom variables and custom args in djin.yml tasks
+
+You can also use environment variables using the '{{YOUR_ENV_HERE}}' syntax, like so:
+
+```yaml
+djin_version: '0.6.0'
+
+_default_run_options: &default_run_options
+  options: "--rm"
+
+tasks:
+  "db:migrate":
+    docker-compose:
+      service: app
+      run:
+        commands: ENV={{ENV}} rake db:migrate
+        <<: *default_run_options
+
+```
+
+Or define some variables to use in multiple locations
+```yaml
+djin_version: '0.6.0'
+
+_default_run_options: &default_run_options
+  options: "--rm"
+
+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, which means is possible to make a djin task act like the command itself:
+
+```yaml
+djin_version: '0.6.0'
+
+_default_run_options: &default_run_options
+  options: "--rm"
+
+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)
+
 ## 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:
 
-1. Add `depends_on` to run dependent tasks
-2. Adds a `-f` option to load custom djin files
+1. Adds a `-f` option to load custom djin files
 
 ## Contributing
 

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require_relative "lib/djin"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require_relative 'lib/djin'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 desc 'Djin REPL'
 task :console do

data/Vertofile

@@ -0,0 +1,45 @@
+verto_version '0.8.0'
+
+config {
+  version.prefix = 'v' # Adds a version_prefix
+  git.pull_before_tag_creation = true
+  git.push_after_tag_creation = true
+}
+
+context(branch('master')) {
+  before_command_tag_up {
+    command_options.add(filter: 'release_only')
+  }
+
+  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)
+    git!('add CHANGELOG.md')
+
+    file('lib/djin/version.rb').replace(latest_version.to_s, new_version.to_s)
+    file('djin.yml').replace(latest_version.to_s, new_version.to_s)
+    file('examples/djin.yml').replace(latest_version.to_s, new_version.to_s)
+    file('README.md').replace_all(latest_version.to_s, new_version.to_s)
+
+    git!('add lib/djin/version.rb djin.yml examples/djin.yml README.md')
+
+    sh!('bundle install')
+    sh!('rake install')
+    git!('add Gemfile.lock')
+
+    git!('commit -m "Bumps Version"')
+  }
+}
+