httpdisk 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 994e5e02b7c4cdbfbfcef40099558c8fa86a97538da74065a76321c8ee25e129
-  data.tar.gz: 97ae05c7a08e2c9b3bdccc01a9679d63ab35ce4fabc6307087fbfa7946fbecef
+  metadata.gz: 5e8bd4c770fe2a79111e7982da74b93e1e88c57621dbb3ea1b35568cdea0fe9e
+  data.tar.gz: f150fa699c26a0fe807e3320686095d380cf87210171d0d4eab5191108b9791a
 SHA512:
-  metadata.gz: '09d938bd3b32d743aab858883c94a760a27c40762a98d792b4135df29625995582aac5571aca0b510d0e85adc8b99436f2ede87196581544ae5759de35df9cfb'
-  data.tar.gz: 18c4f281814896c8d8a9e8d513416538770263b4b17dea5fbc5a5e5612af9f3b0f39d86b5e54919df6466a2e18e73f52e125ad9d167b1912c4f3acc2cb8b8a27
+  metadata.gz: e4e498b766f2ead95de238bb8825946a8ff2e58314ed0323fc384759fe299d73ee9491c54a36f4f2bfe03271175a936c5e6379c0fd3542a8a1d4dc17559c692b
+  data.tar.gz: 7fda2373b05a2103e6df000a2a83042aa5488572ca8c436806b6fbcb8703c8ed235a2a5fe721c064a2e456a280d934d5d68a2717cf44bff2eb54ec87aaa59fef

data/.github/workflows/test.yml

@@ -2,11 +2,7 @@ name: test
 
 on:
   push:
-    paths-ignore:
-      - '**.md'
   pull_request:
-    paths-ignore:
-      - '**.md'
   workflow_dispatch:
 
 jobs:
@@ -15,12 +11,12 @@ jobs:
       max-parallel: 3
       matrix:
         os: [ubuntu, macos]
-        ruby-version: [head, 3.0, 2.7]
+        ruby-version: [head, 3.2, 3.1]
     runs-on: ${{ matrix.os }}-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+      - uses: taiki-e/install-action@just
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
-      - run: bundle install
-      - run: bundle exec rake test
+      - run: just ci

data/.rubocop.yml

@@ -1,28 +1,14 @@
+require:
+  - standard
+
+inherit_gem:
+  standard: config/base.yml
+
 AllCops:
   NewCops: enable
   SuggestExtensions: false
+  TargetRubyVersion: 3.1
 
-# this is buggy in 2.7.0
-Style/HashTransformValues: { Enabled: false }
-
-# 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 }
+# a couple of overrides
+Style/RedundantReturn: { Enabled: false }
+Style/HashSyntax: { EnforcedShorthandSyntax: always }

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/Gemfile.lock

@@ -1,87 +1,84 @@
 PATH
   remote: .
   specs:
-    httpdisk (0.5.1)
+    httpdisk (1.0.0)
       content-type (~> 0.0)
-      faraday (~> 1.4)
+      faraday (~> 2.7)
       faraday-cookie_jar (~> 0.0)
-      faraday_middleware (~> 1.0)
-      slop (~> 4.8)
+      faraday-follow_redirects (~> 0.0)
+      slop (~> 4.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     coderay (1.1.3)
-    content-type (0.0.1)
-      parslet (~> 1.5)
+    content-type (0.0.2)
+      parslet (~> 2.0)
     crack (0.4.5)
       rexml
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    faraday (1.5.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-cookie_jar (0.0.7)
       faraday (>= 0.8.0)
       http-cookie (~> 1.0.0)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
-    faraday-patron (1.0.0)
-    faraday_middleware (1.0.0)
-      faraday (~> 1.0)
+    faraday-follow_redirects (0.3.0)
+      faraday (>= 1, < 3)
+    faraday-net_http (3.0.2)
     hashdiff (1.0.1)
-    http-cookie (1.0.4)
+    http-cookie (1.0.5)
       domain_name (~> 0.5)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    minitest (5.14.4)
-    mocha (1.11.2)
-    multipart-post (2.1.1)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    minitest (5.18.0)
+    mocha (2.0.2)
+      ruby2_keywords (>= 0.0.5)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
-    parslet (1.8.2)
-    pry (0.13.1)
+    parslet (2.0.0)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
-    rubocop (1.13.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.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.5.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
-    slop (4.9.1)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    slop (4.10.1)
+    standard (1.24.3)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.44.1)
+      rubocop-performance (= 1.15.2)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.7)
-    unicode-display_width (2.0.0)
-    webmock (3.12.2)
-      addressable (>= 2.3.6)
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
@@ -94,8 +91,8 @@ DEPENDENCIES
   mocha
   pry
   rake
-  rubocop (~> 1.13.0)
+  standard
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.3.18

data/README.md

@@ -171,8 +171,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 +185,11 @@ It can be challenging to use grep/ripgrep because cache files are compressed and
 
 ## Changelog
 
+#### 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
@@ -50,26 +50,26 @@ class Examples
       retry_options = {
         methods: %w[delete get head options patch post put trace],
         retry_statuses: (400..600).to_a,
-        retry_if: ->(_env, _err) { true },
+        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
@@ -99,13 +99,13 @@ class Examples
       retry_options = {
         methods: %w[delete get head options patch post put trace],
         retry_statuses: (400..600).to_a,
-        retry_if: ->(_env, _err) { true },
+        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,30 @@
-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.1.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 "content-type", "~> 0.0"
+  s.add_dependency "faraday", "~> 2.7"
+  s.add_dependency "faraday-cookie_jar", "~> 0.0"
+  s.add_dependency "faraday-follow_redirects", "~> 0.0"
+  s.add_dependency "slop", "~> 4.10"
 end

data/justfile

@@ -0,0 +1,59 @@
+
+# read gem version
+gemver := `cat lib/httpdisk/version.rb | grep -Eo "[0-9]+\.[0-9]+\.[0-9]+"`
+
+#
+# dev
+#
+
+default: test
+
+check: lint test
+
+fmt:
+  bundle exec rubocop -a
+
+lint:
+  @just banner lint...
+  bundle exec rubocop
+
+pry:
+  bundle exec pry -I lib -r httpdisk.rb
+
+test:
+  @just banner test...
+  bundle exec rake test
+
+watch:
+  @watchexec --watch lib --watch test --clear bundle exec rake test
+
+#
+# ci
+#
+
+ci:
+  bundle install
+  just check
+
+#
+# gem tasks
+#
+
+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
+#
+
+banner *ARGS:
+  @printf '\e[42;37;1m[%s] %-72s \e[m\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/lib/httpdisk/cache.rb

@@ -1,4 +1,5 @@
-require 'fileutils'
+require "fileutils"
+require "tempfile"
 
 module HTTPDisk
   # Disk cache for cache_keys => response. Files are compressed.
@@ -14,8 +15,8 @@ module HTTPDisk
         options[method]
       end
     end
-    alias force? force
-    alias force_errors? force_errors
+    alias_method :force?, :force
+    alias_method :force_errors?, :force_errors
 
     # Get cached response. If there is a cached error it will be raised.
     def read(cache_key)
@@ -72,10 +73,10 @@ module HTTPDisk
       return :force if force?
 
       begin
-        payload = Zlib::GzipReader.open(path, encoding: 'ASCII-8BIT') do
-          Payload.read(_1, peek: peek)
+        payload = Zlib::GzipReader.open(path, encoding: "ASCII-8BIT") do
+          Payload.read(_1, peek:)
         end
-      rescue StandardError => e
+      rescue => e
         raise "#{path}: #{e}"
       end
       return :force if force_errors? && payload.error?