Sha256: 735ecf962824a2eaee2e425e6c17c87b4976a4cf9e31cd560e50009ce9c6bbfc

Contents?: true

Size: 1.71 KB

Versions: 7

Compression:

Stored size: 1.71 KB

Contents

module Picky

  module Backends

    class Memory

      # Base class for all memory-based index files.
      #
      # Provides necessary helper methods for its
      # subclasses.
      # Not directly useable, as it does not provide
      # dump/load methods.
      #
      class Basic

        include Helpers::File

        # This file's cache file without extensions.
        #
        attr_reader :cache_file_path
        
        # What hash type to use. Default: ::Hash
        #
        attr_reader :hash_type

        # An index cache takes a path, without file extension,
        # which will be provided by the subclasses.
        #
        def initialize cache_file_path, hash_type = Hash, options = {}
          @cache_file_path = cache_file_path
          @hash_type       = hash_type
          @empty           = options[:empty]
          @initial         = options[:initial]
        end

        # The default extension for index files is "index".
        #
        def extension
          :index
        end
        def type
          :memory
        end
        def cache_path
          [cache_file_path, type, extension].join(?.)
        end

        # The empty index that is used for putting the index
        # together before it is dumped into the files.
        #
        def empty
          @empty && @empty.clone || hash_type.new
        end

        # The initial content before loading from file/indexing.
        #
        def initial
          @initial && @initial.clone || hash_type.new
        end

        # Deletes the file.
        #
        def delete
          `rm -Rf #{cache_path}`
        end

        #
        #
        def to_s
          "#{self.class}(#{cache_path})"
        end

      end

    end

  end

end

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
picky-4.31.3 lib/picky/backends/memory/basic.rb
picky-4.31.2 lib/picky/backends/memory/basic.rb
picky-4.31.1 lib/picky/backends/memory/basic.rb
picky-4.31.0 lib/picky/backends/memory/basic.rb
picky-4.30.0 lib/picky/backends/memory/basic.rb
picky-4.29.0 lib/picky/backends/memory/basic.rb
picky-4.28.1 lib/picky/backends/memory/basic.rb