til-rb 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40d7142e1a89db2641e1d6da0699c13ee4a4da511331c9822deaef61ca9d546b
+  data.tar.gz: 29eedc188aa255a16d0cb9734412594013b1b2a18ae2836c5194cc0a3ae827e5
+SHA512:
+  metadata.gz: d58c4a7620cfd20fc9901fa3bc10526662a6eea6c0393d58334976cf67a002a871bfad747c6b8ddd95190e824a9f98d2cd81548eebab2811cccefdda7a0d6aa6
+  data.tar.gz: c8f88bf4d8a0336efafcbcb4d0add65a8979845fbea4e34cca19e29a2563e06668335c94d22a3af1003f5eb35782db1329de158685a7518b84131276a0ea6486

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Pierre Jambet
+
+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,7 @@
+![Gem](https://img.shields.io/gem/v/til-rb)
+
+# til-rb
+
+A work-in-progress tool to maintain a TIL repo.
+
+Inspiration: https://github.com/jbranchaud/til

data/bin/til

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'til-rb'
+
+Til::Core.run

data/lib/til-rb.rb

@@ -0,0 +1,2 @@
+require 'til/core'
+require 'til/version'

data/lib/til/core.rb

@@ -0,0 +1,184 @@
+require 'octokit'
+require 'tempfile'
+
+module Til
+  class Core
+
+    def self.run
+      # Exit if `fzf` is not available
+      # Optionally print a spinner
+      # Grab the list of existing categories
+      # Feed them into fzf with a new entry to let the user type a category
+      # Grab the category from fzf
+      # Handle the case where it's a new category (as in, figure out the new place in the README)
+      # Open $VISUAL or $EDITOR with a tempfile
+      # Read the file content
+      # Update the README.md with a link to the new entry
+      # Create the new file
+      # Create a new commit
+      # Output a link to the file and the link to edit it
+      til = new
+      til.run
+    end
+
+    def initialize(kernel: Kernel, process: Process, env: ENV, github_client: nil, stderr: $stderr)
+      @kernel = kernel
+      @process = process
+      @env = env
+      @stderr = stderr
+      @github_client = github_client
+      @repo_name = 'pjambet/til'
+      @new_category = false
+    end
+
+    def run
+      catch(:exit) do
+        check_dependencies
+        check_environment_variables
+        existing_categories = fetch_existing_categories
+        selected_category = prompt_fzf(existing_categories)
+        prepopulate_tempfile(selected_category)
+        open_editor
+        til_content = read_file
+        commit_new_til(selected_category, til_content)
+      end
+    end
+
+    private
+
+    def check_dependencies
+      result = @kernel.system('which fzf', out: '/dev/null', err: '/dev/null')
+      unless result
+        raise "fzf is required, you can install it on macOS with 'brew install fzf'"
+      end
+    end
+
+    def check_environment_variables
+      if @env['GH_TOKEN'].nil? || @env['GH_TOKEN'] == ''
+        raise 'The GH_TOKEN (with the public_repo or repo scope) environment variable is required'
+      end
+
+      if (@env['VISUAL'].nil? || @env['VISUAL'] == '') && (@env['EDITOR'].nil? || @env['EDITOR'] == '')
+        raise 'The VISUAL or EDITOR environment variables are required'
+      end
+    end
+
+    def fetch_existing_categories
+      existing_categories = github_client.contents(@repo_name, path: '').filter do |c|
+        c['type'] == 'dir'
+      end
+
+      existing_category_names = existing_categories.map do |category|
+        category[:name]
+      end
+
+      existing_category_names << 'Something else?'
+    end
+
+    def github_client
+      @github_client ||= Octokit::Client.new(access_token: @env['GH_TOKEN'])
+    end
+
+    def prompt_fzf(categories)
+      reader1, writer1 = IO.pipe
+      reader2, writer2 = IO.pipe
+      fzf_pid = @process.spawn('fzf', { out: writer1, in: reader2 })
+      reader2.close
+      writer1.close
+      writer2.puts categories.join("\n")
+      writer2.close
+      Process.waitpid(fzf_pid)
+      selected = reader1.gets.chomp
+      reader1.close
+      if selected == 'Something else?'
+        @new_category = true
+      end
+      selected
+    rescue Errno::EPIPE => e
+      @stderr.puts "Pipe issue: #{e}"
+      throw :exit
+    end
+
+    def prepopulate_tempfile(selected_category, title = 'Title Placeholder')
+      @tempfile = Tempfile.new('til.md')
+      @tempfile.write("# #{title}")
+      @tempfile.write("\n" * 2)
+      @tempfile.write("What did you learn about #{selected_category} today")
+      @tempfile.close
+    end
+
+    def open_editor
+      editor = ENV['VISUAL'] || ENV['EDITOR']
+      system(*editor.split, @tempfile.path)
+    end
+
+    def read_file
+      content = File.read(@tempfile)
+      @tempfile.unlink
+      content
+    end
+
+    def commit_new_til(category, content)
+      commit_title = content.lines[0].chomp
+      if commit_title.start_with?('#')
+        commit_title = commit_title[1..].strip
+      end
+      today = Time.now.strftime '%Y-%m-%d'
+      name = commit_title.split.map(&:downcase).join('-')
+      filename = "#{today}_#{name}.md"
+
+      ref = github_client.ref @repo_name, 'heads/master'
+      commit = github_client.commit @repo_name, ref.object.sha
+      tree = github_client.tree @repo_name, commit.commit.tree.sha, recursive: true
+      readme = github_client.readme @repo_name
+      readme_content = Base64.decode64 readme.content
+
+      blob = github_client.create_blob @repo_name, content
+      blobs = tree.tree.filter { |object|
+        object[:type] == 'blob' && object[:path] != 'README.md'
+      }.map { |object|
+        object.to_h.slice(:path, :mode, :type, :sha)
+      }
+
+      updated_readme_content = update_readme_content(category, commit_title, filename, readme_content)
+      new_readme_blob = github_client.create_blob @repo_name, updated_readme_content
+      blobs << { path: 'README.md', mode: '100644', type: 'blob', sha: new_readme_blob }
+
+      blobs << { path: "#{category}/#{filename}", mode: '100644', type: 'blob', sha: blob }
+
+      tree = github_client.create_tree @repo_name, blobs
+      commit = github_client.create_commit @repo_name, commit_title, tree.sha, ref.object.sha
+      github_client.update_ref @repo_name, 'heads/master', commit.sha
+
+      puts "You can see your new TIL at : https://github.com/pjambet/til/blob/master/#{category}/#{filename}"
+      puts "You can edit your new TIL at : https://github.com/pjambet/til/edit/master/#{category}/#{filename}"
+    end
+
+    def update_readme_content(category, commit_title, filename, readme_content)
+      beginning = readme_content.index('### Categories') + '### Categories'.length
+      eend = readme_content.index('---', readme_content.index('---') + 1) - 1
+
+      # [["[Git](#git)", "Git", "git"], ["[Qux](#qux)", "Qux", "qux"]]
+      categories = readme_content[beginning..eend].scan(/(\[(\w+)\]\(#(\w+)\))/)
+
+      if @new_category
+      else
+        existing_cat = categories.find { |c| c[2] == category }
+
+        loc_in_page = readme_content.index("### #{existing_cat[1]}")
+        next_cat_location = readme_content.index('###', loc_in_page + 1)
+
+        new_line = "- [#{commit_title}](#{category}/#{filename})"
+        new_readme_content = ''
+        if next_cat_location
+          breakpoint = next_cat_location - 2
+          new_readme_content = readme_content[0..breakpoint] + new_line + readme_content[breakpoint..]
+        else
+          new_readme_content = readme_content + new_line + '\n'
+        end
+        new_readme_content
+      end
+    end
+
+  end
+end

data/lib/til/version.rb

@@ -0,0 +1,5 @@
+module Til
+
+  VERSION = '0.0.2'
+
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: til-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Pierre Jambet
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+description: til-rb helps you manage a repo of TILs similar to https://github.com/jbranchaud/til
+email: hello@pjam.me
+executables:
+- til
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/til
+- lib/til-rb.rb
+- lib/til/core.rb
+- lib/til/version.rb
+homepage: https://rubygems.org/gems/til-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A utility to manage a repo of TILs
+test_files: []