ruby_git_crypt 0.1.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 58708bdc311759486fd4d818881b53f5cda5f6d535f8e5c00eb53c54e3a1ac55
+  data.tar.gz: e00ce54737466951c462d0753cbbe3afac084d1241516c3ace18c324e4bccc22
+SHA512:
+  metadata.gz: 803e63d5587c07eb79f138fb17332291f0074616b1b734bd3026446bc19ffa47c6081beb7565f9fffae2d0cf28ea7c8bc61338be1cbf78f124e2890c5a8c43da
+  data.tar.gz: e65a13db1734ae9f3e862227e60d8c5fda052a50e42ff0e68956e628cad9b877954d20e7aad3956a4b75a1d8d729ea4a18f6b84ba4aa50650edb82b114026374

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant 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 behavior may be
+reported by contacting the project team at maintainers@infrablocks.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_git_crypt.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,185 @@
+PATH
+  remote: .
+  specs:
+    ruby_git_crypt (0.1.0.pre.1)
+      immutable-struct (~> 2.4)
+      lino (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    colored2 (3.1.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    excon (0.95.0)
+    faker (3.1.0)
+      i18n (>= 1.8.11, < 2)
+    faraday (2.7.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    gem-release (2.2.2)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hamster (3.0.0)
+      concurrent-ruby (~> 1.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    immutable-struct (2.4.1)
+    json (2.6.3)
+    lino (3.1.0)
+      hamster (~> 3.0)
+      open4 (~> 1.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    minitest (5.17.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (6.0.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    open4 (1.3.4)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rake_circle_ci (0.11.0)
+      colored2 (~> 3.1)
+      excon (~> 0.72)
+      rake_factory (~> 0.23)
+      sshkey (~> 2.0)
+    rake_factory (0.31.0)
+      activesupport (>= 4)
+      rake (~> 13.0)
+    rake_github (0.11.0)
+      colored2 (~> 3.1)
+      octokit (>= 4.16, < 7.0)
+      rake_factory (~> 0.23)
+      sshkey (~> 2.0)
+    rake_gpg (0.18.0)
+      rake_factory (~> 0.23)
+      ruby_gpg2 (~> 0.6)
+    rake_ssh (0.8.0)
+      colored2 (~> 3.1)
+      rake_factory (~> 0.23)
+      sshkey (~> 2.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.16.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    ruby_gpg2 (0.10.0)
+      lino (~> 3.0)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    shellany (0.0.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sshkey (2.0.0)
+    terminal-notifier-guard (1.7.0)
+    thor (1.2.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  faker
+  gem-release
+  guard
+  guard-rspec
+  rake
+  rake_circle_ci
+  rake_github
+  rake_gpg
+  rake_ssh
+  rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+  ruby_git_crypt!
+  simplecov
+  terminal-notifier-guard
+  yard
+
+BUNDLED WITH
+   2.4.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 InfraBlocks Maintainers
+
+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,99 @@
+# RubyGitCrypt
+
+A simple wrapper around the `git-crypt` binary to allow execution from within
+a Ruby program, RSpec test or Rakefile.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_git_crypt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_git_crypt
+
+## Usage
+
+To require `RubyGitCrypt`:
+
+```ruby
+require 'ruby_git_crypt'
+```
+
+## Documentation
+
+* [API docs](https://infrablocks.github.io/ruby_git_crypt/index.html)
+
+## Development
+
+To install dependencies and run the build, run the pre-commit build:
+
+```shell
+./go
+```
+
+This runs all unit tests and other checks including coverage and code linting /
+formatting.
+
+To run only the unit tests, including coverage:
+
+```shell
+./go test:unit
+```
+
+To attempt to fix any code linting / formatting issues:
+
+```shell
+./go library:fix
+```
+
+To check for code linting / formatting issues without fixing:
+
+```shell
+./go library:check
+```
+
+You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+### Managing CircleCI keys
+
+To encrypt a GPG key for use by CircleCI:
+
+```shell
+openssl aes-256-cbc \
+  -e \
+  -md sha1 \
+  -in ./config/secrets/ci/gpg.private \
+  -out ./.circleci/gpg.private.enc \
+  -k "<passphrase>"
+```
+
+To check decryption is working correctly:
+
+```shell
+openssl aes-256-cbc \
+  -d \
+  -md sha1 \
+  -in ./.circleci/gpg.private.enc \
+  -k "<passphrase>"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/infrablocks/ruby_git_crypt. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to adhere
+to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'yard'
+require 'rake_circle_ci'
+require 'rake_github'
+require 'rake_ssh'
+require 'rake_gpg'
+require 'securerandom'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: %i[
+  library:fix
+  test:unit
+]
+
+namespace :encryption do
+  namespace :directory do
+    desc 'Ensure CI secrets directory exists.'
+    task :ensure do
+      FileUtils.mkdir_p('config/secrets/ci')
+    end
+  end
+
+  namespace :passphrase do
+    desc 'Generate encryption passphrase used by CI.'
+    task generate: ['directory:ensure'] do
+      File.write('config/secrets/ci/encryption.passphrase',
+                 SecureRandom.base64(36))
+    end
+  end
+end
+
+namespace :keys do
+  namespace :deploy do
+    RakeSSH.define_key_tasks(
+      path: 'config/secrets/ci/',
+      comment: 'maintainers@infrablocks.io'
+    )
+  end
+
+  namespace :gpg do
+    RakeGPG.define_generate_key_task(
+      output_directory: 'config/secrets/ci',
+      name_prefix: 'gpg',
+      owner_name: 'InfraBlocks Maintainers',
+      owner_email: 'maintainers@infrablocks.io',
+      owner_comment: 'ruby_git_crypt CI Key'
+    )
+  end
+end
+
+namespace :secrets do
+  desc 'Regenerate all generatable secrets.'
+  task regenerate: %w[
+    encryption:passphrase:generate
+    keys:deploy:generate
+    keys:gpg:generate
+  ]
+end
+
+RuboCop::RakeTask.new
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+  t.options = %w[--embed-mixins --output-dir docs]
+end
+
+namespace :library do
+  desc 'Run all checks of the library'
+  task check: [:rubocop]
+
+  desc 'Attempt to automatically fix issues with the library'
+  task fix: [:'rubocop:autocorrect_all']
+end
+
+namespace :documentation do
+  desc 'Generate documentation'
+  task generate: [:yard]
+
+  desc 'Commit documentation'
+  task :commit, [:skip] do |_, args|
+    args.with_defaults(skip: 'true')
+
+    skip_ci = args.skip == 'true'
+
+    sh('git', 'commit',
+       '-a',
+       '-m', "Generate latest documentation#{skip_ci ? ' [ci skip]' : ''}")
+  end
+
+  desc 'Update documentation'
+  task update: %i[generate commit]
+end
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit)
+end
+
+RakeCircleCI.define_project_tasks(
+  namespace: :circle_ci,
+  project_slug: 'github/infrablocks/ruby_git_crypt'
+) do |t|
+  circle_ci_config =
+    YAML.load_file('config/secrets/circle_ci/config.yaml')
+
+  t.api_token = circle_ci_config['circle_ci_api_token']
+  t.environment_variables = {
+    ENCRYPTION_PASSPHRASE:
+        File.read('config/secrets/ci/encryption.passphrase')
+            .chomp
+  }
+  t.checkout_keys = []
+  t.ssh_keys = [
+    {
+      hostname: 'github.com',
+      private_key: File.read('config/secrets/ci/ssh.private')
+    }
+  ]
+end
+
+RakeGithub.define_repository_tasks(
+  namespace: :github,
+  repository: 'infrablocks/ruby_git_crypt'
+) do |t, args|
+  github_config =
+    YAML.load_file('config/secrets/github/config.yaml')
+
+  t.access_token = github_config['github_personal_access_token']
+  t.deploy_keys = [
+    {
+      title: 'CircleCI',
+      public_key: File.read('config/secrets/ci/ssh.public')
+    }
+  ]
+  t.branch_name = args.branch_name
+  t.commit_message = args.commit_message
+end
+
+namespace :pipeline do
+  desc 'Prepare CircleCI Pipeline'
+  task prepare: %i[
+    circle_ci:env_vars:ensure
+    circle_ci:checkout_keys:ensure
+    circle_ci:ssh_keys:ensure
+    github:deploy_keys:ensure
+  ]
+end
+
+namespace :version do
+  desc 'Bump version for specified type (pre, major, minor, patch)'
+  task :bump, [:type] do |_, args|
+    bump_version_for(args.type)
+  end
+end
+
+desc 'Release gem'
+task :release do
+  sh 'gem release --tag --push'
+end
+
+def bump_version_for(version_type)
+  sh "gem bump --version #{version_type} " \
+     '&& bundle install ' \
+     '&& export LAST_MESSAGE="$(git log -1 --pretty=%B)" ' \
+     '&& git commit -a --amend -m "${LAST_MESSAGE} [ci skip]"'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ruby_git_crypt'
+
+# 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/lib/ruby_git_crypt/commands/base.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'lino'
+
+require_relative '../errors'
+
+module RubyGitCrypt
+  module Commands
+    class Base
+      # rubocop:disable Metrics/AbcSize
+
+      # Constructs an instance of the command.
+      #
+      def initialize(**opts)
+        @binary  = opts[:binary]  || RubyGitCrypt.configuration.binary
+        @logger  = opts[:logger]  || RubyGitCrypt.configuration.logger
+        @options = opts[:options] || RubyGitCrypt.configuration.options
+        @stdin   = opts[:stdin]   || RubyGitCrypt.configuration.stdin
+        @stdout  = opts[:stdout]  || RubyGitCrypt.configuration.stdout
+        @stderr  = opts[:stderr]  || RubyGitCrypt.configuration.stderr
+      end
+
+      # rubocop:enable Metrics/AbcSize
+
+      # Executes the command instance.
+      #
+      # @param [Hash<String, Object>] parameters The parameters used to
+      #   invoke the command. See subclass documentation for details of
+      #   supported options.
+      # @param [Hash<String, Object>] invocation_options Additional options
+      #   controlling the invocation of the command.
+      # @option invocation_options [Hash<String, String>] :environment A map
+      #   of environment variables to expose at command invocation time.
+      def execute(parameters = {}, invocation_options = {})
+        do_before(parameters)
+        build_and_execute_command(parameters, invocation_options)
+        do_after(parameters)
+      rescue Open4::SpawnError
+        message = "Failed while running '#{command_name}'."
+        logger.error(message)
+        raise Errors::ExecutionError, message
+      end
+
+      protected
+
+      attr_reader :binary, :logger, :stdin, :stdout, :stderr
+
+      def build_and_execute_command(parameters, invocation_options)
+        command = build_command(parameters, invocation_options)
+
+        logger.debug("Running '#{command}'.")
+        command.execute(
+          stdin: stdin,
+          stdout: stdout,
+          stderr: stderr
+        )
+      end
+
+      def command_name
+        self.class.to_s.split('::')[-1].downcase
+      end
+
+      def do_before(_parameters); end
+
+      def do_after(_parameters); end
+
+      private
+
+      def build_command(parameters, invocation_options)
+        parameters = resolve_parameters(parameters)
+        environment = invocation_options[:environment] || {}
+
+        Lino::CommandLineBuilder
+          .for_command(@binary)
+          .with_environment_variables(environment)
+          .with_options_after_subcommands
+          .with_option_separator(' ')
+          .with_appliables(@options.resolve(options, parameters))
+          .with_subcommands(subcommands)
+          .with_arguments(arguments(parameters).compact.flatten).build
+      end
+
+      def resolve_parameters(parameters)
+        parameter_defaults(parameters)
+          .merge(parameters)
+          .merge(parameter_overrides(parameters))
+      end
+
+      def parameter_defaults(_parameters)
+        {}
+      end
+
+      def parameter_overrides(_parameters)
+        {}
+      end
+
+      def subcommands
+        []
+      end
+
+      def options
+        []
+      end
+
+      def arguments(_parameters)
+        []
+      end
+    end
+  end
+end