httpdisk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e8bd4c770fe2a79111e7982da74b93e1e88c57621dbb3ea1b35568cdea0fe9e
-  data.tar.gz: f150fa699c26a0fe807e3320686095d380cf87210171d0d4eab5191108b9791a
+  metadata.gz: a35e463161cc63ce5dd053c02f0d8b517259e4652728a5683b155e9b524d9363
+  data.tar.gz: 121bb5943d1777edab3a2de4afeac45fc115b09c8611f5e9e3ec45b1715f7d96
 SHA512:
-  metadata.gz: e4e498b766f2ead95de238bb8825946a8ff2e58314ed0323fc384759fe299d73ee9491c54a36f4f2bfe03271175a936c5e6379c0fd3542a8a1d4dc17559c692b
-  data.tar.gz: 7fda2373b05a2103e6df000a2a83042aa5488572ca8c436806b6fbcb8703c8ed235a2a5fe721c064a2e456a280d934d5d68a2717cf44bff2eb54ec87aaa59fef
+  metadata.gz: 7af2b847f020f2a15ca729106702eb08cc577760603d996fe7053977538005bee054aad1a143b9a8aadc1dcb5003ae50e281c115b52647a54fc8395514458da1
+  data.tar.gz: fac9ff5f3cb745e267dd7a8f508599c3a5e83ddb6f0924d4c3ca078845c99146808eb7af55c6173ff98be397b5f349ea94b3046c83dfae9ad52498ada6b0b855

data/.github/workflows/test.yml

@@ -1,8 +1,11 @@
 name: test
 
 on:
-  push:
   pull_request:
+    paths-ignore: ["**.md"]
+  push:
+    branches: [main]
+    paths-ignore: ["**.md"]
   workflow_dispatch:
 
 jobs:
@@ -11,12 +14,17 @@ jobs:
       max-parallel: 3
       matrix:
         os: [ubuntu, macos]
-        ruby-version: [head, 3.2, 3.1]
+        ruby-version: [4, 3.4, 3.2]
     runs-on: ${{ matrix.os }}-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: taiki-e/install-action@just
-      - uses: ruby/setup-ruby@v1
+      - uses: actions/checkout@v6
+      - uses: jdx/mise-action@v3
         with:
-          ruby-version: ${{ matrix.ruby-version }}
-      - run: just ci
+          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

@@ -2,13 +2,62 @@ require:
   - standard
 
 inherit_gem:
-  standard: config/base.yml
+  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
-  TargetRubyVersion: 3.1
 
-# a couple of overrides
-Style/RedundantReturn: { Enabled: false }
-Style/HashSyntax: { EnforcedShorthandSyntax: always }
+#
+# 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
+
+# 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/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
 
@@ -185,6 +187,13 @@ An alternative is to use [ripgrep-all](https://github.com/phiresky/ripgrep-all)
 
 ## 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

data/examples.rb

@@ -50,8 +50,8 @@ 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 }
-      }.freeze
+        retry_if: ->(_env, _err) { true },
+      }
       _1.request :retry, retry_options
     end
 
@@ -99,8 +99,8 @@ 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 }
-      }.freeze
+        retry_if: ->(_env, _err) { true },
+      }
       _1.request :retry, retry_options
     end
 

data/httpdisk.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   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.required_ruby_version = ">= 3.2.0"
   s.metadata["rubygems_mfa_required"] = "true"
 
   # what's in the gem?
@@ -22,9 +22,12 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # gem dependencies
+  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.7"
+  s.add_dependency "faraday", "~> 2.14"
   s.add_dependency "faraday-cookie_jar", "~> 0.0"
-  s.add_dependency "faraday-follow_redirects", "~> 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

data/lib/httpdisk/cache.rb

@@ -1,8 +1,9 @@
 require "fileutils"
 require "tempfile"
+require "zlib"
 
 module HTTPDisk
-  # Disk cache for cache_keys => response. Files are compressed.
+  # Disk cache for cache_keys => response. Files may be compressed or plain.
   class Cache
     attr_reader :options
 
@@ -10,11 +11,12 @@ module HTTPDisk
       @options = options
     end
 
-    %i[dir expires force force_errors].each do |method|
+    %i[compress dir expires force force_errors].each do |method|
       define_method(method) do
         options[method]
       end
     end
+    alias_method :compress?, :compress
     alias_method :force?, :force
     alias_method :force_errors?, :force_errors
 
@@ -37,15 +39,11 @@ module HTTPDisk
       path = diskpath(cache_key)
       FileUtils.mkdir_p(File.dirname(path))
 
-      # Atomically write gzipped payload. Put our underlying Tempfile into
-      # binmode to avoid accidental newline conversion or string encoding. Not
-      # required for *nix systems, but I've heard rumors it's helpful for
-      # Windows.
+      # Atomically write payload. Put our underlying Tempfile into binmode to
+      # avoid accidental newline conversion or string encoding. Not required for
+      # *nix systems, but I've heard rumors it's helpful for Windows.
       Tempfile.new(binmode: true).tap do |tmp|
-        Zlib::GzipWriter.new(tmp).tap do |gzip|
-          payload.write(gzip)
-          gzip.close
-        end
+        write_payload(tmp, payload)
         tmp.close
         FileUtils.mv(tmp.path, path)
       end
@@ -73,9 +71,7 @@ module HTTPDisk
       return :force if force?
 
       begin
-        payload = Zlib::GzipReader.open(path, encoding: "ASCII-8BIT") do
-          Payload.read(_1, peek:)
-        end
+        payload = read_payload(path, peek:)
       rescue => e
         raise "#{path}: #{e}"
       end
@@ -88,5 +84,27 @@ module HTTPDisk
     def expired?(path)
       expires && File.stat(path).mtime < Time.now - expires
     end
+
+    def read_payload(path, peek:)
+      if compressed?(path)
+        Zlib::GzipReader.open(path, encoding: "ASCII-8BIT") { Payload.read(_1, peek:) }
+      else
+        File.open(path, "rb") { Payload.read(_1, peek:) }
+      end
+    end
+
+    def write_payload(tmp, payload)
+      if compress?
+        Zlib::GzipWriter.new(tmp).tap do |gzip|
+          payload.write(gzip)
+          gzip.close
+        end
+      else
+        payload.write(tmp)
+      end
+    end
+
+    # check got gz magic
+    def compressed?(path) = File.binread(path, 2) == "\x1f\x8b".b
   end
 end

data/lib/httpdisk/cache_key.rb

@@ -4,63 +4,86 @@ require "uri"
 
 module HTTPDisk
   class CacheKey
-    attr_reader :env, :ignore_params
+    PARTS = %i[http_method scheme host port path query body].freeze
+
+    attr_accessor :env, :ignore_params
+    attr_reader(*PARTS)
 
     def initialize(env, ignore_params: [])
       @env, @ignore_params = env, ignore_params
 
+      # setup defaults, user can override
+      @http_method = env.method
+      @scheme = url.scheme
+      @host = url.host
+      @port = default_port? ? nil : url.port
+      @path = (url.path == "/") ? nil : url.path
+      @query = url.query
+      @body = env.request_body ? bodykey : nil
+
       # sanity checks
-      raise InvalidUrl, "http/https required #{env.url.inspect}" if !/^https?$/.match?(env.url.scheme)
-      raise InvalidUrl, "hostname required #{env.url.inspect}" if !env.url.host
+      raise InvalidUrl, "http/https required #{env.url.inspect}" if !/^https?$/.match?(scheme)
+      raise InvalidUrl, "hostname required #{env.url.inspect}" if !host
     end
 
-    def url
-      env.url
-    end
+    def query_params
+      return {} if blank?(query)
 
-    # Cache key (memoized)
-    def key
-      @key ||= calculate_key
+      CGI.parse(query).transform_values do
+        (_1.length == 1) ? _1.first : _1
+      end
     end
 
-    # md5(key) (memoized)
-    def digest
-      @digest ||= Digest::MD5.hexdigest(key)
-    end
+    # one-liners
+    def blank?(value) = value.nil? || value == ""
+    def default_port? = url.default_port == url.port
+    def digest = @digest ||= Digest::MD5.hexdigest(key)
+    def diskpath = @diskpath ||= File.join(hostdir, digest[0, 3], digest[3..])
+    def invalidate! = @digest = @key = @diskpath = nil
+    def key = @key ||= key0
+    def to_s = key
+    def url = env.url
 
-    # Relative path for this cache key based on hostdir & digest.
-    def diskpath
-      @diskpath ||= File.join(hostdir, digest[0, 3], digest[3..])
+    def query_params=(value)
+      self.query = URI.encode_www_form(flatten_query_params(value))
     end
 
-    def to_s
-      key
+    # the parts that feed into `key` invalidate memoized stuff
+    PARTS.each do |part|
+      define_method("#{part}=") do |value|
+        invalidate!
+        instance_variable_set(:"@#{part}", value)
+      end
     end
 
     protected
 
-    # Calculate cache key for url
-    def calculate_key
+    def key0
       key = []
-      key << env.method.upcase
+      key << http_method.to_s.upcase
       key << " "
-      key << url.scheme
+      key << scheme.to_s
       key << "://"
-      key << url.host.downcase
-      if !default_port?
+      key << host.downcase
+      if port
         key << ":"
-        key << url.port
+        key << port
       end
-      if url.path != "/"
-        key << url.path
+      if (path = (blank?(self.path) || self.path == "/") ? nil : self.path)
+        key << path
       end
-      if (q = url.query) && q != ""
+      if (query = canonical_query(self.query))
         key << "?"
-        key << querykey(q)
+        key << query
+      end
+      body = if env.request_headers["Content-Type"] == "application/x-www-form-urlencoded"
+        canonical_query(self.body)
+      else
+        self.body
       end
-      if env.request_body
+      if body
         key << " "
-        key << bodykey
+        key << body
       end
       key.join
     end
@@ -69,7 +92,7 @@ module HTTPDisk
     def bodykey
       body = env.request_body.to_s
       if env.request_headers["Content-Type"] == "application/x-www-form-urlencoded"
-        querykey(body)
+        canonical_query(body)
       elsif body.length < 50
         body
       else
@@ -77,32 +100,40 @@ module HTTPDisk
       end
     end
 
-    # Calculate canonical key for a query
-    def querykey(q)
+    def canonical_query(q)
+      return if blank?(q)
+
       parts = q.split("&").sort
       if !ignore_params.empty?
-        parts = parts.map do |part|
+        parts = parts.filter_map do |part|
           key, value = part.split("=", 2)
           next if ignore_params.include?(key)
 
           "#{key}=#{value}"
-        end.compact
+        end
       end
-      parts.join("&")
-    end
-
-    def default_port?
-      url.default_port == url.port
+      query = parts.join("&")
+      (query == "") ? nil : query
     end
 
     # Calculate nice directory name from url.host
     def hostdir
-      hostdir = url.host.downcase
+      hostdir = host.downcase
       hostdir = hostdir.gsub(/^www\./, "")
       hostdir = hostdir.gsub(/[^a-z0-9._-]/, "")
       hostdir = hostdir.squeeze(".")
       hostdir = "any" if hostdir.empty?
       hostdir
     end
+
+    def flatten_query_params(value)
+      value.flat_map do |k, v|
+        if v.is_a?(Array)
+          v.map { [k, _1] }
+        else
+          [[k, v]]
+        end
+      end
+    end
   end
 end

data/lib/httpdisk/cli/main.rb

@@ -59,7 +59,7 @@ module HTTPDisk
               max: options[:retry],
               methods: %w[delete get head options patch post put trace],
               retry_statuses: (500..600).to_a,
-              retry_if: ->(_env, _err) { true }
+              retry_if: ->(_env, _err) { true },
             }
             _1.request :retry, retry_options
           end

data/lib/httpdisk/client.rb

@@ -10,20 +10,22 @@ module HTTPDisk
     def initialize(app, options = {})
       options = Sloptions.parse(options) do
         _1.string :dir, default: File.join(ENV["HOME"], "httpdisk")
+        _1.boolean :compress, default: true
         _1.integer :expires
         _1.boolean :force
         _1.boolean :force_errors
         _1.array :ignore_params, default: []
+        _1.on :key_transform, type: Proc
         _1.on :logger, type: [:boolean, Logger]
         _1.boolean :utf8
       end
 
-      super(app, options)
+      super
       @cache = Cache.new(options)
     end
 
     def call(env)
-      cache_key = CacheKey.new(env, ignore_params:)
+      cache_key = build_cache_key(env)
       logger&.info("#{env.method.upcase} #{env.url} (#{cache.status(cache_key)})")
       env[:httpdisk_diskpath] = cache.diskpath(cache_key)
 
@@ -42,13 +44,13 @@ module HTTPDisk
 
     # Returns cache status for this request
     def status(env)
-      cache_key = CacheKey.new(env)
+      cache_key = build_cache_key(env)
       {
         url: env.url.to_s,
         status: cache.status(cache_key).to_s,
         key: cache_key.key,
         digest: cache_key.digest,
-        path: cache.diskpath(cache_key)
+        path: cache.diskpath(cache_key),
       }
     end
 
@@ -122,8 +124,7 @@ module HTTPDisk
       # look at charset and set body encoding if necessary
       encoding = encoding_for(content_type)
       if body.encoding != encoding
-        body = body.dup if body.frozen?
-        body.force_encoding(encoding)
+        body = body.dup.force_encoding(encoding)
       end
 
       # if :utf8, force body to UTF-8
@@ -163,6 +164,12 @@ module HTTPDisk
       @ignore_params ||= options[:ignore_params].map { CGI.escape(_1.to_s) }.to_set
     end
 
+    def build_cache_key(env)
+      CacheKey.new(env, ignore_params:).tap do
+        options[:key_transform]&.call(_1)
+      end
+    end
+
     def logger
       return if !options[:logger]
 

data/lib/httpdisk/grep/main.rb

@@ -14,27 +14,20 @@ module HTTPDisk
       def run
         paths.each do
           run_one(_1)
-      rescue => e
-        if ENV["HTTPDISK_DEBUG"]
-          $stderr.puts
-          warn e.class
-          warn e.backtrace.join("\n")
-        end
-        raise CliError, "#{e.message[0, 70]} (#{_1})"
+        rescue => e
+          if ENV["HTTPDISK_DEBUG"]
+            $stderr.puts
+            warn e.class
+            warn e.backtrace.join("\n")
+          end
+          raise CliError, "#{e.message[0, 70]} (#{_1})"
         end
         success
       end
 
       def run_one(path)
-        # read payload & body
-        begin
-          payload = Zlib::GzipReader.open(path, encoding: "ASCII-8BIT") do
-            Payload.read(_1)
-          end
-        rescue Zlib::GzipFile::Error
-          puts "httpdisk: #{path} not in gzip format, skipping" if !options[:silent]
-          return
-        end
+        payload = read_payload(path)
+        return if !payload
 
         body = prepare_body(payload)
 
@@ -66,6 +59,17 @@ module HTTPDisk
         paths
       end
 
+      def read_payload(path)
+        if HTTPDisk::Cache.new(compress: true).send(:compressed?, path)
+          Zlib::GzipReader.open(path, encoding: "ASCII-8BIT") { Payload.read(_1) }
+        else
+          File.open(path, "rb") { Payload.read(_1) }
+        end
+      rescue
+        puts "httpdisk: #{path} not in httpdisk format, skipping" if !options[:silent]
+        nil
+      end
+
       # convert raw body into something palatable for pattern matching
       def prepare_body(payload)
         body = payload.body
@@ -80,7 +84,7 @@ module HTTPDisk
               nil
             end
             if encoding && body.encoding != encoding
-              body.force_encoding(encoding)
+              body = body.dup.force_encoding(encoding)
             end
           end
 

data/lib/httpdisk/grep/printer.rb

@@ -1,7 +1,7 @@
 module HTTPDisk
   module Grep
     class Printer
-      GREP_COLOR = "37;45".freeze
+      GREP_COLOR = "37;45"
 
       attr_reader :output
 
@@ -19,7 +19,7 @@ module HTTPDisk
       #
 
       def grep_color
-        @grep_color ||= (ENV["GREP_COLOR"] || GREP_COLOR)
+        @grep_color ||= ENV["GREP_COLOR"] || GREP_COLOR
       end
 
       def print_matches(matches)

data/lib/httpdisk/payload.rb

@@ -1,33 +1,31 @@
 module HTTPDisk
   class Payload
-    class << self
-      def read(f, peek: false)
-        Payload.new.tap do |p|
-          # comment
-          p.comment = f.gets[/^# (.*)/, 1]
-
-          # status line
-          m = f.gets.match(/^HTTPDISK (\d+) (.*)$/)
-          p.status, p.reason_phrase = m[1].to_i, m[2]
-
-          # headers
-          while (line = f.gets.chomp) && !line.empty?
-            key, value = line.split(": ", 2)
-            p.headers[key] = value
-          end
-
-          # body (if not peeking)
-          p.body = f.read if !peek
+    def self.read(f, peek: false)
+      Payload.new.tap do |p|
+        # comment
+        p.comment = f.gets[/^# (.*)/, 1]
+
+        # status line
+        m = f.gets.match(/^HTTPDISK (\d+) (.*)$/)
+        p.status, p.reason_phrase = m[1].to_i, m[2]
+
+        # headers
+        while (line = f.gets.chomp) && !line.empty?
+          key, value = line.split(": ", 2)
+          p.headers[key] = value
         end
+
+        # body (if not peeking)
+        p.body = f.read if !peek
       end
+    end
 
-      def from_response(response)
-        Payload.new.tap do
-          _1.body = response.body
-          _1.headers = response.headers
-          _1.reason_phrase = response.reason_phrase
-          _1.status = response.status
-        end
+    def self.from_response(response)
+      Payload.new.tap do
+        _1.body = response.body
+        _1.headers = response.headers
+        _1.reason_phrase = response.reason_phrase
+        _1.status = response.status
       end
     end
 

data/lib/httpdisk/slop_duration.rb

@@ -10,8 +10,8 @@ module Slop
       h: 60 * 60,
       d: 24 * 60 * 60,
       w: 7 * 24 * 60 * 60,
-      y: 365 * 7 * 24 * 60 * 60
-    }.freeze
+      y: 365 * 7 * 24 * 60 * 60,
+    }
 
     def call(value)
       m = value.match(/^(\d+)([smhdwy])?$/)

data/lib/httpdisk/sloptions.rb

@@ -70,9 +70,7 @@ module HTTPDisk
 
     protected
 
-    def defaults
-      flags.map { |flag, foptions| [flag, foptions[:default]] }.to_h.compact
-    end
+    def defaults = flags.transform_values { _1[:default] }.compact
 
     # does value match valid?
     def valid?(value, types)

data/lib/httpdisk/version.rb

@@ -1,3 +1,3 @@
 module HTTPDisk
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.1"
 end

data/mise.toml

@@ -0,0 +1,9 @@
+[env]
+_.path = ['{{config_root}}/bin']
+
+[hooks]
+postinstall = ['bundle install']
+
+[tools]
+just = "latest"
+ruby = "3.4"

metadata

@@ -1,15 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: httpdisk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Adam Doppelt
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2026-04-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: content-type
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: faraday-cookie_jar
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +85,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -90,9 +131,10 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".justfile"
 - ".rubocop.yml"
+- AGENTS.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -100,7 +142,6 @@ files:
 - bin/httpdisk-grep
 - examples.rb
 - httpdisk.gemspec
-- justfile
 - lib/httpdisk.rb
 - lib/httpdisk/cache.rb
 - lib/httpdisk/cache_key.rb
@@ -116,12 +157,12 @@ files:
 - lib/httpdisk/sloptions.rb
 - lib/httpdisk/version.rb
 - logo.svg
+- mise.toml
 homepage: http://github.com/gurgeous/httpdisk
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,15 +170,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: httpdisk - disk cache for faraday
 test_files: []

data/Gemfile.lock

@@ -1,98 +0,0 @@
-PATH
-  remote: .
-  specs:
-    httpdisk (1.0.0)
-      content-type (~> 0.0)
-      faraday (~> 2.7)
-      faraday-cookie_jar (~> 0.0)
-      faraday-follow_redirects (~> 0.0)
-      slop (~> 4.10)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.4)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
-    coderay (1.1.3)
-    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 (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-follow_redirects (0.3.0)
-      faraday (>= 1, < 3)
-    faraday-net_http (3.0.2)
-    hashdiff (1.0.1)
-    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.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 (2.0.0)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (5.0.1)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
-    rubocop (1.44.1)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      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 (>= 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.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)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  httpdisk!
-  minitest
-  mocha
-  pry
-  rake
-  standard
-  webmock
-
-BUNDLED WITH
-   2.3.18

data/justfile

@@ -1,59 +0,0 @@
-
-# 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