foobara-cached-command 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36cb25ec47a00d8754634b857722e8eb4e547fb257fa537876a7886ba93fa3a
-  data.tar.gz: 5443d74e0926fe9d769b8c371d45888d2e47cd0abcbf48a633d17b81481579bc
+  metadata.gz: c0cbe47bcf1bd9b9efd9dff8456fa23647a28dd18b54ecfa1167a40bdbd01c56
+  data.tar.gz: 28da7e0c4682e53fca722d24e1b33fe45ca63b6a089c3c9a594694f36e159f9a
 SHA512:
-  metadata.gz: 8e406d4e36b5758e844eb24432ea4382f7ff993ea8c62e2a58d2cc01a72d7d6478ea3e750b30ce68e6bc03d9bad60b46c44b4ddf71fb297d52b1c4ce8d279f6f
-  data.tar.gz: 30e2d6bdc35f1278bebee5a28a8b687fcd0359ac0724ebb45cf23a95f15e2f95e0071f1fd6e64464a0c66df41d622bc9e1f085f6dc96fc7b75b6d68e76b05d1e
+  metadata.gz: 1459cf4031df08db4b3dceeb70deed05ff92da58bd876fc9a33725163e98af274c55d72fa740acb63b7b939f9daefc9c9b456a05001216d45218e0ad3bd32ef5
+  data.tar.gz: b00a02a45fd79a4133287b9f14d27b5c5a242a567bdaf2111fd2cc041a91d4f699cd5bde59d54dfaf1e86d3e4525481458313ad0e65bb99bf9bd781f38fabca8

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [1.0.0] - 2025-07-21
+
+- Add .reset_all for test suites
+
+## [0.0.2] - 2025-02-19
+
+- Fix bugs with tmp file name
+- Fix bugs when not using an expiry
+- Give a flag to disable caching entirely
+
 ## [0.0.1]
 
 - Release as a gem

data/lib/foobara/cached_command.rb

@@ -2,3 +2,16 @@ require "foobara/all"
 require "foobara/command_connectors"
 
 Foobara::Util.require_directory "#{__dir__}/../../src"
+
+module Foobara
+  module CachedCommand
+    class << self
+      def reset_all
+        Foobara.raise_if_production!("reset_all")
+
+        FileUtils.rm_rf "tmp/cached_command/"
+        Foobara::CachedCommand.cache.clear
+      end
+    end
+  end
+end

data/src/foobara/cached_command.rb

@@ -15,17 +15,22 @@ module Foobara
         unless data
           if File.exist?(file_path)
             data = Util.symbolize_keys(JSON.parse(File.read(file_path)))
-            data[:expires_at] = Time.parse(data[:expires_at])
-            cache[key] = data
+
+            if data.key?(:expires_at)
+              data[:expires_at] = Time.parse(data[:expires_at])
+              cache[key] = data
+            end
           else
             return nil
           end
         end
 
-        if Time.now > data[:expires_at]
-          cache.delete(key)
-          FileUtils.rm_f(file_path)
-          data = nil
+        if data.key?(:expires_at)
+          if Time.now > data[:expires_at]
+            cache.delete(key)
+            FileUtils.rm_f(file_path)
+            data = nil
+          end
         end
 
         data
@@ -40,13 +45,20 @@ module Foobara
           data[:expires_at] = created_at + expiry
         end
 
+        basedir = File.dirname(file_path)
+
+        FileUtils.mkdir_p(basedir)
+
         File.write(file_path, JSON.fast_generate(data))
         cache[key] = data
       end
     end
 
+    # We need to prepend this so that we're overriding the method defined in the class we're mixed into
     module Execute
       def execute
+        return super if foobara_cache_disabled
+
         if foobara_cached_value_present?
           foobara_cached_value
         else
@@ -60,7 +72,8 @@ module Foobara
     include Concern
 
     inherited_overridable_class_attr_accessor :foobara_cache_expiry,
-                                              :foobara_cache_serializer
+                                              :foobara_cache_serializer,
+                                              :foobara_cache_disabled
 
     on_include do
       prepend Execute
@@ -83,7 +96,7 @@ module Foobara
 
     # TODO: support various caching strategies like memcached or redis, not just local files
     def foobara_cache_path
-      "tmp/#{foobara_cache_key}.json"
+      @foobara_cache_path ||= "tmp/cached_command/#{foobara_cache_key}.json".gsub("::", "/")
     end
 
     # TODO: support caching based on certain inputs...
@@ -121,5 +134,9 @@ module Foobara
     def foobara_cache_expiry
       self.class.foobara_cache_expiry
     end
+
+    def foobara_cache_disabled
+      self.class.foobara_cache_disabled
+    end
   end
 end

metadata

@@ -1,28 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: foobara-cached-command
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 email:
 - azimux@gmail.com
 executables: []
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Makes it so that any foobara command will cache its result in memory and
   on disk.