evanescence 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6f2dca734bfb023b9f2c927e49904ca5c34c4247ec619ce704d766ad01f8d66
+  data.tar.gz: c336919947cecc092f7d8e1c4495e4f46097d65bc92ed446c36b64b7c90dbe0c
+SHA512:
+  metadata.gz: 5dd994c61a90b4932917924e347866ba92d60d93431ebc559848e1c43adde7c99bd3e50d6fceb348fc70a837573bc8e8a0a937c991e66afc86fce5c6c70b5f39
+  data.tar.gz: 12ab15620128dda67b0b53480bb7ddea55a0f11769aac037a3b4f3e98c2cb07e7a2e01fab75ce34a0d931f3ea6617ee0176c46ab5fe82a6d8c2876bbc328fc68

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+Layout/LineLength:
+  Max: 120
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+Style/ConditionalAssignment:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': ()
+    '%w': ()
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Florin Diconescu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# Evanescence
+
+[![Push & PR](https://github.com/florindiconescu/evanescence/actions/workflows/main.yml/badge.svg)](https://github.com/florindiconescu/evanescence/actions/workflows/main.yml)
+
+In memory cache which can limit the cache size by a maximum number by expiring the least used cached items.
+
+## Usage
+
+Initiate a cache object. Optionally pass the max number of records as an argument:
+```
+cache = Evanescence.initialize_cache(max_size: 1000)
+```
+Write to cache: `cache.write("key", value)`
+
+Read from cache: `cache.read("key")`
+
+Delete from cache: `cache.delete("key")`
+
+Delete the entire cache: `cache.clear`
+
+Check the cache size: `cache.count`
+
+## Next steps
+Expire the cache after given time.
+
+Enhance the API.

data/evanescence.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/evanescence/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "evanescence"
+  spec.version = Evanescence::VERSION
+  spec.authors = ["florindiconescu"]
+  spec.email = ["florin.diconescu@gmail.com"]
+
+  spec.summary = "Simple in memory cache"
+  spec.homepage = "https://github.com/florindiconescu/evanescence"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1", "< 3.4"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w(bin/ test/ spec/ features/ .git .github appveyor Gemfile))
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rubocop", "1.60.2"
+  spec.add_development_dependency "rubocop-rspec", "2.26.1"
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/evanescence/cache.rb

@@ -0,0 +1,61 @@
+module Evanescence
+  # Simple implementation of caching
+  class Cache
+    def initialize(max_size:)
+      @items = {}
+      @max_size = max_size
+    end
+
+    def to_h
+      items.transform_values(&:first)
+    end
+
+    def write(key, val)
+      reject_least_used_item if max_size
+      existing_item = items[key]
+      existing_item ? update_value(existing_item, val) : items[key] = [val, 1]
+
+      items[key].first
+    end
+
+    def read(key)
+      item = items[key]
+      return unless item
+
+      item[1] += 1 if max_size
+      item.first
+    end
+
+    def delete(key)
+      items.delete(key)
+    end
+
+    def clear
+      count_before_clear = count
+      items.clear
+      count_before_clear
+    end
+
+    def count
+      items.count
+    end
+
+    private
+
+    attr_reader :items, :max_size
+
+    def update_value(item, value)
+      item.tap do |i|
+        i.first = value
+        i[1] += 1 if max_size
+      end
+    end
+
+    def reject_least_used_item
+      return if items.size < max_size
+
+      min = items.min_by { |_, v| v.last }
+      delete(min[0])
+    end
+  end
+end

data/lib/evanescence/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Evanescence
+  VERSION = "0.1.0"
+end

data/lib/evanescence.rb

@@ -0,0 +1,11 @@
+require_relative "evanescence/version"
+
+module Evanescence
+  autoload :Cache, "evanescence/cache"
+
+  module_function
+
+  def initialize_cache(max_size: nil)
+    Cache.new(max_size:)
+  end
+end

data/sig/evanescence.rbs

@@ -0,0 +1,4 @@
+module Evanescence
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: evanescence
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- florindiconescu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.60.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.60.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.26.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.26.1
+description:
+email:
+- florin.diconescu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- evanescence.gemspec
+- lib/evanescence.rb
+- lib/evanescence/cache.rb
+- lib/evanescence/version.rb
+- sig/evanescence.rbs
+homepage: https://github.com/florindiconescu/evanescence
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/florindiconescu/evanescence
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Simple in memory cache
+test_files: []