1hdoc 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c359c2620b09de6edbea3f18c745bbc30d53384e
-  data.tar.gz: 79becc34f51c9ea7da05d5a4134ecf8ca7a45477
+  metadata.gz: e20ddfded5850fe29763cf2f76f6b250ee443f57
+  data.tar.gz: 98513221bb36b0c149389fcab9e85e73e1c21269
 SHA512:
-  metadata.gz: dcf8f8a8af3cb50a56c5436bc1d586abca6a2d5bc62635e073817cbdc9b216b6d494cf6d47d3c43a724de2c9ae9ddaaeb4e1a6c71852dafb45889d64ac8ec877
-  data.tar.gz: dfdd0c29081238635f9d7e97384c368a5ae9dc0f0746677ce994921344c835c9fc5f481fcbb2489f0430dbf7562a9589a91485bdd77627edda993c033dcc0b3a
+  metadata.gz: 68c996a8fb5fb1e6f3f96ead94b64bb0ec5e1de3f115659b63873d663c8af7d08a715177341c835c49c7073cfb78802da3930cd77da20546d4b3f00dbc99e126
+  data.tar.gz: 0f9f81919845a558d434bcd8779b214e4e1cef01d9040b14b59d480c168a27104c9f4b15fd17bdc48350a1654c18b07a3b75cb36ca4c64d0a406297aafbf684f

data/README.md

@@ -1,5 +1,6 @@
 # 1hdoc
 
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/f71e6654548045698704abb8f7c4b4af)](https://www.codacy.com/app/dom-corvasce/1hdoc?utm_source=github.com&utm_medium=referral&utm_content=domcorvasce/1hdoc&utm_campaign=badger)
 [![Gem Version](https://badge.fury.io/rb/1hdoc.svg)](https://badge.fury.io/rb/1hdoc)
 
 Keep track of your progress during #100DaysOfCode event.
@@ -66,7 +67,7 @@ Have you ended Day 2?
 Great! Let's 1hdoc track your progress. Type:
 
 ```shell
-1hdoc --commit
+1hdoc -c
 ```
 
 By default, 1hdoc don't push to the repo automatically after you 
@@ -84,20 +85,27 @@ You can change this behavior by assigning `true` to `auto_push` option in
 If you turn off `auto_push` you can push to the repo typing:
 
 ```shell
-1hdoc --push
+1hdoc -p
 ```
 
+## FAQ
+
+- **I got an error when I try to use 1hdoc. How can I resolve?**
+
+  If the error is the following:
+  
+  ```shell
+  `require': libreadline.so.6: cannot open shared object fie
+  ```
+  
+  this means Ruby tries to get the older version of Readline so you need 
+  to reinstall it like reported [here](https://github.com/deivid-rodriguez/byebug/issues/307).
+
 ## 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.
+Feel free to open an issue or propose a pull request.
 
 ## License
 

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

@@ -3,8 +3,20 @@ module HDOC
     ##
     # Push the progress to the repository.
     def push
+      if user_already_pushed?
+        $stderr.puts 'You already pushed for today'
+        return
+      end
+
       open_repository
       @repository.push
     end
+
+    private
+
+    def user_already_pushed?
+      config = Configuration.new(ENVIRONMENT[:configuration_file])
+      config.options[:last_commit_on] == Time.now.strftime('%Y-%m-%d')
+    end
   end
 end

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

@@ -5,31 +5,48 @@ module HDOC
   class Configuration
     attr_reader :options, :file_path
 
+    ##
+    # Initializes a new configuration file with a set of defaults options:
+    #
+    # ```
+    # # Using a custom format
+    # Configuration.init('~/package.json', JSON, name: 'howsweather', version: '0.1.4')
+    #
+    # # Using default format
+    # Configuration.init('~/.1hdoc.yml', day: 0, last_commit_on: Time.now)
+    # ```
     def self.init(file_path, file_parser = YAML, **options)
       file_path = File.expand_path(file_path)
+      dumped_options = file_parser.dump(options)
 
-      File.open(file_path, 'w') do |configuration_file|
-        configuration_file.puts file_parser.dump(options)
-      end
+      File.open(file_path, 'w') { |config| config.puts(dumped_options) }
     end
 
     def initialize(file_path, file_parser = YAML)
       @file_path = File.expand_path(file_path)
       @file_parser = file_parser
-      @options = {}
-
-      raise "Unable to find #{@file_path}" unless File.exist? @file_path
-      load_options
+      @options = load_options
     end
 
     def load_options
-      @options = @file_parser.load(File.read(file_path))
+      raise "Unable to find #{file_path}" unless File.exist? file_path
+      @file_parser.load(File.read(file_path))
     end
 
+    ##
+    # Updates configuration file by rewriting the whole file using
+    # init's singleton method.
+    #
+    # You should avoid this method for big files and use it for small ones.
     def update
-      Configuration.init(@file_path, @file_parser, options)
+      self.class.init(@file_path, @file_parser, options)
     end
 
+    ##
+    # Sets a new option or a edit an existing one.
+    #
+    # It's used in pair with Configuration#update in order to update
+    # an existing configuration file.
     def set(option, value)
       @options[option] = value
     end

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

@@ -18,8 +18,16 @@ module HDOC
     end
 
     def register
+      $stderr.puts 'Finish your answer by typing :!'
+
       QUESTIONS.each do |field, question|
-        @record[field] = Readline.readline(question, false)
+        $stderr.puts question
+        @record[field] = ''
+
+        while text_line = Readline.readline
+          @record[field] += text_line.sub(':!', '') + "\n"
+          break if text_line[':!']
+        end
       end
     end
 

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

@@ -2,6 +2,8 @@ module HDOC
   ##
   # Provides an interface for interact with Git repositories.
   class Repository
+    attr_reader :adapter
+
     def self.clone(url, destination, adapter = Git)
       adapter.clone(url, destination)
     rescue adapter::GitExecuteError => error
@@ -22,6 +24,8 @@ module HDOC
 
     def push
       @repo.push
+    rescue adapter::GitExecuteError => error
+      $stderr.puts error.message
     end
   end
 end

data/lib/1hdoc/version.rb

@@ -1,7 +1,7 @@
 ##
 # Provides all necessary features implemented by 1hdoc.
 module HDOC
-  VERSION = '0.2.3'.freeze
+  VERSION = '0.2.4'.freeze
   CODENAME = 'Phoenix'.freeze
 
   def self.version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 1hdoc
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Dom Corvasce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-19 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - git >= 1.6
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: "#100DaysOfCode CLI tracker"