djin 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 395a6c76f1aac739197b1721dfedca93dfffcfcf456d3fc748fa16f024fb5a94
-  data.tar.gz: c2915512107075ee0fb3bafbfe50033925410241fef29dd54db747a2d0686328
+  metadata.gz: 558aca989aad2d1cfd7b19768a7a5d6fd2f660afb5135fb9ca3ae03eacb233b4
+  data.tar.gz: f2e5c3861c6db601b77bc04321386cb2c22ec049d315781966830ba8a5f6e8af
 SHA512:
-  metadata.gz: 802cfbb81399c9ec9494b98036c7bd5932e735eb028b44ff84abc1ff0f2ff7930fe4d5a2d9b2bdae2b493684289e0e1d8631e570c942c71351321faa641bac85
-  data.tar.gz: 3b895f090fb9c73aac047c234a13191702393cf7fdff8c6b9eb0437daed931e7ae71ba0d6c8113d45b84d6424897309c66f310bfd470f58c955c1b508aa771d9
+  metadata.gz: a898ea486006d81980a4e963a1e7b2d31f40c5bec00d9b5948f4b32d0be5c222b61525c90fd214523cd482aadeab88e3927cb3a3697f7fc86b8180901e015543
+  data.tar.gz: 3d6b0a29b1faa6a3bffb0fa5076ee88083229cbb36f77f2166e44bc19ddd84b73bd6b254578da2c721e1c08ffc7e9583f1325bdd73acc87511ceec47b3f0e512

data/.github/workflows/ruby.yml

@@ -18,3 +18,17 @@ jobs:
           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

@@ -1,3 +1,19 @@
+## 0.8.0 - 31/08/2020
+ * [FEATURE] Adds aliases option
+
+## 0.7.0 - 20/08/2020
+ * [FEATURE] Adds description option
+
+## 0.6.1 - 11/08/2020
+ * [TECH] Better Error Handling
+
+## 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
 

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,8 +1,9 @@
 PATH
   remote: .
   specs:
-    djin (0.4.0)
+    djin (0.8.0)
       dry-cli (~> 0.6.0)
+      dry-equalizer (~> 0.3.0)
       dry-struct (~> 1.3.0)
       dry-validation (~> 1.5.1)
       mustache (~> 1.1.1)
@@ -13,7 +14,7 @@ GEM
   specs:
     ast (2.4.1)
     byebug (11.1.1)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.3)
     dry-cli (0.6.0)
       concurrent-ruby (~> 1.0)
@@ -29,11 +30,11 @@ GEM
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
     dry-initializer (3.0.3)
-    dry-logic (1.0.6)
+    dry-logic (1.0.7)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-schema (1.5.1)
+    dry-schema (1.5.3)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)
@@ -53,7 +54,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.4)
       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,104 +26,168 @@ 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.4.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:
-  docker-compose:
-    service: app
-    run:
-      commands: rspec
-      options: "--rm"
-
+djin_version: '0.8.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"
+    aliases: # Optional Array of strings
+      - rspec
 ```
 
 You can also set task dependencies with depends_on option:
 
 
 ```yaml
-djin_version: '0.4.0'
+djin_version: '0.8.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.8.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 and custom args in djin.yml run tasks
+## Using Environment variables, custom variables and custom args in djin.yml tasks
 
-You can use environment variables using the '{{YOUR_ENV_HERE}}' syntax, like so:
+You can also use environment variables using the '{{YOUR_ENV_HERE}}' syntax, like so:
 
 ```yaml
-djin_version: '0.4.0'
+djin_version: '0.8.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
+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.8.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, 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.4.0'
+djin_version: '0.8.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
+    aliases:
+      - lint
 
 ```
 
 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/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

@@ -29,10 +29,11 @@ context(branch('master')) {
     git!('add CHANGELOG.md')
 
     file('lib/djin/version.rb').replace(latest_version.to_s, new_version.to_s)
-    git!('add lib/djin/version.rb')
-
+    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 README.md')
+
+    git!('add lib/djin/version.rb djin.yml examples/djin.yml README.md')
 
     sh!('bundle install')
     sh!('rake install')

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,38 +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.6.0"
-  spec.add_dependency "dry-validation", "~> 1.5.1"
-  spec.add_dependency "vseries", "~> 0.1.0"
-  spec.add_dependency "mustache", "~> 1.1.1"
-  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 "rubocop"
-  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