jekyll-page-boilerplate 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a93e2b4e7e502c0d19906f1dae2786f6fb1ceecf39d52c0dbdf82db241215e2
+  data.tar.gz: 71434d9ca5e0072c25543fc2180b37ee59ce4702d73dde7ea454c16bf14d56cd
+SHA512:
+  metadata.gz: 9cf262a0c5dc30f2af6b428ab50c0a9b5942c7e192c3e5f18a6e56dab04f2c081f3137119dabce88d108fedc9b65703363985df7a292fd70e472bcc15d778228
+  data.tar.gz: f09fcfbd8dec7ef599e738b9dc45b4616ac181b07088dce6e1025bf3db9ccac32a24b52be9624d24304c03bc011d841cbdda157cdf20e7d8d7b77f12749c7ed9

data/exe/boilerplate

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+STDOUT.sync = true
+
+gem_dir = File.expand_path("..",File.dirname(__FILE__))
+$LOAD_PATH.unshift gem_dir # Look in gem directory for resources first.
+
+require 'jekyll_page_boilerplate'
+require "mercenary"
+
+Mercenary.program(:boilerplate) do |p|
+  p.version JekyllPageBoilerplate::VERSION
+  p.description 'jekyll-page-boilerplate is a gem for jekyll that helps you generate new pages'
+  p.syntax "jekyll-page <subcommand> [options]"
+
+  p.command(:page) do |c|
+    c.syntax "create BOILERPLATE_NAME \"NEW PAGE TITLE\""
+    c.description "Creates a page or post from a boilerplate."
+
+    c.action do |args, _|
+      JekyllPageBoilerplate.page args[0], args[1], c
+    end
+  end
+
+  p.command(:help) do |c|
+    c.syntax "help"
+    c.description "Describe what jekyll-page-boilerplate does."
+
+    c.action do
+      JekyllPageBoilerplate.help c
+    end
+  end
+  
+  p.command(:init) do |c|
+    c.syntax "init"
+    c.description "Creates an example boilerplate."
+
+    c.action do
+      JekyllPageBoilerplate.init c
+    end
+  end
+
+
+
+
+  p.default_command(:help)
+end
+
+

data/lib/jekyll_page_boilerplate.rb

@@ -0,0 +1,33 @@
+require "jekyll_page_boilerplate/version"
+require "jekyll_page_boilerplate/page"
+require "jekyll_page_boilerplate/msg"
+require "jekyll_page_boilerplate/init"
+
+module JekyllPageBoilerplate
+  class Error < StandardError; end
+
+
+  def self.init cmd
+    begin
+      Init.setup
+    rescue => e
+      cmd.logger.fatal e.message
+    end
+  end
+
+
+  def self.help cmd
+    cmd.logger.info Msg::HELP
+  end
+
+
+  def self.page boilerplate_name, page_title, cmd
+    page = Page.new(boilerplate_name)
+    begin
+      page.create(page_title)
+    rescue => e
+      cmd.logger.fatal e.message
+    end
+  end
+
+end

data/lib/jekyll_page_boilerplate/example.yml

@@ -0,0 +1,43 @@
+---
+
+# Create a new jekyll page/post from a boilerplate.
+
+# A boilerplate is a yaml file in the `_boilerplates` folder.
+
+# `$ boilerplate page example "Another post about pottery"`
+
+# the path to create the new page under.
+path: _posts
+
+# when true new post/pages will include the date in the filename.
+timestamp: true
+
+# Any yaml you put under `header` will be added to your new pages/post
+header:
+  layout: post
+  author: John Doe
+
+# the boilerplate markdown content for your page
+content: '
+
+# Heading
+
+
+Some stuff that changes a little bit but that I don't want to bother copying and pasting.'
+
+
+# This would create a new file: 
+#   _posts/yyyy-mm-dd-another-one-about-pottery.markdow`
+#   ---
+#   title: Another one about pottery
+#   created: 'yyyy-mm-dd hh:mm:ss -0000'
+#   layout: post
+#   author: John Doe
+#   ---
+#   
+#   Heading
+#   -------
+#
+#   Some stuff that changes a little bit but that I don't want to bother copying and pasting.
+# 
+# 

data/lib/jekyll_page_boilerplate/init.rb

@@ -0,0 +1,11 @@
+require 'fileutils'
+
+module JekyllPageBoilerplate
+  module Init
+    def self.setup
+      FileUtils.mkpath('_boilerplates')
+      FileUtils.cp(File.join(__dir__, 'example.yml'), '_boilerplates')
+    end
+  
+  end
+end

data/lib/jekyll_page_boilerplate/msg.rb

@@ -0,0 +1,40 @@
+
+module JekyllPageBoilerplate
+  module Msg
+
+    HELP = <<-'HELP'
+
+      Create a new jekyll page/post from a boilerplate.
+
+      A boilerplate is a yaml file in the `_boilerplates` folder.
+
+      ie. `_boilerplates/post.yml`
+          ---
+          path: _posts
+          timestap: true
+          
+          header:
+            layout: post
+            author: John Doe
+      
+      Boilerplate yaml settings:
+        path - the path to create the new page under.
+        timestamp - when true new post/pages will include the date in the filename.
+        header - Any yaml you put under `header` will be added to your new pages/post
+        
+
+      `$ boilerplate page post "Another one about pottery"`
+      
+      would create a new file `_posts/yyyy-mm-dd-another-one-about-pottery.markdown`
+        ---
+        title: Another one about pottery
+        created: 'yyyy-mm-dd hh:mm:ss -0000'
+        layout: post
+        author: John Doe
+        ---
+        
+
+    HELP
+  
+  end
+end

data/lib/jekyll_page_boilerplate/page.rb

@@ -0,0 +1,95 @@
+
+require 'yaml'
+require "stringex"
+
+module JekyllPageBoilerplate
+  class Page
+
+    BOILERPLATES_PATH = '_boilerplates'
+    FILE_DATE_FORMATE = '%Y-%m-%d'
+
+
+    def initialize boilerplate, suffix: '.yml' 
+      plate_path = File.join(BOILERPLATES_PATH, "#{boilerplate}#{suffix}")
+      
+      set_boilerplate_from_yaml_file( plate_path )
+    end    
+    
+    def create title
+      abort_unless_file_exists(@boilerplate['path'])
+      
+      add_header_title( title )
+      add_header_created()
+      
+      create_new_page( title )
+
+      @boilerplate
+    end
+
+    private
+
+    def create_new_page title
+      filename = get_new_page_filename( title )
+      
+      new_file_path = File.join( @boilerplate['path'], filename )
+
+      abort_if_file_exists(new_file_path)
+
+      open(new_file_path, 'w') do |page|
+        page.puts @boilerplate['header'].to_yaml
+        page.puts '---'
+        page.puts ''
+        page.print @boilerplate['content']
+        page.puts ''
+      end
+      
+    end
+
+
+    def add_header_created
+      @boilerplate['header']['created'] = Time.now.to_s
+    end
+    
+    def add_header_title title
+      @boilerplate['header']['title'] = title.gsub(/[&-]/, '&'=>'&', '-'=>' ')
+    end
+
+
+    def set_boilerplate_from_yaml_file yaml_path
+      abort_unless_file_exists( yaml_path )
+      
+      @boilerplate = {} 
+      
+      File.open(yaml_path, 'r') do |yaml_file|
+        @boilerplate = YAML.load( yaml_file.read )
+      end
+    end
+    
+
+    def get_new_page_filename title
+      title = title.to_url
+      title = "#{title}#{@boilerplate['suffix'] || '.markdown'}"
+      if @boilerplate['timestamp']
+        title = "#{Time.now.strftime(FILE_DATE_FORMATE)}-#{title}"
+      end
+      return title
+    end
+
+
+
+    def abort_if_file_exists(file_path)
+      if File.exist?(file_path)
+        raise "#{file_path} already exists!"
+      end
+    end
+
+    def abort_unless_file_exists(file_path)
+      unless File.exist?(file_path)
+        raise "#{file_path} does not exist!"
+      end
+    end
+
+
+  end
+
+end

data/lib/jekyll_page_boilerplate/version.rb

@@ -0,0 +1,3 @@
+module JekyllPageBoilerplate
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-page-boilerplate
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Sean Ferney
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: stringex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A jekyll plugin that allows you to create new pages or posts from a boilerplate
+  through the terminal.
+email:
+- sean@codekarma.dev
+executables:
+- boilerplate
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/boilerplate
+- lib/jekyll_page_boilerplate.rb
+- lib/jekyll_page_boilerplate/example.yml
+- lib/jekyll_page_boilerplate/init.rb
+- lib/jekyll_page_boilerplate/msg.rb
+- lib/jekyll_page_boilerplate/page.rb
+- lib/jekyll_page_boilerplate/version.rb
+homepage: https://github.com/CodeKarmaDev/jekyll-page-boilerplate
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/CodeKarmaDev/jekyll-page-boilerplate
+  source_code_uri: https://github.com/CodeKarmaDev/jekyll-page-boilerplate
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: A jekyll plugin that create new pages from boilerplates
+test_files: []