hbtrack 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 202f4fe27cf01abbf78f19ca7a3fd075e151c9ad
-  data.tar.gz: d0433a6543c279963e4876f372f0147d23b376fe
+  metadata.gz: 36d2ea881a273459943278a8ed55e05162544426
+  data.tar.gz: 05f7cb9199065ab8eca1f558a4d7bda5dc971341
 SHA512:
-  metadata.gz: 33653f712de657b5fd7e40192a0d371f540a121740c265544c7dde950c221d7d8d58343e53d08105652de0e2e9f86af8344ec04e02cfa063aeb80e5a183d1565
-  data.tar.gz: be1d05fc272fbcf4a31ec40c92c5a7b49f4aa6ca5519424459b8e70963d7f581866b1265302f9b5896e8efe4f512fb0ca19a8b240633b8dbbc20428b6f62a68d
+  metadata.gz: 17b23168d92bb400ff17d5b6685268fb5aafbf3ed2f27e9a8685dea89e56316e3af7a4af0ab23f93ce1b525aab0d9746b84ac76714df560eb33ea03cf22cb5ba
+  data.tar.gz: 73b292c9e40a08ed498879ebba2c1c88f82f17a5d902c84aa4074f404341b01e457bbdcfe96729bf32c8f2de87dedb80bc78e92ee3792a4c5a18d736633d68e4

data/.gitignore

@@ -11,6 +11,6 @@ test/test_output
 /spec/reports/
 /tmp/
 *.gem
-*.gemspec
+*.html
 
 

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.2
+script: "bundle exec rspec"     
+

data/README.md

@@ -1,4 +1,4 @@
-## Hbtrack
+# Hbtrack [![Gem Version](https://badge.fury.io/rb/hbtrack.svg)](https://badge.fury.io/rb/hbtrack) [![Build Status](https://travis-ci.org/kw7oe/hbtrack.svg?branch=master)](https://travis-ci.org/kw7oe/hbtrack)
 
 `hbtrack` is a simple command lines tool to keep track of your daily habits. The functionality of the current version is very limited.
 
@@ -10,42 +10,36 @@ gem install hbtrack
 
 ## Usage
 
-#### Add a new habit
 ```
-$ hbtrack add habit_name
-```
-Duplicate habit name will be ignore. 
+Usage: hbtrack <command> [<habit_name>] [options]
 
-#### Mark habit as done/undone
-```
-$ hbtrack done habit_name
-```
-This will mark the current habit as done for the current day. 
+Commands:
+     add: Add habit(s)
+     remove: Remove habit(s)
+     list: List habit(s)
+     done: Mark habit(s) as done
+     undone: Mark habit(s) as undone
 
+Options:
+     -h, --help   Show help messages of the command
 ```
-$ 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` or `--yesterday` option: 
-```
-$ hbtrack done/undone -y habit_name
-```
+**Note:** For more details about available options for each command, type `hbtrack <command> -h` 
 
-#### Remove a habit 
-```
-$ hbtrack remove habit_name
-```
+## Features
+- [x] List all habits
+  - with completion rate or total/done/undone count
+- [x] Add single or multiple habits at once
+- [x] Mark:
+  - single or mutiple habits as done/undone
+  - remaining habits of as done/undone
+  - habit(s) as done for specific day with `--day DAY`
+- [x] Remove single or multiple habits at once
+- [x] Generate report in HTML format. *(In Progress)*
 
-#### Listing Progress
+## Output
 
-You can list all your habits progress by: 
-```
-$ hbtrack list 
-```
-This will list all the habits you added and its progress for the current month.
-
-**Output:** 
+### List all habits:
 ```
 August 2017
 -----------
@@ -62,12 +56,7 @@ All: 15, Done: 13, Undone: 2
 
 **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:**
+### List a habit:
 ```
 workout
 -------
@@ -75,13 +64,11 @@ workout
    August 2017 : ***                             All: 3, Done: 3, Undone: 0
 ```
 
+### List all habits with `-p`:
 
 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
 -----------
@@ -118,6 +105,7 @@ The first line represent the name of the habit. The second rows onward represent
 * `2017,6` represent your progress during June 2017. 
 * `1` is used to represent done.
 * `0` is used to represent undone.
+* Black space is used to represent not recorded/dayoff.
 * Each habit is seperated by a newline. For example:
 
 ```
@@ -129,7 +117,7 @@ read
 ```
 
 ## Bugs/Features
-The project is still in development. 
+The project is still under development. 
 
 If there are any bugs/features request, feel free to create a new issues.
 

data/hbtrack.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hbtrack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hbtrack'
+  spec.version       = Hbtrack::VERSION
+  spec.authors       = ['kw7oe']
+  spec.email         = ['choongkwern@hotmail.com']
+
+  spec.summary       = 'A CLI to track your habits.'
+  spec.description   = 'Habit Tracker CLI'
+  spec.homepage      = 'https://github.com/kw7oe/hbtrack'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'minitest', '~> 5.10'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/hbtrack/command/add_command.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'hbtrack/command'
+require 'hbtrack/store'
+
+module Hbtrack
+  class AddCommand < Command
+    def initialize(hbt, options)
+      super(hbt, options)
+    end
+
+    def execute
+      return add(@names) unless @names.empty?
+      super
+    end
+
+    def create_option_parser
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: hbtrack add [<habit_name>]'
+      end
+    end
+
+    def add(names)
+      added = []
+      names.each do |name|
+        @hbt.find(name) do
+          @hbt.create(name)
+          added << name
+        end
+      end
+
+      Store.new(@hbt.habits, @hbt.output_file_name).save
+
+      output = [
+        Hbtrack::Util.green("Add #{added.join(',')}!")
+      ]
+
+      names -= added
+      unless names.empty?
+        output << "\n"
+        output << Hbtrack::Util.blue("#{names.join(',')} already existed!")
+      end
+
+      output.join
+    end
+  end
+end

data/lib/hbtrack/command/list_command.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'hbtrack/command'
+
+module Hbtrack
+  class ListCommand < Command
+    attr_reader :printer, :formatter
+
+    def initialize(hbt, options)
+      @percentage = false
+
+      super(hbt, options)
+      @formatter = @percentage ? CompletionRateSF.new : CompleteSF.new
+      @printer = HabitPrinter.new(@formatter)
+    end
+
+    def execute
+      return list_all(@printer) if @all
+      return list(@names[0], @printer) unless @names.empty?
+      super
+    end
+
+    def create_option_parser
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: hbtrack list [<habit_name>] [options]'
+        opts.separator ''
+        opts.separator 'Options:'
+
+        opts.on('-p', '--percentage', 'List habit(s) with completion rate') do
+          @percentage = true
+        end
+
+        opts.on('-a', '--all', 'List all habits') do
+          @all = true
+        end
+
+        opts.on_tail('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    def list(name, printer)
+      habit = @hbt.find(name) do
+        return ErrorHandler.raise_habit_not_found(name)
+      end
+
+      title = Util.title habit.name
+      progress = printer.print_all_progress(habit)
+      footer = "\n" + habit.overall_stat_description(printer.formatter)
+
+      "#{title}#{progress}\n#{footer}"
+    end
+
+    def list_all(printer)
+      return Util.blue 'No habits added yet.' if @hbt.habits.empty?
+
+      title = Util.title Util.current_month
+      progress = @hbt.habits.each_with_index.map do |h, index|
+        space = @hbt.longest_name.length - h.name_length
+        "#{index + 1}. " \
+        "#{printer.print_latest_progress(h, space)}"
+      end.join("\n")
+      footer = "\n" + @hbt.overall_stat_description(@formatter)
+
+      "#{title}#{progress}\n#{footer}"
+    end
+  end
+end

data/lib/hbtrack/command/remove_command.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'hbtrack/command'
+require 'hbtrack/store'
+
+module Hbtrack
+  class RemoveCommand < Command
+    def initialize(hbt, options)
+      super(hbt, options)
+    end
+
+    def execute
+      return remove(@names) if @names
+      super
+    end
+
+    def create_option_parser
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: hbtrack remove [<habit_name>]'
+      end
+    end
+
+    def remove(names)
+      names.each do |name|
+        habit = @hbt.find(name) do
+          return ErrorHandler.raise_if_habit_error(name)
+        end
+
+        @hbt.habits.delete(habit)
+      end
+
+      Store.new(@hbt.habits, @hbt.output_file_name).save
+      Hbtrack::Util.blue("Remove #{names.join(',')}!")
+    end
+  end
+end

data/lib/hbtrack/command/update_command.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'hbtrack/command'
+require 'hbtrack/store'
+
+module Hbtrack
+  class UpdateCommand < Command
+    def initialize(hbt, options, is_done)
+      @day = Date.today
+      @is_done = is_done
+      @remaining = false
+      super(hbt, options)
+    end
+
+    def execute
+      return update_remaining(@day, @is_done) if @remaining
+      return update_all(@day, @is_done) if @all
+      return update(@names, @day, @is_done) if @names
+      super
+    end
+
+    def create_option_parser
+      action = @is_done ? 'Done' : 'Undone'
+      OptionParser.new do |opts|
+        opts.banner = "Usage: hbtrack #{action.downcase} [<habit_name>] [options]"
+        opts.separator ''
+        opts.separator 'Options:'
+        opts.on('-a', '--all', "#{action} all habits") do
+          @all = true
+        end
+
+        opts.on('-r', '--remaining', "#{action} remaining habits") do
+          @remaining = true
+        end
+
+        opts.on('-y', '--yesterday', "#{action} habit(s) for yesterday") do
+          @day = Date.today - 1
+        end
+
+        opts.on('--day DAY', OptionParser::OctalInteger, "#{action} habit(s) for specific day") do |day|
+          @day = Date.new(Date.today.year, Date.today.month, day.to_i)
+        end
+
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    def update(names, day, is_done)
+      names.each do |name|
+        habit = if is_done
+                  @hbt.find_or_create(name)
+                else
+                  @hbt.find(name) do
+                    return ErrorHandler.raise_if_habit_error(name)
+                  end
+                end
+
+        habit.done(is_done, day)
+      end
+
+      Store.new(@hbt.habits, @hbt.output_file_name).save
+
+      Hbtrack::Util.green("#{action(is_done)} #{names.join(',')}!")
+    end
+
+    def update_all(day, is_done)
+      @hbt.habits.each { |habit| habit.done(is_done, day) }
+
+      Store.new(@hbt.habits, @hbt.output_file_name).save
+
+      Hbtrack::Util.green("#{action(is_done)} all habits!")
+    end
+
+    def update_remaining(day, is_done)
+      @hbt.habits.each do |habit|
+        habit.done(is_done, day) if habit.done_for(date: day).nil?
+      end
+
+      Store.new(@hbt.habits, @hbt.output_file_name).save
+
+      Hbtrack::Util.green("#{action(is_done)} remaining habit(s)!")
+    end
+
+    private
+
+    def action(is_done)
+      is_done ? 'Done' : 'Undone'
+    end
+  end
+end

data/lib/hbtrack/command.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Hbtrack
+  class Command
+    def initialize(hbt, options)
+      @hbt = hbt
+      @all = false
+      @option_parser = create_option_parser
+
+      unprocess_option = @option_parser.parse(options)
+      @names = unprocess_option
+    end
+
+    def execute
+      help
+    end
+
+    def create_option_parser
+      raise 'Not Implemented'
+    end
+
+    def help
+      @option_parser.help
+    end
+  end
+end

data/lib/hbtrack/error_handler.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Hbtrack
+  class ErrorHandler
+    class << self
+      def raise_error_msg(msg)
+        Util.red msg
+      end
+
+      def raise_if_habit_error(habit_name)
+        return raise_invalid_arguments if habit_name.nil?
+        raise_habit_not_found(habit_name)
+      end
+
+      def raise_habit_not_found(habit_name)
+        raise_error_msg "Invalid habit: #{habit_name} not found."
+      end
+
+      def raise_invalid_arguments
+        raise_error_msg 'Invalid argument: habit_name is expected.'
+      end
+
+      def raise_habit_name_too_long
+        raise_error_msg 'habit_name too long.'
+      end
+    end
+  end
+end

data/lib/hbtrack/habit.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
 require 'date'
+require 'hbtrack/util'
 
-module Hbtrack 
-
+module Hbtrack
   # Habit class
   class Habit
-    attr_accessor :name
-    attr_reader :progress
-
+    attr_accessor :name, :progress
     # Class Methods
 
     class << self
@@ -66,14 +64,12 @@ module Hbtrack
     end
 
     # Get the latest progress key.
-    # 
+    #
     # @return [Symbol] latest progress key
-    def latest_key  
+    def latest_key
       key = Habit.get_progress_key_from(Date.today)
-      if progress[key].nil?
-        initialize_progress_hash_from(key)
-      end
-      key     
+      initialize_progress_hash_from(key) if progress[key].nil?
+      key
     end
 
     # Get the latest progress.
@@ -90,12 +86,12 @@ module Hbtrack
       stat_for_progress(latest_key)
     end
 
-    # Find the month in progress with 
+    # Find the month in progress with
     # the longest name
-    # 
+    #
     # @return [String] month
     def longest_month
-      key = progress.keys.max_by do |x| 
+      key = progress.keys.max_by do |x|
         Util.get_month_from(x).length
       end
       Util.get_month_from(key)
@@ -103,7 +99,7 @@ module Hbtrack
 
     # Update the status of the progress
     #
-    # @param done [true, false] If true, it is marked as done. 
+    # @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]
@@ -113,17 +109,25 @@ module Hbtrack
       update_progress_for(key, date.day, done)
     end
 
+    # TODO: test needed
+    # Get the done status for specific date
+    #
+    # @return [Integer]
+    def done_for(date:) # TODO: Test needed
+      latest_progress.split('')[date.day - 1]
+    end
+
     # Get the stat of the progress.
     #
     # @param key [Symbol] key for the progress
-    # @return [Hash] stat of the progress in the form of 
+    # @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 = @progress[key].split('').count { |x| x == '1' }
       { done: done, undone: undone }
     end
 
@@ -141,11 +145,28 @@ module Hbtrack
       arr.join('')
     end
 
+    def overall_stat
+      done = 0
+      undone = 0
+      @progress.each do |key, _value|
+        stat = stat_for_progress(key)
+        done += stat[:done]
+        undone += stat[:undone]
+      end
+      { done: done, undone: undone }
+    end
+
+    def overall_stat_description(formatter)
+      Util.title('Total') +
+        formatter.format(overall_stat)
+    end
+
     def to_s
       "#{name}\n" + progress_output + "\n"
     end
 
     private
+
     def initialize_progress_hash_from(key)
       @progress[key] = '' unless @progress.key? key
     end
@@ -153,8 +174,8 @@ module Hbtrack
     def update_progress_for(key, day, done)
       i = day - @progress[key].length - 1
       result = @progress[key].split('')
-      i.times { result << '0' }
-      result[day-1] = done ? '1' : '0'
+      i.times { result << ' ' }
+      result[day - 1] = done ? '1' : '0'
       @progress[key] = result.join('')
     end
   end

data/lib/hbtrack/habit_printer.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
+require 'hbtrack/util'
+
 module Hbtrack
-  # This class contains the methods that 
+  # This class contains the methods that
   # are used to format the progress of a Habit
   # into string
   class HabitPrinter
+    attr_accessor :formatter
 
-    def initialize(stat_formatter)
-      @stat_formatter = stat_formatter
+    def initialize(formatter = CompleteSF.new)
+      @formatter = formatter
     end
 
     def calculate_space_needed_for(habit, key)
@@ -16,30 +19,35 @@ module Hbtrack
 
     def print_latest_progress(habit, no_of_space = 0)
       habit.name.to_s + ' ' * no_of_space + ' : ' +
-      print_progress(
-        habit.latest_progress, 
-        habit.latest_stat
-      )
+        print_progress(
+          habit.latest_progress,
+          habit.latest_stat
+        )
     end
 
     def print_all_progress(habit)
-      habit.progress.map do |key, value|        
+      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)
-        )
+          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('*')
+        if x == '0'
+          Util.red('*')
+        elsif x == '1'
+          Util.green('*')
+        else
+          ' '
+        end
       end.join('')
       output + ' ' * (32 - progress.size) +
-        @stat_formatter.format(stat)
+        @formatter.format(stat)
     end
   end
 end
-