djin 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e763f1dad923699c768e998f4dd5caa53ac7a8b0ad4d7acd84c708effdcb627c
-  data.tar.gz: 9ab841b39557b775ec7832a3c1cd0befaf983e89ba931459b89a52d5a5df0bda
+  metadata.gz: 5e44393cb2f47b9b3a68d2ce59ae997e5e1d6b252e68778293b5e62a7600374b
+  data.tar.gz: 5c02ed7dc956357e31b07c6ade84c5f660cb26469f7434ea0128b42f0ebec74f
 SHA512:
-  metadata.gz: e22bc8b7d3deb635180db1d5c49f1e7d5df1eef3f1b4184b13d65b24eaa45b6f716edfae1bb4799abfe4d4255387958f5f078d931c72cf0b5e407abf9d85ee51
-  data.tar.gz: e603ff5f1bab170ed9758331e7c64e39f1832424fc2c0e069aeef2ce85372081ccc15e1a2080cae3c5edc4c8d8fd1286643e4aaa02616249f7173c6d660ffcf2
+  metadata.gz: 1d8d9dbd993757586e35679c12e1d03b98c940e5bca58e6ab2b3b8955c84c78b2fad6ae2053a0430b85aa580217a8540b3196ab3489c0ae76c4426e712142822
+  data.tar.gz: be25638d743e46c62a452891298003d3dd93905ea38b6bbe51420d44549ba001785f7b9a631cc4e4b83c61ffa541688420df9bd9339023b1cb86747ad2ae87c4

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.10.0 - 08/10/2020
+ * [FEATURE] -f command option
+
 ## 0.9.0 - 17/09/2020
  * [FEATURE] Include Option
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    djin (0.9.0)
+    djin (0.10.0)
       dry-cli (~> 0.6.0)
       dry-equalizer (~> 0.3.0)
       dry-struct (~> 1.3.0)
@@ -29,12 +29,12 @@ GEM
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-initializer (3.0.3)
-    dry-logic (1.0.7)
+    dry-initializer (3.0.4)
+    dry-logic (1.0.8)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-schema (1.5.4)
+    dry-schema (1.5.5)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)

data/README.md

@@ -26,7 +26,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.9.0'
+djin_version: '0.10.0'
 
 tasks:
   # With a docker image
@@ -53,7 +53,7 @@ You can also set task dependencies with depends_on option:
 
 
 ```yaml
-djin_version: '0.9.0'
+djin_version: '0.10.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -82,7 +82,7 @@ tasks:
 Or mix local commands and docker/docker-compose commands:
 
 ```yaml
-djin_version: '0.9.0'
+djin_version: '0.10.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -121,7 +121,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.9.0'
+djin_version: '0.10.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -138,7 +138,7 @@ tasks:
 
 Or define some variables to use in multiple locations
 ```yaml
-djin_version: '0.9.0'
+djin_version: '0.10.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -162,7 +162,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.9.0'
+djin_version: '0.10.0'
 
 _default_run_options: &default_run_options
   options: "--rm"
@@ -188,7 +188,7 @@ Under the hood djin uses [Mustache](https://mustache.github.io/), so you can use
 If you have multiple tasks with similar behaviour and with small differences you can use the `include` keyword, so this:
 
 ```yaml
-djin_version: '0.9.0'
+djin_version: '0.10.0'
 
 tasks:
   "host1:ssh":
@@ -227,7 +227,7 @@ can become this:
 
 ```yaml
 # djin.yml
-djin_version: '0.9.0'
+djin_version: '0.10.0'
 
 include:
   - file: '.djin/server_tasks.yml'
@@ -249,7 +249,7 @@ include:
 
 ```yaml
 # .djin/server_tasks.yml
-djin_version: '0.9.0'
+djin_version: '0.10.0'
 
 tasks:
   "{{namespace}}:ssh":
@@ -268,15 +268,37 @@ tasks:
         - ssh -t {{ssh_user}}@{{host}} tail -f /var/log/my_log
   ```
 
+### Loading custom files
+
+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
+djin -f my_file.yml build # Execute the build task defined in my_file.yml
+```
+
+You can also specify multiple files to join tasks between files:
+
+```bash
+# Mix the tasks
+djin -f my_file.yml -f my_file2.yml # Returns the help for all tasks in my_file
+djin -f my_file.yml -f my_file2.yml build # Execute the build task defined in my_file.yml or my_file2.yml
+```
+
+
 ## 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, 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. Adds a `-f` option to load custom djin files
+## TODO
+
+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)
 
 ## Contributing
 

data/Vertofile

@@ -28,12 +28,15 @@ context(branch('master')) {
     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)
+    files_to_change_version_once = %w[lib/djin/version.rb djin.yml] + Dir['examples/**/*.yml'] + Dir['spec/support/fixtures/**/*.yml']
+
+    files_to_change_version_once.each do |filename|
+      file(filename).replace(latest_version.to_s, new_version.to_s)
+    end
+
     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')
+    git!("add #{files_to_change_version_once.join(' ')} README.md")
 
     sh!('bundle install')
     sh!('rake install')

data/djin.yml

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

data/examples/djin.yml

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

data/examples/djin_lib/test.yml

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

data/examples/local_tasks/djin.yml

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

data/lib/djin.rb

@@ -8,7 +8,9 @@ require 'dry-validation'
 require 'vseries'
 require 'dry/cli'
 require 'mustache'
+require 'optparse'
 require 'djin/extensions/hash_extensions'
+require 'djin/extensions/object_extensions'
 require 'djin/entities/types'
 require 'djin/entities/task'
 require 'djin/entities/file_config'
@@ -19,6 +21,7 @@ require 'djin/interpreter/local_command_builder'
 require 'djin/interpreter'
 require 'djin/config_loader'
 require 'djin/executor'
+require 'djin/root_cli_parser'
 require 'djin/cli'
 require 'djin/task_contract'
 require 'djin/repositories/task_repository'
@@ -27,10 +30,12 @@ require 'djin/memory_cache'
 module Djin
   class Error < StandardError; end
 
-  def self.load_tasks!(file_path = Pathname.getwd.join('djin.yml'))
-    abort 'Error: djin.yml not found' unless file_path.exist?
+  using Djin::ObjectExtensions
 
-    file_config = ConfigLoader.load!(file_path)
+  def self.load_tasks!(*file_paths)
+    files = file_paths.presence || RootCliParser.parse![:files] || ['djin.yml']
+
+    file_config = ConfigLoader.load_files!(*files)
 
     # TODO: Make all tasks be under 'tasks' key, passing only the tasks here
     tasks = Interpreter.load!(file_config)

data/lib/djin/cli.rb

@@ -28,6 +28,16 @@ module Djin
       end
     end
 
+    class File < Dry::CLI::Command
+      desc 'Specify a djin file to load (default: djin.yml)'
+      argument :filepath, required: true, desc: 'The file path to load'
+
+      def call(filename:, **)
+        # The actual behaviour is on RootCliParser
+      end
+    end
+
+    register '-f', File, aliases: ['--file']
     register '--version', Version, aliases: ['-v']
   end
 end

data/lib/djin/config_loader.rb

@@ -8,13 +8,26 @@ module Djin
     using Djin::HashExtensions
     RESERVED_WORDS = %w[djin_version variables tasks include].freeze
 
-    def self.load!(template_file, runtime_config: {})
-      new(template_file, runtime_config: runtime_config).load!
+    # CHange Base Error
+    FileNotFoundError = Class.new(Interpreter::InvalidConfigurationError)
+
+    def self.load_files!(*files, runtime_config: {}, base_directory: '.')
+      files.map do |file_path|
+        ConfigLoader.load!(file_path, runtime_config: runtime_config, base_directory: base_directory)
+      end&.reduce(:deep_merge)
+    end
+
+    def self.load!(template_file_path, runtime_config: {}, base_directory: '.')
+      new(template_file_path, runtime_config: runtime_config, base_directory: base_directory).load!
     end
 
-    def initialize(template_file, runtime_config: {})
-      @template_file = template_file
-      @template_file_content = Djin.cache.fetch(template_file.realpath.to_s) { template_file.read }
+    def initialize(template_file_path, runtime_config: {}, base_directory: '.')
+      @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?
+
+      @template_file_content = Djin.cache.fetch(@template_file.realpath.to_s) { @template_file.read }
       @runtime_config = runtime_config
     end
 
@@ -83,12 +96,9 @@ module Djin
 
     def included_config
       @included_config ||= raw_djin_config['include']&.map do |tasks_reference|
-        external_config_file = Pathname.new(tasks_reference['file'])
-
-        ConfigLoader.load!(external_config_file, runtime_config: tasks_reference['context'] || {})
+        ConfigLoader.load!(tasks_reference['file'], base_directory: @template_file.dirname,
+                                                    runtime_config: tasks_reference['context'] || {})
       end&.reduce(:deep_merge)
-    rescue Errno::ENOENT => e
-      raise Interpreter::InvalidConfigFileError, e.message
     end
 
     def args

data/lib/djin/extensions/object_extensions.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Djin
+  module ObjectExtensions
+    refine Object do
+      def presence(default = nil)
+        present? ? self : default
+      end
+
+      def present?
+        !blank?
+      end
+
+      def blank?
+        return true unless self
+
+        # TODO: Improve Validations
+        return empty? if respond_to?(:empty?)
+
+        false
+      end
+    end
+  end
+end

data/lib/djin/root_cli_parser.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Djin
+  ## This class is responsible to handle options that must be evaluated
+  #  before the load of tasks in djin file(eg: djin.yml)
+  class RootCliParser
+    class << self
+      def parse!(args = ARGV)
+        options = {}
+
+        # TODO: Find a better way to handle -f/--file option,
+        #       throw, catch and delete in ARGV are necessary
+        #       to only remove the -f/--file option
+        #       and bypass everything else to Dry::CLI
+        catch(:root_cli_exit) do
+          OptionParser.new do |opts|
+            opts.on('-f FILE', '--file FILE') do |v|
+              options[:files] ||= []
+              options[:files] << v
+            end
+
+            opts.on('-h', '--help') do
+              throw :root_cli_exit
+            end
+          end.parse(args)
+        end
+
+        remove_file_args!(args)
+        options
+      end
+
+      def remove_file_args!(args)
+        file_option = ['-f', '--file']
+        args_indexes_to_remove = args.each_with_index.map do |value, index|
+          index if (file_option.include?(args[index - 1]) && index.positive?) || file_option.include?(value)
+        end.compact
+
+        args_indexes_to_remove.reverse.each { |index| args.delete_at(index) }
+      end
+    end
+  end
+end

data/lib/djin/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: djin
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Carlos Atkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -204,6 +204,7 @@ files:
 - lib/djin/entities/types.rb
 - lib/djin/executor.rb
 - lib/djin/extensions/hash_extensions.rb
+- lib/djin/extensions/object_extensions.rb
 - lib/djin/interpreter.rb
 - lib/djin/interpreter/base_command_builder.rb
 - lib/djin/interpreter/docker_command_builder.rb
@@ -211,6 +212,7 @@ files:
 - lib/djin/interpreter/local_command_builder.rb
 - lib/djin/memory_cache.rb
 - lib/djin/repositories/task_repository.rb
+- lib/djin/root_cli_parser.rb
 - lib/djin/task_contract.rb
 - lib/djin/version.rb
 homepage: https://github.com/catks/djin