friends 0.13 → 0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 844eb360bcc04aed352a8b3c3371117afb18f564
-  data.tar.gz: db2feb8fbf5a15232b6b5923218dc8d7cff4ded1
+  metadata.gz: 1fd5cb3c9a9b913b0772d731f872709820e5fa12
+  data.tar.gz: 99b28c2a79ae11aea5b49e75f328ed03433f94dd
 SHA512:
-  metadata.gz: c3eb0061ba85b5dcc7eb1fa9f7d0dc1c711834b4b128b37d789252b5293b290e95de4553f55cb57a585dee1cf077e87c7b2d8fa6e5806f7ed8520227287e3e9a
-  data.tar.gz: cac077cacd2c4a0309b5614e1952dd65b55f0c22b7d23ed619cda4c6637f282284c0c236ff1a16ed83a4fd9ecc3bcfe434755f3c46f87c241fd8073990deda7d
+  metadata.gz: b8aba3f30dfc6de57c2d98a79b8fa3e131458b199c25e3bfff960ec0011069040844a90580848b10e255fb869ab2843e0ab941daa85c390e69e3ba74dbe650ce
+  data.tar.gz: f9491efb85eed54694805e080c2e00ab5893687d60d78bc643cdccae64cc3081139ea5333e8a9d5d99ba0861e9c3b5586a59156f81b6766d2facbc1ca9eeee65

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## [v0.15](https://github.com/JacobEvelyn/friends/tree/v0.15) (2016-03-11)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.14...v0.15)
+
+## [v0.14](https://github.com/JacobEvelyn/friends/tree/v0.14) (2016-03-11)
+[Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.13...v0.14)
+
+**Implemented enhancements:**
+
+- Allow dates in natural-language formats [\#65](https://github.com/JacobEvelyn/friends/issues/65)
+
+**Merged pull requests:**
+
+- Allow natural-language dates [\#82](https://github.com/JacobEvelyn/friends/pull/82) ([JacobEvelyn](https://github.com/JacobEvelyn))
+
 ## [v0.13](https://github.com/JacobEvelyn/friends/tree/v0.13) (2016-01-21)
 [Full Changelog](https://github.com/JacobEvelyn/friends/compare/v0.12...v0.13)
 
@@ -208,4 +222,4 @@
 ## [v0.0.1](https://github.com/JacobEvelyn/friends/tree/v0.0.1) (2014-12-11)
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -51,7 +51,7 @@ Activity added: "2015-01-04: Got lunch with Grace Hopper and George Washington C
 
 You can of course specify a date for the activity:
 ```
-$ friends add activity "2014-12-31: Celebrated the new year with Marie."
+$ friends add activity "Yesterday: Celebrated the new year with Marie."
 Activity added: "2014-12-31: Celebrated the new year with Marie Curie."
 ```
 Or get an **interactive prompt** by just typing `friends add activity`, with or without a date specified:
@@ -59,6 +59,11 @@ Or get an **interactive prompt** by just typing `friends add activity`, with or
 $ friends add activity 2015-11-01
 2015-11-01: <type description here>
 ```
+**Natural-language dates** work just fine:
+```
+$ friends add activity 'last Monday'
+2016-03-07: <type description here>
+```
 You can escape the names of friends you don't want `friends` to match with a backslash:
 ```
 $ friends add activity "2015-11-01: Grace and I went to \Marie's Diner. \George had to cancel at the last minute."

data/bin/friends

@@ -131,7 +131,7 @@ command :add do |add|
       activity = @introvert.add_activity(serialization: args.first)
 
       # If there's no description, prompt the user for one.
-      if !activity.description
+      if activity.description.nil? || activity.description.empty?
         activity.description = Readline.readline(activity.display_text)
         activity.highlight_friends(introvert: @introvert)
       end

data/friends.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   # We need Ruby 2.0's keyword arguments and default UTF-8 encoding.
   spec.required_ruby_version = ">= 2.1"
 
+  spec.add_dependency "chronic", "~> 0.10"
   spec.add_dependency "gli", "~> 2.12"
   spec.add_dependency "memoist", "~> 0.11"
   spec.add_dependency "paint", "~> 1.0"

data/lib/friends/activity.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 # Activity represents an activity you've done with one or more Friends.
 
+require "chronic"
 require "memoist"
 require "paint"
 
@@ -12,13 +13,11 @@ module Friends
     extend Memoist
 
     SERIALIZATION_PREFIX = "- ".freeze
+    DATE_PARTITION = ": ".freeze
 
     # @return [Regexp] the regex for capturing groups in deserialization
     def self.deserialization_regex
-      # Note: this regex must be on one line because whitespace is important
-      # rubocop:disable Metrics/LineLength
-      /(#{SERIALIZATION_PREFIX})?((?<date_s>\d{4}-\d\d-\d\d)(:\s)?)?(?<description>.+)?/
-      # rubocop:enable Metrics/LineLength
+      /(#{SERIALIZATION_PREFIX})?(?<str>.+)?/
     end
 
     # @return [Regexp] the string of what we expected during deserialization
@@ -26,12 +25,23 @@ module Friends
       "[YYYY-MM-DD]: [Activity]"
     end
 
-    # @param date_s [String] the activity's date, parsed using Date.parse()
-    # @param description [String] the activity's description
+    # @param str [String] the text of the activity, of one of the formats:
+    #   "<date>: <description>"
+    #   "<date>" (Program will prompt for description.)
+    #   "<description>" (The current date will be used by default.)
     # @return [Activity] the new activity
-    def initialize(date_s: Date.today.to_s, description: nil)
-      @date = Date.parse(date_s)
-      @description = description
+    def initialize(str: "")
+      # Partition lets us parse "Today" and "Today: I awoke." identically.
+      date_s, _, description = str.partition(DATE_PARTITION)
+
+      if time = Chronic.parse(date_s)
+        @date = time.to_date
+        @description = description
+      else
+        # If the user didn't input a date, we fall back to the current date.
+        @date = Date.today
+        @description = str # Use str in case DATE_PARTITION occurred naturally.
+      end
     end
 
     attr_reader :date

data/lib/friends/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Friends
-  VERSION = "0.13".freeze
+  VERSION = "0.15".freeze
 end

data/test/activity_spec.rb

@@ -1,18 +1,37 @@
 require "./test/helper"
 
 describe Friends::Activity do
-  let(:date) { Date.today }
+  let(:date) { Date.today - 1 }
   let(:date_s) { date.to_s }
   let(:friend1) { Friends::Friend.new(name: "Elizabeth Cady Stanton") }
   let(:friend2) { Friends::Friend.new(name: "John Cage") }
   let(:description) { "Lunch with **#{friend1.name}** and **#{friend2.name}**" }
+  let(:partition) { Friends::Activity::DATE_PARTITION }
   let(:activity) do
-    Friends::Activity.new(date_s: date_s, description: description)
+    Friends::Activity.new(str: "#{date_s}#{partition}#{description}")
   end
 
   describe ".deserialize" do
     subject { Friends::Activity.deserialize(serialized_str) }
 
+    describe "when serialized string is empty" do
+      let(:serialized_str) { "" }
+
+      it "defaults date to today and sets no description" do
+        today = Date.today - 7
+
+        # We stub out Date.today to guarantee that it is always the same even
+        # when the date changes in the middle of the test's execution. To ensure
+        # this technique actually works, we move our reference time backward by
+        # a week.
+        Date.stub(:today, today) do
+          new_activity = subject
+          new_activity.date.must_equal today
+          new_activity.description.must_equal ""
+        end
+      end
+    end
+
     describe "when string is well-formed" do
       let(:serialized_str) { "#{date_s}: #{description}" }
 
@@ -23,23 +42,45 @@ describe Friends::Activity do
       end
     end
 
+    describe "when date is written in natural language" do
+      let(:serialized_str) { "Yesterday: #{description}" }
+
+      it "creates an activity with the correct date and description" do
+        now = Time.now + 604800
+
+        # Chronic uses Time.now for parsing, so we stub this to prevent racy
+        # behavior when the date changes in the middle of test execution. To
+        # ensure this technique actually works, we move our reference time
+        # backward by a week.
+        Time.stub(:now, now) do
+          new_activity = subject
+          new_activity.date.must_equal (now.to_date - 1)
+          new_activity.description.must_equal description
+        end
+      end
+    end
+
     describe "when no date is present" do
       let(:serialized_str) { description }
 
       it "defaults to today" do
-        today = Date.today
+        today = Date.today - 7
 
         # We stub out Date.today to guarantee that it is always the same even
-        # when the date changes in the middle of the test's execution.
+        # when the date changes in the middle of the test's execution. To ensure
+        # this technique actually works, we move our reference time backward by
+        # a week.
         Date.stub(:today, today) { subject.date.must_equal today }
       end
     end
 
     describe "when no description is present" do
-      let(:serialized_str) { "" }
+      let(:serialized_str) { date_s }
 
-      it "sets no description in deserialization" do
-        subject.description.must_equal nil
+      it "leaves description blank" do
+        new_activity = subject
+        new_activity.date.must_equal date
+        new_activity.description.must_equal ""
       end
     end
   end
@@ -249,17 +290,14 @@ describe Friends::Activity do
           # better friend than Elizabeth Cady Stanton.
           old_activities = [
             Friends::Activity.new(
-              date_s: date_s,
-              description: "Picnic with **Elizabeth Cady Stanton** and "\
-                           "**John Cage**."
+              str: "#{date_s}#{partition}Picnic with "\
+                   "**Elizabeth Cady Stanton** and **John Cage**."
             ),
             Friends::Activity.new(
-              date_s: date_s,
-              description: "Got lunch with with **Elizabeth II**."
+              str: "#{date_s}#{partition}Got lunch with **Elizabeth II**."
             ),
             Friends::Activity.new(
-              date_s: date_s,
-              description: "Ice skated with **Elizabeth II**."
+              str: "#{date_s}#{partition}Ice skated with **Elizabeth II**."
             )
           ]
 
@@ -282,8 +320,7 @@ describe Friends::Activity do
 
           # Give a past activity to Elizabeth II.
           old_activity = Friends::Activity.new(
-            date_s: date_s,
-            description: "Do something with **Elizabeth II**."
+            str: "#{date_s}#{partition}Do something with **Elizabeth II**."
           )
 
           stub_activities([old_activity]) { subject }
@@ -339,10 +376,8 @@ describe Friends::Activity do
 
   describe "#<=>" do
     it "sorts by reverse-date" do
-      yesterday = (Date.today - 1).to_s
-      tomorrow = (Date.today + 1).to_s
-      past_act = Friends::Activity.new(date_s: yesterday, description: "Dummy")
-      future_act = Friends::Activity.new(date_s: tomorrow, description: "Dummy")
+      past_act = Friends::Activity.new(str: "Yesterday: Dummy")
+      future_act = Friends::Activity.new(str: "Tomorrow: Dummy")
       [past_act, future_act].sort.must_equal [future_act, past_act]
     end
   end

data/test/introvert_spec.rb

@@ -31,13 +31,10 @@ describe Friends::Introvert do
   let(:activities) do
     [
       Friends::Activity.new(
-        date_s: Date.today.to_s,
-        description: "Lunch with **#{friend_names.first}** and "\
-          "**#{friend_names.last}**."
+        str: "Lunch w/ **#{friend_names.first}** and **#{friend_names.last}**."
       ),
       Friends::Activity.new(
-        date_s: (Date.today - 1).to_s,
-        description: "Called **#{friend_names.last}**."
+        str: "Yesterday: Called **#{friend_names.last}**."
       )
     ]
   end
@@ -413,22 +410,19 @@ describe Friends::Introvert do
       let(:activities) do
         [
           Friends::Activity.new(
-            date_s: Date.today.to_s,
-            description: "Lunch with **George Washington Carver**."
+            str: "Lunch with **George Washington Carver**."
           ),
 
           # Create another activity with a gap of over a month between it and
           # the next activity, so we can test that we correctly return data for
           # months in the range with no activities.
           Friends::Activity.new(
-            date_s: (Date.today - 70).to_s,
-            description: "Called **George Washington Carver**."
+            str: "70 days ago: Called **George Washington Carver**."
           ),
 
           # Create an activity that doesn't involve our friend name.
           Friends::Activity.new(
-            date_s: (Date.today - 150).to_s,
-            description: "Called **Betsy Ross** on the phone."
+            str: "150 days ago: Called **Betsy Ross** on the phone."
           )
         ]
       end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: friends
 version: !ruby/object:Gem::Version
-  version: '0.13'
+  version: '0.15'
 platform: ruby
 authors:
 - Jacob Evelyn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement