djin 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b1c6e4a65fd3d45dda2ccea34bafb2a33e927d59b25d273486152968629956d
-  data.tar.gz: 7d5bac09875862642943dcf43bdfb61e9874203b6264c16aceeb918669fd4939
+  metadata.gz: 8941dba802fcd1d42ea6f6e52639928f8311b4f5379470a38082f3474985a3fb
+  data.tar.gz: 818fe3e599d48da784364fe96e8a9c413def53a4268adf44f3760d43235a2398
 SHA512:
-  metadata.gz: 0ab09434fc83b94f14a2f2eed6bc23cbb1319a36083e9d110621e71b540953294e62eca5d59d7d4daa667066bd713d20595079c742aa8fe60d41d709e1f9323b
-  data.tar.gz: 85628587736a959d29946c56ffea2e9379bd9184a0f6b9ad939967630d8a71b3004c276a203086bf3b510bfe11902c9c24d3ad279569044686af750a0ec17577
+  metadata.gz: 259f4f7a133336dd41286ecc43a0b7c4e91de62eb51fea4de258b7b934abd54bb7628e12707668b37acea748d32b3bea04c148a13e3c167669de45430b4ead23
+  data.tar.gz: 10f7bb94540315c5f72fc4fdddeb4bae8221c61d7e87dc3a346937bf354105ae6bc9d534f04d6347f44cab5f9862777a3a65ccf9340c5d1320ab2fb4c420a2b8

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+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

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    djin (0.1.1)
+    djin (0.2.0)
       dry-cli (~> 0.5.0)
       dry-struct (~> 1.3.0)
       dry-validation (~> 1.5.0)
+      vseries (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,7 +15,7 @@ GEM
     diff-lcs (1.3)
     dry-cli (0.5.1)
       concurrent-ruby (~> 1.0)
-    dry-configurable (0.11.3)
+    dry-configurable (0.11.5)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
       dry-equalizer (~> 0.2)
@@ -58,7 +59,7 @@ GEM
       dry-initializer (~> 3.0)
       dry-schema (~> 1.5)
     ice_nine (0.11.2)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -72,6 +73,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
+    vseries (0.1.0)
 
 PLATFORMS
   ruby
@@ -80,7 +82,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   byebug
   djin!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH

data/README.md

@@ -1,16 +1,32 @@
 # Djin
 
+![](https://github.com/catks/djin/workflows/Ruby/badge.svg?branch=master)
+
+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
+djin_version: '0.2.0'
+
 # With a docker image
 script:
   docker:
@@ -30,6 +46,36 @@ test:
 
 ```
 
+You can also set task dependencies with depends_on option:
+
+
+```yaml
+djin_version: '0.2.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"
+
+```
+
 After that you can run `djin {{task_name}}`, like `djin script` or `djin test`
 
 ## Development
@@ -40,8 +86,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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/djin.gemspec

@@ -28,8 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-struct", "~> 1.3.0"
   spec.add_dependency "dry-cli", "~> 0.5.0"
   spec.add_dependency "dry-validation", "~> 1.5.0"
+  spec.add_dependency "vseries", "~> 0.1.0"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug"
 end

data/djin.yml

@@ -1,13 +1,18 @@
+djin_version: '0.2.0'
+
+_default_run_options: &default_run_options
+  options: "--rm --entrypoint=''"
+
 test:
   docker-compose:
     service: app
     run:
       commands: "cd /usr/src/djin && rspec"
-      options: "--rm --entrypoint=''"
+      <<: *default_run_options
+
 sh:
   docker-compose:
     service: app
     run:
       commands: "sh"
-      options: "--rm --entrypoint=''"
-
+      <<: *default_run_options

data/lib/djin/entities/task.rb

@@ -3,7 +3,8 @@ module Djin
     attribute :name, Types::String
     attribute :description, Types::String.optional.default(nil)
     attribute :build_command, Types::String.optional.default(nil)
-    attribute :command, Types::String
+    attribute :command, Types::String.optional.default(nil)
+    attribute :depends_on, Types::Array.of(Types::String).optional.default([].freeze)
 
     def ==(other)
       name == other.name &&

data/lib/djin/executor.rb

@@ -1,16 +1,28 @@
 module Djin
   class Executor
-   def call(*tasks)
-     tasks.each do |task|
-       run task.build_command if task.build_command
-       run task.command
-     end
-   end
+    def initialize(task_repository: Djin.task_repository)
+      @task_repository = task_repository
+    end
 
-   private
+    def call(*tasks)
+      tasks.each do |task|
+        run_task(task)
+      end
+    end
 
-   def run(command)
-     system command
-   end
+    private
+
+    def run_task(task)
+      @task_repository.find_by_names(task.depends_on).each do |dependent_task|
+        run_task dependent_task
+      end
+
+      run task.build_command if task.build_command
+      run task.command if task.command
+    end
+
+    def run(command)
+      system command
+    end
   end
 end

data/lib/djin/interpreter.rb

@@ -2,22 +2,37 @@ module Djin
   class Interpreter
     using Djin::HashExtensions
 
-    RESERVED_WORDS = %w[_version _default_options].freeze
+    RESERVED_WORDS = %w[djin_version _default_options].freeze
 
-    InvalidSyntax = Class.new(StandardError)
+    InvalidConfigurationError = Class.new(StandardError)
+    MissingVersionError = Class.new(InvalidConfigurationError)
+    VersionNotSupportedError = Class.new(InvalidConfigurationError)
+    InvalidSyntaxError = Class.new(InvalidConfigurationError)
 
     class << self
       def load!(params)
-        task_params = params.except(*RESERVED_WORDS)
+        version = params['djin_version']
+        raise MissingVersionError, 'Missing djin_version' unless version
+        raise VersionNotSupportedError, "Version #{version} is not supported, use #{Djin::VERSION} or higher" unless version_supported?(version)
+
+        tasks_params = params.except(*RESERVED_WORDS).reject { |task| task.start_with?('_') }
         contract = TaskContract.new
 
-        task_params.map do |task_name, options|
+        tasks_params.map do |task_name, options|
           result = contract.call(options)
 
-          raise InvalidSyntax, result.errors.to_h if result.failure?
+          raise InvalidSyntaxError, result.errors.to_h if result.failure?
 
           command, build_command = build_commands(options, task_name: task_name)
-          Djin::Task.new(name: task_name, build_command: build_command, command: command)
+
+          task_params = {
+            name: task_name,
+            build_command: build_command,
+            command: command,
+            depends_on: options['depends_on']
+          }.compact
+
+          Djin::Task.new(**task_params)
         end
       end
 
@@ -76,6 +91,14 @@ module Djin
 
         [run_command, run_options]
       end
+
+      def validate_version!(version)
+
+      end
+
+      def version_supported?(version)
+        Vseries::SemanticVersion.new(Djin::VERSION) >= Vseries::SemanticVersion.new(version)
+      end
     end
   end
 end

data/lib/djin/repositories/task_repository.rb

@@ -0,0 +1,17 @@
+class TaskRepository
+  def initialize(tasks = [])
+    @tasks = tasks
+  end
+
+  def add(*tasks)
+    @tasks += tasks
+  end
+
+  def all
+    @tasks
+  end
+
+  def find_by_names(names)
+    @tasks.select { |task| names.include?(task.name) }
+  end
+end

data/lib/djin/task_contract.rb

@@ -32,14 +32,16 @@ module Djin
       optional(:"docker-compose").filled do
         hash(DockerComposeSchema)
       end
+
+      optional(:depends_on).each(:str?)
     end
 
-    rule(:docker, :"docker-compose") do
-      key.failure('docker or docker-compose key is required') unless values[:docker] || values[:"docker-compose"]
+    rule(:docker, :"docker-compose", :depends_on) do
+      key.failure('docker, docker-compose or depends_on key is required') unless values[:docker] || values[:"docker-compose"] || values[:depends_on]
     end
 
-    rule(:'docker-compose',docker: [:image, :build])  do
-      key.failure('image or build param is required for docker tasks') unless values.dig(:docker, :image) || values.dig(:docker, :build) || values[:'docker-compose']
+    rule(:depends_on, :'docker-compose',docker: [:image, :build])  do
+      key.failure('image or build param is required for docker tasks') unless values.dig(:docker, :image) || values.dig(:docker, :build) || values[:'docker-compose'] || values[:depends_on]
     end
 
     rule(docker: :build) do

data/lib/djin/version.rb

@@ -1,3 +1,3 @@
 module Djin
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/djin.rb

@@ -3,6 +3,7 @@ require "pathname"
 require "yaml"
 require "dry-struct"
 require "dry-validation"
+require "vseries"
 require "dry/cli"
 require "djin/extensions/hash_extensions"
 require "djin/extensions/custom_predicates"
@@ -12,6 +13,7 @@ require "djin/interpreter"
 require "djin/executor"
 require "djin/cli"
 require "djin/task_contract"
+require "djin/repositories/task_repository"
 
 module Djin
   class Error < StandardError; end
@@ -20,17 +22,22 @@ module Djin
   def self.load_tasks!(path = Pathname.getwd.join('djin.yml'))
     abort 'Error: djin.yml not found' unless path.exist?
 
-    djin_file = YAML.load(path.read)
-    @tasks = Djin::Interpreter.load!(djin_file)
+    djin_file = YAML.safe_load(path.read, [], [], true)
+    tasks = Djin::Interpreter.load!(djin_file)
 
-    CLI.load_tasks!(@tasks)
+    @task_repository = TaskRepository.new(tasks)
+    CLI.load_tasks!(tasks)
 
-  rescue Djin::Interpreter::InvalidSyntax => ex
+  rescue Djin::Interpreter::InvalidConfigurationError => ex
     abort(ex.message)
   end
 
   def self.tasks
-    @tasks || []
+    task_repository.all
+  end
+
+  def self.task_repository
+    @task_repository ||= TaskRepository.new
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: djin
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Carlos Atkinson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: vseries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +130,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -140,6 +155,7 @@ files:
 - lib/djin/extensions/custom_predicates.rb
 - lib/djin/extensions/hash_extensions.rb
 - lib/djin/interpreter.rb
+- lib/djin/repositories/task_repository.rb
 - lib/djin/task_contract.rb
 - lib/djin/version.rb
 homepage: https://github.com/catks/djin