Class: SleepingKingStudios::Docs::Jekyll::Generators::VersionGenerator

Parent Namespace

SleepingKingStudios::Docs::Jekyll::Generators

Inherited Classes

Cuprum::Cli::Files::Generator > Object

Defined In

lib/sleeping_king_studios/docs/jekyll/generators/version_generator.rb

Table Of Contents

• Overview
• Instance Methods
  • parameters
  • sortable_version
  • version_slug

Overview

Generator class for writing versions as Jekyll collection items.

Back To Top

Instance Methods

#parameters => Hash

Returns

• (Hash) — parameters used to resolve output file paths and contents.

#sortable_version => String

Generates a sortable copy of the version string.

Splits the string into .-delineated segments, then left-pads each numeric segment with zeroes to a length of 3.

Examples

generator =
  SleepingKingStudios::Docs::Jekyll::Generators::Generator
  .new(version: '0.10.2')

generator.sortable_version
#=> '000.010.002'

Returns

• (String) — the sortable version string.

#version_slug => String

Returns

• (String) — the version string, with `.` characters converted to dashes for use in file names.

Back To Top

---

Back to Documentation | Reference | SleepingKingStudios | SleepingKingStudios::Docs | SleepingKingStudios::Docs::Jekyll | SleepingKingStudios::Docs::Jekyll::Generators