gci 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5054a7bc682bec251963ae83b64a496d7013fdef5506717bc44736c5b570da8
-  data.tar.gz: 46267463380486d6469798c7bb19b0989258b157bc282c1a26c02ff885298426
+  metadata.gz: 070d78a3999dda8cbfa5f3cc9bd4f9e7ab4fd9e9148280dbf3fb697913d87a12
+  data.tar.gz: f226b93f81535cb6e1fb11229262b2d160ba01d25322695f6b5f5cf62bc51cea
 SHA512:
-  metadata.gz: 6cb9a7d1f05bbfa8264961661c76dd5a8116c3ff3a0950706b9c996b373d9d3150d36173fed2b6edc5a1b5689c13b22b5374df11ef8c20506746fe752d7de584
-  data.tar.gz: 28063867afc8274abc325c22b2f5e6da7c6e9fe94173c928eaea8719ffa349378485714402a6b00b46e708bfcc47f009319975503a9b298931272888471944f4
+  metadata.gz: a2b861901ba6d9be1f4c4bee94752b86ba136f656324d0e864703f5921c7810a480afba887c83178358a2e83472a6a45e41d1aaa2ef1fd5190fa998e1156503c
+  data.tar.gz: a17ae50e24fdfef6be219e5562c0a354a6469bfd1de6972f45e9ddf9b379f369a4bb125a94246c24aefeb1c54b8c968686f0828586b29811a16d5c734f65432c

data/.gitlab-ci.rb

@@ -1,9 +1,20 @@
+# frozen_string_literal: true
+
+GCI.root_pipeline do |pipeline|
+  pipeline
+    .jobs["generate-config"]
+    .before_script
+    .unshift("ruby -v")
+end
+
 GCI.pipeline do |pipeline|
   pipeline.image = 'ruby:alpine'
 
   test_job = GCI::Job.new(stage: :test) do |job|
     job.before_script = [
-      'bundle install --path vendor/ruby'
+      'apk add --update git',
+      "bundle config set path 'vendor/ruby'",
+      'bundle install'
     ]
     job.cache = {
       key: { files: ['Gemfile.lock'] },
@@ -11,10 +22,13 @@ GCI.pipeline do |pipeline|
     }
   end
 
-  %w[rspec rubocop].each do |job_name|
+  {
+    rspec: nil,
+    rubocop: '--config .rubocop.yml'
+  }.each do |job_name, options|
     test_job.change do |job|
       job.name = job_name
-      job.script = ["bundle exec #{job_name}"]
+      job.script = ["bundle exec #{job_name} #{options}"]
       pipeline.jobs << job
     end
   end

data/.gitlab-ci.yml

@@ -6,6 +6,7 @@
 generate-config:
   :stage: build
   :before_script:
+  - ruby -v
   - gem install gci
   :script:
   - gci --config .gitlab-ci.rb generate

data/.rubocop.yml

@@ -0,0 +1,24 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  Exclude:
+    - .gitlab-ci.rb
+    - ./vendor/**/*
+
+Style/Documentation:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gci.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gci (0.1.1)
+    gci (0.1.2)
       activesupport (>= 5.0)
 
 GEM

data/README.md

@@ -30,14 +30,135 @@ Or install it yourself as:
 
 ## Usage
 
+To generate a simple pipeline with one job to list all the files from the current directory,
+create a `.gitlab-ci.rb` file with the following content:
+
 ```ruby
-GitLab::Pipeline.new do |pipeline|
-  pipeline.jobs.new(name: 'test', stage: 'test', script: ['ls -lah'])
+GCI.pipeline do |pipeline|
+  pipeline.jobs.build(name: 'list-files') do |job|
+    job.stage = 'test'
+    job.script = ['ls -lah']
+  end
 
   puts pipeline.to_yaml
 end
 ```
 
+to have this up and running you need a simple `.gitlab-ci.yml` config to trigger the [dynamic pipelines](https://docs.gitlab.com/ee/ci/yaml/README.html#trigger-child-pipeline-with-generated-configuration-file):
+
+```yaml
+---
+:stages:
+- build
+- run
+
+:image: ruby:alpine
+
+generate-config:
+  :stage: build
+  :before_script:
+  - gem install gci
+  :script:
+  - gci --config .gitlab-ci.rb generate
+  :artifacts:
+    :paths:
+    - child.gitlab-ci.yml
+
+execute-config:
+  :stage: run
+  :trigger:
+    :include:
+    - :artifact: child.gitlab-ci.yml
+      :job: generate-config
+    :strategy: depend
+```
+
+
+You can run `gci --config .gitlab-ci.rb root` locally to generate it and push it to the repo. You can change any part of it, for example, adding a `ruby -v` command at the beginning of the execution:
+
+```ruby
+GCI.root_pipeline do |pipeline|
+  pipeline
+    .jobs["generate-config"]
+    .before_script
+    .unshift("ruby -v")
+end
+```
+
+
+[`.gitlab-ci.rb`](./.gitlab-ci.rb) shows a more advanced usage. A pipeline with two jobs that have a lot in common:
+
+```ruby
+GCI.pipeline do |pipeline|
+  pipeline.image = 'ruby:alpine'
+
+  test_job = GCI::Job.new(stage: :test) do |job|
+    job.before_script = [
+      'apk add --update git',
+      "bundle config set path 'vendor/ruby'",
+      'bundle install'
+    ]
+    job.cache = {
+      key: { files: ['Gemfile.lock'] },
+      paths: ['vendor/ruby']
+    }
+  end
+
+  {
+    rspec: nil,
+    rubocop: '--config .rubocop.yml'
+  }.each do |job_name, options|
+    test_job.change do |job|
+      job.name = job_name
+      job.script = ["bundle exec #{job_name} #{options}"]
+      pipeline.jobs << job
+    end
+  end
+end
+```
+
+This is how the YAML configuration for the child pipeline looks like:
+
+```yaml
+---
+:stages:
+- build
+- test
+- deploy
+
+:image: ruby:alpine
+
+:rspec:
+  :stage: test
+  :before_script:
+  - apk add --update git
+  - bundle config set path 'vendor/ruby'
+  - bundle install
+  :cache:
+    :key:
+      :files:
+      - Gemfile.lock
+    :paths:
+    - vendor/ruby
+  :script:
+  - 'bundle exec rspec '
+
+:rubocop:
+  :stage: test
+  :before_script:
+  - apk add --update git
+  - bundle config set path 'vendor/ruby'
+  - bundle install
+  :cache:
+    :key:
+      :files:
+      - Gemfile.lock
+    :paths:
+    - vendor/ruby
+  :script:
+  - bundle exec rubocop --config .rubocop.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.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'gci'

data/exe/gci

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-$:.unshift(File.expand_path('../lib', __dir__))
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 require 'optparse'
 require 'gci'

data/gci.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/gci/version'
 
 Gem::Specification.new do |spec|
@@ -7,10 +9,13 @@ Gem::Specification.new do |spec|
   spec.email         = ['marius@mbobin.me']
 
   spec.summary       = 'Write your GitLab pipeline configuration in Ruby!'
-  spec.description   = 'Using dynamic pipelines you can use your favorite programming language to generate YAML files for pipelines.'
+  spec.description   = <<~DESC
+    Using dynamic pipelines you can use your favorite programming \
+    language to generate YAML files for pipelines.
+  DESC
   spec.homepage      = 'https://gitlab.com/mbobin/gci'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage

data/lib/gci.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/all'
 require 'yaml'
 require 'gci/version'
@@ -50,5 +52,8 @@ module GCI
         }
       end
     end
+
+    yield(@root_pipeline) if block_given?
+    @root_pipeline
   end
 end

data/lib/gci/cli.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 module GCI
   class CLI
     COMMANDS = %i[generate root].freeze
 
     def dispatch(command, options)
-      if COMMANDS.include?(command.to_sym)
-        public_send(command, options)
-      else
-        raise Error, "Invalid command '#{command}'"
-      end
+      raise Error, "Invalid command '#{command}'" unless COMMANDS.include?(command.to_sym)
+
+      public_send(command, options)
     end
 
     def generate(options)
@@ -25,11 +25,9 @@ module GCI
     private
 
     def evaluate_user_config(options)
-      if options[:config].present?
-        require(Pathname(options[:config]).expand_path)
-      else
-        raise Error, 'Missing configuration file'
-      end
+      raise Error, 'Missing configuration file' unless options[:config].present?
+
+      require(Pathname(options[:config]).expand_path)
     end
   end
 end

data/lib/gci/job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GCI
   class Job
     class Collection
@@ -23,6 +25,10 @@ module GCI
           acc
         end
       end
+
+      def [](name)
+        @data.detect { |job| job.name == name }
+      end
     end
 
     def self.define_attr_accessors(name)

data/lib/gci/pipeline.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module GCI
   class Pipeline
     attr_reader :jobs
-    attr_accessor :stages, :image, :variables
+    attr_accessor :stages, :image, :variables, :workflow
     attr_writer :gitlab_ci_file
 
     def initialize
@@ -22,6 +24,7 @@ module GCI
       data = {}
       data.merge!(stages: stages.map(&:to_s))
       data.merge!(image: @image) if @image.present?
+      data.merge!(workflow: @workflow) if @workflow.present?
       data.merge!(@jobs.to_h)
       data
     end

data/lib/gci/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GCI
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gci
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Marius Bobin
@@ -24,8 +24,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
-description: Using dynamic pipelines you can use your favorite programming language
+description: 'Using dynamic pipelines you can use your favorite programming language
   to generate YAML files for pipelines.
+
+'
 email:
 - marius@mbobin.me
 executables:
@@ -37,6 +39,7 @@ files:
 - ".gitlab-ci.rb"
 - ".gitlab-ci.yml"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -65,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="