initial version

Author: vikdotdev

README.md

@@ -0,0 +1,18 @@
+# gh-note
+An opinionated way of working with gists for note-taking.
+
+## Things to do
+- Make folder for keeping local copies configurable.
+- Add `delete` command.
+- Add `status` command.
+- Add `--verbose` option to some commands.
+- Add `--all` option to `push`, `edit` and `view` commands. Paginate results.
+- Add automatic less paging support for `view` command.
+- Colorize `view` command file contents.
+- Clean up `main.rb` require code.
+
+## Notes
+This might be useful to fetch token from `gh`:
+```
+gh config get -h github.com oauth_token
+```

app/cli.rb

@@ -0,0 +1,34 @@
+class CLI < Thor
+  desc 'view', 'View selected gist'
+  def view
+    gists = Gist.all
+    gist = Search.new(gists).search
+    View.new(gist).render
+  end
+
+  desc 'create', 'Create an empty gist and open EDITOR. Then push on exit'
+  def create
+    gist = Gist.create!
+    Editor.new(gist).launch
+  end
+
+  desc 'edit', 'Edit selected gist locally'
+  def edit
+    gists = Gist.all
+    gist = Search.new(gists).search
+    Editor.new(gist).launch
+  end
+
+  desc 'sync', 'Clone & pull remote gists'
+  def sync
+    gists = Gist.all
+    Sync.new(gists).fetch!
+  end
+
+  desc 'push', 'Push local changes'
+  def push
+    gists = Gist.all
+    gist = Search.new(gists).search
+    gist.push!
+  end
+end

app/config.rb

@@ -0,0 +1,5 @@
+class Config
+  def self.path
+    File.join(Dir.home, 'gists')
+  end
+end

app/editor.rb

@@ -0,0 +1,20 @@
+class Editor
+  EDITOR = ENV['EDITOR']
+
+  attr_reader :gist
+
+  def initialize(gist)
+    @gist = gist
+  end
+
+  def launch(push_after_exit: true)
+    system("cd #{cwd}; #{EDITOR} .")
+    gist.push! if push_after_exit
+  end
+
+  private
+
+  def cwd
+    File.join(Config.path, gist.id)
+  end
+end

app/gist.rb

@@ -0,0 +1,93 @@
+require 'git'
+require 'json'
+require 'active_support/all'
+require 'colorize'
+
+class Gist
+  def self.all
+    JSON.parse(`gh api https://api.github.com/gists`).map do |gist|
+      Gist.new(gist)
+    end
+  end
+
+  def self.create!
+    prompt = TTY::Prompt.new
+    body = prompt.collect do
+      key(:description).ask('Description:', required: true)
+
+      loop do
+        key(:files).values do
+          key(:name).ask('Filename:', required: true)
+        end
+
+        break if prompt.no?('Add another file?')
+      end
+    end
+
+    body[:files] = body[:files].inject({}) do |memo, file|
+      memo.merge!(file[:name] => {
+        content: '# This file was generated by gh-note extension.'
+      })
+      memo
+    end
+
+    json = `echo -e '#{body.to_json}' | gh api -X POST /gists --input -`
+    gist = Gist.new(JSON.parse(json))
+    gist.clone!
+    gist
+  rescue JSON::ParserError => e
+    puts e
+    puts json
+    puts 'Error creating a gist'
+    exit 1
+  rescue Interrupt
+    puts
+    exit 130
+  end
+
+  attr_reader :id, :pull_url, :push_url, :description
+
+  def initialize(api_json)
+    @id = api_json['id']
+    @push_url = api_json['git_push_url']
+    @pull_url = api_json['git_pull_url']
+    @description = api_json['description'].presence || api_json['files'].keys.join(' ')
+    @last_updated = DateTime.parse(api_json['updated_at'])
+  end
+
+  def clone!
+    puts "Cloning from #{pull_url} into #{Config.path}" if
+    Git.clone(pull_url, id, path: Config.path)
+  end
+
+  def pull!
+    puts "Pulling from #{pull_url} into #{Config.path}"
+
+    Git.open(File.join(Config.path, id)).pull
+  end
+
+  def push!
+    git = Git.open(File.join(Config.path, id))
+    if needs_commit?(git)
+      git.add(all: true)
+      output = git.commit('Revision done by gh-note extension.')
+      puts "Committing changes for #{id}." if output
+      puts output
+    end
+
+    puts "Pushing to #{push_url}"
+    git.push
+  end
+
+  def needs_commit?(git)
+    status = Git::Status.new(git)
+
+    ![status.untracked, status.changed].all?(&:blank?)
+  end
+
+  def to_s
+    days = (@last_updated...Date.current).count
+    last_updated_text = "Last updated #{days.zero? ? 'today' : "#{days} days ago"}."
+    "#{description} #{last_updated_text.light_black}"
+  end
+end

app/search.rb

@@ -0,0 +1,18 @@
+require 'tty-prompt'
+require_relative './config'
+
+class Search
+  attr_reader :prompt, :list
+
+  def initialize(list)
+    @list = list
+    @prompt = TTY::Prompt.new
+  end
+
+  def search(label = '')
+    prompt.select(label, list, filter: true, per_page: 20)
+  rescue Interrupt
+    puts
+    exit 130
+  end
+end

app/sync.rb

@@ -0,0 +1,45 @@
+require 'fileutils'
+require_relative 'gist'
+
+class Sync
+  attr_reader :gists
+
+  def initialize(gists)
+    @gists = gists
+  end
+
+  def fetch!
+    ensure_folder_exists
+
+    threads = []
+    gists.each do |gist|
+      threads << Thread.new do
+        gist.clone!
+      rescue Git::GitExecuteError
+        gist.pull!
+      end
+    end
+
+    threads.each(&:join)
+    puts 'Fetch and pull finished.'
+  end
+
+  # TODO: keep for that push --all option
+  # def push!
+  #   threads = []
+  #   gists.each do |gist|
+  #     threads << Thread.new do
+  #       gist.push!
+  #     rescue Git::GitExecuteError => e
+  #       puts e
+  #     end
+  #   end
+  #
+  #   threads.each(&:join)
+  #   puts 'Push finished.'
+  # end
+
+  def ensure_folder_exists
+    FileUtils.mkdir_p(Config.path)
+  end
+end

app/view.rb

@@ -0,0 +1,12 @@
+
+class View
+  attr_reader :gist
+
+  def initialize(gist)
+    @gist = gist
+  end
+
+  def render
+    system("gh gist view #{gist.id}")
+  end
+end

gh-note

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -e
+
+# Determine if an executable is in the PATH
+if ! type -p ruby >/dev/null; then
+  echo "Ruby not found on the system" >&2
+  exit 1
+fi
+
+# Always run ruby relative to this scripts directory
+parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
+cd "$parent_path"
+
+ruby ./main.rb "$@"

main.rb

@@ -0,0 +1,18 @@
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'json'
+  gem 'git'
+  gem 'tty-prompt'
+  gem 'thor'
+  gem 'activesupport'
+  gem 'colorize'
+end
+
+Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), './app')) + "/**/*.rb"].each do |file|
+  require file
+end
+
+CLI.start