work_md 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b513f11cea5e174a366551222bcd7c3a9ae12494ecdbb7d5f6b326bfe259cd0
-  data.tar.gz: 96951bcfd495236d08d41a912171caac121afd74413aaf2a920b2985dec7a392
+  metadata.gz: e1c858bf12a976912f85e9fd1a22b39e2bd5daf4e56ec46299c1297aa4e576cb
+  data.tar.gz: 8a542af4507b9765d9317f23ad7db72bc1f4cf8ffe7bc27342ea9c1e8f592e82
 SHA512:
-  metadata.gz: 1dc33cce0525aa56a359619cfae40acd1809317844789ebf50adce5d038f410026a3232cf1bbbf15c63d9c9747c010fee84a339ba436d6cc431e7af6f40b8f84
-  data.tar.gz: 732380d8fa80db98fff04ef5cbd662b789afecc0e68939700a77576fd75731b6339390e303d51b1e0f27a86a0dabf9f0dd6b04a3cb9afcae1376054874aee63c
+  metadata.gz: '02389407af0f604e5cf9fac532639b5cb5553179cd98d67fa18aecf56bc182cccbc2bc674cd1f8ca3f5b11ede62d82d8b85320613a55e0cf6d432f273618e06a'
+  data.tar.gz: 3983b233410dd07224abf01bf74998c31307780b52b43cdb83495d4745ed83938c72d0f0cb449e34dcdb7cded9e28fd5dec440fedacd823446f8ec0309152457

data/lib/work_md.rb

@@ -3,9 +3,13 @@
 require_relative 'work_md/version'
 require_relative 'work_md/config'
 require_relative 'work_md/commands/today'
+require_relative 'work_md/parser/engine'
+require_relative 'work_md/commands/parse'
 require_relative 'work_md/cli'
 require 'date'
 require 'fileutils'
+require 'tty-box'
+require 'tty-editor'
 
 module WorkMd
 end

data/lib/work_md/cli.rb

@@ -6,7 +6,8 @@ module WorkMd
 
     ALIAS_COMMANDS =
       {
-        't' => 'today'
+        't' => 'today',
+        'p' => 'parse'
       }.freeze
 
     DEFAULT_COMMAND = WorkMd::Commands::Today
@@ -23,17 +24,40 @@ module WorkMd
         .const_get("WorkMd::Commands::#{command}")
         .send(:execute, argv)
     rescue NameError
-      error("Command '#{first_argv_argument}' not found!")
+      puts info(
+        ::TTY::Box.frame(
+          "Command '#{first_argv_argument}' not found!",
+          **error_frame_style
+        )
+      )
     rescue CommandMissing
       DEFAULT_COMMAND.execute(argv)
     end
 
-    def self.error(message)
-      puts 'x - work_md error ------ x'
-      puts ''
-      puts message
-      puts ''
-      puts 'x ---------------------- x'
+    def self.info(message = '')
+      # rubocop:disable Layout/LineLength
+      puts ::TTY::Box.frame(
+        message,
+        'Track your work activities, write annotations, recap what you did for a week, month or specific days... and much more!',
+        '',
+        'commands available:',
+        '',
+        '- work_md',
+        '- work_md today',
+        '- work_md parse',
+        '',
+        'read more in github.com/henriquefernandez/work_md',
+        padding: 1,
+        title: { top_left: '(work_md)', bottom_right: "(v#{WorkMd::VERSION})" }
+      )
+      # rubocop:enable Layout/LineLength
+    end
+
+    def self.error_frame_style
+      {
+        padding: 1,
+        title: { top_left: '(error)' }
+      }
     end
   end
 end

data/lib/work_md/commands/parse.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module WorkMd
+  module Commands
+    class Parse
+      PARSED_FILE_PATH = WorkMd::Config.work_dir + '/parsed.md'
+
+      class << self
+        def execute(argv = [])
+          begin
+            args = Hash[argv.join(' ').scan(/-?([^=\s]+)(?:=(\S+))?/)]
+            parser = WorkMd::Parser::Engine.new
+            t = WorkMd::Config.translations
+
+            year = args['y'] || Time.new.year
+            month = args['m'] || Time.new.month
+
+            month = "0#{month.to_i}" if month.to_i < 10
+
+            args['d'].split(',').each do |day|
+              day = "0#{day.to_i}" if day.to_i < 10
+
+              file_name = WorkMd::Config.work_dir + "/#{year}/#{month}/#{day}.md"
+
+              parser.add_file(file_name)
+            end
+
+            parser.freeze
+
+            File.delete(PARSED_FILE_PATH) if File.exist? PARSED_FILE_PATH
+
+            File.open(PARSED_FILE_PATH, 'w+') do |f|
+              f.puts("# #{WorkMd::Config.title}\n\n")
+              f.puts("### #{t[:tasks]} (#{parser.tasks.size}):\n\n")
+              parser.tasks.each do |task|
+                f.puts("- [#{task}\n\n") if task != ' ]'
+              end
+              f.puts("---\n\n")
+              f.puts("### #{t[:meetings]} (#{parser.meetings.size}):\n\n")
+              parser.meetings.each do |meeting|
+                f.puts("- #{meeting}\n\n")
+              end
+              f.puts("---\n\n")
+              f.puts("### #{t[:annotations]}:\n\n")
+              parser.annotations.each do |annotation|
+                f.puts("- #{annotation.gsub('###', '')}") unless annotation.nil?
+              end
+              f.puts("###### #{t[:meeting_annotations]}:\n\n")
+              parser.meeting_annotations.each do |meeting_annotation|
+                f.puts("- #{meeting_annotation}\n\n")
+              end
+              f.puts("---\n\n")
+              f.puts("### #{t[:interruptions]} (#{parser.interruptions.size}):\n\n")
+              parser.interruptions.each do |interruption|
+                f.puts("- #{interruption}\n\n")
+              end
+              f.puts("---\n\n")
+              f.puts("### #{t[:difficulties]} (#{parser.difficulties.size}):\n\n")
+              parser.difficulties.each do |difficulty|
+                f.puts("- #{difficulty}\n\n")
+              end
+              f.puts("---\n\n")
+              f.puts("### #{t[:pomodoros]}:\n\n")
+              f.puts(parser.pomodoros)
+            end
+
+            editor = WorkMd::Config.editor
+
+            unless editor.nil?
+              ::TTY::Editor.open(PARSED_FILE_PATH, {command: editor})
+            else
+              ::TTY::Editor.open(PARSED_FILE_PATH)
+            end
+          rescue
+            WorkMd::Cli.info(
+              ::TTY::Box.frame(
+                "Usage examples:",
+                "",
+                "work_md parse -d=1 -m=5 -y=2000 | get day 1 from month 5 and year 2000",
+                "work_md parse -d=1,2,3          | get day 1, 2 and 3 from the current month and year",
+                "work_md parse -d=1,2 -m=4       | get day 1 and 2 from month 4 and current year",
+                **WorkMd::Cli.error_frame_style
+              )
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/work_md/commands/today.rb

@@ -4,44 +4,50 @@ module WorkMd
   module Commands
     class Today
       class << self
-        def description; end
-
         def execute(_argv = [])
           today = DateTime.now
+          t = WorkMd::Config.translations
+          work_dir = WorkMd::Config.work_dir
 
           ::FileUtils
-            .mkdir_p("#{WorkMd::Config.work_dir}/#{today.strftime('%Y/%m')}")
+            .mkdir_p("#{work_dir}/#{today.strftime('%Y/%m')}")
           unless ::File
                  .exist?(
-                   "#{WorkMd::Config.work_dir}/#{today.strftime('%Y/%m/%d')}.md"
+                   "#{work_dir}/#{today.strftime('%Y/%m/%d')}.md"
                  )
             ::File.open(
-              "#{WorkMd::Config.work_dir}/#{today.strftime('%Y/%m/%d')}.md",
+              "#{work_dir}/#{today.strftime('%Y/%m/%d')}.md",
               'w+'
             ) do |f|
-              f.puts("# #{today.strftime('%d/%m/%Y')} \n\n")
-              f.puts("### Atividades:\n\n")
+              f.puts("# #{today.strftime('%d/%m/%Y')} - #{WorkMd::Config.title} \n\n")
+              f.puts("### #{t[:tasks]}:\n\n")
               f.puts("- [ ]\n\n")
               f.puts("---\n\n")
-              f.puts("### Reuniões:\n\n")
+              f.puts("### #{t[:meetings]}:\n\n")
               f.puts("---\n\n")
-              f.puts("### Anotações:\n\n")
-              f.puts("###### Anotações de Reunião:\n\n")
+              f.puts("### #{t[:annotations]}:\n\n")
+              f.puts("###### #{t[:meeting_annotations]}:\n\n")
               f.puts("---\n\n")
-              f.puts("### Interrupções:\n\n")
+              f.puts("### #{t[:interruptions]}:\n\n")
               f.puts("---\n\n")
-              f.puts("### Dificuldades:\n\n")
+              f.puts("### #{t[:difficulties]}:\n\n")
               f.puts("---\n\n")
-              f.puts("### Pomodoros:\n\n")
+              f.puts("### #{t[:pomodoros]}:\n\n")
               f.puts("0\n\n")
-              f.puts("---\n\n")
-              f.puts("### Ponto:\n\n")
-              f.puts("- \n\n")
             end
           end
 
-          ::FileUtils.cd(WorkMd::Config.work_dir) do
-            system("#{WorkMd::Config.editor} #{today.strftime('%Y/%m/%d')}.md")
+          editor = WorkMd::Config.editor
+
+          ::FileUtils.cd(work_dir) do
+            unless editor.nil?
+              ::TTY::Editor.open(
+                "#{today.strftime('%Y/%m/%d')}.md",
+                {command: editor}
+              )
+            else
+              ::TTY::Editor.open("#{today.strftime('%Y/%m/%d')}.md")
+            end
           end
         end
       end

data/lib/work_md/config.rb

@@ -1,16 +1,55 @@
 # frozen_string_literal: true
 
-# TODO: Make this a class with receive an yaml file directory,
-# this is easier to mock in test
-# TODO: Set language (i18n) as a config
+require 'yaml'
+
 module WorkMd
   module Config
+    DEFAULT_WORK_DIR = Dir.home + '/work_md'
+    TRANSLATIONS = {
+      'pt' =>
+        {
+          tasks: 'Atividades',
+          meetings: 'Reuniões',
+          annotations: 'Anotações',
+          meeting_annotations: 'Anotações de Reunião',
+          interruptions: 'Interrupções',
+          difficulties: 'Dificuldades',
+          pomodoros: 'Pomodoros'
+        },
+      'en' =>
+        {
+          tasks: 'Tasks',
+          meetings: 'Meetings',
+          annotations: 'Annotations',
+          meeting_annotations: 'Meeting Annotations',
+          interruptions: 'Interruptions',
+          difficulties: 'Difficulties',
+          pomodoros: 'Pomodoros'
+        }
+    }.freeze
+
+    def self.title
+      yaml_file['title'] || ''
+    end
+
     def self.editor
-      ENV['EDITOR']
+      ENV['EDITOR'] || ENV['VISUAL'] || yaml_file['editor'] || nil
     end
 
     def self.work_dir
-      "#{Dir.home}/work_md/"
+      ENV['WORK_MD_DIR'] || DEFAULT_WORK_DIR
+    end
+
+    def self.translations
+      TRANSLATIONS[ENV['WORK_MD_LANG']] ||
+        TRANSLATIONS[yaml_file['lang']] ||
+        TRANSLATIONS['en']
+    end
+
+    def self.yaml_file
+      YAML.load_file(DEFAULT_WORK_DIR + '/config.yml')
+    rescue StandardError
+      {}
     end
   end
 end

data/lib/work_md/parser/engine.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module WorkMd
+  module Parser
+    class Engine
+      IS_FROZEN_ERROR_MESSAGE = 'WorkMd::Parser::Engine is frozen'
+      IS_NOT_FROZEN_ERROR_MESSAGE = 'WorkMd::Parser::Engine is not frozen'
+
+      class ParsedFile
+        attr_accessor :tasks,
+                      :annotations,
+                      :meeting_annotations,
+                      :meetings,
+                      :interruptions,
+                      :difficulties,
+                      :pomodoros
+      end
+
+      def initialize
+        @t = WorkMd::Config.translations
+        @parsed_files = []
+        @frozen = false
+      end
+
+      def add_file(file)
+        raise IS_FROZEN_ERROR_MESSAGE if @frozen
+
+        begin
+          file_content = File.read(file)
+        rescue Errno::ENOENT
+          return
+        end
+
+        return unless file_content.start_with?('# ')
+
+        @parsed_files.push(parse_file_content(file_content))
+      end
+
+      def done_tasks
+        raise IS_NOT_FROZEN_ERROR_MESSAGE unless @frozen
+
+        @done_tasks ||=
+          tasks.filter { |t| t.start_with?('x]') || t.start_with?('X]') }
+      end
+
+      def tasks
+        raise IS_NOT_FROZEN_ERROR_MESSAGE unless @frozen
+
+        @tasks ||= @parsed_files.map(&:tasks).flatten
+      end
+
+      def annotations
+        raise IS_NOT_FROZEN_ERROR_MESSAGE unless @frozen
+
+        @annotations ||= @parsed_files.map(&:annotations).flatten
+      end
+
+      def meeting_annotations
+        raise IS_NOT_FROZEN_ERROR_MESSAGE unless @frozen
+
+        @meeting_annotations ||=
+          @parsed_files.map(&:meeting_annotations).flatten
+      end
+
+      def meetings
+        raise IS_NOT_FROZEN_ERROR_MESSAGE unless @frozen
+
+        @meetings ||= @parsed_files.map(&:meetings).flatten
+      end
+
+      def interruptions
+        raise IS_NOT_FROZEN_ERROR_MESSAGE unless @frozen
+
+        @interruptions ||= @parsed_files.map(&:interruptions).flatten
+      end
+
+      def difficulties
+        raise IS_NOT_FROZEN_ERROR_MESSAGE unless @frozen
+
+        @difficulties ||= @parsed_files.map(&:difficulties).flatten
+      end
+
+      def pomodoros
+        raise IS_NOT_FROZEN_ERROR_MESSAGE unless @frozen
+
+        @pomodoros ||=
+          @parsed_files.reduce(0) { |sum, f| sum + f.pomodoros || 0 }
+      end
+
+      def freeze
+        @frozen = true
+      end
+
+      private
+
+      def parse_file_content(file_content)
+        parsed_file = ParsedFile.new
+
+        file_content
+          .split('### ')
+          .each { |content| parse_content(parsed_file, content) }
+
+        parsed_file
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      def parse_content(parsed_file, content)
+        if content.start_with?(@t[:tasks])
+          parsed_file.tasks = parse_task_list(content)
+        elsif content.start_with?(@t[:meetings])
+          parsed_file.meetings = parse_list(content)
+        elsif content.start_with?(@t[:meeting_annotations])
+          parsed_file.meeting_annotations = basic_parse(content)
+        elsif content.start_with?(@t[:annotations])
+          parsed_file.annotations = basic_parse(content)
+        elsif content.start_with?(@t[:interruptions])
+          parsed_file.interruptions = parse_list(content)
+        elsif content.start_with?(@t[:difficulties])
+          parsed_file.difficulties = parse_list(content)
+        elsif content.start_with?(@t[:pomodoros])
+          parsed_file.pomodoros = parse_pomodoro(content)
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      def parse_task_list(content)
+        clear_list(basic_parse(content).split('- ['))
+      end
+
+      def parse_list(content)
+        clear_list(basic_parse(content).split('- '))
+      end
+
+      def parse_pomodoro(content)
+        basic_parse(content).scan(/\d+/).first.to_i
+      end
+
+      def basic_parse(content)
+        content.split(":\n\n")[1]
+      end
+
+      def clear_list(list)
+        return list unless list.is_a?(Array)
+
+        list
+          .map { |s| s.gsub('---', '') unless s.nil? }
+          .filter { |s| (s != '') && (s != "\n\n") }
+          .map(&:strip)
+      end
+    end
+  end
+end

data/lib/work_md/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WorkMd
-  VERSION = '0.1.0'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: work_md
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Henrique Fernandez Teixeira
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
-dependencies: []
+date: 2021-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-box
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: tty-editor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 description:
 email:
 - hriqueft@gmail.com
@@ -23,8 +51,10 @@ files:
 - bin/work_md
 - lib/work_md.rb
 - lib/work_md/cli.rb
+- lib/work_md/commands/parse.rb
 - lib/work_md/commands/today.rb
 - lib/work_md/config.rb
+- lib/work_md/parser/engine.rb
 - lib/work_md/version.rb
 homepage:
 licenses: