friends 0.35 → 0.36

data/lib/friends/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Friends
-  VERSION = "0.35".freeze
+  VERSION = "0.36".freeze
 end

data/test/commands/clean_spec.rb

@@ -3,7 +3,8 @@
 require "./test/helper"
 
 clean_describe "clean" do
-  subject { run_cmd("clean") }
+  subject { run_cmd("#{quiet} clean") }
+  let(:quiet) { nil }
   let(:content) { nil }
 
   it "outputs a message" do
@@ -29,6 +30,32 @@ clean_describe "clean" do
 
 ### Friends:
 
+### Locations:
+      FILE
+    end
+  end
+
+  describe "when file is missing some headers and sections are out of order" do
+    let(:content) do
+      <<-CONTENT
+### Friends:
+- Marie Curie
+
+### Activities:
+- 2016-01-01: Celebrated the new year with **Marie Curie**.
+      CONTENT
+    end
+
+    it "adds the missing file structure and reorders the sections" do
+      file_equals <<-FILE
+### Activities:
+- 2016-01-01: Celebrated the new year with **Marie Curie**.
+
+### Notes:
+
+### Friends:
+- Marie Curie
+
 ### Locations:
       FILE
     end
@@ -41,6 +68,66 @@ clean_describe "clean" do
       it "writes the file with contents sorted" do
         file_equals CONTENT
       end
+
+      describe "when the content includes friends and locations that have not yet been added" do
+        let(:content) do
+          <<-CONTENT
+### Activities:
+- 2017-01-01: Celebrated the new year in _Paris_ with **Marie Curie** and her husband **Pierre Curie**. **Marie Curie** loves _Paris_!
+
+### Notes:
+- 2017-01-01: I just learned that **Jacques Cousteau** is thinking about moving from _Gironde_ to _The Lost City of Atlantis_ (_Gironde_ did seem a bit too terrestrial for him).
+
+### Friends:
+- Grace Hopper [NYC]
+
+### Locations:
+- NYC
+          CONTENT
+        end
+
+        it "adds those friends and locations" do
+          file_equals <<-CONTENT
+### Activities:
+- 2017-01-01: Celebrated the new year in _Paris_ with **Marie Curie** and her husband **Pierre Curie**. **Marie Curie** loves _Paris_!
+
+### Notes:
+- 2017-01-01: I just learned that **Jacques Cousteau** is thinking about moving from _Gironde_ to _The Lost City of Atlantis_ (_Gironde_ did seem a bit too terrestrial for him).
+
+### Friends:
+- Grace Hopper [NYC]
+- Jacques Cousteau
+- Marie Curie
+- Pierre Curie
+
+### Locations:
+- Gironde
+- NYC
+- Paris
+- The Lost City of Atlantis
+          CONTENT
+        end
+
+        it "prints messages for both cleaning and adding friends/locations" do
+          stdout_only <<-OUTPUT
+Friend added: \"Marie Curie\"
+Friend added: \"Pierre Curie\"
+Location added: \"Paris\"
+Friend added: \"Jacques Cousteau\"
+Location added: \"Gironde\"
+Location added: \"The Lost City of Atlantis\"
+File cleaned: \"#{filename}\"
+          OUTPUT
+        end
+
+        describe "when output is quieted" do
+          let(:quiet) { "--quiet" }
+
+          it "prints no messages" do
+            stdout_only ""
+          end
+        end
+      end
     end
 
     describe "when a header is malformed" do

data/test/commands/edit_spec.rb

@@ -3,25 +3,133 @@
 require "./test/helper"
 
 clean_describe "edit" do
-  subject do
-    stdout, stderr, status = Open3.capture3(
-      "EDITOR=cat bundle exec bin/friends --colorless --filename #{filename} edit"
-    )
-    {
-      stdout: stdout,
-      stderr: stderr,
-      status: status.exitstatus
-    }
+  subject { run_cmd("#{quiet} edit", env_vars: "EDITOR=#{editor}") }
+
+  let(:content) { SCRAMBLED_CONTENT }
+  let(:editor) { "cat" }
+
+  # First we test some simple behavior using `cat` as our "editor."
+  describe "when output is quieted" do
+    let(:quiet) { "--quiet" }
+
+    it 'opens the file in the "editor"' do
+      stdout_only content
+    end
+
+    it "cleans the file" do
+      file_equals CONTENT # File is cleaned (no longer scrambled).
+    end
+  end
+
+  describe "when output is not quieted" do
+    let(:quiet) { nil }
+
+    # Since our "editor" is just `cat`, our STDOUT output will include both the opening
+    # message and the contents of the file.
+    it 'prints a message and opens the file in the "editor"' do
+      stdout_only "Opening \"#{filename}\" with \"#{editor}\""\
+                  "\n#{content}File cleaned: \"#{filename}\""
+    end
+
+    it "cleans the file" do
+      file_equals CONTENT # File is cleaned (no longer scrambled).
+    end
+  end
+
+  describe "when editor does not exit successfully" do
+    let(:editor) { "'exit 1 #'" }
+
+    describe "when output is quieted" do
+      let(:quiet) { "--quiet" }
+
+      it "prints nothing to STDOUT" do
+        stdout_only ""
+      end
+
+      it "does not clean the file" do
+        file_equals content
+      end
+    end
+
+    describe "when output is not quieted" do
+      let(:quiet) { nil }
+
+      it "prints a status message to STDOUT" do
+        stdout_only <<-OUTPUT
+Opening "#{filename}" with "exit 1 #"
+Not cleaning file: "#{filename}" ("exit 1 #" did not exit successfully)
+        OUTPUT
+      end
+
+      it "does not clean the file" do
+        file_equals content
+      end
+    end
   end
 
-  let(:content) { CONTENT }
+  # Now we test a more realistic scenario, in which the editor actually modifies the
+  # file. Instead of human interaction we use the `test/editor` file to serve as our
+  # editor; that script adds a new activity to the file with a friend name and location
+  # name that are not currently in the file. This tests the fact that `friends edit`
+  # should clean the `friends.md` file *after* the editor has closed successfully.
+  describe "when edit operation adds an event that includes a new friend or location" do
+    let(:editor) { "test/editor" }
+    let(:cleaned_edited_content) do
+      <<-EXPECTED_CONTENT
+### Activities:
+- 2015-11-01: **Grace Hopper** and I went to _Marie's Diner_. George had to cancel at the last minute. @food
+- 2015-01-04: Got lunch with **Grace Hopper** and **George Washington Carver**. @food
+- 2014-12-31: Celebrated the new year in _Paris_ with **Marie Curie**. @partying
+- 2014-12-15: I just had a possible **Bigfoot** sighting! I think I may have seen **Bigfoot** in the _Mysterious Mountains_.
+- 2014-11-15: Talked to **George Washington Carver** on the phone for an hour.
+
+### Notes:
+- 2017-03-12: **Marie Curie** completed her PhD in record time. @school
+- 2015-06-15: **Grace Hopper** found out she's getting a big Naval Academy building named after her. @navy
+- 2015-06-06: **Marie Curie** just got accepted into a PhD program in _Paris_. @school
+- 2015-01-04: **Grace Hopper** and **George Washington Carver** both won an award.
+
+### Friends:
+- Bigfoot
+- George Washington Carver
+- Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris] @navy @science
+- Marie Curie [Atlantis] @science
+
+### Locations:
+- Atlantis
+- Marie's Diner
+- Mysterious Mountains
+- Paris
+      EXPECTED_CONTENT
+    end
+
+    describe "when output is quieted" do
+      let(:quiet) { "--quiet" }
+
+      it "prints nothing to STDOUT" do
+        stdout_only ""
+      end
+
+      it "cleans the file after the editor has quit" do
+        file_equals cleaned_edited_content
+      end
+    end
+
+    describe "when output is not quieted" do
+      let(:quiet) { nil }
+
+      it "prints status messages to STDOUT" do
+        stdout_only <<-OUTPUT
+Opening "#{filename}" with "#{editor}"
+Friend added: "Bigfoot"
+Location added: "Mysterious Mountains"
+File cleaned: "#{filename}"
+        OUTPUT
+      end
 
-  it 'opens the file in the "editor"' do
-    # Because of the way that the edit command uses `Kernel.exec` to replace itself,
-    # our `Open3.capture3` call doesn't return STDOUT from before the `Kernel.exec`
-    # call, meaning we can't test output of the status message we print out, and
-    # our test here can check that STDOUT is equivalent to the `Kernel.exec` command's
-    # output, even though visually that's not what happens.
-    stdout_only content
+      it "cleans the file after the editor has quit" do
+        file_equals cleaned_edited_content
+      end
+    end
   end
 end

data/test/commands/rename/friend_spec.rb

@@ -48,6 +48,13 @@ clean_describe "rename friend" do
       FILE
     end
 
+    it "updates friend name in notes" do
+      line_changed(
+        "- 2015-01-04: **Grace Hopper** and **George Washington Carver** both won an award.",
+        "- 2015-01-04: **Grace Hopper** and **George Washington** both won an award."
+      )
+    end
+
     it "prints an output message" do
       stdout_only 'Name changed: "George Washington"'
     end

data/test/commands/rename/location_spec.rb

@@ -29,6 +29,14 @@ clean_describe "rename location" do
       )
     end
 
+    it "updates location name in notes" do
+      line_changed(
+        "- 2015-06-06: **Marie Curie** just got accepted into a PhD program in _Paris_. @school",
+        "- 2015-06-06: **Marie Curie** just got accepted into a PhD program in "\
+        "_Ville Lumière_. @school"
+      )
+    end
+
     it "updates location name for friends" do
       line_changed(
         "- Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace) [Paris] @navy @science",

data/test/commands/set/location_spec.rb

@@ -31,7 +31,7 @@ clean_describe "set location" do
       let(:friend_name) { "Marie" }
 
       it "prints correct output" do
-        stdout_only "Marie Curie's location set to: Paris"
+        stdout_only "Marie Curie's location set to: \"Paris\""
       end
 
       it "updates existing location" do
@@ -43,7 +43,7 @@ clean_describe "set location" do
       let(:friend_name) { "George" }
 
       it "prints correct output" do
-        stdout_only "George Washington Carver's location set to: Paris"
+        stdout_only "George Washington Carver's location set to: \"Paris\""
       end
 
       it "adds a location" do

data/test/editor

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# This is an example "editor" used to test the `friends edit` command.
+# It inserts a new activity into the second line of the file, allowing
+# us to test that friends and locations added in an `edit` command are
+# subsequently added during the `clean` stage after the editor closes.
+
+filename = ARGV[0]
+current_file_contents = File.read(filename).split("\n")
+File.open(filename, "w") do |file|
+  file.puts current_file_contents[0]
+  file.puts "- 2014-12-15: I just had a possible **Bigfoot** sighting! "\
+            "I think I may have seen **Bigfoot** in the _Mysterious Mountains_."
+  file.puts current_file_contents.drop(1)
+end

data/test/helper.rb

@@ -79,9 +79,9 @@ def filename; end
 
 def subject; end
 
-def run_cmd(command, **args)
+def run_cmd(command, env_vars: "", **args)
   stdout, stderr, status = Open3.capture3(
-    "bundle exec bin/friends --colorless --filename #{filename} #{command}",
+    "#{env_vars} bundle exec bin/friends --colorless --filename #{filename} #{command}",
     **args
   )
   {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.35'
+  version: '0.36'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-14 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -237,6 +237,7 @@ files:
 - test/commands/stats_spec.rb
 - test/commands/suggest_spec.rb
 - test/commands/update_spec.rb
+- test/editor
 - test/helper.rb
 - test/tmp/.keep
 homepage: https://github.com/JacobEvelyn/friends
@@ -290,6 +291,7 @@ test_files:
 - test/commands/stats_spec.rb
 - test/commands/suggest_spec.rb
 - test/commands/update_spec.rb
+- test/editor
 - test/helper.rb
 - test/tmp/.keep
 has_rdoc: