builder-rails_cache 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4aa749a4640d7ca3fe3729890999c3c51fe0bd1b273cde488367410c9496acf
-  data.tar.gz: a117fcaef9eaa8b354b3d047585d43af8e0261c4bddf66c903f735cfa2ec9f44
+  metadata.gz: 201b3f3dad3c0cc9a9e768e08811efdf32d332f1d1e0e88e6d72271244d26def
+  data.tar.gz: c7173944b2f31198acc1b191f80d9ab556df979b5afa756527673b189413781b
 SHA512:
-  metadata.gz: ba317a626c14dda2d79925cee3757ce47ead9ec88a5ecb1bfff034c65e72be0619f232d552d79f1d819cf0ce1900c716e957faaa0ef3141c78273e5b53b1fd8d
-  data.tar.gz: ec9cca1b5820d6e03ab90d8d0903f44494c50c193c79d95d6aebf66cf79d34e284d9ee56dd16452f8d57ff23cb1eb8950ef695ab577d1723d639391be1ba838e
+  metadata.gz: e992720b1e3c154069e710e15673fd73ebdc0f7b5f63aa79f17a97ec28c58b84fa024ff04997dbce4e8eac3df2409cc051c257254cf9e2743a4433637b001a33
+  data.tar.gz: 3e96bb5f875de6fca09406447d921fb59b34880341d427fdc81e72448a8176d25b1a9bfd503a05c56413903db5808cddc27678bf06c6d68dd8137b1b11a48b56

data/CHANGELOG.md

@@ -1,5 +1,9 @@
-## [Unreleased]
+## [Released]
 
 ## [0.1.0] - 2024-11-21
 
 - Initial release
+
+## [0.1.2] - 2024-12-02
+
+- Improved documentation in the README, added Table of Contents and more code examples

data/README.md

@@ -2,6 +2,11 @@
 
 Provides a convenient `with_cache do ... end` wrapper around caching Rails responses, and shared_examples for use in your controller tests.
 
+### Contents
+[[_TOC_]]
+
+### Example controller method:
+
 ```ruby
   def index
     # Cache the response across all users
@@ -21,6 +26,21 @@ Provides a convenient `with_cache do ... end` wrapper around caching Rails respo
   end
 ```
 
+Or to cache a different response for each user :
+
+
+```ruby
+  def index
+    # Cache the response separately for each user:
+    json = with_cache(user_id: current_user.id) do
+      @records = MyModelClass.where(....)
+      @records.to_json
+    end
+    render json: json, status: :ok
+  end
+```
+
+
 ## Installation
 
 1. Add the gem to your Gemfile:
@@ -43,7 +63,7 @@ _NOTE: future versions will automate as much of the following steps as possible
 
 (this can either be the global `BuilderBase::ApplicationController` or just for one specific module if you prefer):
 
-```
+```ruby
   class ApplicationController < ActionController::Base
     include Builder::RailsCache
   end
@@ -118,7 +138,7 @@ Add these lines to `config/environment/production.rb`, anywhere _inside_ the `Ra
  
 For example, assume your controller method looks like this:
 
-```
+```ruby
   def index
     # Slow query:
     @records = MyModelClass.where(....)
@@ -205,7 +225,7 @@ The contents of the block are not called at all if there's a cache hit - so you
 
 For example, this code -
 
-```
+```ruby
   def show
     @record = MyClass.find(params[:id])
     render json: @record.to_json, status: :ok

data/builder-rails_cache.gemspec

@@ -13,8 +13,6 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://gitlab.builder.ai/cte/alistair-davidson/builder-rails_cache"
   spec.required_ruby_version = ">= 2.6.0"
 
-  # spec.metadata["allowed_push_host"] = "https://gem.fury.io/engineerai"
-
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."

data/lib/builder/rails_cache/version.rb

@@ -2,6 +2,6 @@
 
 module Builder
   module RailsCache
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: builder-rails_cache
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alistair Davidson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-30 00:00:00.000000000 Z
+date: 2024-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails