hbtrack 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42e80f09161cc593527386d9d47f73364e6a69b6
-  data.tar.gz: 36ad20ec43500749a0261fa496e363efca27a648
+  metadata.gz: 202f4fe27cf01abbf78f19ca7a3fd075e151c9ad
+  data.tar.gz: d0433a6543c279963e4876f372f0147d23b376fe
 SHA512:
-  metadata.gz: 74bfb5ee6b795b000c856b851d88ef36a5ab634d4a07f5eeaedd8811de261778ebe146e2d5e922b70f0e08487783d2b84937c197d105b3626d10f03cabd5e942
-  data.tar.gz: b9b51aec3bd911037382fea14cf13a07ea115e68f00272a1375132f94c22ae37892d243d6ec0322962e74523941e904396e9532c9992e1bf7ea3b49f351b57fd
+  metadata.gz: 33653f712de657b5fd7e40192a0d371f540a121740c265544c7dde950c221d7d8d58343e53d08105652de0e2e9f86af8344ec04e02cfa063aeb80e5a183d1565
+  data.tar.gz: be1d05fc272fbcf4a31ec40c92c5a7b49f4aa6ca5519424459b8e70963d7f581866b1265302f9b5896e8efe4f512fb0ca19a8b240633b8dbbc20428b6f62a68d

data/README.md

@@ -1,6 +1,6 @@
 ## Hbtrack
 
-`hbtrack` is a simple Command Lines tool to keep track of your daily habits. The functionality of the current version is very limited.
+`hbtrack` is a simple command lines tool to keep track of your daily habits. The functionality of the current version is very limited.
 
 ## Installation
 
@@ -10,44 +10,91 @@ gem install hbtrack
 
 ## Usage
 
-To add a new habit _(duplicate name will be ignore)_:
+#### Add a new habit
 ```
-hbtrack add habit_name
+$ hbtrack add habit_name
 ```
+Duplicate habit name will be ignore. 
 
-To mark your habit as done for the current day:
+#### Mark habit as done/undone
 ```
-hbtrack done habit_name
+$ hbtrack done habit_name
 ```
+This will mark the current habit as done for the current day. 
 
-To mark your habit as undone for the current day:
 ```
-hbtrack undone habit_name
+$ hbtrack undone habit_name
 ```
+This will mark the current habit as undone for the current day.
 
-You can also mark your habit done/undone for the previous day by adding `-y` option:
+You can also mark your habit done/undone for the previous day by adding `-y` or `--yesterday` option: 
 ```
-hbtrack done/undone -y habit_name
+$ hbtrack done/undone -y habit_name
 ```
 
-To remove the habit completely:
+#### Remove a habit 
 ```
-hbtrack remove habit_name
+$ hbtrack remove habit_name
 ```
 
-To have a look of all of your habit progress:
+#### Listing Progress
+
+You can list all your habits progress by: 
 ```
-hbtrack list 
+$ hbtrack list 
 ```
+This will list all the habits you added and its progress for the current month.
 
-To look at individual habit progress:
+**Output:** 
 ```
-hbtrack list habit_name
+August 2017
+-----------
+1. workout     : ***                             All: 3, Done: 3, Undone: 0
+2. read        : ***                             All: 3, Done: 3, Undone: 0
+3. programming : ***                             All: 3, Done: 3, Undone: 0
+4. ukulele     : ***                             All: 3, Done: 3, Undone: 0
+5. sleep_early : ***                             All: 3, Done: 1, Undone: 2
+
+Total
+-----
+All: 15, Done: 13, Undone: 2
 ```
 
-## Limitations
+**Note:** The actual output is colorized where green color font indicate done and red color font indicate undone.
+
+You can also look at the progress of an individual habit by: 
+```
+$ hbtrack list habit_name
+```
+
+**Output:**
+```
+workout
+-------
+     July 2017 : ******************************* All: 31, Done: 26, Undone: 5
+   August 2017 : ***                             All: 3, Done: 3, Undone: 0
+```
 
-For the current version, some invalid inputs are not handled properly.
+
+Extra options such as `-p` or `--percentage` can be provided to list the stats of your habits in terms of completion rate.
+```
+$ hbtrack list -p habit_name
+```
+
+With the extra options `-p`, the output will be:
+```
+August 2017
+-----------
+1. workout     : ***                             Completion rate: 100.00%
+2. read        : ***                             Completion rate: 100.00%
+3. programming : ***                             Completion rate: 100.00%
+4. ukulele     : ***                             Completion rate: 100.00%
+5. sleep_early : ***                             Completion rate: 33.33%
+
+Total
+-----
+Completion rate: 86.67%
+```
 
 ## Data
 
@@ -82,7 +129,9 @@ read
 ```
 
 ## Bugs/Features
-If there are any bugs/feature requesst, feel free to create a new issues.
+The project is still in development. 
+
+If there are any bugs/features request, feel free to create a new issues.
 
 
 

data/lib/hbtrack/habit.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
 require 'date'
-require 'hbtrack/cli'
 
-module Hbtrack
-  # Habit provide a rich library to track the
-  # progress of your habit.
+module Hbtrack 
+
+  # Habit class
   class Habit
     attr_accessor :name
     attr_reader :progress
@@ -26,9 +25,10 @@ module Hbtrack
 
       # Initialize Habit object from string.
       #
-      # string - The string to be parse.
+      # @param string [String] The string to be parse.
+      # @return [Habit] a habit object
       #
-      # Example
+      # == Example
       #
       #   Habit.initialize_from_string("workout\n2017,6:1001")
       #   # => #<Habit:0x007f9be6041b70 @name="workout",
@@ -50,8 +50,6 @@ module Hbtrack
       end
     end
 
-    # Public APIs
-
     def initialize(name,
                    progress = {
                      Habit.get_progress_key_from(Date.today) => ''
@@ -60,66 +58,78 @@ module Hbtrack
       @progress = progress
     end
 
+    # The length of the habit name.
+    #
+    # @return [Numeric] length of the habit name
     def name_length
       name.length
     end
 
-    def latest_key
-      Habit.get_progress_key_from(Date.today)
+    # Get the latest progress key.
+    # 
+    # @return [Symbol] latest progress key
+    def latest_key  
+      key = Habit.get_progress_key_from(Date.today)
+      if progress[key].nil?
+        initialize_progress_hash_from(key)
+      end
+      key     
     end
 
+    # Get the latest progress.
+    #
+    # @return [String] value of the progress
     def latest_progress
       progress[latest_key]
     end
 
+    # Get the stat for the latest progress.
+    #
+    # @return [Hash] stat for the progress.
+    def latest_stat
+      stat_for_progress(latest_key)
+    end
+
+    # Find the month in progress with 
+    # the longest name
+    # 
+    # @return [String] month
     def longest_month
       key = progress.keys.max_by do |x| 
-        get_month_from(x).length
+        Util.get_month_from(x).length
       end
-      get_month_from(key)
+      Util.get_month_from(key)
     end
 
+    # Update the status of the progress
+    #
+    # @param done [true, false] If true, it is marked as done. 
+    #   Else, marked as undone.
+    # @param date [Date] The date of the progress
+    # @return [void]
     def done(done = true, date = Date.today)
       key = Habit.get_progress_key_from(date)
       initialize_progress_hash_from(key)
       update_progress_for(key, date.day, done)
     end
 
-    def pretty_print_all
-      @progress.map do |key, _value|
-        space = longest_month.length - get_month_from(key).length 
-        convert_key_to_date(key, space) +
-        pretty_print_progress(key)
-      end.join("\n")
-    end
-
-    def pretty_print_latest(no_of_space = 0)
-      name.to_s + ' ' * no_of_space + ' : ' +
-        pretty_print_progress(latest_key)
-    end
-
-    def pretty_print_progress(key)
-      stat = progress[key].split('').map do |x|
-        x == '0' ? Hbtrack::CLI.red('*') : Hbtrack::CLI.green('*')
-      end.join('')
-      stat + ' ' * (32 - progress[key].size) +
-        one_liner_progress_stat_output_for(key)
-    end
-
-    def convert_key_to_date(key, no_of_space)
-      year = key.to_s.split(",")[0]
-      ' ' * no_of_space + get_month_from(key) + 
-      " #{year}" + " : "
-    end
-
-    def get_month_from(key)
-      key = key.to_s.split(',')
-      Date::MONTHNAMES[key[1].to_i]
+    # Get the stat of the progress.
+    #
+    # @param key [Symbol] key for the progress
+    # @return [Hash] stat of the progress in the form of 
+    # == Example:
+    #
+    #   habit.stat_for_progress("2017,5".to_sym)
+    #   # => { done: 5, undone: 2 }
+    def stat_for_progress(key)
+      undone = @progress[key].split('').count { |x| x == '0' }
+      done = @progress[key].length - undone
+      { done: done, undone: undone }
     end
 
     # Get all of the progress of the habit in string form
     #
-    # Example:
+    # == Example:
     #
     #   habit.progress_output
     #   # => "2017,5: 0010001010\n2017,6: 000010010\n"
@@ -131,47 +141,11 @@ module Hbtrack
       arr.join('')
     end
 
-    def progress_stat
-      @progress.map do |key, _value|
-        convert_key_to_date(key, 0) + "\n" +
-          progress_stat_output_for(key)
-      end.join("\n")
-    end
-
-    def one_liner_progress_stat_output_for(key)
-      hash = progress_stat_for(key)
-      "(All: #{progress[key].size}," \
-        " Done: #{hash[:done]}, Undone: #{hash[:undone]})"
-    end
-
-    def progress_stat_output_for(key)
-      hash = progress_stat_for(key)
-      Hbtrack::CLI.green("Done: #{hash[:done]}") + "\n" +
-        Hbtrack::CLI.red("Undone: #{hash[:undone]}") + "\n"
-    end
-
-    # Get the stat of the progress.
-    #
-    # key - Key for the progress (hash)
-    #
-    # Example:
-    #
-    #   habit.progress_stat_for("2017,5".to_sym)
-    #   # => { done: 5, undone: 2 }
-    def progress_stat_for(key)
-      undone = @progress[key].split('').count { |x| x == '0' }
-      done = @progress[key].length - undone
-      { done: done, undone: undone }
-    end
-
     def to_s
       "#{name}\n" + progress_output + "\n"
     end
 
-    # Private APIs
-
     private
-
     def initialize_progress_hash_from(key)
       @progress[key] = '' unless @progress.key? key
     end
@@ -180,7 +154,7 @@ module Hbtrack
       i = day - @progress[key].length - 1
       result = @progress[key].split('')
       i.times { result << '0' }
-      result[day] = done ? '1' : '0'
+      result[day-1] = done ? '1' : '0'
       @progress[key] = result.join('')
     end
   end

data/lib/hbtrack/habit_printer.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Hbtrack
+  # This class contains the methods that 
+  # are used to format the progress of a Habit
+  # into string
+  class HabitPrinter
+
+    def initialize(stat_formatter)
+      @stat_formatter = stat_formatter
+    end
+
+    def calculate_space_needed_for(habit, key)
+      habit.longest_month.length - Util.get_month_from(key).length
+    end
+
+    def print_latest_progress(habit, no_of_space = 0)
+      habit.name.to_s + ' ' * no_of_space + ' : ' +
+      print_progress(
+        habit.latest_progress, 
+        habit.latest_stat
+      )
+    end
+
+    def print_all_progress(habit)
+      habit.progress.map do |key, value|        
+        space = calculate_space_needed_for(habit, key)
+        Util.convert_key_to_date(key, space) +
+        print_progress(
+          value, 
+          habit.stat_for_progress(key)
+        )
+      end.join("\n")
+    end
+
+    def print_progress(progress, stat)
+      output = progress.split('').map do |x|
+        x == '0' ? CLI.red('*') : CLI.green('*')
+      end.join('')
+      output + ' ' * (32 - progress.size) +
+        @stat_formatter.format(stat)
+    end
+  end
+end
+

data/lib/hbtrack/habit_tracker.rb

@@ -1,32 +1,35 @@
 # frozen_string_literal: true
 
-require 'hbtrack/version'
-require 'hbtrack/habit'
-require 'hbtrack/cli'
-require 'hbtrack/config'
-
 module Hbtrack
   # This class contains the methods to
   # handle the operation of mutliple habits
   class HabitTracker
-    attr_reader :habits
+    attr_reader :habits, :hp
 
     def self.help # Refactoring needed
-      puts 'usage: hbtrack list [ habit_name ]'
+      puts 'usage: hbtrack list [-p] [ habit_name ]'
       puts '       hbtrack add habit_name'
       puts '       hbtrack done [-y] habit_name'
       puts '       hbtrack undone [-y] habit_name'
       puts '       hbtrack remove habit_name'
     end
 
-    def initialize(file = Hbtrack::FILE_NAME,
-                   output = Hbtrack::FILE_NAME)
+    def initialize(file = FILE_NAME,
+                   output = FILE_NAME)
       @habits = []
       @file_name = file
       @output_file_name = output
+      @sf = CompleteSF.new
+      @hp = HabitPrinter.new(@sf)
       initialize_habits_from_file
     end
 
+    def initialize_habits_from_file
+      return unless File.exist?(@file_name)
+      input = File.read(@file_name).split(/\n\n/)
+      input.each { |string| @habits << Habit.initialize_from_string(string) }
+    end
+
     def parse_arguments(args)
       head = args.shift
       tail = args
@@ -51,16 +54,23 @@ module Hbtrack
       HabitTracker.help
     end
 
-    private
+    def total_habits_stat 
+      @habits.reduce({done: 0, undone: 0}) do |stat, habit|
+        stat[:done] += habit.latest_stat[:done]
+        stat[:undone] += habit.latest_stat[:undone]
+        stat
+      end
+    end
 
-    def initialize_habits_from_file
-      return unless File.exist?(@file_name)
-      input = File.read(@file_name).split(/\n\n/)
-      input.each { |string| @habits << Hbtrack::Habit.initialize_from_string(string) }
+    def overall_stat_description
+      Util.title("Total") +
+      @sf.format(total_habits_stat)
     end
 
+    private
     def list(args)
-      habit_name, _options = parse_options(args)
+      habit_name, options = parse_options(args)
+      set_sf_based_on(options)
       habit = find(habit_name) do
         if habit_name.nil?
           list_all_habits
@@ -69,14 +79,26 @@ module Hbtrack
         end
         return
       end
-      puts habit.pretty_print_all
+      puts Util.title habit.name 
+      puts @hp.print_all_progress(habit)
+    end
+
+    def set_sf_based_on(options)
+      return if options.empty?
+      if options[0] == '-p' || options[0] == '--percentage'
+        @sf = CompletionRateSF.new
+        @hp = HabitPrinter.new(@sf)
+      end
     end
 
     def list_all_habits 
+      puts Util.title Util.current_month
       @habits.each_with_index do |h, index|
         space = longest_name.length - h.name_length
-        puts "#{index + 1}. #{h.pretty_print_latest(space)}"
+        puts "#{index + 1}. " +
+        "#{@hp.print_latest_progress(h, space)}"
       end
+      puts "\n" + overall_stat_description
     end
 
     def add(args)
@@ -86,7 +108,7 @@ module Hbtrack
         save_to_file(habit, 'Add') unless habit.nil?
         return
       end
-      puts Hbtrack::CLI.blue("#{habit_name} already existed!")
+      puts CLI.blue("#{habit_name} already existed!")
     end
 
     def done(args)
@@ -124,7 +146,7 @@ module Hbtrack
 
     def create(habit_name)
       unless invalid_habit_name?(habit_name)
-        habit = Hbtrack::Habit.new(habit_name)
+        habit = Habit.new(habit_name)
         @habits << habit
         return habit
       end
@@ -143,12 +165,13 @@ module Hbtrack
     end
 
     def get_day_based_on(options)
-      return Date.today unless options[0] == '-y'
+      yesterday = options[0] == '-y' || options[0] == '--yesterday'
+      return Date.today unless yesterday
       Date.today - 1
     end
 
     def raise_error_msg(msg)
-      puts Hbtrack::CLI.red msg 
+      puts CLI.red msg 
       return
     end
 
@@ -158,7 +181,7 @@ module Hbtrack
     end        
 
     def raise_habit_not_found(habit_name)
-      raise_error_msg "Invalid argument: #{habit_name} not found."
+      raise_error_msg "Invalid habit: #{habit_name} not found."
     end
 
     def raise_invalid_arguments 
@@ -187,7 +210,7 @@ module Hbtrack
         yield if block_given?
         save
         output = "#{action} #{habit.name}!"
-        puts Hbtrack::CLI.public_send(color, output)
+        puts CLI.public_send(color, output)
       end
     end
   end

data/lib/hbtrack/stat_formatter.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Hbtrack
+  # This is an abstract class for classes that
+  # are used to format the progress of a Habit
+  # into string
+  class StatFormatter
+    def initialize
+    end
+
+    def format
+      raise "Not Implemented"
+    end
+  end
+
+  class DoneUndoneSF < StatFormatter
+    # Format in terms of the count of done and undone.
+    # @param hash [Hash]
+    # @option hash [String] :done total of done
+    # @option hash [String] :undone total of undone
+    # @return [String] formatted result
+    def format(hash)
+      CLI.green("Done: #{hash[:done]}") + "\n" +
+      CLI.red("Undone: #{hash[:undone]}")
+    end
+  end
+
+  class CompleteSF < StatFormatter
+    # Format in terms of the total and the count of
+    # done and undone.
+    # @param hash [Hash]
+    # @option hash [String] :done total of done
+    # @option hash [String] :undone total of undone
+    # @return [String] formatted result
+    def format(hash)
+      total = hash[:done] + hash[:undone]
+      "All: #{total}, Done: #{hash[:done]}, Undone: #{hash[:undone]}"
+    end
+  end
+
+  class CompletionRateSF < StatFormatter
+    # Format in terms of the completion rate of the habit.
+    # @param hash [Hash]
+    # @option hash [String] :done total of done
+    # @option hash [String] :undone total of undone
+    # @return [String] formatted result
+    def format(hash)
+      percentage = to_percentage(hash)[:done]
+      "Completion rate: #{'%.2f' % percentage}%"
+    end
+
+    # Convert the value in the hash into percentage
+    # @param hash [Hash]
+    # @option hash [String] :done total of done
+    # @option hash [String] :undone total of undone
+    # @return [Hash] formatted result
+    def to_percentage(hash)
+      total = hash[:done] + hash[:undone]
+      done_p = 0
+      undone_p = 0
+      unless total == 0
+        done_p = hash[:done] / total.to_f * 100
+        undone_p = hash[:undone] / total.to_f * 100
+      end
+      { done: done_p, undone: undone_p }
+    end
+  end
+end
+

data/lib/hbtrack/util.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Hbtrack
+  # This class contains the methods that 
+  # are used to format the progress of a Habit
+  # into string
+  class Util
+
+    class << self
+
+      # Format the string with title style.
+      #
+      # @param string [String] the string to be styled as title
+      # @return [Nil]
+      # 
+      # == Example
+      #
+      #   puts Util.title("Title")
+      #   # Title
+      #   # -----
+      #   #=> nil 
+      def title(string) 
+        string + "\n" + 
+        "-" * string.length + "\n"
+      end
+
+      # Convert key into date in string form.
+      # 
+      # @param key [Symbol] The key of the progress in the 
+      #   form of :'year, month'. Example: :"2017,7"
+      # @param no_of_space [Numeric] number of space to be 
+      #   added in front
+      # @return [String] a string in date form.
+      # 
+      # == Example
+      #
+      #   Util.convert_key_to_date(:"2017,7", 0)
+      #   #=> "July 2016 : "
+      def convert_key_to_date(key, no_of_space)
+        year = key.to_s.split(",")[0]
+        ' ' * no_of_space + get_month_from(key) + 
+        " #{year}" + " : "
+      end
+
+      # Format the current month and year into string
+      # 
+      # @return [String] Month and Year in String.
+      # 
+      # == Example
+      #
+      #  Util.current_month
+      #  #=> "August 2017"
+      def current_month
+        Date.today.strftime("%B %Y")
+      end
+
+      # Get the month in string form from given key
+      #
+      # @param key [Symbol] The key of the progress
+      # @return [String] month
+      #
+      # == Example
+      #   
+      #   Util.get_month_from(:"2017,7")
+      #   #=> "July"
+      def get_month_from(key)
+        key = key.to_s.split(',')
+        Date::MONTHNAMES[key[1].to_i]
+      end
+    end
+  end
+end
+

data/lib/hbtrack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hbtrack
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/hbtrack.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
 require 'hbtrack/habit_tracker'
+require 'hbtrack/version'
+require 'hbtrack/cli'
+require 'hbtrack/util'
+require 'hbtrack/config'
+require 'hbtrack/habit'
+require 'hbtrack/stat_formatter'
+require 'hbtrack/habit_printer'
 
 module Hbtrack
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hbtrack
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - kw7oe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Habit Tracker CLI. A CLI to track your habits.
+description: Habit Tracker CLI
 email:
 - choongkwern@hotmail.com
 executables:
@@ -72,7 +72,10 @@ files:
 - lib/hbtrack/cli.rb
 - lib/hbtrack/config.rb
 - lib/hbtrack/habit.rb
+- lib/hbtrack/habit_printer.rb
 - lib/hbtrack/habit_tracker.rb
+- lib/hbtrack/stat_formatter.rb
+- lib/hbtrack/util.rb
 - lib/hbtrack/version.rb
 homepage: https://github.com/kw7oe/hbtrack
 licenses:
@@ -94,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A CLI to track your habits.