counted_cache 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d37ddff712233dcdc2d0dc5c5eb32d5743eacb35
+  data.tar.gz: 96a06deee11bf404fbb0d9d52af88de817525b3b
+SHA512:
+  metadata.gz: '038f467b83415bb5dca95b04dc81b866a9bb10b71dbb878ffd979df66ed2c1f0aac53e2df306efec49198489af6f9ff77ac84de628f7b7ff51e8a62860bb8467'
+  data.tar.gz: b913faf39839f0e7fc7267e7878b90817006b8b34e188ac7715fd5f48cbe8667464c649ba174e84a07a8806e6c2c5b75a49acd11385b0fdfd6b14fa9eaaf0464

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at peter.c.camilleri@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in counted_cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 PeterCamilleri
+
+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,103 @@
+# CountedCache
+
+The counted_cache gem. A cache for use in cases where data is mostly only
+read and where the cost of rebuilding that data is high, and yet, the size
+of the data is too large to keep all of it in RAM all of the time.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'counted_cache'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install counted_cache
+
+## Usage
+
+Creating a counted cache is as simple as:
+
+```ruby
+cache_on_hand = CountedCache.new(10) {|key| retrieve_data_for(key) }
+```
+
+Where:
+
+* The argument is the optional cache depth, which is the number of data
+items kept in the cache.
+* The required block is used to fetch the data associated with the key when
+that data is needed, but not currently in the cache.
+
+So how do we use a counted cache to get at our data? That is really simple:
+
+```ruby
+data = cache_on_hand[key]
+```
+
+That's it! And that is the complete essentials guide. There are a very few
+extras to determine how well the cache is working. The hits and misses
+properties record how many times the data was found in the cache (a hit) and
+how many times it had to be retrieved (a miss).
+
+### Removing data from the cache.
+
+At some point, data items will need to be removed from the cache to make room
+for newer data requests.
+
+Normally when this happens, the old data can go away and no further action
+needs to be taken. In some cases however, modified data will need to be written
+out to save any changes that may have been made to that data. This is done by
+giving the cache a block that does the work of saving the data into wherever
+is identified by the key.
+
+```ruby
+cache_on_hand.set_save_block do |key, data|
+  # Code to save data at key goes here.
+end
+```
+
+### Example
+
+Consider the case of an application that uses embedded ruby (erb) files. This
+could look like:
+
+```ruby
+erb_cache = CountedCache.new {|name| ERB.new(IO.read(name))}
+
+# Other code omitted.
+
+view_text = erb_cache["home_page/my_file.html.erb"].result(a_binding)
+```
+
+The benchmark in the demo folder examines just such a scenario.
+
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+OR...
+
+* Make a suggestion by raising an
+ [issue](https://github.com/PeterCamilleri/counted_cache/issues)
+. All ideas and comments are welcome.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](./LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the counted_cache project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](./CODE_OF_CONDUCT.md).

data/counted_cache.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "counted_cache/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "counted_cache"
+  spec.version       = CountedCache::VERSION
+  spec.authors       = ["PeterCamilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+
+  spec.summary       = CountedCache::DESCRIPTION
+  spec.description   = "A cache for read mostly data with a high cost of retrieval."
+  spec.homepage      = "https://github.com/PeterCamilleri/counted_cache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+                          f.match(%r{^(test|docs)/})
+                        end
+  spec.bindir        = "exe"
+  spec.executables   = spec
+                         .files
+                         .reject { |f| f.downcase == 'exe/readme.md'}
+                         .grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'minitest_visible', "~> 0.1"
+end

data/lib/counted_cache.rb

@@ -0,0 +1,79 @@
+# The counted_cache class. A cache for use in cases where data is mostly only
+# read and where the cost of rebuilding that data is high, and yet, the size
+# of the data is too large to keep all of it in RAM all of the time.
+
+require_relative 'counted_cache/counted_cache_item'
+require_relative 'counted_cache/version'
+
+class CountedCache
+
+  # How many data elements should be retained?
+  attr_reader :depth
+
+  # How many times was data found in the cache?
+  attr_reader :hits
+
+  # How many times was data not in the cache?
+  attr_reader :misses
+
+  # Setup the cache
+  def initialize(depth = 10, &load_block)
+    fail "A data loading block is required" unless block_given?
+
+    @load_block = load_block
+    @save_block = Proc.new {}
+    @key_space  = Hash.new {|hash, key| hash[key] = CountedCacheItem.new(key)}
+    @data_space = Array.new
+    self.depth  = depth
+    @hits       = 0
+    @misses     = 0
+  end
+
+  # Set up the optional block called to save data.
+  def set_save_block(&save_block)
+    @save_block = save_block
+  end
+
+  # Get a data item.
+  def [](key)
+    item = @key_space[key]
+
+    if item.empty?
+      item.data = @load_block.call(key)
+      adjust_cache(1)
+      @data_space << item
+      @misses += 1
+    else
+      @hits += 1
+    end
+
+    item.data
+  end
+
+  # Set the new depth.
+  def depth=(value)
+    value = value.to_i
+    fail "The depth must be greater than zero." if value < 1
+    @depth = value
+    adjust_cache(0)
+  end
+
+  # How many cache slots are free?
+  def free
+    @depth - @data_space.length
+  end
+
+private
+
+  # Make sure the data space has at least one free slot.
+  def adjust_cache(reserve)
+    return if free >= reserve
+
+    @data_space.sort_by!(&:count)
+
+    while free != reserve
+      @data_space.shift.purge(@save_block)
+    end
+  end
+
+end

data/lib/counted_cache/counted_cache_item.rb

@@ -0,0 +1,36 @@
+# A container for items in a counted cache.
+class CountedCacheItem
+
+  # A marker for empty items.
+  EMPTY = :counted_cache_item_empty
+
+  # The reference count of this item.
+  attr_reader :count
+
+  # Let the data be set.
+  attr_writer :data
+
+  # Setup an empty data item.
+  def initialize(key)
+    @data  = EMPTY
+    @key   = key
+    @count = 0
+  end
+
+  # Is this item empty?
+  def empty?
+    @data == EMPTY
+  end
+
+  # Erase the data associated with the given key.
+  def purge(save_block)
+    save_block.call(@key, @data)
+    @data = EMPTY
+  end
+
+  # Retrieve the data, maintain a reference count.
+  def data
+    @count += 1
+    @data
+  end
+end

data/lib/counted_cache/version.rb

@@ -0,0 +1,5 @@
+class CountedCache
+  VERSION = "0.2.0".freeze
+
+  DESCRIPTION = "counted_cache: A cache for mostly read data with a high cost of retrieval.".freeze
+end

data/rakefile.rb

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+desc "What version of counted_cache is this?"
+task :vers do |t|
+  puts
+  puts "counted_cache version = #{::CountedCache::VERSION}"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: counted_cache
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- PeterCamilleri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest_visible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: A cache for read mostly data with a high cost of retrieval.
+email:
+- peter.c.camilleri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- counted_cache.gemspec
+- lib/counted_cache.rb
+- lib/counted_cache/counted_cache_item.rb
+- lib/counted_cache/version.rb
+- rakefile.rb
+homepage: https://github.com/PeterCamilleri/counted_cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: 'counted_cache: A cache for mostly read data with a high cost of retrieval.'
+test_files: []