gene_system 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 69b1b6ad105f91562009bfa99f1a2cc3a3dfd0391a54a4e58b65296cc452e581
+  data.tar.gz: de398efc98b4de7eb7f3b8a8661790f5ca9f89cf55165abc89a7ec0b97b3986c
+SHA512:
+  metadata.gz: b3936aa6de8f87fec7fbabfa7574e7ab15a0252a7f653efb163bf78a341eb0451766b32db7e2b3616583589116f863e1e7747331f8cc3e6a5af0aa965c01e6bb
+  data.tar.gz: 524c443a8ee2425184e70072336e4d99f6b3716f14864c723164ecc7d422a1fcab722edb0b212741be7cf71964245699b80990e6eb8ec77311c9b5850f8f3533

data/.doxie.json

@@ -0,0 +1,25 @@
+{
+  "uploads": {
+     "yardoc": {
+        "source": "doc",
+        "target": {
+           "bucket": "docs-biggerconcept-com",
+           "key": "bitbucket.org/biggerconcept/gene_system/doc"
+        }
+     },
+     "coverage": {
+        "source": "target/reports/coverage",
+        "target": {
+           "bucket": "docs-biggerconcept-com",
+           "key": "bitbucket.org/biggerconcept/gene_system/coverage"
+        }
+     },
+     "critique": {
+        "source": "target/reports/critique",
+        "target": {
+           "bucket": "docs-biggerconcept-com",
+           "key": "bitbucket.org/biggerconcept/gene_system/critique"
+        }
+     }
+  }
+}

data/.github/workflows/build.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# byebug history
+.byebug_history
+
+*.gem
+target/reports
+
+.DS_Store
+
+/doc/

data/.rubocop.yml

@@ -0,0 +1,20 @@
+---
+  AllCops:
+    TargetRubyVersion: 2.4
+  
+  Style/FrozenStringLiteralComment:
+    Enabled: false
+  
+  Metrics/MethodLength:
+    Max: 20
+  
+  Metrics/AbcSize:
+    Max: 20
+  
+  Lint/AssignmentInCondition:
+    Enabled: false
+  
+  Metrics/BlockLength:
+    Exclude:
+      - 'gene_system.gemspec'
+      - 'spec/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+When contributing to Gene System, please take note of the following requests.
+
+## Pull Request Process
+
+1. Before raising a pull request, please first discuss the change by raising an issue.
+2. Ensure any changes that change the behaviour or would be useful to implementers of this gem are documented within the README.md
+3. Increase the version number in any PR raised. The versioning scheme we use is [SemVer](https://semver.org/)
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing or otherwise unacceptable behaviour may be reported by contacting the project team. The project team will decide how to respond to any compliants.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org/version/1/4), version 1.4, available at http://contributor-covenant.org/version/1/4

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+git_source(:biggerconcept) do |repo_name|
+  username = ENV['BIGGERCONCEPT_CI_USER']
+  password = ENV['BIGGERCONCEPT_CI_PASSWORD']
+  git_host = ENV['BIGGERCONCEPT_GIT_HOSTpro']
+  "https://#{username}:#{password}@#{git_host}/#{repo_name}"
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,150 @@
+PATH
+  remote: .
+  specs:
+    gene_system (0.3.2)
+      hashie
+      highline (~> 2.0)
+      jsonnet
+      logger (~> 1.4)
+      os
+      ruby-handlebars (~> 0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    bump (0.10.0)
+    byebug (11.1.3)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coderay (1.1.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    doxie (4.0.0)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    flay (2.12.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.4)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    hashie (4.1.0)
+    highline (2.0.3)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.4)
+    jsonnet (0.4.0)
+      mini_portile2 (>= 2.2.0)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    logger (1.4.3)
+    method_source (1.0.0)
+    mini_portile2 (2.6.1)
+    nio4r (2.5.7)
+    os (1.1.1)
+    parallel (1.20.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    parslet (1.8.2)
+    path_expander (1.1.0)
+    private_gem (1.1.4)
+      bundler (> 1.7, < 3.0)
+      thor
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    puma (4.3.7)
+      nio4r (~> 2.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    reek (4.8.2)
+      codeclimate-engine-rb (~> 0.4.0)
+      parser (>= 2.5.0.0, < 2.6)
+      rainbow (>= 2.0, < 4.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.68.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-handlebars (0.4.0)
+      parslet (~> 1.6, >= 1.6.2)
+    ruby-progressbar (1.11.0)
+    ruby_parser (3.15.1)
+      sexp_processor (~> 4.9)
+    rubycritic (3.5.2)
+      flay (~> 2.8)
+      flog (~> 4.4)
+      launchy (= 2.4.3)
+      parser (~> 2.5.0)
+      rainbow (~> 3.0)
+      reek (~> 4.4)
+      ruby_parser (~> 3.8)
+      tty-which (~> 0.3.0)
+      virtus (~> 1.0)
+    sexp_processor (4.15.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    tty-which (0.3.0)
+    unicode-display_width (1.5.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    yard (0.9.26)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bump (~> 0.6)
+  byebug (~> 11.0)
+  doxie
+  gene_system!
+  private_gem (~> 1.1)
+  pry (~> 0.11)
+  puma (~> 4.3)
+  rake (~> 13.0)
+  rspec (~> 3.7, >= 3.7.0)
+  rubocop (~> 0.58)
+  rubycritic (~> 3.4, >= 3.4.0)
+  simplecov (~> 0.16)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.2.16

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Andrew Bigger
+
+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,255 @@
+# GeneSystem
+
+A gem for configuring systems via json or jsonnet manifest.
+
+## Installation
+
+Install the gem into your system:
+
+```bash
+gem install gene_system
+```
+
+## Usage
+
+### Creating a Configuration Manifest
+
+Once installed, you can create a configuration manifest by calling the `new` command:
+
+```bash
+genesystem new manifest
+```
+
+This creates a file called `manifest.json` in which you can write configuration steps.
+
+### Writing a Configuration Manifest
+
+A configuration manifest looks like this:
+
+```json
+{
+  "name": "manifest",
+  "version": "0.0.1",
+  "metadata": {
+    "gene_system": {
+      "version": "0.3.1"
+    }
+  },
+  "steps": [
+    {
+      "name": "say hello",
+      "exe": {
+        "install": {
+          "cmd": [
+            "echo \"hello\""
+          ]
+        },
+        "remove": {
+          "cmd": [
+            "echo goodbye"
+          ]
+        }
+      },
+      "tags": "example step"
+    }
+  ]
+}
+```
+
+Below is a description of the root level manifest attributes, each of which is required:
+
+- `name` is the name of the configuration manifest
+- `version` refers to the version of the configuration. You might want to increment this number as you make changes to the manifest.
+- `metadata` contains data about the manifest, notably the `gene_system > version` attribute which governs the minimum version of the Gene System gem required to execute the manifest
+- `steps` an array of step objects that configure a host machine. 
+
+#### Step Objects
+
+Each step is executed in order and should be in the following format:
+
+```json
+{
+  "name": "say hello",
+  "exe": {
+    "install": {
+      "cmd": [
+        "echo \"hello\""
+      ]
+    },
+    "remove": {
+      "cmd": [
+        "echo goodbye"
+      ]
+    }
+  },
+  "tags": "example step"
+}
+```
+
+Steps have a `name`, `exe` and `tag` attribute.
+
+- `name` refers to the step name, this will be printed in STDOUT when the step is being executed.
+- `exe` is an object that runs during the application or removal of a manifest. It can take an `install` or `remove` object (described below)
+- `tags` a space separated string of tags.
+
+#### Install and Remove Objects
+
+The install and remove objects are basically the same, only differing in the sense that the `install` exe instructions are run when the `genesystem install` command is run, and the `remove` exe instructions when the `genesystem remove` command is run.
+
+The install and remove objects require a `cmd` array like the one in the example above. These should be shell commands to be run.
+
+Optionally, both the install and remove objects can accept the following:
+
+- `skip` command that prevents execution of `cmd` instructions
+- `prompts` array of prompt that asks the user for input
+
+##### Skip
+
+Skip instructions can speed up the execution of a configuration manifest, by running a shell command to determine whether the step is required.
+
+Skip works by executing a shell command and evaluating whether it returned a zero status (in other words is truthy).
+
+For example you might wish to skip a command in the event that a file or folder exists. You would do this by adding a step like this:
+
+```json
+{
+  "name": "say hello",
+  "exe": {
+    "install": {
+      "skip": "[ -f greeted.txt ]",
+      "cmd": [
+        "echo \"hello\""
+      ]
+    }
+  },
+  "tags": "example step"
+}
+```
+
+The `echo "hello"` command would only execute if the `greeted.txt` file does not exist.
+
+##### Prompts
+
+Prompts is an array of objects that describes a prompt for user input. A prompt looks like this:
+
+```json
+{
+  "prompt": "Please enter your name",
+  "var": "name"
+}
+```
+
+Before the `exe` commands are run, the user will be asked for input, and that input will be saved to a variable named the value of `var`.
+
+In the above example, the user input would be saved to the `name` variable.
+
+The variable is rendered into the `cmd` command using handlebars syntax. Using the example above a prompt can be used thus:
+
+```json
+{
+  "name": "say hello",
+  "exe": {
+    "install": {
+      "prompts": [
+        {
+          "prompt": "Please enter your name",
+          "var": "name"
+        }
+      ],
+      "cmd": [
+        "echo \"hello {{ name }}\""
+      ]
+    }
+  },
+  "tags": "example step"
+}
+```
+
+### Installing a Configuration Manifest
+
+Once a manifest file is created, Gene System can apply the changes described in the manifest using the `install` command with the relative path to the manifest json as an argument.
+
+```bash
+genesystem install /path/to/manifest.json
+```
+
+This will select all of the `install` commands from the steps and execute them.
+
+### Removing a Configuration Manifest
+
+The Gene System manifest defines `remove` steps which are intended to be reverse commands for removing the configuration applied by the `install` commands. A good manifest should provide these to return a machine to a default state if required.
+
+The `remove` steps can be run by calling the `remove` command with the relative path to the manifest json as an argument:
+
+```bash
+genesystem remove /path/to/manifest.json
+```
+
+### Jsonnet Support
+
+[Jsonnet](https://jsonnet.org/) is a data templating language for specifying configuration files, and it is a supported format for Gene System manifests.
+
+This might be useful where step loops are useful. 
+
+```jsoonnet
+local conf = {
+  varibles: {
+    pkg: {
+      apts: [
+        {
+          "name": "docker.io"
+        },
+        {
+          "name": "postgresql-client"
+        }
+      ]
+    }
+  }
+}
+
+{
+  "name": "manifest",
+  "version": "0.0.1",
+  "metadata": {
+    "gene_system": {
+      "version": "0.3.1"
+    }
+  },
+  "steps": [] + [
+    // install apt packages
+    {
+      "name": "install " + apt.name,
+      "exe": {
+        "install": {
+          "cmd": [
+            "echo password | sudo -S apt-get install " + apt.name
+          ]
+        },
+      },
+      "tags": "install " + apt.name
+    } for apt in conf.variables.pkg.apts
+  ]
+}
+```
+
+## Tests and Quality
+
+Tests cover this project and are written in RSpec. You'll find them in the spec folder.
+
+```bash
+bundle exec rspec spec
+```
+
+Tests and quality tasks are included in the default rake task which can be run thus:
+
+```bash
+bundle exec rake
+```
+
+## Contributing
+
+See CONTRIBUTING.md for more information
+
+## Licence
+
+This gem is covered by the terms of the MIT licence. See LICENCE for more information