rusty_lru 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8262b61f3b89a8fb40f436a3820314887d1f20f91448ee14a8563d05fdc2061a
+  data.tar.gz: 52f666bde7eb89754683a33040b4fcb17a03b3fb85b0399f2130f7c13d8e8811
+SHA512:
+  metadata.gz: 86da4959c095c2d7517383b001e5239576301601a4c3234885461e732f691514e15af04af06dfc2e269b211fcd47533c4bb5178ee7a830d484a52dbac0b168a6
+  data.tar.gz: e5515288bd26ed3ef1016adb86294bb088eb93073ed5cc92171d35605855f5c6e92cf832e44a3d17b77762292b1702de7340714e5b55afc42ecac94bb4eb9801

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+
+#Added by cargo
+#
+#already existing elements are commented out
+
+/target
+**/*.rs.bk
+Cargo.lock
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.6.3
+  Exclude:
+    - vendor/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+os:
+  - osx
+  - linux
+rvm:
+  - 2.6
+  - 2.5
+  - 2.4
+env:
+  - RUST_VERSION=stable
+  - RUST_VERSION=nightly
+before_install:
+  - gem update --system
+  - gem install bundler
+  - curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain $RUST_VERSION
+  - source $HOME/.cargo/env
+cache:
+  bundler: true
+  directories:
+    - $HOME/.cargo
+script:
+  - LD_LIBRARY_PATH=$(ruby -e "print RbConfig::CONFIG['libdir']") cargo test
+  - bundle exec rake spec
+  - bundle exec rubocop
+matrix:
+  allow_failures:
+    - env: RUST_VERSION=nightly
+branches:
+  only: master

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Implement basic Hash-like functionality by using
+  [rutie](https://rubygems.org/gems/rutie) to wrap the
+  [lru](https://crates.io/crates/lru) crate.
+- RSpec tests.
+
+[Unreleased]: https://github.com/asppsa/rusty_lru/commits/master

data/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "rusty_lru"
+version = "0.1.0"
+authors = ["Alastair Pharo <me@asph.dev>"]
+edition = "2018"
+
+[dependencies]
+rutie = "0.6.1"
+lru = "0.1.17"
+lazy_static = "1.3.0"
+
+[lib]
+name = "rusty_lru"
+crate-type = ["dylib"]

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rusty_lru.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,3 @@
+rusty_lru
+Copyright (C) 2019 Alastair Pharo
+

data/README.md

@@ -0,0 +1,129 @@
+# RustyLRU
+
+[![Build Status](https://travis-ci.org/asppsa/rusty_lru.svg?branch=master)](https://travis-ci.org/asppsa/rusty_lru)
+
+This gem provides an [LRU
+cache](https://en.wikipedia.org/wiki/Cache_replacement_policies#Least_recently_used_(LRU))
+for Ruby.  It uses [Rutie](https://rubygems.org/gems/rutie) to wrap the
+[Rust](https://rust-lang.org/)'s [lru](https://crates.io/crates/lru) crate.
+
+From a Ruby perspective, the API is close to that of the `Hash` class.   It
+differs in that it will never grow beyond a capped number of key-value pairs,
+which makes it suitable to use as a cache.
+
+
+## Installation
+
+Make sure you have Rust installed.  Add this line to your application's
+Gemfile:
+
+```ruby
+gem 'rusty_lru'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rusty_lru
+
+
+## Usage
+ 
+The key concept of an LRU cache is the LRU list, which is a list of all the
+key-value pairs in the cache, ordered by how recently they are used.  When the
+cache fills to capacity, the pair at the bottom of the list will be dropped
+each time a new pair is added.  Accessing/updating an existing pair in the
+cache moves it to the top of the list.
+
+Comprehensive documentation is available online:
+
+- [Bleeding edge](https://rubydoc.info/github/asppsa/rusty_lru/master)
+
+For the impatient, here is an example of basic usage:
+
+~~~ ruby
+# Creates a cache with a cap of 1,000 entries.
+cache = RustyLRU::Cache.new(1000)
+
+# Returns true iff the cache is empty.
+cache.empty? #=> true
+
+# Returns the number of pairs in the cache (not the cap).
+cache.size #=> 0
+
+# Adds a key-value pair to the cache.
+cache['x'] = :y
+cache['y'] = proc { 'anything can go here' }
+cache['z'] = {"x" => 1}
+cache.size #=> 3
+
+# Overwriting a key returns the old value.
+cache['x'] = :q #=> :y
+
+# Retrieves the least recently used key-value pair without updating the LRU
+# list.
+cache.lru_pair #=> ['x', :q]
+
+# Returns true iff the key exists. Does not affect the LRU list.
+cache.key?('x') #=> true
+cache.key?(:test) #=> false
+
+# Retrieves a value by key, updating the LRU list.
+cache['x'] #=> :q
+cache.lru_pair #=> ['y', #<Proc:...>]
+
+# Retrieves and deletes the least recently used key-value pair.
+cache.pop #=> ['y', #<Proc:...>]
+cache.size #=> 2
+cache.lru_pair #=> ['z', {"x" => 1}]
+
+# Retrieves a value by key without updating LRU list.
+cache.peek('z') #=> {"x" => 1}
+cache.lru_pair #=> ['z', {"x" => 1}]
+
+# Deletes a key-value pair, returning the deleted value.
+cache.delete('x') #=> :q
+cache.size #=> 1
+
+# Deletes all pairs from the cache
+cache.clear #=> nil
+
+# Changes the cache's cap.  If necessary, elements will be deleted (in LRU
+# order) to accommodate this.
+cache.resize(1)
+cache[:test1] = 'test1'
+cache[:test2] = 'test2'
+cache.size #=> 1
+
+# includes Enumerable, so things like conversion to Array and Hash are simple:
+cache.to_a
+cache.to_h
+cache.each_key { |k| cache[k] = 'replaced' }
+~~~
+
+
+## Development
+
+For development, check out the repo and then run `bundle install` to install
+development dependencies.  `bundle exec rake test` will run RSpec and Rust
+tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/asppsa/rusty_lru.
+
+
+## License
+
+Licensed under the Apache License 2.0.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+load 'tasks/cargo.rake'
+
+RSpec::Core::RakeTask.new(spec: 'cargo:build')
+
+task test: [:spec, 'cargo:test']
+task default: :test

data/ext/Rakefile

@@ -0,0 +1,2 @@
+load File.join(__dir__, '../tasks/cargo.rake')
+task default: 'cargo:build'

data/lib/rusty_lru/cache.rb

@@ -0,0 +1,220 @@
+require 'forwardable'
+
+module RustyLRU
+  # This class implements an
+  # {https://en.wikipedia.org/wiki/Cache_replacement_policies LRU Cache}.
+  #
+  # {RustyLRU::Cache} objects behave a lot like Ruby's {https://ruby-doc.org/core/Hash.html Hash}
+  # class, but with the important difference that internally a list is
+  # maintained of all keys in order from most recently used to least
+  # recently used (LRU).
+  #
+  # Additionally, if the cache is capped (see
+  # {#initialize}), then when the cache is full to capacity an operation that
+  # adds a new key will cause the key-value pair at the bottom of the LRU list
+  # (i.e. the least-recently-used pair) to be dropped from the cache.  This way
+  # the cache never grows beyond a pre-determined size.
+  #
+  # To precent items from being dropped, some operations (notably {#[]} and
+  # {#[]=} move the key to the front of the list.
+  #
+  # Like {https://ruby-doc.org/core/Hash.html Hash}, this class includes the
+  # {https://ruby-doc.org/core/Enumerable.html Enumerable} module, so it
+  # responds to a number of methods not listed here, such as #map, #reduce, #to_a,
+  # #to_h, etc.
+  #
+  # Like a Hash, values can be any object whatsoever, and keys can be any
+  # object that responds to #hash and #eql? correctly.
+  class Cache
+    # @!method initialize(cap=nil)
+    #   Initializes a new cache object.
+    #
+    #   If no cap is specified, the cache will be uncapped.  A cap can be added
+    #   later using {#resize}.
+    #
+    #   @example Create a LRU cache with no cap
+    #     cache = RustyLRU::Cache.new
+    #
+    #   @example Create a LRU cache with a maximum of 100 items
+    #     cache = RustyLRU::Cache.new(100)
+
+    # @!method [](key)
+    #   Retrieves a value from the cache by key, updating the LRU list.
+    #
+    #   @example Retrieve a value
+    #     cache["x"] #=> "y"
+    #
+    #   @param key [Object] The key to look up in the cache.
+    #   @return [Object, nil] The value corresponding to the key, or nil.
+
+    # @!method []=(key, value)
+    #   Stores a key-value pair in the cache, updating the LRU list.
+    #
+    #   The stored pair becomes the most recently used upon insertion/update.
+    #
+    #   @example Store a pair
+    #     cache[:x] = "z"
+    #     cache[:x] = "y" #=> "z"
+    #
+    #   @param key [Object] The key to store
+    #   @param value [Object] The value to store
+    #   @return [Object, nil] The previous value, or `nil`.
+
+    # @!method delete(key)
+    #   Deletes the key-value pair corresponding to the given key from the
+    #   cache.
+    #
+    #   @example Store and delete a pair
+    #     cache["key"] = :value
+    #     cache.delete("key") #=> :value
+    #
+    #   @param key [Object] The key to delete
+    #   @return [Object, nil] The corresponding value, or nil
+
+    # @!method pop()
+    #   Deletes and returns the least-recently used key-value pair.
+    #
+    #   @example Create a cache with two elements, pop the first one.
+    #     cache = RustyLRU::cache.new
+    #     cache[:a] = 1
+    #     cache[:b] = 2
+    #     cache.pop #=> [:a, 1]
+    #
+    #   @return [<(Object, Object)>, nil] The least-recently-used pair, or nil.
+
+    # @!method peek(key)
+    #   Retrieves a value from the cache by key without updating the LRU list.
+    #
+    #   This method is equivalent to {#[]}, except that the LRU list is not
+    #   affected.
+    #
+    #   @example Peek into the cache
+    #     cache[:x] = "y"
+    #     cache.peek(:x) #=> "y"
+    #
+    #   @param key [Object] The key too look up
+    #   @return [Object, nil] The corresponding value, or nil
+
+    # @!method lru_pair()
+    #   Returns the least-recently used pair without affecting the LRU list.
+    #
+    #   This method is similar to {#pop}, but does not mutate the cache.
+    #
+    #   @example Conditionally remove the LRU pair
+    #     cache.pop if cache.peek_lru == [:x, :y]
+    #
+    #   @return [<(Object, Object)>, nil] The least-recently-used pair, or nil.
+
+    # @!method empty?()
+    #   Returns true iff the cache is empty.
+    #
+    #   @return [Boolean]
+
+    # @!method has_key?(key)
+    #   Returns true iff the given key is present.  Does not affect the LRU list.
+    #
+    #   @param key [Object] The key to test for.
+    #   @return [Boolean]
+
+    # @!method length()
+    #   Returns the number of key-value pairs stored in the cache.
+    #
+    #   @return [Integer]
+
+    # @!method resize(cap)
+    #   Alters the store's cap.
+    #
+    #   @param cap [Integer] The new cap.
+    #   @return [nil]
+
+    # @!method clear()
+    #   Removes all key-value pairs from the cache.
+    #
+    #   @return [nil]
+
+    # @!method each_pair()
+    #   @overload each_pair()
+    #     Yields each key-value pair in the cache to the caller.
+    #
+    #     @example {#each_pair} with a block
+    #       cache.each_pair do |key, value|
+    #         puts "#{key} = #{value}"
+    #       end
+    #
+    #     @yieldparam key [Object] each key
+    #     @yieldparam value [Object] each value
+    #     @return [self]
+    #
+    #   @overload each_pair()
+    #     Returns an {https://ruby-doc.org/core/Enumerator.html Enumerator}
+    #     that will enumerate all key-value pairs.
+    #
+    #     @example Get a hash of values to keys
+    #       cache.each_pair.map { |key, value| [value, key }.to_h
+    #
+    #     @return [Enumerator]
+
+    # @!method each_key()
+    #   @overload each_key()
+    #     Yields each key in the cache to the caller.
+    #
+    #     @yieldparam key [Object] each key
+    #     @return [self]
+    #
+    #   @overload each_key()
+    #     Returns an {https://ruby-doc.org/core/Enumerator.html Enumerator}
+    #     that will enumerate the keys in the cache.
+    #
+    #     @return [Enumerator]
+
+    # @!method each_value()
+    #   @overload each_value()
+    #     Yields each value in the cache to the caller.
+    #
+    #     @yieldparam value [Object] each value
+    #     @return [self]
+    #
+    #   @overload each_value()
+    #     Returns an {https://ruby-doc.org/core/Enumerator.html Enumerator} for
+    #     enumerating the values in the cache.
+    #
+    #     @return [Enumerator]
+
+    # @api private
+    module EnumHelpers
+      def each_pair
+        block_given? ? super : enum_for(:each_pair) { size }
+      end
+
+      def each_key
+        block_given? ? super : enum_for(:each_key) { size }
+      end
+
+      def each_value
+        block_given? ? super : enum_for(:each_value) { size }
+      end
+    end
+
+    prepend EnumHelpers
+    extend Forwardable
+    include Enumerable
+
+    # @!method keys()
+    #   Returns all keys in the cache as an array
+    #
+    #   @return [Array<Object>] All keys
+    def_delegator :each_key, :to_a, :keys
+
+    # @!method values()
+    #   Returns all values in the cache as an array
+    #
+    #   @return [Array<Object>] All values
+    def_delegator :each_value, :to_a, :values
+
+    alias store []=
+    alias key? has_key?
+    alias member? has_key?
+    alias size length
+    alias each each_pair
+  end
+end

data/lib/rusty_lru/version.rb

@@ -0,0 +1,3 @@
+module RustyLRU
+  VERSION = '0.1.0'.freeze
+end

data/lib/rusty_lru.rb

@@ -0,0 +1,11 @@
+require 'rusty_lru/version'
+require 'rutie'
+
+# This is the container module for the {RustyLRU::Cache} class.
+module RustyLRU
+  # Loads Rust code
+  Rutie.new(:rusty_lru).init 'Init_rusty_lru', __dir__
+
+  # Now load the additional methods
+  require_relative './rusty_lru/cache.rb'
+end

data/rusty_lru.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rusty_lru/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rusty_lru'
+  spec.version       = RustyLRU::VERSION
+  spec.authors       = ['Alastair Pharo']
+  spec.email         = ['me@asph.dev']
+
+  spec.summary       = 'An LRU cache implemented in Rust'
+  spec.description   = 'This gem wraps a the lru crate from Rustland, providing a Hash-like interface'
+  spec.homepage      = 'https://github.com/asppsa/rusty_lru'
+  spec.license       = 'Apache-2.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/asppsa/rusty_lru.git'
+  spec.metadata['changelog_uri'] = 'https://github.com/asppsa/rusty_lru/blob/master/CHANGELOG.md'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.extensions << 'ext/Rakefile'
+
+  spec.add_runtime_dependency 'rutie', '~> 0.0.3'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'irb', '~> 1.0.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.74.0'
+end

data/src/lib.rs

@@ -0,0 +1,335 @@
+#[macro_use] extern crate rutie;
+#[macro_use] extern crate lazy_static;
+
+use lru::LruCache;
+use std::ops::{Deref, DerefMut};
+use rutie::{AnyObject, Class, Module, Array, Integer, Boolean, AnyException, GC, NilClass, Object, VM};
+use rutie::types::Value;
+
+pub struct HashableObject {
+  value: Value,
+  hash: i64
+}
+
+impl HashableObject {
+  fn get_hash<T: Object>(object: &T) -> i64 {
+    object.send("hash", &[])
+      .try_convert_to::<Integer>()
+      .map_err(|e| VM::raise_ex(e))
+      .unwrap()
+      .to_i64()
+  }
+}
+
+impl<T: Object> From<&T> for HashableObject {
+  fn from(object: &T) -> Self {
+    Self {
+      hash: Self::get_hash(object),
+      value: object.value()
+    }
+  }
+}
+
+impl From<Value> for HashableObject {
+  fn from(value: Value) -> Self {
+    Self::from(&AnyObject::from(value))
+  }
+}
+
+impl Object for HashableObject {
+  #[inline]
+  fn value(&self) -> Value {
+    self.value
+  }
+}
+
+impl PartialEq for HashableObject {
+  fn eq(&self, other: &Self) -> bool {
+    self.is_eql(other)
+  }
+}
+
+impl Eq for HashableObject {}
+
+impl std::hash::Hash for HashableObject {
+  // Use the oject's hash if it has one; otherwise, fall back to object ID
+  fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
+    self.hash.hash(state);
+  }
+}
+
+pub struct ObjectLruCache {
+  inner: LruCache<HashableObject, AnyObject>,
+}
+
+impl ObjectLruCache {
+  fn new(cap: usize) -> Self {
+    ObjectLruCache { inner: LruCache::new(cap) }
+  }
+
+  fn unbounded() -> Self {
+    ObjectLruCache { inner: LruCache::unbounded() }
+  }
+
+  fn get(&mut self, key: &AnyObject) -> Option<&AnyObject> {
+    self.inner.get(&HashableObject::from(key))
+  }
+
+  fn put(&mut self, key: AnyObject, value: AnyObject) -> Option<AnyObject> {
+    self.inner.put(HashableObject::from(&key), value)
+  }
+
+  fn pop(&mut self, key: &AnyObject) -> Option<AnyObject> {
+    self.inner.pop(&HashableObject::from(key))
+  }
+
+  fn peek(&self, key: &AnyObject) -> Option<&AnyObject> {
+    self.inner.peek(&HashableObject::from(key))
+  }
+
+  fn contains(&self, key: &AnyObject) -> bool {
+    self.inner.contains(&HashableObject::from(key))
+  }
+}
+
+impl Deref for ObjectLruCache {
+  type Target = LruCache<HashableObject, AnyObject>;
+
+  fn deref(&self) -> &LruCache<HashableObject, AnyObject> {
+    &self.inner
+  }
+}
+
+impl DerefMut for ObjectLruCache {
+  fn deref_mut(&mut self) -> &mut LruCache<HashableObject, AnyObject> {
+    &mut self.inner
+  }
+}
+
+wrappable_struct! {
+  ObjectLruCache,
+  ObjectLruCacheWrapper,
+  OBJECT_LRU_CACHE_WRAPPER,
+
+  // Mark each `AnyObject` element of the `inner` cache to prevent garbage collection.
+  // `data` is a mutable reference to the wrapped data (`&mut ObjectLruCache`).
+  mark(cache) {
+    for (key, value) in &cache.inner {
+      GC::mark(key);
+      GC::mark(value);
+    }
+  }
+}
+
+class!(Cache);
+
+impl Cache {
+  fn unwrap_or_raise<T>(result: Result<T, AnyException>) -> T {
+    result
+      .map_err(|e| VM::raise_ex(e))
+      .unwrap()
+  }
+
+  fn cache(&self) -> &ObjectLruCache {
+    self.get_data(&*OBJECT_LRU_CACHE_WRAPPER)
+  }
+
+  fn cache_mut(&mut self) -> &mut ObjectLruCache {
+    self.get_data_mut(&*OBJECT_LRU_CACHE_WRAPPER)
+  }
+
+  fn array_from_pair(pair: (&HashableObject, &AnyObject)) -> Array {
+    let mut array = Array::with_capacity(2);
+    array.push(pair.0.to_any_object());
+    array.push(pair.1.to_any_object());
+    array
+  }
+}
+
+methods! {
+  Cache,
+  itself,
+
+  fn new(cap_result: Integer) -> AnyObject {
+    let cache = match cap_result {
+      Ok(number) => ObjectLruCache::new(number.to_u64() as usize),
+      Err(_)     => ObjectLruCache::unbounded()
+    };
+
+    Class::from_existing("RustyLRU")
+      .get_nested_class("Cache")
+      .wrap_data(cache, &*OBJECT_LRU_CACHE_WRAPPER)
+  }
+
+  fn load(key: AnyObject) -> AnyObject {
+    match itself.cache_mut().get(&Cache::unwrap_or_raise(key)) {
+      Some(value) => value.to_any_object(),
+      None        => NilClass::new().to_any_object()
+    }
+  }
+
+  fn store(key: AnyObject, value: AnyObject) -> AnyObject {
+    match itself.cache_mut().put(Cache::unwrap_or_raise(key), Cache::unwrap_or_raise(value)) {
+      Some(value) => value.to_any_object(),
+      None        => NilClass::new().to_any_object()
+    }
+  }
+
+  fn delete(key: AnyObject) -> AnyObject {
+    match itself.cache_mut().pop(&Cache::unwrap_or_raise(key)) {
+      Some(value) => value,
+      None        => NilClass::new().to_any_object()
+    }
+  }
+
+  fn pop() -> AnyObject {
+    match itself.cache_mut().pop_lru() {
+      Some(pair) => Cache::array_from_pair((&pair.0, &pair.1)).to_any_object(),
+      None       => NilClass::new().to_any_object()
+    }
+  }
+
+  fn peek(key: AnyObject) -> AnyObject {
+    match itself.cache().peek(&Cache::unwrap_or_raise(key)) {
+      Some(value) => value.to_any_object(),
+      None        => NilClass::new().to_any_object()
+    }
+  }
+
+  fn lru_pair() -> AnyObject {
+    match itself.cache().peek_lru() {
+      Some(pair) => Cache::array_from_pair(pair).to_any_object(),
+      None       => NilClass::new().to_any_object()
+    }
+  }
+
+  fn has_key(key: AnyObject) -> Boolean {
+    let contained = itself.cache().contains(&Cache::unwrap_or_raise(key));
+    Boolean::new(contained)
+  }
+
+  fn is_empty() -> Boolean {
+    let empty = itself.cache().is_empty();
+    Boolean::new(empty)
+  }
+
+  fn length() -> Integer {
+    let len = itself.cache().len();
+    Integer::new(len as i64)
+  }
+
+  fn resize(cap: Integer) -> NilClass {
+    itself.cache_mut().resize(Cache::unwrap_or_raise(cap).to_u64() as usize);
+    NilClass::new()
+  }
+
+  fn clear() -> NilClass {
+    itself.cache_mut().clear();
+    NilClass::new()
+  }
+
+  fn each_pair() -> Cache {
+    for pair in &itself.cache().inner {
+      VM::yield_object(Cache::array_from_pair(pair));
+    }
+    itself
+  }
+
+  fn each_key() -> Cache {
+    for (key, _) in &itself.cache().inner {
+      VM::yield_object(key.to_any_object());
+    }
+    itself
+  }
+
+  fn each_value() -> Cache {
+    for (_, value) in &itself.cache().inner {
+      VM::yield_object(value.to_any_object());
+    }
+    itself
+  }
+}
+
+#[allow(non_snake_case)]
+#[no_mangle]
+pub extern "C" fn Init_rusty_lru() {
+  let parent = Class::from_existing("Object");
+  Module::from_existing("RustyLRU")
+    .define_nested_class("Cache", Some(&parent))
+    .define(|itself| {
+      itself.def_self("new", new);
+
+      itself.def("[]", load);
+      itself.def("[]=", store);
+      itself.def("delete", delete);
+      itself.def("pop", pop);
+      itself.def("peek", peek);
+      itself.def("lru_pair", lru_pair);
+      itself.def("empty?", is_empty);
+      itself.def("has_key?", has_key);
+      itself.def("length", length);
+      itself.def("resize", resize);
+      itself.def("clear", clear);
+      itself.def("each_pair", each_pair);
+      itself.def("each_key", each_key);
+      itself.def("each_value", each_value);
+    });
+}
+
+#[cfg(test)]
+mod tests {
+  use super::*;
+  use std::collections::hash_map::DefaultHasher;
+  use std::hash::Hash;
+  use std::hash::Hasher;
+  use rutie::RString;
+
+  #[test]
+  fn test() {
+    VM::init();
+
+    /*
+     * Test HashableObject hashes as intended
+     */
+    let nil = NilClass::new();
+    let ho = HashableObject::from(&nil);
+
+    let mut hasher1 = DefaultHasher::new();
+    let mut hasher2 = DefaultHasher::new();
+
+    nil.send("hash", &[]).try_convert_to::<Integer>().unwrap().to_i64().hash(&mut hasher1);
+    ho.hash(&mut hasher2);
+
+    let hash1 = hasher1.finish();
+    let hash2 = hasher2.finish();
+    assert_eq!(hash1, hash2);
+
+    /*
+     * Create a cache and make sure it works
+     */
+    let mut cache = ObjectLruCache::new(2);
+    let key1 = RString::new_utf8("key1").to_any_object();
+    let key2 = RString::new_utf8("key2").to_any_object();
+
+    let val1 = RString::new_utf8("val1").to_any_object();
+    let val2 = RString::new_utf8("val2").to_any_object();
+
+    // We use to_any_object() to clone the reference to the ruby object, so that it can be put into
+    // the cache
+    assert_eq!(cache.put(key1.to_any_object(), val1.to_any_object()), None);
+    // Returns the old value if there was one
+    assert_eq!(cache.put(key1.to_any_object(), val2.to_any_object()), Some(val1));
+    assert_eq!(cache.contains(&key1), true);
+
+    // These have different caching behaviours, but should all return the same
+    assert_eq!(cache.get(&key2), None);
+    assert_eq!(cache.peek(&key2), None);
+    assert_eq!(cache.pop(&key2), None);
+
+    assert_eq!(cache.get(&key1), Some(&val2));
+    assert_eq!(cache.peek(&key1), Some(&val2));
+    assert_eq!(cache.pop(&key1), Some(val2));
+    assert_eq!(cache.pop(&key1), None);
+    assert_eq!(cache.peek(&key1), None);
+  }
+}

data/tasks/cargo.rake

@@ -0,0 +1,9 @@
+namespace :cargo do
+  task :build do
+    sh 'cargo build --release'
+  end
+
+  task :test do
+    sh 'cargo test'
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: rusty_lru
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alastair Pharo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rutie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+description: This gem wraps a the lru crate from Rustland, providing a Hash-like interface
+email:
+- me@asph.dev
+executables: []
+extensions:
+- ext/Rakefile
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Cargo.toml
+- Gemfile
+- LICENSE
+- NOTICE
+- README.md
+- Rakefile
+- ext/Rakefile
+- lib/rusty_lru.rb
+- lib/rusty_lru/cache.rb
+- lib/rusty_lru/version.rb
+- rusty_lru.gemspec
+- src/lib.rs
+- tasks/cargo.rake
+homepage: https://github.com/asppsa/rusty_lru
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/asppsa/rusty_lru
+  source_code_uri: https://github.com/asppsa/rusty_lru.git
+  changelog_uri: https://github.com/asppsa/rusty_lru/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: An LRU cache implemented in Rust
+test_files: []