Module: Stic::SiteBase

Included in:
Blob, Layout
Defined in:
lib/stic/site_base.rb

Overview

Stic::SiteBase

Base module for all site objects.

Attributes collapse

Construction collapse

Instance Attribute Details

#data ⇒ HashWithIndifferentAccess (readonly)

A hash of additional meta data.

The blob does not assume, process or load any kind of meta data.

Returns:

  • (HashWithIndifferentAccess) —

    Meta data hash.



23
24
25
 
# File 'lib/stic/site_base.rb', line 23

def data
  @data
end

#site ⇒ Site (readonly)

The Stic::Site object.

Returns:



15
16
17
 
# File 'lib/stic/site_base.rb', line 15

def site
  @site
end

Instance Method Details

#initialize(opts = {}) ⇒ Object

Initialize new blob.

Parameters:

  • opts (Hash) (defaults to: {}) —

    Initialization options.

Options Hash (opts):

  • :site (Site) —

    Required Site object.

  • :data (Hash) —

    Optional meta data hash.



33
34
35
36
 
# File 'lib/stic/site_base.rb', line 33

def initialize(opts = {})
  @site = opts.delete(:site) { raise ::ArgumentError.new 'Argument `:site` required.' }
  @data = ::ActiveSupport::HashWithIndifferentAccess.new opts.delete(:data)
end