Class: JekyllAdmin::DataFile

Inherits:
Object
  • Object
show all
Extended by:
PathHelper
Includes:
APIable, PathHelper, URLable
Defined in:
lib/jekyll-admin/data_file.rb

Constant Summary collapse

METHODS_FOR_LIQUID = 
%w(path relative_path slug ext title).freeze
EXTENSIONS = 
%w(yaml yml json csv).freeze

Constants included from APIable

APIable::CONTENT_FIELDS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from PathHelper

relative_write_path, renamed?, sanitized_path, sanitized_relative_path, write_path

Methods included from URLable

#api_url, #entries_url, #http_url

Methods included from APIable

#to_api

Constructor Details

#initialize(id) ⇒ DataFile

Initialize a new DataFile object

id - the file ID as passed from the API. This may or may not have an extension



16
17
18
 
# File 'lib/jekyll-admin/data_file.rb', line 16

def initialize(id)
  @id ||= File.extname(id).empty? ? "#{id}.yml" : id
end

Instance Attribute Details

#id ⇒ Object (readonly) Also known as: relative_path

Returns the value of attribute id.



11
12
13
 
# File 'lib/jekyll-admin/data_file.rb', line 11

def id
  @id
end

Class Method Details

.all ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/jekyll-admin/data_file.rb', line 71

def self.all
  data_dir = Jekyll.sanitized_path(JekyllAdmin.site.source, DataFile.data_dir)
  data_dir = Pathname.new(data_dir)
  Dir["#{data_dir}/**/*.{#{EXTENSIONS.join(",")}}"].map do |path|
    new(Pathname.new(path).relative_path_from(data_dir).to_s)
  end
end

.data_dir ⇒ Object

Relative path to data directory within site source



80
81
82
 
# File 'lib/jekyll-admin/data_file.rb', line 80

def self.data_dir
  JekyllAdmin.site.config["data_dir"]
end

Instance Method Details

#absolute_path ⇒ Object Also known as: file_path 



60
61
62
 
# File 'lib/jekyll-admin/data_file.rb', line 60

def absolute_path
  sanitized_path(path)
end

#content ⇒ Object

Returnes (re)parsed content using Jekyll’s native parsing mechanism



31
32
33
 
# File 'lib/jekyll-admin/data_file.rb', line 31

def content
  @content ||= data_reader.read_data_file(absolute_path)
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/jekyll-admin/data_file.rb', line 21

def exists?
  @exists ||= File.exist?(absolute_path)
end

#ext ⇒ Object Also known as: extension

Returns the file’s extension with preceeding ‘.`



36
37
38
39
40
41
42
 
# File 'lib/jekyll-admin/data_file.rb', line 36

def ext
  @ext ||= if File.extname(id).to_s.empty?
             ".yml"
           else
             File.extname(id)
           end
end

#path ⇒ Object

Returns path relative to site source



56
57
58
 
# File 'lib/jekyll-admin/data_file.rb', line 56

def path
  ensure_leading_slash(File.join(DataFile.data_dir, relative_path))
end

#raw_content ⇒ Object

Returns unparsed content as it exists on disk



26
27
28
 
# File 'lib/jekyll-admin/data_file.rb', line 26

def raw_content
  @raw_content ||= File.open(absolute_path, "r:UTF-8", &:read)
end

#slug ⇒ Object

Returns the file’s sanitized slug (as used in ‘site.data`)



46
47
48
 
# File 'lib/jekyll-admin/data_file.rb', line 46

def slug
  @slug ||= data_reader.sanitize_filename(basename)
end

#title ⇒ Object

Returns the human-readable title of the data file



51
52
53
 
# File 'lib/jekyll-admin/data_file.rb', line 51

def title
  @title ||= Jekyll::Utils.titleize_slug(slug.tr("_", "-"))
end

#to_liquid ⇒ Object

Mimics Jekyll’s native to_liquid functionality by returning a hash of data file metadata



67
68
69
 
# File 'lib/jekyll-admin/data_file.rb', line 67

def to_liquid
  @to_liquid ||= METHODS_FOR_LIQUID.map { |key| [key, public_send(key)] }.to_h
end