micro_manager 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f01d3a2b0ca42701e6db6495bde53401187fb9e88642036e174dbb2aba5ec01c
+  data.tar.gz: 7e0c1aa8fdadc1758a874f7f883bfaf5d47b568dd7c092cb481f3d5569217178
+SHA512:
+  metadata.gz: 4f5b6062a84749f6595717ad23ae0aaf4be72e2ba90e1cc706659627391320eada050dc8e568a21d96b4cf11e8105e6933df8ec1dedd78248f30b9617d7f29cb
+  data.tar.gz: d6a55e88eac46618e317e67a1605f68ee6d17def31aa55b3e972217a3f710e7f4dbb878555556bbf1dcf2a01aef2463baae9e44bc7e2f550ea86a007ccd2ed05

data/.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Install gems
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+    - name: Run Rubocop
+      run: bundle exec rubocop
+    - name: Run tests
+      run: |
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+micro_manager-*.gem
+*.swp
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 200
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/Documentation:
+  Enabled: false
+Style/AccessModifierDeclarations:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true
+  IgnoreNotImplementedMethods: true
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.0

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in micro_manager.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem "tty-prompt", "~> 0.23.0"
+gem "tty-table", "~> 0.12.0"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    micro_manager (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    strings (0.2.0)
+      strings-ansi (~> 0.2)
+      unicode-display_width (~> 1.5)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.0)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    tty-table (0.12.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-screen (~> 0.8)
+    unicode-display_width (1.7.0)
+    unicode_utils (1.4.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  micro_manager!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  tty-prompt (~> 0.23.0)
+  tty-table (~> 0.12.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Bruno Vezoli
+
+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 PARTICULAR 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.

data/README.md

@@ -0,0 +1,43 @@
+# MicroManager
+
+This gems is aimed at improving productivity by allowing to create quick TO-DO tasks from the terminal.
+The name is a pun on [micro-management](https://en.wikipedia.org/wiki/Micromanagement) and it's usage is also inspired on
+a word they usually say a lot "Just do this feature, it should be easy", "Oh, it's just a text change. It shouldn't take long"
+
+## Installation
+
+Install it as:
+
+    $ gem install micro_manager
+
+## Usage
+
+MicroManager adds a `just` command, which can be used to add tasks like:
+
+```bash
+$ just Add what you want to do --due 1-week # you can also use a date or leave it blank to default to today
+```
+
+List tasks:
+
+```bash
+$ just --list-tasks # or -l
+```
+
+And finally complete tasks:
+
+```bash
+$ just --complete-task
+```
+
+For more detail run `just --help`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/brunvez/micro_manager.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "micro_manager"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/just

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/cli"
+
+config = MicroManager::Config.new
+persistence = MicroManager::Persistence.new(config)
+schedule = persistence.recover || MicroManager::Schedule.new
+
+command = MicroManager::CLI::CommandBuilder.new.build(ARGV)
+result = command.run(schedule: schedule)
+print result.render
+
+persistence.save(schedule)

data/lib/cli.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "tty-table"
+require_relative "micro_manager"
+require_relative "cli/relative_date"
+require_relative "cli/command_builder"
+require_relative "cli/result"
+require_relative "cli/add_task"
+require_relative "cli/list_tasks"
+require_relative "cli/complete_task"
+require_relative "cli/show_help"
+
+module MicroManager
+  module CLI
+  end
+end

data/lib/cli/add_task.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module MicroManager
+  module CLI
+    class AddTask
+      private attr_reader :description, :due
+
+      def initialize(description:, due: Date.today)
+        @description = description
+        @due = due
+      end
+
+      def run(schedule:)
+        schedule.add_task(description: description, due: due)
+
+        Result.new { "Task added successfully" }
+      end
+    end
+  end
+end

data/lib/cli/command_builder.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module MicroManager
+  module CLI
+    class CommandBuilder
+      def build(input)
+        params = parse_input(input)
+
+        if params[:help]
+          ShowHelp.new(parser)
+        elsif params[:"complete-task"]
+          CompleteTask.new
+        elsif params[:"list-tasks"] || params[:rest].empty?
+          ListTasks.new
+        else
+          task = { description: params[:rest].join(" ") }
+          task.merge!(due: params[:due]) if params[:due]
+          AddTask.new(**task)
+        end
+      end
+
+      private
+
+      def parse_input(input)
+        params = {}
+        rest = parser.parse(input, into: params)
+
+        params.merge(rest: rest)
+      end
+
+      def parser
+        OptionParser.new do |opts|
+          opts.accept(RelativeDate) do |date|
+            RelativeDate.parse(date)
+          end
+          opts.on("-d", "--due [DATE]", RelativeDate, "Date to which the task is due, defaults to Date.today. Supports relative dates (e.g. 1-day, 2-weeks, etc)")
+          opts.on("-c", "--complete-task", "Prompts on a task to mark as completed")
+          opts.on("-l", "--list-tasks", "Lists all due tasks and tasks completed today")
+          opts.on("-h", "--help", "Prints this help")
+        end
+      end
+    end
+  end
+end

data/lib/cli/complete_task.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+
+module MicroManager
+  module CLI
+    class CompleteTask
+      private attr_reader :prompt
+
+      def initialize(prompt: TTY::Prompt.new)
+        @prompt = prompt
+      end
+
+      def run(schedule:)
+        tasks = schedule.outstanding_tasks
+        options = tasks.map { |task| { task.description => task } }
+        options << { "Exit" => nil }
+
+        Result.new do
+          task = prompt.select("Complete task", options)
+          task&.complete
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/cli/list_tasks.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MicroManager
+  module CLI
+    class ListTasks
+      def run(schedule:)
+        tasks = schedule.outstanding_tasks + schedule.tasks_completed(on: Date.today)
+        rows = tasks.map { |task| task_row(task) }
+        table = TTY::Table.new(header: ["", "Description", "Due"], rows: rows)
+        renderer = TTY::Table::Renderer::Unicode.new(table, padding: [0, 1])
+
+        Result.new { renderer.render }
+      end
+
+      private
+
+      def task_row(task)
+        [
+          task.completed? ? "[X]" : "[ ]",
+          task.description,
+          task.due.to_s
+        ]
+      end
+    end
+  end
+end

data/lib/cli/relative_date.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MicroManager
+  module CLI
+    class RelativeDate
+      def self.parse(string, *args)
+        date = parse_relative_date(string)
+        return date if date
+
+        Date.parse(string, *args)
+      end
+
+      def self.parse_relative_date(string)
+        regex = /(?<n>\d+)-(?<modifier>day|week|month)/
+        matches = string.match(regex)
+        return unless matches
+
+        Date.today + date_offset(matches[:n], matches[:modifier])
+      end
+
+      def self.date_offset(num, modifier)
+        modifier_days = {
+          "day" => 1,
+          "week" => 7,
+          "month" => 30
+        }
+
+        num.to_i * modifier_days[modifier]
+      end
+    end
+  end
+end

data/lib/cli/result.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module MicroManager
+  module CLI
+    class Result
+      private attr_reader :render_block
+
+      def initialize(&block)
+        raise ArgumentError, "A block is required" unless block_given?
+
+        @render_block = block
+      end
+
+      def render
+        @render_block.call
+      end
+    end
+  end
+end

data/lib/cli/show_help.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module MicroManager
+  module CLI
+    class ShowHelp
+      private attr_reader :parser
+
+      def initialize(parser)
+        @parser = parser
+      end
+
+      def run(schedule:)
+        parser.banner = "Usage: just [task-description] [options]"
+
+        parser.help
+      end
+    end
+  end
+end

data/lib/micro_manager.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "micro_manager/version"
+require_relative "micro_manager/schedule"
+require_relative "micro_manager/task"
+require_relative "micro_manager/persistence"
+require_relative "micro_manager/config"
+
+module MicroManager
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/micro_manager/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module MicroManager
+  class Config
+    attr_reader :save_location
+
+    def initialize(**opts)
+      @save_location = opts[:save_location] || File.join(Dir.home, ".micro_manager", "schedule.yml")
+    end
+  end
+end

data/lib/micro_manager/persistence.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module MicroManager
+  class Persistence
+    private attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def save(schedule, serializer: YAML, writer: File)
+      file = config.save_location
+      serialized_schedule = serializer.dump(schedule)
+      writer.write(file, serialized_schedule)
+    end
+
+    def recover(serializer: YAML, reader: File)
+      content = reader.read(config.save_location)
+      serializer.load(content)
+    end
+  end
+end

data/lib/micro_manager/schedule.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MicroManager
+  class Schedule
+    private attr_reader :tasks
+
+    def initialize(tasks: [])
+      @tasks = tasks
+    end
+
+    def add_task(description:, due:)
+      tasks << Task.new(description: description, due: due)
+    end
+
+    def outstanding_tasks
+      tasks
+        .reject(&:completed?)
+        .sort_by(&:due)
+    end
+
+    def tasks_completed(on:)
+      tasks.select { |task| task.completed? && task.completed_on == on }
+    end
+  end
+end

data/lib/micro_manager/task.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module MicroManager
+  class Task
+    attr_reader :description, :due, :completed_on
+
+    def initialize(description:, due:)
+      @description = description
+      @due = due
+      @completed = false
+    end
+
+    def complete
+      @completed = true
+      @completed_on = Date.today
+    end
+
+    def completed?
+      @completed
+    end
+
+    def ==(other)
+      description == other.description && completed? == other.completed?
+    end
+  end
+end

data/lib/micro_manager/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MicroManager
+  VERSION = "1.0.0"
+end

data/micro_manager.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/micro_manager/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "micro_manager"
+  spec.version       = MicroManager::VERSION
+  spec.authors       = ["Bruno Vezoli"]
+  spec.email         = ["brunvez@gmail.com"]
+
+  spec.license = "MIT"
+
+  spec.summary       = "A utility to help get shit done"
+  spec.description   = "A glorified TO-DO list with a couple of useful commands"
+  spec.homepage      = "https://github.com/brunvez/micro_manager"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/brunvez/micro_manager"
+  spec.metadata["changelog_uri"] = "https://github.com/brunvez/micro_manager/blob/master/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rubocop", "~> 1.7"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: micro_manager
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bruno Vezoli
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: A glorified TO-DO list with a couple of useful commands
+email:
+- brunvez@gmail.com
+executables:
+- just
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/just
+- lib/cli.rb
+- lib/cli/add_task.rb
+- lib/cli/command_builder.rb
+- lib/cli/complete_task.rb
+- lib/cli/list_tasks.rb
+- lib/cli/relative_date.rb
+- lib/cli/result.rb
+- lib/cli/show_help.rb
+- lib/micro_manager.rb
+- lib/micro_manager/config.rb
+- lib/micro_manager/persistence.rb
+- lib/micro_manager/schedule.rb
+- lib/micro_manager/task.rb
+- lib/micro_manager/version.rb
+- micro_manager.gemspec
+homepage: https://github.com/brunvez/micro_manager
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/brunvez/micro_manager
+  source_code_uri: https://github.com/brunvez/micro_manager
+  changelog_uri: https://github.com/brunvez/micro_manager/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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 utility to help get shit done
+test_files: []