vagrant-scp-sync 0.5.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65c818898c0656b74c7602b97bc8e9a65954254cd08a7d2dbdf740e177c86235
+  data.tar.gz: 62af0730c515cb15f50027d8fad094cf46ec973187749afb8c8d8f53edf439e5
+SHA512:
+  metadata.gz: d1edeee758eacd0863690066cee48f67c7ad88d8f940c074c8f5b3e3ec87c19d3588b60d701ffdcc867f657c1e84414a49b56ecaa9a45df1879ea16afc5ee448
+  data.tar.gz: 667cb7d1e6abe906520039ebb4c9994a60ec9cfeffa76e60c335de4bad2aa0870e6f03ded3b535ccd4b001cee32868015b8ac5664ff8f7a6a83b57df2c6e9662

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: MarkProminic
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: MarkProminic
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'bundler'
+    directory: '/'
+    schedule:
+      interval: 'daily'

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '16 4 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/lint-release-and-publish.yml

@@ -0,0 +1,71 @@
+# .github/workflows/release.yml
+
+name: Test, Lint, Release and Publish
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    env:
+      GEM_NAME: "vagrant-scp-sync"
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: ruby
+          package-name: ${{ env.GEM_NAME }}
+          bump-minor-pre-major: true
+          bump-patch-for-minor-pre-major: true
+          version-file: "lib/${{ env.GEM_NAME }}/version.rb"
+
+      # Checkout code if release was created
+      - uses: actions/checkout@v2
+        if: ${{ steps.release.outputs.release_created }}
+
+      # Setup ruby if a release was created
+      - name: Set up Ruby 3.0.0
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+        if: ${{ steps.release.outputs.release_created }}
+
+      # Bundle install
+      - run: bundle install
+        if: ${{ steps.release.outputs.release_created }}
+        
+      # Check if Passing Lint Requirements
+      - name: Run Rake tests
+        id: tests
+        run: bundle exec rake
+        if: ${{ steps.release.outputs.release_created }}
+        
+      # Publish to GPR
+      - name: Publish to GPR
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+          OWNER: ${{ github.repository_owner }}
+        if: steps.tests.outputs.exit_code == 0 && steps.release.outputs.release_created
+
+      # Publish to Ruby Gems
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+        if: steps.tests.outputs.exit_code == 0 && steps.release.outputs.release_created

data/.github/workflows/ruby-lint.yml

@@ -0,0 +1,35 @@
+# 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-lint
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+
+    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

data/.gitignore

@@ -0,0 +1,32 @@
+.bundle
+vendor
+/vendor/
+bin
+*.lock
+id_rsa
+_tmp_package
+package.box
+Vagrantfile
+exec
+.vagrant/*
+*/.vagrant/*
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.config
+.yardoc
+*.box
+/synced_folders
+.venv
+.idea/
+*.iml
+*.rbc
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,143 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+    - bin/**/*
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: true
+  Exclude:
+    - lib/vagrant-scp-sync/driver*
+
+Naming/MethodName:
+  EnforcedStyle: snake_case
+
+Naming/FileName:
+  Exclude:
+    - 'lib/vagrant-scp-sync.rb'
+    
+Naming/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+
+Style/Encoding:
+  Description: 'Use UTF-8 as the source file encoding.'
+  Enabled: true
+
+Style/HashSyntax:
+  Description: >-
+                 Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax
+                 { :a => 1, :b => 2 }.
+  Enabled: false
+  EnforcedStyle: hash_rockets
+
+Style/LineEndConcatenation:
+  Description: 'Use \\ instead of + to concatenate two string literals at line end.'
+  Enabled: true
+  AutoCorrect: true
+
+Layout/LineLength:
+  Description: 'Limit lines to 139 characters.'
+  Enabled: true
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Description: 'Avoid complex methods.'
+  Enabled: false
+
+Metrics/BlockLength:
+ Description: 'Limit Block to 139 Characters'
+ Max: 139
+
+Metrics/ModuleLength:
+ Description: 'Limit Block to 150 Characters'
+ Max: 165
+
+Metrics/AbcSize:
+  Description: >-
+                 A calculated magnitude based on number of assignments,
+                 branches, and conditions.
+  Reference: 'http://c2.com/cgi/wiki?AbcMetric'
+  Enabled: true
+  VersionAdded: '0.27'
+  # The ABC size is a calculated magnitude, so this number can be an Integer or
+  # a Float.
+  Max: 90
+
+Metrics/PerceivedComplexity:
+  Description: >-
+                 A complexity metric geared towards measuring complexity for a
+                 human reader.
+  Enabled: true
+  VersionAdded: '0.25'
+  Max: 30
+
+Style/RedundantReturn:
+  Description: >-
+                 ensure there are no redudant returns
+  Enabled: true
+  AutoCorrect: true
+
+Style/SpecialGlobalVars:
+  Description: >-
+                 Set Special Global vars
+  Enabled: true
+  AutoCorrect: true
+
+Style/RedundantInterpolation:
+  Description: >-
+                 Check for redudant interpolation
+  Enabled: true
+  AutoCorrect: true
+
+Style/StringConcatenation:
+  Description: >-
+                 Prefer to use String contactenation
+  Enabled: true
+  AutoCorrect: true
+
+Style/IfUnlessModifier:
+  Description: >-
+                 Used to check If/Unless should be used
+  Enabled: true
+  AutoCorrect: true
+
+Layout/EmptyLineAfterGuardClause:
+  Description: >-
+                 Empty line to show where clauses are
+  Enabled: true
+  AutoCorrect: true
+
+Style/CaseLikeIf:
+  Description: >-
+                 If if unles case styling
+  Enabled: true
+  AutoCorrect: true
+
+Layout/CaseIndentation:
+  Description: >-
+                 Enusures cases are Indented properly
+  Enabled: true
+  AutoCorrect: true
+
+Layout/TrailingWhitespace:
+  Description: >-
+                 Enusures cases are Indented properly
+  Enabled: true
+  AutoCorrect: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Description: >-
+                 Enusures cases are Indented properly
+  Enabled: true
+  AutoCorrect: true
+
+Layout/ElseAlignment:
+  Description: >-
+                 Enusures cases are Indented properly 
+  Enabled: true
+  AutoCorrect: true

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [0.5.8](https://github.com/STARTcloud/vagrant-scp-sync/compare/v0.5.7...v0.5.8) (2024-06-25)
+
+
+### Bug Fixes
+
+* first release ([eeb34fa](https://github.com/STARTcloud/vagrant-scp-sync/commit/eeb34fa0ecb5b851721c6ef21eebc4dfc0733d2f))

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+mark.gilbert@prominic.net.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,97 @@
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your RuboCop-compliant and test-passing changes (`git commit -am 'Add
+   some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Versioning
+
+This plugin follows the principles of
+[Semantic Versioning 2.0.0](http://semver.org/).
+
+## Unit Tests
+
+Please run the unit tests to verify your changes. To do this simply run `rake`.
+If you want a quick merge, write a spec that fails before your changes are
+applied and that passes after.
+
+If you don't have rake installed, first install [bundler](http://bundler.io/)
+and run `bundle install`. Then you can run `bundle exec rake`, even if rake is
+still not installed to your `PATH`.
+
+## RuboCop
+
+Please make changes [RuboCop](https://github.com/bbatsov/rubocop)-compliant.
+
+Changes that eliminate rules from
+[`.rubocop_todo.yml`](https://github.com/nsidc/vagrant-scp-sync/blob/master/.rubocop_todo.yml)
+are welcome.
+
+## Travis-CI
+
+[Travis](https://travis-ci.org/nsidc/vagrant-scp-sync) will automatically run
+RuboCop and the unit tests when you create a new pull request. If there are any
+failures, a notification will appear on the pull request. To update your pull
+request, simply create a new commit on the branch that fixes the failures, and
+push to the branch.
+
+## Development Without Building the Plugin
+
+To test your changes when developing the plugin, you have two main
+options. First, you can build and install the plugin from source every time you
+make a change:
+
+1. Make changes
+2. `rake build`
+3. `vagrant plugin install ./pkg/vagrant-scp-sync-$VERSION.gem`
+4. `vagrant scp`
+
+Second, you can use Bundler and the Vagrant gem to execute vagrant commands,
+saving time as you never have to wait for the plugin to build and install:
+
+1. Make changes
+2. `bundle exec vagrant scp`
+
+This method uses the version of Vagrant specified in
+[`Gemfile`](https://github.com/nsidc/vagrant-scp-sync/blob/master/Gemfile). It
+will also cause Bundler and Vagrant to output warnings every time you run
+`bundle exec vagrant`, because `Gemfile` lists **vagrant-scp-sync** twice (once
+with `gemspec` and another time in the `group :plugins` block), and Vagrant
+prefers to be run from the official installer rather than through the gem.
+
+Despite those warning messages, this is the
+[officially recommended](https://docs.vagrantup.com/v2/plugins/development-basics.html)
+method for Vagrant plugin development.
+
+## Committing
+
+The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
+
+* [Conventional Commits](https://github.com/conventional-commits/conventionalcommits.org/blob/master/content/v1.0.0/index.md)
+* [SemVer](https://semver.org/)
+* [Better Committing Practices](https://riptutorial.com/git/example/4729/good-commit-messages)
+
+## Releasing
+
+1) Ensure [travis-ci](https://travis-ci.org/github/nsidc/vagrant-scp-sync/) build is passing
+2) Ensure `CHANGELOG.md` is up-to-date with the changes to release
+3) Update version in the code, according to [semver](https://semver.org/)
+    * [bumpversion](https://github.com/peritus/bumpversion) can be used; if not,
+      the version needs to be manually updated in `.bumpversion.cfg`,
+      `README.md`, and `lib/vagrant-scp-sync/version.rb` (e.g., as in
+      [`11eced2`](https://github.com/nsidc/vagrant-scp-sync/commit/11eced2))
+4) `bundle exec rake build`
+    * builds the plugin to `pkg/vagrant-scp-sync-$VERSION.gem`
+    * install to your system vagrant for further testing with `vagrant plugin
+      install ./pkg/vagrant-scp-sync-$VERSION.gem`
+5) `bundle exec rake release`
+    * creates the version tag and pushes it to GitHub
+    * pushes the built gem to
+      [RubyGems.org](https://rubygems.org/gems/vagrant-scp-sync/)
+6) Update the [Releases page](https://github.com/nsidc/vagrant-scp-sync/releases)
+    * the release name should match the version tag (e.g., `v1.2.3`)
+    * the release description can be the same as the `CHANGELOG.md` entry
+    * upload the `.gem` from RubyGems.org as an attached binary for the release

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem 'vagrant', github: 'hashicorp/vagrant', ref: 'v2.2.19'
+end
+
+group :plugins do
+  gemspec
+  gem 'bundler', '~> 2.2', '>= 2.2.3'
+  gem 'code-scanning-rubocop', '~> 0.5', '>= 0.5.0'
+  gem 'rake', '~> 13.0', '>= 13.0.6'
+  gem 'rspec', '~> 3.4'
+  gem 'rspec-core', '~> 3.4'
+  gem 'rspec-expectations', '~> 3.10', '>= 3.10.0'
+  gem 'rspec-mocks', '~> 3.10', '>= 3.10.0'
+  gem 'rubocop', '~> 1.0'
+  gem 'rubocop-rake', '~> 0.6', '>= 0.6.0'
+  gem 'rubocop-rspec', '~> 2.4', '>= 2.4.0'
+  gem 'ruby-progressbar', '~> 1.11', '>= 1.11.0'
+end