sized_list 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/active_support/cache/lru.rb

@@ -8,6 +8,7 @@ module ActiveSupport
       def initialize(options)
         @options = options
         @sized_list = SizedList.new @options[:max_size]
+        @sized_list.enable_time_based_stats = !! @options[:enable_time_based_stats]
       end
 
       # Silence the logger.
@@ -57,6 +58,9 @@ module ActiveSupport
       def write(name, value, options=nil)
         instrument(:write, name, options) do |payload|
           @sized_list[name] = value
+          payload[:eviction] = @sized_list.evicted?
+          payload[:total_evictions] = @sized_list.evictions
+          payload[:eviction_frequency] = @sized_list.eviction_frequency
         end
       end
 

data/lib/sized_list.rb

@@ -3,23 +3,50 @@ class SizedList
 
   attr_reader :max_size
 
+  # Basic Stats
+  attr_accessor :enable_time_based_stats
+
+  attr_reader :hits,
+              :misses,
+              :writes,
+              :evictions
+
   def initialize(max_size)
     @max_size = max_size
     @used = []
     @items = {}
+    self.reset_stats
+  end
+
+  def reset_stats
+    @hits = 0
+    @misses = 0
+    @writes = 0
+    @evictions = 0
+    @total_eviction_time = 0.0
+    @last_evicted_at = nil
   end
 
   def get(key)
     if value = @items[key]
+      @hits += 1
       used! key
+    else
+      @misses += 1
     end
     value
   end
   alias [] get
 
   def set(key, value)
+    @writes += 1 unless exist?(key)
     @items[key] = value
-    remove_least_recently_used! if @items.size > @max_size
+    if @items.size > @max_size
+      @evicted = true
+      remove_least_recently_used!
+    else
+      @evicted = false
+    end
     used! key
     nil
   end
@@ -43,11 +70,20 @@ class SizedList
     @items.values
   end
 
+  def evicted?
+    !! @evicted
+  end
+
   def exist?(key)
     @items.has_key? key
   end
   alias exists? exist?
 
+  def eviction_frequency
+    return 0.0 unless @enable_time_based_stats && @evictions > 1
+    @total_eviction_time / @evictions
+  end
+
   private
 
   def used!(key)
@@ -62,6 +98,16 @@ class SizedList
   end
 
   def remove_least_recently_used!
+    @evictions += 1
+
+    if @enable_time_based_stats
+      now = Time.now
+      if @last_evicted_at
+        @total_eviction_time += now - @last_evicted_at
+      end
+      @last_evicted_at = now
+    end
+
     key = @used.pop
     @items.delete key
   end

data/sized_list.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "sized_list"
-  s.version = "0.2.0"
+  s.name = %q{sized_list}
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Doug Youch"]
-  s.date = "2013-05-20"
-  s.description = "Uses LRU functionality to keep a limited size list of items"
-  s.email = "doug@sessionm.com"
+  s.date = %q{2013-05-22}
+  s.description = %q{Uses LRU functionality to keep a limited size list of items}
+  s.email = %q{doug@sessionm.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -30,16 +30,17 @@ Gem::Specification.new do |s|
     "spec/sized_list_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = "http://github.com/dyouch5@yahoo.com/sized_list"
+  s.homepage = %q{http://github.com/dyouch5@yahoo.com/sized_list}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
-  s.summary = "Limited size list"
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Limited size list}
 
   if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<rspec>, [">= 0"])

data/spec/sized_list_spec.rb

@@ -7,6 +7,7 @@ describe SizedList do
     list.size.should == 5
     100.times { |i| list.set "new-item-#{i}", 1 }
     list.size.should == 5
+    list.evictions .should == 100
     list['new-item-99'].should == 1
   end
 
@@ -21,30 +22,52 @@ describe SizedList do
 
     list['b'].should == 1
     list.keys.should == ['b', 'e', 'd', 'c', 'a']
+    list.evictions.should == 0
+    list.misses.should == 0
+    list.hits.should == 1
+    list.writes.should == 5
 
     list['b'].should == 1
     list.keys.should == ['b', 'e', 'd', 'c', 'a']
+    list.evictions.should == 0
+    list.misses.should == 0
+    list.hits.should == 2
+
+    list['not_here'].should be_nil
+    list.evictions.should == 0
+    list.misses.should == 1
+    list.hits.should == 2
   end
 
   it "should remove the least accessed" do
     list = SizedList.new 5
+    list.enable_time_based_stats = true
     list['a'] = 1
     list['b'] = 1
     list['c'] = 1
     list['d'] = 1
     list['e'] = 1
     list.keys.should == ['e', 'd', 'c', 'b', 'a']
+    list.writes.should == 5
 
     list['a'].should == 1
     list.keys.should == ['a', 'e', 'd', 'c', 'b']
+    list.evictions.should == 0
 
     list['new'] = 1
+    list.evicted?.should be_true
+    list['new'] = 1
+    list.evicted?.should be_false
     list.keys.should == ['new', 'a', 'e', 'd', 'c']
+    list.evictions.should == 1
+    list.writes.should == 6
 
     list['d'].should == 1
     list.keys.should == ['d', 'new', 'a', 'e', 'c']
+    list.evictions.should == 1
 
     list['new2'] = 1
     list.keys.should == ['new2', 'd', 'new', 'a', 'e']
+    list.evictions.should == 2
   end
 end

metadata

@@ -1,72 +1,71 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: sized_list
-version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
 platform: ruby
-authors:
+authors: 
 - Doug Youch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-05-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
   name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.12'
-- !ruby/object:Gem::Dependency
+  type: :development
   name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 8
+        - 4
         version: 1.8.4
-  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.8.4
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  name: rspec
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
 description: Uses LRU functionality to keep a limited size list of items
 email: doug@sessionm.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
-files:
+files: 
 - .document
 - Gemfile
 - Gemfile.lock
@@ -79,32 +78,35 @@ files:
 - sized_list.gemspec
 - spec/sized_list_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://github.com/dyouch5@yahoo.com/sized_list
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
       - 0
-      hash: 2720490057972214731
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Limited size list
 test_files: []
+