checkin_self 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1beca821f97304a103ee2deb6df3758a5f846c7b
-  data.tar.gz: aa66eb98dce4cdca5d5192d75418c1db09c1257b
+  metadata.gz: 57dccfc36b1536412a5b8e4f7694418a553d1f67
+  data.tar.gz: '059a9efe90da3ee503de910bd826986742e9d699'
 SHA512:
-  metadata.gz: 46821a4b632de34fe5cd8c524e32895256b86b419c37138e70c4adde9251982af1e85db37ab82a14a4bc5cad0e90076ab5e1ad7da7b59421c8b0ce016a20ffa2
-  data.tar.gz: e223e828b5dab00b7aade3d63bee9e76839d1cdd11c14a5faff7f8312756416a2c0fdd3526323860eb5962c3d65677c9fee1e86ed441730a4dfe2f0588a63518
+  metadata.gz: 3e8624538fdb14137d3e931f676ff76d28b2219eecf17f6329092b8094101ba74bea7d70bd2b9ecdbae3cc32c868ac7294e0701be7c2e71ae512cb621a3a869c
+  data.tar.gz: 8d2c075f1492d482b65cf0bd3e5b9eb928e0fca6b89ecbb8404aad30ee7a3afb471c14cb2eb660a24ce99d5d39755eec3d8a224535e09ec6d1f2881f7c7f1d4c

data/README.md

@@ -1,6 +1,6 @@
 # checkin-project
 
-checkin - a tool to integrate mindful checkins into your git workflow
+checkin_self - a tool to integrate mindful checkins into your git workflow
 
 Wording, advice, and structure for this mindfulness exercise were largely pulled from 'SOS for Emotions' by the NYU Student Health Center, authored by Reji Mathew, PhD, NYU Counseling and Wellness Services, Dialectical Behavior Therapy Clinical Team (https://www.nyu.edu/content/dam/nyu/studentHealthServices/documents/PDFs/mental-health/CWS_SOS_for_Emotions_Booklet.pdf).
 
@@ -20,4 +20,14 @@ This program has three optional arguments:
 
   - Review your previous notes to self made through this program.
 
-If you've installed this as a gem, you should be able to run it just by typing `checkin' into bash, with optional arguments. However, this is my first attempt at making an executable gem, so there seem to be some issues. Such as an unalerted dependency on the ruby gem sqlite3.
+- hook, or --hook, with optional hook name as second argument
+
+  - Attaches this checkin to a githook in the current git repository, so that checkin_self is automatically called every time you run a specific git command for the current repository. Defaults to post-checkout hook if no argument given. See this page for further documentation on githooks: https://git-scm.com/docs/githooks.
+
+If you've installed this as a gem, you should be able to run it just by typing `checkin_self' into bash, with optional arguments.
+
+Future changes to be made:
+
+- Changing from a sqlite database to some flatter data storage?
+- making a gemfile to alert sqlite dependencies
+- making more object-oriented, and splitting into multiple files

data/lib/checkin_self.rb

@@ -138,7 +138,7 @@ def categorize_feeling(feeling)
     print_emotion_list
     puts
     puts "Pick a word from the list above that describes how you're feeling right now."
-    return categorize_feeling(gets.chomp)
+    return categorize_feeling(STDIN.gets.chomp)
   elsif EMOTION_LIST.keys.include?(feeling.downcase)
     # emotion named by user, but not a secondary state
     categorized = { emotion: feeling.downcase, state: nil }
@@ -154,10 +154,10 @@ end
 # Read in list of tasks that the user wants to remember for later.
 def get_tasks
   note_to_self = ""
-  task = gets.chomp
+  task = STDIN.gets.chomp
   until task.downcase == "done"
     note_to_self += " o " + task + "\n"
-    task = gets.chomp
+    task = STDIN.gets.chomp
   end
   return note_to_self.chomp
 end
@@ -170,7 +170,7 @@ def display_help
   puts
   puts "This program is designed to be used when you checkout a git branch, so that you can checkin with yourself before you start on some coding work. If you're feeling somewhat to very intense negative emotions, you're encouraged to address those before you start your work, and leave a note to yourself to be reviewed later."
   puts
-  puts "This program has three optional arguments:"
+  puts "This program has four optional arguments:"
   puts
   puts "help, h, --help, or --h"
   puts "Displays this help screen."
@@ -180,6 +180,9 @@ def display_help
   puts
   puts "pull, or p"
   puts "Review your previous notes to self made through this program."
+  puts
+  puts "hook, or --hook, with optional hook name"
+  puts "Attaches this checkin to a githook in the current git repository, so that checkin_self is automatically called every time you run a specific git command for the current repository. Defaults to post-checkout hook if no argument given. See this page for further documentation on githooks: https://git-scm.com/docs/githooks."
   exit
 end
 
@@ -237,6 +240,55 @@ def review_notes_to_self(db)
   exit
 end
 
+def githook(hook_name="post-checkout")
+  git_dir = find_git_dir
+  hook_filename = hook_name || "post-checkout"
+  acceptable_hooks = ["applypatch-msg","pre-applypatch","post-applypatch","pre-commit","prepare-commit-msg","commit-msg","post-commit","pre-rebase","post-checkout","post-merge","pre-push","pre-receive","update","post-receive","post-update","push-to-checkout","pre-auto-gc","post-rewrite","rebase"]
+  unless acceptable_hooks.include? hook_filename
+    puts "Please provide an acceptable hook name. Refer to this page for information:"
+    puts "https://git-scm.com/docs/githooks"
+    exit
+  end
+  if git_dir
+    # check if .git/hooks contains file matching current hook
+    hooks_dir = File.join(git_dir, "hooks")
+    hook_full_path = File.join(hooks_dir, hook_filename)
+    unless File.exist? hook_full_path
+      hook_file = File.open(hook_full_path, "w") do |file|
+        file.puts "#!/usr/bin/env ruby"
+        file.puts "require 'checkin_self'"
+      end
+      system("chmod +x #{hook_full_path}")
+      puts "Added githook on hook #{hook_filename}, located in hooks folder #{hooks_dir}"
+      exit
+    else
+      puts "Githook for this action (#{hook_filename}) already exists... exiting..."
+      puts "See this stackoverflow answer on attaching multiple scripts to same hook:\nhttp://stackoverflow.com/questions/30104343/multiple-git-hooks-for-the-same-trigger"
+      exit
+    end
+  else
+    puts "No git repository found... exiting... "
+    exit
+  end
+end
+
+def find_git_dir
+  # find .git directory
+  if File.exist? ".git"
+    return File.join(Dir.pwd,".git")
+  else
+    # find path to parent directory
+    index_of_parent_separator = Dir.pwd.rindex(File::SEPARATOR)
+    parent_dir_name = Dir.pwd[0...index_of_parent_separator]
+
+    if File.exist? parent_dir_name
+      Dir.chdir(parent_dir_name) { find_git_dir }
+    else
+      return false
+    end
+  end
+end
+
 # DRIVER CODE
 
 # parse arguments passed to program
@@ -253,6 +305,8 @@ if ARGV[0]
     end
   when "pull", "p"
     review_notes_to_self(db)
+  when "hook", "--hook"
+    githook(ARGV[1])
   end
 end
 
@@ -270,11 +324,11 @@ puts "anger -=- joy -=- sadness -=- hurt -=- fear"
 puts
 puts "Type 'more' for a list of more words to help you figure out what you're feeling and how we'll categorize it."
 
-emotional_state = categorize_feeling(gets.chomp)
+emotional_state = categorize_feeling(STDIN.gets.chomp)
 puts
 
 puts "How strong is that feeling on a scale of 0 to 10?"
-intensity = gets.chomp.to_i
+intensity = STDIN.gets.chomp.to_i
 intensity = 0 if intensity < 0
 intsensity = 10 if intensity > 10
 puts
@@ -291,10 +345,10 @@ if intensity > 5 and emotional_state[:emotion] != "joy"
   puts "-= Or you can choose to try and LET GO of this feeling before you start your work."
   puts
   puts "What do you want to do right now? Type 'change', 'accept' or 'let go', or anything else to skip this."
-  intervention = gets.chomp
+  intervention = STDIN.gets.chomp
   puts
   puts "Think for a minute about what prompted or triggered this feeling. Think for a minute. Type a quick note to yourself about it to remind you later if you'd like, or press enter when ready."
-  trigger_note = gets.chomp
+  trigger_note = STDIN.gets.chomp
   puts
   case intervention.downcase
   when "change"
@@ -316,7 +370,7 @@ if intensity > 5 and emotional_state[:emotion] != "joy"
     puts "- Grab a healthy snack, or drink a glass of water."
     puts
     puts "When you've done that, come back and hit 'enter' so we can start coding."
-    gets.chomp
+    STDIN.gets.chomp
     puts
   when "accept"
     puts "Here are some things you might want to remind yourself about this trigger and your reaction to it:"
@@ -329,7 +383,7 @@ if intensity > 5 and emotional_state[:emotion] != "joy"
     puts "- It is as it is, but it won't stay that way. It will pass."
     puts
     puts "Jot down a thought about what accepting this means to you, so you can remember this later."
-    note_to_self = gets.chomp
+    note_to_self = STDIN.gets.chomp
     puts
 
   when "let go"
@@ -340,7 +394,7 @@ if intensity > 5 and emotional_state[:emotion] != "joy"
     puts "- What would I want to do differently next time?"
     puts
     puts "Jot a note to yourself about this. Hit enter when done."
-    note_to_self = gets.chomp
+    note_to_self = STDIN.gets.chomp
     puts
     puts "Now that you've logged how you're feeling and what might have caused it, think about how you don't have to hold onto that trigger anymore if you don't want to."
     puts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: checkin_self
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Simon Swartzman