jmv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bf45f987619f45bdcc50440f4e044c7d57fa2661e923a15a4e0d8581ac388a9
+  data.tar.gz: 3052a76fa4a0861e966729ecf2c63b1e8f6d663e6280b7d62643939f275000c9
+SHA512:
+  metadata.gz: ed354bb8caa1a439bb59a0624b50eeecef4f5cc37e302851c31ba1038d220ca79dd8ec70dd51c7ab78ce1d55d3c367dc6268dbbdafee35b289f164e441a9bfc6
+  data.tar.gz: e51a567437aaf09eddeef2a2c590507da79b4abe331107d2d9eb26044cdebc6f9287345db27ba33a7a4050a8d100da705334262007e669651035198a36bda8a1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,102 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for
+everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity
+and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion,
+or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take
+appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for
+moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing
+the community in public spaces. Examples of representing our community include using an official e-mail address, posting
+via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible
+for enforcement at ashmaroli@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem
+in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation
+and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including
+unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding
+interactions in community spaces as well as external channels like social media. Violating these terms may lead to
+a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified
+period of time. No public or private interaction with the people involved, including unsolicited interaction with those
+enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate
+behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ashwin Maroli
+
+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,56 @@
+# JMV
+
+Jekyll Metadata file Viewer (JMV) is a simple tool to enable viewing contents of the `.jekyll-metadata` file generated
+by Jekyll when a site is built or served under _incremental_ mode.
+
+## Installation
+
+Add this line to your Jekyll site's Gemfile:
+
+```ruby
+gem 'jmv', '~> 0.1'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it directly via:
+
+    $ gem install jmv
+
+## Usage
+
+JMV installs as a command-line program that serves a local webpage generated and rendered using the contents of
+the metadata file, provided that a `.jekyll-metadata` file exists at the root of the given directory.
+
+1. `cd` into a Jekyll project directory containing the `.jekyll-metadata` file.
+
+2. Run `jmv` or `bundle exec jmv` if the gem is to be used via a `Gemfile`.
+
+The above two steps can be executed in a single step by utilizing the `--source` (or `-s`) option:
+
+    $ jmv --source path/to/dir
+
+Once the server is up and running, point your web browser to `http://localhost:3000` to view the metadata file contents.
+If you wish to use a different port for the server, you may do so by utilizing the `--port` (or `-p`) option before
+starting the server:
+
+    $ jmv --port 8080
+
+The server will then start mounted at `http://localhost:8080`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ashmaroli/jmv. This project is intended to be
+a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct](https://github.com/ashmaroli/jmv/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JMV project's codebases, issue trackers, chat rooms and mailing lists is expected to follow
+the [code of conduct](https://github.com/ashmaroli/jmv/blob/master/CODE_OF_CONDUCT.md).

data/exe/jmv

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/jmv'
+require 'optparse'
+
+options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner = <<~TEXT
+
+    Jekyll Metadata file Viewer (JMV) - v#{JMV::VERSION}
+    ------------------------------------------
+
+    Serves contents of the metadata file as a local webpage
+
+    Usage:
+      jmv [<options>]
+
+  TEXT
+
+  opts.on('-s', '--source DIR', 'Configure metadata file location. Default: current dir') do |source|
+    options[:source] = source
+  end
+
+  opts.on('-p', '--port PORT', 'Configure server port. Default: 3000') do |port|
+    options[:port] = port
+  end
+
+  opts.on('-h', '--help', 'Show this message') do |help|
+    puts opts
+    exit
+  end
+end
+
+begin
+  option_parser.parse!
+rescue OptionParser::InvalidOption => e
+  puts ''
+  puts "  Error! #{e}"
+  puts '  Please run `jmv --help` to view available options.'
+  exit
+end
+
+JMV.start(options)

data/jmv.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "lib/jmv/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jmv"
+  spec.version       = JMV::VERSION
+  spec.authors       = ["Ashwin Maroli"]
+  spec.email         = ["ashmaroli@gmail.com"]
+  spec.homepage      = "https://github.com/ashmaroli/jmv"
+
+  spec.summary       = "Simple tool to enable viewing contents of '.jekyll-metadata' file."
+  spec.description   = "Jekyll Metadata file Viewer (JMV) is a simple tool to enable viewing " \
+                       "contents of the '.jekyll-metadata' file generated by Jekyll."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| File.basename(f).start_with?(".") }
+  spec.bindir        = "exe"
+  spec.executables   = ["jmv"]
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "webrick", "~> 1.7"
+end

data/lib/jmv/template.html.liquid

@@ -0,0 +1,233 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>{{ app.name }}</title>
+    <style>
+      :root {
+        --dark-gray: #454545;
+        --gray: #757575;
+        --light-gray: #eeeeee;
+        --off-white: #fcfcfc;
+        --white: #ffffff;
+        --red: #b30404;
+        --light-red: #ecd7d7;
+        --pale-red: #fbf9f9;
+      }
+
+      * { box-sizing: border-box }
+      body {
+        margin: 0;
+        font-family: Roboto, sans-serif;
+        line-height: 1.25;
+        color: var(--red);
+        background: var(--pale-red);
+      }
+      header {
+        margin-bottom: 30px;
+        padding: 15px;
+        background: var(--off-white);
+        border-bottom: 1px solid var(--light-gray);
+      }
+      h2 {
+        margin: 0;
+        font-size: 1.125em;
+        color: var(--red);
+        text-align: center;
+      }
+      main {
+        height: calc(100vh - 195px);
+        overflow-y: auto;
+        overflow-x: hidden;
+
+      }
+      ul {
+        margin: 0;
+        padding-left: 0.5em ;
+        list-style: none;
+      }
+      footer {
+        margin-top: 30px;
+        padding: 15px;
+        color: var(--red);;
+        font-size: 0.8em;
+        text-align: center;
+        background: var(--off-white);
+        border-top: 1px solid var(--light-gray);
+      }
+      footer a { color: var(--red) }
+      .toggles {
+        margin-left: 30px;
+        position: fixed;
+      }
+      .toggle-btn {
+        margin: 8px 15px;
+        padding: 8px 15px;
+        font-size: 0.8em;
+        cursor: pointer;
+        border: 1px solid var(--light-red);
+        border-radius: 15px 5px;
+      }
+      #toggle-collapse:after { content: 'Collapse All' }
+      #toggle-collapse.collapsed:after { content: 'Expand All' }
+      #toggle-json:after { content: 'View JSON' }
+      #toggle-json.active:after { content: 'Hide JSON' }
+      .container {
+        max-width: 960px;
+        width: calc(100% - 400px);
+        margin: 0 auto;
+      }
+      .wrapper {
+        width: calc(100% - 30px);
+        height: calc(100vh - 200px);
+        overflow: auto;
+      }
+      .entry {
+        margin-bottom: 3px;
+        padding: 10px 15px;
+        background: var(--off-white);
+        transition: all 0.5s;
+      }
+      .entry, .entry.togglable.collapsed {
+        border: 1px solid var(--light-gray);
+      }
+      .entry.togglable {
+        background: var(--white);
+        border-color: var(--light-red);
+      }
+      .entry.togglable:hover .name { color: var(--red) }
+      .deps {
+        width: calc(100% - 25px);
+        padding-top: 2px;
+        color: var(--dark-gray);
+        overflow: hidden;
+      }
+      .deps li {
+        padding-left: 15px;
+        border-left: 1px dotted var(--light-red);
+      }
+      .chevron {
+        width: 25px;
+        max-height: 20px;
+        vertical-align: middle;
+        text-align: center;
+      }
+      .hidden { display: none }
+      .path { display: flex }
+      .name { width: calc(100% - 25px); color: var(--gray) }
+      .togglable .name { color: var(--red) }
+      .togglable { cursor: pointer }
+      .chevron:after { content: '\25B4'; font-size: 1.5em }
+      .collapsed .name, .json { color: var(--gray) }
+      .collapsed .deps { height: 0 }
+      .collapsed .chevron:after { content: '\25BD'; font-size: 1em }
+      .app-meta, .oss {
+        display: inline-block;
+        padding: 10px 15px;
+      }
+      .oss {
+        width: 58px;
+        border-left: 1px solid var(--light-red);
+      }
+
+      ::-webkit-scrollbar {
+        width: 15px;
+      }
+      ::-webkit-scrollbar-track {
+        background: #fbf9f9;
+        box-shadow: inset 0 0 8px #eac8c8;
+        border-radius: 8px;
+      }
+      ::-webkit-scrollbar-thumb {
+        background: #bb1b1b;
+        background-clip: content-box;
+        border: 3px solid transparent;
+        border-radius: 10px;
+      }
+    </style>
+  </head>
+  <body>
+    <header>
+      <h2>{{ data.path }}</h2>
+    </header>
+    <main>
+      <aside class="toggles">
+        <div id="toggle-collapse" class="toggle-btn"></div>
+        <div id="toggle-json" class="toggle-btn"></div>
+      </aside>
+      <div class="wrapper">
+      <div class="slabs container">
+        {%- for entry in data.data -%}
+          {% assign mtime = entry[1]['mtime'] -%}
+          {% assign deps = entry[1]['deps'] -%}
+          {%- if deps.size != 0 %}
+          <div class="entry togglable">
+            <div class="path" title="last modified at: {{ mtime }}; {{ deps.size }} dependencies">
+              <div class="name">{{ entry[0] }}</div>
+              <span class="chevron"></span>
+            </div>
+            <div class="deps">
+              <ul>
+              {%- for dependency in deps %}
+                <li>{{ dependency }}</li>
+              {%- endfor %}
+              </ul>
+            </div>
+          </div>
+          {%- else %}
+          <div class="entry">
+            <div class="path" title="last modified at: {{ mtime }}; no dependencies">
+              <div class="name">{{ entry[0] }}</div>
+            </div>
+          </div>
+          {%- endif -%}
+        {%- endfor %}
+      </div>
+      <div class="json container hidden">
+        <pre>{{ data.json }}</pre>
+      </div>
+      </div>
+    </main>
+    <footer>
+      <div class="footer-contents">
+        <div class="app-meta">
+          <div>{{ app.name }}</div>
+          <div>v{{ app.version }}</div>
+        </div>
+        <div class="oss">
+          <a href="https://github.com/ashmaroli/jmv" title="Source code at GitHub">
+            <svg viewBox="0 0 16 16">
+              <path fill="currentcolor" d="M7.999,0.431c-4.285,0-7.76,3.474-7.76,7.761 c0,3.428,2.223,6.337,5.307,7.363c0.388,0.071,0.53-0.168,0.53-0.374c0-0.184-0.007-0.672-0.01-1.32 c-2.159,0.469-2.614-1.04-2.614-1.04c-0.353-0.896-0.862-1.135-0.862-1.135c-0.705-0.481,0.053-0.472,0.053-0.472 c0.779,0.055,1.189,0.8,1.189,0.8c0.692,1.186,1.816,0.843,2.258,0.645c0.071-0.502,0.271-0.843,0.493-1.037 C4.86,11.425,3.049,10.76,3.049,7.786c0-0.847,0.302-1.54,0.799-2.082C3.768,5.507,3.501,4.718,3.924,3.65 c0,0,0.652-0.209,2.134,0.796C6.677,4.273,7.34,4.187,8,4.184c0.659,0.003,1.323,0.089,1.943,0.261 c1.482-1.004,2.132-0.796,2.132-0.796c0.423,1.068,0.157,1.857,0.077,2.054c0.497,0.542,0.798,1.235,0.798,2.082 c0,2.981-1.814,3.637-3.543,3.829c0.279,0.24,0.527,0.713,0.527,1.437c0,1.037-0.01,1.874-0.01,2.129 c0,0.208,0.14,0.449,0.534,0.373c3.081-1.028,5.302-3.935,5.302-7.362C15.76,3.906,12.285,0.431,7.999,0.431z"/>
+            </svg>
+          </a>
+        </div>
+      </div>
+    </footer>
+    <script>
+      const togglables = document.getElementsByClassName('togglable');
+      const toggleClassName = 'collapsed';
+      for (entry of togglables) {
+        entry.addEventListener('click', function() {
+          this.classList.toggle(toggleClassName);
+        });
+      }
+      document.getElementById('toggle-collapse').addEventListener(
+        'click', function() {
+          this.classList.toggle(toggleClassName);
+          if (this.classList.contains(toggleClassName)) {
+            for (entry of togglables) { entry.classList.add(toggleClassName); }
+          } else {
+            for (entry of togglables) { entry.classList.remove(toggleClassName); }
+          }
+        }
+      );
+      document.getElementById('toggle-json').addEventListener(
+        'click', function() {
+          this.classList.toggle('active');
+          document.getElementsByClassName('slabs')[0].classList.toggle('hidden');
+          document.getElementsByClassName('json')[0].classList.toggle('hidden');
+        }
+      );
+    </script>
+  </body>
+</html>

data/lib/jmv/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JMV
+  VERSION = "0.1.0"
+end

data/lib/jmv.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative 'jmv/version'
+
+require 'json'
+require 'liquid'
+require 'webrick'
+
+module JMV
+  class Servlet < WEBrick::HTTPServlet::AbstractServlet
+    TEMPLATE_PATH = File.join(__dir__, 'jmv', 'template.html.liquid').freeze
+    private_constant :TEMPLATE_PATH
+
+    def do_GET(_request, response)
+      metadata_file = @server.config[:ResourcePath]
+      metadata = read metadata_file
+
+      context = {
+        'app'  => {
+          'name'    => 'Jekyll Metadata file Viewer',
+          'version' => JMV::VERSION,
+        },
+        'data' => {
+          'path' => metadata_file,
+          'data' => metadata,
+          'json' => JSON.pretty_generate(metadata),
+        }
+      }
+
+      # Repeat on every browser window refresh
+      template_contents = File.binread(TEMPLATE_PATH)
+      rendered_contents = Liquid::Template.parse(template_contents).render(context)
+
+      response.status = 200
+      response['Content-Type'] = 'text/html'
+      response.body = rendered_contents
+    end
+
+    private
+
+    def read(file)
+      Marshal.load(File.binread(file))
+    rescue StandardError => e
+      puts "  Error loading #{file}: #{e}"
+      raise e
+    end
+  end
+
+  def self.start(options)
+    source = File.expand_path(options[:source] || '')
+    puts "\n         Source: #{source}"
+    metadata_file = File.join(source, '.jekyll-metadata') 
+
+    if File.exist?(metadata_file) && !File.directory?(metadata_file)
+      puts "  Metadata file: #{metadata_file}"
+      puts ''
+      puts '  Processing..'
+    else
+      puts "  Error: Could not find the '.jekyll-metadata' file at source. Aborting.."
+      puts '         Build or serve a Jekyll source either with `--incremental` CLI option or'
+      puts '         with `incremental: true` config setting to generate the metadata file.'
+      return
+    end
+
+    server = WEBrick::HTTPServer.new(
+      :Port         => options[:port] || 3000,
+      :Logger       => WEBrick::Log.new($stdout, WEBrick::Log::WARN),
+      :AccessLog    => [],
+      :ResourcePath => metadata_file
+    )
+    server.mount('/', Servlet)
+    trap('INT') do
+      puts '  Shutting down server..'
+      puts ''
+      server.shutdown
+    end
+    puts '  Starting server..'
+    puts "  Server mounted at http://localhost:#{server.config[:Port]}."
+    puts ''
+    server.start
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: jmv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashwin Maroli
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Jekyll Metadata file Viewer (JMV) is a simple tool to enable viewing
+  contents of the '.jekyll-metadata' file generated by Jekyll.
+email:
+- ashmaroli@gmail.com
+executables:
+- jmv
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- exe/jmv
+- jmv.gemspec
+- lib/jmv.rb
+- lib/jmv/template.html.liquid
+- lib/jmv/version.rb
+homepage: https://github.com/ashmaroli/jmv
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Simple tool to enable viewing contents of '.jekyll-metadata' file.
+test_files: []