mkmatter 3.0.38 → 3.0.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b9161253762fa37d178f21532ffca2629ce787593699c64b3b8510ba70ac532
-  data.tar.gz: 5cff346aff68d29ccfc56cff3d625f084f68d85ffc343181cef4d50cf5c65eb5
+  metadata.gz: 04a7db220defedf2cda0b815eab8786071256a3859feabdfd2c6570c100099e8
+  data.tar.gz: 44ab5da9def6631721eece172f52ab35d34dc7d7c513db880fa5d732f897dc00
 SHA512:
-  metadata.gz: 69a679ba18bd92731bc71fd5508ceb32becbc6a502772b15a20fc502a7ff22d223ae5a8cc2e135daabb0e660778a6f8fad6ae34ca1acc3b2354fa637f068f286
-  data.tar.gz: 669452556c67aa36eede1d4f776405bbacd7e8c8cd3876e876d8cbd02e46ef86d8b89b13ecd0c6b252588eebdec79b3cd87c972bf8436b852446ae8e975f43cf
+  metadata.gz: b19c9bc10f1766db877545a4b4dd2348758a144617dd9315cf20c288575f02ecbc57aba22aa0a17c393ad7c5876b64fbd9c072fc1fb5cbadffe5ccb15211d5a9
+  data.tar.gz: 03e2aa2b92bf7a0e43c78221652b3bed32b63df0ab8e0da28e0266f654a735c0dcd4568f0511394dd2686fe29c0fa177fc36deed33223309e66dc6213544825e

data/.travis.yml

@@ -33,6 +33,11 @@ jobs:
     script:
     - echo "Running tests against $(ruby -v) ..."
     - bundle exec rake -t
+  - stage: test Ruby Head
+    rvm: ruby-head
+    script:
+    - echo "Running tests against $(ruby -v) ..."
+    - bundle exec rake -t
   - stage: gem release
     rvm: 2.3.0
     script: echo "Deploying to rubygems.org ..."

data/README.md

@@ -1,10 +1,17 @@
 # mkmatter
 
-###### Builds & Links
+ Builds & Links
+
+<div>
+
 [![Travis branch](https://img.shields.io/travis/IotaSpencer/mkmatter/dev.svg?style=for-the-badge)](https://travis-ci.org/IotaSpencer/mkmatter)
 [![Travis branch](https://img.shields.io/travis/IotaSpencer/mkmatter/master.svg?style=for-the-badge)](https://travis-ci.org/IotaSpencer/mkmatter)
+</div>
+<div class="m-0 p-0">
+
 [![Github commits (since latest release)](https://img.shields.io/github/commits-since/IotaSpencer/mkmatter/latest.svg?style=for-the-badge)]()
-[![GitHub commits](https://img.shields.io/github/commits-since/IotaSpencer/mkmatter/3.0.27.svg?style=for-the-badge)]()
+[![GitHub commits](https://img.shields.io/github/commits-since/IotaSpencer/mkmatter/3.0.38.svg?style=for-the-badge)]()
+</div>
 
 ###### Gem
 [![Gem](https://img.shields.io/gem/v/mkmatter.svg?style=for-the-badge)](https://rubygems.org/gems/mkmatter)

data/bin/mkmatter

@@ -1,7 +1,5 @@
 #!/usr/bin/ruby
 require 'mkmatter'
-
-
 Signal.trap('INT') do
   $stderr.puts
   $stderr.puts 'Got INT.. Exiting'

data/lib/mkmatter/answers.rb

@@ -47,8 +47,7 @@ module Mkmatter
     alias_method :inspect, :to_h
     #
     # Dumps all file applicable metadata to a provided output.
-    # @param [Boolean] to_file A path or filename
-    # @param [Boolean] stdout Whether to print to stdout
+    # @return [String] yaml front matter
     def dump
       custom_fields = nil
       hl            = HighLine.new($stdin, $stderr, 80)

data/lib/mkmatter/cli/app.rb

@@ -14,6 +14,8 @@ module Mkmatter
   module App
     class CLI < Thor
       include Thor::Actions
+      
+      # \(see {http://www.rubydoc.info/gems/highline/HighLine#initialize-instance_method HighLine#new}\)
       HILINE = HighLine.new($stdin, $stderr, 80)
       map %w[--version -v] => :__print_version
       desc '--version, -v', 'Print the version'
@@ -54,11 +56,12 @@ module Mkmatter
       map %w[--info -i] => :__print_info
       desc '--info, -i', 'Print script/gem info'
       method_option :'info-format', :type => :string, desc: 'The format of info', enum: %w(table yaml), default: 'table'
+      # @return nil
       def __print_info
         format = options[:'info-format']
         rows   = {
             'author(s)':        Mkmatter::GemInfo.authors.join(', '),
-            'e-mail':           Mkmatter::GemInfo.email,
+            'e-mail':           Mkmatter::GemInfo.email.join(', '),
             'mkmatter version': Mkmatter::VERSION,
             'Ruby version': RbConfig::CONFIG['RUBY_PROGRAM_VERSION'],
             'Platform':         RbConfig::CONFIG['build_os']

data/lib/mkmatter/cli/methods.rb

@@ -3,6 +3,7 @@ require 'find'
 require 'yaml'
 module Mkmatter
     class Methods
+      # @return [Boolean] whether current directory is inside a jekyll site source directory
       def Methods.check_if_jekyll
         cwd = Pathname.new('.')
         cwd.ascend do |path|
@@ -15,6 +16,7 @@ module Mkmatter
         end
       end
       
+      # @return [Pathname] path of current jekyll site source roo
       def Methods.get_jekyll_root
         if Methods.check_if_jekyll
           cwd = Pathname.new('.').realdirpath
@@ -28,6 +30,7 @@ module Mkmatter
         end
       end
       
+      # @return [NilClass] nil
       def Methods.launch_editor(file_path)
         hl = HighLine.new($stdin, $stderr, 80)
         if file_path
@@ -38,7 +41,9 @@ module Mkmatter
         end
       end
       
-      
+      # @param [String] type type of content
+      # @param [String] key root yaml directive to return
+      # @return [Hash] front matter
       def Methods.find_front_matter(type, key)
         unless type =~ /^(post|page)$/
           $stderr.puts "#{HighLine.color('Error', :red, :bold)}: Invalid Argument, allowed values: post, page"

data/lib/mkmatter/gem_info.rb

@@ -1,6 +1,8 @@
 require 'mkmatter/version'
 module Mkmatter
+  # Gem Name
   GEM_NAME = 'mkmatter'
+  # Gem Name Alias
   NAME     = GEM_NAME
   
   #
@@ -10,13 +12,16 @@ module Mkmatter
   #
   # Gem Summary
   SUMMARY = %q{Script facilitating easy content creation and generation for Jekyll Sites}
+  # Return gem information for certain commands and options
   class GemInfo
+    # @return [Array] list of authors
     def GemInfo.authors
       ['Ken Spencer']
     end
     
+    # @return [Array] authors emails
     def GemInfo.email
-      'me@iotaspencer.me'
+      ['me@iotaspencer.me']
     end
   end
 end

data/lib/mkmatter/version.rb

@@ -1,3 +1,3 @@
 module Mkmatter
-  VERSION = '3.0.38'
+  VERSION = '3.0.39'
 end

data/lib/mkmatter.rb

@@ -6,7 +6,7 @@ require 'mkmatter/version'
 
 require 'json'
 require 'yaml'
-
+# Main Module Declaration
 module Mkmatter
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mkmatter
 version: !ruby/object:Gem::Version
-  version: 3.0.38
+  version: 3.0.39
 platform: ruby
 authors:
 - Ken Spencer