Add lib/inspec-objects.rb so inspec-objects can be required

.expeditor/config.yml

@@ -1,12 +1,12 @@
 ---
 project:
-  alias: inspec-objects
+  alias: mitre-inspec-objects
 
 slack:
   notify_channel: "compliance-profile"
 
 rubygems:
-  - inspec-objects
+  - mitre-inspec-objects
 
 github:
   # This deletes the GitHub PR branch after successfully merged into the release branch

.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Release Management
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    name: Release to gem hosts
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup ruby
+        uses: actions/setup-ruby@v1
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          lfs: true
+      - run: git fetch origin +refs/tags/*:refs/tags/*
+      - name: Setup credentials and versioning
+        run: |
+          gem install git-lite-version-bump keycutter roo
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:push_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+          printf -- ":github_api_key: Bearer ${GPR_API_KEY}\n" >> $HOME/.gem/credentials
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+          GPR_API_KEY: ${{secrets.GITHUB_TOKEN}}
+      - name: Build gem
+        run: gem build ./mitre-inspec-objects.gemspec
+      - name: Get gem version
+        run: echo "::set-env name=VERSION::$(ls *.gem | grep -Po '(\d+.)+\d+')"
+        env:
+          ACTIONS_ALLOW_UNSECURE_COMMANDS: true 
+      - name: Publish to RubyGems
+        run: |
+          gem push -k push_api_key --host https://rubygems.org *.gem
+      - name: Publish to GPR
+        run: |
+          gem push -k github_api_key --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          OWNER: mitre

.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: |
+        bundle exec rake

.gitignore

@@ -48,3 +48,4 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+.vscode/*

.rubocop.yml

@@ -0,0 +1,14 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-02-07 20:29:42 -0500 using RuboCop version 0.72.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'test/unit/objects_test.rb'

Gemfile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-gem "inspec-objects", path: "."
+gem "mitre-inspec-objects", path: "."
 
 group :test do
+  gem "chef-utils", "~> 16.6.14"
   gem "chefstyle", "0.13.0"
   gem "minitest", "~> 5.5"
   gem "rake", ">= 10"
-  gem "chef-utils", "~> 16.6.14"
 end

README.md

@@ -1,5 +1,5 @@
 # inspec-objects
-[![Gem Version](https://badge.fury.io/rb/inspec-objects.svg)](https://badge.fury.io/rb/inspec-objects)
+[![Gem Version](https://badge.fury.io/rb/mitre-inspec-objects.svg)](https://badge.fury.io/rb/mitre-inspec-objects)
 
 **Umbrella Project**: [InSpec](https://github.com/chef/chef-oss-practices/blob/master/projects/inspec.md)
 

Rakefile

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require "bundler"
 require "rake/testtask"
 
-Bundler::GemHelper.install_tasks name: "inspec-objects"
+Bundler::GemHelper.install_tasks name: "mitre-inspec-objects"
 
 Rake::TestTask.new(:unit) do |t|
   t.libs << "test"
   t.test_files = Dir.glob([
-    "test/unit/**/*_test.rb",
-  ])
+                            "test/unit/**/*_test.rb",
+                          ])
 end
 
 begin

VERSION

@@ -1 +1 @@
-0.1.0
+0.3.3

lib/inspec/objects.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 module Inspec
   module Object
-    autoload :Tag, "inspec/objects/tag"
-    autoload :Control, "inspec/objects/control"
-    autoload :Describe, "inspec/objects/describe"
-    autoload :EachLoop, "inspec/objects/each_loop"
-    autoload :List, "inspec/objects/list"
-    autoload :OrTest, "inspec/objects/or_test"
-    autoload :RubyHelper, "inspec/objects/ruby_helper"
-    autoload :Test, "inspec/objects/test"
-    autoload :Value, "inspec/objects/value"
-    autoload :Input, "inspec/objects/input"
+    require_relative "objects/tag"
+    require_relative "objects/control"
+    require_relative "objects/ruby_helper"
+    require_relative "objects/describe"
+    require_relative "objects/value"
+    require_relative "objects/list"
+    require_relative "objects/each_loop"
+    require_relative "objects/or_test"
+    require_relative "objects/test"
+    require_relative "objects/input"
+    require_relative "objects/post_body"
+    require_relative "objects/header"
   end
 end

lib/inspec/objects/control.rb

@@ -1,11 +1,19 @@
+# frozen_string_literal: true
+
 module Inspec::Object
   class Control
-    attr_accessor :id, :title, :descriptions, :impact, :tests, :tags, :refs, :only_if
+    attr_accessor :header, :id, :title, :descriptions, :impact, :tests, :post_body, :tags, :refs, :only_if
     def initialize
+      @header = ""
       @tests = []
       @tags = []
       @refs = []
       @descriptions = {}
+      @post_body = ""
+    end
+
+    def add_header(header)
+      @header = header
     end
 
     def add_test(t)
@@ -16,19 +24,27 @@ def add_tag(t)
       @tags.push(t)
     end
 
+    def add_post_body(post_body)
+      @post_body = post_body
+    end
+
     def to_hash
       {
+        header: header,
         id: id,
         title: title,
         descriptions: descriptions,
         impact: impact,
         tests: tests.map(&:to_hash),
         tags: tags.map(&:to_hash),
+        post_body: post_body,
       }
     end
 
-    def to_ruby # rubocop:disable Metrics/AbcSize
-      res = ["control #{id.inspect} do"]
+    def to_ruby
+      res = []
+      res.push header unless header.nil? || header.empty?
+      res.push "control #{id.inspect} do"
       res.push "  title #{title.inspect}" unless title.to_s.empty?
       descriptions.each do |label, text|
         if label == :default
@@ -44,6 +60,7 @@ def to_ruby # rubocop:disable Metrics/AbcSize
       refs.each { |t| res.push("  ref   #{print_ref(t)}") }
       res.push "  only_if { #{only_if} }" if only_if
       tests.each { |t| res.push(indent(t.to_ruby, 2)) }
+      res.push(indent(post_body, 2)) unless post_body.nil? || post_body.empty?
       res.push "end"
       res.join("\n")
     end

lib/inspec/objects/describe.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Inspec::Object
   class Describe
     # Internal helper to structure test objects.
@@ -11,11 +13,11 @@ def negate!
       def to_ruby
         itsy = "it"
         unless its.nil?
-          if its.is_a? Array
-            itsy = "its(" + its.inspect + ")"
-          else
-            itsy = "its(" + its.to_s.inspect + ")"
-          end
+          itsy = if its.is_a? Array
+                   "its(" + its.inspect + ")"
+                 else
+                   "its(" + its.to_s.inspect + ")"
+                 end
         end
         naughty = negated ? "_not" : ""
         xpect = if expectation.nil?
@@ -72,7 +74,7 @@ def to_hash
     end
 
     def resource
-      return nil if qualifier.empty? || qualifier[0].empty? || qualifier[0][0].empty?
+      return if qualifier.empty? || qualifier[0].empty? || qualifier[0][0].empty?
 
       qualifier[0][0]
     end

lib/inspec/objects/each_loop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Inspec::Object
   class EachLoop < List
     attr_reader :variables

lib/inspec/objects/header.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class Header
+    attr_accessor :header
+
+    def initialize(header)
+      @header = header
+    end
+
+    def to_hash
+      {
+        header: header,
+      }
+    end
+
+    def to_ruby
+      header.inspect.to_s
+    end
+
+    def to_s
+      "Header #{header}"
+    end
+  end
+end

lib/inspec/objects/input.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require "inspec/input"
 
 module Inspec::Object
   class Input < ::Inspec::Input
-
     # NOTE: No initialize method or accessors for the reasons listed above
 
     #--------------------------------------------------------------------------#

lib/inspec/objects/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Inspec::Object
   class List < Value
     def map

lib/inspec/objects/or_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Inspec::Object
   class OrTest
     attr_reader :tests
@@ -18,12 +20,11 @@ def to_ruby
       if @negated
         # We don't use the describe.one wrapper when negated because:
         # !(test1 || test2)     same as    (!test1 && !test2)    where && is implicit in inspec
-        all_tests = @tests.map do |test|
+        @tests.map do |test|
           test.negate!
           test
         end.map(&:to_ruby).join("\n")
 
-        all_tests
       else
         all_tests = @tests.map(&:to_ruby).join("\n").gsub("\n", "\n  ")
 

lib/inspec/objects/post_body.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Inspec::Object
+  class PostBody
+    attr_accessor :post_body
+
+    def initialize(post_body)
+      @post_body = post_body
+    end
+
+    def to_hash
+      {
+        post_body: post_body,
+      }
+    end
+
+    def to_ruby
+      post_body.inspect.to_s
+    end
+
+    def to_s
+      "Post Body #{post_body}"
+    end
+  end
+end

lib/inspec/objects/ruby_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Inspec::Object
   module RubyHelper
     def ruby_qualifier(q)

lib/inspec/objects/tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Inspec::Object
   class Tag
     attr_accessor :key, :value