jekyll-page-boilerplate 4.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0bdff35c4fc0b98be3987b90be503a93864c8dcb0dec6358a1cdd07f19fdc88
-  data.tar.gz: 8a11dca9014aaa518f9f56d4782077e3791b4342af84a8f917afe8d5b7eecf62
+  metadata.gz: 774edface63c05ab9dba0898408bbc7ba43936fd0d67a56fb201989bb605ae15
+  data.tar.gz: b1076c48762f122437d06ee5424afe489ff58b3e0ac1e2b61d134da964492b40
 SHA512:
-  metadata.gz: b9a614357a7bcb5c380ab20587b34779d18d12d06380f0511a15f8187ea22b28547b640aeba05029422de27cc3e0974ac724c0b13746220a6e3455f83abf67be
-  data.tar.gz: 7533fd3e0811a14c04f505c444d1e61225bc624c54d9cd2aecace495884172c8628b04810d54e23639137334ea5ccdff4e65ab8dddeb8ed39c33e099e226def0
+  metadata.gz: b89128cd44e91ba760b7d7655b5c14d1d26919bca83c016364ff7dae30d91f1d63b208cb0a73a07c59abeed4c463d1dc7a2f852319992308bddc27f7073b20f2
+  data.tar.gz: 1dcc5e8279d8e0ad5e5cb84c5efc5209d86cccf8391d3b669f51fbc34407a508f808271992912ee158852d91b2f1a4bcf3accb2fb12270ddc999f9e25cef5a42

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,8 +1,18 @@
 
 module JekyllPageBoilerplate::Msg
 
+  SUMMARY = "A jekyll plugin that allows you to create new pages or posts from a boilerplate through the terminal."  
+
   def self.file name
-    puts File.read(File.join(__dir__, 'msg', name))
+    puts self.read_file name
+  end
+
+  def self.description
+    self.read_file('description.md')
+  end
+
+  def self.read_file name
+    File.read(File.join(__dir__, 'msg', name))
   end
   
   def self.error(**msgs)

data/lib/jekyll_page_boilerplate/page.rb

@@ -21,7 +21,7 @@ class JekyllPageBoilerplate::Page
 
   def initialize boilerplate, options
     options.compact!
-    options.transform_keys! {|k| k.to_s}
+    options.transform_keys!(&:to_s)
     plate_path = get_boilerplate_path(boilerplate).to_s
 
     abort_unless_file_exists( plate_path )
@@ -82,8 +82,8 @@ class JekyllPageBoilerplate::Page
  
   class Tag
     class << self
-      def missing_method
-        nil
+      def method_missing *args
+        ''
       end
 
       def random_url length = nil
@@ -93,11 +93,6 @@ class JekyllPageBoilerplate::Page
     end
   end
 
-  def fill_template key, val
-    @head.gsub! /\{{2}\s{0,}boilerplate\.#{key}\s{0,}\}{2}/, @config[key].to_s
-    @body.gsub! /\{{2}\s{0,}boilerplate\.#{key}\s{0,}\}{2}/, @config[key].to_s
-  end
-
   def get_body markdown
     return markdown
   end

data/lib/jekyll_page_boilerplate/version.rb

@@ -1,5 +1,3 @@
 module JekyllPageBoilerplate
-  VERSION = "4.0.0"
-
-  DESCRIPTION = "A jekyll plugin that allows you to create new pages or posts from a boilerplate through the terminal."  
+  VERSION = "4.1.1"
 end

data/lib/jekyll_page_boilerplate.rb

@@ -21,7 +21,7 @@ module JekyllPageBoilerplate
   end
 
   def self.readme
-    Msg.file 'readme.md'
+    Msg.file 'description.md'
   end
 
   def self.page boilerplate_name, options

data/lib/jekyll_page_boilerplate_cli.rb

@@ -3,8 +3,8 @@ require 'jekyll_page_boilerplate'
 
 class JekyllPageBoilerplate::Application < Bales::Application
   version JekyllPageBoilerplate::VERSION
-  description JekyllPageBoilerplate::DESCRIPTION
-
+  description JekyllPageBoilerplate::Msg.description
+  summary JekyllPageBoilerplate::Msg::SUMMARY
   # `boilerplate <page>`  
   option :title, type: String, long_form: '--title', short_form: '-T',
     description: "`path/<title>.md`"
@@ -15,16 +15,12 @@ class JekyllPageBoilerplate::Application < Bales::Application
   option :suffix, type: String, long_form: '--suffix', short_form: '-x',
     description: "`path/title.<md, markdown, txt>`"
 
-  action do |plate, title: nil, path: nil, timestamp: nil, suffix: nil|
-    JekyllPageBoilerplate.page plate, {title: title, path: path, suffix: suffix, timestamp: timestamp}
-  end
-
-  # `boilerplate readme`  
-  command 'readme' do
-    description "Helpful info"
-    action do
-      JekyllPageBoilerplate.readme
-    end
+  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`  
@@ -32,7 +28,7 @@ class JekyllPageBoilerplate::Application < Bales::Application
 
   # `boilerplate init`  
   command 'init' do
-    description "Creates an example boilerplate."
+    summary "Creates an example boilerplate."
     action do
       JekyllPageBoilerplate.init
     end
@@ -40,7 +36,7 @@ class JekyllPageBoilerplate::Application < Bales::Application
   
   # `boilerplate list`  
   command 'list' do
-    description "List all the boilerplates"
+    summary "List all the boilerplates"
     action do 
       JekyllPageBoilerplate.list
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-page-boilerplate
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Sean Ferney
@@ -44,8 +44,22 @@ 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/<boilerplate>.md` folder to generate new pages for jekyll.
+
+
+  It can automatically timestamp and title new pages.
+
+
+  It will also replacing any `{{ boilerplate.xxx }}` tags with content. Available tags include `.time, .title, .date, .random_url`.
+
+
+  You can also provide custom tags with `boilerplate post nav_order=1` > `{{ boilerplate.nav_order }}`.
+
+
+  In the boilerplate header you can specify options like the path to generate pages under and if filenames should be timestamped. `_boilerplate: > path: '_posts/'`
+
+
 email:
 - sean@codekarma.dev
 executables:
@@ -61,7 +75,7 @@ files:
 - lib/jekyll_page_boilerplate/init.rb
 - lib/jekyll_page_boilerplate/list.rb
 - lib/jekyll_page_boilerplate/msg.rb
-- lib/jekyll_page_boilerplate/msg/readme.md
+- 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
@@ -89,5 +103,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: []

data/lib/jekyll_page_boilerplate/msg/readme.md

@@ -1,27 +0,0 @@
-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. 
-    
-    title: {{ boilerplate.title }}
-    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.