jekyll-page-boilerplate 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17477700177377cd7125dcdaab31a6c5ccc853d7f4a2ad866fb055680803f41e
-  data.tar.gz: 2b03a6cca499eb059c8842fd1a5c4dbeefef44b538d2bd92df738fd795c9a10b
+  metadata.gz: c0e902f15da76660bca40905d596f95cc1ab1f6f3f3f1e6533d38d1e219b05e6
+  data.tar.gz: 71a26b39978a7f26252e95f99caf0e1dda7a8b4f72ebe57637afa5a5eca040f3
 SHA512:
-  metadata.gz: 91381a908df2713f69036642a842f84da601f8616219ea362b18ded8f8c189452498a40d29c972f7e1832ba414ef8d4fdcd0bbf03aa97e8426582acb665c7b66
-  data.tar.gz: 7522e8fe98b9beb92b057f1159776ea53c9075fcede91b1a4d0c5632646fb0e25f602931a6b32b84d0bc4c061edaf49ed00715f1d51c70870c4355e0ee809bf0
+  metadata.gz: 7d5a7e96cdc2b999749603d9c8dcda141b49e7b2230dc5ae2871cab22eff97b29f309320d69777ba9c9c5287b477bcf2847a9c14c9b235d150049215b0d1fe04
+  data.tar.gz: 3182cf46a90cf0d0ffe94ba6120eee236a5ec6d897cba09dc702fcd5a8b8cf300ab2a28e0dd8ae47e422608bf43f56f22cce2595e91b045c17f82f4a4532033b

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

data/lib/jekyll_page_boilerplate/version.rb

@@ -1,5 +1,3 @@
 module JekyllPageBoilerplate
-  VERSION = "4.0.1"
-
-  DESCRIPTION = "A jekyll plugin that allows you to create new pages or posts from a boilerplate through the terminal."  
+  VERSION = "4.1.0"
 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.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Sean Ferney
@@ -44,8 +44,19 @@ 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:
@@ -61,7 +72,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 +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: []

data/lib/jekyll_page_boilerplate/msg/readme.md

@@ -1,30 +0,0 @@
-A boilerplate is a markdown file in the `_boilerplates` folder.
-
-ie. `_boilerplates/post.md`
-    ---
-    _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 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 with `{{ boilerplate.xxx }}`:
-- `.title`, `.name`
-- `.path`, `.file`, `.suffix`
-- `.time`, `.date`, `.timestamp`
-- `.random_url`
-- And anything you put under the `_boilerplate:` header
-
-
-
-Use `boilerplate help` for more details