hbtrack 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d846c3fab2b780d7be575138918e3cbf97b6dc7d
-  data.tar.gz: 8b329428683139a92294fa6ba8bebc1b5611ab1f
+SHA256:
+  metadata.gz: 5639d955118b59c2133db7f8bb40d2337acb3c1bb964d232479fca54bd033e3d
+  data.tar.gz: cbca26eabc6a9e21829a22bcaff269f5ef74271501cf2f7d5b06614f22cb7f1f
 SHA512:
-  metadata.gz: b845ed06eb8ae37e4857bda84bc691fee6f81f007bfb95f3ddf9e47691a762d88839e098834a22067fc838b6ab31144dea04151760b1026a1d6b1afd89a19f47
-  data.tar.gz: 880729c315b22e13509a0fe1cc9bbf20a4ada8f0255d4f10082649f0e3772fd107d4a7fb2ceed035cfa71cc42c11da09cfe26afd41c91dc600bf176763d9da47
+  metadata.gz: 9f220af89c62ff71081cb0a7a9237b20f0e8eeb955d5672c936a04aa4f69409f0a4b69b68451283b513a66493370bf4db4f4721c56570a9854a3d54fa968f918
+  data.tar.gz: 1bdf736adb20598592ecfc513c9ddddb4e21e0965b1238fbe7f440f29644fb2cfca59dda2afe3c284eb46547489c221209ed1d71835ed4e8c6fe2b2ef26a287d

data/.gitignore

@@ -12,5 +12,6 @@ test/test_output
 /tmp/
 *.gem
 *.html
+*.db
 
 

data/.travis.yml

@@ -1,6 +1,14 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=b2258e835c1b69dc14aef5dcb4d3e0b9153810b0e4e86cb702955164a514043f
 language: ruby
 cache: bundler
 rvm:
   - 2.4.2
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 script: "bundle exec rspec"     
-
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/README.md

@@ -1,10 +1,11 @@
-# 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
+[![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)
 [![Code Climate](https://codeclimate.com/github/kw7oe/hbtrack/badges/gpa.svg)](https://codeclimate.com/github/kw7oe/hbtrack)
+[![Test Coverage](https://codeclimate.com/github/kw7oe/hbtrack/badges/coverage.svg)](https://codeclimate.com/github/kw7oe/hbtrack/coverage)
 
 
-`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.
 
 ## Installation
 
@@ -13,7 +14,6 @@ gem install hbtrack
 ```
 
 ## Usage
-
 ```
 Usage: hbtrack <command> [<habit_name>] [options]
 
@@ -21,75 +21,24 @@ Commands:
      add: Add habit(s)
      remove: Remove habit(s)
      list: List habit(s)
+     show: Show habit
      done: Mark habit(s) as done
      undone: Mark habit(s) as undone
+     import: Import data from files
 
 Options:
      -h, --help   Show help messages of the command
 ```
 
-**Note:** For more details about available options for each command, type `hbtrack <command> -h` 
-
-## 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
-- [ ] Generate report in HTML format. *(In Progress)*
-
-## Output
-
-### List all habits:
-```
-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
-```
-
-**Note:** The actual output is colorized where green color font indicate done and red color font indicate undone.
-
-### List a habit:
-```
-workout
--------
-     July 2017 : ******************************* All: 31, Done: 26, Undone: 5
-   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.
-
-
-```
-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%
-```
+For more details, `hbtrack <command> --help`
 
 ## 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:
+### For version `>= 0.0.7`
+The data are  stored in `sqlite3` database, which is located at `~/.habit.db`. So if you have updated to the latest version, you can import your data from `.habit` by using the commnd `hbtrack import 'YOUR_HOME_DIRECTORY/.habit'`
+
+### For version prior to `0.0.7`
+The data is stored in your home directory, in file named `.habit`. In Unix/Unix-like system, you can directly edit the file by:
 
 ```
 vim ~/.habit
@@ -106,7 +55,7 @@ workout
 
 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. 
+* `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.
@@ -121,10 +70,8 @@ read
 ```
 
 ## Bugs/Features
-The project is still under development. 
+The project is still under development.
 
 If there are any bugs/features request, feel free to create a new issues.
 
 
-
-

data/bin/irb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'hbtrack'
+require 'irb'
+IRB.start

data/exe/hbtrack

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'bundler/setup'
 require 'hbtrack'
-Hbtrack.run(ARGV)
+
+Hbtrack::CLI.run(ARGV)

data/hbtrack.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 # frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
@@ -25,5 +24,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'sequel', '~> 5.4'
+  spec.add_dependency 'sqlite3'
 end

data/lib/hbtrack.rb

@@ -1,50 +1,10 @@
 # frozen_string_literal: true
 
-require 'hbtrack/habit_tracker'
-require 'hbtrack/habit'
 require 'hbtrack/config'
 require 'hbtrack/stat_formatter'
-require 'hbtrack/habit_printer'
-require 'hbtrack/command/list_command'
-require 'hbtrack/command/update_command'
-require 'hbtrack/command/remove_command'
-require 'hbtrack/command/add_command'
+require 'hbtrack/importer/streaks_importer'
+require 'hbtrack/importer/hbtrack_importer'
+require 'hbtrack/database/sequel_store'
 require 'hbtrack/error_handler'
+require 'hbtrack/cli/cli'
 
-module Hbtrack
-  class << self
-    def run(args)
-      hbt = HabitTracker.new
-      command = case args.shift
-                when 'list'
-                  ListCommand.new(hbt, args)
-                when 'done'
-                  UpdateCommand.new(hbt, args, true)
-                when 'undone'
-                  UpdateCommand.new(hbt, args, false)
-                when 'remove'
-                  RemoveCommand.new(hbt, args)
-                when 'add'
-                  AddCommand.new(hbt, args)
-                else
-                  help
-                end
-      puts command.execute
-    end
-
-    def help
-      puts 'Usage: hbtrack <command> [<habit_name>] [options]'
-      puts
-      puts 'Commands:'
-      puts '     add: Add habit(s)'
-      puts '     remove: Remove habit(s)'
-      puts '     list: List habit(s)'
-      puts '     done: Mark habit(s) as done'
-      puts '     undone: Mark habit(s) as undone'
-      puts
-      puts 'Options:'
-      puts "     -h, --help\t\tShow help messages of the command"
-      exit
-    end
-  end
-end

data/lib/hbtrack/cli/cli.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'hbtrack/command/list_command'
+require 'hbtrack/command/show_command'
+require 'hbtrack/command/update_command'
+require 'hbtrack/command/remove_command'
+require 'hbtrack/command/add_command'
+require 'hbtrack/command/import_command'
+
+module Hbtrack
+  module CLI
+    class << self
+      def run(store_path = DB_PATH, args)
+        command = case args.shift
+                  when 'list'
+                    ListCommand.new(store_path, args)
+                  when 'show'
+                    ShowCommand.new(store_path, args)
+                  when 'done'
+                    UpdateCommand.new(store_path, args, true)
+                  when 'undone'
+                    UpdateCommand.new(store_path, args, false)
+                  when 'remove'
+                    RemoveCommand.new(store_path, args)
+                  when 'add'
+                    AddCommand.new(store_path, args)
+                  when 'import'
+                    ImportCommand.new(store_path, args)
+                  else
+                    help
+                  end
+        puts command.execute
+      end
+
+      def help
+        puts 'Usage: hbtrack <command> [<habit_name>] [options]'
+        puts
+        puts 'Commands:'
+        puts '     add: Add habit(s)'
+        puts '     remove: Remove habit(s)'
+        puts '     list: List habit(s)'
+        puts '     show: Show habit'
+        puts '     done: Mark habit(s) as done'
+        puts '     undone: Mark habit(s) as undone'
+        puts '     import: Import data from files'
+        puts
+        puts 'Options:'
+        puts "     -h, --help\t\tShow help messages of the command"
+        exit
+      end
+    end
+  end
+end

data/lib/hbtrack/cli/view.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'hbtrack/util'
+
+module Hbtrack
+  module CLI
+    module View
+      extend self
+
+      # Create the string output of command
+      # `hbtrack list` a.k.a ListCommand.list_all
+      def list_all_habits(habits, entries, month_key)
+        date = Util.get_date_from(key: month_key)
+        Util.title(date.strftime('%B %Y')) +
+          print_habits(habits, entries)
+     end
+
+      def show_habit(habit, entries)
+        Util.title(habit[:title]) +
+          print_entries(entries)
+      end
+
+      # Create the string representation of
+      # the habits and its entries to be presented
+      # to the user
+      def print_habits(habits, entries)
+        char_count = max_char_count habits.map { |h| h[:title] }
+        habits.map.with_index(1) do |habit, index|
+          title = habit[:title]
+          print_habit(index, title, entries[title], char_count - title.size)
+        end.join("\n")
+      end
+
+      # Create the string representation of
+      # a habit and its entries to be presented
+      # to the user
+      def print_habit(index, title, entry, space = 0)
+        "#{index}. #{title}#{' ' * space} : " +
+        convert_entry_to_view(entry)
+      end
+
+      # Create the string representation of
+      # a hash of entries.
+      def print_entries(entries)
+        char_count = max_char_count entries.keys
+        entries.map do |month, entry|
+          print_entry(month, entry, char_count - month.size)
+        end.join("\n")
+      end
+
+      # Create the string representation of
+      # an entry with its date period. E.g
+      # "September 2017".
+      def print_entry(period, entry, space)
+        "#{period}#{' ' * space} : " + convert_entry_to_view(entry)
+      end
+
+      # Create the string representation of
+      # a entry to be presented to the user
+      def convert_entry_to_view(entry)
+        max_day_of_month = 31
+        index = 0
+        result = Array.new(max_day_of_month, ' ')
+        entry.each do |e|
+          date = e[:timestamp]
+          index = date.day
+          result[index - 1] = convert_status_to_view(e[:type])
+        end
+        result.slice!(0, index).join('')
+      end
+
+      # Create the string representation of
+      # a status and colorized it accordingly
+      def convert_status_to_view(status)
+        return Util.green '*' if status.start_with? 'completed'
+        return Util.red '*'
+      end
+
+      # Iterate through an array of string
+      # to find the largest character count
+      # from the array of string.
+      def max_char_count(strings)
+        strings.map(&:size).max
+      end
+    end
+  end
+end

data/lib/hbtrack/command.rb

@@ -1,16 +1,21 @@
 # frozen_string_literal: true
 
+require 'hbtrack/database/sequel_store'
+
 module Hbtrack
   class Command
-    def initialize(hbt, options)
-      @hbt = hbt
+    def initialize(store_path, options)
       @all = false
       @option_parser = create_option_parser
-
+      @store_path = store_path
       unprocess_option = @option_parser.parse(options)
       @names = unprocess_option
     end
 
+    def local_store
+      @store ||= Hbtrack::Database::SequelStore.new(name: @store_path)
+    end
+
     def execute
       help
     end

data/lib/hbtrack/command/add_command.rb

@@ -2,16 +2,19 @@
 
 require 'optparse'
 require 'hbtrack/command'
-require 'hbtrack/store'
 
 module Hbtrack
+  # AddCommand class is responsible for handling
+  # `hbtrack add` command in CLI
   class AddCommand < Command
-    def initialize(hbt, options)
-      super(hbt, options)
+    def initialize(store_path, options)
+      super(store_path, options)
     end
 
     def execute
-      return add(@names) unless @names.empty?
+      unless @names.empty?
+        return add_to_db(@names, local_store)
+      end
       super
     end
 
@@ -21,28 +24,31 @@ module Hbtrack
       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
+    def feedback(names, added)
+      output = []
 
-      output = [
-        Hbtrack::Util.green("Add #{added.join(',')}!")
-      ]
+      unless added.empty?
+        output << Hbtrack::Util.green("Add #{added.join(',')}!")
+        output << "\n"
+        names -= added
+      end
 
-      names -= added
       unless names.empty?
-        output << "\n"
         output << Hbtrack::Util.blue("#{names.join(',')} already existed!")
       end
 
       output.join
     end
+
+    def add_to_db(names, store)
+      order = store.get_habits_count
+      names.each do |name|
+        order = order + 1
+        habit = Hbtrack::Database::Habit.new(name, order)
+        store.add_habit(habit)
+      end
+      feedback(names, names)
+    end
+
   end
 end