standup_md 0.3.10 → 0.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 911436a3ca07345eb0085c99efa994e3e56732f2d7de641a2a427c2ce02d0407
-  data.tar.gz: ba4eba776394f67ef44f02a0033374748da0b036b7a4384062e618e1b7f376bf
+  metadata.gz: e9e2449a7136b2b9b9633db530b2304ddc986050bb404c951cb0da1cb299330b
+  data.tar.gz: 52106b7870dee25cf07070fd6e6ff689c84e3142bdb1249077f8ea757d56eac1
 SHA512:
-  metadata.gz: 2e7fa07198da5f302671be61e83c21052f1f8c5a99cb25a0d4bb0c2963fc12489c1bac338523048be6cf14efad53754c5b4eb6cda8bc78cfe42a02b95a115ef6
-  data.tar.gz: f6abec7ecb3171139fedf90e3ead734ab06d580bad3d958186f931513b4c78cc747615557e620aa2b0e96e9060727518564e7334ab8d70a6f6810b8a68c0285b
+  metadata.gz: 27248294c5f4d85bb5b1c4ae5df44d4133bfbe968acc30aba3917df29424f00b56c56bb12ea1219fe0b0c2ce311699f912957f616526db5ee43939c11abf7def
+  data.tar.gz: dfc856d09518702f57bc7fdb2a1610ce5143c165340709e067a4509ca7fc7789bd247422f6ac3952a678006789dc939a8f8e12b7f318b3e63cec140dab5c82b3

data/.gitignore

@@ -1,2 +1,3 @@
 standup_md-*.gem
 coverage/*
+docs/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standup_md (0.3.10)
+    standup_md (0.3.13)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -9,9 +9,7 @@
 A highly customizable and automated way to keep track of daily standups in
 markdown files.
 
-View on: [Github](https://github.com/evanthegrayt/standup_md) |
-[GitHub Pages](https://evanthegrayt.github.io/standup_md/) |
-[RubyGems](https://rubygems.org/gems/standup_md)
+You can view the documentation [here](https://evanthegrayt.github.io/standup_md/).
 
 ## About
 I've now been at two separate companies where we post our daily standups in a
@@ -263,7 +261,7 @@ end
 
 ## API
 The API is fully documented in the
-[RDoc Documentation](https://evanthegrayt.github.io/standup_md/doc/index.html).
+[RDoc Documentation](https://evanthegrayt.github.io/standup_md/).
 
 This was mainly written as a command line utility, but the API is very robust,
 and is available for use in your own projects. A quick example of how to write a

data/Rakefile

@@ -14,7 +14,7 @@ end
 
 RDoc::Task.new do |rdoc|
   rdoc.main = 'README.md'
-  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_dir = 'docs'
   rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
 end
 

data/lib/standup_md/cli/helpers.rb

@@ -12,10 +12,8 @@ module StandupMD
       #
       # @return [nil]
       def print(entry)
-        if entry.nil?
-          puts "No record found for #{config.cli.date}"
-          return
-        end
+        return puts "No record found for #{config.cli.date}" if entry.nil?
+
         puts header(entry)
         config.file.sub_header_order.each do |header_type|
           tasks = entry.public_send(header_type)
@@ -142,7 +140,6 @@ module StandupMD
       # @return [Array]
       def previous_entry(file)
         return config.entry.previous_entry unless config.cli.auto_fill_previous
-
         return prev_entry(prev_file.load.entries) if file.new? && prev_file
 
         prev_entry(file.entries)
@@ -155,9 +152,7 @@ module StandupMD
       #
       # @return [StandupMD::Entry]
       def prev_entry(entries)
-        return [] if entries.empty?
-
-        entries.last.current
+        entries.empty? ? [] : entries.last.current
       end
 
       ##

data/lib/standup_md/config/cli.rb

@@ -19,8 +19,9 @@ module StandupMD
         write: true,
         print: false,
         auto_fill_previous: true,
-        preference_file:
-          ::File.expand_path(::File.join(ENV['HOME'], '.standuprc'))
+        preference_file: ::File.expand_path(
+          ::File.join(ENV['HOME'], '.standuprc')
+        )
       }.freeze
 
       ##

data/lib/standup_md/config/entry_list.rb

@@ -2,11 +2,9 @@
 
 module StandupMD
   class Config
-
     ##
     # The configuration class for StandupMD::EntryList
     class EntryList
-
       ##
       # The default options.
       #

data/lib/standup_md/config/file.rb

@@ -2,11 +2,9 @@
 
 module StandupMD
   class Config
-
     ##
     # The configuration class for StandupMD::File
     class File
-
       ##
       # The default options.
       #
@@ -156,11 +154,9 @@ module StandupMD
       #
       # @return [Integer]
       def header_depth=(depth)
-        if !depth.between?(1, 5)
-          raise 'Header depth out of bounds (1..5)'
-        elsif depth >= sub_header_depth
-          @sub_header_depth = depth + 1
-        end
+        raise 'Header depth out of bounds (1..5)' if !depth.between?(1, 5)
+
+        @sub_header_depth = depth + 1 if depth >= sub_header_depth
         @header_depth = depth
       end
 
@@ -172,11 +168,9 @@ module StandupMD
       #
       # @return [Integer]
       def sub_header_depth=(depth)
-        if !depth.between?(2, 6)
-          raise 'Sub-header depth out of bounds (2..6)'
-        elsif depth <= header_depth
-          @header_depth = depth - 1
-        end
+        raise 'Sub-header depth out of bounds (2..6)' if !depth.between?(2, 6)
+
+        @header_depth = depth - 1 if depth <= header_depth
         @sub_header_depth = depth
       end
 
@@ -188,13 +182,15 @@ module StandupMD
       # @return [String]
       def bullet_character=(char)
         raise 'Must be "-" or "*"' unless %w[- *].include?(char)
+
         @bullet_character = char
       end
 
       ##
-      # Setter for directory. Must be expanded in case the user uses `~` for home.
-      # If the directory doesn't exist, it will be created. To reset instance
-      # variables after changing the directory, you'll need to call load.
+      # Setter for directory. Must be expanded in case the user uses `~` for
+      # home. If the directory doesn't exist, it will be created. To reset
+      # instance variables after changing the directory, you'll need to call
+      # load.
       #
       # @param [String] directory
       #

data/lib/standup_md/entry.rb

@@ -78,8 +78,8 @@ module StandupMD
     # @param [Array] notes
     def initialize(date, current, previous, impediments, notes = [])
       raise unless date.is_a?(Date)
-      @config = self.class.config
 
+      @config = self.class.config
       @date = date
       @current = current
       @previous = previous

data/lib/standup_md/entry_list.rb

@@ -24,10 +24,9 @@ module StandupMD
     #
     # @return [StandupMD::EntryList]
     def initialize(*entries)
+      entries.each { |entry| validate_entry(entry) }
+
       @config = self.class.config
-      unless entries.all? { |e| e.is_a?(StandupMD::Entry) }
-        raise ArgumentError, 'Entry must instance of StandupMD::Entry'
-      end
       @entries = entries
     end
 
@@ -38,9 +37,8 @@ module StandupMD
     #
     # @return [Array]
     def <<(entry)
-      unless entry.is_a?(StandupMD::Entry)
-        raise ArgumentError, 'Entry must instance of StandupMD::Entry'
-      end
+      validate_entry(entry)
+
       @entries << entry
     end
 
@@ -145,5 +143,13 @@ module StandupMD
     #
     # +last+:: The last record in the list.
     def_delegators :@entries, :each, :empty?, :size, :first, :last
+
+    private
+
+    def validate_entry(entry)
+      return if entry.is_a?(StandupMD::Entry)
+
+      raise ArgumentError, 'Entry must be an instance of StandupMD::Entry'
+    end
   end
 end

data/lib/standup_md/file/helpers.rb

@@ -40,7 +40,10 @@ module StandupMD
 
       def new_entry(record) # :nodoc:
         Entry.new(
-          Date.strptime(record['header'], StandupMD.config.file.header_date_format),
+          Date.strptime(
+            record['header'],
+            StandupMD.config.file.header_date_format
+          ),
           record[StandupMD.config.file.current_header],
           record[StandupMD.config.file.previous_header],
           record[StandupMD.config.file.impediments_header],
@@ -49,7 +52,9 @@ module StandupMD
       end
 
       def header(date)
-        '#' * StandupMD.config.file.header_depth + ' ' + date.strftime(StandupMD.config.file.header_date_format)
+        '#' * StandupMD.config.file.header_depth +
+          ' ' +
+          date.strftime(StandupMD.config.file.header_date_format)
       end
 
       def sub_header(subhead)

data/lib/standup_md/version.rb

@@ -21,7 +21,7 @@ module StandupMD
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 10
+    PATCH = 14
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+
@@ -47,4 +47,6 @@ module StandupMD
       Hash[%i[major minor patch].zip(to_a)]
     end
   end
+
+  VERSION = StandupMD::Version.to_s
 end

data/standup_md.gemspec

@@ -2,7 +2,7 @@ require_relative 'lib/standup_md/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'standup_md'
-  spec.version       = StandupMD::Version.to_s
+  spec.version       = StandupMD::VERSION
   spec.authors       = ['Evan Gray']
   spec.email         = 'evanthegrayt@vivaldi.net'
   spec.license       = 'MIT'
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] =
     'https://github.com/evanthegrayt/standup_md'
   spec.metadata['documentation_uri'] =
-    'https://evanthegrayt.github.io/standup_md/doc/index.html'
+    'https://evanthegrayt.github.io/standup_md/'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standup_md
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.14
 platform: ruby
 authors:
 - Evan Gray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-08 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,63 +80,6 @@ files:
 - Rakefile
 - _config.yml
 - bin/standup
-- doc/README_md.html
-- doc/StandupMD.html
-- doc/StandupMD/Cli.html
-- doc/StandupMD/Cli/Helpers.html
-- doc/StandupMD/Config.html
-- doc/StandupMD/Config/Cli.html
-- doc/StandupMD/Config/Entry.html
-- doc/StandupMD/Config/EntryList.html
-- doc/StandupMD/Config/File.html
-- doc/StandupMD/Entry.html
-- doc/StandupMD/EntryList.html
-- doc/StandupMD/File.html
-- doc/StandupMD/Version.html
-- doc/created.rid
-- doc/css/fonts.css
-- doc/css/rdoc.css
-- doc/fonts/Lato-Light.ttf
-- doc/fonts/Lato-LightItalic.ttf
-- doc/fonts/Lato-Regular.ttf
-- doc/fonts/Lato-RegularItalic.ttf
-- doc/fonts/SourceCodePro-Bold.ttf
-- doc/fonts/SourceCodePro-Regular.ttf
-- doc/images/add.png
-- doc/images/arrow_up.png
-- doc/images/brick.png
-- doc/images/brick_link.png
-- doc/images/bug.png
-- doc/images/bullet_black.png
-- doc/images/bullet_toggle_minus.png
-- doc/images/bullet_toggle_plus.png
-- doc/images/date.png
-- doc/images/delete.png
-- doc/images/find.png
-- doc/images/loadingAnimation.gif
-- doc/images/macFFBgHack.png
-- doc/images/package.png
-- doc/images/page_green.png
-- doc/images/page_white_text.png
-- doc/images/page_white_width.png
-- doc/images/plugin.png
-- doc/images/ruby.png
-- doc/images/tag_blue.png
-- doc/images/tag_green.png
-- doc/images/transparent.png
-- doc/images/wrench.png
-- doc/images/wrench_orange.png
-- doc/images/zoom.png
-- doc/index.html
-- doc/js/darkfish.js
-- doc/js/navigation.js
-- doc/js/navigation.js.gz
-- doc/js/search.js
-- doc/js/search_index.js
-- doc/js/search_index.js.gz
-- doc/js/searcher.js
-- doc/js/searcher.js.gz
-- doc/table_of_contents.html
 - lib/standup_md.rb
 - lib/standup_md/cli.rb
 - lib/standup_md/cli/helpers.rb
@@ -158,7 +101,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://evanthegrayt.github.io/standup_md/
   source_code_uri: https://github.com/evanthegrayt/standup_md
-  documentation_uri: https://evanthegrayt.github.io/standup_md/doc/index.html
+  documentation_uri: https://evanthegrayt.github.io/standup_md/
 post_install_message:
 rdoc_options: []
 require_paths: