friends 0.45 → 0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb0258b3dca86e0aba3b852b4d58462e2e3570f6
-  data.tar.gz: cbb2091ca9b77764999b5667b4a00c309ce1263d
+  metadata.gz: 6e2e73301c76c3d799abebb73a9e1f53a1233783
+  data.tar.gz: 929e11c8180395acf1338c316d3b0fd6f657ffd4
 SHA512:
-  metadata.gz: '052706180f25b59c73618c545e659becf4a1b9295ba3bb4e8478b7279a0c7460c5e974eafc8627c3f5745c5236ba37ff31648b4129b9a70780bc4d55f83cac96'
-  data.tar.gz: 4e0819d8bcab2152a883853e5b2b6899660faa8eca350dfa73085658ad1e5b4a2fe95be97d4006f8fd5d23d11865a25a7cae66b8c8a78184ddc6b0c9406bef50
+  metadata.gz: 3ad10cbe59e1932947ce389c9fdaa16cd08b326d4129486328746801207c8e51b45c4db7319a7ee59742e0555360b2789d9e6a19a3bdaeebc04da0f88ad3a868
+  data.tar.gz: 1ba1ab37eec7c942cb44db4285b822a5fa0083e1a564375b6eec6caa0c0ff921e7cfc355d9200a7f120f1a76f77a5d452492a78478e2b152e84dbcbafdbe36bc

data/CHANGELOG.md

@@ -14,6 +14,17 @@ making a small donation (🙏) to show you appreciate its continued development.
 
 👆 Donate with these buttons! 👆
 
+## [v0.46](https://github.com/JacobEvelyn/friends/tree/v0.46) (2019-01-27)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.45...v0.46)
+
+**Fixed bugs:**
+
+- Data overwritten when --filename is not specified [\#231](https://github.com/JacobEvelyn/friends/issues/231)
+
+**Merged pull requests:**
+
+- Fix file-reading issues with default file [\#232](https://github.com/JacobEvelyn/friends/pull/232) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [v0.45](https://github.com/JacobEvelyn/friends/tree/v0.45) (2019-01-15)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.44...v0.45)
 

data/lib/friends/introvert.rb

@@ -23,7 +23,8 @@ module Friends
 
     # @param filename [String] the name of the friends Markdown file
     def initialize(filename:)
-      @filename = filename
+      @user_facing_filename = filename
+      @expanded_filename = File.expand_path(filename)
       @output = []
 
       # Read in the input file. It's easier to do this now and optimize later
@@ -59,7 +60,7 @@ module Friends
         end
       end
 
-      File.open(File.expand_path(@filename), "w") do |file|
+      File.open(@expanded_filename, "w") do |file|
         file.puts(ACTIVITIES_HEADER)
         stable_sort(@activities).each { |act| file.puts(act.serialize) }
         file.puts # Blank line separating activities from notes.
@@ -75,7 +76,7 @@ module Friends
 
       # This is a special-case piece of code that lets us print a message that
       # includes the filename when `friends clean` is called.
-      @output << "File cleaned: \"#{@filename}\"" if clean_command
+      @output << "File cleaned: \"#{@user_facing_filename}\"" if clean_command
     end
 
     # Add a friend.
@@ -665,12 +666,12 @@ module Friends
       @notes = []
       @locations = []
 
-      return unless File.exist?(@filename)
+      return unless File.exist?(@expanded_filename)
 
       state = :unknown
 
       # Loop through all lines in the file and process them.
-      File.foreach(@filename).with_index(1) do |line, line_num|
+      File.foreach(@expanded_filename).with_index(1) do |line, line_num|
         line.chomp! # Remove trailing newline from each line.
 
         # Parse the line and update the parsing state.

data/lib/friends/version.rb

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

data/test/default_file_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "./test/helper"
+
+# Since this touches the ~/friends.md file instead of a temp
+# one, we only want to run it on our CI servers.
+if ENV["TRAVIS"] == "true"
+  describe "default filename behavior" do
+    let(:filename) { File.expand_path("~/friends.md") }
+
+    after { File.delete(filename) }
+
+    # Since the filename is the system-wide one, we can't have
+    # more than one test that touches it, because multiple
+    # tests can run in parallel and might stomp on one another.
+    # Instead, we just run one test that exercises a lot.
+    # This test specifically checks for regressions akin to
+    # https://github.com/JacobEvelyn/friends/issues/231
+    it "creates a new file and adds to it multiple times" do
+      # File does not exist at first.
+      File.exist?(filename).must_equal false
+
+      `bundle exec bin/friends add friend Mohandas Karamchand Gandhi`
+      `bundle exec bin/friends add friend Sojourner Truth`
+      `bundle exec bin/friends add activity 1859-11-30: Lunch with **Harriet Tubman** in _Auburn_.`
+      `bundle exec bin/friends add note "1851-05-29: Sojourner Truth's speech"`
+
+      File.read(filename).must_equal <<-FILE
+### Activities:
+- 1859-11-30: Lunch with **Harriet Tubman** in _Auburn_.
+
+### Notes:
+- 1851-05-29: **Sojourner Truth**'s speech
+
+### Friends:
+- Harriet Tubman
+- Mohandas Karamchand Gandhi
+- Sojourner Truth
+
+### Locations:
+- Auburn
+      FILE
+    end
+  end
+end

data/test/helper.rb

@@ -139,8 +139,8 @@ def line_added(expected)
   lines.size.must_equal(n_initial_lines + 1) # Line was added, not changed.
 end
 
-def clean_describe(desc, *additional_desc, &block)
-  describe desc, *additional_desc do
+def clean_describe(desc, &block)
+  describe desc do
     let(:filename) { "test/tmp/friends#{SecureRandom.uuid}.md" }
 
     before { File.write(filename, content) unless content.nil? }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.45'
+  version: '0.46'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2019-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -246,6 +246,7 @@ files:
 - test/commands/stats_spec.rb
 - test/commands/suggest_spec.rb
 - test/commands/update_spec.rb
+- test/default_file_spec.rb
 - test/editor
 - test/helper.rb
 - test/paging_spec.rb
@@ -302,6 +303,7 @@ test_files:
 - test/commands/stats_spec.rb
 - test/commands/suggest_spec.rb
 - test/commands/update_spec.rb
+- test/default_file_spec.rb
 - test/editor
 - test/helper.rb
 - test/paging_spec.rb