RubyGems - jekyll-page-boilerplate - Versions diffs - 4.3.0 → 4.4.0 - Mend

jekyll-page-boilerplate 4.3.0 → 4.4.0

Files changed (8) hide show

checksums.yaml +4 -4
data/lib/jekyll_page_boilerplate/msg/description.md +4 -4
data/lib/jekyll_page_boilerplate/msg/gem_description.md +2 -2
data/lib/jekyll_page_boilerplate/page.rb +38 -80
data/lib/jekyll_page_boilerplate/tags.rb +70 -0
data/lib/jekyll_page_boilerplate/version.rb +1 -1
data/lib/jekyll_page_boilerplate.rb +1 -0
metadata +5 -4

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11506899d111701050ee623e6f1970e1a6ea1028a597c47ddb09e84d2bda8625
-  data.tar.gz: 79a41ce8ae43e40aab6ece52faab4b0a604f462849a9bb076d8df601cff1409d
+  metadata.gz: 65d5d4ea29334a96097f61f901251bd077dd288ef96db98316e79c289db435ea
+  data.tar.gz: 44365677835697d6b07f636a14e81a96595be48274d0e3a828c9b09499282d89
 SHA512:
-  metadata.gz: 57085fc3192f461a8fbdb1bf6dfe722e5eb9447fe608b4be170922192a17c930780d4e25c253a77220ab6dcd697f94c3c2029b2c34546d7f91e0974d679e224d
-  data.tar.gz: 587b236f7a440a0a6d274926267b2fd9e45f83eb11724559b89a5bfba76deb27b99a809f651c96a3d7dabc78dcdce647a961e4961aea8f602aac7c006dc67a48
+  metadata.gz: 71b662bc22160d2a1550eac1beedb5ebebca1484765d1e3b18062f863a7948f8b3b7d7773c8caf6a639a8937f9609e01cfed01dc1643d0e0bc1a9c3195b7c0a2
+  data.tar.gz: fd59775cb1917f121ba79861a9b5aad461b0928d482e1af2a59a7b8236732b2ce397ed3594491d4372516a1611213aa14153847ae45f88db3b1340051743f59f

data/lib/jekyll_page_boilerplate/msg/description.md CHANGED Viewed

@@ -6,9 +6,9 @@ A boilerplate is a markdown file you place under the `_boilerplates` folder to g
     _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.
-        # a custom slug overrides the timestamp setting
-        slug: '{{ title }}-{{ date }}'
-        # slug is a template for the filename, it cant take the same tags everything else.
+        slug: '{{ title }}-{{ num }}'
+        # slug is a template for the filename, it cant take the same tags as everything else.
+        num: 0
     title: {{ boilerplate.title }} # tags like this will be replaced
     layout: post        # everthing else will be copied to the new post.
     author: John Doe
@@ -27,6 +27,6 @@ Available Tags `{{ boilerplate.xxx }}`:
 - `.title`, `.name`
 - `.path`, `.file`, `.suffix`
 - `.time`, `.date`, `.timestamp`
-- `.random_url`
+- `.random`
 - 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/gem_description.md CHANGED Viewed

@@ -1,10 +1,10 @@
-A boilerplate is a markdown file you place under the `_boilerplates/<boilerplate>.md` folder to generate new pages for jekyll.
+A boilerplate is a markdown file you place under the `_boilerplates/` 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`.
+It will also replacing any `{{ boilerplate.xxx }}` tags with content. Available tags include `.time, .title, .date, .random`.
 You can also provide custom tags with `boilerplate post nav_order=1` > `{{ boilerplate.nav_order }}`.

data/lib/jekyll_page_boilerplate/page.rb CHANGED Viewed

@@ -2,31 +2,26 @@
 require 'yaml'
 require "stringex"
 require 'securerandom'
+require 'fileutils'
 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 = /\{{2}\s{0,}boilerplate\.([^\{\}\.\s]+)\s{0,}\}{2}/
-  TAG_SLUG = /\{{2}\s{0,}([^\{\}\.\s]+)\s{0,}\}{2}/
+  attr_reader :tags
-  attr_reader :config
-  def self.run boilerplate, options
-    page = self.new(boilerplate, options)
+  def self.run boilerplate, *options
+    page = self.new(boilerplate, *options)
     page.create
-    return "Created %s/%s" % [page.config['path'], page.config['file']]
+    return "Created "+ File.join(page.tags['path'], page.tags['file'])
   end
-  def initialize boilerplate, options
-    options.compact!
-    options.transform_keys!(&:to_s)
-    plate_path = get_boilerplate_path(boilerplate).to_s
+  def initialize boilerplate, *options, **params
+    plate_path = get_boilerplate_path(boilerplate)
     abort_unless_file_exists( plate_path )
     parsed_file = {}
@@ -34,45 +29,45 @@ class JekyllPageBoilerplate::Page
       parsed_file = file.read.match(READ_FILE_REGEX).named_captures
     end
-    @config = get_config(parsed_file['head']).merge(options)
-    @config['suffix'] ||= plate_path[/\.\w+$/]
-    @config['name'] ||= plate_path[/.*(?=\.)/] || plate_path
-    @config['basename'] = File.basename(plate_path, '.*')
-    @config['title'] ||= @config['basename']
-    unless @config['slug']
-      if @config['timestamp']
-        @config['slug'] = '{{ date }}-{{ title }}'
-      else
-        @config['slug'] = '{{ title }}'
-      end
-    end
+    @tags = JekyllPageBoilerplate::Tags.new(
+      defaults(plate_path),
+      get_header_config(parsed_file['head']),
+      *options,
+      params
+    )
+    @tags[:file] = '{{ date }}-{{ slug }}{{ suffix }}' if @tags.timestamp
+    @tags.fill(:slug, :file, :path, safe: true)
     @head = get_head(parsed_file['head'])
-    @body = get_body(parsed_file['body'])
+    @body = parsed_file['body']
   end
   def create
-    @config['time'] ||= Time.now.to_s
-    @config['date'] ||= Time.now.strftime(FILE_DATE_FORMATE)
-    abort_unless_file_exists(@config['path'])
-    # puts @config['slug']
-    scan_slug
-    @config['file'] = @config['slug']+@config['suffix']
-    # puts @config['file']
-    # puts @config['title'].inspect
+    FileUtils.mkdir_p(@tags.path)
     scan_template :@body
     scan_template :@head
-    create_new_page @config['file']
+    create_new_page
   end
   private
-  def create_new_page filename
-    new_file_path = File.join( @config['path'], filename )
+  def defaults(plate_path, timestamp: false)
+    basename = File.basename(plate_path, '.*')
+    {
+      suffix: plate_path[/\.\w+$/],
+      name: plate_path[/.*(?=\.)/] || plate_path,
+      basename: basename,
+      title: basename,
+      slug: '{{ title }}',
+      path: '_posts/',
+      file: '{{ slug }}{{ suffix }}',
+    }
+  end
+  def create_new_page
+    new_file_path = File.join( @tags.path, @tags.file )
     abort_if_file_exists(new_file_path)
@@ -87,43 +82,11 @@ class JekyllPageBoilerplate::Page
   def scan_template var
     instance_variable_get(var).scan(TAGS_REGEX).flatten.uniq.each do |tag|
-      instance_variable_get(var).gsub! /\{{2}\s{0,}boilerplate\.#{tag}\s{0,}\}{2}/, get_tag_value(tag)
-    end
-  end
-  def scan_slug
-    @config['slug'].scan(TAG_SLUG).flatten.uniq.each do |tag|
-      @config['slug'].gsub! /\{{2}\s{0,}#{tag}\s{0,}\}{2}/, get_tag_value(tag)
-    end
-    @config['slug'].gsub!(/[^0-9A-Za-z\.\-_]/, '-')
-    @config['slug'].downcase!
-  end
-  def get_tag_value(key)
-    return @config[key].to_s 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 random_url length = nil
-        length && length = length.to_i
-        SecureRandom.urlsafe_base64(length)
-      end
+      instance_variable_get(var).gsub! /\{{2}\s{0,}boilerplate\.#{tag}\s{0,}\}{2}/, @tags[tag].to_s
     end
   end
-  def get_body markdown
-    return markdown
-  end
-  def get_config head
+  def get_header_config head
     return YAML.load(head.match(READ_CONFIG_REGEX).to_s)['_boilerplate']
   end
@@ -131,15 +94,10 @@ class JekyllPageBoilerplate::Page
     return head.gsub( READ_CONFIG_REGEX, '')
   end
   def get_boilerplate_path plate_name
-    return Dir.glob(
-      "#{File.join(BOILERPLATES_PATH, plate_name)}*"
-    ).first
+    return Dir.glob( "#{File.join(BOILERPLATES_PATH, plate_name)}*" ).first.to_s
   end
   def abort_if_file_exists(file_path)
     if File.exist?(file_path)
       raise "#{file_path} already exists!"

data/lib/jekyll_page_boilerplate/tags.rb ADDED Viewed

@@ -0,0 +1,70 @@
+class JekyllPageBoilerplate::Tags
+  FILE_DATE_FORMATE = '%Y-%m-%d'
+  FILL_SCAN = /\{{2}\s{0,}([^\{\}\.\s]+)\s{0,}\}{2}/
+  def self.[] *args
+    self.new *args
+  end
+  def initialize *args, **params
+    @tags = {}
+    add(*args, params)
+  end
+  def []= key, val
+    @tags[key.to_s] = val
+  end
+  def add *args, **params
+    args.map! {|h| h.transform_keys(&:to_s).compact }
+    params.transform_keys!(&:to_s).compact!
+    @tags.merge!(*args, params)
+    self
+  end
+  def [] key
+    key = key.to_s
+    @tags[key] ||= fetch(*key.split(/\s*=\s*|\s*,\s*/))
+  end
+  def fill *keys, safe: false
+    keys.map!(&:to_s)
+    keys.each do |k|
+      @tags[k].scan(FILL_SCAN).flatten.uniq.each do |tag|
+        @tags[k].gsub! /\{{2}\s{0,}#{tag.to_s}\s{0,}\}{2}/, self[tag].to_s
+      end
+    end
+    if safe
+      keys.each do |k|
+        @tags[k] = safe(k)
+      end
+    end
+    self
+  end
+  def safe key
+    self[key].to_s.downcase.gsub(/[^0-9a-z\.\-\/]+/, '-')
+  end
+  def fetch key, *params
+    case key
+    when 'safe'
+      safe(params.join(','))
+    when 'time'
+      Time.now.to_s
+    when 'date'
+      Time.now.strftime(FILE_DATE_FORMATE)
+    when 'random'
+      SecureRandom.hex(*params.map(&:to_i))
+    else
+      ''
+    end
+  end
+  def method_missing key
+    @tags[key.to_s]
+  end
+end

data/lib/jekyll_page_boilerplate/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module JekyllPageBoilerplate
-  VERSION = "4.3.0"
+  VERSION = "4.4.0"
 end

data/lib/jekyll_page_boilerplate.rb CHANGED Viewed

@@ -1,5 +1,6 @@
 require "jekyll_page_boilerplate/version"
 require "jekyll_page_boilerplate/msg"
+require "jekyll_page_boilerplate/tags"
 require "jekyll_page_boilerplate/page"
 require "jekyll_page_boilerplate/init"
 require "jekyll_page_boilerplate/list"

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-page-boilerplate
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Sean Ferney
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-14 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bales
@@ -45,13 +45,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.8.5
 description: |+
-  A boilerplate is a markdown file you place under the `_boilerplates/<boilerplate>.md` folder to generate new pages for jekyll.
+  A boilerplate is a markdown file you place under the `_boilerplates/` 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`.
+  It will also replacing any `{{ boilerplate.xxx }}` tags with content. Available tags include `.time, .title, .date, .random`.
   You can also provide custom tags with `boilerplate post nav_order=1` > `{{ boilerplate.nav_order }}`.
@@ -78,6 +78,7 @@ files:
 - lib/jekyll_page_boilerplate/msg/description.md
 - lib/jekyll_page_boilerplate/msg/gem_description.md
 - lib/jekyll_page_boilerplate/page.rb
+- lib/jekyll_page_boilerplate/tags.rb
 - lib/jekyll_page_boilerplate/version.rb
 - lib/jekyll_page_boilerplate_cli.rb
 homepage: https://github.com/CodeKarmaDev/jekyll-page-boilerplate