gci 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5054a7bc682bec251963ae83b64a496d7013fdef5506717bc44736c5b570da8
+  data.tar.gz: 46267463380486d6469798c7bb19b0989258b157bc282c1a26c02ff885298426
+SHA512:
+  metadata.gz: 6cb9a7d1f05bbfa8264961661c76dd5a8116c3ff3a0950706b9c996b373d9d3150d36173fed2b6edc5a1b5689c13b22b5374df11ef8c20506746fe752d7de584
+  data.tar.gz: 28063867afc8274abc325c22b2f5e6da7c6e9fe94173c928eaea8719ffa349378485714402a6b00b46e708bfcc47f009319975503a9b298931272888471944f4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/child.gitlab-ci.yml

data/.gitlab-ci.rb

@@ -0,0 +1,23 @@
+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'
+    ]
+    job.cache = {
+      key: { files: ['Gemfile.lock'] },
+      paths: ['vendor/ruby']
+    }
+  end
+
+  %w[rspec rubocop].each do |job_name|
+    test_job.change do |job|
+      job.name = job_name
+      job.script = ["bundle exec #{job_name}"]
+      pipeline.jobs << job
+    end
+  end
+
+  puts pipeline.to_yaml
+end

data/.gitlab-ci.yml

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gci.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.2'

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    gci (0.1.1)
+      activesupport (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.2.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.0.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gci!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Marius Bobin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Write your GitLab pipeline configuration in Ruby!
+
+This gem uses [dynamic child pipelines](https://docs.gitlab.com/ee/ci/parent_child_pipelines.html#dynamic-child-pipelines)
+
+## Why would you use this over plain YAML?
+
+- Easy to reuse structures
+- Easy to read complex pipelines
+- More powerful control flow
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gci'
+```
+
+And then execute:
+
+```
+    $ bundle install
+```
+
+Or install it yourself as:
+
+```
+    $ gem install gci
+```
+
+## Usage
+
+```ruby
+GitLab::Pipeline.new do |pipeline|
+  pipeline.jobs.new(name: 'test', stage: 'test', script: ['ls -lah'])
+
+  puts pipeline.to_yaml
+end
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/mbobin/gci.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'gci'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gci

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path('../lib', __dir__))
+
+require 'optparse'
+require 'gci'
+
+begin
+  options = {}
+
+  subtext = <<~HELP
+    Commonly used command are:
+       generate :     Generate child pipeline configuration
+       root     :     Generate root pipeline configuration
+  HELP
+
+  global = OptionParser.new do |opts|
+    opts.version = GCI::VERSION
+    opts.banner = 'Usage: [options] [subcommand]'
+    opts.on('-c', '--config PATH', 'The path to the pipeline configuration') do |config|
+      options[:config] = config
+    end
+
+    opts.separator ''
+    opts.separator subtext
+  end
+
+  global.parse!
+
+  subcommands = {
+    'generate' => OptionParser.new do |opts|
+      opts.banner = 'Usage: -c path/to/config generate'
+    end,
+    'root' => OptionParser.new do |opts|
+      opts.banner = 'Usage: -c path/to/config root'
+    end
+  }
+
+  global.order!
+  command = ARGV.shift
+  subcommands[command].order!
+  GCI::CLI.new.dispatch(command, options)
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument, LoadError, GCI::Error => e
+  warn "Error: #{e.message}"
+  exit 1
+end

data/gci.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/gci/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gci'
+  spec.version       = GCI::VERSION
+  spec.authors       = ['Marius Bobin']
+  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.homepage      = 'https://gitlab.com/mbobin/gci'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 5.0'
+end

data/lib/gci.rb

@@ -0,0 +1,54 @@
+require 'active_support/all'
+require 'yaml'
+require 'gci/version'
+require 'gci/cli'
+require 'gci/job'
+require 'gci/pipeline'
+
+module GCI
+  class Error < StandardError; end
+
+  def self.pipeline(&block)
+    if @pipeline
+      yield(@pipeline) if block_given?
+    else
+      @pipeline = Pipeline.new(&block)
+    end
+
+    @pipeline
+  end
+
+  def self.root_pipeline
+    @root_pipeline ||= Pipeline.new do |pipeline|
+      pipeline.gitlab_ci_file = '.gitlab-ci.yml'
+      pipeline.image = 'ruby:alpine'
+      pipeline.stages = %i[build run]
+
+      pipeline.jobs.build(name: 'generate-config') do |job|
+        job.stage = :build
+        job.before_script = [
+          'gem install gci'
+        ]
+
+        job.script = [
+          'gci --config .gitlab-ci.rb generate'
+        ]
+
+        job.artifacts = {
+          paths: ['child.gitlab-ci.yml']
+        }
+      end
+
+      pipeline.jobs.build(name: 'execute-config') do |job|
+        job.stage = :run
+        job.trigger = {
+          include: [
+            artifact: 'child.gitlab-ci.yml',
+            job: 'generate-config'
+          ],
+          strategy: 'depend'
+        }
+      end
+    end
+  end
+end

data/lib/gci/cli.rb

@@ -0,0 +1,35 @@
+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
+    end
+
+    def generate(options)
+      evaluate_user_config(options)
+
+      GCI.pipeline.write
+    end
+
+    def root(options)
+      evaluate_user_config(options)
+
+      GCI.root_pipeline.write
+    end
+
+    private
+
+    def evaluate_user_config(options)
+      if options[:config].present?
+        require(Pathname(options[:config]).expand_path)
+      else
+        raise Error, 'Missing configuration file'
+      end
+    end
+  end
+end

data/lib/gci/job.rb

@@ -0,0 +1,91 @@
+module GCI
+  class Job
+    class Collection
+      def initialize
+        @data = []
+      end
+
+      def build(**attrs, &block)
+        job = Job.new(**attrs, &block)
+        @data << job
+        job
+      end
+
+      def <<(job)
+        @data << job
+
+        self
+      end
+
+      def to_h
+        @data.each_with_object({}) do |job, acc|
+          acc.merge!(job.name => job.attributes)
+          acc
+        end
+      end
+    end
+
+    def self.define_attr_accessors(name)
+      define_method("#{name}=") do |value|
+        @attrs[name] = value
+      end
+
+      define_method(name) do
+        @attrs[name]
+      end
+    end
+
+    define_attr_accessors :name
+    define_attr_accessors :script
+    define_attr_accessors :after_script
+    define_attr_accessors :allow_failure
+    define_attr_accessors :artifacts
+    define_attr_accessors :before_script
+    define_attr_accessors :cache
+    define_attr_accessors :coverage
+    define_attr_accessors :dependencies
+    define_attr_accessors :environment
+    define_attr_accessors :except
+    define_attr_accessors :extends
+    define_attr_accessors :image
+    define_attr_accessors :include
+    define_attr_accessors :interruptible
+    define_attr_accessors :only
+    define_attr_accessors :pages
+    define_attr_accessors :parallel
+    define_attr_accessors :release
+    define_attr_accessors :resource_group
+    define_attr_accessors :retry
+    define_attr_accessors :rules
+    define_attr_accessors :services
+    define_attr_accessors :stage
+    define_attr_accessors :tags
+    define_attr_accessors :timeout
+    define_attr_accessors :trigger
+    define_attr_accessors :variables
+    define_attr_accessors :when
+
+    def initialize(**attrs)
+      @attrs = attrs
+      yield(self) if block_given?
+    end
+
+    def stage=(value)
+      @attrs[:stage] = value.to_s
+    end
+
+    def change(&block)
+      self.class.new(**@attrs.deep_dup, &block)
+    end
+
+    def to_h
+      data = @attrs
+      data[:stage] = data[:stage].to_s if data[:stage]
+      data
+    end
+
+    def attributes
+      to_h.except(:name)
+    end
+  end
+end

data/lib/gci/pipeline.rb

@@ -0,0 +1,33 @@
+module GCI
+  class Pipeline
+    attr_reader :jobs
+    attr_accessor :stages, :image, :variables
+    attr_writer :gitlab_ci_file
+
+    def initialize
+      @jobs = Job::Collection.new
+      @stages = %i[build test deploy]
+      @gitlab_ci_file = 'child.gitlab-ci.yml'
+
+      yield(self) if block_given?
+    end
+
+    def write
+      File.open(@gitlab_ci_file, 'wb') do |file|
+        file.write(to_yaml)
+      end
+    end
+
+    def to_h
+      data = {}
+      data.merge!(stages: stages.map(&:to_s))
+      data.merge!(image: @image) if @image.present?
+      data.merge!(@jobs.to_h)
+      data
+    end
+
+    def to_yaml
+      to_h.to_yaml
+    end
+  end
+end

data/lib/gci/version.rb

@@ -0,0 +1,3 @@
+module GCI
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: gci
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Marius Bobin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Using dynamic pipelines you can use your favorite programming language
+  to generate YAML files for pipelines.
+email:
+- marius@mbobin.me
+executables:
+- gci
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.rb"
+- ".gitlab-ci.yml"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gci
+- gci.gemspec
+- lib/gci.rb
+- lib/gci/cli.rb
+- lib/gci/job.rb
+- lib/gci/pipeline.rb
+- lib/gci/version.rb
+homepage: https://gitlab.com/mbobin/gci
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/mbobin/gci
+  source_code_uri: https://gitlab.com/mbobin/gci
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Write your GitLab pipeline configuration in Ruby!
+test_files: []