todo_cli_app 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95063a1e4b786e7bbf9791959c9c4b91391dc624d8f9dcaa46fcd32e1e4baaf9
+  data.tar.gz: 626f4c7c37a78542373e72af0186535a80aaf5bf8c44f8820a5397496e5b06b0
+SHA512:
+  metadata.gz: a5483884fc56111c19e7783406c886b1eb40b2478969f7774781d103f8a7565df364643d03aeea8c7d134779e9a8444daf0d278c22ba2a9bc078a233e385ba4e
+  data.tar.gz: 3410c99f7bc59e047a216d83e6c07bda2d1a2f95e5de123d0ff459bdd3aefdfb31ed32f7c3679d623c9562f0035b1945db7152f266f4af6bc955ed3b2f6a860a

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2021 Juan Manuel Ramallo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A ARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.P

data/README.md

@@ -0,0 +1,16 @@
+# What?
+A to-do app, the ruby cli-only edition to-do app [insert registered mark logo here].
+
+# Why?
+Why not?
+
+# How to use
+
+1. `link ./exe/todo /usr/local/bin/todo` or whatever folder that is present in $PATH
+2. `todo -h` to get started
+
+# Contribute
+Do not. This is just for fun.
+
+# License
+It's fancier with [a license](https://opensource.org/licenses/MIT)

data/exe/todo

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'todo'
+
+options = ToDo::Parser.new(ARGV).parse
+context = ToDo::Context.new(options)
+
+if options.query
+  ToDo::Finder.new(context: context, query: options.query).find
+elsif options.visualize
+  ToDo::Visualizer.new(context).view
+else
+  ToDo::Session.new(context).start
+end

data/lib/context.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ToDo
+  #
+  # Context object that provides general info for all objects in the to-do app.
+  #
+  class Context
+    DIR_PATH = '.todo'
+
+    attr_reader :options
+
+    def initialize(options)
+      @options = options
+    end
+
+    def dir_path
+      File.join(Dir.home, DIR_PATH)
+    end
+
+    def file_name
+      "#{options.date}.md"
+    end
+
+    def file_path
+      File.join(dir_path, file_name)
+    end
+  end
+end

data/lib/finder.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ToDo
+  #
+  # Finds text in to-dos entries. Relies on system's `find' and `grep' commands.
+  #
+  class Finder
+    attr_reader :context, :query
+
+    def initialize(context:, query:)
+      @context = context
+      @query = query
+    end
+
+    def find
+      system("find #{context.dir_path} -type f | xargs grep -Hni \"#{query}\"")
+    end
+  end
+end

data/lib/parser.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module ToDo
+  #
+  # OptionParser wrapper for the to-do app.
+  #
+  class Parser
+    Options = Struct.new(:date, :yesterday, :query, :visualize, keyword_init: true)
+
+    attr_reader :args
+
+    def initialize(args)
+      @args = args
+    end
+
+    def parse
+      OptionParser.new do |parser|
+        parser.banner = <<~TXT
+          A ruby CLI-only To Do app, because why not?
+          Usage:
+            todo -d, --date 2020-12-25  # Open todo for the date
+            todo -y, --yesterday        # Open todo yesterday
+            todo                        # Open todo for today
+            todo -f, --find algo        # Looks for todo with word "algo"
+            todo -v, --visualize        # Opens an HTML file with the to-dos
+
+        TXT
+
+        parser.on('-y', '--yesterday', "Todo's for yesterday") do |y|
+          options.yesterday = y
+          options.date = Date.today - 1
+        end
+
+        parser.on('-dDATE', '--date=DATE', "Todo's date") do |d|
+          options.date = parse_date(d)
+        end
+
+        parser.on('-fQUERY', '--find=QUERY', 'Looks for query') do |q|
+          options.query = q
+        end
+
+        parser.on('-v', '--visualize', 'Visualize a todo list') do |v|
+          options.visualize = v
+        end
+
+        parser.parse!(args)
+      end
+
+      options
+    end
+
+    private
+
+    def options
+      @options ||= Options.new(date: Date.today)
+    end
+
+    def parse_date(date)
+      case date
+      when /[0-9]{4}-[0-9]{2}-[0-9]{2}/
+        Date.parse(date)
+      when nil, ''
+        Date.today
+      else
+        raise 'WAT'
+      end
+    end
+  end
+end

data/lib/session.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ToDo
+  #
+  # Creates or reopens a to-do file for the given date.
+  #
+  class Session
+    # TODO: Add support for custom templates
+    TEMPLATE = ERB.new(<<~ERB).freeze
+      # <%= @date %>
+
+      ## To-do
+        -
+      ## Plan
+        -
+      ## Questions
+        -
+    ERB
+
+    attr_reader :context
+
+    def initialize(context)
+      @context = context
+      @date = context.options.date
+
+      Dir.mkdir(context.dir_path) unless Dir[context.dir_path].any?
+      prepare_todo_file
+    end
+
+    def start
+      system("$EDITOR #{context.file_path}")
+    end
+
+    private
+
+    def prepare_todo_file
+      return if Dir[context.file_path].any?
+
+      File.open(context.file_path, 'w') do |f|
+        f.puts TEMPLATE.result(self.binding)
+      end
+    end
+  end
+end

data/lib/todo.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'optparse'
+require 'date'
+require 'erb'
+
+require 'context'
+require 'session'
+require 'parser'
+require 'finder'
+require 'visualizer'
+require 'version'

data/lib/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ToDo
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 0
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
+end

data/lib/visualizer.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ToDo
+  #
+  # Relies on pandoc to generate HTML out from a Github flavored markdown file.
+  # https://pandoc.org/installing.html
+  #
+  class Visualizer
+    CSS_URL = 'https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/4.0.0/github-markdown.min.css'
+    BODY_CSS = <<~CSS
+      max-width: 700px;
+      margin: 40px auto;
+    CSS
+
+    attr_reader :context
+
+    def initialize(context)
+      @context = context
+    end
+
+    def view
+      raise 'Something failed with Pandoc' unless system(command)
+
+      update_body_class
+      system("open #{tmpfile}")
+    end
+
+    private
+
+    def command
+      [
+        "pandoc #{context.file_path}",
+        '-f gfm',
+        '-s',
+        "-o #{tmpfile}",
+        '--metadata title="TODO"',
+        "-c #{CSS_URL}"
+      ].join(' ')
+    end
+
+    def tmpfile
+      "#{File.join(Dir.tmpdir, context.file_name)}.html"
+    end
+
+    # TODO: This can be updated to just modify the body tag
+    def update_body_class
+      html = File.read(tmpfile)
+      html.sub!('<body>', "<body class='markdown-body' style='#{BODY_CSS}'>")
+      File.open(tmpfile, 'wb') { |f| f.puts(html) }
+    end
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: todo_cli_app
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Manuel Ramallo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-27 00:00:00.000000000 Z
+dependencies: []
+description: A to-do app, the ruby cli-only edition to-do app [insert registered mark
+  logo here].
+email: juanmanuelramallo@hey.com
+executables:
+- todo
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- exe/todo
+- lib/context.rb
+- lib/finder.rb
+- lib/parser.rb
+- lib/session.rb
+- lib/todo.rb
+- lib/version.rb
+- lib/visualizer.rb
+homepage: https://github.com/juanmanuelramallo/todo
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/juanmanuelramallo/todo
+  source_code_uri: https://github.com/juanmanuelramallo/todo
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A ruby cli-only to-do app
+test_files: []