jekyll-page-boilerplate 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a93e2b4e7e502c0d19906f1dae2786f6fb1ceecf39d52c0dbdf82db241215e2
-  data.tar.gz: 71434d9ca5e0072c25543fc2180b37ee59ce4702d73dde7ea454c16bf14d56cd
+  metadata.gz: 598484bc29508c7785e1dd1e24eb2699b6ecc7aa0ba346ee9c67a4d7530f3cc1
+  data.tar.gz: e72595d0503e4011384f54fd5d1a076e18796287b380911c1a14a8820d7c33a4
 SHA512:
-  metadata.gz: 9cf262a0c5dc30f2af6b428ab50c0a9b5942c7e192c3e5f18a6e56dab04f2c081f3137119dabce88d108fedc9b65703363985df7a292fd70e472bcc15d778228
-  data.tar.gz: f09fcfbd8dec7ef599e738b9dc45b4616ac181b07088dce6e1025bf3db9ccac32a24b52be9624d24304c03bc011d841cbdda157cdf20e7d8d7b77f12749c7ed9
+  metadata.gz: '058701eb91e08f7630642bbcbeeedf3368fc90c533dcb88286570e348207fd12af8a8dab89f0ea56094ff06f097a11c7fc0b061760007c6adcdecf8a16c23483'
+  data.tar.gz: f2678c628a1fde61096a8c68c61945796881ed190fcbab82af68ea73ed2e06c3cfcd849eec3806946ac0314f1791a63418ae7415e0c657843473a68bfc3c8276

data/exe/boilerplate

@@ -11,10 +11,10 @@ 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.syntax "boilerplate <subcommand> [options]"
 
   p.command(:page) do |c|
-    c.syntax "create BOILERPLATE_NAME \"NEW PAGE TITLE\""
+    c.syntax 'page BOILERPLATE_NAME "NEW PAGE TITLE"'
     c.description "Creates a page or post from a boilerplate."
 
     c.action do |args, _|

data/lib/jekyll_page_boilerplate/example.md

@@ -0,0 +1,44 @@
+---
+_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
+
+layout: post      # Anything else in the file will be copied to your new post/page.
+author: John Doe
+---
+
+
+A Jekyll Boilerplate Example
+----------------------------
+
+
+To create a new page/post from this boilerplate run:
+```bash
+$ boilerplate page example "Another post about pottery"`
+```
+
+A boilerplate is a markdown file in the `_boilerplates` folder.
+
+
+This would create a new file:
+
+```text 
+_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
+---
+
+A Jekyll Boilerplate Example
+----------------------------
+
+To create a new page/post from this boilerplate run:
+
+recursion error...
+
+```

data/lib/jekyll_page_boilerplate/init.rb

@@ -4,7 +4,7 @@ module JekyllPageBoilerplate
   module Init
     def self.setup
       FileUtils.mkpath('_boilerplates')
-      FileUtils.cp(File.join(__dir__, 'example.yml'), '_boilerplates')
+      FileUtils.cp(File.join(__dir__, 'example.md'), '_boilerplates')
     end
   
   end

data/lib/jekyll_page_boilerplate/msg.rb

@@ -4,35 +4,34 @@ module JekyllPageBoilerplate
 
     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
-        
+  A boilerplate is a markdown file in the `_boilerplates` folder.
 
-      `$ boilerplate page post "Another one about pottery"`
+  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. 
       
-      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
-        ---
-        
+      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
+      ---
+
+
+  Usage: `$ boilerplate [page|init|help]`
+
+  `$ boilerplate init`: creates a example boilerplate at `_boilerplates/example.md`
+  
+  `$ boilerplate page <boilerplate-name> <post-title>`: Creates a new page from a boilerplate
+
+  `$ boilerplate help`: shows this dialog.
 
     HELP
   

data/lib/jekyll_page_boilerplate/page.rb

@@ -7,69 +7,81 @@ module JekyllPageBoilerplate
 
     BOILERPLATES_PATH = '_boilerplates'
     FILE_DATE_FORMATE = '%Y-%m-%d'
+    READ_CONFIG_REGEX = /^_boilerplate:(\s*^[\t ]{1,2}.+$)+/
+    READ_FILE_REGEX = /^-{3}\s*$(?<head>[\s\S]*)^-{3}\s$(?<body>[\s\S]*)/
 
 
-    def initialize boilerplate, suffix: '.yml' 
-      plate_path = File.join(BOILERPLATES_PATH, "#{boilerplate}#{suffix}")
+    def initialize boilerplate
+
+      plate_path = get_boilerplate_path(boilerplate)
       
-      set_boilerplate_from_yaml_file( plate_path )
-    end    
+      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
+
+      @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(@boilerplate['path'])
-      
-      add_header_title( title )
-      add_header_created()
+      abort_unless_file_exists(@config['path'])
       
-      create_new_page( title )
+      set_header_entry 'title', title.gsub(/[&-]/, '&'=>'&amp;', '-'=>' ')
+      set_header_entry 'created', Time.now.to_s
 
-      @boilerplate
+      create_new_page get_new_page_filename(title)
     end
 
     private
-
-    def create_new_page title
-      filename = get_new_page_filename( title )
-      
-      new_file_path = File.join( @boilerplate['path'], filename )
+    
+    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 @boilerplate['header'].to_yaml
         page.puts '---'
+        page.puts @head
+        page.puts '---'
+        page.puts @body
         page.puts ''
-        page.print @boilerplate['content']
-        page.puts ''
-      end
-      
+      end      
     end
 
 
-    def add_header_created
-      @boilerplate['header']['created'] = Time.now.to_s
+    def set_header_entry key, val
+      @head << "\n#{key}: null" unless @head.match /^#{key}:.*$/
+      @head.gsub! /^#{key}:.*$/, "#{key}: #{val}"
     end
-    
-    def add_header_title title
-      @boilerplate['header']['title'] = title.gsub(/[&-]/, '&'=>'&amp;', '-'=>' ')
+
+    def get_body markdown
+      return markdown
     end
 
+    def get_config head
+      return YAML.load(head.match(READ_CONFIG_REGEX).to_s)['_boilerplate']
+    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
+    def get_head head
+      return head.gsub READ_CONFIG_REGEX, ''
     end
     
 
+    def get_boilerplate_path plate_name
+      return Dir.glob( 
+        "#{File.join(BOILERPLATES_PATH, plate_name)}.{md,markdown,MD,MARKDOWN}" 
+      ).first
+    end
+
+
     def get_new_page_filename title
       title = title.to_url
-      title = "#{title}#{@boilerplate['suffix'] || '.markdown'}"
-      if @boilerplate['timestamp']
+      title = "#{title}#{@config['suffix'] || '.markdown'}"
+      if @config['timestamp']
         title = "#{Time.now.strftime(FILE_DATE_FORMATE)}-#{title}"
       end
       return title

data/lib/jekyll_page_boilerplate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-page-boilerplate
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Sean Ferney
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-26 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -28,16 +28,22 @@ dependencies:
   name: stringex
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.8.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.8.5
 description: A jekyll plugin that allows you to create new pages or posts from a boilerplate
   through the terminal.
 email:
@@ -49,7 +55,7 @@ extra_rdoc_files: []
 files:
 - exe/boilerplate
 - lib/jekyll_page_boilerplate.rb
-- lib/jekyll_page_boilerplate/example.yml
+- lib/jekyll_page_boilerplate/example.md
 - lib/jekyll_page_boilerplate/init.rb
 - lib/jekyll_page_boilerplate/msg.rb
 - lib/jekyll_page_boilerplate/page.rb
@@ -75,8 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
-summary: A jekyll plugin that create new pages from boilerplates
+summary: A jekyll plugin that creates new pages from boilerplates
 test_files: []

data/lib/jekyll_page_boilerplate/example.yml

@@ -1,43 +0,0 @@
----
-
-# 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.
-# 
-#