1hdoc 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6858c51ee5e5515c03900f8060fe672a4f899a45
-  data.tar.gz: 7f5b95cdb98bf60fc42dab7dfb20ab7c61eea76a
+  metadata.gz: a84109594225740fa2b2a7696c0745d72f68b324
+  data.tar.gz: 546dddc52b368d64b4221c2407c4a0b394b5c3e0
 SHA512:
-  metadata.gz: 43b32f3517660ac29cc340bb208117e3560037c2a0d32243a93dcb4c3d9fbe05833482aa96e024e7cec1daaa5eaac2cd80753074af6db4207957f5cdc32da809
-  data.tar.gz: cfc91d0e61f6c9fb00c96e65dbc3158eace822362f9c14195d603c56b1e77b866e28994f8d0967ab736ec8081ee288f2379bb005d42c617be23fd6d4573ca7ae
+  metadata.gz: 6ed83b089e997708a403be343b83b0281ec8be37d2e0fc54524688c9459b527bcd09b8295f75e41317cf26490100796861914ed29835652d9b39b48be31cbc78
+  data.tar.gz: 6e739f455a58e9e010fa532e902ced6a435c7bb0a1a536d2e389057721eb2dcba6613c59abdf0f9bd493bdca43dedbbb91b13f59800e2f25bb98f443f3992f39

data/README.md

@@ -1,11 +1,6 @@
 # 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
 
@@ -43,7 +38,7 @@ Here we are! Now you've to initialize all necessary files which are:
 Open your Terminal and type:
 
 ```shell
-1hdoc --init
+1hdoc
 ```
 
 ### Change repo's remote origin
@@ -72,15 +67,14 @@ Great! Let's 1hdoc track your progress. Type:
 1hdoc --commit
 ```
 
-By default, 1hdoc will push to the repo automatically after you 
+By default, 1hdoc don't push to the repo automatically after you 
 register your progress. 
 
-You can change this behavior by assigning `false` to `auto_push` option in 
+You can change this behavior by assigning `true` to `auto_push` option in 
 `~/.1hdoc.yml`:
 
 ```yaml
-workspace: ~/Workspace/Mine/100-days-of-code
-auto_push: false
+:auto_push: true
 ```
 
 ### Manually push to the repo
@@ -88,16 +82,7 @@ auto_push: false
 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
+1hdoc --push
 ```
 
 ## Contribute

data/bin/1hdoc

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

data/lib/1hdoc/actions/commit.rb

@@ -0,0 +1,42 @@
+module HDOC
+  module Actions
+    ##
+    # Register the daily progress.
+    def commit
+      open_configuration_file
+      return $stderr.puts 'You are done for today :)' if record_already_exist?
+
+      register_daily_progress
+      commit_daily_progress
+      update_last_record_day
+    end
+
+    private
+
+    def record_already_exist?
+      @options[:last_commit_on] == Time.now.strftime('%Y-%m-%d')
+    end
+
+    def register_daily_progress
+      open_log
+      progress = Progress.new(@options[:day] + 1)
+
+      progress.register
+      @log.append(progress.format)
+    end
+
+    def commit_daily_progress
+      open_repository
+      @repository.commit("Add Day #{@options[:day] + 1}")
+
+      push if @options[:auto_push]
+    end
+
+    def update_last_record_day
+      @configuration.set :day, @configuration.options[:day] + 1
+      @configuration.set :last_commit_on, Time.now.strftime('%Y-%m-%d')
+
+      @configuration.update
+    end
+  end
+end

data/lib/1hdoc/actions/init.rb

@@ -0,0 +1,28 @@
+module HDOC
+  module Actions
+    ##
+    # Initialize the necessary files cloning the #100DaysOfCode's repo
+    # and create the configuration file in the user's $HOME path.
+    def init
+      puts 'Where I should locate the #100DaysOfCode repo (ex. ~/my_repo): '
+      @workspace = File.expand_path $stdin.gets.chomp
+
+      initialize_workspace
+      initialize_configuration_file
+
+      $stderr.puts 'Here we are! You are ready to go.'
+    end
+
+    private
+
+    def initialize_workspace
+      Repository.clone(ENVIRONMENT[:repository_url], @workspace)
+      Log.reset(File.join(@workspace, ENVIRONMENT[:log_file]))
+    end
+
+    def initialize_configuration_file
+      defaults = { auto_push: false, day: 0, workspace: @workspace }
+      Configuration.init(ENVIRONMENT[:configuration_file], defaults)
+    end
+  end
+end

data/lib/1hdoc/actions/push.rb

@@ -0,0 +1,10 @@
+module HDOC
+  module Actions
+    ##
+    # Push the progress to the repository.
+    def push
+      open_repository
+      @repository.push
+    end
+  end
+end

data/lib/1hdoc/actions/version.rb

@@ -0,0 +1,7 @@
+module HDOC
+  module Actions
+    def version
+      $stderr.puts HDOC.version
+    end
+  end
+end

data/lib/1hdoc/actions.rb

@@ -0,0 +1,32 @@
+module HDOC
+  ##
+  # Implements actions which can be executed by the program.
+  module Actions
+    ENVIRONMENT = {
+      configuration_file: File.expand_path('~/.1hdoc.yml'),
+      repository_url: 'https://github.com/Kallaway/100-days-of-code',
+      log_file: 'log.md'
+    }.freeze
+
+    private
+
+    def open_configuration_file
+      @configuration = Configuration.new(ENVIRONMENT[:configuration_file])
+      @options = @configuration.options
+    end
+
+    def open_repository
+      open_configuration_file unless @configuration
+      @repository = Repository.new(@options[:workspace])
+    end
+
+    def open_log
+      @log = Log.new(File.join(@options[:workspace], ENVIRONMENT[:log_file]))
+    end
+  end
+end
+
+require_relative 'actions/push'
+require_relative 'actions/commit'
+require_relative 'actions/init'
+require_relative 'actions/version'

data/lib/1hdoc/cli.rb

@@ -0,0 +1,50 @@
+module HDOC
+  ##
+  # Provides the CLI interface for interact with the program.
+  class CLI
+    include Actions
+
+    AVAILABLE_COMMANDS = [
+      ['-i', '--init', 'Initialize necessary files.'],
+      ['-c', '--commit', 'Register your progress and sync it.'],
+      ['-p', '--push', 'Manually synchronize your online repository.'],
+      ['-v', '--version', 'Show program version.']
+    ].freeze
+
+    def initialize(option_parser = OptionParser)
+      @option_parser = option_parser
+      check_for_configuration
+    end
+
+    def run
+      @option_parser.new do |opts|
+        opts.banner = 'Usage: 1hdoc [options]'
+
+        @options = opts
+        initialize_options
+      end.parse!
+
+    rescue @option_parser::ParseError
+      $stderr.puts @options
+    end
+
+    private
+
+    def check_for_configuration
+      unless File.exist? ENVIRONMENT[:configuration_file]
+        $stderr.puts 'Unable to find configuration file..'
+        init
+      end
+    end
+
+    def initialize_options
+      AVAILABLE_COMMANDS.each do |command|
+        @options.on(*command) { send(remove_dashes(command[1])) }
+      end
+    end
+
+    def remove_dashes(command)
+      command.sub('--', '')
+    end
+  end
+end

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

@@ -1,20 +1,36 @@
 module HDOC
   ##
-  # Manage configuration files.
+  # Provides methods for read configuration options by a file.
+  # By default, it uses YAML as configuration file's parse
   class Configuration
-    attr_reader :options
-    include Utilities
+    attr_reader :options, :file_path
 
-    ##
-    # 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)
+    def self.init(file_path, file_parser = YAML, **options)
+      file_path = File.expand_path(file_path)
+
+      File.open(file_path, 'w') do |configuration_file|
+        configuration_file.puts file_parser.dump(options)
       end
     end
 
-    def initialize(path, config_parser = YAML)
-      @options = parse_file(expand_path(path), config_parser)
+    def initialize(file_path, file_parser = YAML)
+      @file_path = File.expand_path(file_path)
+      @file_parser = file_parser
+
+      raise Errno::ENOENT unless File.exist? @file_path
+      load_options
+    end
+
+    def load_options
+      @options = @file_parser.load(File.read(file_path))
+    end
+
+    def update
+      Configuration.init(@file_path, @file_parser, options)
+    end
+
+    def set(option, value)
+      @options[option] = value
     end
   end
 end

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

@@ -0,0 +1,21 @@
+module HDOC
+  ##
+  # Provides methods for interact with the log file.
+  class Log
+    attr_reader :log_path
+
+    def self.reset(log_path)
+      log_path = File.expand_path(log_path)
+      File.open(log_path, 'w') { |log| log.print '' }
+    end
+
+    def initialize(log_path)
+      @log_path = File.expand_path(log_path)
+      raise Errno::ENOENT unless File.exist? log_path
+    end
+
+    def append(content)
+      File.open(log_path, 'a') { |log| log.puts content }
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module HDOC
+  ##
+  # Provides methods for register and format user's daily progress.
+  class Progress
+    attr_reader :record
+
+    QUESTIONS = {
+      progress: 'Your progress: ',
+      thoughts: 'Your thoughts: ',
+      link: 'Link to work: '
+    }.freeze
+
+    def initialize(current_day)
+      @current_day = current_day
+      @current_date = Time.now.strftime('%B %d, %Y')
+
+      @record = {}
+    end
+
+    def register
+      QUESTIONS.each do |field, question|
+        puts question
+        @record[field] = gets.chomp
+      end
+    end
+
+    def format
+      result = "### Day #{@current_day}: #{@current_date}\n"
+      record.each { |field, value| result << format_field(field, value) }
+
+      result
+    end
+
+    def format_field(field, value)
+      "**#{field.capitalize}:** #{value}\n\n"
+    end
+
+    def set_record(record)
+      @record = record
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module HDOC
+  ##
+  # Provides an interface for interact with Git repositories.
+  class Repository
+    def self.clone(url, destination, adapter = Git)
+      adapter.clone(url, destination)
+    rescue adapter::GitExecuteError => error
+      $stderr.puts error.message
+    end
+
+    def initialize(repo_path, adapter = Git)
+      @adapter = adapter
+      @repo = @adapter.open(repo_path)
+    rescue ArgumentError
+      $stderr.puts 'The given repository is not a valid one.'
+    end
+
+    def commit(message)
+      @repo.add(all: true)
+      @repo.commit(message)
+
+    rescue @adapter::GitExecuteError => error
+      $stderr.puts error
+    end
+
+    def push
+      puts @repo.push
+    rescue @adapter::GitExecuteError => error
+      $stderr.puts error
+    end
+  end
+end

data/lib/1hdoc/version.rb

@@ -1,3 +1,10 @@
+##
+# Provides all necessary features implemented by 1hdoc.
 module HDOC
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2.0'.freeze
+  CODENAME = 'Phoenix'.freeze
+
+  def self.version
+    "1hdoc ver#{VERSION} '#{CODENAME}'"
+  end
 end

data/lib/1hdoc.rb

@@ -1,16 +1,16 @@
+# coding: utf-8
+
 # stdlib
 require 'yaml'
-require 'optparse'
 require 'git'
+require 'optparse'
 
-# 1hdoc core
-require_relative '1hdoc/core/utilities'
+# 1hdoc
 require_relative '1hdoc/core/configuration'
-require_relative '1hdoc/core/committer'
-require_relative '1hdoc/core/log_builder'
-require_relative '1hdoc/core/log_viewer'
+require_relative '1hdoc/core/log'
+require_relative '1hdoc/core/progress'
+require_relative '1hdoc/core/repository'
 
-# 1hdoc inteface
 require_relative '1hdoc/version'
-require_relative '1hdoc/integration'
-require_relative '1hdoc/application'
+require_relative '1hdoc/actions'
+require_relative '1hdoc/cli'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 1hdoc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Dom Corvasce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -77,13 +77,16 @@ files:
 - README.md
 - bin/1hdoc
 - lib/1hdoc.rb
-- lib/1hdoc/application.rb
-- lib/1hdoc/core/committer.rb
+- lib/1hdoc/actions.rb
+- lib/1hdoc/actions/commit.rb
+- lib/1hdoc/actions/init.rb
+- lib/1hdoc/actions/push.rb
+- lib/1hdoc/actions/version.rb
+- lib/1hdoc/cli.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/core/log.rb
+- lib/1hdoc/core/progress.rb
+- lib/1hdoc/core/repository.rb
 - lib/1hdoc/version.rb
 homepage: https://github.com/domcorvasce/1hdoc
 licenses:

data/lib/1hdoc/application.rb

@@ -1,94 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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/log_builder.rb

@@ -1,46 +0,0 @@
-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

@@ -1,49 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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