teak_util 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92731ed522f798d250b3b9b317c92ba9f17eb3dba21574235fefe7d1938de729
-  data.tar.gz: cad15ef3aa288b56a26574741d6bd22b2fe1377fcd3846656f7d9255ac5ba1d7
+  metadata.gz: 5ed306a1c0d8b1bd16fad11431b1d0ed8506ff01fbb536c5db9e1562ec12c096
+  data.tar.gz: 83ee0167f13ab63f51588a63f2f60246bde93032ad6798f8a78b29c0c7872470
 SHA512:
-  metadata.gz: 1b6cd53052c02325944ce90f837c085e4fe0bf1ebc5b27c565f4714be5b84308405cec3b0a57fa4e05ad49c4ed9b7f6b803fbf6f96152eebffcc8340b47a625c
-  data.tar.gz: 6cef854be60d4fdc20453e421f158bd4201eaae51c1ae165c392ce76f0171e27f9c81374284ccab7f59263c02db6edcb33dc9e697c588bab4c6f81c15139ea08
+  metadata.gz: 2b6d30e4e71b5a4b386ea1a6327df0ae877b4c1975d3976e912d37e05b5a4a23c0222a0c5a892c9feb6e6d189a049e6d12da228fe4a23cd9bc634a8c6e576d3e
+  data.tar.gz: 558b5223f4600b4e9405f545c8aea2de3c373c6cb4266546f8cd72beb6c44d238e4419df21b171c0caaae468e1b57758aaa2934db967a95c20d3b368deaf03a6

data/.circleci/config.yml

@@ -1,13 +1,139 @@
 version: 2.1
+
+references:
+  RUBY_IMAGE: &RUBY_IMAGE
+    cimg/ruby:3.3.9
+  CACHE_KEY: &BUNDLE_CACHE_KEY
+    v2-teak_util-bundle-{{ checksum "Gemfile.lock" }}
+
 jobs:
+  refresh_ruby_deps:
+    docker:
+      - image: *RUBY_IMAGE
+        environment:
+          RACK_ENV: test
+    working_directory: ~/teak_util-build
+    steps:
+      - checkout
+      - restore_cache:
+          key: *BUNDLE_CACHE_KEY
+      - run: bundle config set --local path 'vendor/bundle'
+      - run: bundle install --jobs 3 --retry 3
+      - save_cache:
+          key: *BUNDLE_CACHE_KEY
+          paths:
+            - ~/teak_util-build/vendor/bundle
+            - ~/teak_util-build/.bundle
+
   build:
     docker:
-      - image: ruby:3.0.0
+      - image: *RUBY_IMAGE
+    working_directory: ~/teak_util-build
+    steps:
+      - checkout
+      - restore_cache:
+          key: *BUNDLE_CACHE_KEY
+
+      - run:
+          name: Run the build task
+          command: |
+            bundle exec rake build
+
+  rspec:
+    docker:
+      - image: *RUBY_IMAGE
+        environment:
+          RACK_ENV: test
+    working_directory: ~/teak_util-build
     steps:
       - checkout
+      - restore_cache:
+          key: *BUNDLE_CACHE_KEY
+
+      - run: mkdir ~/rspec
       - run:
-          name: Run the default task
           command: |
-            gem install bundler -v 2.2.3
-            bundle install
-            bundle exec rake
+            circleci tests glob "spec/**/*_spec.rb" | circleci tests run --command="xargs bundle exec rspec --format progress --format RspecJunitFormatter -o ~/rspec/rspec.xml" --verbose --split-by=timings
+      - store_test_results:
+          path: ~/rspec
+      - store_artifacts:
+          path: ~/rspec/rspec.xml
+      - run: mv ./coverage /tmp/coverage_${CIRCLE_NODE_INDEX}
+      - persist_to_workspace:
+          root: /tmp
+          paths:
+          - "coverage_*"
+
+  # report_coverage:
+  #   docker:
+  #     - image: *RUBY_IMAGE
+  #       environment:
+  #         RAILS_ENV: development
+  #   working_directory: ~/teak_util-build
+  #   steps:
+  #     - checkout
+  #     - restore_cache:
+  #         key: *BUNDLE_CACHE_KEY
+  #     - attach_workspace:
+  #         at: /tmp/coverage
+  #     - run: bundle exec rake report:coverage
+
+  # lint_bundler_audit:
+  #   docker:
+  #     - image: *RUBY_IMAGE
+  #   working_directory: ~/teak_util-build
+  #   steps:
+  #     - checkout
+  #     - restore_cache:
+  #         key: *BUNDLE_CACHE_KEY
+  #     - run: bundle exec rake lint:bundler_audit
+
+  # lint_rubocop:
+  #   docker:
+  #     - image: *RUBY_IMAGE
+  #   working_directory: ~/teak_util-build
+  #   steps:
+  #     - checkout
+  #     - restore_cache:
+  #         key: *BUNDLE_CACHE_KEY
+  #     - run: bundle exec rake lint:rubocop
+
+  # report_rubocop:
+  #   docker:
+  #     - image: *RUBY_IMAGE
+  #       environment:
+  #         RAILS_ENV: development
+  #   working_directory: ~/teak_util-build
+  #   steps:
+  #     - checkout
+  #     - restore_cache:
+  #         key: *BUNDLE_CACHE_KEY
+  #     - run: bundle exec rake report:rubocop
+
+workflows:
+  default:
+    jobs:
+      - refresh_ruby_deps
+      - rspec:
+          requires:
+            - refresh_ruby_deps
+      # - report_coverage:
+      #     requires:
+      #       - rspec
+      #     context:
+      #       - DataDog
+      # - lint_bundler_audit:
+      #     requires:
+      #       - refresh_ruby_deps
+      #       - refresh_js_deps
+      # - lint_rubocop:
+      #     requires:
+      #       - refresh_ruby_deps
+      # - report_rubocop:
+      #     requires:
+      #       - refresh_ruby_deps
+      #     context:
+      #       - DataDog
+      - build:
+          requires:
+            - rspec

data/.ruby-gemset

@@ -0,0 +1 @@
+teak_util

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.3.9

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.3.0
+
+ENHANCEMENTS:
+
+* Added TestDatabaseName for deriving worktree-scoped test database names, and
+  purging databases left behind by worktrees that no longer exist.
+
+## 0.2.0
+
+* Jettison compatibility for Ruby 3.2 and below.
+
+## 0.1.3
+
+ENHANCEMENTS:
+
+* Added Storage::S3#bucket_name to read back configured bucket name.
+
 ## 0.1.2
 
 ENHANCEMENTS:

data/Gemfile

@@ -12,3 +12,6 @@ gem "rspec", "~> 3.0"
 gem 'timecop', '~> 0.9.8'
 
 gem 'simplecov', '~> 0.22.0'
+gem 'rspec_junit_formatter'
+
+gem "nokogiri", "~> 1.18"

data/Gemfile.lock

@@ -1,97 +1,114 @@
 PATH
   remote: .
   specs:
-    teak_util (0.1.2)
+    teak_util (0.3.0)
       aws-sdk-s3 (>= 1.102)
       business_flow (>= 0.18.0)
       mime-types (>= 3)
-      rubyzip (~> 2.3)
+      rubyzip (>= 2.3, < 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.1.2)
-      activesupport (= 7.1.2)
-    activesupport (7.1.2)
+    activemodel (8.0.3)
+      activesupport (= 8.0.3)
+    activesupport (8.0.3)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    aws-eventstream (1.3.0)
-    aws-partitions (1.880.0)
-    aws-sdk-core (3.190.2)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    aws-eventstream (1.4.0)
+    aws-partitions (1.1168.0)
+    aws-sdk-core (3.233.0)
       aws-eventstream (~> 1, >= 1.3.0)
-      aws-partitions (~> 1, >= 1.651.0)
-      aws-sigv4 (~> 1.8)
+      aws-partitions (~> 1, >= 1.992.0)
+      aws-sigv4 (~> 1.9)
+      base64
+      bigdecimal
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-kms (1.76.0)
-      aws-sdk-core (~> 3, >= 3.188.0)
-      aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.142.0)
-      aws-sdk-core (~> 3, >= 3.189.0)
+      logger
+    aws-sdk-kms (1.113.0)
+      aws-sdk-core (~> 3, >= 3.231.0)
+      aws-sigv4 (~> 1.5)
+    aws-sdk-s3 (1.199.1)
+      aws-sdk-core (~> 3, >= 3.231.0)
       aws-sdk-kms (~> 1)
-      aws-sigv4 (~> 1.8)
-    aws-sigv4 (1.8.0)
+      aws-sigv4 (~> 1.5)
+    aws-sigv4 (1.12.1)
       aws-eventstream (~> 1, >= 1.0.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.5)
-    business_flow (0.19.3)
-      activemodel (>= 4.2, < 8)
-      activesupport (>= 4.2, < 8)
-    concurrent-ruby (1.2.3)
-    connection_pool (2.4.1)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    drb (2.2.0)
-      ruby2_keywords
-    i18n (1.14.1)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.3)
+    business_flow (0.20.0)
+      activemodel (>= 4.2, < 8.1)
+      activesupport (>= 4.2, < 8.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.4)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    drb (2.2.3)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     jmespath (1.6.2)
-    mime-types (3.5.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2023.1205)
-    minitest (5.21.1)
-    mutex_m (0.2.0)
-    rake (13.0.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    logger (1.7.0)
+    mime-types (3.7.0)
+      logger
+      mime-types-data (~> 3.2025, >= 3.2025.0507)
+    mime-types-data (3.2025.0924)
+    mini_portile2 (2.8.9)
+    minitest (5.25.5)
+    nokogiri (1.18.10)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    racc (1.8.1)
+    rake (13.3.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    ruby2_keywords (0.0.5)
-    rubyzip (2.3.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubyzip (3.1.1)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    timecop (0.9.8)
+    timecop (0.9.10)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    uri (1.0.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  nokogiri (~> 1.18)
   rake (~> 13.0)
   rspec (~> 3.0)
+  rspec_junit_formatter
   simplecov (~> 0.22.0)
   teak_util!
   timecop (~> 0.9.8)
 
 BUNDLED WITH
-   2.1.4
+   2.7.2

data/lib/teak_util/storage/make_externally_available_file.rb

@@ -47,7 +47,7 @@ module TeakUtil
       def convert_data
         self.data =
           if multiple_files?
-            Zip::File.open_buffer(StringIO.new(String.new)) do |zip_file|
+            Zip::File.open_buffer(StringIO.new(String.new), create: true) do |zip_file|
               value.each do |(fname, contents)|
                 zip_file.file.open(fname, +'w') do |file|
                   file.write(contents)
@@ -55,7 +55,7 @@ module TeakUtil
               end
             end.string
           elsif compress
-            Zip::File.open_buffer(StringIO.new(String.new)) do |zip_file|
+            Zip::File.open_buffer(StringIO.new(String.new), create: true) do |zip_file|
               zip_file.file.open(key, +'w') do |file|
                 file.write(value)
               end

data/lib/teak_util/storage/s3.rb

@@ -69,6 +69,11 @@ module TeakUtil
         @bucket.object(path).presigned_url(:get, expires_in: expires_in.to_i)
       end
 
+      # Returns the name of the bucket.
+      def bucket_name
+        @bucket.name
+      end
+
     private
 
       def prefixed_path(key)

data/lib/teak_util/test_database_name.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'English'
+require 'set'
+
+module TeakUtil
+  # Derives a worktree-scoped test database name from a checkout's directory basename,
+  # and purges databases left behind by worktrees that no longer exist. Deliberately
+  # standalone-requirable (no dependency on the rest of teak_util) since it's typically
+  # evaluated from an ERB database config at app boot.
+  module TestDatabaseName
+    MAX_IDENTIFIER_LENGTH = 64 # MySQL's identifier limit
+    HASH_LENGTH = 8
+
+    DEFAULT_WORKTREE_LISTER = lambda do
+      output = `git worktree list --porcelain 2>/dev/null`
+      raise '`git worktree list --porcelain` failed. Are you in a git repository?' unless $CHILD_STATUS.success?
+
+      output
+    end
+
+    module_function
+
+    # @param basename [String] the checkout's directory basename
+    # @param base [String] the database name used by the main (non-worktree) checkout,
+    #   e.g. 'taro_posts_test'
+    # @param main_worktree [String] the directory name of the main checkout, e.g. 'taro' —
+    #   compared case-insensitively so `main_worktree` gets `base` back unmodified
+    def for_worktree(basename, base:, main_worktree:)
+      downcased = basename.downcase
+      return base if downcased == main_worktree.downcase
+
+      # core_app's `CREATE DATABASE #{db}` is unquoted, so a non-identifier character
+      # is a syntax error, not a style choice.
+      sanitized = downcased.gsub(/[^a-z0-9]+/, '_')
+      budget = MAX_IDENTIFIER_LENGTH - base.length - 1 # 1 for the joining underscore
+      raise ArgumentError, "base #{base.inspect} leaves no room for a worktree suffix" if budget <= 0
+
+      if sanitized.length > budget
+        hash = Digest::SHA256.hexdigest(sanitized)[0, HASH_LENGTH]
+        truncated_length = budget - hash.length - 1 # 1 for the underscore before the hash
+        raise ArgumentError, "base #{base.inspect} leaves no room for a worktree suffix" if truncated_length <= 0
+
+        sanitized = "#{sanitized[0, truncated_length]}_#{hash}"
+      end
+
+      "#{base}_#{sanitized}"
+    end
+
+    # Lists and drops test databases for worktrees that no longer exist.
+    #
+    # @param connection [#fetch, #run] a Sequel-connection-shaped object
+    # @param base [String] as for #for_worktree
+    # @param main_worktree [String] as for #for_worktree
+    # @param input [#gets] prompt source
+    # @param output [#puts, #print] prompt/progress sink
+    # @param worktree_lister [#call] returns `git worktree list --porcelain` output;
+    #   must raise on failure — the default does. A custom lister inherits that
+    #   contract; a lister that swallows a failed listing will read as "no active
+    #   worktrees" and offer to drop every database this basename owns.
+    def purge(connection:, base:, main_worktree:, input: $stdin, output: $stdout,
+              worktree_lister: DEFAULT_WORKTREE_LISTER)
+      escaped_base = base.gsub(/[\\_%]/) { |match| "\\#{match}" }
+      rows = connection.fetch("SHOW DATABASES LIKE '#{escaped_base}\\_%'").map { |row| row.values.first }
+
+      active = worktree_lister.call.lines
+                 .select { |line| line.start_with?('worktree ') }
+                 .map { |line| File.basename(line.sub('worktree ', '').strip) }
+                 .to_set { |basename| for_worktree(basename, base: base, main_worktree: main_worktree) }
+
+      defunct = rows - active.to_a
+
+      if defunct.empty?
+        output.puts 'No defunct worktree test databases found.'
+        return
+      end
+
+      output.puts "Found #{defunct.size} defunct worktree test database(s):"
+      defunct.each { |db| output.puts "  - #{db}" }
+
+      output.print "\nDrop all of them? [y/N] "
+      answer = input.gets&.strip
+      unless answer&.match?(/\Ay(es)?\z/i)
+        output.puts 'Aborted.'
+        return
+      end
+
+      defunct.each do |db|
+        output.puts "Dropping #{db}..."
+        connection.run("DROP DATABASE `#{db}`")
+      end
+      output.puts 'Done.'
+    end
+  end
+end

data/lib/teak_util/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TeakUtil
-  VERSION = "0.1.2"
+  VERSION = "0.3.0"
 end

data/teak_util.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "A collection of utilities used by multiple projects at Teak"
   spec.homepage      = "https://github.com/GoCarrot/teak_util"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
 
   spec.license = "Apache-2.0"
 
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "aws-sdk-s3", ">= 1.102"
   spec.add_dependency "business_flow", ">= 0.18.0"
   spec.add_dependency "mime-types", ">= 3"
-  spec.add_dependency "rubyzip", "~> 2.3"
+  spec.add_dependency "rubyzip", ">= 2.3", "< 4.0"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: teak_util
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Alex Scarborough
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -56,17 +55,22 @@ dependencies:
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
-description:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 email:
 - alex@teak.io
 executables: []
@@ -76,6 +80,8 @@ files:
 - ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -88,6 +94,7 @@ files:
 - lib/teak_util.rb
 - lib/teak_util/storage/make_externally_available_file.rb
 - lib/teak_util/storage/s3.rb
+- lib/teak_util/test_database_name.rb
 - lib/teak_util/version.rb
 - teak_util.gemspec
 homepage: https://github.com/GoCarrot/teak_util
@@ -98,7 +105,6 @@ metadata:
   homepage_uri: https://github.com/GoCarrot/teak_util
   source_code_uri: https://github.com/GoCarrot/teak_util
   changelog_uri: https://github.com/GoCarrot/teak_util/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,15 +112,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A collection of utilities used by multiple projects at Teak
 test_files: []