daily_log 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f8d6b8f5bd384395377f8d0804b6b647b3167363bd3b730e150a1edbdbb1188
-  data.tar.gz: 8910775604dd64a27e94637ca80678715da785f9ab2bda68ea1714a7a7fc5920
+  metadata.gz: 55b40ff4be4bbab74b754f403b289ee7160a57f0da3fdac1d0a4a194e4cbae4f
+  data.tar.gz: 73bb29930df2be588849df5f1cc872afadce5917a01ac14200333b9e83670f5d
 SHA512:
-  metadata.gz: 0c6a936ec9927a5873199fabab264b646f81b10dcb0919cc463ca38e9c5faf107a0316735cdebbf64f29ba2ff9d4442fa5acefa4e84b8f467f09a645114db2f2
-  data.tar.gz: 65164230b791472f09344cd241696c74208cb479fa518d413fd8e0095dc23f95e3ad03eac69cdcd9182e122f52fad346f3b2dc541427efbd2451e944a78fe89d
+  metadata.gz: ec72aa7b6b535f24503fe8e745b49fd1ccc3977a1e32eac72e7551aefa440727ae3ab6bc6bfff6d5b1e0ad9a6735ed2770b8097ac87c4acab74252d7dd540f62
+  data.tar.gz: 556d1c798b7bd3c5e0c82e54d37f95280efb311cfbd293c7f3f7d259a75714f6a72d090ae7371b4852e40aae69b5b7af94d9cfff97eb1edda5dc34daf97f9ba1

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/Gemfile

@@ -5,16 +5,3 @@ source "https://rubygems.org"
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
-
-group :development do
-
-  gem "yard-tomdoc"
-
-  gem "rake"
-
-  gem "irb", "~> 1.2"
-
-  gem "rspec", "~> 3.9"
-
-  gem "byebug"
-end

data/History.md

@@ -1,17 +1,14 @@
 
-2020-01-06 / 2020-01-07
-==================
-
-  * Allow public gem pushing
-
 n.n.n / 2020-01-07
 ==================
 
+  * Add missing documentation
+  * Replace docs rake task with Yard rake task
+  * Move gem dependencies to gemspec
+  * Allow public gem pushing
   * Bundle as Rubygem
   * Update README
   * Remove YARD files from git repo
-  * Added documentation
+  * Add documentation
   * Remove .daily_logs from gitignore
   * Basic working version up and running
-  * Basic text-file is opening
-  * Initial commit

data/Rakefile

@@ -1,7 +1,18 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-load "lib/tasks/doc.rake"
 
 RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
+
+# For docs
+require 'yard'
+require "yard-tomdoc"
+
+YARD::Rake::YardocTask.new do |t|
+ t.files   = ['lib/**/*.rb']
+ t.options = ['--plugin=tomdoc', '--hide-void-return', '--title="Daily Log"']
+ t.stats_options = ['--list-undoc']
+end
+
+task doc: :yard

data/daily_log.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard-tomdoc"
 end

data/lib/daily_log/options.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
 module DailyLog
+
+  # Parses options passed into the command-line and returns the desired values
   class Options
     require "optparse"
     require "optparse/date"
     require "date"
 
+    ##
+    # The options as a Hash
+    #
+    # Returns Hash
     attr_reader :hash
 
     alias to_hash hash
@@ -15,10 +21,14 @@ module DailyLog
       parse
     end
 
+    # The default options
+    #
+    # Returns Hash
     def defaults
       { date: Date.today }
     end
 
+    # Parse the input options and update the {hash} with desired values.
     def parse
       OptionParser.new do |opts|
         opts.banner = "Usage: dl [options]"
@@ -49,4 +59,5 @@ module DailyLog
       hash[:edit]  = (hash[:date] == Date.today) unless hash.key?(:edit)
     end
   end
+  
 end

data/lib/daily_log/version.rb

@@ -1,3 +1,3 @@
 module DailyLog
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/zero_padded.rb

@@ -1,5 +1,16 @@
 # Extends the Integer class with zero-padded numbers, so that months are days
-# all always shown as double-digit numbers
+# all always shown as double-digit numbers.
+#
+# Examples
+#
+#   class MyClass
+#
+#     using ZeroPadded
+#
+#     def print_number
+#       print 1.zero_pad # => "0.1"
+#     end
+#
 module ZeroPadded
 
   refine Integer do
@@ -8,6 +19,6 @@ module ZeroPadded
     def zero_pad
       to_s.rjust(2, "0")
     end
-    
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: daily_log
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Bodacious
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard-tomdoc
+  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'
 description: Keep a short, daily log of the work you do within a project repo
 email:
 - bodacious@katanacode.com
@@ -67,7 +81,6 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - History.md
 - LICENSE.txt
 - README.md
@@ -84,7 +97,6 @@ files:
 - lib/daily_log/pathname.rb
 - lib/daily_log/scm_check.rb
 - lib/daily_log/version.rb
-- lib/tasks/doc.rake
 - lib/templates/daily_log/entry.md.erb
 - lib/zero_padded.rb
 homepage: https://github.com/KatanaCode/daily_log

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    daily_log (0.1.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (11.0.1)
-    diff-lcs (1.3)
-    io-console (0.5.4)
-    irb (1.2.1)
-      reline (>= 0.0.1)
-    rake (13.0.1)
-    reline (0.1.2)
-      io-console (~> 0.5)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    tomparse (0.4.2)
-    yard (0.9.23)
-    yard-tomdoc (0.7.1)
-      tomparse (>= 0.4.0)
-      yard
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  byebug
-  daily_log!
-  irb (~> 1.2)
-  rake
-  rspec (~> 3.9)
-  yard-tomdoc
-
-BUNDLED WITH
-   1.17.3

data/lib/tasks/doc.rake

@@ -1,12 +0,0 @@
-namespace :doc do
-
-  desc "Create the HTML docs for this project"
-  task :create do
-    load("lib/daily_log/version.rb")
-    system("yard doc --plugin tomdoc\
-                     --hide-void-return\
-                     --title \"Daily Logs - #{DailyLog::VERSION}\"")
-  end
-end
-
-task doc: ["doc:create"]