hbtrack 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6548ef2dc5d0749d46b22a6efa32862a394dc92
+  data.tar.gz: f0c93fbc9490a2e9edb909b022efa775828120eb
+SHA512:
+  metadata.gz: c75506ae3edd3e8593ed1c679a82581ce450dd7073357a9f5e65e0fcac6029392fd6b9a2b0a2869716d2ccf98733ff9169ed730bbfb37680a97992b5c79ff6b7
+  data.tar.gz: c10a01dbb04a7f1f9610211c5c1c6afb8cc93bb9850d2cac0abf0ab09dffe2f3be2191aca76f3ef8ae8ea91164ab6ac2d915de03a09ea1faac3bd7499187a161

data/.gitignore

@@ -0,0 +1,16 @@
+.DS_Store
+.rubocop.yml
+test/test_output
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+*.gemspec
+
+

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at choongkwern@hotmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in apple.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Choong Kai Wern
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,7 @@
+#### Hbtrack
+
+TODO: Add intro
+
+#### Installation
+
+TODO

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/exe/hbtrack

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'hbtrack'
+Hbtrack.run(ARGV)

data/lib/hbtrack/cli.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# A class that contains the helper methods
+# used for CLI.
+module Hbtrack
+  class CLI
+    FONT_COLOR = {
+      green: "\e[32m",
+      red: "\e[31m",
+      blue: "\e[34m"
+    }.freeze
+
+    class << self
+      # Define CLI.green, CLI.red, CLI.blue
+      # which colorize string output in terminal
+      FONT_COLOR.each do |key, value|
+        define_method(key) do |string|
+          value + string + "\e[0m"
+        end
+      end
+    end
+  end
+end

data/lib/hbtrack/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Configuration for the application.
+module Hbtrack
+  # File to read during testing
+  TEST_FILE = 'test/test_data'
+
+  # File to write to during testing
+  OUTPUT_FILE = 'test/test_output'
+
+  # File to store your data
+  FILE_NAME = Dir.home + '/.habit'
+end

data/lib/hbtrack/habit.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'hbtrack/cli'
+
+module Hbtrack
+  # Habit provide a rich library to track the
+  # progress of your habit.  
+  class Habit
+    attr_accessor :name
+    attr_reader :progress
+
+    # Class Methods
+    class << self
+      # Generate hash key for progress based
+      # on date.
+      #
+      # Example
+      #
+      #   Habit.get_progress_key_from(Date.new(2017, 7, 18))
+      #   # => :"2017,7"
+      def get_progress_key_from(date)
+        date.strftime('%Y,%-m').to_sym
+      end
+
+      # Initialize Habit object from string.
+      #
+      # string - The string to be parse.
+      #
+      # Example
+      #
+      #   Habit.initialize_from_string("workout\n2017,6:1001")
+      #   # => #<Habit:0x007f9be6041b70 @name="workout",
+      #   #    @progress={:"2017,6"=>"1001"}>
+      #
+      #   Habit.initialize_from_string("")
+      #   # => nil
+      def initialize_from_string(string)
+        return nil if string.empty?
+        arr = string.split("\n")
+        habit_name = arr.shift
+        hash = {}
+        arr.each do |s|
+          a = s.split(':')
+          hash[a[0].to_sym] = a[1]
+        end
+        Habit.new(habit_name, hash)
+      end
+    end
+
+    # Public APIs
+    def initialize(name,
+                   progress = {
+                     Habit.get_progress_key_from(Date.today) => ' '
+                   })
+      @name = name
+      @progress = progress
+    end
+
+    def name_length
+      name.length
+    end
+
+    def latest_progress
+      key = Habit.get_progress_key_from(Date.today)
+      progress[key]
+    end
+
+    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|
+        convert_key_to_date(key) + pretty_print_progress(value)
+      end.join("\n")
+    end
+
+    def pretty_print_latest(no_of_space = 0)
+      name.to_s + ' ' * no_of_space + ' : ' +
+        pretty_print_progress(latest_progress)
+    end
+
+    def pretty_print_progress(progress_value)
+      stat = progress_value.lstrip.split('').map do |x|
+        x == '0' ? Hbtrack::CLI.red('*') : Hbtrack::CLI.green('*')
+      end.join('')
+      stat
+    end
+
+    def convert_key_to_date(key)
+      key = key.to_s.split(',')
+      "#{Date::MONTHNAMES[key[1].to_i]} #{key[0]}: "
+    end
+
+    def progress_output
+      arr = @progress.map do |key, value|
+        "#{key}:#{value}\n"
+      end
+      arr.join('')
+    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
+
+    def update_progress_for(key, day, done)
+      i = day - @progress[key].length
+      result = @progress[key].split('')
+      i.times { result << '0' }
+      result[day] = done ? '1' : '0'
+      @progress[key] = result.join('')
+    end
+  end
+end

data/lib/hbtrack/habit_tracker.rb

@@ -0,0 +1,139 @@
+# 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
+
+    def self.help # Refactoring needed
+      puts 'usage: hbtrack list [ habit_name ]'
+      puts '       hbtrack add habit_name'
+      puts '       hbtrack done habit_name'
+      puts '       hbtrack undone habit_name'
+    end
+
+    def initialize(file = Hbtrack::FILE_NAME,
+                   output = Hbtrack::FILE_NAME)
+      @habits = []
+      @file_name = file
+      @output_file_name = output
+      initialize_habits_from_file
+    end
+
+    def parse_arguments(args)
+      head = args.shift
+      tail = args
+      send(head, tail)
+    end
+
+    # This methods find a habit based on the name given.
+    # Blocks are executed when habit is not found.
+    def find(habit_name)
+      habit = @habits.find do |h|
+        h.name == habit_name
+      end
+      yield if habit.nil? && block_given?
+      habit
+    end
+
+    def longest_name
+      @habits.max_by(&:name_length).name
+    end
+
+    private
+
+    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) }
+    end
+
+    def list(args)
+      habit_name, _options = parse_options(args)
+      habit = find(habit_name) do
+        @habits.each_with_index do |h, index|
+          space = longest_name.length - h.name_length
+          puts "#{index + 1}. #{h.pretty_print_latest(space)}"
+        end
+        return
+      end
+      puts habit.pretty_print_all
+    end
+
+    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!")
+        return
+      end
+      puts Hbtrack::CLI.blue("#{habit_name} already existed!")
+    end
+
+    def done(args)
+      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
+    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
+    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
+    end
+
+    def find_or_create(habit_name)
+      habit = find(habit_name) do
+        habit = Hbtrack::Habit.new(habit_name)
+        @habits << habit
+      end
+      habit
+    end
+
+    def parse_options(args)
+      options = args.select { |x| x =~ /\A-/ }
+      args -= options
+      [args[0], options]
+    end
+
+    def get_day_based_on(options)
+      return Date.today unless options[0] == '-y'
+      Date.today - 1
+    end
+
+    def raise_habit_not_found
+      puts Hbtrack::CLI.red "#{habit_name} not found."
+    end
+
+    def save
+      File.open(@output_file_name, 'w') do |f|
+        @habits.each do |habit|
+          f.puts habit
+        end
+      end
+    end
+  end
+end
+
+

data/lib/hbtrack/version.rb

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

data/lib/hbtrack.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'hbtrack/habit_tracker'
+
+module Hbtrack
+  class << self
+    def run *args
+      if ARGV.empty?
+        HabitTracker.help
+      else
+        HabitTracker.new.parse_arguments(*args)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: hbtrack
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- kw7oe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Habit Tracker CLI
+email:
+- choongkwern@hotmail.com
+executables:
+- hbtrack
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/hbtrack
+- lib/hbtrack.rb
+- lib/hbtrack/cli.rb
+- lib/hbtrack/config.rb
+- lib/hbtrack/habit.rb
+- lib/hbtrack/habit_tracker.rb
+- lib/hbtrack/version.rb
+homepage: https://github.com/kw7oe/hbtrack
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A CLI to track your habits.
+test_files: []