@ -1,14 +1,26 @@
use crate ::AppContext ; use crate ::AppContext ;
use crate ::config ::{ ChannelName , Config , EntryName , VersionName } ;
use anyhow ::bail ; use anyhow ::bail ;
use colored ::Colorize ;
use faccess ::PathExt ; use faccess ::PathExt ;
use std ::fs ::OpenOptions ; use serde ::{ Deserialize , Serialize } ;
use std ::io ::Write ; use std ::borrow ::Cow ;
use std ::path ::PathBuf ; use std ::collections ::HashMap ;
use std ::fs ::{ OpenOptions , read_to_string } ;
use std ::io ::{ BufRead , BufReader , Write } ;
use std ::path ::{ Path , PathBuf } ;
const DIR_ENTRIES : & str = "entries" ;
const DIR_CHANNELS : & str = "channels" ;
/// Changelog store struct
pub struct Store < ' a > { pub struct Store < ' a > {
/// App context, including config
ctx : & ' a AppContext , ctx : & ' a AppContext ,
/// Path to the changelog directory
store_path : PathBuf , store_path : PathBuf ,
/// Loaded version history for all channels
versions : HashMap < ChannelName , ChannelReleaseStore > ,
} }
impl < ' a > Store < ' a > { impl < ' a > Store < ' a > {
@ -36,9 +48,14 @@ impl<'a> Store<'a> {
) ; ) ;
} }
let store = Self { store_path , ctx } ; let mut store = Self {
store_path ,
ctx ,
versions : HashMap ::new ( ) ,
} ;
store . ensure_internal_subdirs_exist ( ) ? ; store . ensure_internal_subdirs_exist ( ) ? ;
store . load_versions ( ) ? ;
Ok ( store ) Ok ( store )
} }
@ -47,7 +64,7 @@ impl<'a> Store<'a> {
/// This is a file in the entries storage
/// This is a file in the entries storage
fn make_entry_path ( & self , filename : & str ) -> PathBuf { fn make_entry_path ( & self , filename : & str ) -> PathBuf {
self . store_path self . store_path
. join ( "entries" ) . join ( DIR_ENTRIES )
. join ( format! ( "{filename}.md" ) ) . join ( format! ( "{filename}.md" ) )
} }
@ -58,9 +75,25 @@ impl<'a> Store<'a> {
path . exists ( ) path . exists ( )
} }
/// Load release lists for all channels
fn load_versions ( & mut self ) -> anyhow ::Result < ( ) > {
let channels_dir = self . store_path . join ( DIR_CHANNELS ) ;
for ch in self . ctx . config . channels . keys ( ) {
let channel_file = channels_dir . join ( format! ( "{}.json" , ch ) ) ;
self . versions . insert (
ch . clone ( ) ,
ChannelReleaseStore ::load ( channel_file , ch . clone ( ) ) ? ,
) ;
}
Ok ( ( ) )
}
/// Check and create internal subdirs for the clpack system
/// Check and create internal subdirs for the clpack system
pub fn ensure_internal_subdirs_exist ( & self ) -> anyhow ::Result < ( ) > { pub fn ensure_internal_subdirs_exist ( & self ) -> anyhow ::Result < ( ) > {
self . ensure_subdir_exists ( "entries" ) ? ; self . ensure_subdir_exists ( DIR_ENTRIES , true ) ? ;
self . ensure_subdir_exists ( DIR_CHANNELS , false ) ? ;
// TODO
// TODO
Ok ( ( ) ) Ok ( ( ) )
@ -69,7 +102,7 @@ impl<'a> Store<'a> {
/// make sure a subdir exists, creating if needed.
/// make sure a subdir exists, creating if needed.
///
///
/// Note there is no lock so there can be a TOCTOU bug later if someone deletes the path - must be checked and handled.
/// Note there is no lock so there can be a TOCTOU bug later if someone deletes the path - must be checked and handled.
fn ensure_subdir_exists ( & self , name : & str ) -> anyhow ::Result < ( ) > { fn ensure_subdir_exists ( & self , name : & str , gitkeep : bool ) -> anyhow ::Result < ( ) > {
let subdir = self . store_path . join ( name ) ; let subdir = self . store_path . join ( name ) ;
if ! subdir . is_dir ( ) { if ! subdir . is_dir ( ) {
@ -87,19 +120,316 @@ impl<'a> Store<'a> {
bail ! ( "Changelog subdir is not writable: {}" , subdir . display ( ) ) ; bail ! ( "Changelog subdir is not writable: {}" , subdir . display ( ) ) ;
} }
if gitkeep {
std ::fs ::File ::create ( subdir . join ( ".gitkeep" ) ) ? ; std ::fs ::File ::create ( subdir . join ( ".gitkeep" ) ) ? ;
}
Ok ( ( ) ) Ok ( ( ) )
} }
/// Create a changelog entry file and write content to it
/// Create a changelog entry file and write content to it
pub fn create_entry ( & self , name : String , content : String ) -> anyhow ::Result < ( ) > { pub fn create_entry ( & self , name : EntryName , content : String ) -> anyhow ::Result < ( ) > {
let path = self . make_entry_path ( name . as_str ( ) ) ; let path = self . make_entry_path ( name . as_str ( ) ) ;
let mut file = OpenOptions ::new ( ) . write ( true ) . create ( true ) . open ( & path ) ? ; let mut file = OpenOptions ::new ( ) . write ( true ) . create ( true ) . open ( & path ) ? ;
eprintln! ( "Writing to file: {}" , path . display ( ) ) ; eprintln! ( "Writing changelog entry to file: {}" , path . display ( ) ) ;
file . write_all ( content . as_bytes ( ) ) ? ; file . write_all ( content . as_bytes ( ) ) ? ;
Ok ( ( ) ) Ok ( ( ) )
} }
/// Check if a version was already released (on any channel) - prevents the user from making a mistake in version naming
pub fn version_exists ( & self , version : & str ) -> bool {
for v in self . versions . values ( ) {
if v . version_exists ( version ) {
return true ;
}
}
false
}
/// Find unreleased changelog entries on a channel
pub fn find_unreleased_changes ( & self , channel : & ChannelName ) -> anyhow ::Result < Vec < EntryName > > {
let Some ( store ) = self . versions . get ( channel ) else {
bail ! ( "Channel {channel} does not exist." ) ;
} ;
store . find_unreleased_entries ( self . store_path . join ( DIR_ENTRIES ) )
}
/// Create a release entry, write it to the releases buffer and to the file.
pub fn create_release ( & mut self , channel : ChannelName , release : Release ) -> anyhow ::Result < ( ) > {
let rendered = self . render_release ( & release ) ? ;
let Some ( store ) = self . versions . get_mut ( & channel ) else {
bail ! ( "Channel {channel} does not exist." ) ;
} ;
let config = & self . ctx . config ;
let changelog_file = self . ctx . root . join (
if channel = = config . default_channel {
Cow ::Borrowed ( config . changelog_file_default . as_str ( ) )
} else {
Cow ::Owned (
config
. changelog_file_channel
. replace ( "{channel}" , & channel . to_lowercase ( ) )
. replace ( "{CHANNEL}" , & channel . to_uppercase ( ) )
. replace ( "{Channel}" , & ucfirst ( & channel ) ) ,
)
}
. as_ref ( ) ,
) ;
if changelog_file . exists ( ) {
let changelog_file_content = read_to_string ( & changelog_file ) ? ;
let old_content = changelog_file_content
. strip_prefix ( & config . changelog_header )
. unwrap_or ( & changelog_file_content ) ;
let mut outfile = OpenOptions ::new ( )
. write ( true )
. create ( true )
. truncate ( true )
. open ( changelog_file ) ? ;
outfile . write_all (
format! ( "{}{}{}" , config . changelog_header , rendered , old_content ) . as_bytes ( ) ,
) ? ;
} else {
let mut outfile = OpenOptions ::new ( )
. write ( true )
. create ( true )
. truncate ( true )
. open ( changelog_file ) ? ;
outfile . write_all ( format! ( "{}{}" , config . changelog_header , rendered ) . as_bytes ( ) ) ? ;
}
store . add_version ( release ) ? ;
// Write to the changelog file for this channel
store . write_to_file ( ) ? ;
Ok ( ( ) )
}
/// Render a release
pub fn render_release ( & self , release : & Release ) -> anyhow ::Result < String > {
let config = & self . ctx . config ;
release . render ( self . store_path . join ( DIR_ENTRIES ) , & config )
}
}
/// Uppercase first char of a string
fn ucfirst ( input : & str ) -> String {
let mut c = input . chars ( ) ;
match c . next ( ) {
Some ( f ) = > f . to_uppercase ( ) . collect ::< String > ( ) + c . as_str ( ) ,
None = > String ::new ( ) ,
}
}
/// Summary of a release
#[ derive(Debug, Serialize, Deserialize, Clone) ]
pub struct Release {
/// Name of the version
pub version : VersionName ,
/// List of entries included in this version
pub entries : Vec < EntryName > ,
}
impl Release {
/// Render the entry into a Markdown fragment, using h2 (##) as the title, h3 (###) for sections
pub fn render ( & self , entries_dir : impl AsRef < Path > , config : & Config ) -> anyhow ::Result < String > {
let mut entries_per_section = HashMap ::< String , String > ::new ( ) ;
let entries_dir = entries_dir . as_ref ( ) ;
let unnamed = "" . to_string ( ) ;
for entry in & self . entries {
let entry_file = entries_dir . join ( & format! ( "{entry}.md" ) ) ;
if ! entry_file . exists ( ) | | ! entry_file . readable ( ) {
bail ! (
"Changelog entry file missing or not readable: {}" ,
entry_file . display ( )
) ;
}
let file = OpenOptions ::new ( ) . read ( true ) . open ( & entry_file ) ? ;
let reader = BufReader ::new ( file ) ;
let mut current_section = unnamed . clone ( ) ;
for line in reader . lines ( ) {
let line = line ? ;
if line . trim ( ) . is_empty ( ) {
continue ;
}
if line . trim ( ) . starts_with ( '#' ) {
// It is a section name
let section = line . trim_matches ( | c | c = = '#' | | c = = ' ' ) ;
current_section = section . to_string ( ) ;
} else {
if let Some ( buffer ) = entries_per_section . get_mut ( & current_section ) {
buffer . push ( '\n' ) ;
buffer . push_str ( & line ) ;
} else {
entries_per_section . insert ( current_section . clone ( ) , line ) ;
}
}
}
}
let mut reordered_sections = Vec ::< ( String , String ) > ::new ( ) ;
// First the unlabelled section (this is probably junk, but it was entered by the user, so keep it)
if let Some ( unlabelled ) = entries_per_section . remove ( "" ) {
reordered_sections . push ( ( "" . to_string ( ) , unlabelled ) ) ;
}
for section_name in [ unnamed ] . iter ( ) . chain ( config . sections . iter ( ) ) {
if let Some ( content ) = entries_per_section . remove ( section_name ) {
reordered_sections . push ( ( section_name . clone ( ) , content ) ) ;
}
}
// Leftovers (names authors invented when writing changelog)
for ( section_name , content ) in entries_per_section {
reordered_sections . push ( ( section_name , content ) ) ;
}
let date = chrono ::Local ::now ( ) ;
let mut buffer = format! (
"## {}\n" ,
config
. release_header
. replace ( "{VERSION}" , & self . version )
. replace ( "{DATE}" , & date . format ( & config . date_format ) . to_string ( ) )
) ;
for ( section_name , content ) in reordered_sections {
if ! section_name . is_empty ( ) {
buffer . push_str ( & format! ( "\n### {}\n\n" , section_name ) ) ;
}
buffer . push_str ( content . trim_end ( ) ) ;
buffer . push_str ( "\n\n" ) ;
}
Ok ( buffer )
}
}
/// List of releases, deserialized from a file
type ReleaseList = Vec < Release > ;
/// Versions store for one channel
struct ChannelReleaseStore {
/// File where the list of versions is stored
backing_file : PathBuf ,
/// Name of the channel, for error messages
channel_name : ChannelName ,
/// List of releases, load from the file
releases : ReleaseList ,
}
impl ChannelReleaseStore {
/// Load from a versions file
fn load ( releases_file : PathBuf , channel_name : ChannelName ) -> anyhow ::Result < Self > {
println! (
"Loading versions for channel {} from: {}" ,
channel_name ,
releases_file . display ( )
) ;
let releases = if ! releases_file . exists ( ) {
// File did not exist yet, create it - this catches error with write access early
let mut f = OpenOptions ::new ( )
. write ( true )
. create ( true )
. open ( & releases_file ) ? ;
f . write_all ( "[]" . as_bytes ( ) ) ? ;
Default ::default ( )
} else {
let channel_json = read_to_string ( & releases_file ) ? ;
serde_json ::from_str ::< ReleaseList > ( & channel_json ) ?
} ;
Ok ( Self {
backing_file : releases_file ,
channel_name ,
releases ,
} )
}
/// Check if a version is included in a release
fn version_exists ( & self , version : & str ) -> bool {
self . releases . iter ( ) . any ( | rel | rel . version = = version )
}
/// Add a version to the channel buffer
/// The release entry, borrowed, is returned for further use
fn add_version ( & mut self , release : Release ) -> anyhow ::Result < ( ) > {
if self . version_exists ( & release . version ) {
bail ! (
"Version {} already exists on channel {}" ,
release . version ,
self . channel_name
) ;
}
self . releases . push ( release ) ;
Ok ( ( ) )
}
/// Write the versions list contained in this store into the backing file.
fn write_to_file ( & self ) -> anyhow ::Result < ( ) > {
let encoded = serde_json ::to_string_pretty ( & self . releases ) ? ;
let mut f = OpenOptions ::new ( )
. write ( true )
. create ( true )
. open ( & self . backing_file ) ? ;
f . write_all ( encoded . as_bytes ( ) ) ? ;
Ok ( ( ) )
}
/// Find entries not yet included in this release channel
fn find_unreleased_entries (
& self ,
entries_dir : impl AsRef < Path > ,
) -> anyhow ::Result < Vec < EntryName > > {
let mut found = vec! [ ] ;
for entry in entries_dir . as_ref ( ) . read_dir ( ) ? {
let entry = entry ? ;
let fname_os = entry . file_name ( ) ;
let fname = fname_os . into_string ( ) . map_err ( | _ | {
anyhow ::anyhow ! ( "Failed to parse file name: {}" , entry . path ( ) . display ( ) )
} ) ? ;
if ! entry . metadata ( ) ? . is_file ( ) | | ! fname . ends_with ( ".md" ) {
if fname ! = ".gitkeep" {
eprintln! (
"{}" ,
format! (
"Unexpected item in changelog entries dir: {}" ,
entry . path ( ) . display ( )
)
. yellow ( )
) ;
}
continue ;
}
let basename = fname . strip_suffix ( ".md" ) . unwrap ( ) ;
if ! self
. releases
. iter ( )
. map ( | rel | & rel . entries )
. flatten ( )
. any ( | entryname | entryname = = basename )
{
found . push ( basename . to_string ( ) ) ;
}
}
Ok ( found )
}
} }
Ondřej Hruška