checkin_self 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0d80b523c7dac84fede03faeef63fdb0f4ca24c
-  data.tar.gz: 17d2088e0b041a272785dc9c8e9eb4d8cc0b0835
+  metadata.gz: 504f2a87604869c9fe43aa1e6f49ec9d524acc27
+  data.tar.gz: bc116d3bddb368498fe92f1d45e6d10931c58a3d
 SHA512:
-  metadata.gz: ae4c7837fc4a9bf2e40586024d8c856b0cb4914265e1a59dc839c0c0f718139a4eaf777fd11965996f1d200771a36041e765e75dd78b520c4b4c15a27062cf86
-  data.tar.gz: e1b82db2326b4d44a5224f600b5447d5b842a22ae4719f73625e69eb53a1160ba7fd736e555d19ac03489869570522abcbfeb9512a5434d62b1fe6d6ebc0dc1f
+  metadata.gz: 446e8ea3a238a2bd13ac45a9b16b47c23cd9860bd42e19dd7e1ab643eb9072de713a3fddf457f2613ccad0dbf88869d4fc9f773b49e69e80da035944f42d7b88
+  data.tar.gz: 043122836ec90702ed8e2a453c7a70f83adbab372df72b28f4693798b2f9786e459ecfdd8da25fdbcdffb5fcb0bdbb1cec4408aeda186842b1162749b42ecb77

data/README.md

@@ -6,11 +6,11 @@ Wording, advice, and structure for this mindfulness exercise were largely pulled
 
 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.
 
-This program has three optional arguments:
+This program has four optional arguments:
 
-- help, h, --help, or --h
+- hook, or --hook, with optional hook name as second argument
 
-  - Displays this help screen.
+  - 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.
 
 - log, or l, with optional integer
 
@@ -20,9 +20,9 @@ This program has three optional arguments:
 
   - Review your previous notes to self made through this program.
 
-- hook, or --hook, with optional hook name as second argument
+- help, h, --help, or --h
 
-  - 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.
+  - Displays help screen.
 
 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.
 
@@ -30,4 +30,5 @@ 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
+- improving object-oriented design
+- Use highline to improve the readability of the text in command-line

data/lib/checkin.rb

@@ -0,0 +1,190 @@
+class Checkin
+  def initialize
+    el = EmotionList.new()
+
+    @time = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+
+    observe_feeling
+    @emotional_state = describe_feeling(el)
+    @intensity = describe_feeling_instensity
+    if @intensity > 5 and @emotional_state[:emotion] != "joy"
+      @intervention = choose_intervention
+      @trigger = describe_trigger
+      case @intervention
+      when "change"
+        @note = change_self
+      when "accept"
+        @note = accept_self
+      when "let go"
+        @note = let_go_self
+      else
+        @note = nil
+      end
+    end
+    close_checkin
+  end
+
+  def observe_feeling
+    puts
+    puts "OBSERVE how you're feeling."
+    puts "No need to judge it, let's just pause and notice it."
+    pause_for(25)
+  end
+
+  def describe_feeling(el)
+    puts "DESCRIBE how you're feeling. Which of these emotions would you say it falls under?"
+    puts
+    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."
+    return categorize_feeling(STDIN.gets.chomp, el)
+  end
+
+  def describe_feeling_instensity
+    puts
+    puts "How strong is that feeling on a scale of 0 to 10?"
+    intensity = STDIN.gets.chomp.to_i
+    return 0 if intensity < 0
+    return 10 if intensity > 10
+    return intensity
+  end
+
+  # Give choice of possible interventions due to high negative emotions
+  def choose_intervention
+    puts
+    puts "Okay, let's take a couple of breaths, then let's talk about our options."
+    puts
+    breathing_exercise
+    puts
+    puts "Now, let's talk about your options for right now, before you start your work."
+    puts "-= You can CHANGE your situation, environment or reactions."
+    puts "-= You can ACCEPT that this is how you'll be feeling while you're working."
+    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."
+    return STDIN.gets.chomp.downcase
+  end
+
+  def describe_trigger
+    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."
+    return STDIN.gets.chomp
+  end
+
+  def change_self
+    puts "Think about your environment, your situation, or your reactions. You can change each of those, even in small ways."
+    puts
+    puts "Think for a minute about what you want to change, and what you'd need to make that change."
+    pause_for(25)
+    puts "You probably aren't going to make this change all at once right now. But let's jot down some next steps you want to take in the near future. We'll store those away for after you've finished your work."
+    puts
+    puts "When you're done listing things you want to do later, type 'done'."
+    tasks = get_tasks
+    puts
+    puts "Now before we move on, let's make a small change to your situation right now. Here are some ideas:"
+    puts "- Take a quick exercise break."
+    puts "- Go for a walk around the block."
+    puts "- Clean up a part of this room right now, or your desk."
+    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."
+    STDIN.gets.chomp
+    puts
+    return tasks
+  end
+
+  def accept_self
+    puts "Here are some things you might want to remind yourself about this trigger and your reaction to it:"
+    puts "- It is as it is."
+    puts "- I don’t have to agree with it or judge it as good or bad."
+    puts "- I can always come back to this feeling later."
+    puts "- I can keep my options open."
+    puts "- This is a normal body reaction."
+    puts "- I don’t have to fight it or try to stop it."
+    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."
+    return STDIN.gets.chomp
+  end
+
+  def let_go_self
+    puts "Think about this trigger and your emotions from it. Ask yourself:"
+    puts "- Is it worth it?"
+    puts "- Is this something I can leave or let go of and move on from this experience?"
+    puts "- Can I learn from this experience?"
+    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 = 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
+    return note_to_self
+  end
+
+  def close_checkin()
+    puts "Thanks for checking in with yourself!"
+    puts "If you want to see a log of your checkins, open this file again with the argument 'log'."
+    if @note != nil
+      puts "And to check the note you left yourself just now or in previous checkins, open this file with the argument 'pull'."
+    end
+  end
+
+  # Breathing exercise to be run if the intensity of negative emotions is greater than 5
+  def breathing_exercise
+    4.times do
+      4.times { |n| puts "BREATHE IN  " + (">" * (n+1)) + ("." * (3-n)); sleep 1 }
+      4.times { |n| puts "    HOLD    " + ("=" * 4); sleep 1 }
+      4.times { |n| puts "BREATHE OUT " + ("<" * (4 - n)) + ("." * n); sleep 1 }
+    end
+  end
+
+  # used to add some mindful wait time so user can observe emotions
+  def pause_for(seconds)
+    seconds.times { |s| print ((seconds - s).to_s + "... ") ; sleep 1 }
+    puts
+  end
+
+  # used to put the feeling that the user feels into terms readable for our databases
+  def categorize_feeling(feeling, emotion_list)
+    if feeling.downcase == "more"
+      puts
+      puts emotion_list
+      puts
+      puts "Pick a word from the list above that describes how you're feeling right now."
+      return categorize_feeling(STDIN.gets.chomp, emotion_list)
+    elsif emotion_list.list.keys.include?(feeling.downcase)
+      # emotion named by user, but not a secondary state
+      categorized = { emotion: feeling.downcase, state: nil }
+    else
+      matching_emotion = emotion_list.list.select {|emotion, states| states.include? feeling.downcase}
+      categorized = { emotion: matching_emotion.keys[0], state: feeling.downcase }
+    end
+    return categorized if defined? categorized
+    # User gave invalid input, run again
+    return categorize_feeling("more", emotion_list)
+  end
+
+  # Read in list of tasks that the user wants to remember for later.
+  def get_tasks
+    note_to_self = ""
+    task = STDIN.gets.chomp
+    until task.downcase == "done"
+      note_to_self += " o " + task + "\n"
+      task = STDIN.gets.chomp
+    end
+    return note_to_self.chomp
+  end
+
+  # Display checkin as a hash
+  def to_h
+    return {
+      time: @time,
+      emotion: @emotional_state[:emotion],
+      state: @emotional_state[:state],
+      intensity: @intensity ||= nil,
+      trigger: @trigger ||= nil,
+      note: @note ||= nil
+    }
+  end
+end

data/lib/checkins_db.rb

@@ -0,0 +1,173 @@
+class CheckinsDB
+  def initialize(db)
+    @db = db
+    @db.execute_batch(create_tables_cmd)
+    # Check if the emotions and states tables have been populated, and, if not, do so.
+    unless @db.execute("SELECT name FROM emotions;").any? { |row| row[0] == "joy" }
+      @db.execute_batch(populate_emotional_states_cmd)
+    end
+  end
+
+  def create_tables_cmd
+    # SQL command to make the tables if they don't exist.
+    return <<-SQL
+    CREATE TABLE IF NOT EXISTS emotions(
+      id INT PRIMARY KEY,
+      name VARCHAR(32)
+      );
+    CREATE TABLE IF NOT EXISTS states(
+      id INT PRIMARY KEY,
+      name VARCHAR(32),
+      emotionID INT,
+      FOREIGN KEY (emotionID) REFERENCES emotions(id)
+      );
+    CREATE TABLE IF NOT EXISTS checkins(
+      time VARCHAR(32) PRIMARY KEY,
+      emotionID INT,
+      stateID INT,
+      intensity INT,
+      trigger VARCHAR(255),
+      noteToSelf BLOB,
+      FOREIGN KEY (emotionID) REFERENCES emotions(id),
+      FOREIGN KEY (stateID) REFERENCES state(id)
+      );
+    SQL
+  end
+  def populate_emotional_states_cmd
+    return <<-SQL
+    INSERT OR IGNORE INTO emotions (id, name) VALUES (1, "anger");
+    INSERT OR IGNORE INTO emotions (id, name) VALUES (2, "joy");
+    INSERT OR IGNORE INTO emotions (id, name) VALUES (3, "sadness");
+    INSERT OR IGNORE INTO emotions (id, name) VALUES (4, "hurt");
+    INSERT OR IGNORE INTO emotions (id, name) VALUES (5, "fear");
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (1, "bothered", 1);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (2, "annoyed", 1);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (3, "bitter", 1);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (4, "angry", 1);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (5, "irritated", 1);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (6, "disgusted", 1);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (7, "frustrated", 1);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (8, "exasperated", 1);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (9, "furious", 1);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (10, "content", 2);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (11, "peaceful", 2);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (12, "relaxed", 2);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (13, "cheerful", 2);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (14, "satisfied", 2);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (15, "joyous", 2);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (16, "excited", 2);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (17, "ecstatic", 2);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (18, "happy", 2);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (19, "sad", 3);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (20, "depressed", 3);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (21, "distraught", 3);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (22, "despair", 3);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (23, "melancholy", 3);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (24, "grief", 3);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (25, "helpless", 3);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (26, "hopeless", 3);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (27, "miserable", 3);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (28, "lonely", 4);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (29, "homesick", 4);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (30, "abandoned", 4);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (31, "embarrassed", 4);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (32, "shame", 4);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (33, "guilt", 4);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (34, "foolish", 4);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (35, "humiliated", 4);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (36, "uncertain", 5);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (37, "worried", 5);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (38, "anxious", 5);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (39, "frightened", 5);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (40, "scared", 5);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (41, "nervous", 5);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (42, "afraid", 5);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (43, "terrified", 5);
+    INSERT OR IGNORE INTO states (id, name, emotionID) VALUES (44, "overwhelmed", 5);
+    SQL
+  end
+
+  # Add a checkin to the database
+  def add(checkin_entry)
+    # replace emotion name with matching id
+    emotion_id = lookup_emotion_id(checkin_entry[:emotion])
+    checkin_entry[:emotion] = emotion_id
+
+    # replace state name with matching id, if exists
+    if checkin_entry[:state]
+      state_id = lookup_state_id(checkin_entry[:state])
+      checkin_entry[:state] = state_id
+    end
+
+    # turn note to self into blob, if exists
+    if checkin_entry[:note]
+      checkin_entry[:note] = checkin_entry[:note].to_blob
+    end
+
+    @db.execute("INSERT INTO checkins (time, emotionID, stateID, intensity, trigger, noteToSelf) VALUES (?, ?, ?, ?, ?, ?)", checkin_entry[:time], checkin_entry[:emotion], checkin_entry[:state], checkin_entry[:intensity], checkin_entry[:trigger], checkin_entry[:note])
+  end
+
+  # look up the emotion ID in this DB for a given emotion name
+  def lookup_emotion_id(emotion)
+    emotion_id = @db.get_first_value("SELECT id FROM emotions WHERE name = ?", emotion)
+  end
+
+  # look up the state ID in this DB for a given state name
+  def lookup_state_id(state)
+    state_id = @db.get_first_value("SELECT id FROM states WHERE name = ?", state)
+  end
+
+  # generate SQL query that can pull the log, replace the ids from each table with the emotion/state names, etc
+  def log(limit)
+    qry_checkins_cmd = <<-SQL
+      SELECT time, emotions.name, states.name, intensity
+      FROM (checkins LEFT JOIN emotions ON checkins.emotionID = emotions.id) LEFT JOIN states
+      ON checkins.stateID = states.id;
+      SQL
+    rows = @db.execute(qry_checkins_cmd)
+
+    result = ""
+    # make header row
+    result += "Checkin time         | Emotion      | Emotional state  | Intensity \n"
+    result += "---------------------|--------------|------------------|-----------\n"
+    # initialize incrementer to test if going past limit
+    i = 1
+
+    # print that SQL query for each row, going back as long as incrementer is less than limit
+    rows.reverse_each do |row|
+      next if i > limit
+      # turn all null or nil values and all numbers into strings
+      row.map!(&:to_s)
+      result += row[0].ljust(21) + "| " + row[1].ljust(13) + "| " + row[2].ljust(17) + "| " + row[3].ljust(9) + "\n"
+      i += 1
+    end
+    return result
+  end
+
+  def review_notes
+    # generate SQL queries that pull the times and all from the noteToSelf attribute, numbered
+    pull_notes_cmd = <<-SQL
+      SELECT time, emotions.name, states.name, trigger, noteToSelf
+      FROM (checkins JOIN emotions ON checkins.emotionID = emotions.id) LEFT JOIN states
+      ON checkins.stateID = states.id;
+      SQL
+    entries = @db.execute(pull_notes_cmd)
+    result = ""
+
+    entries.each do |entry|
+      next unless entry[3] or entry[4]
+      result += "Date and time: " + entry[0] + "\n"
+      result += "Emotional state: " + entry[1]
+      result += ", " + entry[2] if entry[2] # checking if state is nil
+      result += "\n"
+      result += "Trigger: " + entry[3] + "\n" if entry[3]
+      result += "\n"
+      result += "Note to self: \n\n" + entry[4] + "\n" if entry[4]
+      result += "\n"
+      result += " -=- -=- -=- -=- -=- -=- -=- -=- \n"
+      result += "\n"
+    end
+    return result
+  end
+
+end

data/lib/githooker.rb

@@ -0,0 +1,48 @@
+module Githooker
+  def self.hook(hook_name, file_contents)
+    git_dir = self.find_git_dir
+    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_name
+      puts "Please provide an acceptable hook name. Acceptable hooks are as follows:"
+      acceptable_hooks.each {|hook| puts "  - '" + hook + "'"}
+      puts "Refer to git docs for more information."
+      exit(1)
+    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_name)
+      unless File.exist? hook_full_path
+        hook_file = File.open(hook_full_path, "w") do |file|
+          file_contents.each_line { |line| file.puts line }
+        end
+        system("chmod +x #{hook_full_path}")
+        puts "Added githook on hook #{hook_name}, located in hooks folder #{hooks_dir}"
+      else
+        puts "Githook for this action (#{hook_name}) already exists. This script is unable to manage duplicate executables for the same githook. Exiting..."
+        exit(1)
+      end
+    else
+      puts "No git repository found... exiting... "
+      exit(1)
+    end
+  end
+
+  def self.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) { self.find_git_dir }
+      else
+        return false
+      end
+    end
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: checkin_self
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Simon Swartzman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A tool to integrate mindful checkins into your git workflow
@@ -31,10 +31,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
-- bin/checkin_self
 - lib/checkin_self.rb
 - lib/emotion_list.rb
+- lib/checkin.rb
+- lib/checkins_db.rb
+- lib/githooker.rb
+- README.md
+- bin/checkin_self
 homepage: https://github.com/rtzm/checkin-project
 licenses:
 - MIT
@@ -45,17 +48,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: checkin_self