Class: Webby::Resources::Resource

Attributes

dir	[R]	The directory of the resource excluding the content directory
ext	[R]	Extesion of the resource file
mtime	[R]	Resource file modification time
name	[R]	The name of the file excluding the directory and extension
path	[R]	The full path to the resource file

Public Class methods

Resource.new( filename ) => resource

Creates a new resource object given the filename.

[Source]

# File lib/webby/resources/resource.rb, line 38
  def initialize( fn )
    @path  = fn
    @dir   = ::Webby::Resources.dirname(@path)
    @name  = ::Webby::Resources.basename(@path)
    @ext   = ::Webby::Resources.extname(@path)
    @mtime = ::File.mtime @path

    @_meta_data =  {}
    self._reset
  end

Public Instance methods

resource <=> other => -1, 0, +1, or nil

Resource comparison operates on the full path of the resource objects and uses the standard String comparison operator. Returns nil if other is not a Resource instance.

[Source]

# File lib/webby/resources/resource.rb, line 69
  def <=>( other )
    return unless other.kind_of? ::Webby::Resources::Resource
    self.destination <=> other.destination
  end

==( other )

Alias for equal?

resource[key] => value or nil

Returns the value associated with the given meta-data key. Key is converted into a string.

[Source]

# File lib/webby/resources/resource.rb, line 80
  def []( key )
    _meta_data[key.to_s]
  end

resource[key] = value

Sets the given meta-data key to the value. Key is converted into a string.

[Source]

# File lib/webby/resources/resource.rb, line 90
  def []=( key, value )
    _meta_data[key.to_s] = value
  end

destination()

Returns the path in the output directory where the resource will be generated. This path is used to determine if the resource is dirty and in need of generating.

[Source]

# File lib/webby/resources/resource.rb, line 166
  def destination
    return @destination unless @destination.nil?

    @destination = ::File.join(::Webby.site.output_dir, directory, filename)
    ext = extension
    unless ext.nil? or ext.empty?
      @destination << '.' << ext
    end
    @destination
  end

directory()

The location of this resource in the directory structure. This directory does not include the content folder or the output folder.

[Source]

# File lib/webby/resources/resource.rb, line 157
  def directory
    return _meta_data['directory'] if _meta_data.has_key? 'directory'
    dir
  end

dirty? => true or false

Returns true if this resource is newer than its corresponding output product. The resource needs to be rendered (if a page or layout) or copied (if a static file) to the output directory.

[Source]

# File lib/webby/resources/resource.rb, line 113
  def dirty?
    return _meta_data['dirty'] if _meta_data.has_key? 'dirty'

    # if the destination file does not exist, then we are dirty
    return true unless test(?e, destination)

    # if this file's mtime is larger than the destination file's
    # mtime, then we are dirty
    dirty = @mtime > ::File.mtime(destination)
    return dirty if dirty

    # check to see if the layout is dirty, and if it is then we
    # are dirty, too
    if _meta_data.has_key? 'layout'
      lyt = ::Webby::Resources.find_layout(_meta_data['layout'])
      unless lyt.nil?
        return true if lyt.dirty?
      end
    end

    # if we got here, then we are not dirty
    false
  end

eql?( other )

Alias for equal?

equal?( other ) => true or false

Returns true if the path of this resource is equivalent to the path of the other resource. Returns false if this is not the case.

[Source]

# File lib/webby/resources/resource.rb, line 55
  def equal?( other )
    return false unless other.kind_of? ::Webby::Resources::Resource
    (self.destination == other.destination) && (self.path == other.path)
  end

extension()

The resource file extension. This will either be the extension of the file or the ‘extension’ attribute from the meta-data if present.

[Source]

# File lib/webby/resources/resource.rb, line 149
  def extension
    return _meta_data['extension'] if _meta_data.has_key? 'extension'
    ext
  end

filename()

The resource filename excluding path and extension. This will either be the name of the file or the ‘filename’ attribute from the meta-data if present.

[Source]

# File lib/webby/resources/resource.rb, line 141
  def filename
    return _meta_data['filename'] if _meta_data.has_key? 'filename'
    name
  end

method_missing( symbol [, *args, &block] ) => result

Invoked by Ruby when a message is sent to the resource that it cannot handle. The default behavior is to convert symbol to a string and search for that string in the resource‘s meta-data. If found, the meta-data item is returned; otherwise, nil is returned.

[Source]

# File lib/webby/resources/resource.rb, line 102
  def method_missing( name, *a, &b )
    _meta_data[name.to_s]
  end

url()

Returns a string suitable for use as a URL linking to this resource.

[Source]

# File lib/webby/resources/resource.rb, line 179
  def url
    return @url unless @url.nil?
    @url = destination.sub(::Webby.site.output_dir, '')
  end

Methods

Attributes

Public Class methods

Public Instance methods