1hdoc 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6858c51ee5e5515c03900f8060fe672a4f899a45
+  data.tar.gz: 7f5b95cdb98bf60fc42dab7dfb20ab7c61eea76a
+SHA512:
+  metadata.gz: 43b32f3517660ac29cc340bb208117e3560037c2a0d32243a93dcb4c3d9fbe05833482aa96e024e7cec1daaa5eaac2cd80753074af6db4207957f5cdc32da809
+  data.tar.gz: cfc91d0e61f6c9fb00c96e65dbc3158eace822362f9c14195d603c56b1e77b866e28994f8d0967ab736ec8081ee288f2379bb005d42c617be23fd6d4573ca7ae

data/README.md

@@ -0,0 +1,117 @@
+# 1hdoc
+[![Code Climate](https://codeclimate.com/github/domcorvasce/1hdoc/badges/gpa.svg)](https://codeclimate.com/github/domcorvasce/1hdoc)
+[![Test Coverage](https://codeclimate.com/github/domcorvasce/1hdoc/badges/coverage.svg)](https://codeclimate.com/github/domcorvasce/1hdoc/coverage)
+[![Build Status](https://travis-ci.org/domcorvasce/1hdoc.svg?branch=master)](https://travis-ci.org/domcorvasce/1hdoc)
+
+Keep track of your progress during #100DaysOfCode event.
+## Warning
+It's still in development so you could meet some bugs.
+
+## Installation
+
+Install **1hdoc** from RubyGems:
+
+```shell
+gem install 1hdoc
+```
+
+or clone this repository and build the gem manually:
+
+```shell
+git clone https://github.com/domcorvasce/1hdoc
+cd 1hdoc
+
+gem build 1hdoc.gemspec
+gem install *.gem
+```
+
+## Getting Started
+
+You can get a list of available commands typing:
+
+```shell
+1hdoc --help
+```
+
+### Configure the necessary
+
+Here we are! Now you've to initialize all necessary files which are:
+  
+  - the [#100DaysOfCode's repository](https://github.com/Kallaway/100-days-of-code)
+  - the .1hdoc.yml configuration file
+
+Open your Terminal and type:
+
+```shell
+1hdoc --init
+```
+
+### Change repo's remote origin
+
+A final thing, you should edit the repo's remote origin so I can 
+push to your account.
+
+First of all, open GitHub or whatever you use and create a new empty repository.
+
+Now move to the **100-days-of-code** repo's folder and type:
+
+```shell
+git remote remove origin
+git remote add origin YOUR_REPO_URL
+```
+
+Hooray! We're done.
+
+### Register your progress
+
+Have you ended Day 2? 
+
+Great! Let's 1hdoc track your progress. Type:
+
+```shell
+1hdoc --commit
+```
+
+By default, 1hdoc will push to the repo automatically after you 
+register your progress. 
+
+You can change this behavior by assigning `false` to `auto_push` option in 
+`~/.1hdoc.yml`:
+
+```yaml
+workspace: ~/Workspace/Mine/100-days-of-code
+auto_push: false
+```
+
+### Manually push to the repo
+
+If you turn off `auto_push` you can push to the repo typing:
+
+```shell
+1hdoc --sync
+```
+
+### See progress
+
+Obviously you can see your progress:
+
+```shell
+1hdoc --log
+1hdoc --log=2 # only day 2
+```
+
+## Contribute
+
+Everyone can contribute to this project:
+
+  - Fixing bugs
+  - Fixing my bad english
+  - Proposing new features
+  - Improving code
+  - and doing a plethora of other things..
+  
+Feel free to open an issue and propose a pull request.
+
+## License
+
+**1hdoc** is released under terms of _GNU/GPL v3_ license.

data/bin/1hdoc

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require_relative '../lib/1hdoc'
+
+app = HDOC::Application.new
+app.run

data/lib/1hdoc/application.rb

@@ -0,0 +1,94 @@
+module HDOC
+  ##
+  # Provides an interface for interact with the program.
+  class Application
+    include Integration
+
+    AVAILABLE_COMMANDS = [
+      ['-i', '--init', 'Initialize necessary files.'],
+      ['-c', '--commit', 'Register your progress and sync it.'],
+      ['-s', '--sync', 'Manually synchronize your online repository.'],
+      ['-v', '--version', 'Show program version.']
+    ].freeze
+
+    def initialize(option_parser = OptionParser)
+      @option_parser = option_parser
+      @config_file = File.expand_path('~/.1hdoc.yml')
+
+      return init unless File.exist?(@config_file)
+
+      @config_options = Configuration.new(@config_file).options
+      @log_path = File.join(@config_options['workspace'], 'log.yml')
+      @repo = 'https://github.com/domcorvasce/100-days-of-code'
+    end
+
+    ##
+    # Parse defined options.
+    def run
+      options = initialize_options
+      options.parse!
+    rescue @option_parser::InvalidOption
+      puts options
+    end
+
+    private
+
+    def initialize_options
+      @option_parser.new do |opts|
+        opts.banner = 'Usage: 1hdoc -h'
+
+        AVAILABLE_COMMANDS.each do |command|
+          opts.on(*command) { send(command[1].sub('--', '')) }
+        end
+
+        opts.on('-l', '--log=[DAY]', 'Show the entire log or per day') do |day|
+          show_log(day)
+        end
+      end
+    end
+
+    ##
+    # Initialize necessary files such as the configuration file.
+    def init
+      print 'Type the full path for your new repo (ex. ~/works/my_repo): '
+      workspace = $stdin.gets.chomp
+
+      Configuration.init(@config_file, 'workspace' => File.expand_path(workspace),
+                                       'auto_push' => true)
+      Committer.init(@repo, workspace)
+
+      puts 'Here we are! You are ready to start.'
+    end
+
+    ##
+    # Track user's progress for the current day.
+    def commit
+      log_handler = LogBuilder.new(@log_path)
+      committer = Committer.new(@config_options['workspace'])
+
+      return puts 'You are done for today :)' unless log_handler.record_not_exist?
+
+      latest_day = log_handler.add(register_daily_commit)
+      committer.commit("Add Day #{latest_day}")
+
+      sync if @config_options['auto_push']
+    end
+
+    ##
+    # Show the entire log or per day.
+    def show_log(target_day)
+      log_viewer = LogViewer.new(@log_path)
+      puts log_viewer.show(target_day.to_i)
+    end
+
+    ##
+    # Manually push the daily commit to user's repository.
+    def sync
+      push_commit(@config_options['workspace'])
+    end
+
+    def version
+      puts '1hdoc ver' + VERSION
+    end
+  end
+end

data/lib/1hdoc/core/committer.rb

@@ -0,0 +1,27 @@
+module HDOC
+  ##
+  # Provides an interface for Git in order to manage user's repo.
+  class Committer
+    ##
+    # Initialize the workspace.
+    def self.init(repository, path, git = Git)
+      path = File.expand_path(path)
+
+      $stderr.puts 'Cloning #100DaysOfCode repository..'
+      git.clone(repository, path)
+    end
+
+    def initialize(path, git = Git)
+      @repo = git.open(path)
+    end
+
+    def commit(message)
+      @repo.add(all: true)
+      @repo.commit(message)
+    end
+
+    def push
+      @repo.push
+    end
+  end
+end

data/lib/1hdoc/core/configuration.rb

@@ -0,0 +1,20 @@
+module HDOC
+  ##
+  # Manage configuration files.
+  class Configuration
+    attr_reader :options
+    include Utilities
+
+    ##
+    # Initialize a new configuration file and write given options.
+    def self.init(path, options)
+      File.open(File.expand_path(path), 'w') do |configuration_file|
+        configuration_file.puts(options.to_yaml)
+      end
+    end
+
+    def initialize(path, config_parser = YAML)
+      @options = parse_file(expand_path(path), config_parser)
+    end
+  end
+end

data/lib/1hdoc/core/log_builder.rb

@@ -0,0 +1,46 @@
+module HDOC
+  ##
+  # Provides methods for manage user's log such as adding records.
+  class LogBuilder
+    attr_reader :log
+    include Utilities
+
+    def initialize(path, file_parser = YAML)
+      @path = expand_path(path)
+      @log = parse_file(@path, file_parser)
+
+      @today_date = Time.now.strftime('%Y-%m-%d')
+      @record = {}
+    end
+
+    ##
+    # Check if there is no record for the current day.
+    def record_not_exist?
+      last_day = @log.keys.last
+      last_day.nil? || @log[last_day]['published_on'] != @today_date
+    end
+
+    def add(data)
+      day = fetch_current_day
+
+      @record[day] = stringify_symbols(data)
+      @record[day]['published_on'] = @today_date
+
+      append_to_log
+    end
+
+    private
+
+    def append_to_log
+      File.open(@path, 'a') do |log|
+        log.puts @record.to_yaml.sub('---', '')
+      end
+
+      fetch_current_day
+    end
+
+    def fetch_current_day
+      (@log.keys.last || 0) + 1
+    end
+  end
+end

data/lib/1hdoc/core/log_viewer.rb

@@ -0,0 +1,49 @@
+module HDOC
+  ##
+  # Show the user's log in a human-readable way.
+  class LogViewer
+    include Utilities
+
+    def initialize(path, file_parser = YAML)
+      @path = expand_path(path)
+      @log = parse_file(@path, file_parser)
+    end
+
+    def show(target_day = 0)
+      result = ''
+
+      @log.each do |past_day, information|
+        next if target_day != 0 && target_day != past_day
+        result << format_log(past_day, information)
+      end
+
+      result
+    end
+
+    private
+
+    ##
+    # Format log's data in order to get something like:
+    #   ```
+    #   - Day 1 -
+    #     ** Progress **
+    #     Fixed CSS, worked on canvas functionality for the app.
+    #
+    #     ** Thoughts **
+    #     I really struggled with CSS.
+    #
+    #     -- Link to work: http://www.example.com/
+    #   ```
+    def format_log(day, data)
+      %(
+        |- Day #{day} -
+        |
+        |  ** Progress ** \n  #{data['progress']}
+        |
+        |  ** Thoughts ** \n  #{data['thoughts']}
+        |
+        |  -- Link to work: #{data['link']}
+      ).gsub(/ +\|/, '')
+    end
+  end
+end

data/lib/1hdoc/core/utilities.rb

@@ -0,0 +1,27 @@
+module HDOC
+  ##
+  # Implements methods and constants used by many independents classes.
+  module Utilities
+    ##
+    # Load log from a YAML file.
+    def parse_file(path, file_parser)
+      raise Errno::ENOENT, "Unable to find #{path}" unless File.exist?(path)
+      file_parser.load_file(path) || {}
+    end
+
+    ##
+    # Transform symbol's keys in string ones.
+    def stringify_symbols(hash_object)
+      hash_object.keys.each do |key|
+        next unless key.is_a?(Symbol)
+        hash_object[key.to_s] = hash_object.delete(key)
+      end
+
+      hash_object
+    end
+
+    def expand_path(path)
+      File.expand_path(path, File.dirname($PROGRAM_NAME))
+    end
+  end
+end

data/lib/1hdoc/integration.rb

@@ -0,0 +1,36 @@
+module HDOC
+  ##
+  # Provides methods used across various commands.
+  module Integration
+    QUESTIONS = {
+      progress: 'Your progress:',
+      thoughts: 'Your thoughts:',
+      link: 'Link to work:'
+    }.freeze
+
+    def push_commit(workspace)
+      committer = Committer.new(workspace)
+      committer.push
+      $stderr.puts 'Daily commit pushed with success!'
+    rescue Exception => exception
+      $stderr.puts exception.message
+    end
+
+    def register_daily_commit
+      record = {}
+
+      QUESTIONS.each do |key, question|
+        record[key] = ask(question)
+      end
+
+      record
+    end
+
+    private
+
+    def ask(message)
+      puts message
+      gets.chomp
+    end
+  end
+end

data/lib/1hdoc/version.rb

@@ -0,0 +1,3 @@
+module HDOC
+  VERSION = '0.1.3'.freeze
+end

data/lib/1hdoc.rb

@@ -0,0 +1,16 @@
+# stdlib
+require 'yaml'
+require 'optparse'
+require 'git'
+
+# 1hdoc core
+require_relative '1hdoc/core/utilities'
+require_relative '1hdoc/core/configuration'
+require_relative '1hdoc/core/committer'
+require_relative '1hdoc/core/log_builder'
+require_relative '1hdoc/core/log_viewer'
+
+# 1hdoc inteface
+require_relative '1hdoc/version'
+require_relative '1hdoc/integration'
+require_relative '1hdoc/application'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: 1hdoc
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Dom Corvasce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 'Keep track of your progress during #100DaysOfCode event.'
+email: dom.corvasce@yandex.com
+executables:
+- 1hdoc
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- bin/1hdoc
+- lib/1hdoc.rb
+- lib/1hdoc/application.rb
+- lib/1hdoc/core/committer.rb
+- lib/1hdoc/core/configuration.rb
+- lib/1hdoc/core/log_builder.rb
+- lib/1hdoc/core/log_viewer.rb
+- lib/1hdoc/core/utilities.rb
+- lib/1hdoc/integration.rb
+- lib/1hdoc/version.rb
+homepage: https://github.com/domcorvasce/1hdoc
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- git >= 1.6
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: "#100DaysOfCode CLI tracker"
+test_files: []