activemodel-caching 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ec8752a6b2b1b61f148065784dda2f0627e452f05a338c32d0620b55784a9ae
-  data.tar.gz: 1e6f1968f1a8ed4da125c186e32eb38336c9e7e0c38a9f2b01f185c845a42cf4
+  metadata.gz: 8b303bf8dad12f99a476fd5848f7c86a2955529bf3525685885d18bdcb8c6910
+  data.tar.gz: 475519f8c787511aa0c4511b066430cf77a894c3d3bdfce89abf6c7c8fd8f57b
 SHA512:
-  metadata.gz: 235af76026a1cf74566eff3d5ad30f4aa9bbb037859710a1357f37ae0e2c01539835d83026ca29a9cd6bb7fc1f56fdc198a0cc88d710c476a1f7b5dfbdfe98f6
-  data.tar.gz: 3aa89b3be0ec2e322b1456a6c1d78b597568dc051db1d7f01a7ed27455047879ffc00b669096760d18c79139bba5d9f62d4bfe3b686da405ec5f3f84ca335351
+  metadata.gz: 418a295855396e610ed66f8bcb72f531131b533d5e5efbebe70e0cfcec46acdf56a38a3f1940a7d69f66f0e425d1ef80d61b99f51f95c34aea072885b5774cb1
+  data.tar.gz: d010322be580cca50eebf1558196c8b3f129a5140bb57a47b2afeb8b3aa3fb4a5c44cd91cbc38c2e4ab8cc6d93d60d0677cd3145c22a59be38b18523632adfb0

data/.rubocop.yml

@@ -1,4 +1,6 @@
 AllCops:
+  NewCops: enable
+  SuggestExtensions: false
   TargetRubyVersion: 3.0
 
 Metrics/BlockLength:

data/README.md

@@ -10,65 +10,26 @@ Add this line to your application's Gemfile:
 gem 'activemodel-caching'
 ```
 
-And then execute:
+Then execute:
 
 ```bash
-bundle install
+$ bundle install
 ```
 
-Or install it yourself as:
+## Configuration
 
-```bash
-gem install activemodel-caching
-```
-
-## Usage
-
-To use the caching methods provided by `ActiveModel::Caching`, include the module in your model and set up the cache store.
-
-### Setup
-
-You can set up a cache store globally in an initializer, for example, in `config/initializers/active_model_caching.rb`:
+Configure the gem in an initializer:
 
 ```ruby
 ActiveModel::Caching.setup do |config|
-  config.cache_store = ActiveSupport::Cache::MemoryStore.new # or any other cache store you prefer
+  config.cache_store = Rails.cache # Defaults to Rails.cache if Rails is defined, otherwise to memory store
+  config.global_id_app = 'MyApp'   # Defaults to GlobalID.app if present, otherwise to Rails.application.name if Rails is defined
 end
 ```
 
-If you're using Rails, you can also default to Rails cache if you prefer:
-```ruby
-ActiveModel::Caching.setup do |config|
-  config.cache_store = Rails.cache
-end
-```
-
-### Basic Usage
-
-To enable caching for an attribute, simply call one of the `cache_*` methods in your model class. Here are the methods you can use:
-
-- `cache_string` - Caches a string value.
-- `cache_integer` - Caches an integer value.
-- `cache_decimal` - Caches a decimal value.
-- `cache_datetime` - Caches a datetime value.
-- `cache_flag` - Caches a boolean flag.
-- `cache_float` - Caches a float value.
-- `cache_enum` - Caches an enumerated value.
-- `cache_json` - Caches a JSON object.
-- `cache_list` - Caches an ordered list with an optional limit.
-- `cache_unique_list` - Caches a unique list with an optional limit.
-- `cache_set` - Caches a unique set with an optional limit.
-- `cache_ordered_set` - Caches an ordered set with an optional limit.
-- `cache_slots` - Caches available "slots" (e.g., seats) with helper methods.
-- `cache_slot` - Caches a single-slot availability.
-- `cache_counter` - Caches a counter that can be incremented and reset.
-- `cache_limiter` - Caches a limited counter, enforcing a maximum count.
-- `cache_hash` - Caches a hash structure.
-- `cache_boolean` - Caches a boolean value.
-
-#### Example
+## Usage
 
-Here’s how you might define a model with various cached attributes:
+Include the module in your class:
 
 ```ruby
 class User
@@ -76,87 +37,202 @@ class User
 
   cache_string :session_token
   cache_integer :view_count
-  cache_decimal :account_balance
-  cache_datetime :last_login
-  cache_flag :is_active
-  cache_enum :status, %w[active inactive suspended]
-  cache_json :preferences
-  cache_list :recent_searches, limit: 10
-  cache_set :tags, limit: 5
-  cache_slots :seats, available: 100
-  cache_counter :login_count
-  cache_boolean :is_verified
+  # ... etc
 end
 ```
 
-With these, you’ll automatically have generated methods for interacting with the cache.
+## Available Cache Types
+
+### Basic Types
+
+#### `cache_string`
+Caches a string value.
+```ruby
+cache_string :session_token
+# Generates:
+# - session_token
+# - session_token=
+```
+
+#### `cache_integer`
+Caches an integer value.
+```ruby
+cache_integer :view_count
+# Generates:
+# - view_count
+# - view_count=
+```
 
-### Detailed Method Descriptions
+#### `cache_decimal`
+Caches a decimal value.
+```ruby
+cache_decimal :account_balance
+# Generates:
+# - account_balance
+# - account_balance=
+```
+
+#### `cache_datetime`
+Caches a datetime value.
+```ruby
+cache_datetime :last_login
+# Generates:
+# - last_login
+# - last_login=
+```
 
-- **`cache_string(attribute_name, expires_in: nil)`**: Caches a string attribute.
-  - Example: `cache_string :username`
+#### `cache_flag` / `cache_boolean`
+Caches a boolean value.
+```ruby
+cache_flag :is_active
+# or
+cache_boolean :is_verified
+# Generates:
+# - is_active
+# - is_active=
+```
 
-- **`cache_integer(attribute_name, expires_in: nil)`**: Caches an integer attribute.
-  - Example: `cache_integer :view_count`
+#### `cache_float`
+Caches a float value.
+```ruby
+cache_float :average_rating
+# Generates:
+# - average_rating
+# - average_rating=
+```
 
-- **`cache_decimal(attribute_name, expires_in: nil)`**: Caches a decimal attribute.
-  - Example: `cache_decimal :account_balance`
+### Complex Types
 
-- **`cache_datetime(attribute_name, expires_in: nil)`**: Caches a datetime attribute.
-  - Example: `cache_datetime :last_login`
+#### `cache_enum`
+Caches an enum value, storing the value among defined options.
+```ruby
+cache_enum :status, %w[active inactive suspended]
+# Generates:
+# - status
+# - status=
+```
 
-- **`cache_flag(attribute_name, expires_in: nil)`**: Caches a boolean flag.
-  - Example: `cache_flag :is_active`
+#### `cache_json`
+Caches a JSON value.
+```ruby
+cache_json :user_preferences
+# Generates:
+# - user_preferences
+# - user_preferences=
+```
 
-- **`cache_enum(attribute_name, options, expires_in: nil)`**: Caches an enumerated value.
-  - Example: `cache_enum :status, %w[active inactive suspended]`
+#### `cache_hash`
+Caches a hash value.
+```ruby
+cache_hash :settings
+# Generates:
+# - settings
+# - settings=
+```
 
-- **`cache_json(attribute_name, expires_in: nil)`**: Caches a JSON object.
-  - Example: `cache_json :user_preferences`
+### Collections
 
-- **`cache_list(attribute_name, limit: nil, expires_in: nil)`**: Caches an ordered list, with an optional limit.
-  - Example: `cache_list :recent_posts, limit: 5`
+#### `cache_list`
+Caches an ordered list of values, maintaining order and optional limit.
+```ruby
+cache_list :recent_posts, limit: 5
+# Generates:
+# - recent_posts
+# - add_to_recent_posts
+# - remove_from_recent_posts
+```
 
-- **`cache_set(attribute_name, limit: nil, expires_in: nil)`**: Caches a unique set, with an optional limit.
-  - Example: `cache_set :tags, limit: 10`
+#### `cache_unique_list`
+Caches a unique list of values, maintaining uniqueness and optional limit.
+```ruby
+cache_unique_list :favorite_articles, limit: 10
+# Generates:
+# - favorite_articles
+# - add_to_favorite_articles
+# - remove_from_favorite_articles
+```
 
-- **`cache_slots(attribute_name, available:, expires_in: nil)`**: Caches a set number of slots with helper methods.
-  - Example: `cache_slots :seats, available: 100`
+#### `cache_set`
+Caches a set of unique values with optional limit.
+```ruby
+cache_set :tags, limit: 5
+# Generates:
+# - tags
+# - add_to_tags
+# - remove_from_tags
+```
 
-- **`cache_counter(attribute_name, expires_in: nil)`**: Caches a counter.
-  - Example: `cache_counter :login_count`
+#### `cache_ordered_set`
+Caches an ordered set of values, maintaining order and optional limit.
+```ruby
+cache_ordered_set :recent_views, limit: 10
+# Generates:
+# - recent_views
+# - add_to_recent_views
+# - remove_from_recent_views
+```
 
-- **`cache_boolean(attribute_name, expires_in: nil)`**: Caches a boolean value.
-  - Example: `cache_boolean :is_verified`
+### Special Types
 
-### Example Methods
+#### `cache_slots`
+Caches a limited number of available "slots" for resources like seats or reservations.
+```ruby
+cache_slots :seats, available: 10
+# Generates:
+# - seats
+# - available_seats?
+# - reserve_seats!
+# - release_seats!
+# - reset_seats!
+```
 
-For each cached attribute, methods are generated for getting and setting values. For example:
+#### `cache_slot`
+Caches a single slot (binary available/taken resource).
+```ruby
+cache_slot :parking_space
+# Generates:
+# - parking_space
+# - available_parking_space?
+# - reserve_parking_space!
+# - release_parking_space!
+# - reset_parking_space!
+```
 
+#### `cache_counter`
+Caches a counter value.
 ```ruby
-user = User.new
+cache_counter :likes_count
+# Generates:
+# - likes_count
+# - increment_likes_count
+# - decrement_likes_count
+# - reset_likes_count
+```
 
-# Cache a string
-user.session_token = "abc123"
-puts user.session_token # => "abc123"
+#### `cache_limiter`
+Caches a limiter value with a maximum allowed count.
+```ruby
+cache_limiter :api_requests, limit: 100
+# Generates:
+# - api_requests
+# - increment_api_requests
+# - reset_api_requests
+```
 
-# Increment a counter
-user.increment_login_count
-puts user.login_count # => 1
+## Options
 
-# Reserve a slot
-if user.available_seats?
-  user.reserve_seats!
-end
+All cache methods accept an optional `expires_in` parameter:
 
-# Reset a slot
-user.reset_seats!
+```ruby
+cache_string :session_token, expires_in: 1.hour
+cache_counter :daily_visits, expires_in: 1.day
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/your-username/active_model-caching](https://github.com/your-username/active_model-caching).
+Bug reports and pull requests are welcome at https://github.com/EmCousin/activemodel-caching.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```

data/lib/active_model/caching/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveModel
   module Caching
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/active_model/caching.rb

@@ -2,25 +2,81 @@
 
 require_relative "caching/version"
 
+require "active_support"
+require "active_support/time"
 require "base64"
 require "bigdecimal/util"
+require "global_id"
 require "json"
-require "active_support"
-require "active_support/time"
 
 module ActiveModel
   # Provides with a set of methods allowing to cache data structures at the object level
   module Caching
-    mattr_accessor :cache_store
-    @@cache_store = ActiveSupport::Cache::MemoryStore.new
+    extend ActiveSupport::Concern
+
+    include GlobalID::Identification
 
     class << self
+      # Configures the gem with a block. Example:
+      #   ActiveModel::Caching.setup do |config|
+      #     config.cache_store = Rails.cache
+      #     config.global_id_app = 'MyApp'
+      #   end
+      #
+      # @yield [ActiveModel::Caching] Yields self for configuration
+      # @return [void]
       def setup
         yield self
       end
+
+      # Returns the cache store to use for caching attributes.
+      # Defaults to Rails.cache if Rails is defined, otherwise uses MemoryStore.
+      #
+      # @return [ActiveSupport::Cache::Store] The configured cache store
+      def cache_store
+        @cache_store ||= default_cache_store
+      end
+
+      # Returns the application name used for GlobalID generation.
+      # Defaults to GlobalID.app if present, then Rails.application.name if Rails is defined.
+      #
+      # @return [String, nil] The configured application name for GlobalID
+      def global_id_app
+        @global_id_app ||= default_global_id_app
+      end
+
+      attr_writer :cache_store, :global_id_app
+
+      private
+
+      # @private
+      # Returns the default cache store based on the environment.
+      #
+      # @return [ActiveSupport::Cache::Store] The default cache store
+      def default_cache_store
+        if defined?(Rails)
+          Rails.cache
+        else
+          ActiveSupport::Cache::MemoryStore.new
+        end
+      end
+
+      # @private
+      # Returns the default application name for GlobalID based on the environment.
+      #
+      # @return [String, nil] The default application name
+      def default_global_id_app
+        if GlobalID.app.present?
+          GlobalID.app
+        elsif defined?(Rails)
+          Rails.application.name
+        end
+      end
     end
 
-    extend ActiveSupport::Concern
+    included do
+      delegate :cache_store, to: ActiveModel::Caching
+    end
 
     class_methods do
       # Caches a string value for the given attribute.
@@ -117,6 +173,7 @@ module ActiveModel
 
         attribute_name
       end
+      alias_method :cache_boolean, :cache_flag
 
       # Caches a float value for the given attribute.
       #
@@ -426,6 +483,11 @@ module ActiveModel
           cache_store.write(cache_key_for(attribute_name), new_value, expires_in: expires_in)
         end
 
+        define_method(:"decrement_#{attribute_name}") do
+          new_value = send(attribute_name) - 1
+          cache_store.write(cache_key_for(attribute_name), new_value, expires_in: expires_in)
+        end
+
         define_method(:"reset_#{attribute_name}") do
           cache_store.write(cache_key_for(attribute_name), 0, expires_in: expires_in)
         end
@@ -483,23 +545,6 @@ module ActiveModel
 
         attribute_name
       end
-
-      # Caches a boolean value for the given attribute.
-      #
-      # @param attribute_name [Symbol] the name of the boolean attribute to cache.
-      # @param expires_in [ActiveSupport::Duration, nil] optional expiration time for the cache entry.
-      #
-      # @example
-      #   cache_boolean :is_verified
-      def cache_boolean(attribute_name, expires_in: nil)
-        define_method(attribute_name) do
-          cache_store.read(cache_key_for(attribute_name)).present?
-        end
-
-        define_method(:"#{attribute_name}=") do |value|
-          cache_store.write(cache_key_for(attribute_name), !!value, expires_in: expires_in)
-        end
-      end
     end
 
     private
@@ -509,7 +554,11 @@ module ActiveModel
     # @param attribute_name [Symbol] the name of the attribute.
     # @return [String] the generated cache key.
     def cache_key_for(attribute_name)
-      to_global_id(attribute_name: attribute_name)
+      if ActiveModel::Caching.global_id_app.present?
+        to_global_id(attribute_name: attribute_name, app: ActiveModel::Caching.global_id_app)
+      else
+        to_global_id(attribute_name: attribute_name)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activemodel-caching
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Emmanuel Cousin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -105,6 +105,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/EmCousin/activemodel-caching
   source_code_uri: https://github.com/EmCousin/activemodel-caching
 post_install_message: