jekyll_patternbot 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1531ec29e2d2f7efc94dc21297d9a628b3e8f15ac2c159c6d1ced92c28db603f
-  data.tar.gz: b8b2da871aea057cb4df68722c83cfdd9d04c0271f6dda90328fa213f263b997
+  metadata.gz: 884f2906dc4a4f8b9bb847ce46049501e583a5bca7e9c5b79b897c407a430b88
+  data.tar.gz: '0587e5339f5b5da4a73e3c6b509c3c60563ee21673ad656c74acc32da714537e'
 SHA512:
-  metadata.gz: b1325fc8376a2e779fd776e3d5bb928ab4ce95d0a0dc0bc5293a35b6fe9719481b86ceec6b98589efb83cbf2085555c57e525259261d31a53c007fd445bef364
-  data.tar.gz: 90f04b7f8dc5907b3978add05b5e52bff69edabda773b8dad4862736a028a15f3cb3d353b010841f5a0853edf0243a43935a7338e94c26fc10df6272d6d25bb8
+  metadata.gz: 0e1f3fbbfd9ed231b0453cfe81682c98e0c409671f03bf72b82dc56def73082a9339ee0e4157c97f5ea3016feaac56e91f9e38faefefa18bb8fc6d92b43aad92
+  data.tar.gz: 580a3bac4bd5d6634eddbf30815e7035c6e256f2efc82691fbd4b969c9e99b422e7eedb23d1cd9d8ad7640f121d98c964fc6899b728f194bb244c5739da87217

data/CHANGELOG.md

@@ -5,7 +5,24 @@ Jekyll Patternbot adheres to [Semantic Versioning](http://semver.org/).
 
 ---
 
-##[1.4.2] — 2019-02-11
+## [1.5.0] — 2020-01-04
+
+### Added
+
+- The Patternbot configuration options automatically reloaded when saved.
+- Show errors in the console when YAML cannot properly load.
+- Raise an exception when the `name` entry of a field is missing or blank.
+- Raise an exception when there’s a common syntax error in the font variables.
+- Allow code blocks within layout documentation.
+- Added the ability to describe includes within the `_config.yml` file.
+
+### Fixed
+
+- Absorb the error when the `fields` attribute in pattern configs isn’t an array.
+
+---
+
+## [1.4.2] — 2019-02-11
 
 ### Fixed
 

data/Gemfile

@@ -5,6 +5,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 ruby '2.5.3'
 
 gem 'jekyll', '~> 3.8'
+gem 'listen', '~> 3.0'
 gem 'unicode', '~> 0.4'
 gem 'colorator', '~> 1'
 gem 'babosa', '~> 1'

data/_layouts/patternbot_pattern_lib.html

@@ -167,6 +167,18 @@
               </a>
             </li>
           {% endunless %}
+          {% unless page._PatternbotData.includes == empty %}
+            <li role="presentation">
+              <a class="gutter pad-t-1-4 pad-b-1-4 block" role="tab" aria-controls="includes" href="#includes">
+                <div class="relative">
+                  <span>Includes</span>
+                  <i class="icon i-18 absolute pin-cr">
+                    <svg><use xlink:href="#icon-active"></use></svg>
+                  </i>
+                </div>
+              </a>
+            </li>
+          {% endunless %}
           {% unless page._PatternbotData.icons.spritesheets == empty %}
             <li role="presentation">
               <a class="gutter pad-t-1-4 pad-b-1-4 block" role="tab" aria-controls="icons" href="#icons">

data/_patterns/includes/config.yml

@@ -0,0 +1,11 @@
+_layout: "patternbot_pattern_internal"
+_extra_css:
+  - 'utilities/utilities.min.css'
+
+patterns:
+  includes:
+    title: "Includes"
+    description: "Below is a reference of all the includes available for pages within the website."
+    _popout_button: false
+    _resizable: false
+    _code: false

data/_patterns/includes/includes.html

@@ -0,0 +1,20 @@
+<div class="patternbot-font-primary text-left milli">
+  <div class="pattern-utilities-scrollable scrollable">
+    <table class="patternbot-utilities-table">
+      <thead>
+        <tr>
+          <th scope="col" colspan="6">Include</th>
+          <th scope="col" colspan="18">Description</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for include in page._PatternbotData.includes %}
+          <tr>
+            <th class="valign-middle" scope="row" colspan="6"><code class="ib valign-middle">{{include.name | escape}}</code></th>
+            <td class="valign-middle" scope="col" colspan="18"><span class="ib valign-middle">{{include.description | default: '—' | markdownify}}</span></td>
+          </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+  </div>
+</div>

data/_patterns/layouts/layouts.html

@@ -11,7 +11,7 @@
         {% for layout in page._PatternbotData.layouts %}
           <tr>
             <th class="valign-middle" scope="row" colspan="6"><code class="ib valign-middle">{{layout.name | escape}}</code></th>
-            <td class="valign-middle" scope="col" colspan="18"><span class="ib valign-middle">{{layout.description | default: '—' | escape}}</span></td>
+            <td class="valign-middle" scope="col" colspan="18"><span class="ib valign-middle">{{layout.description | default: '—' | markdownify}}</span></td>
           </tr>
         {% endfor %}
       </tbody>

data/_plugins/jekyll_patternbot.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'listen'
 require 'open-uri'
 require 'babosa'
 require 'deep_merge'
@@ -35,6 +36,7 @@ module JekyllPatternbot
   require 'jekyll_patternbot/finders/logos'
   require 'jekyll_patternbot/finders/icons'
   require 'jekyll_patternbot/finders/layouts'
+  require 'jekyll_patternbot/finders/includes'
   require 'jekyll_patternbot/finders/patterns'
   require 'jekyll_patternbot/finders/sample_pages'
 

data/_plugins/jekyll_patternbot/config.rb

@@ -1,5 +1,6 @@
 module JekyllPatternbot
   Config = YAML.load_file File.expand_path('../../_config.yml', __dir__)
+  ConfigListener = nil
   class << self; attr_accessor :PatternbotLogger; end
   class << self; attr_accessor :PatternbotCache; end
   class << self; attr_accessor :PatternbotLocale; end
@@ -23,5 +24,23 @@ module JekyllPatternbot
     else
       PatternbotLocale = YAML.load_file File.expand_path("../../_data/locales/en-ca.yml", __dir__)
     end
+
+    # Does this leave a running process when Jekyll shuts down?
+    ConfigListener = Listen.to(site.source, only: /\_config\.yml/) do |modified, added, removed|
+      begin
+        new_config = YAML.load_file File.expand_path(site.source + '/_config.yml')
+      rescue Exception => err
+        log = PatternbotConsoleLogger.new
+        log.fatal(err.message)
+      else
+        if new_config.key? 'patternbot'
+          Config['patternbot'].deep_merge! new_config['patternbot']
+          if site
+            site.process
+          end
+        end
+      end
+    end
+    ConfigListener.start
   end
 end

data/_plugins/jekyll_patternbot/finders/includes.rb

@@ -0,0 +1,32 @@
+module JekyllPatternbot
+  class IncludesFinder
+
+    def base
+      {
+        :name => false,
+        :description => false,
+      }
+    end
+
+    def info
+      includes_dir = File.expand_path Config['includes_dir']
+      includes = []
+      return includes unless File.directory? includes_dir
+      include_files = FileHelper.list_files_with_ext includes_dir, '*'
+      for include in include_files
+        include_data = base.clone
+        include_data[:name] = File.basename include, '.*'
+        unless Config['patternbot']['includes'].nil?
+          Config['patternbot']['includes'].each do |key, desc|
+            if key == include_data[:name]
+              include_data[:description] = desc.strip if desc
+            end
+          end
+        end
+        includes.push include_data
+      end
+      includes
+    end
+
+  end
+end

data/_plugins/jekyll_patternbot/finders/patterns.rb

@@ -13,7 +13,9 @@ module JekyllPatternbot
       return {} unless File.file? config_path
       begin
         config_data = YAML.load_file config_path
-      rescue
+      rescue Exception => err
+        log = PatternbotConsoleLogger.new
+        log.fatal(err.message)
         return {}
       end
       if config_data.nil? or config_data == false

data/_plugins/jekyll_patternbot/helpers/jekyll.rb

@@ -7,10 +7,12 @@ module JekyllPatternbot
 
     def self._pattern_assign_tags(fields)
       assign_tags = []
-      for field in fields
-        unless field['required'] == false
-          if field.key? 'data'
-            assign_tags.push "{% assign #{self._pattern_data_source_var_name(field)}=#{field['data']['source']} %}"
+      if fields.is_a? Array
+        for field in fields
+          unless field['required'] == false
+            if field.key? 'data'
+              assign_tags.push "{% assign #{self._pattern_data_source_var_name(field)}=#{field['data']['source']} %}"
+            end
           end
         end
       end
@@ -19,21 +21,29 @@ module JekyllPatternbot
 
     def self._pattern_include_fields(fields, datasource=false)
       liquid_fields = []
-      for field in fields
-        unless field['required'] == false
-          if field.key? 'data'
-            if datasource
-              liquid_fields.push "#{field['name']}=#{self._pattern_data_source_var_name(field)}"
-            else
-              liquid_fields.push "#{field['name']}=#{field['data']['type']}"
-            end
+      if fields.is_a? Array
+        for field in fields
+          if not field.key? 'name' or field['name'] == ''
+            err_msg = 'A pattern field, inside a pattern’s config.yml file, is missing a name.'
+            err_logger = PatternbotConsoleLogger.new
+            err_logger.fatal err_msg
+            raise err_msg
           end
-          if field.key? 'example'
-            quotes = ''
-            if field['example'].is_a? String
-              quotes = '"'
+          unless field['required'] == false
+            if field.key? 'data'
+              if datasource
+                liquid_fields.push "#{field['name']}=#{self._pattern_data_source_var_name(field)}"
+              else
+                liquid_fields.push "#{field['name']}=#{field['data']['type']}"
+              end
+            end
+            if field.key? 'example'
+              quotes = ''
+              if field['example'].is_a? String
+                quotes = '"'
+              end
+              liquid_fields.push "#{field['name']}=#{quotes}#{field['example']}#{quotes}"
             end
-            liquid_fields.push "#{field['name']}=#{quotes}#{field['example']}#{quotes}"
           end
         end
       end

data/_plugins/jekyll_patternbot/hooks/pattern_lib.rb

@@ -60,6 +60,9 @@ module JekyllPatternbot
     layouts = LayoutsFinder.new
     PatternbotData[:layouts] = layouts.info
 
+    includes = IncludesFinder.new
+    PatternbotData[:includes] = includes.info
+
     pattern_files = PatternsFinder.new
     PatternbotData[:patterns] = {
       :internal => pattern_files.internal_patterns_info,

data/_plugins/jekyll_patternbot/parsers/css_font.rb

@@ -84,6 +84,12 @@ module JekyllPatternbot
     end
 
     def self.parse_font(dec, val, available_weights)
+      if not val.is_a? String
+        err_msg = "There’s a syntax error in the #{dec.strip} declaration of the css/theme.css file."
+        err_logger = PatternbotConsoleLogger.new
+        err_logger.fatal err_msg
+        raise err_msg
+      end
       font_family = val.match(/[^\,\;]*/)[0].gsub(/['"]/, '')
       font_family_slug = font_family.force_encoding("utf-8").to_slug.normalize.to_s
       font = self.font.clone

data/jekyll_patternbot.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2'
 
   spec.add_runtime_dependency 'jekyll', '~> 3.8'
+  spec.add_runtime_dependency 'listen', '~> 3.0'
   spec.add_runtime_dependency 'unicode', '~> 0.4'
   spec.add_runtime_dependency 'colorator', '~> 1'
   spec.add_runtime_dependency 'babosa', '~> 1'

data/version.rb

@@ -1,3 +1,3 @@
 module JekyllPatternbot
-  VERSION = '1.4.2'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_patternbot
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Thomas J Bradley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2020-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: unicode
   requirement: !ruby/object:Gem::Requirement
@@ -194,6 +208,8 @@ files:
 - _patterns/icons/icon-sizes.html
 - _patterns/icons/icons-with-labels.html
 - _patterns/icons/icons.html
+- _patterns/includes/config.yml
+- _patterns/includes/includes.html
 - _patterns/layouts/config.yml
 - _patterns/layouts/layouts.html
 - _patterns/modules/config.yml
@@ -226,6 +242,7 @@ files:
 - _plugins/jekyll_patternbot/filters/text.rb
 - _plugins/jekyll_patternbot/finders/finder.rb
 - _plugins/jekyll_patternbot/finders/icons.rb
+- _plugins/jekyll_patternbot/finders/includes.rb
 - _plugins/jekyll_patternbot/finders/layouts.rb
 - _plugins/jekyll_patternbot/finders/logos.rb
 - _plugins/jekyll_patternbot/finders/patterns.rb
@@ -317,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Your pompous and persnickety patterning robot.