public-suffix-list 0.0.3 → 0.0.4

data/lib/public_suffix_list.rb

@@ -1,11 +1,12 @@
 $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__))
 
 require 'open-uri'
+require "public_suffix_list/cache_file.rb"
 require "public_suffix_list/parser.rb"
 
 class PublicSuffixList
 
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 
   def self.config
     @@config ||= Config.new
@@ -29,9 +30,14 @@ class PublicSuffixList
 
   end
 
+  attr_reader :config, :cache_file
+
   def initialize(options = {})
     @config = self.class.config.dup
     options.each { |k, v| @config.send("#{k}=", v) }
+    if @config.cache_dir
+      @cache_file = CacheFile.new(@config)
+    end
     if @config.cache_dir && File.directory?(@config.cache_dir) && File.exist?(File.join(@config.cache_dir, name))
       uncache or (download and cache)
     elsif @config.cache_dir && File.directory?(@config.cache_dir)
@@ -66,13 +72,17 @@ class PublicSuffixList
   end
 
   def cache
-    @cache = {:rules => @rules, :created_at => Time.now}
+    @cache = {:rules => @rules, :created_at => Time.now, :tag => rand(36**8).to_s(36)}
     open(File.join(@config.cache_dir, name), "w") { |f| Marshal.dump(@cache, f) }
   end
 
   def uncache
     open(File.join(@config.cache_dir, name), "r") { |f| @cache = Marshal.load(f) }
-    @rules = @cache[:rules] if Time.now < @cache[:created_at] + @config.cache_expiry_period
+    @rules = @cache[:rules] unless expired?
+  end
+
+  def expired?
+    !(@config.cache_expiry_period.nil? or @config.cache_expiry_period == 0 or Time.now < @cache[:created_at] + @config.cache_expiry_period)
   end
 
   def download

data/lib/public_suffix_list/cache_file.rb

@@ -0,0 +1,59 @@
+class PublicSuffixList
+
+  class CacheFile
+
+    def initialize(config)
+      @config = config
+    end
+
+    def cache?
+      @config.cache_dir && true
+    end
+
+    def name
+      URI.parse(@config.effective_tld_names_url).path.split("/").last + ".cache" if cache?
+    end
+
+    def file
+      File.join(@config.cache_dir, name) if cache?
+    end
+
+    def exist?
+      File.exist?(file) if cache?
+    end
+
+    def delete
+      File.delete(file) if exist?
+    end
+
+    def load_data
+      open(file, "r") { |f| @data = Marshal.load(f) } if exist?
+    end
+
+    def dump_data
+      open(file, "w") { |f| Marshal.dump(@data, f) } if cache?
+    end
+
+    def data
+      @data or (load_data and @data) or @data = {:created_at => Time.now}
+    end
+
+    def data=(data)
+      @data = data and dump_data
+    end
+
+    def expired?
+      !cache? or !([0, nil].include?(@config.cache_expiry_period) or data[:created_at] + @config.cache_expiry_period > Time.now)
+    end
+
+    def read_attribute(attribute)
+      data[attribute]
+    end
+
+    def write_attribute(attribute, value)
+      data[attribute] = value
+    end
+
+  end
+
+end

data/spec/caching.spec

@@ -1,21 +1,59 @@
 require 'tmpdir'
 require 'lib/public_suffix_list'
 
-options = {
-  :cache_dir => Dir.tmpdir,
-  :cache_expiry_period => 10,
-  :effective_tld_names_url => "spec/test.dat"
-}
-
 describe PublicSuffixList do
 
+  FILE = File.join(Dir.tmpdir, "test.dat.cache")
+
   before do
-    File.delete(File.join(Dir.tmpdir, "test.dat.cache")) if File.exist?(File.join(Dir.tmpdir, "test.dat.cache"))
+    File.delete(FILE) if File.exist?(FILE)
+  end
+
+  it "should cache when instructed to do so" do
+    File.exist?(FILE).should be false
+    public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat", :cache_dir => Dir.tmpdir, :cache_expiry_period => 10)
+    public_suffix_list.cache_file.cache?.should be true
+    public_suffix_list.cache_file.exist?.should be true
+    created_at = public_suffix_list.cache_file.read_attribute(:created_at)
+    tag  = public_suffix_list.cache_file.read_attribute(:tag)
+    public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat", :cache_dir => Dir.tmpdir, :cache_expiry_period => 10)
+    public_suffix_list.cache_file.cache?.should be true
+    public_suffix_list.cache_file.exist?.should be true
+    public_suffix_list.cache_file.read_attribute(:created_at).should == created_at
+    public_suffix_list.cache_file.read_attribute(:tag).should == tag
+    public_suffix_list.cache_file.write_attribute :created_at, Time.now - 100
+    public_suffix_list.cache_file.dump_data
+    public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat", :cache_dir => Dir.tmpdir, :cache_expiry_period => 10)
+    public_suffix_list.cache_file.cache?.should be true
+    public_suffix_list.cache_file.exist?.should be true
+    public_suffix_list.cache_file.read_attribute(:created_at).should_not == created_at
+    public_suffix_list.cache_file.read_attribute(:tag).should_not == tag
   end
 
-  it "should cache when instructed to" do
-    public_suffix_list = PublicSuffixList.new(options)
-    File.exist?(File.join(Dir.tmpdir, "test.dat.cache")).should be true
+  it "should allow 0 or nil to specify an infinite cache expiry period" do
+    File.exist?(FILE).should be false
+    public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat", :cache_dir => Dir.tmpdir, :cache_expiry_period => 10)
+    public_suffix_list.cache_file.exist?.should be true
+    public_suffix_list.cache_file.expired?.should be false
+    public_suffix_list.cache_file.write_attribute :created_at, Time.now - 100
+    public_suffix_list.cache_file.expired?.should be true
+    public_suffix_list.cache_file.exist?.should be true
+    public_suffix_list.cache_file.delete
+    public_suffix_list.cache_file.exist?.should be false
+    public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat", :cache_dir => Dir.tmpdir, :cache_expiry_period => 0)
+    public_suffix_list.cache_file.exist?.should be true
+    public_suffix_list.cache_file.expired?.should be false
+    public_suffix_list.cache_file.write_attribute :created_at, Time.now - 10000000
+    public_suffix_list.cache_file.expired?.should be false
+    public_suffix_list.cache_file.exist?.should be true
+    public_suffix_list.cache_file.delete
+    public_suffix_list.cache_file.exist?.should be false
+    public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat", :cache_dir => Dir.tmpdir, :cache_expiry_period => nil)
+    public_suffix_list.cache_file.exist?.should be true
+    public_suffix_list.cache_file.expired?.should be false
+    public_suffix_list.cache_file.write_attribute :created_at, Time.now - 10000000
+    public_suffix_list.cache_file.expired?.should be false
+    public_suffix_list.cache_file.exist?.should be true
   end
 
 end

data/spec/public_suffix_list.spec

@@ -4,6 +4,7 @@ describe PublicSuffixList do
 
   before do
     @public_suffix_list = PublicSuffixList.new(:effective_tld_names_url => "spec/test.dat")
+    @public_suffix_list.cache_file.should be nil
   end
 
   it "should calculate tld and cdn correctly" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: public-suffix-list
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Todd Sundsted
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-10 00:00:00 -05:00
+date: 2010-01-11 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -25,6 +25,7 @@ files:
 - README.rdoc
 - lib/public_suffix_list.rb
 - lib/public_suffix_list/parser.rb
+- lib/public_suffix_list/cache_file.rb
 - spec/caching.spec
 - spec/cookie_calculation.spec
 - spec/public_suffix_list.spec