hbtrack 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f62e6b1a4c9978f97cd51b60ca91ea8508f945d1
-  data.tar.gz: 463768cf9d7ef99a486c06b0ca93d6ec34c3fc4f
+  metadata.gz: 4c701ca5b2187759928514a35a48855eb185fbdc
+  data.tar.gz: 8ec5d9cc6b2b90ca2bef90c4d72e32e9fe096844
 SHA512:
-  metadata.gz: b870785216a0d1371aeec39e7ff36aedcc57328cea1dfb21bafe1b588a6a26b1d2d404c656782b6b38925e707c5233eb82a2972cf00e773038841cba979da2e8
-  data.tar.gz: 7d219a47e955b3d647bdc88817c12bc390c4b8caf6fde3f1ee813d57aba42a83a11edeef5f89255ffdf94c4b7fce2c5479a6b9a3a68924a33cb8932e1cbbdef9
+  metadata.gz: c8c9ec66a9f2fc796ed2a9c0c8e113625ba57c9cef97b30f274333d78d0ab3bcc0168495778da4a53015d1391e2b35c9a2332c5059b3426ec1329fe713b2fa63
+  data.tar.gz: da70844a1d91bc5852b86d76c0ca66de58b77b0359d175dded7da052a7d8489a52df888a1bd4725637521e0ccebc4fad14826869a084545088437d107452b620

data/README.md

@@ -45,6 +45,42 @@ To look at individual habit progress:
 hbtrack list habit_name
 ```
 
+## Limitations
+
+For the current version, some invalid inputs are not handled properly.
+
+## Data
+
+All the data is stored in your home directory, in a hidden file named `.habit`. In Unix/Unix-like system, you can directly edit the file by:
+
+```
+vim ~/.habit
+
+```
+
+All the data is stored in the form of:
+
+```
+workout
+2017,6: 111111100000110100110000000001
+2017,7: 11111111111111111111
+```
+
+The first line represent the name of the habit. The second rows onward represent the progress of the habit for each month. More details:
+
+* `2017,6` represent your progress during June 2017. 
+* `1` is used to represent done.
+* `0` is used to represent undone.
+* Each habit is seperated by a newline. For example:
+
+```
+workout
+2017,7: 11111111111111111111
+
+read
+2017,7: 11111111111110011111
+```
+
 ## Bugs/Features
 If there are any bugs/feature requesst, feel free to create a new issues.
 

data/lib/hbtrack/habit.rb

@@ -11,6 +11,7 @@ module Hbtrack
     attr_reader :progress
 
     # Class Methods
+
     class << self
       # Generate hash key for progress based
       # on date.
@@ -49,6 +50,7 @@ module Hbtrack
     end
 
     # Public APIs
+
     def initialize(name,
                    progress = {
                      Habit.get_progress_key_from(Date.today) => ' '
@@ -95,6 +97,13 @@ module Hbtrack
       "#{Date::MONTHNAMES[key[1].to_i]} #{key[0]}: "
     end
 
+    # Get all of the progress of the habit in string form
+    #
+    # Example:
+    # 
+    #   habit.progress_output
+    #   # => "2017,5: 0010001010\n2017,6: 000010010\n"
+    #
     def progress_output
       arr = @progress.map do |key, value|
         "#{key}:#{value}\n"
@@ -102,6 +111,33 @@ module Hbtrack
       arr.join('')
     end
 
+    def progress_stat
+      @progress.map do |key, value|
+        convert_key_to_date(key) + "\n" + 
+        progress_stat_output_for(key)
+      end.join("\n")
+    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].lstrip.length - undone
+      { done: done, undone: undone }
+    end
+
     def to_s
       "#{name}\n" + progress_output + "\n"
     end

data/lib/hbtrack/habit_tracker.rb

@@ -74,9 +74,8 @@ module Hbtrack
     def add(args)
       habit_name, _options = parse_options(args)
       find(habit_name) do
-        @habits << Hbtrack::Habit.new(habit_name)
-        save
-        puts Hbtrack::CLI.green("#{habit_name} added succesfully!")
+        habit = create(habit_name)
+        save_to_file(habit, "Add") unless habit.nil?
         return
       end
       puts Hbtrack::CLI.blue("#{habit_name} already existed!")
@@ -86,34 +85,42 @@ module Hbtrack
       habit_name, options = parse_options(args)
       day = get_day_based_on(options)
       habit = find_or_create(habit_name)
-      habit.done(true, day)
-      save
-      puts Hbtrack::CLI.green("Done #{habit_name}!") # Similar code
+      save_to_file(habit, "Done") do 
+        habit.done(true, day)
+      end
     end
 
     def undone(args)
       habit_name, options = parse_options(args)
       day = get_day_based_on(options)
-      habit = find(habit_name) { raise_habit_not_found }
-      habit.done(false, day)
-      save
-      puts Hbtrack::CLI.blue("Undone #{habit_name}!") # Similar code
+      habit = find(habit_name) { raise_habit_not_found(habit_name) }
+      save_to_file(habit, "Undone", "blue") do 
+        habit.done(false, day)
+      end
     end
 
     def remove(args)
       habit_name, _options = parse_options(args)
-      habit = find(habit_name) { raise_habit_not_found }
-      @habits.delete(habit)
-      save
-      puts Hbtrack::CLI.blue("#{habit_name} removed!") # Similar code
+      habit = find(habit_name) { raise_habit_not_found(habit_name) }
+      save_to_file(habit, "Remove", "blue") do 
+        @habits.delete(habit)
+      end      
     end
 
     def find_or_create(habit_name)
       habit = find(habit_name) do
+        habit = create(habit_name)       
+        return habit
+      end
+    end
+
+    def create(habit_name)
+      unless habit_name.nil? || habit_name =~ /\s+/
         habit = Hbtrack::Habit.new(habit_name)
         @habits << habit
+        return habit
       end
-      habit
+      puts Hbtrack::CLI.red("Invalid argument: habit_name is expected.")
     end
 
     def parse_options(args)
@@ -127,8 +134,10 @@ module Hbtrack
       Date.today - 1
     end
 
-    def raise_habit_not_found
-      puts Hbtrack::CLI.red "#{habit_name} not found."
+    def raise_habit_not_found(habit_name)
+      last_words = habit_name ? 'not found' : 'is expected'
+      habit_name ||= "habit_name"
+      puts Hbtrack::CLI.red "Invalid argument: #{habit_name} #{last_words}."
     end
 
     def save
@@ -138,6 +147,15 @@ module Hbtrack
         end
       end
     end
+
+    def save_to_file(habit, action, color = "green") 
+      unless habit.nil?
+        yield if block_given?
+        save
+        output = "#{action} #{habit.name}!"
+        puts Hbtrack::CLI.public_send(color, output)
+      end
+    end
   end
 end
 

data/lib/hbtrack/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hbtrack
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - kw7oe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-18 00:00:00.000000000 Z
+date: 2017-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler