Module: CachingMatcher

Defined in:
lib/caching_matcher.rb,
lib/caching_matcher/caching_matcher.rb

Defined Under Namespace

Classes: BeCachedMatcher, BeExpiredMatcher, MatcherBase

Constant Summary collapse

LIBPATH =

:stopdoc:

::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
PATH = 
::File.dirname(LIBPATH) + ::File::SEPARATOR

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.libpath(*args, &block) ⇒ Object

Returns the library path for the module. If any arguments are given, they will be joined to the end of the libray path using File.join.



19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/caching_matcher.rb', line 19

def self.libpath( *args, &block )
  rv =  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
  if block
    begin
      $LOAD_PATH.unshift LIBPATH
      rv = block.call
    ensure
      $LOAD_PATH.shift
    end
  end
  return rv
end

.path(*args, &block) ⇒ Object

Returns the lpath for the module. If any arguments are given, they will be joined to the end of the path using File.join.



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/caching_matcher.rb', line 36

def self.path( *args, &block )
  rv = args.empty? ? PATH : ::File.join(PATH, args.flatten)
  if block
    begin
      $LOAD_PATH.unshift PATH
      rv = block.call
    ensure
      $LOAD_PATH.shift
    end
  end
  return rv
end

.require_all_libs_relative_to(fname, dir = nil) ⇒ Object

Utility method used to require all files ending in .rb that lie in the directory below this file that has the same name as the filename passed in. Optionally, a specific directory name can be passed in such that the filename does not have to be equivalent to the directory.



54
55
56
57
58
59
60
 
# File 'lib/caching_matcher.rb', line 54

def self.require_all_libs_relative_to( fname, dir = nil )
  dir ||= ::File.basename(fname, '.*')
  search_me = ::File.expand_path(
      ::File.join(::File.dirname(fname), dir, '**', '*.rb'))

  Dir.glob(search_me).sort.each {|rb| require rb}
end

.version ⇒ Object

Returns the version string for the library.



11
12
13
 
# File 'lib/caching_matcher.rb', line 11

def self.version
  @version ||= File.read(path('version.txt')).strip
end

Instance Method Details

#be_cached(controller, url_options) ⇒ Object 



69
70
71
 
# File 'lib/caching_matcher/caching_matcher.rb', line 69

def be_cached(controller,url_options)
  BeCachedMatcher.new(controller,url_options)
end

#be_expired(controller, url_options) ⇒ Object 



95
96
97
 
# File 'lib/caching_matcher/caching_matcher.rb', line 95

def be_expired(controller,url_options)
  BeExpiredMatcher.new(controller,url_options)
end

#clear_cache(controller, url_options) ⇒ Object 



42
43
44
45
 
# File 'lib/caching_matcher/caching_matcher.rb', line 42

def clear_cache(controller, url_options)
  mb = MatcherBase.new(controller, url_options)
  ActionController::Base.cache_store.delete(mb.cache_key)
end

#prime_cache(controller, url_options) ⇒ Object 



37
38
39
40
 
# File 'lib/caching_matcher/caching_matcher.rb', line 37

def prime_cache(controller, url_options)
  mb = MatcherBase.new(controller, url_options)
  ActionController::Base.cache_store.write(mb.cache_key, "Some data")
end