mkmatter 3.0.26

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5820176bd7d2e83b046fea9d79bf535e7c8090a4
+  data.tar.gz: b4a73fb3ccea1a7569253138b407260e45a14dd5
+SHA512:
+  metadata.gz: 88a64684f76531d7c27c11f40222aa5d7e3a08f845ccf7d7261b3e874000c9d662f10f41d81b38da0018a55f31cc700103e72251a5caf4e273701bffff1afd2b
+  data.tar.gz: 9c1a898a666ab077ea9ffa6affb1442819ff31ae7faab37d7ea4edfa76b5849c3211d7373c20ff5529b4c1c300d7c699c1f3abff3c437b07267966bcfb94eb57

data/.github/issue_template.md

@@ -0,0 +1,7 @@
+## Debug Table
+
+<!-- Run mkmatter --debug  and paste it in between the <pre> tags-->
+
+<pre>
+
+</pre>

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/.vscode/
+/vendor/
+Gemfile.lock
+*.gem
+pkg/

data/.gitlab-ci.yml

@@ -0,0 +1,24 @@
+image: ruby:2.3
+
+cache:
+  paths:
+  - vendor/
+
+before_script:
+  - export LC_ALL="C.UTF-8"
+  - export LANG="en_US.UTF-8"
+  - export LANGUAGE="en_US.UTF-8"
+
+build:
+  stage: build
+  script:
+  - bundle install --path vendor/bundle
+  only:
+  - master
+  - tags
+
+test:
+  stage: test
+  script:
+  - bundle install --path vendor/bundle
+  - rake spec

data/.travis.yml

@@ -0,0 +1,8 @@
+
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+script:

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mkmatter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Ken Spencer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ken Spencer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# mkmatter
+
+###### Builds & Links
+[![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)
+
+[![Gem](https://img.shields.io/gem/v/mkmatter.svg?style=for-the-badge)](https://rubygems.org/gems/mkmatter)
+[![GitHub tag](https://img.shields.io/github/tag/IotaSpencer/mkmatter.svg?style=for-the-badge)](https://github.com/IotaSpencer/mkmatter/tree/v3.0.1)
+
+[![Gem](https://img.shields.io/gem/dt/mkmatter.svg?style=for-the-badge)](https://rubygems.org/gems/mkmatter)
+[![Gem](https://img.shields.io/gem/dtv/mkmatter.svg?style=for-the-badge)](https://rubygems.org/gems/mkmatter)
+[![Gem](https://img.shields.io/gem/dv/mkmatter/3.0.25.svg?style=for-the-badge)](https://github.com/IotaSpencer/mkmatter/tree/v3.0.1)
+
+###### Badges
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
+[![forthebadge](https://forthebadge.com/images/badges/uses-badges.svg)](https://forthebadge.com)
+[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)
+[![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://forthebadge.com)
+
+
+
+## Contact
+
+[![E-mail](https://img.shields.io/badge/Email-Me-green.svg?style=for-the-badge)](mailto:me@iotaspencer.me)
+[![Website](https://img.shields.io/website-up-down-green-red/https/iotaspencer.me.svg?label=My%20Site%20-%20IotaSpencer%2Eme&style=for-the-badge)](https://iotaspencer.me)
+[![E-mail](https://img.shields.io/badge/mkmatter%20on%20IotaSpencer%2eme-Project-green.svg?style=for-the-badge)](https://iotaspencer.me/projects/mkmatter)
+[![Twitter Follow](https://img.shields.io/twitter/follow/IotaEcode.svg?label=Follow%20Me%20on%20Twitter&style=for-the-badge)](https://twitter.com/IotaEcode)
+
+## About mkmatter
+
+'mkmatter' is a gem designed to make it easy to generate front matter for files and also subsequently edit them.
+
+**Note**: Just like Jekyll there are minimal constraints on what is needed to build, but for `mkmatter` all I ask is that there is a `_config.yml` in your site source root, so the executable knows where it is in the filesystem.
+
+This is needed for any part that `reads from/writes to` the filesystem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mkmatter'
+```
+
+And then execute:
+
+    $ bundle install
+
+### Standalone
+
+To install to the system/user instead of a project, use the following
+
+#### System-wide
+As root or by using sudo, run:
+
+```$ gem install mkmatter```
+
+or
+
+```$ sudo gem install mkmatter```
+
+#### User
+
+```$ gem install --user-install mkmatter```
+
+## Usage
+
+### Using 'mkmatter'
+
+If you want to use 'mkmatter', an executable that ships with `mkmatter`, you gots to run it
+
+**Note**: Due to minimal constraints in Jekyll, I require at least an empty `_config.yml` file at the root of your source directory. 
+
+**P.S.**: **It does not have to have any directives, it can be an empty file.**
+
+#### Command 'new'
+
+ 1. 'new' is for generating front matter and content
+ 
+ 1. The current commands under 'new' are 'post' and 'page'
+ 
+Which will ask you questions about the content you want to put out. 
+* The script also will open an editor (the 'editor' command) if allowed to, as to allow the user to begin editing their file, front-matter already included.
+
+## Contributing
+
+* I am open to the idea of adding more questions/modules if there are plugins that require more configuration in the front matter. Just let me know!
+
+* [Bug Reports](https://github.com/IotaSpencer/mkmatter/issues)
+* [Pull Requests](https://github.com/IotaSpencer/mkmatter/pulls)
+
+<!--
+**Tutorial**: [mkmatter Tutorial on IotaSpencer.me](https://iotaspencer.me/2018-02-XX-mkmatter-tutorial)
+-->
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+
+desc 'Run tests'
+task :default => :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mkmatter'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+#require 'irb'
+#IRB.start(__FILE__)
+require 'pry'
+Pry.start

data/bin/mkmatter

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby
+require 'mkmatter'
+
+
+Signal.trap('INT') do
+  $stderr.puts
+  $stderr.puts 'Got INT.. Exiting'
+  exit 0
+end
+Mkmatter::App::Runner.new(ARGV.dup).execute!

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mkmatter/answers.rb

@@ -0,0 +1,79 @@
+require 'yaml'
+require 'active_support/all'
+require 'highline'
+module Mkmatter
+  class Answers
+    attr_accessor :title, :tags, :categories
+    attr_accessor :date, :layout, :draft
+    attr_accessor :slug_date, :answer_hash
+    attr_accessor :published, :file_format
+    attr_reader :matter
+    
+    def initialize(question_hash, publish)
+      
+      @layout      = question_hash[:layout]
+      @title       = question_hash[:title]
+      @tags        = question_hash[:tags]
+      @categories  = question_hash[:categories]
+      Time.zone    = question_hash[:time_zone]
+      now          = Time.zone.now
+      @date        = now.to_s
+      @slug_date   = now.strftime('%Y-%m-%d')
+      @published   = publish
+      @file_format = question_hash[:file_format]
+      @keywords = question_hash[:keywords]
+      @description = question_hash[:description]
+      @matter      = {
+          layout:     @layout,
+          title:      @title,
+          categories: @categories,
+          tags:       @tags,
+          date:       @date,
+      }
+      @matter[:published] = @published if publish
+    end
+    
+    # @return [Hash] returns attribute `.matter`
+    def to_h
+      @matter
+    end
+    
+    # @param [Hash] hash other hash
+    # @return [nil] merges hash into attribute `.matter`
+    def to_h=(hash)
+      @matter.merge!(hash)
+    end
+    
+    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
+    def dump
+      custom_fields = nil
+      hl            = HighLine.new($stdin, $stderr, 80)
+      # Custom matter
+      if hl.agree('Do you want to add custom fields? (usable as {{LAYOUT_TYPE.FIELD}} in templates) ', true)
+        hl.say('Your fields should be inputted as FIELD=>TEXT HERE')
+        hl.say("Enter 'EOL' on a new line and press enter when you are done.")
+        hl.say("<% HighLine.color('NOTE', :bold, :red) %>: Input is <% HighLine.color('NOT', :bold, :red) %> evaluated!")
+        custom_fields = hl.ask('Fields?') do |q|
+          q.gather = /^EOL$/
+        end
+      end
+      if custom_fields
+        fields = Hash.new
+        custom_fields.each do |field|
+          field = field.split(/=>/)
+          fields.store(field[0].to_s, field[1])
+        end
+        self.to_h = fields
+      elsif custom_fields.nil?
+        hl.say('No extra fields were added.')
+      else
+      end
+      self.to_h.stringify_keys.to_yaml(indentation: 2)
+      '---'
+    end
+  end
+end

data/lib/mkmatter/cli/app.rb

@@ -0,0 +1,102 @@
+require 'thor'
+require 'highline'
+require 'slugity/extend_string'
+require 'yaml'
+require 'active_support/all'
+require 'terminal-table'
+require 'os'
+require 'rbconfig'
+
+require 'mkmatter'
+require 'mkmatter/cli/subs'
+module Mkmatter
+  module App
+    class CLI < Thor
+      include Thor::Actions
+      HILINE = HighLine.new($stdin, $stderr, 80)
+      map %w[--version -v] => :__print_version
+      desc '--version, -v', 'Print the version'
+      
+      # Prints version string
+      def __print_version
+        puts Mkmatter::VERSION
+      end
+      
+      map %w[--debug -d] => :__debug
+      desc '--debug, -d', 'Prints debug info about the script/gem'
+      # Prints debug info
+      def __debug
+        info   = Mkmatter::GemInfo.new
+        report = YAML.safe_load(OS.report)
+        rows   = {
+            'mkmatter_version' => Mkmatter::VERSION,
+            'ruby_version' => RbConfig::CONFIG['RUBY_PROGRAM_VERSION'],
+        }
+        rows.merge! report
+        rows.merge!({
+                        'ruby_bin'      => OS.ruby_bin,
+                        'windows'       => OS.windows?,
+                        'posix'         => OS.posix?,
+                        'mac'           => OS.mac?,
+                        'under windows' => OS::Underlying.windows?,
+                        'under bsd'     => OS::Underlying.bsd?
+                    })
+        table                  = Terminal::Table.new
+        table.style.width      = 80
+        table.style.border_top = false
+        table.title            = 'mkmatter Debug Info'
+        table.rows             = rows.to_a
+        table.align_column(0, :left)
+        width = table.style.width - 2
+        print '+', '-' * width, '+'
+        puts
+        puts table
+        puts
+      end
+      
+      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'
+      def __print_info
+        format = options[:'info-format']
+        rows   = {
+            'Author(s)':        Mkmatter::GemInfo.authors,
+            'E-Mail':           Mkmatter::GemInfo.email,
+            'mkmatter-Version': Mkmatter::VERSION,
+            'RubyGems-Version': RbConfig::CONFIG['RUBY_PROGRAM_VERSION'],
+            'Platform':         RbConfig::CONFIG['build_os']
+        }
+        case format
+          when 'table'
+            table                  = Terminal::Table.new
+            table.style.width      = 60
+            table.style.border_top = false
+            table.style.alignment  = :center
+            table.title            = 'mkmatter Info'
+            table.rows             = rows.to_a
+            table.align_column(0, :left)
+            width = table.style.width - 2
+            print '+', '-' * width, '+'
+            puts
+            puts table
+            puts
+          when 'yaml'
+            puts rows.stringify_keys.to_yaml
+          
+          else
+            # noop
+            # this doesn't get run because of
+            # the logic of options and their
+            # enum parameter.
+        end
+      end
+      
+      desc 'new SUBCOMMAND [options]', 'Make new content'
+      subcommand 'new', Mkmatter::App::Classes::NewContent
+      desc 'tags SUBCOMMAND [options]', 'Generate or Create tags'
+      subcommand 'tags', Mkmatter::App::Classes::Tags
+    end
+      
+    
+  end
+end

data/lib/mkmatter/cli/descriptions.rb

@@ -0,0 +1,44 @@
+require 'highline'
+HighLine.colorize_strings
+
+module Mkmatter
+  module App
+    module Descriptions
+      module New
+        PAGE = <<-PAGEDOC
+        `mkmatter new page` will run you through making a jekyll page.
+
+        Given the above options/flags you can modify how the script
+
+        outputs your front matter, or whether to mark it as published.
+      
+        PAGEDOC
+        
+        POST = <<-POSTDOC
+          `mkmatter new post` will run you through making a jekyll post.
+
+          Given the above options/flags you can modify how the script
+
+          outputs your front matter, and whether to mark it as published,
+
+          or as a draft and move it into `_drafts`.
+
+          NOTES:
+
+
+            By default Jekyll will publish a post if `published` is omitted in
+
+            the front matter. So if you omit `--publish` you will publish,
+
+            so you have to explicitly use --no-publish to set `#{HighLine.color('published', :yellow)}: #{HighLine.color('false', :yellow, :bold)}`
+
+        POSTDOC
+      end
+      module Tags
+        GEN = <<-GENDOC
+        
+        GENDOC
+      end
+    end
+  end
+end

data/lib/mkmatter/cli/methods.rb

@@ -0,0 +1,82 @@
+require 'highline'
+require 'find'
+require 'yaml'
+module Mkmatter
+    class Methods
+      def Methods.check_if_jekyll
+        cwd = Pathname.new('.')
+        cwd.ascend do |path|
+          if path.join('_config.yml').exist?
+            break true
+          elsif cwd.to_s == '/'
+            # hit root, stop
+            break false
+          end
+        end
+      end
+      
+      def Methods.get_jekyll_root
+        if Methods.check_if_jekyll
+          cwd = Pathname.new('.').realdirpath
+          cwd.ascend do |path|
+            if path.join('_config.yml').exist?
+              return path
+            else
+              next
+            end
+          end
+        end
+      end
+      
+      def Methods.launch_editor(file_path)
+        hl = HighLine.new($stdin, $stderr, 80)
+        if file_path
+          if hl.agree("Would you like to open an editor? ('editor' command) ", true)
+            pid = spawn("editor #{file_path}")
+            Process.wait pid
+          end
+        end
+      end
+      
+      
+      def Methods.find_front_matter(type, key)
+        unless type =~ /^(post|page)$/
+          $stderr.puts "#{HighLine.color('Error', :red, :bold)}: Invalid Argument, allowed values: post, page"
+          exit 1
+        end
+        yaml_loader       = ->(string) {YAML.load(string)}
+        files             = {}
+        html_front_matter = []
+        md_front_matter   = []
+        front_matter      = {}
+        case type
+          when 'page'
+            Find.find(Methods.get_jekyll_root.to_s) do |path|
+              Find.prune if path =~ /(_includes|_layouts|_docs|_site)/ # don't include layouts, includes, site, docs
+              Find.prune if path =~ /(_posts)/ # don't include our own posts either
+              Find.prune if path =~ /(vendor\/bundle)/ # don't include vendor/
+              Find.prune if path =~ /(\/tag\/)/ # don't include our own tags
+              html_front_matter << path if path =~ /.*\.html$/
+              md_front_matter << path if path =~ /.*\.md$/
+            end
+          
+          when 'post'
+            Find.find(Pathname(Methods.get_jekyll_root).join('_posts').to_path) do |path|
+              html_front_matter << path if path =~ /.*\.html$/
+              md_front_matter << path if path =~ /.*\.md$/
+            end
+          else
+            # noop
+        end
+        files['html'] = html_front_matter
+        files['md']   = md_front_matter
+        files.each do |ftype, array|
+          array.each do |ele|
+            front_matter[ele] = YAML.load_file(ele)[key]
+          end
+        end
+        front_matter.select! {|k, v| !v.nil?}
+        front_matter
+      end
+    end
+  end

data/lib/mkmatter/cli/runner.rb

@@ -0,0 +1,51 @@
+require 'mkmatter/cli/app'
+
+module Mkmatter
+  module App
+    class Runner
+      # Allow everything fun to be injected from the outside while defaulting to normal implementations.
+      def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+        @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+      end
+      
+      def execute!
+        exit_code = begin
+                      # Thor accesses these streams directly rather than letting them be injected, so we replace them...
+          $stderr = @stderr
+          $stdin  = @stdin
+          $stdout = @stdout
+          
+          # Run our normal Thor app the way we know and love.
+          Mkmatter::App::CLI.start(@argv)
+          
+          # Thor::Base#start does not have a return value, assume success if no exception is raised.
+          0
+        rescue StandardError => e
+          # The ruby interpreter would pipe this to STDERR and exit 1 in the case of an unhandled exception
+          b = e.backtrace
+          @stderr.puts("#{b.shift}: #{e.message} (#{e.class})")
+          @stderr.puts(b.map {|s| "\tfrom #{s}"}.join("\n"))
+          1
+        rescue SystemExit => e
+          e.status
+        ensure
+          # TODO: reset your app here, free up resources, etc.
+          # Examples:
+          # MyApp.logger.flush
+          # MyApp.logger.close
+          # MyApp.logger = nil
+          #
+          # MyApp.reset_singleton_instance_variables
+          
+          # ...then we put the streams back.
+          $stderr = STDERR
+          $stdin  = STDIN
+          $stdout = STDOUT
+        end
+        
+        # Proxy our exit code back to the injected kernel.
+        @kernel.exit(exit_code)
+      end
+    end
+  end
+end