friends 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afa08d3f4c3b0c3cf97e75321e94d788ba282d93
-  data.tar.gz: c0653597da81b0f6132af10ab97faf2358484d91
+  metadata.gz: 625e3744b0240347b4e0c74a3a4063b672afab88
+  data.tar.gz: 25d066d3bb99d407adb41f01785772f514e7d4fa
 SHA512:
-  metadata.gz: a71a226dbad93f72e9cd4a48babe3186ad4c73d7d3483f85ebef94b3053e170ccded2b9ce42873898137b72808d4ef1ce6e6a4ccd6729292c0040ca05a92b099
-  data.tar.gz: 492a51f2a1abc0eaf8bf533bb2a4f24f7c2dce9a965c4a5cb8d9767658cf7b23be8f64ef86c613dbef27e9a29a8204a9cf342c7c146a0f70a381cb0d155710d6
+  metadata.gz: d9e23ab9e130aede68c68e7d65c07de1847585915af9794525db1057c3e3d6939010b73310fa7bf74ef808c94e41f41a41c7555af4d57bf96a1fb66548ee4bcc
+  data.tar.gz: 36300571ab2f75ef5406e5a6dddef153370dd5718a08d2dfe262f5ac03b368034ed21f2e6e97d0607abb35880bb4f28feb255e79513bea8c5cc693ce5159f02a

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 *.gem
+ideas.txt

data/.overcommit.yml

@@ -0,0 +1,3 @@
+PreCommit:
+  Reek:
+    enabled: false

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AbcSize:
+  Enabled: false
+
 AccessorMethodName:
   Enabled: false
 
@@ -5,11 +8,6 @@ Alias:
   Enabled: false
 
 AllCops:
-  Exclude:
-    - "vendor/**/*"
-    - "spec/dummy/**/*"
-    - "db/schema.rb"
-    - "db/migrate/**/*"
   RunRailsCops: false
 
 AmbiguousOperator:
@@ -181,6 +179,9 @@ ParameterLists:
 ParenthesesAsGroupedExpression:
   Enabled: false
 
+PerceivedComplexity:
+  Enabled: false
+
 PercentLiteralDelimiters:
   PreferredDelimiters:
     '%': '{}'

data/README.md

@@ -1,19 +1,160 @@
-[![Code Climate](https://codeclimate.com/github/JacobEvelyn/friends/badges/gpa.svg)](https://codeclimate.com/github/JacobEvelyn/friends) [![Test Coverage](https://codeclimate.com/github/JacobEvelyn/friends/badges/coverage.svg)](https://codeclimate.com/github/JacobEvelyn/friends) [![Build Status](https://travis-ci.org/JacobEvelyn/friends.svg)](https://travis-ci.org/JacobEvelyn/friends)
+[![Code Climate](https://codeclimate.com/github/JacobEvelyn/friends/badges/gpa.svg)](https://codeclimate.com/github/JacobEvelyn/friends) [![Test Coverage](https://codeclimate.com/github/JacobEvelyn/friends/badges/coverage.svg)](https://codeclimate.com/github/JacobEvelyn/friends) [![Build Status](https://travis-ci.org/JacobEvelyn/friends.svg)](https://travis-ci.org/JacobEvelyn/friends) [![Inline docs](http://inch-ci.org/github/JacobEvelyn/friends.png)](http://inch-ci.org/github/JacobEvelyn/friends)
 
 # Friends
 
-Spend time with the people you care about. Introvert-tested. Extrovert-approved.
+Spend time with the people you care about. Introvert-tested.
+Extrovert-approved.
+
+### What is it?
+
+**Friends** is both a Ruby library and a command-line interface that
+allows you to keep track of your relationships with the people you
+care about.
+
+### Why use it?
+
+1. **Friends** gives you:
+  - More organization around staying in touch with friends and
+    family.
+  - A way to track of the ebbs and flows of your relationships over
+    time.
+  - Suggestions for who to call or hang out with when you have free
+    time, whether it's fifteen minutes or an entire weekend.
+  - A low-cost way to record and remember big moments in your life.
+2. **Friends** stores its data in a universally readable `friends.md`
+  Markdown file. No proprietary formats here!
+3. **Friends** is open-source and very open to new ideas. Contribute!
 
 ## Installation
 
-    $ gem install friends
+```
+$ gem install friends
+```
 
 ## Usage
 
-    $ friends --help
+### Basic commands:
+
+Add a friend:
+
+```
+$ friends add friend "Grace Hopper"
+Friend added: "Grace Hopper"
+```
+List your friends:
+```
+$ friends list friends
+George Washington Carver
+Grace Hopper
+Marie Curie
+```
+Record an activity with a friend:
+```
+$ friends add activity "Got lunch with Grace and George."
+Activity added: "2015-01-04: Got lunch with Grace Hopper and George Washington Carver."
+```
+Or specify a date for the activity:
+```
+$ friends add activity "2014-12-31: Celebrated the new year with Marie."
+Activity added: "2014-12-31: Celebrated the new year with Marie Curie."
+```
+List the activities you've recorded:
+```
+$ friends list activities
+2015-01-04: Got lunch with Grace Hopper and George Washington Carver.
+2014-12-31: Celebrated the new year with Marie Curie.
+2014-11-15: Talked to George Washington Carver on the phone for an hour.
+```
+Or only list the activities you did with a certain friend:
+```
+$ friends list activities --with "George"
+2015-01-04: Got lunch with Grace Hopper and George Washington Carver.
+2014-11-15: Talked to George Washington Carver on the phone for an hour.
+
+```
+Find your favorite friends:
+```
+$ friends list favorites
+Your favorite friends:
+1. George Washington Carver
+2. Grace Hopper
+3. Marie Curie
+```
+Or get a specific number of favorites:
+```
+$ friends list favorites --limit 2
+Your favorite friends:
+1. George Washington Carver
+2. Grace Hopper
+```
+
+### Global options:
+
+##### --quiet
+
+Quiet output messages:
+```
+$ friends add activity "Went rollerskating with George."
+$ # No output!
+
+```
+
+##### --filename
+
+Change the location/name of the `friends.md` file:
+```
+$ friends --filename ./test/tmp/friends.md clean
+File cleaned: "./test/tmp/friends.md"
+```
+
+##### --clean
+
+Force cleaning of the `friends.md` file, even if the command does not
+normally write to the file.
+```
+$ friends --clean list friends
+George Washington Carver
+Grace Hopper
+Marie Curie
+File cleaned: "./friends.md"
+```
+
+### Advanced usage:
+
+Wouldn't it be nice to be able to use **Friends** across all of your
+devices? Hooray, you can! Just put the `friends.md` file in your
+Dropbox/Box Sync/Google Drive/whatever folder and use the
+`--filename` flag. You can even set up a Bash/Zsh/whatever alias to
+do this for you, like so:
+```bash
+alias friends="friends --filename '~/Dropbox/friends.md'"
+```
+
+### Help:
+
+Help menus are available for all levels of commands:
+```
+$ friends --help
+```
+```
+$ friends list --help
+```
+```
+$ friends list activities --help
+```
+
+## Documentation
+
+In case you're *really* interested, we have
+[documentation](http://www.rubydoc.info/JacobEvelyn/friends).
 
 ## Contributing
 
+If you have an idea,
+[make a GitHub Issue](https://github.com/JacobEvelyn/friends/issues/new)!
+Suggestions are very very welcome, and often are implemented very
+quickly. And if you'd like to do the implementing yourself:
+
 1. Fork it (https://github.com/JacobEvelyn/friends/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am "Add some feature"`)
@@ -21,7 +162,7 @@ Spend time with the people you care about. Introvert-tested. Extrovert-approved.
 5. Create a new Pull Request
 
 **Make sure your changes have appropriate tests (`rake test`) and
-conform to the Rubocop style specified. We use
+conform to the Rubocop style specified. This project uses
 [overcommit](https://github.com/causes/overcommit) to enforce good
 code.**
 

data/bin/friends

@@ -1,5 +1,129 @@
 #!/usr/bin/env ruby
 
-require "friends"
+require "gli"
 
-Friends::Extrovert.start(ARGV)
+require "friends/introvert"
+require "friends/version"
+
+include GLI::App
+
+program_desc "Spend time with the people you care about. Introvert-tested. "\
+  "Extrovert-approved."
+
+version Friends::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+switch [:quiet],
+  negatable: false,
+  desc: "Quiet output messages"
+
+flag [:filename],
+  arg_name: "FILENAME",
+  default_value: "./friends.md",
+  desc: "Set the location of the friends file"
+
+switch [:clean],
+  negatable: false,
+  desc: "Force a clean write of the friends file"
+
+desc "Lists friends or activities"
+command :list do |c|
+  c.desc "List all friends"
+  c.command :friends do |list_friends|
+    list_friends.action do
+      puts @introvert.list_friends
+    end
+  end
+
+  c.desc "List favorite friends"
+  c.command :favorites do |list_favorites|
+    list_favorites.flag [:limit],
+      arg_name: "NUMBER",
+      default_value: 10,
+      desc: "The number of friends to return"
+
+    list_favorites.action do |_, options|
+      limit = options[:limit].to_i
+      favorites = @introvert.list_favorites(limit: limit)
+
+      if limit == 1
+        puts "Your best friend is #{favorites.first}"
+      else
+        puts "Your favorite friends:"
+        num = 0
+        favorites.each { |name| puts "#{"#{num += 1}.".ljust(2)} #{name}" }
+      end
+    end
+  end
+
+  c.desc "Lists all activities"
+  c.command :activities do |list_activities|
+    list_activities.flag [:with],
+      arg_name: "NAME",
+      desc: "List only activities involving the given friend"
+
+    list_activities.action do |_, options|
+      puts @introvert.list_activities(with: options[:with])
+    end
+  end
+end
+
+desc "Adds a friend or activity"
+command :add do |c|
+  c.desc "Adds a friend"
+  c.arg_name "NAME"
+  c.command :friend do |add_friend|
+    add_friend.action do |_, _, args|
+      friend = @introvert.add_friend(name: args.first)
+      @message = "Friend added: \"#{friend.name}\""
+    end
+  end
+
+  c.desc "Adds an activity"
+  c.arg_name "DESCRIPTION"
+  c.command :activity do |add_activity|
+    add_activity.action do |_, _, args|
+      activity = @introvert.add_activity(serialization: args.first)
+      @message = "Activity added: \"#{activity.display_text}\""
+    end
+  end
+end
+
+desc "Cleans your friends.md file"
+command :clean do |c|
+  c.action do
+    filename = @introvert.clean
+    @message = "File cleaned: \"#{filename}\""
+  end
+end
+
+# Before each command, clean up all arguments and create the global Introvert.
+pre do |global_options, _, options|
+  final_options = global_options.merge!(options).select do |key, _|
+    [:filename].include? key
+  end
+
+  @introvert = Friends::Introvert.new(final_options)
+  true
+end
+
+post do |global_options|
+  # After each command, clean if requested with the --clean flag.
+  if global_options[:clean]
+    filename = @introvert.clean
+    @message = "File cleaned: \"#{filename}\""
+  end
+
+  # Print the output message (if there is one) unless --quiet is passed.
+  puts @message unless @message.nil? || global_options[:quiet]
+end
+
+# If an error is raised, print the message to STDERR and exit the program.
+on_error do |error|
+  abort "Error: #{error}"
+end
+
+# Run the program and return the exit code corresponding to the its success.
+exit run(ARGV)

data/friends.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["jacobevelyn@gmail.com"]
   spec.summary       = %q{Spend time with the people you care about.}
   spec.description   = %q{Spend time with the people you care about. Introvert-tested. Extrovert-approved.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/JacobEvelyn/friends"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,9 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "thor"
+  spec.add_dependency "gli", "~> 2.12"
+  spec.add_dependency "memoist", "~> 0.11"
 
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
 end

data/friends.md

@@ -1,3 +1,9 @@
+### Activities:
+- 2015-01-04: Got lunch with **Grace Hopper** and **George Washington Carver**.
+- 2014-12-31: Celebrated the new year with **Marie Curie**.
+- 2014-11-15: Talked to **George Washington Carver** on the phone for an hour.
+
 ### Friends:
-- Ben Yavitt
-- Zane
+- George Washington Carver
+- Grace Hopper
+- Marie Curie

data/lib/friends.rb

@@ -1,4 +1,5 @@
-require "friends/extrovert"
+require "friends/introvert"
+require "friends/version"
 
 module Friends
 end

data/lib/friends/activity.rb

@@ -0,0 +1,127 @@
+# Activity represents an activity you've done with one or more Friends.
+
+require "memoist"
+
+require "friends/serializable"
+
+module Friends
+  class Activity
+    extend Serializable
+    extend Memoist
+
+    SERIALIZATION_PREFIX = "- "
+
+    # @return [Regexp] the regex for capturing groups in deserialization
+    def self.deserialization_regex
+      /(#{SERIALIZATION_PREFIX})?((?<date_s>\d{4}-\d\d-\d\d):\s)?(?<description>.+)/
+    end
+
+    # @return [Regexp] the string of what we expected during deserialization
+    def self.deserialization_expectation
+      "[YYYY-MM-DD]: [Activity]"
+    end
+
+    # @param date_s [String] the activity's date, parsed using Date.parse()
+    # @param description [String] the activity's description
+    # @return [Activity] the new activity
+    def initialize(date_s: Date.today.to_s, description:)
+      @date = Date.parse(date_s)
+      @description = description
+    end
+
+    attr_reader :date
+    attr_reader :description
+
+    # @return [String] the command-line display text for the activity
+    def display_text
+      date_s = "\e[1m#{date}\e[0m"
+      description_s = description
+      while match = description_s.match(/(\*\*)([^\*]+)(\*\*)/)
+        description_s =
+          "#{match.pre_match}\e[1m#{match[2]}\e[0m#{match.post_match}"
+      end
+      "#{date_s}: #{description_s}"
+    end
+
+    # @return [String] the file serialization text for the activity
+    def serialize
+      "#{SERIALIZATION_PREFIX}#{date}: #{description}"
+    end
+
+    # Modify the description to turn inputted friend names
+    # (e.g. "Jacob" or "Jacob Evelyn") into full asterisk'd names
+    # (e.g. "**Jacob Evelyn**")
+    # @param friends [Array] list of friends to highlight in the description
+    # @raise [FriendsError] if more than one friend matches a part of the
+    #   description
+    def highlight_friends(friends:)
+      # Map each friend to a list of all possible regexes for that friend.
+      friend_regexes = {}
+      friends.each { |f| friend_regexes[f.name] = regexes_for_name(f.name) }
+
+      # Create hash mapping regex to friend name. Note that because two friends
+      # may have the same regex (e.g. /John/), we need to store the names in an
+      # array since there may be more than one. We also iterate through the
+      # regexes to add the most important regexes to the hash first, so
+      # "Jacob Evelyn" takes precedence over all instances of "Jacob" (since
+      # Ruby hashes are ordered).
+      regex_map = Hash.new { |h, k| h[k] = [] }
+      while !friend_regexes.empty?
+        friend_regexes.each do |friend_name, regex_list|
+          regex_map[regex_list.shift] << friend_name
+          friend_regexes.delete(friend_name) if regex_list.empty?
+        end
+      end
+
+      # Go through the description and substitute in full, asterisk'd names for
+      # anything that matches a friend's name.
+      new_description = description.clone
+      regex_map.each do |regex, names|
+        new_description.gsub!(regex, "**#{names.first}**") if names.size == 1
+      end
+
+      @description = new_description
+    end
+
+    # Find the names of all friends in this description.
+    # @return [Array] list of all friend names in the description
+    def friend_names
+      description.scan(/(?<=\*\*)\w[^\*]*(?=\*\*)/).uniq
+    end
+    memoize :friend_names
+
+    private
+
+    # Default sorting for an array of activities is reverse-date.
+    def <=>(other)
+      other.date <=> date
+    end
+
+    # @return [Array] a list of all regexes to match the name in a string, with
+    #   longer regexes first
+    #   Note: for now we only match on full names or first names
+    #   Example: [
+    #     /Jacob\s+Morris\s+Evelyn/,
+    #     /Jacob/
+    #   ]
+    def regexes_for_name(name)
+      # We generously allow any amount of whitespace between parts of a name.
+      splitter = "\\s+"
+
+      # We don't want to match names that are directly touching double asterisks
+      # as these are treated as sacred by our program.
+      no_leading_asterisks = "(?<!\\*\\*)"
+      no_ending_asterisks = "(?!\\*\\*)"
+
+      # Create the list of regexes and return it.
+      chunks = name.split(Regexp.new(splitter))
+
+      [chunks, [chunks.first]].map do |words|
+        Regexp.new(
+          no_leading_asterisks + words.join(splitter) + no_ending_asterisks,
+          Regexp::IGNORECASE
+        )
+      end
+    end
+  end
+end