wassup 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 941e170c1128cdd099c74de0c068bddabe50ef1921dedcd4f7c278cb6032bd94
-  data.tar.gz: b76965eec5063a77ec8d6bca7dee5081a7c380af28b95732298039d1958b5ab6
+  metadata.gz: fe6fcd8e497b99430a22d16872f83d9b8a08356436c95f222bb3c9bed1b86d47
+  data.tar.gz: db98e8f4af5997b228bd8f148b13fc0b09681dcfa5486ad8d37e8c21aae0dc7b
 SHA512:
-  metadata.gz: 8371c29c1c55e96837e07f2c904d27ac22ccec2f848ee2540f9caf0cf4c5d43a746fab12d23a742222dc56c49584eb5a2dead3599c6db86786ed5aa667446bee
-  data.tar.gz: 0ad9c8dade67a8a83236c01c1c252bffb96218175eae256268c366f5f7078efa4dbb0d2c1a82fbe0936cfc3a75a52d0aa362814ddb5d6b15b380b825b27e21d3
+  metadata.gz: 7623256788359eac541c314581b9b552257f58af44a36216df2922c80a411a9a0dd078e3ca3291b0b0943706689f06c49ec27898879bca2a2131857e960c8b21
+  data.tar.gz: 9b4a0cbb77b12eebb1e9a1392d4d0ac6fcc9796aac72c9632bab5d9217aba1d179847220348532106ae4175131207f3f1484041b7527db1cc5e7957f038d3b89

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [joshdholtz]

data/.gitignore

@@ -10,4 +10,8 @@
 # rspec failure tracking
 .rspec_status
 
+*.gem
+
+.DS_Store
+
 *.swp

data/README.md

@@ -1,8 +1,48 @@
-# Wassup
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/wassup`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+<h3 align="center">
+  <img height="200" alt="Wassup logo" src="https://user-images.githubusercontent.com/401294/145626927-7eb0fda5-c62a-47c8-9422-074b178fd8ef.png" />
+</h3>
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/fastlane/fastlane/blob/master/LICENSE)
+[![Gem](https://img.shields.io/gem/v/wassup.svg?style=flat)](https://rubygems.org/gems/wassup)
+
+**Wassup** is a scriptable terminal dashboard. Configure panes and content logic in a `Supfile` and then run `wassup`.
+
+<hr/>
+
+https://user-images.githubusercontent.com/401294/145632767-d75a8244-b68f-4838-8ff4-4017ba0c1ed2.mov
+
+## Example `Supfile`
+
+```rb
+require 'json'
+require 'rest-client'
+
+add_pane do |pane|
+  pane.height = 0.5
+  pane.width = 0.5
+  pane.top = 0
+  pane.left = 0
+
+  pane.highlight = true
+  pane.title = "Open PRs - fastlane/fastlane"
+
+  pane.interval = 60 * 5
+  pane.content do |builder|
+    resp = RestClient.get "https://api.github.com/repos/fastlane/fastlane/pulls"
+    json = JSON.parse(resp)
+    json.map do |pr|
+      display = "##{pr["number"]} #{pr["title"]}"
+
+      # First argument is displayed
+      # Second argument is passed to pane.selection
+      builder.add_row(display, pr["html_url"])
+    end
+  end
+  pane.selection do |url|
+    `open #{url}`
+  end
+end
+```
 
 ## Installation
 

data/bin/wassup

@@ -1,4 +1,11 @@
 #!/usr/bin/env ruby
 
 require 'wassup'
-Wassup::App.start(path: ARGV[0])
+
+path = ARGV[0] || 'Supfile'
+
+unless File.exists?(path)
+  raise "Missing file: #{path}"
+end
+
+Wassup::App.start(path: path)

data/docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

data/docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

data/docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

data/docs/blog/2021-12-09-welcome/index.md

@@ -0,0 +1,8 @@
+---
+slug: welcome
+title: Welcome
+authors: [joshdholtz]
+tags: [wassup, hello]
+---
+
+This is the first blog

data/docs/blog/authors.yml

@@ -0,0 +1,5 @@
+joshdholtz:
+  name: Josh Holtz
+  title: Maintainer of wassup
+  url: https://github.com/joshdholtz
+  image_url: https://github.com/joshdholtz.png

data/docs/docs/Supfile-basics/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Supfile - Basics",
+  "position": 2
+}

data/docs/docs/Supfile-basics/understanding-the-supfile.md

@@ -0,0 +1,50 @@
+---
+sidebar_position: 1
+---
+
+# Understanding the `Supfile`
+
+The `Supfile` is what **Wassup** uses to generate the dashboard.
+
+The dashboard is made up of **panes**. These **panes** are configured by the `Supfile`.
+
+```ruby title="Supfile"
+add_pane do |pane|
+  pane.height = 0.5
+  pane.width = 0.4
+  pane.top = 0
+  pane.left = 0
+
+  pane.title = "Current Time"
+
+  pane.highlight = false
+
+  pane.interval = 1
+  pane.content do |content|
+    date = `date`
+    content.add_row(date)
+  end
+end
+```
+
+## Properties
+
+### Positioning
+
+| Property | Type | Description |
+| --- | --- | --- |
+| height | Float | Height of the pane (value between 0 and 1) |
+| width | Float | Width of the pane (value between 0 and 1) |
+| top | Float | Top positioning of the pane (value between 0 and 1) |
+| left | Float | Left positioning of the pane (value between 0 and 1) |
+| title | String | Title to display in the top border of the pane |
+
+### Content
+
+| Property | Type | Description |
+| --- | --- | --- |
+| interval | Integer (or Float) | Interval (in seconds) on how often to refresh pane with the `content` block |
+| show_refresh | Boolean | Whether or not to show when a content refresh is happening |
+| highlight | Boolean | Whether or not to allow highlighting and selection of rows |
+| content | Block | A Ruby block for fetching and adding content to the pane |
+| selection | Block | A Ruby block for fetching and adding content to the pane |

data/docs/docs/intro.md

@@ -0,0 +1,54 @@
+---
+sidebar_position: 1
+---
+
+# Getting Started
+
+Get started by **installing the gem**.
+
+## Installing
+
+Install **Wassup** from RubyGems:
+
+```shell
+gem install wassup
+```
+
+Or in a `Gemfile`:
+
+```rb
+source "https://rubygems.org"
+
+gem "wassup"
+```
+
+## Create Your First `Supfile`
+
+Create a `Supfile` with the following contents:
+
+```ruby title="Supfile"
+add_pane do |pane|
+  pane.height = 0.5
+  pane.width = 0.4
+  pane.top = 0
+  pane.left = 0
+
+  pane.highlight = false
+  pane.title = "Current Time"
+
+  pane.interval = 1
+  pane.content do |content|
+    date = `date`
+
+    content.add_row(date)
+  end
+end
+```
+
+Run `wassup` (or `bundle exec wassup` if using a `Gemfile`) from your terminal in the same directory as your `Supfile`.
+
+### Screenshot
+
+You should see a pane in the top left corner that updates the time every second.
+
+![Tutorial intro starter screenshot](/img/tutorial-intro-starter-screenshot.png)

data/docs/docusaurus.config.js

@@ -0,0 +1,110 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+const lightCodeTheme = require('prism-react-renderer/themes/github');
+const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'Wassup',
+  tagline: 'Scriptable terminal dashboard',
+  url: 'https://wassup.tools',
+  baseUrl: '/',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+  favicon: 'img/favicon.ico',
+  organizationName: 'joshdholtz', // Usually your GitHub org/user name.
+  projectName: 'wassup', // Usually your repo name.
+
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          sidebarPath: require.resolve('./sidebars.js'),
+          // Please change this to your repo.
+          editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/',
+        },
+        blog: {
+          showReadingTime: true,
+          // Please change this to your repo.
+          editUrl:
+            'https://github.com/facebook/docusaurus/edit/main/website/blog/',
+        },
+        theme: {
+          customCss: require.resolve('./src/css/custom.css'),
+        },
+      }),
+    ],
+  ],
+
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      navbar: {
+        title: 'Wassup',
+        logo: {
+          alt: 'Wassup Logo',
+          src: 'img/logo.svg',
+        },
+        items: [
+          {
+            type: 'doc',
+            docId: 'intro',
+            position: 'left',
+            label: 'Tutorial',
+          },
+          {to: '/blog', label: 'Blog', position: 'left'},
+          {
+            href: 'https://github.com/joshdholtz/wassup',
+            label: 'GitHub',
+            position: 'right',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Docs',
+            items: [
+              {
+                label: 'Tutorial',
+                to: '/docs/intro',
+              },
+            ],
+          },
+          {
+            title: 'Community',
+            items: [
+              {
+                label: 'Twitter',
+                href: 'https://twitter.com/joshdholtz',
+              },
+            ],
+          },
+          {
+            title: 'More',
+            items: [
+              {
+                label: 'Blog',
+                to: '/blog',
+              },
+              {
+                label: 'GitHub',
+                href: 'https://github.com/joshdholtz/wassup',
+              },
+            ],
+          },
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} Josh Holtz. Built with Docusaurus.`,
+      },
+      prism: {
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
+      },
+    }),
+};
+
+module.exports = config;