httpdisk 0.5.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 534d055da653551f2dbf23db1c323c6858fcaa0bab09354491c175bffadf6d54
-  data.tar.gz: 825a6779fec3c5ce2828363e9022da231017ae2d13aa8fa88acff9692d8cd7fe
+  metadata.gz: a35e463161cc63ce5dd053c02f0d8b517259e4652728a5683b155e9b524d9363
+  data.tar.gz: 121bb5943d1777edab3a2de4afeac45fc115b09c8611f5e9e3ec45b1715f7d96
 SHA512:
-  metadata.gz: 750eaaca6bba23b1a8af351d916c79e470928c23cb3f6517662d6e99a7278c963cfe9dbbde564282d1367dd0f6bb34c166066b2babdb29d1c29f398fe9498245
-  data.tar.gz: 951f2f668018872bd4a970be506e4fc4c9dce302b4fa03e310eb0269dba428216bdd23a4da1a6fa86ad75f2e75b5d3fbe9988e1018cd328c6bbf6eb790d3406c
+  metadata.gz: 7af2b847f020f2a15ca729106702eb08cc577760603d996fe7053977538005bee054aad1a143b9a8aadc1dcb5003ae50e281c115b52647a54fc8395514458da1
+  data.tar.gz: fac9ff5f3cb745e267dd7a8f508599c3a5e83ddb6f0924d4c3ca078845c99146808eb7af55c6173ff98be397b5f349ea94b3046c83dfae9ad52498ada6b0b855

data/.github/workflows/test.yml

@@ -1,12 +1,11 @@
 name: test
 
 on:
-  push:
-    paths-ignore:
-      - '**.md'
   pull_request:
-    paths-ignore:
-      - '**.md'
+    paths-ignore: ["**.md"]
+  push:
+    branches: [main]
+    paths-ignore: ["**.md"]
   workflow_dispatch:
 
 jobs:
@@ -15,12 +14,17 @@ jobs:
       max-parallel: 3
       matrix:
         os: [ubuntu, macos]
-        ruby-version: [head, 3.0, 2.7]
+        ruby-version: [4, 3.4, 3.2]
     runs-on: ${{ matrix.os }}-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
+      - uses: actions/checkout@v6
+      - uses: jdx/mise-action@v3
         with:
-          ruby-version: ${{ matrix.ruby-version }}
-      - run: bundle install
-      - run: bundle exec rake test
+          experimental: true # required for post-install and binary rubies
+          mise_toml: |
+            [hooks]
+            postinstall = ['bundle install']
+            [tools]
+            just = "latest"
+            ruby = "${{ matrix.ruby-version }}"
+      - run: just check

data/.gitignore

@@ -1,3 +1,4 @@
-.ruby-version
 .vscode
 *.gem
+# gems don't need to include this since the gemspec is enough
+Gemfile.lock

data/.justfile

@@ -0,0 +1,51 @@
+default:
+  just --list
+
+#
+# dev
+#
+
+check: lint test
+
+fmt:
+  rubocop -a
+
+lint:
+  rubocop
+
+pry:
+  pry -I lib -r httpdisk.rb
+
+test:
+  rake test
+
+test-watch:
+  watchexec --stop-timeout=0 --clear=clear just test
+
+
+#
+# gem tasks
+#
+
+gemver := `cat lib/httpdisk/version.rb | grep -Eo "[0-9]+\.[0-9]+\.[0-9]+"`
+
+gem-push: check-git-status
+  just banner gem build...
+  gem build httpdisk.gemspec
+  just banner tag...
+  git tag -a "v{{gemver}}" -m "Tagging {{gemver}}"
+  git push --tags
+  just banner gem push...
+  gem push "httpdisk-{{gemver}}.gem"
+
+#
+# util
+#
+
+set quiet
+
+banner +args:
+  printf '\e[38;5;231;48;2;64;160;43;m{{BOLD}}[%s] %-72s {{NORMAL}}\n' "$(date +%H:%M:%S)" "{{args}}"
+
+check-git-status:
+  if [ ! -z "$(git status --porcelain)" ]; then echo "git status is dirty, bailing."; exit 1; fi

data/.rubocop.yml

@@ -1,28 +1,63 @@
+require:
+  - standard
+
+inherit_gem:
+  standard: config/ruby-3.3.yml
+  standard-custom: config/base.yml
+  standard-performance: config/base.yml
+
+plugins:
+  - standard-custom
+  - standard-performance
+  - rubocop-performance
+
 AllCops:
+  # We completely override Exclude rather than using `inherit_mode: merge` because
+  # we want to undo the exclusion of `bin/*` from rubocop-rails. So we must recreate the
+  # full exclusion list from all of our parent configs.
+  Exclude:
+    - .git/**/*
+    - tmp/**/*
+    - vendor/**/*
   NewCops: enable
   SuggestExtensions: false
 
-# this is buggy in 2.7.0
-Style/HashTransformValues: { Enabled: false }
+#
+# fight with standardrb!
+#
+
+Bundler/OrderedGems: { Enabled: true } # sort Gemfile
+Lint/MissingSuper: { Enabled: true } # must call `super`
+Lint/NonLocalExitFromIterator: { Enabled: false } # allow return in iterators
+Lint/RedundantDirGlobSort: { Enabled: true } # glob already sorted
+Naming/FileName: { Enabled: true } # duh
+Naming/MemoizedInstanceVariableName: { Enabled: true } # clean memo ivars
+Naming/MethodName: { Enabled: true } # keep method names conventional
+Performance/MapCompact: { Enabled: true } # filter_map-ish style
+Performance/RegexpMatch: { Enabled: false } # local style is fine
+Performance/SelectMap: { Enabled: true } # filter_map-ish style
+Style/BlockDelimiters: { Enabled: true } # do/end vs braces
+Style/ClassMethodsDefinitions: { Enabled: true } # avoid "class << self"
+Style/CollectionCompact: { Enabled: true } # compact over reject
+Style/CollectionMethods: { Enabled: true } # modern collection helpers
+Style/FrozenStringLiteralComment: { Enabled: true, EnforcedStyle: never } # nope
+Style/HashEachMethods: { Enabled: true } # each_key/value helpers
+Style/HashSyntax: { EnforcedShorthandSyntax: always } # modern hash syntax
+Style/HashTransformKeys: { Enabled: true } # transform_keys
+Style/HashTransformValues: { Enabled: true } # transform_values
+Style/MinMax: { Enabled: true } # minmax when fitting
+Style/NestedTernaryOperator: { Enabled: false } # we do this sometimes
+Style/NonNilCheck: { Enabled: false } # allow x != nil for clarity
+Style/PreferredHashMethods: { Enabled: true } # modern hash helpers
+Style/RedundantAssignment: { Enabled: false } # allows s=xxx;s=yyy;s
+Style/RedundantInitialize: { Enabled: true } # remove pointless initialize
+Style/RedundantReturn: { Enabled: false } # sometimes we do this while working on something
+Style/SelectByRegexp: { Enabled: true } # grep-like selection
+Style/StringConcatenation: { Enabled: true } # interpolation
+Style/SymbolArray: { Enabled: true } # %i for symbol arrays
+Style/TrailingCommaInArrayLiteral: { EnforcedStyleForMultiline: consistent_comma } # commas!!
+Style/TrailingCommaInHashLiteral: { EnforcedStyleForMultiline: consistent_comma } # commas!!
+Style/WordArray: { Enabled: true } # %w for word arrays
 
-# minimal personal preference
-Layout/CaseIndentation: { Enabled: false }
-Layout/EndAlignment: { EnforcedStyleAlignWith: variable }
-Lint/AssignmentInCondition: { Enabled: false }
-Lint/NonLocalExitFromIterator: { Enabled: false }
-Metrics: { Enabled: false }
-Naming/MethodParameterName: { Enabled: false }
-Naming/VariableNumber: { Enabled: false }
-Style/Documentation: { Enabled: false }
-Style/DoubleNegation: { Enabled: false }
-Style/EmptyCaseCondition: { Enabled: false }
-Style/FrozenStringLiteralComment: { Enabled: false }
-Style/GuardClause: { Enabled: false }
-Style/IfUnlessModifier: { Enabled: false }
-Style/NegatedIf: { Enabled: false }
-Style/NumericPredicate: { Enabled: false }
-Style/ParallelAssignment: { Enabled: false }
-Style/SoleNestedConditional: { Enabled: false }
-Style/StderrPuts: { Enabled: false }
-Style/TrailingCommaInArrayLiteral: { EnforcedStyleForMultiline: consistent_comma }
-Style/TrailingCommaInHashLiteral: { EnforcedStyleForMultiline: consistent_comma }
+# dup w/ standardrb?
+# Layout/EmptyLineBetweenDefs: { AllowAdjacentOneLineDefs: true } # allow compact one-liners

data/AGENTS.md

@@ -0,0 +1,56 @@
+# AGENTS
+
+## Workflow
+
+- Prefer `just` recipes vs raw cli
+- After code changes, run `just check`
+- Do not run rubocop or prettier directly; use `just fmt` or `just lint`
+- Don't be overly defensive, fail fast
+- Keep commit messages under 80 chars
+
+## Layout
+
+- Executables in `bin/`
+- Support code and domain logic in `lib/`
+
+## Coding Style
+
+- Be concise, we value that highly
+- Favor early returns, functional/immutable helpers, minimal, golden path
+- Keep code small, direct, and easy to scan
+- Prefer symbol-keyed hashes
+- Prefer `hash[:key]` over `fetch`; use `fetch` when a missing key should fail fast
+- Avoid `to_s` / `to_sym` churn unless it solves a real boundary problem
+- Methods with >=3 args are a code smell, esp. when forwarded; prefer context:, options:, or refactor
+- When using a shell, use argv arrays to avoid escaping issues
+- Avoid compatibility class aliases
+
+## Formatting
+
+- Trivial methods can be one-liners, only if <100 chars
+- If a file has several one-liners, group them under `# one-liners` at bottom and alphabetize
+- Use `_1` / `_2` for simple blocks when clear
+- Add a short top-level comment to each source file
+- A single line comment above complex code sections can be helpful
+
+## Bin Scripts
+
+- `Main` is a fine class name for things in bin/
+- Scripts in bin/ always use BinMain, Sloppier and TableTennis
+- Nice output with `ap` or writing CSVs to /tmp
+- Use `delegate:` for `options` with sloppier
+
+## Tests
+
+- New behavior should usually come with tests
+- Bug fixes should usually add or update a test
+- Keep tests small and deterministic
+- Avoid dependency injection, Ruby doesn't use that. Mock/stub
+
+## Defaults
+
+- Match the repo's existing test style
+- Prefer existing repo patterns over new abstractions
+- Prefer straightforward over clever
+- Keep comments light and useful
+- Be conservative about adding deps, core ext, or globals

data/Gemfile

@@ -1,11 +1,11 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec
 
 group :development, :test do
-  gem 'minitest'
-  gem 'mocha'
-  gem 'pry'
-  gem 'rake'
-  gem 'rubocop', '~> 1.13.0'
-  gem 'webmock'
+  gem "minitest"
+  gem "mocha"
+  gem "pry"
+  gem "rake"
+  gem "standard", require: false
+  gem "webmock"
 end

data/README.md

@@ -128,10 +128,12 @@ httpdisk will honor the `Content-Type` from responses. Unfortunately, it is enti
 httpdisk supports a few options:
 
 - `dir:` location for disk cache, defaults to `~/httpdisk`
+- `compress:` if false, write plain cache files instead of gzip
 - `expires:` when to expire cached requests, default is nil (never expire)
 - `force:` don't read anything from cache (but still write)
 - `force_errors:` don't read errors from cache (but still write)
 - `ignore_params:` array of query params to ignore when calculating cache_key
+- `key_transform:` proc that can mutate the `HTTPDisk::CacheKey`
 - `logger`: log requests to stderr, or pass your own logger
 - `utf8`: if true, force text response bodies to valid UTF-8
 
@@ -171,8 +173,9 @@ Specific to httpdisk:
 
 ## Goodies: httpdisk-grep
 
-The `httpdisk-grep` command makes it easy to search your cache directory.
-It can be challenging to use grep/ripgrep because cache files are compressed and JSON bodies often lack newlines. httpdisk-grep is the right tool for the job. See `httpdisk-grep --help`.
+The `httpdisk-grep` command makes it easy to search your cache directory. It can be challenging to use grep/ripgrep because cache files are compressed and JSON bodies often lack newlines. httpdisk-grep is the right tool for the job. See `httpdisk-grep --help`.
+
+An alternative is to use [ripgrep-all](https://github.com/phiresky/ripgrep-all) with the `--rga-accurate` flag. Ripgrep-all works well for large caches, though it lacks some of the niceties of `httpdisk-grep`.
 
 ## Limitations & Gotchas
 
@@ -184,6 +187,18 @@ It can be challenging to use grep/ripgrep because cache files are compressed and
 
 ## Changelog
 
+#### 1.0.1
+
+- added `compress: false` to disable compression (#9, thx `@aspiers`)
+- added key_transform for cache key customization
+- moved to Mise
+- deps
+
+#### 1.0
+
+- support faraday 2, minimum Ruby is 3.1 now
+- moved to Justfile and Standard
+
 #### 0.5
 
 - honor Content-Type

data/Rakefile

@@ -1,58 +1,5 @@
-require 'bundler/setup'
-require 'rake/testtask'
+require "bundler/setup"
+require "rake/testtask"
 
-# load the spec, we use it below
-spec = Gem::Specification.load('httpdisk.gemspec')
-
-#
-# testing
-# don't forget about TESTOPTS="--verbose" rake
-#
-
-# test (default)
-Rake::TestTask.new do
-  _1.libs << 'test'
-  _1.warning = false # https://github.com/lostisland/faraday/issues/1285
-end
+Rake::TestTask.new
 task default: :test
-
-# Watch rb files, run tests whenever something changes
-task :watch do
-  sh "find . -name '*.rb' | entr -c rake"
-end
-
-#
-# pry
-#
-
-task :pry do
-  sh 'pry -I lib -r httpdisk.rb'
-end
-
-#
-# rubocop
-#
-
-task :rubocop do
-  sh 'bundle exec rubocop -A .'
-end
-
-#
-# gem
-#
-
-task :build do
-  sh 'gem build --quiet httpdisk.gemspec'
-end
-
-task install: :build do
-  sh "gem install --quiet httpdisk-#{spec.version}.gem"
-end
-
-task release: %i[rubocop test build] do
-  raise "looks like git isn't clean" unless `git status --porcelain`.empty?
-
-  sh "git tag -a #{spec.version} -m 'Tagging #{spec.version}'"
-  sh 'git push --tags'
-  sh "gem push httpdisk-#{spec.version}.gem"
-end

data/bin/httpdisk

@@ -4,23 +4,23 @@
 # Main bin. Most of the interesting stuff is in HTTPDisk, for ease of testing.
 #
 
-$LOAD_PATH.unshift(File.join(__dir__, '../lib'))
+$LOAD_PATH.unshift(File.join(__dir__, "../lib"))
 
 BIN = File.basename($PROGRAM_NAME)
 
 def puts_error(s)
-  $stderr.puts "#{BIN}: #{s}"
+  warn "#{BIN}: #{s}"
 end
 
 #
 # Load the bare minimum and parse args with slop. We do this separately for speed.
 #
 
-require 'httpdisk/cli/args'
+require "httpdisk/cli/args"
 begin
   slop = HTTPDisk::Cli::Args.slop(ARGV)
 rescue Slop::Error => e
-  puts_error(e) if e.message != ''
+  puts_error(e) if e.message != ""
   puts_error("try '#{BIN} --help' for more information")
   exit 1
 end
@@ -29,15 +29,15 @@ end
 # now load everything and run
 #
 
-require 'httpdisk'
+require "httpdisk"
 main = HTTPDisk::Cli::Main.new(slop)
 begin
   main.run
-rescue StandardError => e
+rescue => e
   puts_error(e) if !main.options[:silent]
-  if ENV['HTTPDISK_DEBUG']
+  if ENV["HTTPDISK_DEBUG"]
     $stderr.puts
-    $stderr.puts e.backtrace.join("\n")
+    warn e.backtrace.join("\n")
   end
   exit 1
 end

data/bin/httpdisk-grep

@@ -4,23 +4,23 @@
 # Search an HTTPDisk cache, similar to grep.
 #
 
-$LOAD_PATH.unshift(File.join(__dir__, '../lib'))
+$LOAD_PATH.unshift(File.join(__dir__, "../lib"))
 
 BIN = File.basename($PROGRAM_NAME)
 
 def puts_error(s)
-  $stderr.puts "#{BIN}: #{s}"
+  warn "#{BIN}: #{s}"
 end
 
 #
 # Load the bare minimum and parse args with slop. We do this separately for speed.
 #
 
-require 'httpdisk/grep/args'
+require "httpdisk/grep/args"
 begin
   slop = HTTPDisk::Grep::Args.slop(ARGV)
 rescue Slop::Error => e
-  puts_error(e) if e.message != ''
+  puts_error(e) if e.message != ""
   puts_error("try '#{BIN} --help' for more information")
   exit 1
 end
@@ -29,18 +29,18 @@ end
 # now load everything and run
 #
 
-require 'httpdisk'
+require "httpdisk"
 
 main = HTTPDisk::Grep::Main.new(slop)
 begin
   success = main.run
   exit 1 if !success
-rescue StandardError => e
+rescue => e
   puts_error(e)
-  if ENV['HTTPDISK_DEBUG']
+  if ENV["HTTPDISK_DEBUG"]
     $stderr.puts
-    $stderr.puts e.class
-    $stderr.puts e.backtrace.join("\n")
+    warn e.class
+    warn e.backtrace.join("\n")
   end
   exit 2
 end

data/examples.rb

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift(File.join(__dir__, 'lib'))
+$LOAD_PATH.unshift(File.join(__dir__, "lib"))
 
-require 'httpdisk'
-require 'json'
+require "httpdisk"
+require "json"
 
 class Examples
   #
@@ -15,12 +15,12 @@ class Examples
       _1.use :httpdisk, force: true
     end
 
-    faraday.get('http://www.google.com', nil, { "User-Agent": 'test-agent' })
-    faraday.get('http://www.google.com', { q: 'ruby' })
-    faraday.post('http://httpbin.org/post', 'name=hello')
+    faraday.get("http://www.google.com", nil, {"User-Agent": "test-agent"})
+    faraday.get("http://www.google.com", {q: "ruby"})
+    faraday.post("http://httpbin.org/post", "name=hello")
 
     3.times { puts }
-    response = faraday.get('http://httpbingo.org/get')
+    response = faraday.get("http://httpbingo.org/get")
     puts response.env.url
     puts JSON.pretty_generate(JSON.parse(response.body))
   end
@@ -33,8 +33,8 @@ class Examples
   def better
     faraday = Faraday.new do
       # options
-      _1.headers['User-Agent'] = 'HTTPDisk'
-      _1.params.update(hello: 'world')
+      _1.headers["User-Agent"] = "HTTPDisk"
+      _1.params.update(hello: "world")
       _1.options.timeout = 10
 
       # middleware
@@ -51,25 +51,25 @@ class Examples
         methods: %w[delete get head options patch post put trace],
         retry_statuses: (400..600).to_a,
         retry_if: ->(_env, _err) { true },
-      }.freeze
+      }
       _1.request :retry, retry_options
     end
 
     # get w/ params
     3.times { puts }
-    response = faraday.get('http://httpbingo.org/get', { q: 'query' })
+    response = faraday.get("http://httpbingo.org/get", {q: "query"})
     puts response.env.url
     puts JSON.pretty_generate(response.body)
 
     # post w/ encoded form body
     3.times { puts }
-    response = faraday.post('http://httpbingo.org/post', 'a=1&b=2')
+    response = faraday.post("http://httpbingo.org/post", "a=1&b=2")
     puts response.env.url
     puts JSON.pretty_generate(response.body)
 
     # post w/ auto-encoded form hash
     3.times { puts }
-    response = faraday.post('http://httpbingo.org/post', { input: 'body' })
+    response = faraday.post("http://httpbingo.org/post", {input: "body"})
     puts response.env.url
     puts JSON.pretty_generate(response.body)
   end
@@ -82,8 +82,8 @@ class Examples
   def json
     faraday = Faraday.new do
       # options
-      _1.headers['User-Agent'] = 'HTTPDisk'
-      _1.params.update(hello: 'world')
+      _1.headers["User-Agent"] = "HTTPDisk"
+      _1.params.update(hello: "world")
       _1.options.timeout = 10
 
       # middleware
@@ -100,12 +100,12 @@ class Examples
         methods: %w[delete get head options patch post put trace],
         retry_statuses: (400..600).to_a,
         retry_if: ->(_env, _err) { true },
-      }.freeze
+      }
       _1.request :retry, retry_options
     end
 
     3.times { puts }
-    response = faraday.post('http://httpbingo.org/post', { this_is: ['json'] })
+    response = faraday.post("http://httpbingo.org/post", {this_is: ["json"]})
     puts response.env.url
     puts JSON.pretty_generate(response.body)
   end

data/httpdisk.gemspec

@@ -1,29 +1,33 @@
-require_relative 'lib/httpdisk/version'
+require_relative "lib/httpdisk/version"
 
 Gem::Specification.new do |s|
-  s.name = 'httpdisk'
+  s.name = "httpdisk"
   s.version = HTTPDisk::VERSION
-  s.authors = ['Adam Doppelt']
-  s.email = 'amd@gurge.com'
+  s.authors = ["Adam Doppelt"]
+  s.email = "amd@gurge.com"
 
-  s.summary = 'httpdisk - disk cache for faraday'
-  s.description = 'httpdisk works with faraday to aggressively cache responses on disk.'
-  s.homepage = 'http://github.com/gurgeous/httpdisk'
-  s.license = 'MIT'
-  s.required_ruby_version = '>= 2.7.0'
+  s.summary = "httpdisk - disk cache for faraday"
+  s.description = "httpdisk works with faraday to aggressively cache responses on disk."
+  s.homepage = "http://github.com/gurgeous/httpdisk"
+  s.license = "MIT"
+  s.required_ruby_version = ">= 3.2.0"
+  s.metadata["rubygems_mfa_required"] = "true"
 
   # what's in the gem?
   s.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { _1.match(%r{^test/}) }
   end
-  s.bindir = 'bin'
+  s.bindir = "bin"
   s.executables = s.files.grep(%r{^#{s.bindir}/}) { File.basename(_1) }
-  s.require_paths = ['lib']
+  s.require_paths = ["lib"]
 
   # gem dependencies
-  s.add_dependency 'content-type', '~> 0.0'
-  s.add_dependency 'faraday', '~> 1.4'
-  s.add_dependency 'faraday-cookie_jar', '~> 0.0'
-  s.add_dependency 'faraday_middleware', '~> 1.0'
-  s.add_dependency 'slop', '~> 4.8'
+  s.add_dependency "base64", "~> 0.3" # required for 3.4
+  s.add_dependency "cgi", "~> 0.5" # required for 4
+  s.add_dependency "content-type", "~> 0.0"
+  s.add_dependency "faraday", "~> 2.14"
+  s.add_dependency "faraday-cookie_jar", "~> 0.0"
+  s.add_dependency "faraday-follow_redirects", "~> 0.5"
+  s.add_dependency "ostruct", "~> 0.6" # required for 3.5
+  s.add_dependency "slop", "~> 4.10"
 end