standup_md 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 41221176dbfd0d5ddc136c700dd2313e3fc618efae2d4b2409df1849192889b4
+  data.tar.gz: 37fb6ac0435984844f76b922b88628a06b4f56bf48052a0337248bb3505edb2d
+SHA512:
+  metadata.gz: cf13b24ef59d5a34723ec422ff37ebcbc465ab98e2ec31a86a6ab870c071ae229b86850851cbba69615f5be31c722edb87ee8bd072804febf0a3f1eeaada109e
+  data.tar.gz: f18d79f594db85ad16acdd11ded9412dfe4cbb4d65c8293a977f980fcb20c8e56f14e27a48e5c908daf15d781004a86cdf6bcbe48e469479c3def51ab17fed76

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install
+        bundle exec rake test

data/.gitignore

@@ -0,0 +1 @@
+standup_md-*.gem

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec
+
+gem "rake"
+gem 'test-unit'

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    standup_md (0.0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    power_assert (1.2.0)
+    rake (13.0.1)
+    test-unit (3.3.5)
+      power_assert
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  standup_md!
+  test-unit
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Evan Gray
+
+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,252 @@
+# [The Standup Doctor](https://evanthegrayt.github.io/standup_md/)
+> The cure for all your standup woes.
+
+A highly customizable and automated way to keep track of daily standups in
+markdown files.
+
+## Table of Contents
+- [About](#about)
+- [Installation](#Installation)
+  - [Via RubyGems](#via-rubygems)
+  - [Manual Installation](#manual-installation)
+- [Usage](#usage)
+  - [Example](#example)
+  - [Customization and Runtime Options](#customization-and-runtime-options)
+- [API](#api)
+  - [Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html)
+- [Reporting Bugs and Requesting Features](#reporting-bugs-and-requesting-features)
+- [Self-Promotion](#self-promotion)
+
+## About
+I've now been at two separate companies where we post our daily standups in a
+chat client, such as Slack, Mattermost, or Riot. Typing out my standup every day
+became tedious, as I'd have to look up what I did the day before, copy and paste
+yesterday's work into a new entry, and add today's tasks. This gem automates
+most of this process, along with providing means of opening the file in your
+editor, and displaying entries from the command line.
+
+I wasn't sure that others would find this useful, but then the pandemic
+happened, which I assume made doing standups via chat much more common.
+
+In a nutshell, calling `standup` from the command line will open a standup file
+for the current month in your preferred editor. If an entry for today is already
+present, no text will be generated. If an entry for today doesn't exist, one
+will be generated, and if a previous entry exists, it will be added to today's
+entry as what your previous day's work. See [example](#example). There's also an
+API if you'd like to use this in your own code somehow.
+
+This is a new project, and I have a lot of [updates
+planned](https://github.com/evanthegrayt/standup_md/issues), but I won't push
+to `master` unless all
+[tests](https://github.com/evanthegrayt/standup_md/blob/master/test/standup_md_test.rb)
+are passing and the gem is working as expected. The first official release will
+be once [this milestone](https://github.com/evanthegrayt/standup_md/milestone/1)
+is complete. Until then, consider this gem to be in alpha, and the version will
+remain `< 0.1.0`.
+
+## Installation
+### Via RubyGems
+*COMING SOON. For now, please use the [manual installation
+instructions](#manual-installation). The gem will be officially released once
+[this milestone](https://github.com/evanthegrayt/standup_md/milestone/1) is
+completed*.
+
+<!-- Just install the gem! -->
+
+<!-- ```sh -->
+<!-- gem install standup_md -->
+<!-- ``` -->
+<!-- If you don't have permission on your system to install ruby or gems, I recommend -->
+<!-- using [rvm](https://rvm.io/) or -->
+<!-- [rbenv](http://www.rubyinside.com/rbenv-a-simple-new-ruby-version-management-tool-5302.html), -->
+<!-- or you can try to use a manual method below. -->
+
+
+### Manual Installation
+From your terminal, clone the repository where you want it. From there, you have
+a couple of installation options.
+
+```sh
+git clone https://github.com/evanthegrayt/standup_md.git
+cd standup_md
+
+# Use rake to build and install the gem.
+rake install
+
+# OR manually link the executable somewhere. If you use this method, you cannot
+# move the repository after you link it!
+ln -s $PWD/bin/standup /usr/local/bin
+```
+
+## Usage
+Call the executable.
+
+```sh
+standup
+```
+
+This opens the current month's standup file. If an entry already exists for
+today, nothing is added. If no entry exists for today, the previous "Current" is
+placed in the "Previous" section of a new entry.  The format of this file is
+very important; do not change anything, except for adding entries for today.
+
+### Example
+For example, if the standup entry from yesterday reads as follows:
+
+```markdown
+# 2020-04-13
+## Previous
+- Did something else.
+## Current
+- Write new feature for `standup_md`
+- Fix bug in `standup_md`
+## Impediments
+- None
+```
+
+The following scaffolding will be added for current entry at the top of the
+file:
+```markdown
+# 2020-04-14
+## Previous
+- Write new feature for `standup_md`
+- Fix bug in `standup_md`
+## Current
+- <!-- ADD TODAY'S WORK HERE -->
+## Impediments
+- None
+```
+
+There are also flags that will print entries to the command line. There's a full
+list of features below, but as a quick example, you can copy today's entry to
+your clipboard without even opening your editor.
+
+```sh
+standup -c | pbcopy
+```
+
+## Customization and Runtime Options
+You can create a file in your home directory called `~/.standup_md.yml`.
+Settings located in this file will override default behavior. This file can also
+have settings overwritten at runtime by the use of options. You can view [my config
+file](https://github.com/evanthegrayt/dotfiles/blob/master/dotfiles/standup_md.yml)
+as an example. Any setting in this file can still be overridden at runtime by
+passing flags to the executable.
+
+You'll notice, a lot of settings don't have the ability to be changed at runtime
+when calling the executable. This is because the file structure is very
+important, and changing values that affect formatting will cause problems with
+the file parser. If you don't want to use a default, make the change in your
+config file before you start editing standups. There is an [open
+issue](https://github.com/evanthegrayt/standup_md/issues/16) for handling this
+for the user, but they're not available yet.
+
+There are no options to change the headers at runtime because it uses the
+headers to detect tasks from previous entries. If changed at runtime, this would
+cause errors. For this reason, if you don't like the default headers, change
+them in your configuration file after installation, and then try to not change
+them again.
+
+
+### Available Config File Keys and Defaults
+
+```yaml
+# Key:                 Default
+header_depth:          1
+header_date_format:    '%Y-%m-%d'
+sub_header_depth:      2
+current_header:        'Current'
+previous_header:       'Previous'
+impediments_header:    'Impediments'
+file_name_format:      '%Y_%m.md'
+bullet_character:      '-'        # (dash)
+directory:             '~/.cache/standup_md'
+editor:                # $VISUAL, $EDITOR or vim, in that order
+current_entry_tasks:
+  - "<!-- ADD TODAY'S WORK HERE -->"
+previous_entry_tasks:  # An array of the tasks from the previous entry
+impediments:
+  - 'None'
+notes:                 null # If not null, must be array
+sub_header_order:
+  - 'previous'
+  - 'current'
+  - 'impediments'
+  - 'notes'
+```
+
+### Executable Flags
+```
+The Standup Doctor
+        --current-entry-tasks=ARRAY  List of current entry's tasks
+        --previous-entry-tasks=ARRAY List of yesterday's tasks
+        --impediments=ARRAY          List of impediments for current entry
+        --notes=ARRAY                List of notes for current entry
+        --sub-header-order=ARRAY     The order of the sub-headers when writing the file
+        --[no-]append-previous       Append previous tasks? Default is true
+    -f, --file-name-format=STRING    Date-formattable string to use for standup file name
+    -e, --editor=EDITOR              Editor to use for opening standup files
+    -d, --directory=DIRECTORY        The directories where standup files are located
+        --[no-]write                 Write current entry if it doesn't exist. Default is true
+        --[no-]edit                  Open the file in the editor. Default is true
+    -j, --[no-]json                  Print output as formatted json. Default is false.
+    -v, --[no-]verbose               Verbose output. Default is false.
+    -c, --current                    Print current entry. Disables editing
+    -a, --all                        Print all previous entries. Disables editing
+```
+
+Any options not set in this file will retain their default values. Note that if
+you change `file_name_format`, and don't use a month or year, there will only
+ever be one standup file. This could cause issues long-term, as the files will
+get large over time and possibly cause performance issues.
+
+If you wanted to add some tasks at runtime, and without opening the file in an
+editor, you could use the following:
+
+```bash
+standup --no-edit --current-entry-tasks="Work on this thing","And another thing!"
+```
+
+## API
+Below are some quick examples, but the API is fully documented in the
+[documentation](https://evanthegrayt.github.io/standup_md/doc/index.html).
+
+This was mainly written as a command line utility, but I made the API available
+for scripting. There are attribute accessors for most of the settings in the
+[customization table](#customization-and-runtime-options) above. To view all
+available methods, read the comments in the [source](lib/standup_md.rb). A
+quick-and-dirty example of how to write a new entry via code could look like the
+following:
+
+```ruby
+require 'standup_md'
+
+standup = StandupMD.load(
+  current_header: 'Today',
+  current_entry_tasks: ['Thing to do today', 'Another thing to do today'],
+  impediments: ['Not enough time in the day']
+)
+
+standup.write
+```
+
+Entries are just hashes, so you can easily transform them to `json` objects.
+
+```ruby
+require 'standup_md'
+require 'json'
+
+standup = StandupMD.load
+standup_entries_as_json = standup.all_entries.to_json
+```
+
+## Reporting Bugs and Requesting Features
+If you have an idea or find a bug, please [create an
+issue](https://github.com/evanthegrayt/standup_md/issues/new). Just make sure the topic
+doesn't already exist. Better yet, you can always submit a Pull Request.
+
+## Self-Promotion
+I do these projects for fun, and I enjoy knowing that they're helpful to people.
+Consider starring [the repository](https://github.com/evanthegrayt/standup_md)
+if you like it! If you love it, follow me [on
+Github](https://github.com/evanthegrayt)!

data/Rakefile

@@ -0,0 +1,36 @@
+require_relative 'lib/standup_md'
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_files.include("README.md", "**/*.rb")
+end
+
+task :default => :test
+
+desc "Build the gem"
+task :build do
+  system('gem build standup_md.gemspec')
+end
+
+desc "Build and install the gem"
+task install: [:dependencies, :build] do
+  system("gem install standup_md-#{StandupMD::VERSION}.gem")
+end
+
+desc "Add dependencies"
+task :dependencies do
+  system("gem install bundler")
+  system("bundle install")
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  system('gem uninstall standup')
+end
+
+desc "Run test suite"
+task :test do
+  Dir.glob(File.join(__dir__, 'test', '**', '*_test.rb')).each { |f| ruby f }
+end

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-midnight

data/bin/standup

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/standup_md/cli'
+
+StandupMD::CLI.execute(ARGV)