abide_dev_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb6febf04efd889f8fae16d58b7951a1e209c57aef125a03017ac3fdc5229a88
+  data.tar.gz: f133a75839ef09396eba54bb6f563567c9f5cf7057aab1a03a5ec09598600cd8
+SHA512:
+  metadata.gz: 798de0252108b50dbe3486f1edceb916e985039087ccf23f2ff0c2a0f1f1f75e0478a45c4a78b634968e197a03628869f968cf55236ab8b7e4bd7e3f1f9f17e1
+  data.tar.gz: e41abc0cbcd7bdb8ac3b700beed14479baf9287ad10c1bc8405d22384afb75df7e8a0dee0f9914f99e2b81576dff2b5d8f10b06a3dfe66595858fa6967e71eb1

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,136 @@
+inherit_from: .rubocop_todo.yml
+require:
+  - rubocop/cop/internal_affairs
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+    - '.git/**/*'
+    - 'bin/*'
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+
+Naming/PredicateName:
+  # Method define macros for dynamically generated method.
+  MethodDefinitionMacros:
+    - define_method
+    - define_singleton_method
+    - def_node_matcher
+    - def_node_search
+
+Style/AccessorGrouping:
+  Exclude:
+    - lib/rubocop/formatter/base_formatter.rb
+    - lib/rubocop/cop/offense.rb
+
+Style/FormatStringToken:
+  # Because we parse a lot of source codes from strings. Percent arrays
+  # look like unannotated format string tokens to this cop.
+  Exclude:
+    - spec/**/*
+
+Style/IpAddresses:
+  # The test for this cop includes strings that would cause offenses
+  Exclude:
+  - spec/rubocop/cop/style/ip_addresses_spec.rb
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+      - module_inclusion
+      - constants
+      - public_class_methods
+      - initializer
+      - instance_methods
+      - protected_methods
+      - private_methods
+
+Layout/TrailingWhitespace:
+  AllowInHeredoc: false
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle:
+    - key
+    - table
+  EnforcedColonStyle:
+    - key
+    - table
+
+Layout/LineLength:
+  Max: 120
+  IgnoredPatterns:
+    - !ruby/regexp /\A +(it|describe|context|shared_examples|include_examples|it_behaves_like) ["']/
+
+Lint/InterpolationCheck:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Lint/UselessAccessModifier:
+  MethodCreatingMethods:
+    - 'def_matcher'
+    - 'def_node_matcher'
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '**/*.gemspec'
+
+Metrics/ClassLength:
+  Exclude:
+    - lib/rubocop/config_obsoletion.rb
+
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+RSpec/FilePath:
+  Exclude:
+    - spec/rubocop/formatter/junit_formatter_spec.rb
+
+RSpec/PredicateMatcher:
+  EnforcedStyle: explicit
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/NestedGroups:
+  Max: 7
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'Rakefile'
+    - 'spec/**/*.rb'
+
+RSpec/StubbedMock:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,49 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-01-15 17:47:56 UTC using RuboCop version 1.8.1.
+# 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: 2
+# Cop supports --auto-correct.
+# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'abide_dev_utils.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/abide_dev_utils/xccdf/parser.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowComments.
+Lint/EmptyClass:
+  Exclude:
+    - 'lib/abide_dev_utils/xccdf/parser.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+RSpec/ExpectActual:
+  Exclude:
+    - 'spec/routing/**/*'
+    - 'spec/abide_dev_utils_spec.rb'
+
+# Offense count: 20
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'abide_dev_utils.gemspec'
+    - 'lib/abide_dev_utils/version.rb'
+    - 'spec/abide_dev_utils_spec.rb'
+    - 'spec/spec_helper.rb'

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in abide_dev_utils.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Heston Snodgrass
+
+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,45 @@
+# AbideDevUtils
+
+Helper library and CLI app for Abide development.
+
+## Installation
+
+### CLI app
+
+```sh
+$ gem install abide_dev_utils
+...
+$ abide -h
+```
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'abide_dev_utils'
+```
+
+And then execute:
+
+`$ bundle install`
+
+Or install it yourself as:
+
+`$ gem install abide_dev_utils`
+
+## Usage
+
+Coming soon, in the mean time run `abide -h` and `abide [command] -h` for help.
+
+## 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hsnodgrass/abide_dev_utils.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/abide_dev_utils.gemspec

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "abide_dev_utils/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "abide_dev_utils"
+  spec.version       = AbideDevUtils::VERSION
+  spec.authors       = ["Heston Snodgrass"]
+  spec.email         = ["hsnodgrass3@gmail.com"]
+
+  spec.summary       = "Helper utilities for developing Abide"
+  spec.description   = "Provides a CLI with helpful utilities for developing Abide"
+  spec.homepage      = "https://github.com/hsnodgrass/abide_dev_utils"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = ['abide']
+  spec.require_paths = ['lib']
+
+  # Prod dependencies
+  spec.add_dependency 'bundler', '~> 2.0'
+  spec.add_dependency 'nokogiri', '~> 1.11'
+  spec.add_dependency 'cmdparse', '~> 3.0'
+  spec.add_dependency 'puppet', '<= 6.19'
+  spec.add_dependency 'jira-ruby', '~> 2.1'
+  spec.add_dependency 'ruby-progressbar', '~> 1.11'
+
+  # Dev dependencies
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.8'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.1'
+  spec.add_development_dependency 'rubocop-ast', '~> 1.4'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.9'
+  spec.add_development_dependency 'rubocop-i18n', '~> 3.0'
+  spec.add_development_dependency 'fast_gettext', '~> 1.1'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/abide.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'abide_dev_utils/cli'
+
+Abide::CLI.execute

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "abide_dev_utils"
+
+# 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/abide

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'abide_dev_utils/cli'
+
+Abide::CLI.execute

data/lib/abide_dev_utils.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'abide_dev_utils/version'
+require 'abide_dev_utils/xccdf'
+require 'abide_dev_utils/utils'
+require 'abide_dev_utils/errors'
+
+# Just creates the namespace
+module AbideDevUtils; end

data/lib/abide_dev_utils/cli.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'cmdparse'
+require 'abide_dev_utils/version'
+require 'abide_dev_utils/constants'
+require 'abide_dev_utils/cli/puppet'
+require 'abide_dev_utils/cli/xccdf'
+require 'abide_dev_utils/cli/test'
+require 'abide_dev_utils/cli/jira'
+
+module Abide
+  module CLI
+    include AbideDevUtils::CliConstants
+    ROOT_CMD_NAME = 'abide'
+    ROOT_CMD_BANNER = 'Developer tools for Abide'
+
+    def self.new_parser
+      parser = CmdParse::CommandParser.new(handle_exceptions: true)
+      parser.main_options.program_name = ROOT_CMD_NAME
+      parser.main_options.version = AbideDevUtils::VERSION
+      parser.main_options.banner = ROOT_CMD_BANNER
+      parser.add_command(CmdParse::HelpCommand.new, default: true)
+      parser.add_command(PuppetCommand.new)
+      parser.add_command(XccdfCommand.new)
+      parser.add_command(TestCommand.new)
+      parser.add_command(JiraCommand.new)
+      parser
+    end
+
+    def self.execute
+      parser = new_parser
+      parser.parse
+    end
+  end
+end