ronin-core 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '081789614dad5997f6ff3c7761a10b27d6d242def8f70d21969764b9d1c9236b'
+  data.tar.gz: eca88a2a8d2450444c87ae06c85e5cb1243549d55ad3b8c615763facc59c6e49
+SHA512:
+  metadata.gz: 549cf9c4a77db4f8086dbf81504d29dfa06bf5aff11aa5730acf558daef6bab1c69710c7a870ff6afd18554fe68715e088383cb51c1350d3a093359a079b7964
+  data.tar.gz: b5432079445a5e9d9fdab4f4eada0f581c1ec1ad125d19b29839871b207a3c37887e2c666a9e530018cad08172ebc2a189b7d851c257e67bd7485abeabf29d8b

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+- 
+ChangeLog.md
+COPYING.txt
+man/*.md

data/.github/workflows/ruby.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - jruby
+          - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.gitignore

@@ -0,0 +1,12 @@
+/coverage
+/doc
+/pkg
+/vendor/bundle
+/Gemfile.lock
+/.bundle
+/.yardoc
+.DS_Store
+*.db
+*.log
+*.swp
+*~

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.rubocop.yml

@@ -0,0 +1,160 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+#
+# our rules
+#
+
+Layout/FirstArrayElementIndentation: { Exclude: ['spec/**/*'] }
+Layout/LineLength: { Enabled: false }
+Layout/SpaceAroundEqualsInParameterDefault: { EnforcedStyle: no_space }
+Lint/ConstantDefinitionInBlock: { Exclude: ['spec/**/*'] }
+Metrics: { Enabled: false }
+Style/SymbolArray: { EnforcedStyle: brackets }
+Style/IfInsideElse: { Enabled: false } # Offense count: 1
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    default: '{}'
+    '%i': '[]'
+    '%I': '[]'
+    '%w': '[]'
+    '%W': '[]'
+Style/UnlessElse: { Enabled: false }
+Bundler/OrderedGems: { Enabled: false }
+Style/CaseEquality: { Exclude: ['lib/ronin/web/server/conditions.rb'] }
+Style/Next: { Enabled: false }
+Style/HashSyntax: { Enabled: false }
+Naming/BlockForwarding: { Enabled: false }
+Lint/ReturnInVoidContext: { Enabled: false }
+Gemspec/DeprecatedAttributeAssignment: { Enabled: false }
+Style/MixinUsage: { Enabled: false }
+Naming/VariableNumber: { Enabled: false }
+Naming/PredicateName: { Enabled: false }
+Style/FetchEnvVar: { Enabled: false }
+Layout/RescueEnsureAlignment: { Enabled: false }
+Layout/BeginEndAlignment: { Enabled: false }
+Layout/EmptyLineAfterMagicComment: { Enabled: false }
+
+#
+# rules that are in flux
+#
+
+# consider enabling these and autocorrecting?
+# Layout/SpaceAfterComma
+# Layout/SpaceAroundKeyword
+# Layout/SpaceBeforeComma
+# Layout/SpaceInsideHashLiteralBraces
+# Layout/SpaceInsideParens
+# Layout/TrailingWhitespace
+# Lint/UnreachableLoop
+# Lint/UnusedBlockArgument
+# Style/ClassCheck
+# Style/Documentation
+# Style/ExpandPathArguments
+# Style/GlobalStdStream
+# Style/HashSyntax
+# Style/KeywordParametersOrder
+# Style/MethodCallWithoutArgsParentheses
+# Style/MutableConstant
+# Style/QuotedSymbols: { EnforcedStyle: double_quotes }
+# Style/RedundantReturn
+# Style/SafeNavigation
+# Style/SpecialGlobalVars
+# Style/StringLiterals: { EnforcedStyle: double_quotes }
+# Style/WordArray
+
+# these have been fixed
+# Gemspec/DuplicatedAssignment: { Enabled: false } # Offense count: 1
+# Layout/ElseAlignment: { Enabled: false } # Offense count: 1
+# Layout/EndAlignment: { Enabled: false } # Offense count: 1
+# Lint/DuplicateMethods: { Enabled: false } # Offense count: 1
+# Lint/UselessAssignment: { Enabled: false } # Offense count: 1
+# Style/Encoding: { Enabled: false } # Offense count: 2
+# Style/RedundantBegin: { Enabled: false } # Offense count: 2
+# Style/RedundantInterpolation: { Enabled: false } # Offense count: 1
+# Style/TrailingCommaInArrayLiteral: { Enabled: false } # Offense count: 1
+
+#
+# This list was generated with:
+# bundle exec rubocop --auto-gen-config --exclude-limit 1
+#
+
+# > 10 violations
+Layout/AssignmentIndentation: { Enabled: false } # Offense count: 11
+Layout/EmptyLinesAroundClassBody: { Enabled: false } # Offense count: 76
+Layout/HashAlignment: { Enabled: false } # Offense count: 28
+Layout/SpaceAfterComma: { Enabled: false } # Offense count: 141
+Layout/SpaceInsideHashLiteralBraces: { Enabled: false } # Offense count: 57
+Layout/TrailingWhitespace: { Enabled: false } # Offense count: 50
+Naming/RescuedExceptionsVariableName: { Enabled: false } # Offense count: 11
+Style/BlockDelimiters: { Enabled: false } # Offense count: 17
+Style/ClassCheck: { Enabled: false } # Offense count: 10
+Style/ClassEqualityComparison: { Enabled: false } # Offense count: 16
+Style/FrozenStringLiteralComment: { Enabled: false } # Offense count: 77
+Style/GlobalStdStream: { Enabled: false } # Offense count: 13
+Style/GuardClause: { Enabled: false } # Offense count: 10
+Style/IfUnlessModifier: { Enabled: false } # Offense count: 13
+Style/MethodCallWithoutArgsParentheses: { Enabled: false } # Offense count: 10
+Style/SpecialGlobalVars: { Enabled: false } # Offense count: 28
+Style/StringLiterals: { Enabled: false } # Offense count: 774
+Lint/ElseLayout: { Enabled: false } # Offense count: 22
+
+# < 10 violations
+Layout/EmptyLinesAroundModuleBody: { Enabled: false } # Offense count: 5
+Layout/ExtraSpacing: { Enabled: false } # Offense count: 6
+Layout/FirstHashElementIndentation: { Enabled: false } # Offense count: 4
+Layout/ParameterAlignment: { Enabled: false } # Offense count: 9
+Layout/SpaceAroundKeyword: { Enabled: false } # Offense count: 7
+Layout/SpaceBeforeComma: { Enabled: false } # Offense count: 4
+Layout/SpaceInsideParens: { Enabled: false } # Offense count: 4
+Lint/EmptyClass: { Enabled: false } # Offense count: 3
+Lint/SuppressedException: { Enabled: false } # Offense count: 4
+Lint/UnusedMethodArgument: { Enabled: false } # Offense count: 5
+Style/AccessorGrouping: { Enabled: false } # Offense count: 7
+Style/Documentation: { Enabled: false } # Offense count: 3
+Style/ExpandPathArguments: { Enabled: false } # Offense count: 8
+Style/KeywordParametersOrder: { Enabled: false } # Offense count: 8
+Style/Lambda: { Enabled: false } # Offense count: 3
+Style/MutableConstant: { Enabled: false } # Offense count: 4
+Style/RaiseArgs: { Enabled: false } # Offense count: 4
+Style/RedundantReturn: { Enabled: false } # Offense count: 7
+Style/SafeNavigation: { Enabled: false } # Offense count: 5
+Style/StringConcatenation: { Enabled: false } # Offense count: 8
+Style/WordArray: { Enabled: false } # Offense count: 4
+
+# 1 or 2 violations
+Layout/ArgumentAlignment: { Enabled: false } # Offense count: 1
+Layout/BlockAlignment: { Enabled: false } # Offense count: 1
+Layout/IndentationWidth: { Enabled: false } # Offense count: 2
+Layout/SpaceAroundOperators: { Enabled: false } # Offense count: 1
+Layout/SpaceBeforeBlockBraces: { Enabled: false } # Offense count: 1
+Lint/MissingSuper: { Enabled: false } # Offense count: 2
+Lint/RescueException: { Enabled: false } # Offense count: 1
+Lint/UnreachableLoop: { Enabled: false } # Offense count: 1
+Lint/UnusedBlockArgument: { Enabled: false } # Offense count: 1
+Naming/MethodParameterName: { Enabled: false } # Offense count: 1
+Style/EmptyMethod: { Enabled: false } # Offense count: 2
+Style/HashConversion: { Enabled: false } # Offense count: 1
+Style/MultilineMemoization: { Enabled: false } # Offense count: 1
+Style/NumericPredicate: { Enabled: false } # Offense count: 1
+Style/OptionalArguments: { Enabled: false } # Offense count: 1
+Style/ParenthesesAroundCondition: { Enabled: false } # Offense count: 1
+Style/PreferredHashMethods: { Enabled: false } # Offense count: 1
+Style/QuotedSymbols: { Enabled: false } # Offense count: 1
+Style/RedundantException: { Enabled: false } # Offense count: 1
+Style/RedundantRegexpEscape: { Enabled: false } # Offense count: 1
+Style/RegexpLiteral: { Enabled: false } # Offense count: 1
+Style/RescueStandardError: { Enabled: false } # Offense count: 1
+Style/SoleNestedConditional: { Enabled: false } # Offense count: 1
+Style/TrailingCommaInHashLiteral: { Enabled: false } # Offense count: 2
+
+# rubocop cannot tell that rubygems_mfa_required is enabled in gemspec.yml
+Gemspec/RequireMFA: { Enabled: false }
+
+# make an exception for our gemspec code
+Gemspec/DuplicatedAssignment:
+  Exclude:
+    - 'ronin-core.gemspec'

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'Ronin Core Documentation' --protected

data/COPYING.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/ChangeLog.md

@@ -0,0 +1,11 @@
+### 0.1.0 / 2023-XX-XX
+
+* Initial release:
+  * Provides access to the XDG directories (`~/.config/`, `~/.cache/`,
+    `~/.local/share`).
+  * Allows querying `~/.gitconfig` for common git settings.
+  * Provides a common `Command` base class for all ronin libraries.
+  * Provides a `Shell` and `CommandShell` base classes for writing interactive
+    shells.
+  * Provides a `Params` API for adding user configurable parameters to classes.
+

data/Gemfile

@@ -0,0 +1,30 @@
+source 'https://rubygems.org'
+
+gemspec
+
+platform :jruby do
+  gem 'jruby-openssl',	'~> 0.7'
+end
+
+# gem 'command_kit', '~> 0.4', github: 'postmodern/command_kit.rb',
+#                              branch: 'main'
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks',  '~> 0.2'
+
+  gem 'rspec',           '~> 3.0'
+  gem 'simplecov',       '~> 0.20'
+
+  gem 'kramdown',        '~> 2.0'
+  gem 'kramdown-man',    '~> 0.1'
+
+  gem 'redcarpet',       platform: :mri
+  gem 'yard',            '~> 0.9'
+  gem 'yard-spellcheck', require: false
+
+  gem 'dead_end',        require: false
+  gem 'sord',            require: false, platform: :mri
+  gem 'stackprof',       require: false, platform: :mri
+  gem 'rubocop',         require: false
+end