side_boom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80ded80fc1fad3ad923d90ea39e238d698593c5c
+  data.tar.gz: c3a1351dc07f9aecba775116d11356a402c62650
+SHA512:
+  metadata.gz: 452b7b2bdb715808e55a8ac33a372998e44c114087762697c3eabd2eeae9fcebe6348834e751e34dc4e4c59f8f45247548421ef2793b787dcfe9b7ff813e8ee1
+  data.tar.gz: b20dcb5a05a304845ffea26c2b2e585c8ae155dea1989aba38a7fe9060838ec3ed76891d29cdb787ebf10a2cd138e8f4fb1f9a3b88bbe09480b43a2a4b397ed4

data/.gitattributes

@@ -0,0 +1,2 @@
+*.sideboom linguist-language=Ruby
+.sideboom gitlab-language=Ruby

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,33 @@
+# Generated by SideBoom
+---
+stages:
+- test
+rspec ruby 2.3:
+  before_script:
+  - bundle install -j 4
+  script:
+  - bundle exec rspec
+  image: ruby:2.3
+  stage: test
+rspec ruby 2.4:
+  before_script:
+  - bundle install -j 4
+  script:
+  - bundle exec rspec
+  image: ruby:2.4
+  stage: test
+rspec ruby 2.5:
+  before_script:
+  - bundle install -j 4
+  script:
+  - bundle exec rspec
+  image: ruby:2.5
+  stage: test
+rspec ruby rc:
+  before_script:
+  - bundle install -j 4
+  script:
+  - bundle exec rspec
+  image: ruby:rc
+  allow_failure: true
+  stage: test

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.sideboom

@@ -0,0 +1,17 @@
+# vim: autoindent tabstop=2 shiftwidth=2 expandtab softtabstop=2 filetype=ruby
+SideBoom::Pipeline.define('.gitlab-ci.yml') do
+  RUBY_VERSIONS = %w[2.3 2.4 2.5 rc]
+
+  before_script 'bundle install -j 4'
+  script 'bundle exec rspec'
+
+  stage 'test' do
+    RUBY_VERSIONS.each do |version|
+      job "rspec ruby #{version}" do
+        image "ruby:#{version}"
+
+        allow_failure! if version == 'rc'
+      end
+    end
+  end
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in side_boom.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    side_boom (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  side_boom!
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Zeger-Jan van de Weg
+
+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,70 @@
+# SideBoom
+
+Creating and maintaining your projects CI/CD specifications with a programming
+language instead of a markup language.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'side_boom'
+```
+
+And then execute:
+
+```shell
+$ bundle exec sideboom
+```
+
+## Usage
+
+Examples are found in the [Examples directory](./examples), and as new features
+become available these will be expanded. But just to show:
+
+```ruby
+# Save this to .sideboom
+# Generate output with `sideboom`
+SideBoom::Pipeline.define('.gitlab-ci.yml') do
+  RUBY_VERSIONS = %w[2.3 2.4 2.5 rc]
+
+  before_script ['bundle -j 4']
+  script ['bundle exec rspec']
+
+  stage 'test' do
+    RUBY_VERSIONS.each do |version|
+      job "rspec ruby #{version}" do
+        image "ruby:#{version}"
+
+        allow_failure! if version == 'rc'
+      end
+    end
+  end
+end
+```
+
+```yaml
+# Generated by SideBoom
+---
+stages:
+- test
+rspec ruby 2.3:
+  image: ruby:2.3
+  stage: test
+rspec ruby 2.4:
+  image: ruby:2.4
+  stage: test
+rspec ruby 2.5:
+  image: ruby:2.5
+  stage: test
+rspec ruby rc:
+  image: ruby:rc
+  allow_failure: true
+  stage: test
+```
+
+### TODO
+- [ ] Better documentation, now is just an example
+- [ ] Support for caching
+- [ ] Support for artifacts
+- [ ] Support advanced features, like services and dependencies

data/bin/sideboom

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+begin
+  require 'side_boom'
+rescue LoadError
+  require_relative '../lib/side_boom'
+end
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: sideboom [options]'
+
+  opts.on('-fNAME', '--file NAME', 'File to interpret') do |path|
+    options[:file] = path
+  end
+end.parse!
+
+options[:file] ||= '.sideboom'
+
+eval File.read(options[:file])

data/examples/simple.out

@@ -0,0 +1,37 @@
+# Generated by SideBoom
+---
+stages:
+- test
+Ruby 2.3:
+  before_script:
+  - bundle install -j 4
+  script:
+  - rspec
+  - rubocop
+  image: ruby:2.3
+  stage: test
+Ruby 2.4:
+  before_script:
+  - bundle install -j 4
+  script:
+  - rspec
+  - rubocop
+  image: ruby:2.4
+  stage: test
+Ruby 2.5:
+  before_script:
+  - bundle install -j 4
+  script:
+  - rspec
+  - rubocop
+  image: ruby:2.5
+  stage: test
+Ruby rc:
+  before_script:
+  - bundle install -j 4
+  script:
+  - rspec
+  - rubocop
+  image: ruby:rc
+  allow_failure: true
+  stage: test

data/examples/simple.sideboom

@@ -0,0 +1,38 @@
+# vim: autoindent tabstop=2 shiftwidth=2 expandtab softtabstop=2 filetype=ruby
+
+# Pipeline.define takes an optional argument, the sink. If this is a string,
+# the output YAML will be written to that path. If no sink is passed, the output
+# will be written to STDOUT
+SideBoom::Pipeline.define do
+  VERSIONS = %w[2.3 2.4 2.5 rc]
+
+  # This before_script is a single line, thus a string can be passed.
+  # If multiple commands should be in the before script, an Array should be passed
+  # where each member responds to #to_s
+  # This before_script will be used by all jobs, unless their stage, or they
+  # themselfs define another before_script.
+  before_script 'bundle install -j 4'
+
+  # This defines the first stage of the pipeline, and thus the stage that will
+  # be executed first. 'test' is the name for this stage.
+  stage 'test' do
+    # Like the before_script explain earlier, but now passing an Array of Strings.
+    script ["rspec", "rubocop"]
+
+    # This just leverages Ruby, this is not SideBoom specific
+    VERSIONS.each do |v|
+      # In a loop, generate jobs in the current stage.
+      # Each of these jobs inherrits the before_script from the pipeline and the
+      # script from the stage as the job itself doesn't define any.
+      job "Ruby #{v}" do
+        # This is the main difference between each job, the image attribute
+        # If the stage, or the pipeline defined an image, these would not be used.
+        image "ruby:#{v}"
+
+        # Again, leveraging Ruby to either set this job as an allowed failure,
+        # or in most cases, don't let it fail.
+        allow_failure! if v == 'rc'
+      end
+    end
+  end
+end

data/lib/side_boom.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'yaml'
+
+Dir[File.join(__dir__, 'side_boom', '*.rb')].sort.each { |file| require file }
+
+module SideBoom
+  VERSION = '0.1.0'.freeze
+end

data/lib/side_boom/attributes.rb

@@ -0,0 +1,50 @@
+module SideBoom
+  ## Attributes define the methods that can be set on both Pipeline, Stage, and
+  # Job level. Attributes set at pipeline level can be overriden at either stage-
+  # or job-level. Stage level attributes can be overriden by any of its jobs.
+  module Attributes
+    class << self
+      def boolean_attribute(*attrs)
+        attrs.each do |attr|
+          define_method("#{attr}!") do
+            @attributes[attr.to_s] = true
+          end
+
+          define_method("dis#{attr}!") do
+            @attributes[attr.to_s] = false
+          end
+
+          define_method(attr) do |arg|
+            @attributes[attr.to_s] = !!arg
+          end
+        end
+      end
+
+      def string_attribute(*attrs)
+        attrs.each do |attr|
+          define_method(attr) do |arg|
+            attributes[attr.to_s] = arg.to_s
+          end
+        end
+      end
+
+      def array_attribute(*attrs)
+        attrs.each do |attr|
+          define_method(attr) do |args|
+            args = [args] if args.is_a?(String)
+
+            attributes[attr.to_s] = args.map(&:to_s)
+          end
+        end
+      end
+    end
+
+    boolean_attribute :allow_failure
+    string_attribute :coverage, :image
+    array_attribute :script, :before_script, :after_script
+
+    def attributes
+      @attributes ||= {}
+    end
+  end
+end

data/lib/side_boom/context.rb

@@ -0,0 +1,41 @@
+module SideBoom
+  # To keep the context during defining the pipeline, allowing for RSpec like
+  # definitions, without explicitly linking a job to a stage. Example:
+  #
+  # SideBoom::Pipeline.define '.gitlab-ci.yml' do
+  #   stage 'compile' do
+  #     job 'golang 1.9' do
+  #       # specifications here
+  #     end
+  #   end
+  # end
+  class Context
+    @stack = []
+
+    class << self
+      def push(context)
+        @stack.push(context)
+      end
+
+      def pop
+        @stack.pop
+      end
+
+      def peek
+        @stack.last
+      end
+
+      def clear
+        @stack = []
+      end
+
+      def in(context)
+        push(context)
+        val = yield peek
+        pop
+
+        val
+      end
+    end
+  end
+end

data/lib/side_boom/job.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SideBoom
+  class Job
+    include SideBoom::Attributes
+
+    attr_reader :name, :stage
+
+    def initialize(name)
+      @name = name
+      @stage = SideBoom::Context.peek
+    end
+
+    def to_hash
+      attrs = stage.merged_attributes.merge(attributes)
+      attrs['stage'] = stage.name
+
+      duplicated_values(attrs)
+    end
+
+    private
+
+    # Avoid YAML to use inherritence, so output remains readable
+    def duplicated_values(dup_hash)
+      dup_hash.each_with_object({}) do |(key, value), hash|
+        hash[key] = begin
+                      value.dup
+                    rescue TypeError # The unduppables
+                      value
+                    end
+      end
+    end
+  end
+end

data/lib/side_boom/pipeline.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SideBoom
+  class Pipeline
+    include SideBoom::Attributes
+
+    class << self
+      def define(sink = $stdout, &block)
+        sink = File.open(sink, 'w+') if sink.is_a?(String)
+
+        SideBoom::Context.in(self) do
+          pipeline = new(sink)
+          pipeline.instance_eval(&block)
+          pipeline.write!
+        end
+      end
+    end
+
+    attr_reader :stages, :sink
+
+    def initialize(sink)
+      @sink = sink
+      @stages = []
+    end
+
+    def stage(name, &block)
+      SideBoom::Context.in(self) do
+        new_stage = SideBoom::Stage.new(name)
+        new_stage.instance_eval(&block) if block_given?
+        @stages << new_stage
+      end
+    end
+
+    def write!
+      content = "# Generated by SideBoom\n" + to_yaml
+      @sink.write(content)
+      @sink.close if @sink.is_a?(File)
+    end
+
+    private
+
+    def to_hash
+      hsh = {}
+      hsh['stages'] = @stages.map(&:name)
+
+      @stages.each { |stage| hsh.merge!(stage.to_hash) }
+      hsh
+    end
+
+    def to_yaml
+      to_hash.to_yaml
+    end
+  end
+end

data/lib/side_boom/stage.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SideBoom
+  class Stage
+    include SideBoom::Attributes
+
+    attr_reader :name, :jobs, :pipeline
+
+    def initialize(name)
+      @name = name
+      @pipeline = SideBoom::Context.peek
+      @jobs = []
+    end
+
+    def job(name, &block)
+      SideBoom::Context.in(self) do
+        new_job = SideBoom::Job.new(name)
+        new_job.instance_eval(&block) if block_given?
+
+        @jobs << new_job
+      end
+    end
+
+    def merged_attributes
+      pipeline.attributes.merge(attributes)
+    end
+
+    def to_hash
+      @jobs.each_with_object({}) do |job, hash|
+        hash[job.name] = job.to_hash
+      end
+    end
+  end
+end

data/side_boom.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'side_boom'
+
+description = <<-DESC
+  The .gitlab-ci.yml is hard to maintain if your project grows, and its hard to
+  determine what is defined where, and why. This Ruby DSL allows you to not be
+  limited by YAMLs limitations, but have all Ruby's features at your disposal.
+DESC
+
+Gem::Specification.new do |spec|
+  spec.name          = 'side_boom'
+  spec.version       = SideBoom::VERSION
+  spec.authors       = ['Zeger-Jan van de Weg']
+  spec.email         = ['git@zjvandeweg.nl']
+
+  spec.summary       = 'Construct and maintain your GitLab CI/CD pipeline'
+  spec.description   = description
+  spec.homepage      = 'https://gitlab.com/zj/side_boom'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['sideboom']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: side_boom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zeger-Jan van de Weg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+    The .gitlab-ci.yml is hard to maintain if your project grows, and its hard to
+    determine what is defined where, and why. This Ruby DSL allows you to not be
+    limited by YAMLs limitations, but have all Ruby's features at your disposal.
+email:
+- git@zjvandeweg.nl
+executables:
+- sideboom
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".sideboom"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- bin/sideboom
+- examples/simple.out
+- examples/simple.sideboom
+- lib/side_boom.rb
+- lib/side_boom/attributes.rb
+- lib/side_boom/context.rb
+- lib/side_boom/job.rb
+- lib/side_boom/pipeline.rb
+- lib/side_boom/stage.rb
+- side_boom.gemspec
+homepage: https://gitlab.com/zj/side_boom
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Construct and maintain your GitLab CI/CD pipeline
+test_files: []