symkat
/
MyJekyllBlog
1
0
Fork 0
Code Issues Pull Requests Packages Projects 2 Releases Wiki Activity

Remove excess lib (moved to plugins).

Browse Source
master
Manager Bot 3 years ago
parent 60a3ee4479
commit 869e188d20
5 changed files with 0 additions and 858 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 20
      libs/MJB-Backend-Jekyll/dist.ini
  2. 656
      libs/MJB-Backend-Jekyll/lib/MJB/Backend/Jekyll.pm
  3. 63
      libs/MJB-Backend-Jekyll/lib/MJB/Backend/Jekyll/ConfigFile.pm
  4. 111
      libs/MJB-Backend-Jekyll/lib/MJB/Backend/Jekyll/MarkdownFile.pm
  5. 8
      libs/MJB-Backend-Jekyll/t/00_load.t

20
libs/MJB-Backend-Jekyll/dist.ini
Unescape View File

@ -1,20 +0,0 @@
name = MJB-Backend-Jekyll
abstract = Manage Jekyll Blog Repositories
author = Kaitlyn Parkhurst <symkat@symkat.com>
license = Perl_5
copyright_holder = Kaitlyn Parkhurst
copyright_year = 2022
version = 0.001
[@Basic]
[Prereqs]
Moo = 0
IPC::Run3 = 0
Cwd = 0
File::Path = 0
Storable = 0
Mojo::File = 0
[AutoPrereqs]

656
libs/MJB-Backend-Jekyll/lib/MJB/Backend/Jekyll.pm
Unescape View File

@ -1,656 +0,0 @@
package MJB::Backend::Jekyll;
use Moo;
use IPC::Run3 qw( run3 );
use Cwd qw( getcwd );
use File::Path qw( make_path );
use File::Find;
use Storable qw( dclone );
use Mojo::File;
use MJB::Backend::Jekyll::MarkdownFile;
use MJB::Backend::Jekyll::ConfigFile;
#======
# This class enables you to programatically access and update Jekyll blogs
# that are backed by a git repository. Additionally, you can create new
# Jekyll blogs from a repository to use as a template.
#
#======
#==
# The path to the directory that will be used to hold the git repositories for each blog blogs.
#==
has root => (
is => 'ro',
required => 1,
trigger => sub {
my ( $self, $value ) = @_;
make_path( $value );
},
);
#==
# The domain name for this specific blog.
#==
has domain => (
is => 'ro',
required => 1,
);
#==
# The full remote path ( i.e. git@foo.com:mjb/domain.com.git) to the git repository that we will push to.
#==
has repo => (
is => 'ro',
required => 1,
);
#==
# The full local path (i.e. /var/repos/domain.com ) to the git repository that we will execute git commands in.
#==
has repo_path => (
is => 'lazy',
);
sub _build_repo_path {
my ( $self ) = @_;
return $self->root . "/" . $self->domain;
}
#==
# The full git path (i.e. git@foo.com:mjb/default-site.git) of the repository to use as an initial
# template when using the init() method to create a new blog.
#==
has init_from => (
is => 'ro',
required => 1,
);
#==
# The configuration file for the Jekyll blog itself.
#==
has config => (
is => 'lazy',
);
sub _build_config {
my ( $self ) = @_;
return MJB::Backend::Jekyll::ConfigFile->new(
path => $self->repo_path . "/_config.yml",
)->read;
}
#==
# This method will initialize a new blog.
#
# It will clone the git repo from $self->init_from and set a new remote, then
# push the repository (and expect the git server to create the repo on push).
#
# It returns $self
#==
sub init {
my ( $self ) = @_;
# Refuse to overwrite an already-existing site.
die "Error: Cannot init when the target directory already exists."
if -d $self->repo_path;
# Clone the template repo
$self->system_command( [ qw( git clone ), $self->init_from, $self->repo_path ] );
# Update the origin that is set
$self->system_command( [ qw( git remote set-url origin ), $self->repo ], {
chdir => $self->repo_path,
});
# Confirm the origin updated
my $return = $self->system_command( [ qw( git remote get-url origin ) ], {
chdir => $self->repo_path,
});
if ( $return->{stdout} ne $self->repo . "\n" ) {
die "Error: Unable to initialize and set repo.";
}
# Push the repo to the store
$self->system_command( [ qw( git push origin master ) ], {
chdir => $self->repo_path,
});
return $self;
}
#==
# This method will list the media files that are in the blog's /assets/media directory,
# where images, pdfs, etc may be stored.
#
# It returns a list of hashrefs containing
# path | The full path to the file
# filename | The basename of the file.
# url | The http url that the image should exist at
# markdown | The markdown code to embedd the asset as an image
#==
sub list_media {
my ( $self ) = @_;
$self->_ensure_repository_is_latest;
my $media = Mojo::File->new( $self->repo_path . "/assets/media" );
my @return;
# TODO: Sort by date for the listing on the front end.
foreach my $file ( $media->list->each ) {
push @return, {
path => $file->to_string,
filename => $file->basename,
url => 'https://' . $self->domain . '/assets/media/' . $file->basename,
markdown => '![Title for image](https://' . $self->domain . '/assets/media/' . $file->basename . ')',
};
}
return [ @return ];
}
#==
# This method will list posts for the blog that are in the /_posts
# collection..
#
# It returns a list of MJB::Backend::Jekyll::MarkdownFile objects.
#
# For speed read() is NOT called on these objects, so the file will
# not be loaded until you call read() on the object.
#==
sub list_posts {
my ( $self ) = @_;
$self->_ensure_repository_is_latest;
my $posts = Mojo::File->new( $self->repo_path . "/_posts" );
my @files;
# TODO: Sort by date for the listing on the front end.
foreach my $file ( $posts->list->each ) {
push @files, MJB::Backend::Jekyll::MarkdownFile->new(
root => $self->repo_path,
path => $file->to_string,
);
}
return [ @files ];
}
#==
# This method removes a markdown file from the git repository for this blog.
#
# It accepts a Mojo::File object to remove.
#
# It returns self.
#==
sub remove_markdown_file {
my ( $self, $file ) = @_;
# Update the origin that is set
$self->system_command( [ qw( git rm ), $file->path ], {
chdir => $self->repo_path,
});
# Commit The Changes
$self->system_command( [ qw( git commit -m ), 'Removed ' . $file->filename ], {
chdir => $self->repo_path,
});
# Push the changes
$self->system_command( [ qw( git push origin master ) ], {
chdir => $self->repo_path,
});
return $self;
}
#==
# This method lists all of the pages that exist in this blog.
#
# It will search for .md and .markdown files and returns an arrayref
# of MJB::Backend::Jekyll::MarkdownFile objects.
#
# For speed read() is NOT called on these objects, so the file will
# not be loaded until you call read() on the object.
#==
sub list_pages {
my ( $self ) = @_;
$self->_ensure_repository_is_latest;
my @files;
find( sub {
return unless $_ =~ /\.(?:markdown|md)$/; # Only markdown files
return if substr((split m|/|, $File::Find::dir)[-1], 0, 1) eq '_'; # Skip directories that start with _
push @files, MJB::Backend::Jekyll::MarkdownFile->new(
root => $self->repo_path,
path => $File::Find::name,
);
}, $self->repo_path );
return [ @files ];
}
#==
# This method will load a post by its filename.
#
# It returns an MJB::Backend::Jekyll::MarkdownFile object
# if the file exists. Otherwise, it returns undef.
#
#==
sub get_post {
my ( $self, $filename ) = @_;
return undef
if $filename =~ m|\.\./|;
return undef
unless -f $self->repo_path . "/_posts/" . $filename;
return MJB::Backend::Jekyll::MarkdownFile->new(
root => $self->repo_path,
path => $self->repo_path . "/_posts/" . $filename,
)->read;
}
#==
# This method will create a new post on the blog.
#
# It expects the filename for the collection in YYYY-MM-DD-some-title.markdown format.
# (i.e. 2020-12-25-it-is-christmas.markdown)
#
# It returns an MJB::Backend::Jekyll::MarkdownFile object that is expected to be
# populated by the caller.
#
# Once populated, this object should be given to write_post() to commit it.
#
# TODO: get_post and new_post are the very nearly the same, and should be refactored into
# one function.
# 1. Write a new function load_or_create_post() that will function as get_post, but
# if the post doesn't exist, it will function as new_post and return an object
# anyway.
# 2. Run ack in the controllers and update any use of get_post or new_post to use the
# new function. Confirm it works at each step of the way.
# 3. Remove get_post and new_post from this file.
#==
sub new_post {
my ( $self, $filename ) = @_;
return undef
if $filename =~ m|\.\./|;
return MJB::Backend::Jekyll::MarkdownFile->new(
root => $self->repo_path,
path => $self->repo_path . "/_posts/" . $filename,
);
}
#==
# This method will create a new page.
#
# It expects a filepath in the form of my/file/path/and/name.markdown, and will
# return a MJB::Backend::Jekyll::MarkdownFile object.
#
# That object should be given to write_post.
#
# TODO: The difference between this and the post is that this can go off the root
# of the repo, where the posts go off the /_post/.
#
# Think about how this would work with being refactored the same as the new_post bit...
# it could be all three should be one function.
#==
sub new_page {
my ( $self, $filename ) = @_;
return undef
if $filename =~ m|\.\./|;
return MJB::Backend::Jekyll::MarkdownFile->new(
root => $self->repo_path,
path => $self->repo_path . $filename,
);
}
#==
# This method writes the jekyll blog configuration file.
# You can pass an MJB::Backend::Jekyll::ConfigFile object to write,
# otherwise the one in $self is written.
#
# The config file is written, commited, and pushed to the git origin server.
#==
sub write_config {
my ( $self, $config ) = @_;
$config ||= $self->config;
$config->write;
# Add the file to git
$self->system_command( [ qw( git add ), $config->path ], {
chdir => $self->repo_path,
});
# Commit the file
$self->system_command( [ qw( git commit -m ), "Updated Site Config" ], {
chdir => $self->repo_path,
});
# Push the repo to the store server
$self->system_command( [ qw( git push origin master ) ], {
chdir => $self->repo_path,
});
return 1;
}
#==
# This method accepts an MJB::Backend::Jekyll::MarkdownFile object
# and writes it to the blog, then commits and pushes it to the origin.
#
# It is used by the post and page editing/creating functions.
#==
sub write_post {
my ( $self, $md_file ) = @_;
# Check that the repo exists and is latest.
$self->_ensure_repository_is_latest;
# Write the file
$md_file->write;
# Add the file to git
$self->system_command( [ qw( git add ), $md_file->path ], {
chdir => $self->repo_path,
});
# Commit the file
$self->system_command( [ qw( git commit -m ), "Created " . $md_file->headers->{title} ], {
chdir => $self->repo_path,
});
# Push the repo to the store server
$self->system_command( [ qw( git push origin master ) ], {
chdir => $self->repo_path,
});
return 1;
}
#==
# This method accepts a file path and a comment and will commit the file,
# and push the repo.
#
# This is used to commit media and non-post files.
#==
sub commit_file {
my ( $self, $file, $comment ) = @_;
# Check that the repo exists and is latest.
$self->_ensure_repository_is_latest;
# Add the file to git
$self->system_command( [ qw( git add ), $file ], {
chdir => $self->repo_path,
});
# Commit the file
$self->system_command( [ qw( git commit -m ), $comment ], {
chdir => $self->repo_path,
});
# Push the repo to the store server
$self->system_command( [ qw( git push origin master ) ], {
chdir => $self->repo_path,
});
return 1;
}
#==
# This method accepts a file path and a comment and will remove the file,
# and push the repo.
#
# This is used to delete media and other files.
#==
sub remove_file {
my ( $self, $file, $comment ) = @_;
# Check that the repo exists and is latest.
$self->_ensure_repository_is_latest;
# Add the file to git
$self->system_command( [ qw( git rm ), $file ], {
chdir => $self->repo_path,
});
# Commit the file
$self->system_command( [ qw( git commit -m ), $comment ], {
chdir => $self->repo_path,
});
# Push the repo to the store server
$self->system_command( [ qw( git push origin master ) ], {
chdir => $self->repo_path,
});
return 1;
}
#==
# Given a commit, restore the repo to that state.
#==
sub restore_commit {
my ( $self, $commit ) = @_;
# Check that the repo exists and is latest.
$self->_ensure_repository_is_latest;
# Restore the commit.
$self->system_command( [ qw( git restore --source ), $commit, qw( -W -S --theirs :/ ) ], {
chdir => $self->repo_path,
});
# Restore the commit.
$self->system_command( [ qw( git commit -m ), "Restored from $commit" ], {
chdir => $self->repo_path,
});
# Push the repo to the store server
$self->system_command( [ qw( git push origin master ) ], {
chdir => $self->repo_path,
});
return 1;
}
#==
# This method lists the history of the git repo.
#
# It returns an arrayref of hashrefs with the following keys:
# commit | The commit hash
# dateref | The date, expressed relative (i.e. 3 days ago)
# message | The commit message
#==
sub history {
my ( $self ) = @_;
# Check if the repo exists and update the repo if needed
$self->_ensure_repository_is_latest;
# Do a git history
my $result = $self->system_command( [ qw(git log --date=relative), q|--pretty=%H %ad %s| ], {
chdir => $self->repo_path,
});
my @return;
# Format the results into a data structure
foreach my $line ( split( /\n/, $result->{stdout} ) ) {
if ( $line =~ /^([0-9a-f]{40}) (.+ ago) (.+)$/ ) {
push @return, {
commit => $1,
dateref => $2,
message => $3,
};
}
}
# Return the data structure
return [ @return ];
}
#==
# This method will checkout the repo if it doesn't exist on the filesystem.
#
# It will update the repo with a git pull.
#==
sub _ensure_repository_is_latest {
my ( $self ) = @_;
# Check for the repo -- if it doesn't exist, clone it.
if ( ! -d $self->repo_path ) {
$self->system_command( [ qw( git clone ), $self->repo, $self->repo_path ] );
return 1;
}
# Run a git pull with fast forward
$self->system_command( [ qw( git pull --ff-only origin master ) ], {
chdir => $self->repo_path,
});
return 1;
}
#==
# Run a system command.
# $self->system_command(
# [qw( the command here )],
# { options => 'here' },
# );
#
# This method accepts an arrayref with a command, and a hashref with
# options.
#
# The command will be executed.
#
# The following options may be passed:
# chdir | Directory to chdir to before executing the command
# mask | A hash like { My$ecretP@ssword => '--PASSWORD--' } to censor in
# logging STDOUT/STDERR, and logging the command itself.
# fail_on_stderr | An arrayref like [
# qr/pattern/ => 'die reason',
# qr/other pattern/ => 'another die reason'
# ] where system_command will emmit a die if the pattern matches on stderr.
#
# A hashref will be returned that contains the following keys:
# {
# stdout => 'standard output content',
# stderr => 'standard error content',
# exitno => 1, # the exit status of the command
# }
#
# If the environment variable MJB_DEBUG is set true, these return values
# will also be printed to STDOUT.
#==
sub system_command {
my ( $self, $cmd, $settings ) = @_;
$settings ||= {};
# Change the directory, if requested.
if ( $settings->{chdir} ) {
# Throw an error if that directory doesn't exist.
die "Error: directory " . $settings->{chdir} . "doesn't exist."
unless -d $settings->{chdir};
# Change to that directory, or die with error.
chdir $settings->{chdir}
or die "Failed to chdir to " . $settings->{chdir} . ": $!";
$settings->{return_chdir} = getcwd();
}
# Mask values we don't want exposed in the logs.
my $masked_cmd = dclone($cmd);
if ( ref $settings->{mask} eq 'HASH' ) {
foreach my $key ( keys %{$settings->{mask}} ) {
my $value = $settings->{mask}{$key};
$masked_cmd = [ map { s/\Q$key\E/$value/g; $_ } @{$masked_cmd} ];
}
}
# Log the lines
my ( $out, $err );
my $ret = run3( $cmd, \undef, sub {
chomp $_;
# Mask values we don't want exposed in the logs.
if ( ref $settings->{mask} eq 'HASH' ) {
foreach my $key ( keys %{$settings->{mask}} ) {
my $value = $settings->{mask}{$key};
s/\Q$key\E/$value/g;
}
}
$out .= "$_\n";
}, sub {
chomp $_;
# Mask values we don't want exposed in the logs.
if ( ref $settings->{mask} eq 'HASH' ) {
foreach my $key ( keys %{$settings->{mask}} ) {
my $value = $settings->{mask}{$key};
s/\Q$key\E/$value/g;
}
}
$err .= "$_\n";
});
# Check stderr for errors to fail on.
if ( $settings->{fail_on_stderr} ) {
my @tests = @{$settings->{fail_on_stderr}};
while ( my $regex = shift @tests ) {
my $reason = shift @tests;
if ( $err =~ /$regex/ ) {
die $reason;
}
}
}
# Return to the directory we started in if we chdir'ed.
if ( $settings->{return_chdir} ) {
chdir $settings->{return_chdir}
or die "Failed to chdir to " . $settings->{chdir} . ": $!";
}
if ( $ENV{MJB_DEBUG} ) {
require Data::Dumper;
print Data::Dumper::Dumper({
stdout => $out,
stderr => $err,
exitno => $ret,
});
}
return {
stdout => $out,
stderr => $err,
exitno => $ret,
};
}
1;

63
libs/MJB-Backend-Jekyll/lib/MJB/Backend/Jekyll/ConfigFile.pm
Unescape View File

@ -1,63 +0,0 @@
package MJB::Backend::Jekyll::ConfigFile;
use Moo;
use YAML::XS qw( Load Dump );
# File path we are read/write from
has path => (
is => 'ro',
required => 1,
);
has data => (
is => 'rw',
default => sub { return +{} },
);
sub as_text {
my ( $self ) = @_;
return Dump($self->data);
}
sub set_from_text {
my ( $self, $config ) = @_;
$self->data( Load($config) );
return $self;
}
sub read {
my ( $self ) = @_;
$self->data( { } );
open my $lf, "<", $self->path
or die "Failed to open " . $self->path . " for reading: $!";
my $content = do { local $/; <$lf> };
close $lf;
$self->data( Load($content) );
return $self;
}
sub write {
my ( $self, $file ) = @_;
$file ||= $self->path;
open my $sf, ">", $file
or die "Failed to open $file for writing: $!";
print $sf Dump($self->data);
close $sf;
return $self;
}
1;

111
libs/MJB-Backend-Jekyll/lib/MJB/Backend/Jekyll/MarkdownFile.pm
Unescape View File

@ -1,111 +0,0 @@
package MJB::Backend::Jekyll::MarkdownFile;
use Moo;
use YAML::XS qw( Load Dump );
use Mojo::File;
# File path we are read/write from
has path => (
is => 'ro',
required => 1,
);
# root / domain from parent class.
has root => (
is => 'ro',
required => 1,
);
has rel_path => (
is => 'lazy',
);
sub _build_rel_path {
my ( $self ) = @_;
return substr($self->path, length($self->root));
}
has filename => (
is => 'lazy',
);
sub _build_filename {
my ( $self ) = @_;
return (split( /\//, $self->path ))[-1];
}
has headers => (
is => 'rw',
default => sub { return +{} },
);
has markdown => (
is => 'rw',
);
sub headers_as_string {
my ( $self ) = @_;
return Dump($self->headers);
}
sub set_headers_from_string {
my ( $self, $string ) = @_;
$self->headers( Load( $string ) );
return $self;
}
sub read {
my ( $self ) = @_;
# Ensure any content we alread have is discarded before reading.
$self->markdown( undef );
$self->headers( { } );
open my $lf, "<", $self->path
or die "Failed to open " . $self->path . " for reading: $!";
my $sep_count = 0;
my ( $yaml, $markdown ) = ( undef, undef );
while ( defined( my $line = <$lf> ) ) {
if ( $sep_count < 2 ) {
$yaml .= $line;
} else {
$markdown .= $line;
}
$sep_count++ if $line =~ /^---$/;
}
$self->headers( Load($yaml) );
$self->markdown( $markdown );
return $self;
}
sub write {
my ( $self, $file ) = @_;
$file ||= $self->path;
# Make directory if it doesn't exist.
Mojo::File->new( $file )->dirname->make_path;
open my $sf, ">", $file
or die "Failed to open $file for writing: $!";
print $sf Dump($self->headers);
print $sf "---\n";
print $sf $self->markdown;
close $sf;
return $self;
}
1;

8
libs/MJB-Backend-Jekyll/t/00_load.t
Unescape View File

@ -1,8 +0,0 @@
#!/usr/bin/env perl
use warnings;
use strict;
use Test::More;
use_ok( "MJB::Backend::Jekyll" );
done_testing;
Write Preview
Loading…
Cancel
Save