til-rb 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c97869d1c32d177ee5086d135865e9d21145e754d09a3542dbeb0558d10121ba
-  data.tar.gz: 100e0765c9ad27450614b785d2099794ee674425c2e35b6128b9bffaf9873836
+  metadata.gz: 929173ad31be6464b75779784d2c1bb1d37f04d548b1869783e156bc1a13cb11
+  data.tar.gz: 351871aa23247e031ab56b163a3e3684b8cc995d8fe0dc65b6c529b851c51332
 SHA512:
-  metadata.gz: bb6b75930c31b17a85a18229561e96cd4843c65f03cf8a2f9e43a7d0566d512cd50965ce86806091ceda929774aa9c7b6dc3576dec1c7be293a15c45f9af264b
-  data.tar.gz: 987ddd76bf8394424e404f776837301d70477907f8bdb4387bae61af2fcb00a3f15522b1629f14c81f6fac741a81f1f2d2a92a358518e4127a9f79741c01335e
+  metadata.gz: ce2a20ab053f5e3ed0f8bb68cd085beb60e87a5f45c39e9af95626714eb309275f6464b9d5690ad6b7eedf34b6d476999b890ac16e72db8b1fc2dc0a838eedb8
+  data.tar.gz: c418c12ae3bf2ee02255350c330b6271a07d0bcd053ea2b45acf762b852e5e0eb04daf4676bbec9980bfe803f2e6b83c598bd39e51075527fbf8233b9f2f4087

data/README.md

@@ -18,6 +18,16 @@ See it in action below:
 gem install til-rb
 ```
 
+You will also need `fzf` to run `til`, it's available on homebrew, so unless you already installed it, you'll have to run
+
+```
+brew install fzf
+```
+
+_fzf is technically not a hard requirement, we really could have a slightly different workflow if it's not available.
+Given that I currently am the only user, there's no need to change this at the moment, but if you'd like to use this
+gem without `fzf`, let me know and I'll happily work on it!_
+
 ### Step 2: Create a GitHub repo
 
 You need a GitHub repo to store your TILs. The gem has pretty strict expectations about the format of the README.md
@@ -43,6 +53,9 @@ Add the following variables to your environment:
 You might want to add those to either your `.bashrc` or `.zshrc` but please be careful in case you share those publicly
 as the token is private and *must not* be shared publicly.
 
+Note: An earlier version of this gem used different names, `GH_TOKEN` & `GH_REPO`, it still works, but is not the
+recommended approach anymore, see #2.
+
 ### Step 4:
 
 Run `til` from the command line

data/lib/til/core.rb

@@ -5,6 +5,9 @@ require 'readline'
 module Til
   class Core
 
+    GH_TOKEN_ENV_VAR_NAME = 'TIL_RB_GITHUB_TOKEN'
+    GH_REPO_ENV_VAR_NAME = 'TIL_RB_GITHUB_REPO'
+
     def self.run(options: {})
       # Exit if `fzf` is not available
       # Optionally print a spinner
@@ -59,12 +62,20 @@ module Til
     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'
+      if @env[GH_TOKEN_ENV_VAR_NAME].nil? || @env[GH_TOKEN_ENV_VAR_NAME] == ''
+        if @env['GH_TOKEN'].nil? || @env['GH_TOKEN'] == ''
+          raise "The #{GH_TOKEN_ENV_VAR_NAME} (with the public_repo or repo scope) environment variable is required"
+        else
+          @stderr.puts "Using GH_TOKEN is deprecated, use #{GH_TOKEN_ENV_VAR_NAME} instead"
+        end
       end
 
-      if @env['GH_REPO'].nil? || @env['GH_REPO'] == ''
-        raise 'The GH_REPO environment variable is required'
+      if @env[GH_REPO_ENV_VAR_NAME].nil? || @env[GH_REPO_ENV_VAR_NAME] == ''
+        if @env['GH_REPO'].nil? || @env['GH_REPO'] == ''
+          raise "The #{GH_REPO_ENV_VAR_NAME} environment variable is required"
+        else
+          @stderr.puts "Using GH_REPO is deprecated, use #{GH_REPO_ENV_VAR_NAME} instead"
+        end
       end
     end
 
@@ -81,11 +92,11 @@ module Til
     end
 
     def github_client
-      @github_client ||= Octokit::Client.new(access_token: @env['GH_TOKEN'])
+      @github_client ||= Octokit::Client.new(access_token: @env[GH_TOKEN_ENV_VAR_NAME] || @env['GH_TOKEN'])
     end
 
     def repo_name
-      @repo_name ||= @env['GH_REPO']
+      @repo_name ||= (@env[GH_REPO_ENV_VAR_NAME] || @env['GH_REPO'])
     end
 
     def prompt_fzf(categories)
@@ -131,14 +142,18 @@ module Til
       content
     end
 
+    def new_filename(commit_title)
+      today = Time.now.strftime '%Y-%m-%d'
+      name = CGI.escape(commit_title.split.map(&:downcase).join('-'))
+      "#{today}_#{name}.md"
+    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"
+      filename = new_filename(commit_title)
 
       ref = github_client.ref repo_name, 'heads/master'
       commit = github_client.commit repo_name, ref.object.sha

data/lib/til/version.rb

@@ -1,5 +1,5 @@
 module Til
 
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: til-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Pierre Jambet