docfolio 0.0.1 → 0.0.2

data/lib/docfolio/views/diary_console_view.rb

@@ -5,6 +5,7 @@ require_relative 'view.rb'
 class DiaryConsoleView < ConsoleView
   def initialize(diary = nil)
     return if diary.nil?
+    @diary = diary
     @paragraphs = diary.paragraphs
     @credits = diary.standard_credits
     @credits_total = diary.standard_credits_total
@@ -22,11 +23,22 @@ class DiaryConsoleView < ConsoleView
 
   def output_str
     str = ''
+    sig_event = @diary.significant_event?
+    str += "SIGNIFICANT EVENT\n\n" if sig_event
     str += section_str('TITLE', content(:TITLE))
+    str += section_str('DATE OF EVENT', content(:SEA))
+    str += section_str('WHO WAS INVOLVED', content(:INVOLVED))
     str += section_str('INTRODUCTION', content(:INTRO))
+    str += section_str('WHAT HAPPENED?', content(:WHAT))
+    str += section_str('WHY DID IT HAPPEN?', content(:WHY))
+    str += section_str('HOW DID YOU AND THE OTHERS INVOLVED FEEL?', content(:FEELINGS))
+    str += section_str('WHAT WENT WELL?', content(:WELL))
+    str += section_str('WHAT COULD HAVE BEEN DONE DIFFERENTLY?', content(:DIFFERENT))
+    str += section_str('WHAT NEEDS TO CHANGE?', content(:CHANGE))
+    str += section_str('WHAT HAS CHANGED?', content(:CHANGED))
     str += learning_str
     str += credits_str
-    str
+    str.gsub(/ \n/, "\n")
   end
 
   def learning_str(str = '')

data/lib/docfolio/views/view.rb

@@ -18,8 +18,8 @@ class ConsoleView < View
       to_console("#{title}") + "\n\n" +
       to_console("• #{body.join("\n\n• ")}\n\n", 2, 4)
     else
-      to_console("#{title}") +
-      to_console("#{body.join}\n\n")
+      to_console("#{title.gsub(/ $/, '')}") +
+      to_console("#{body.join}\n\n").gsub(/ $/, '')
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docfolio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nick Bulmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2015-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -27,16 +27,20 @@ dependencies:
 description: A domain specific language to aid recording of a personal learning portfolio
   for UK General Practitioners.
 email: n.bulmer@live.co.uk
-executables: []
+executables:
+- docfolio
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/docfolio.rb
-- lib/docfolio/date_format.rb
+- bin/docfolio
 - lib/docfolio/docfolio.rb
 - lib/docfolio/learning_diary.rb
+- lib/docfolio/logs.rb
 - lib/docfolio/paragraph.rb
-- lib/docfolio/tags.rb
+- lib/docfolio/paragraph_modules/date_times.rb
+- lib/docfolio/paragraph_modules/dates.rb
+- lib/docfolio/paragraph_modules/tags.rb
+- lib/docfolio/paragraph_modules/times.rb
 - lib/docfolio/views/collater_console_view.rb
 - lib/docfolio/views/diary_console_view.rb
 - lib/docfolio/views/view.rb

data/lib/docfolio.rb

@@ -1,2 +0,0 @@
-require_relative 'docfolio/docfolio.rb'
-Docfolio.new.print_logs

data/lib/docfolio/date_format.rb

@@ -1,88 +0,0 @@
-# convert the date from 'dd-Oct-yy' to seconds past UNIX epoc
-# accepts dd_Mmm-yy  dd-Mmmmmmm-yy  dd-MMM-yy and other similar
-module DateFormat
-  # Extracts a date in seconds past UNIX epoc from a string date. The result
-  # can be used for other date operations. Converts from dd-mmm-yy and similar
-  # formats as commonly found in csv files
-  class DateExtractor
-    def format_date(date)
-      day, month, year = components(date)
-      begin
-        Time.new(year, month, day).to_i
-      rescue ArgumentError => e
-        print_argument_error_msg(e)
-        return nil
-      rescue => e
-        raise e
-      end
-    end
-
-    private
-
-    def print_argument_error_msg(e)
-      puts "\n#{e.to_s.upcase}"
-      puts "date  : #{date.inspect}"
-      puts "day   : #{day}"
-      puts "month : #{month}"
-      puts "year  : #{year}"
-      puts e.backtrace
-    end
-
-    # splits date into is component day month and time
-    def components(date)
-      date = date.split('-')
-      day = date[0].to_i
-      month = convert_month_to_number(date[1])
-      year = date[2].to_i
-      if year < 100 # no century
-        year > Time.now.year % 1000 ? century = 1900 : century = 2000
-        year += century
-      end
-      [day, month, year]
-    end
-
-    # A hash of text months and their corresponding month number
-    MONTHS = {
-      'jan' => 1,
-      'feb' => 2,
-      'mar' => 3,
-      'apr' => 4,
-      'may' => 5,
-      'jun' => 6,
-      'jul' => 7,
-      'aug' => 8,
-      'sep' => 9,
-      'oct' => 10,
-      'nov' => 11,
-      'dec' => 12,
-      'january' => 1,
-      'february' => 2,
-      'march' => 3,
-      'april' => 4,
-      'june' => 6,
-      'july' => 7,
-      'august' => 8,
-      'september' => 9,
-      'october' => 10,
-      'november' => 11,
-      'december' => 12,
-      'sept' => 9
-    }
-
-    # Takes a text month to its corresponding number, case insensitive
-    # @param [String] month Month of year in text
-    # @return [Integer] Number of month in calander e.g. Feb is 2
-    def convert_month_to_number(month)
-      return month.to_i if month.to_i > 0 # already a number
-      month = month.downcase
-      MONTHS[month]
-    end
-  end
-
-  # Extracts a date in seconds past UNIX epoc from a string date. The result
-  # can be used for other date operations. Converts from dd-mmm-yy and similar
-  # formats as commonly found in csv files
-  def format_date(date)
-    DateExtractor.new.format_date(date)
-  end
-end

data/lib/docfolio/tags.rb

@@ -1,216 +0,0 @@
-require_relative 'date_format.rb'
-require 'English'
-
-# handles extraction of tagged or other significant content. 
-# Interface:  extract_date, extract_tags
-module Tags
-
-  # Tags that are part of the DSL and are recognized in text
-  TAGS = [:LP, :R, :DEN, :NOTE, :I] 
-
-  # Tags that can earn CPD credit
-  CREDITABLE = [:LP, :R, :I]
-
-  # Tags that are applied to content based on the position in the document
-  SECTIONS = [:TITLE, :INTRO, :NOTE] 
-
-  # Tags that are internal and which have no meaning derived from the DSL or
-  # the position in the document.
-  SPECIAL = [:DATE] # internal tags with no meaning from content or position
-
-  # A combined array of all tags
-  ALL_TAGS = SECTIONS + TAGS + SPECIAL
-
-  # extracts and formats tags and pertaining text from a plain text paragraph
-  class TagFriend
-    include DateFormat
-
-    # @todo move function to one of the date or time handling classes
-    # The $LAST_MATCH_INFO global is equivalent to Rexexp.last_match and 
-    # returns a MatchData object. This can be used as an array, where indices
-    # 1 - n are the matched backreferences of the last successful match
-    # @param [String] paragraph_text a paragraph from a DSL text file
-    # @param [Time] date Date of this paragraph. May be nil if not known. 
-    #  This date is taken from the Date class instance variable of the 
-    #  paragraph class.
-    # @return [Array<String, Array, Time>] Array of values to be returned
-    # [String return value] 'paragraph_text' the same paragraph that was passed to the function but without the matched date character if there were any.
-    # [Array return value] 'time_array' array of 4 integer representing the hours and minutes of the from and to times
-    # [Time return value] 'date' the date in (day month year) of this paragraph taken from the matched date_regex if there was one. Will be nil if there was no match and if the date passed to the function was also nil.
-    def extract_date(paragraph_text, date)
-      time_array = []
-
-      # if text contains a date match
-      if date_regex =~ paragraph_text 
-        # $' (or $POSTMATCH), contains the characters after the match position
-        paragraph_text = $' 
-
-        # strip whitespace if any remaining match or set to empty string 
-        # if no match. If there is just white space after the match then
-        # this is truncated to an empty string
-        paragraph_text.nil? ? paragraph_text = '' : paragraph_text.strip!
-        
-        # extracts the 'from' and 'to' times from the last match above. the 
-        # time_array contains from_hour, from_min, to_hour, to_min, the
-        # date parameter is updated if the match found a new date
-        time_array, date = date_from_globals($LAST_MATCH_INFO, date)
-      end
-      [paragraph_text, time_array, date]
-    end
-
-    # Extracts a paragraph string to a tagged array with elements of type
-    # [:tag, 'content']. Called after the date/time info has been removed. If 
-    # called before, will result in date info at the start being tagged as
-    # a :NOTE
-    # @param [String] paragraph_text Paragraph string after date info removed
-    # @return [Array] Tagged array
-    def extract_tags(paragraph_text)
-      tag_regex =~ paragraph_text ? extract_tag(paragraph_text) : []
-    end
-
-    private
-
-    # @todo move function to one of the date or time handling classes
-    # returns a date from the 26 globals returned by date_regex
-    # @param [MatchData] glob_a the MatchData object return when the date_regex
-    #  was matched to the paragraph
-    # @param [Time] date the date of the paragraph; may be nil if not known
-    # @return [Array] array of 4 integer representing the 
-    #  hours and minutes of the from and to times
-    # @return [Time] 'date' the date (day month year) of this paragraph
-    def date_from_globals(glob_a, date)
-      from_hour = glob([1, 23], glob_a)
-      from_min  = glob([2, 24], glob_a)
-      to_hour   = glob([3, 25], glob_a)
-      to_min    = glob([4, 26], glob_a)
-      day       = glob([5, 8, 12, 14, 17, 21], glob_a)
-      month     = glob([6, 9, 11, 15, 18, 20], glob_a)
-      year      = glob([7, 10, 13, 16, 19, 22], glob_a)
-      date = Time.at(format_date("#{day}-#{month}-#{year}")) unless day.nil?
-      [[from_hour, from_min, to_hour, to_min], date]
-    end
-
-    # @todo move function to one of the date or time handling classes
-    # Returns a regular expression to be used to match dates and times of 
-    # the paragraph.
-    # @return [Regex] a regular expression to use to match dates and times
-    #  in the paragraph
-    def date_regex
-      dy      = /(?<day>\d{1,2})/
-      mt      = /(?<month>\w+)/
-      yr      = /(?<year>\d{2,4})/
-      time    = /(?<hour>\d{1,2}):(?<min>\d{2})/
-      period  = /#{time}( ?(?:-|to) ?#{time})?/
-      date1   = %r{#{dy}/#{dy}/#{yr}}     # d/m/y
-      date2   = /#{dy},? #{mt},? #{yr}/   # d Month Year
-      date3   = /#{mt},? #{dy},? #{yr}/   # Month d Year
-      date    = /#{date1}|#{date2}|#{date3}/
-      /^(#{period} ?#{date}?|#{date} ?#{period}?)/
-    end
-
-    # @todo would str be better with join?
-    # Creates a regex that can be used to match for tags that are recognized 
-    # as part of the DSL, currently :LP, :R, :DEN, :NOTE and :I
-    def tag_regex
-      str = ''
-      TAGS.each do |t|
-        str << "#{t}|"
-      end
-      str.gsub!(/\|$/, '')
-      /\b(#{str}): ?/
-    end
-
-    # Extracts a particular parameter from the MatchData object return when the
-    # paragraph was matched with the date regex. Treats the MatchData
-    # as an array, iterating through each index represented in the i_a
-    # array to find and return a value if there is one. 
-    # @param [Array] i_a Array of integers representing positions to test in 
-    #  array glob_a
-    # @param [MatchData] glob_a Array of matched backreferences of the last
-    #  successful regular expression match
-    # @return the first element in MatchData that is not nil. Returns
-    #  nil if there are no elements in MatchData at the indices in i_a that 
-    #  are not nil. 
-    def glob(i_a, glob_a)
-      i_a.each { |n| return glob_a[n] unless glob_a[n].nil? }
-      nil
-    end
-
-    # Paragraphs are broken down into a tagged array, with elements of type
-    # [:tag, 'text']. The first element of an array is of type string. If the 
-    # paragraph begins with text before any tags, then this first element will
-    # contain this text, otherwise it will be an empty string. This function 
-    # tests this string and returns it tagged as :NOTE unless empty in which
-    # case it returns an empty array []
-    # @param [Array] a An array of tagged content of the paragraph
-    # @return [Array] Another tagged array which is either empty, or just 
-    #  contains a single tagged content of the text at the beginning if there
-    #  was any.
-    def preface_with_note(a)
-      str = a[0].strip
-      str == '' ? [] : [[:NOTE, str]]
-    end
-
-    # Turns an array of strings into a tagged array. Ignores the string variable at position [0]. This first string is turned into a tagged array by the function #preface_with_note and appended in #extract_tag
-    # @param [Array] a Array of strings from splitting the paragraph
-    # @return [Array] A tagged array with elements of the form 
-    #  [:tag, 'content']
-    def tags_array(a)
-      tags = []
-      tag_count = (a.count - 1) / 2
-      1.upto(tag_count) do |i|
-        tag = a[(i * 2) - 1].to_sym
-        content = a[i * 2].strip
-        tags << [tag, content]
-      end
-      tags
-    end
-
-    # Splits the paragraph into an array of tags of type [:tag, 'content']
-    # @param [String] paragraph_text String text of the paragraph with any 
-    #  date and time info at the beginning, removed
-    # @return [Array] Tagged array of content with elements of type
-    #  [:tag, 'content']
-    def extract_tag(paragraph_text)
-      a = paragraph_text.split(tag_regex)
-      preface_with_note(a) + tags_array(a)
-    end
-  end
-
-  # Adds a given number and hours and minutes to a Time object
-  # @param [Time] from time to which hours and minutes are added
-  # @param [Number] hour hours to add to from
-  # @param [Number] min minutes to add to from
-  # @return [Time] the result of hours and minutes after from
-  def extract_time_object(hour, min, from)
-    seconds = (hour.to_i * 3600) + (min.to_i * 60)
-    Time.at(from.to_i + seconds)
-  end
-
-  # Extracts a paragraph string to a tagged array with elements of type
-  # [:tag, 'content']. Called after the date/time info has been removed. If 
-  # called before, will result in date info at the start being tagged as
-  # a :NOTE
-  # @param [String] paragraph_text Paragraph string after date info removed
-  # @return [Array] Tagged array
-  def extract_tags(paragraph_text)
-    TagFriend.new.extract_tags(paragraph_text)
-  end
-
-  # Defined in the Tags module
-  # @todo move function to one of the date or time handling classes
-  # The $LAST_MATCH_INFO global is equivalent to Rexexp.last_match and 
-  # returns a MatchData object. This can be used as an array, where indices
-  # 1 - n are the matched backreferences of the last successful match
-  # @param [String] paragraph_text a paragraph from a DSL text file
-  # @param [Time] date Date of this paragraph. May be nil if not known. 
-  #  This date is taken from the Date class instance variable of the 
-  #  paragraph class.
-  # @return [Array<String, Array, Time>] Array of values to be returned
-  # [String return value] 'paragraph_text' the same paragraph that was passed to the function but without the matched date character if there were any.
-  # [Array return value] 'time_array' array of 4 integer representing the hours and minutes of the from and to times
-  # [Time return value] 'date' the date in (day month year) of this paragraph taken from the matched date_regex if there was one. Will be nil if there was no match and if the date passed to the function was also nil.
-  def extract_date(paragraph_text, date)
-    TagFriend.new.extract_date(paragraph_text, date)
-  end
-end