Sha256: 69c052b88839e4356fd24fe5218b658ccfd11eea23f6390acaded20c4b22be1f

Contents?: true

Size: 1.72 KB

Versions: 30

Compression:

Stored size: 1.72 KB

Contents

module YARD
  module Server
    # Implements static caching for requests.
    #
    # @see Router Router documentation for "Caching"
    module StaticCaching
      # Called by a router to return the cached object. By default, this
      # method performs disk-based caching. To perform other forms of caching,
      # implement your own +#check_static_cache+ method and mix the module into
      # the Router class.
      #
      # Note that caching does not occur here. This method simply checks for
      # the existence of cached data. To actually cache a response, see
      # {Commands::Base#cache}.
      #
      # @example Implementing In-Memory Cache Checking
      #   module MemoryCaching
      #     def check_static_cache
      #       # $memory_cache is filled by {Commands::Base#cache}
      #       cached_data = $memory_cache[request.path]
      #       if cached_data
      #         [200, {'Content-Type' => 'text/html'}, [cached_data]]
      #       else
      #         nil
      #       end
      #     end
      #   end
      #
      #   class YARD::Server::Router; include MemoryCaching; end
      # @return [Array(Number,Hash,Array)] the Rack-style response
      # @return [nil] if no cache is available and routing should continue
      # @see Commands::Base#cache
      def check_static_cache
        return nil unless adapter.document_root
        cache_path = File.join(adapter.document_root, request.path.sub(/\.html$/, '') + '.html')
        cache_path = cache_path.sub(%r{/\.html$}, '.html')
        if File.file?(cache_path)
          log.debug "Loading cache from disk: #{cache_path}"
          return [200, {'Content-Type' => 'text/html'}, [File.read_binary(cache_path)]]
        end
        nil
      end
    end
  end
end

Version data entries

30 entries across 30 versions & 4 rubygems

Version Path
challah-0.6.2 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.6.1 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.6.0 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.5.4 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.5.3 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.5.2 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.5.1 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.5.0 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.4.1 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.4.0 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.3.5 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.3.4 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.3.3 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.3.2 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.3.1 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.3.0 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.2.1 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
challah-0.2.0 vendor/bundle/gems/yard-0.7.5/lib/yard/server/static_caching.rb
yard-0.7.5 lib/yard/server/static_caching.rb
nutshell-crm-0.0.6.alpha vendor/bundle/gems/yard-0.7.4/lib/yard/server/static_caching.rb