jekyll-page-boilerplate 2.1.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cda02e5e566768a18e995b7b409ec9d7563553a2ae576b790e2604bc3200d8d8
-  data.tar.gz: 03cad8782fa41bdf0bc26b52739ac0150868c5ae8a5f18aada88004a25d26689
+  metadata.gz: c0e902f15da76660bca40905d596f95cc1ab1f6f3f3f1e6533d38d1e219b05e6
+  data.tar.gz: 71a26b39978a7f26252e95f99caf0e1dda7a8b4f72ebe57637afa5a5eca040f3
 SHA512:
-  metadata.gz: f2a77c95e14d5289aeff92bed9cf6d6fa34982c7a4d16585957880fbeee09069cff4df3e9797a5e15cf53b6c4f436cdbbba932719dd8bd2984dac57015fc4e75
-  data.tar.gz: fd30ddeacf2a1eef951ba7d4cf28f2996af7961ab707af4548e5872de0be5653501d7be356ad6aa1ea5cb43c10edaedd6abace18d2c2c99c24126bb0c7ccdb8f
+  metadata.gz: 7d5a7e96cdc2b999749603d9c8dcda141b49e7b2230dc5ae2871cab22eff97b29f309320d69777ba9c9c5287b477bcf2847a9c14c9b235d150049215b0d1fe04
+  data.tar.gz: 3182cf46a90cf0d0ffe94ba6120eee236a5ec6d897cba09dc702fcd5a8b8cf300ab2a28e0dd8ae47e422608bf43f56f22cce2595e91b045c17f82f4a4532033b

data/exe/boilerplate

@@ -5,47 +5,4 @@ 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 "boilerplate <subcommand> [options]"
-
-  p.command(:page) do |c|
-    c.syntax 'page 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
-
-
+require 'jekyll_page_boilerplate_cli'

data/exe/bplate

@@ -0,0 +1,8 @@
+#!/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_cli'

data/lib/jekyll_page_boilerplate/example.md

@@ -3,8 +3,8 @@ _boilerplate:     # The config for your boilerplates:
   path: _posts    # this is the folder path it will create your new post/page under. 
   timestamp: true # when true new post/pages will include the date in the filename.
 
-title: TITLE      # The title will be overwriten
-created: CREATED  # created will be overwriten with the current time
+title: {{ boilerplate.title }}   # -T or --title options
+created: {{ boilerplate.time }}  # the current time.
 
 layout: post      # Anything else in the file will be copied to your new post/page.
 author: John Doe
@@ -17,7 +17,7 @@ A Jekyll Boilerplate Example
 
 To create a new page/post from this boilerplate run:
 ```bash
-$ boilerplate page example "Another post about pottery"`
+$ boilerplate create example "Another post about pottery"`
 ```
 
 A boilerplate is a markdown file in the `_boilerplates` folder.

data/lib/jekyll_page_boilerplate/init.rb

@@ -1,11 +1,16 @@
 require 'fileutils'
 
 module JekyllPageBoilerplate
-  module Init
+  class Init
+
+    def self.run
+      self.setup
+      return 'Created _boilerplates/example.md'
+    end
+    
     def self.setup
       FileUtils.mkpath('_boilerplates')
       FileUtils.cp(File.join(__dir__, 'example.md'), '_boilerplates')
     end
-  
   end
-end
+end

data/lib/jekyll_page_boilerplate/list.rb

@@ -0,0 +1,16 @@
+
+module JekyllPageBoilerplate
+
+  class List
+
+    SPACER = '\n'
+    REMOVE_SUFFIX = /\.\w+(?=[\s\n\r$])/
+
+    def self.run
+      Dir.glob("_boilerplates/*").map do |f|
+        File.basename(f, '.*')
+      end
+    end
+
+  end
+end

data/lib/jekyll_page_boilerplate/msg/description.md

@@ -0,0 +1,29 @@
+A boilerplate is a markdown file you place under the `_boilerplates` folder to generate new pages for jekyll.
+
+`_boilerplates/post.md`
+
+    ---
+    _boilerplate:       # boilerplate settings
+        path: _posts    # the path to create the new page under.
+        timestamp: true  # when true new post/pages will include the date in the filename. 
+    title: {{ boilerplate.title }} # tags like this will be replaced
+    layout: post        # everthing else will be copied to the new post.
+    author: John Doe
+
+
+`$ boilerplate post -T "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
+
+
+Available Tags `{{ boilerplate.xxx }}`:
+- `.title`, `.name`
+- `.path`, `.file`, `.suffix`
+- `.time`, `.date`, `.timestamp`
+- `.random_url`
+- Custom tags you provide in the command `bplate post custom=1`
+- And anything you put under the `_boilerplate:` header

data/lib/jekyll_page_boilerplate/msg.rb

@@ -1,39 +1,34 @@
 
-module JekyllPageBoilerplate
-  module Msg
+module JekyllPageBoilerplate::Msg
 
-    HELP = <<-'HELP'
-
-  A boilerplate is a markdown file in the `_boilerplates` folder.
-
-  ie. `_boilerplates/post.yml`
-      ---
-      _boilerplate:     # boilerplate settings
-        path: _posts    #   the path to create the new page under.
-        timestap: true  #   when true new post/pages will include the date in the filename. 
-      
-      layout: post      # everthing else will be copied to the new post.
-      author: John Doe
-  
-
-  `$ 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
-      ---
+  SUMMARY = "A jekyll plugin that allows you to create new pages or posts from a boilerplate through the terminal."  
 
+  def self.file name
+    puts self.read_file name
+  end
 
-  Usage: `$ boilerplate [page|init|help]`
+  def self.description
+    self.read_file('description.md')
+  end
 
-  `$ boilerplate init`: creates a example boilerplate at `_boilerplates/example.md`
+  def self.read_file name
+    File.read(File.join(__dir__, 'msg', name))
+  end
   
-  `$ boilerplate page <boilerplate-name> <post-title>`: Creates a new page from a boilerplate
+  def self.error(**msgs)
+    msgs.each {|k,v| puts(k.to_s.capitalize!+': '+v)}
+  end
 
-  `$ boilerplate help`: shows this dialog.
+  def self.info msg
+    puts msg
+  end
 
-    HELP
-  
+  def self.try_and_report &block
+    begin
+      self.info block.call
+    rescue => e
+      self.error fatal: e.message
+    end
   end
-end
+
+end

data/lib/jekyll_page_boilerplate/page.rb

@@ -1,107 +1,139 @@
 
 require 'yaml'
 require "stringex"
+require 'securerandom'
+
+class JekyllPageBoilerplate::Page
+  
+  BOILERPLATES_PATH = '_boilerplates'
+  FILE_DATE_FORMATE = '%Y-%m-%d'
+  READ_CONFIG_REGEX = /[\r\n\s]{0,}^_boilerplate:(\s*^[\t ]{1,2}.+$)+[\r\s\n]{0,}(?![^\r\s\n])/
+  READ_FILE_REGEX = /^-{3}\s*^(?<head>[\s\S]*)^-{3}\s^(?<body>[\s\S]*)/
+  TAGS_REGEX = /(?<tag>\{{2}\s{0,}boilerplate\.(?<key>[^\{\}\.\s]+)\s{0,}\}{2})/
+
+  attr_reader :config
+
+  def self.run boilerplate, options
+    page = self.new(boilerplate, options)
+    page.create
+    return "Created %s/%s" % [page.config['path'], page.config['file']]
+  end
 
-module JekyllPageBoilerplate
-  class Page
+  def initialize boilerplate, options
+    options.compact!
+    options.transform_keys!(&:to_s)
+    plate_path = get_boilerplate_path(boilerplate).to_s
 
-    BOILERPLATES_PATH = '_boilerplates'
-    FILE_DATE_FORMATE = '%Y-%m-%d'
-    READ_CONFIG_REGEX = /[\r\n\s]{0,}^_boilerplate:(\s*^[\t ]{1,2}.+$)+[\r\s\n]{0,}(?![^\r\s\n])/
-    READ_FILE_REGEX = /^-{3}\s*^(?<head>[\s\S]*)^-{3}\s^(?<body>[\s\S]*)/
+    abort_unless_file_exists( plate_path )
 
+    parsed_file = {}
+    File.open(plate_path, 'r') do |file|
+      parsed_file = file.read.match(READ_FILE_REGEX).named_captures
+    end
 
-    def initialize boilerplate
+    @config = get_config(parsed_file['head']).merge(options)
+    @config['suffix'] ||= plate_path[/\.\w+$/]
+    @config['name'] ||= plate_path[/.*(?=\.)/] || plate_path
+    @head = get_head(parsed_file['head'])
+    @body = get_body(parsed_file['body'])
+  end
+  
+  def create
+    @config['time'] ||= Time.now.to_s
+    @config['date'] ||= Time.now.strftime(FILE_DATE_FORMATE)
 
-      plate_path = get_boilerplate_path(boilerplate).to_s
-      
-      abort_unless_file_exists( plate_path )
+    abort_unless_file_exists(@config['path'])
+    
+    @config['file'] ||= get_new_page_filename(@config['title'] || @config['name'])
 
-      parsed_file = {}
-      File.open(plate_path, 'r') do |file|
-        parsed_file = file.read.match(READ_FILE_REGEX).named_captures
-      end
+    scan_template :@body
+    scan_template :@head
 
-      @config = get_config(parsed_file['head'])       
-      @head = get_head(parsed_file['head'])
-      @body = get_body(parsed_file['body'])
-    end
-    
-    def create title
-      abort_unless_file_exists(@config['path'])
-      
-      set_header_entry 'title', title.gsub(/[&-]/, '&'=>'&amp;', '-'=>' ')
-      set_header_entry 'created', Time.now.to_s
+    create_new_page @config['file']
+  end
 
-      create_new_page get_new_page_filename(title)
-    end
+  private
+  
+  def create_new_page filename
+    new_file_path = File.join( @config['path'], filename )
 
-    private
-    
-    def create_new_page filename
-      new_file_path = File.join( @config['path'], filename )
-
-      abort_if_file_exists(new_file_path)
-
-      open(new_file_path, 'w') do |page|
-        page.puts '---'
-        page.puts @head.lstrip
-        page.puts '---'
-        page.puts @body
-        page.puts ''
-      end      
-    end
+    abort_if_file_exists(new_file_path)
 
+    open(new_file_path, 'w') do |page|
+      page.puts '---'
+      page.puts @head.lstrip
+      page.puts '---'
+      page.puts @body
+      page.puts ''
+    end      
+  end
 
-    def set_header_entry key, val
-      @head << "\n#{key}: null" unless @head.match /^#{key}:.*$/
-      @head.gsub! /^#{key}:.*$/, "#{key}: #{val}"
+  def scan_template var
+    instance_variable_get(var).scan(TAGS_REGEX).uniq.each do |tag, key|
+      instance_variable_get(var).gsub! /\{{2}\s{0,}boilerplate\.#{key}\s{0,}\}{2}/, get_tag_value(key)
     end
+  end
 
-    def get_body markdown
-      return markdown
-    end
+  def get_tag_value(key)
+    return @config[key] if @config[key]
+    key = key.split('=')
+    return Tag.send(key[0].to_sym, *key[1]&.split(','))
+  end
+ 
+  class Tag
+    class << self
+      def method_missing *args
+        ''
+      end
 
-    def get_config head
-      return YAML.load(head.match(READ_CONFIG_REGEX).to_s)['_boilerplate']
+      def random_url length = nil
+        length && length = length.to_i
+        SecureRandom.urlsafe_base64(length)
+      end
     end
+  end
 
-    def get_head head
-      return head.gsub( READ_CONFIG_REGEX, '')
-    end
-    
+  def get_body markdown
+    return markdown
+  end
 
-    def get_boilerplate_path plate_name
-      return Dir.glob( 
-        "#{File.join(BOILERPLATES_PATH, plate_name)}.{md,markdown,MD,MARKDOWN}" 
-      ).first
-    end
+  def get_config head
+    return YAML.load(head.match(READ_CONFIG_REGEX).to_s)['_boilerplate']
+  end
 
+  def get_head head
+    return head.gsub( READ_CONFIG_REGEX, '')
+  end
+  
 
-    def get_new_page_filename title
-      title = title.to_url
-      title = "#{title}#{@config['suffix'] || '.markdown'}"
-      if @config['timestamp']
-        title = "#{Time.now.strftime(FILE_DATE_FORMATE)}-#{title}"
-      end
-      return title
+  def get_boilerplate_path plate_name
+    return Dir.glob( 
+      "#{File.join(BOILERPLATES_PATH, plate_name)}*" 
+    ).first
+  end
+
+
+  def get_new_page_filename title
+    title = title.to_url
+    title = "#{title}#{@config['suffix']}"
+    if @config['timestamp']
+      title = "#{@config['date']}-#{title}"
     end
+    return title
+  end
 
 
 
-    def abort_if_file_exists(file_path)
-      if File.exist?(file_path)
-        raise "#{file_path} already exists!"
-      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
+  def abort_unless_file_exists(file_path)
+    unless File.exist?(file_path)
+      raise "The file `#{file_path}` does not exist!"
     end
-
-
   end
 
-end
+end

data/lib/jekyll_page_boilerplate/version.rb

@@ -1,3 +1,3 @@
 module JekyllPageBoilerplate
-  VERSION = "2.1.0"
+  VERSION = "4.1.0"
 end

data/lib/jekyll_page_boilerplate.rb

@@ -1,33 +1,33 @@
 require "jekyll_page_boilerplate/version"
-require "jekyll_page_boilerplate/page"
 require "jekyll_page_boilerplate/msg"
+require "jekyll_page_boilerplate/page"
 require "jekyll_page_boilerplate/init"
+require "jekyll_page_boilerplate/list"
+
 
 module JekyllPageBoilerplate
   class Error < StandardError; end
 
-
-  def self.init cmd
-    begin
-      Init.setup
-    rescue => e
-      cmd.logger.fatal e.message
+  def self.init 
+    Msg.try_and_report do
+      Init.run
     end
   end
 
-
-  def self.help cmd
-    cmd.logger.info Msg::HELP
+  def self.list
+    Msg.try_and_report do
+      List.run
+    end
   end
 
+  def self.readme
+    Msg.file 'description.md'
+  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
+  def self.page boilerplate_name, options
+    Msg.try_and_report do
+      Page.run(boilerplate_name, options)
     end
-  end
+  end  
 
 end

data/lib/jekyll_page_boilerplate_cli.rb

@@ -0,0 +1,60 @@
+require "bales"
+require 'jekyll_page_boilerplate'
+
+class JekyllPageBoilerplate::Application < Bales::Application
+  version JekyllPageBoilerplate::VERSION
+  description JekyllPageBoilerplate::Msg.description
+  summary JekyllPageBoilerplate::Msg::SUMMARY
+  # `boilerplate <page>`  
+  option :title, type: String, long_form: '--title', short_form: '-T',
+    description: "`path/<title>.md`"
+  option :path, type: String, long_form: '--path', short_form: '-p',
+    description: "`<path>/title.md`"
+  option :timestamp, type: TrueClass, long_form: '--timestamp', short_form: '-s',
+    description: "`path/<time.now>-title.md`"
+  option :suffix, type: String, long_form: '--suffix', short_form: '-x',
+    description: "`path/title.<md, markdown, txt>`"
+
+  action do |plate, *custom, title: nil, path: nil, timestamp: nil, suffix: nil|
+    custom = Hash[custom.map {|v| v.split('=')}]
+    JekyllPageBoilerplate.page plate, custom.merge({
+      title: title, path: path, 
+      suffix: suffix, timestamp: timestamp
+    })
+  end
+
+  # `boilerplate help`  
+  command 'help', parent: Bales::Command::Help
+
+  # `boilerplate init`  
+  command 'init' do
+    summary "Creates an example boilerplate."
+    action do
+      JekyllPageBoilerplate.init
+    end
+  end
+  
+  # `boilerplate list`  
+  command 'list' do
+    summary "List all the boilerplates"
+    action do 
+      JekyllPageBoilerplate.list
+    end
+  end
+  
+
+  def self.run(*args, **opts)
+    begin
+      super
+    rescue => e
+      JekyllPageBoilerplate.readme 
+    end
+  end
+
+end
+
+JekyllPageBoilerplate::Application.parse_and_run
+
+  
+  
+  

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-page-boilerplate
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Sean Ferney
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mercenary
+  name: bales
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: stringex
   requirement: !ruby/object:Gem::Requirement
@@ -44,22 +44,38 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.8.5
-description: A jekyll plugin that allows you to create new pages or posts from a boilerplate
-  through the terminal.
+description: "A boilerplate is a markdown file you place under the `_boilerplates`
+  folder to generate new pages for jekyll.\n\n`_boilerplates/post.md`\n\n    ---\n
+  \   _boilerplate:       # boilerplate settings\n        path: _posts    # the path
+  to create the new page under.\n        timestamp: true  # when true new post/pages
+  will include the date in the filename. \n    title: {{ boilerplate.title }} # tags
+  like this will be replaced\n    layout: post        # everthing else will be copied
+  to the new post.\n    author: John Doe\n\n\n`$ boilerplate post -T \"Another one
+  about pottery\"` would create a new file `_posts/yyyy-mm-dd-another-one-about-pottery.markdown`\n\n
+  \   ---\n    title: Another one about pottery\n    created: 'yyyy-mm-dd hh:mm:ss
+  -0000'\n    layout: post\n    author: John Doe\n\n\nAvailable Tags `{{ boilerplate.xxx
+  }}`:\n- `.title`, `.name`\n- `.path`, `.file`, `.suffix`\n- `.time`, `.date`, `.timestamp`\n-
+  `.random_url`\n- Custom tags you provide in the command `bplate post custom=1`\n-
+  And anything you put under the `_boilerplate:` header\n"
 email:
 - sean@codekarma.dev
 executables:
 - boilerplate
+- bplate
 extensions: []
 extra_rdoc_files: []
 files:
 - exe/boilerplate
+- exe/bplate
 - lib/jekyll_page_boilerplate.rb
 - lib/jekyll_page_boilerplate/example.md
 - lib/jekyll_page_boilerplate/init.rb
+- lib/jekyll_page_boilerplate/list.rb
 - lib/jekyll_page_boilerplate/msg.rb
+- lib/jekyll_page_boilerplate/msg/description.md
 - lib/jekyll_page_boilerplate/page.rb
 - lib/jekyll_page_boilerplate/version.rb
+- lib/jekyll_page_boilerplate_cli.rb
 homepage: https://github.com/CodeKarmaDev/jekyll-page-boilerplate
 licenses:
 - MIT
@@ -84,5 +100,6 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: A jekyll plugin that creates new pages from boilerplates
+summary: A jekyll plugin that allows you to create new pages or posts from a boilerplate
+  through the terminal.
 test_files: []