standup_md 0.3.1 → 0.3.6

data/lib/standup_md/config/file.rb

@@ -1,9 +1,31 @@
+# frozen_string_literal: true
+
 module StandupMD
   class Config
 
     ##
     # The configuration class for StandupMD::File
     class File
+
+      ##
+      # The default options.
+      #
+      # @return [Hash]
+      DEFAULTS = {
+        header_date_format: '%Y-%m-%d',
+        header_depth: 1,
+        sub_header_depth: 2,
+        current_header: 'Current',
+        previous_header: 'Previous',
+        impediments_header: 'Impediments',
+        notes_header: 'Notes',
+        sub_header_order: %w[previous current impediments notes],
+        directory: ::File.join(ENV['HOME'], '.cache', 'standup_md'),
+        bullet_character: '-',
+        name_format: '%Y_%m.md',
+        create: true,
+      }
+
       ##
       # Number of octothorps that should preface entry headers.
       #
@@ -116,27 +138,15 @@ module StandupMD
       ##
       # Initializes the config with default values.
       def initialize
-        reset_values
+        reset
       end
 
       ##
       # Sets all config values back to their defaults.
       #
-      # @return [Boolean] true if successful
-      def reset_values
-        @header_date_format = '%Y-%m-%d'
-        @header_depth = 1
-        @sub_header_depth = 2
-        @current_header = 'Current'
-        @previous_header = 'Previous'
-        @impediments_header = 'Impediments'
-        @notes_header = 'Notes'
-        @sub_header_order = %w[previous current impediments notes]
-        @directory = ::File.join(ENV['HOME'], '.cache', 'standup_md')
-        @bullet_character = '-'
-        @name_format = '%Y_%m.md'
-        @create = true
-        true
+      # @return [Hash]
+      def reset
+        DEFAULTS.each { |k, v| instance_variable_set("@#{k}", v) }
       end
 
       ##

data/lib/standup_md/entry.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
+
 require 'json'
 
 module StandupMD
-
   ##
   # Class for handling single entries. Includes the comparable module, and
   # compares by date.
@@ -38,7 +38,7 @@ module StandupMD
     attr_accessor :previous
 
     ##
-    # Iimpediments for this entry.
+    # Impediments for this entry.
     #
     # @return [Array]
     attr_accessor :impediments

data/lib/standup_md/entry_list.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-module StandupMD
+require 'forwardable'
 
+module StandupMD
   ##
   # Enumerable list of entries.
   class EntryList
+    extend Forwardable
     include Enumerable
 
     ##
@@ -29,12 +31,6 @@ module StandupMD
       @entries = entries
     end
 
-    ##
-    # Iterate over the list and yield each entry.
-    def each(&block)
-      @entries.each(&block)
-    end
-
     ##
     # Appends entries to list.
     #
@@ -51,24 +47,12 @@ module StandupMD
     ##
     # Finds an entry based on date. This method assumes the list has already
     # been sorted.
-    def find(key)
-      to_a.bsearch { |e| e.date == key }
-    end
-
-    ##
-    # How many entries are in the list.
     #
-    # @return [Integer]
-    def size
-      @entries.size
-    end
-
-    ##
-    # Is the list empty?
+    # @param [Date] date
     #
-    # @return [Boolean] true if empty
-    def empty?
-      @entries.empty?
+    # @return [StandupMD::Entry]
+    def find(date)
+      entries.bsearch { |e| e.date == date }
     end
 
     ##
@@ -124,24 +108,6 @@ module StandupMD
       self
     end
 
-    ##
-    # The first entry in the list. This method assumes the list has
-    # already been sorted.
-    #
-    # @return [StandupMD::Entry]
-    def first
-      to_a.first
-    end
-
-    ##
-    # The last entry in the list. This method assumes the list has
-    # already been sorted.
-    #
-    # @return [StandupMD::Entry]
-    def last
-      to_a.last
-    end
-
     ##
     # The list as a hash, with the dates as keys.
     #
@@ -162,5 +128,22 @@ module StandupMD
     def to_json
       to_h.to_json
     end
+
+    # :section: Delegators
+
+    ##
+    # The following are forwarded to @entries, which is the underly array of
+    # entries.
+    #
+    # +each+:: Iterate over each entry.
+    #
+    # +empty?+:: Is the list empty?
+    #
+    # +size+:: How many items are in the list?
+    #
+    # +first+:: The first record in the list.
+    #
+    # +last+:: The last record in the list.
+    def_delegators :@entries, :each, :empty?, :size, :first, :last
   end
 end

data/lib/standup_md/file.rb

@@ -5,7 +5,6 @@ require 'fileutils'
 require_relative 'file/helpers'
 
 module StandupMD
-
   ##
   # Class for handling reading and writing standup files.
   class File
@@ -19,15 +18,34 @@ module StandupMD
       @config ||= StandupMD.config.file
     end
 
+    ##
+    # Convenience method for calling File.find(file_name).load
+    #
+    # @param [String] file_name
+    #
+    # @return [StandupMD::File]
+    def self.load(file_name)
+      unless ::File.directory?(config.directory)
+        raise "Dir #{config.directory} not found." unless config.create
+
+        FileUtils.mkdir_p(config.directory)
+      end
+      new(file_name).load
+    end
+
     ##
     # Find standup file in directory by file name.
     #
     # @param [String] File_naem
     def self.find(file_name)
-      file = Dir.entries(config.directory).bsearch { |f| f == file_name }
-      if file.nil? && !config.create
-        raise "File #{file_name} not found." unless config.create
+      unless ::File.directory?(config.directory)
+        raise "Dir #{config.directory} not found." unless config.create
+
+        FileUtils.mkdir_p(config.directory)
       end
+      file = Dir.entries(config.directory).bsearch { |f| f == file_name }
+      raise "File #{file_name} not found." if file.nil? && !config.create
+
       new(file_name)
     end
 
@@ -36,8 +54,12 @@ module StandupMD
     #
     # @param [Date] date
     def self.find_by_date(date)
-      unless date.is_a?(Date)
-        raise ArgumentError, "Argument must be a Date object"
+      raise ArgumentError, 'Must be a Date object' unless date.is_a?(Date)
+
+      unless ::File.directory?(config.directory)
+        raise "Dir #{config.directory} not found." unless config.create
+
+        FileUtils.mkdir_p(config.directory)
       end
       find(date.strftime(config.name_format))
     end
@@ -69,6 +91,7 @@ module StandupMD
 
       unless ::File.directory?(@config.directory)
         raise "Dir #{@config.directory} not found." unless @config.create
+
         FileUtils.mkdir_p(@config.directory)
       end
 
@@ -76,6 +99,7 @@ module StandupMD
 
       unless ::File.file?(@name)
         raise "File #{@name} not found." unless @config.create
+
         FileUtils.touch(@name)
       end
 
@@ -114,21 +138,23 @@ module StandupMD
     # @return [StandupMD::FileList]
     def load
       raise "File #{name} does not exist." unless ::File.file?(name)
+
       entry_list = EntryList.new
       record = {}
       section_type = ''
       ::File.foreach(name) do |line|
         line.chomp!
         next if line.strip.empty?
-        if is_header?(line)
+
+        if header?(line)
           unless record.empty?
             entry_list << new_entry(record)
             record = {}
           end
-          record['header'] = line.sub(%r{^\#{#{@config.header_depth}}\s*}, '')
-            section_type = @config.notes_header
-            record[section_type] = []
-        elsif is_sub_header?(line)
+          record['header'] = line.sub(/^\#{#{@config.header_depth}}\s*/, '')
+          section_type = @config.notes_header
+          record[section_type] = []
+        elsif sub_header?(line)
           section_type = determine_section_type(line)
           record[section_type] = []
         else
@@ -148,10 +174,10 @@ module StandupMD
     # This method is destructive; if a file for entries in the date range
     # already exists, it will be clobbered with the entries in the range.
     #
-    # @param [Hash] start_and_end_date
+    # @param [Hash] {start_date: Date, end_date: Date}
     #
     # @return [Boolean] true if successful
-    def write(dates = {})
+    def write(**dates)
       sorted_entries = entries.sort
       start_date = dates.fetch(:start_date, sorted_entries.first.date)
       end_date = dates.fetch(:end_date, sorted_entries.last.date)
@@ -159,9 +185,10 @@ module StandupMD
         sorted_entries.filter(start_date, end_date).sort_reverse.each do |entry|
           f.puts header(entry.date)
           @config.sub_header_order.each do |attr|
-            tasks = entry.send(attr)
+            tasks = entry.public_send(attr)
             next if !tasks || tasks.empty?
-            f.puts sub_header(@config.send("#{attr}_header").capitalize)
+
+            f.puts sub_header(@config.public_send("#{attr}_header").capitalize)
             tasks.each { |task| f.puts @config.bullet_character + ' ' + task }
           end
           f.puts

data/lib/standup_md/file/helpers.rb

@@ -2,40 +2,38 @@
 
 module StandupMD
   class File
-
     ##
     # Module responsible for reading and writing standup files.
     module Helpers # :nodoc:
-
       private
 
-      def is_header?(line) # :nodoc:
+      def header?(line) # :nodoc:
         line.match(header_regex)
       end
 
-      def is_sub_header?(line) # :nodoc:
+      def sub_header?(line) # :nodoc:
         line.match(sub_header_regex)
       end
 
       def header_regex # :nodoc:
-        %r{^#{'#' * StandupMD.config.file.header_depth}\s+}
+        /^#{'#' * StandupMD.config.file.header_depth}\s+/
       end
 
       def sub_header_regex # :nodoc:
-        %r{^#{'#' * StandupMD.config.file.sub_header_depth}\s+}
+        /^#{'#' * StandupMD.config.file.sub_header_depth}\s+/
       end
 
       def bullet_character_regex # :nodoc:
-        %r{\s*#{StandupMD.config.file.bullet_character}\s*}
+        /\s*#{StandupMD.config.file.bullet_character}\s*/
       end
 
       def determine_section_type(line) # :nodoc:
-        line = line.sub(%r{^\#{#{StandupMD.config.file.sub_header_depth}}\s*}, '')
-          [
-            StandupMD.config.file.current_header,
-            StandupMD.config.file.previous_header,
-            StandupMD.config.file.impediments_header,
-            StandupMD.config.file.notes_header
+        line = line.sub(/^\#{#{StandupMD.config.file.sub_header_depth}}\s*/, '')
+        [
+          StandupMD.config.file.current_header,
+          StandupMD.config.file.previous_header,
+          StandupMD.config.file.impediments_header,
+          StandupMD.config.file.notes_header
         ].each { |header| return header if line.include?(header) }
         raise "Unrecognized header [#{line}]"
       end
@@ -54,8 +52,8 @@ module StandupMD
         '#' * StandupMD.config.file.header_depth + ' ' + date.strftime(StandupMD.config.file.header_date_format)
       end
 
-      def sub_header(sh)
-        '#' * StandupMD.config.file.sub_header_depth + ' ' + sh
+      def sub_header(subhead)
+        '#' * StandupMD.config.file.sub_header_depth + ' ' + subhead
       end
     end
   end

data/lib/standup_md/version.rb

@@ -1,11 +1,28 @@
 # frozen_string_literal: true
 
 module StandupMD
+
   ##
-  # The gem verision
-  #
-  # @example
-  #  StandupMD::VERSION
-  #  # => '0.3.0'
-  VERSION = '0.3.1'
+  # Module that contains all gem version information. Follows semantic
+  # versioning. Read: https://semver.org/
+  module Version
+
+    ##
+    # Major version.
+    MAJOR = 0
+
+    ##
+    # Minor version.
+    MINOR = 3
+
+    ##
+    # Patch version.
+    PATCH = 6
+
+    ##
+    # Version as +MAJOR.MINOR.PATCH+
+    def self.to_s
+      "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
 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
+  spec.version       = StandupMD::Version.to_s
   spec.authors       = ['Evan Gray']
   spec.email         = 'evanthegrayt@vivaldi.net'
   spec.license       = 'MIT'
@@ -12,25 +12,21 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Generate and edit standups in markdown format}
   spec.homepage      = 'https://evanthegrayt.github.io/standup_md/'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = 'https://github.com/evanthegrayt/standup_md'
-    spec.metadata['documentation_uri'] = 'https://evanthegrayt.github.io/standup_md/doc/index.html'
-  else
+  unless spec.respond_to?(:metadata)
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'
   end
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  # spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    # `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  # end
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] =
+    'https://github.com/evanthegrayt/standup_md'
+  spec.metadata['documentation_uri'] =
+    'https://evanthegrayt.github.io/standup_md/doc/index.html'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']