ruby-pomodoro 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 667bcaf784b502e99b2a7c12c9191e9111d9021169536780ea0dd18d8183a10e
+  data.tar.gz: c65ec77cb4230982371ac2a873661b7c18bfc7db7825986c64a51772c45c877e
+SHA512:
+  metadata.gz: e59e0cd9616c20f6615f7c306db7b4c952c90a686cf6891b65d707c588faf1dc3f5af26c12d4f77c8717d5c3dd03e3ddec60c100c5034e757e4be02b9ef4dea6
+  data.tar.gz: a9c725792d947809e0ded09b83e53a00d9e8d64bc967b09113e36aafb7701f940c894d04f22fad53862cd1087c9d97a26c2dad8ace8fa21084fd56d908595023

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.3

data/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Change log
+
+## master
+
+## 0.4.0 (2021-11-18)
+
+- Adds Ruby 3 support
+- Fixes saving tasks
+- Fixes notifications
+
+## 0.3.4 (2020-04-04)
+
+- add fast numbers keys, select task on type number
+
+## 0.3.3 (2020-03-23)
+
+- add colors
+- activate terminal on click
+
+## 0.3.2 (2020-03-23)
+
+- fix edit tasks
+
+## 0.3.1 (2020-03-23)
+
+- fix total time
+- add error handler
+- add russian keys support
+
+
+## 0.3.0 (2020-03-21)
+
+- improved UI
+- move logic to command modules
+
+## 0.2.3 (2020-03-18)
+
+- can choose task all time
+- can edit tasks all time
+- show pause message
+- fix mini bugs
+
+## 0.2.2 (2020-03-16)
+
+- add summary time
+- fix bugs
+- repeat task
+
+## 0.2.1 (2020-03-15)
+
+- fix bugs
+
+## 0.2.0 (2020-03-15)
+
+- Add task editor
+- Add save tasks to disc
+
+## 0.1.3 (2020-03-15)
+
+- Fix output bugs
+
+## 0.1.2 (2020-03-15)
+
+- Fix bug, choose task if list of tasks is empty
+- Improvement output
+- Add print task spent time
+
+## 0.1.1 (2020-03-14)
+
+- Notification after finish pomodoro
+- Improvement stability
+
+## 0.1.0 (2020-03-13)
+
+- Base MVP.
+
+
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at skiline.alex@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby-pomodoro.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "debug", ">= 1.0.0"

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    ruby-pomodoro (0.3.4)
+      aasm (~> 5)
+      pastel (~> 0.8)
+      terminal-notifier
+      tty-cursor (~> 0.6)
+      tty-editor (~> 0.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aasm (5.2.0)
+      concurrent-ruby (~> 1.0)
+    concurrent-ruby (1.1.9)
+    debug (1.3.4)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    diff-lcs (1.4.4)
+    io-console (0.5.9)
+    irb (1.3.7)
+      reline (>= 0.2.7)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rake (12.3.3)
+    reline (0.2.7)
+      io-console (~> 0.5)
+    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.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    terminal-notifier (2.0.0)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-editor (0.7.0)
+      tty-prompt (~> 0.22)
+    tty-prompt (0.23.1)
+      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)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debug (>= 1.0.0)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  ruby-pomodoro!
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexander Shvaykin
+
+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,46 @@
+![Ruby](https://github.com/AlexanderShvaykin/pomodoro-tracker/workflows/Ruby/badge.svg?branch=master)
+
+# Ruby::Pomodoro
+
+[Pomodoro](https://en.wikipedia.org/wiki/Pomodoro_Technique) CLI task tracker
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-pomodoro'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby-pomodoro
+
+## Usage
+
+    $ ruby-pomodoro
+
+Then you will see an interactive interface where you can add and perform tasks.
+
+## 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 tags, 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/[USERNAME]/ruby-pomodoro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ruby-pomodoro/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ruby::Pomodoro project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby-pomodoro/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby/pomodoro"
+
+# 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/ruby-pomodoro

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "ruby/pomodoro"
+
+Ruby::Pomodoro.start

data/lib/ruby/pomodoro/cmd/base.rb

@@ -0,0 +1,40 @@
+# Commands for each user action
+module Ruby
+  module Pomodoro
+    module Cmd
+      class Base
+        include TimeHelpers
+
+        # @param [Ruby::Pomodoro::Printer] printer
+        # @param prompt [Object]
+        def initialize(printer: Ruby::Pomodoro::Printer.new, prompt: TTY::Prompt.new, worker: Ruby::Pomodoro::Worker.instance)
+          @printer = printer
+          @prompt  = prompt
+          @worker  = worker
+        end
+
+        # @abstract
+        # @return [Symbol, NilClass]
+        def call; end
+
+        private
+
+        attr_reader :prompt, :worker
+
+        def print(clear: true, **options)
+          @printer.clear_terminal if clear
+
+          type, value = options.first
+          case type
+          when :template
+            @printer.print_template(value, binding)
+          when :text
+            @printer.print(value, color: options[:color])
+          else
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/pomodoro/cmd/choose_task.rb

@@ -0,0 +1,33 @@
+module Ruby
+  module Pomodoro
+    module Cmd
+      # Select task and start worker
+      class ChooseTask < Base
+        # @param [Ruby::Pomodoro::Worker] worker
+        def call
+          worker.pause if worker.working?
+          print
+          task = Ruby::Pomodoro::Tasks::Resource.find(select_task(worker.current_task))
+          Main.new.call
+          if task
+            worker.stop
+            worker.start(task)
+          else
+            worker.resume if worker.paused?
+          end
+          :ok
+        end
+
+        private
+
+        def select_task(current_task)
+          options = Ruby::Pomodoro::Tasks::Resource.all.map do |task|
+            disable = task == current_task ? "(The task in progress)" : nil
+            { value: task.id, name: task.name, disabled: disable }
+          end
+          prompt.select("Select task", [*options, { name: "exit", value: 0 }])
+        end
+      end
+    end
+  end
+end

data/lib/ruby/pomodoro/cmd/edit_list.rb

@@ -0,0 +1,15 @@
+module Ruby
+  module Pomodoro
+    module Cmd
+      class EditList < Base
+        def call(editor)
+          print
+          worker.stop
+          editor.save
+          editor.edit
+          Main.new.call
+        end
+      end
+    end
+  end
+end

data/lib/ruby/pomodoro/cmd/error_handler.rb

@@ -0,0 +1,17 @@
+module Ruby
+  module Pomodoro
+    module Cmd
+      class ErrorHandler < Base
+        def call(error)
+          path = File.join(Dir.home, ".ruby-pomodoro", "log")
+          Logger.new(path).error(error.message)
+          print text: "Oops! Error! Detail info in the log file (~/.ruby-pomodoro/log)\n", color: :red
+          prompt.keypress(
+            "Press any key to continue, resumes automatically in 3 seconds ...", timeout: 3
+          )
+          Main.new.call
+        end
+      end
+    end
+  end
+end

data/lib/ruby/pomodoro/cmd/main.rb

@@ -0,0 +1,15 @@
+module Ruby
+  module Pomodoro
+    # Print tasks list and commands list
+    module Cmd
+      class Main < Base
+        # @return [Symbol] signal for controller
+        def call
+          @tasks = Ruby::Pomodoro::Tasks::Resource.all
+          print template: :main
+          :ok
+        end
+      end
+    end
+  end
+end

data/lib/ruby/pomodoro/cmd/pause.rb

@@ -0,0 +1,27 @@
+module Ruby
+  module Pomodoro
+    module Cmd
+      class Pause < Base
+        def call
+          if worker.working?
+            Main.new.call
+            worker.pause
+            choices = [
+              { key: 'y', name: "Resume this task", value: true },
+              { key: 'n', name: 'Stop this task', value: false },
+            ]
+            print text: "#{worker.current_task.name} was paused\n", color: :yellow, clear: false
+            if prompt.expand("Resume?", choices)
+              Main.new.call
+              worker.resume
+            else
+              Stop.new.call
+            end
+          else
+            Main.new.call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby/pomodoro/cmd/quit.rb

@@ -0,0 +1,19 @@
+module Ruby
+  module Pomodoro
+    module Cmd
+      # Save tasks and stop program
+      class Quit < Base
+        # @param [Ruby::Pomodoro::Tasks::Editor] editor
+        # @return [Symbol]
+        def call(editor)
+          worker.delete_observers
+          worker.stop
+          editor.save
+          Main.new.call
+          print text: "Bye!\n", color: :green, clear: false
+          :quit
+        end
+      end
+    end
+  end
+end

data/lib/ruby/pomodoro/cmd/stop.rb

@@ -0,0 +1,12 @@
+module Ruby
+  module Pomodoro
+    module Cmd
+      class Stop < Base
+        def call
+          worker.stop
+          Main.new.call
+        end
+      end
+    end
+  end
+end

data/lib/ruby/pomodoro/command_controller.rb

@@ -0,0 +1,42 @@
+module Ruby
+  module Pomodoro
+    module CommandController
+      class << self
+        def call(event)
+          signal =
+            case event.value
+            when 'q', 'й'
+              Cmd::Quit.new.call(Pomodoro.editor)
+            when 'c', 'с'
+              Cmd::ChooseTask.new.call
+            when 'e', 'у'
+              Cmd::EditList.new.call(Pomodoro.editor)
+            when 'p', 'з'
+              Cmd::Pause.new.call
+            when 's', 'ы'
+              Cmd::Stop.new.call
+            when 'R', 'К'
+              Worker.instance.then do |worker|
+                task = worker.current_task
+                worker.start(task) if task
+                Cmd::Main.new.call
+              end
+            when /[1-9]/
+              Worker.instance.then do |worker|
+                task = Ruby::Pomodoro::Tasks::Resource.find(event.value.to_i)
+                return if task.nil? || task.id == worker.current_task&.id
+
+                Cmd::Main.new.call
+                worker.stop
+                worker.start(task)
+              end
+            else
+              Cmd::Main.new.call
+            end
+          abort if signal == :quit
+        end
+        alias_method :keypress, :call
+      end
+    end
+  end
+end

data/lib/ruby/pomodoro/notification.rb

@@ -0,0 +1,40 @@
+module Ruby
+  module Pomodoro
+    class Notification
+      attr_reader :message
+
+      # @param message [String] Message
+      # @param channel [Object, Module] Channel to push message
+      def initialize(message, channel)
+        @message = message
+        @channel = channel
+      end
+
+      # @param repeat_at [Numeric] Time to repeat
+      # @param skip_now [Boolean] Skip notify after call, default: +false+
+      # @return [TrueClass]
+      def notify(repeat_at = nil, skip_now: false)
+        @channel.call(message) unless skip_now
+        repeat(repeat_at) if repeat_at
+        true
+      end
+
+      # @return [TrueClass]
+      def stop
+        @thread&.kill
+        true
+      end
+
+      private
+
+      def repeat(time_at)
+        @thread = Thread.new do
+          loop do
+            sleep time_at
+            @channel.call(message)
+          end
+        end
+      end
+    end
+  end
+end