tmuxodoro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e09e03af89e8b2a3ad8a547245ed87cdaddf2373
+  data.tar.gz: 3ab70098e7a9503f31256975bf2220b7e5b0fe87
+SHA512:
+  metadata.gz: 49269d25b60572ce93b8788fbf4a30442a909e9b1030ca5cf9e5828ce38e05871e68f7a95842c9023b0bd984d037a7529ee7d40b6bd72fa6bdd5f08c33f89a63
+  data.tar.gz: f61d465bd347594aebd83035bb9b5ffcd0bb391e09641fba86c9c2bbe79dac18e1b7820f5d913d56d00691088a3c4073ab4b48427b1fd5301347cecada910166

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+tmuxodoro-*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.0
+  - 2.3.0
+  - 2.0.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tmuxodoro.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Timur Yanberdin
+
+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,69 @@
+# Tmuxodoro [![Build Status](https://travis-ci.org/mendab1e/tmuxodoro.svg?branch=master)](https://travis-ci.org/mendab1e/tmuxodoro)
+
+**Tmuxodoro** is a minimalistic pomodoro timer designed for tmux.
+
+It can display how many pomodoros remain
+
+<img width="333" alt="screen shot 2017-04-12 at 01 55 05" src="https://cloud.githubusercontent.com/assets/854386/24934268/3875a202-1f23-11e7-9d1f-ed4659727809.png">
+
+How much time remains until the end of a pomodoro
+
+<img width="318" alt="screen shot 2017-04-12 at 01 55 40" src="https://cloud.githubusercontent.com/assets/854386/24934306/778fcf94-1f23-11e7-8c04-23d3acda1041.png">
+
+And how much time remains for a rest
+
+<img width="326" alt="screen shot 2017-04-12 at 01 56 04" src="https://cloud.githubusercontent.com/assets/854386/24934341/bb4714a4-1f23-11e7-9bed-9e162a816715.png">
+
+tmuxodoro doesn't have any stupid notifications or other distraction sounds.
+
+
+
+## Installation
+
+Check that you have Ruby >= 2.0 installed, then install tmuxodoro:
+
+    $ gem install tmuxodoro
+
+## Usage
+
+You can run tmuxodoro with default configurations (8 tomatoes, 25 minutes per tomato and 5 minutes for a rest):
+
+	$ tmuxodoro
+
+Or you can set configurations with ENV variables:
+
+	$ env TOMATOES=8 TOMATO_TIME=25 REST_TIME=5 tmuxodoro
+
+Actually tmuxodoro is a pomodoro timer with HTTP interface, so you need to configure tmux to make requests via curl and display output to a statusbar.
+Add the following line to `~/.tmux.conf`:
+
+	set -g status-left ' #(curl localhost:3080) '
+
+You can select another port with `ENV['PORT']`, don't forget to change requests in this case.
+
+To start a new pomodoro you need to send the following request:
+
+	$ curl localhost:3080/start
+
+Also you can start it from tmux itself. For example, I've bind it to `prefix + p` (p is mnemonic to pomodoro). Add the following line to `~/.tmux.conf`:
+
+	bind p run-shell "curl localhost:3080/start"
+
+To reset pomodoros you need to send the following request:
+
+	$ curl localhost:3080/restart
+
+Similarly to the previous command, you can bind it to an any key and run from tmux.
+
+Don't forget ro reload tmux config or restart tmux.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+
+https://github.com/mendab1e/tmuxodoro.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "tmuxodoro"
+
+# 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

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/bin/tmuxodoro

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+MINUTE = 60
+
+require 'tmuxodoro'
+
+tomato_time = ENV['TOMATO_TIME'] ? ENV['TOMATO_TIME'].to_i * MINUTE : nil
+rest_time = ENV['REST_TIME'] ? ENV['REST_TIME'].to_i * MINUTE : nil
+tomatoes = ENV['TOMATOES'] ? ENV['TOMATOES'].to_i : nil
+
+port = ENV['PORT'] || 3080
+
+Tmuxodoro.run(
+  port,
+  tomatoes: tomatoes,
+  rest_time: rest_time,
+  tomato_time: tomato_time
+)

data/lib/tmuxodoro/pomodoro.rb

@@ -0,0 +1,48 @@
+class Pomodoro
+  MINUTE = 60
+
+  attr_reader :tomatoes, :tomato_time, :rest_time, :stop_at
+
+  def initialize(tomatoes: nil, tomato_time: nil, rest_time: nil)
+    @tomatoes = tomatoes || 8
+    @tomato_time = tomato_time || 25 * MINUTE
+    @rest_time = rest_time || 5 * MINUTE
+  end
+
+  def status
+    if is_active?
+      if work_time?
+        "work: #{remaining_work_time} min\n"
+      else
+        "rest: #{remaining_rest_time} min\n"
+      end
+    else
+      "🍅  #{tomatoes}\n"
+    end
+  end
+
+  def start
+    @tomatoes -= 1
+    @stop_at = Time.now + tomato_time
+  end
+
+  private
+
+  def is_active?
+    stop_at && Time.now < stop_at + rest_time
+  end
+
+  def work_time?
+    Time.now < stop_at
+  end
+
+  def remaining_work_time
+    return unless stop_at
+    ((stop_at - Time.now) / MINUTE).ceil
+  end
+
+  def remaining_rest_time
+    return unless stop_at
+    ((stop_at + rest_time - Time.now) / MINUTE).ceil
+  end
+end

data/lib/tmuxodoro/version.rb

@@ -0,0 +1,3 @@
+module Tmuxodoro
+  VERSION = "0.1.0"
+end

data/lib/tmuxodoro.rb

@@ -0,0 +1,31 @@
+require 'tmuxodoro/version'
+require 'tmuxodoro/pomodoro'
+require 'webrick'
+
+module Tmuxodoro
+  class << self
+    def run(port, args = {})
+      pomodoro = Pomodoro.new(args)
+      server = WEBrick::HTTPServer.new(Port: port)
+
+      server.mount_proc('/') do |req, resp|
+        resp['Content-Type'] = 'text/plain'
+        resp.body = pomodoro.status
+      end
+
+      server.mount_proc('/start') do |req, resp|
+        pomodoro.start
+        resp['Content-Type'] = 'text/plain'
+        resp.body = "New tomato has been started, it ends at #{pomodoro.stop_at}.\n"
+      end
+
+      server.mount_proc('/restart') do |req, resp|
+        pomodoro = Pomodoro.new(args)
+        resp['Content-Type'] = 'text/plain'
+        resp.body = "Tomatos have been reset\n"
+      end
+
+      server.start
+    end
+  end
+end

data/tmuxodoro.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tmuxodoro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tmuxodoro"
+  spec.version       = Tmuxodoro::VERSION
+  spec.authors       = ["Timur Yanberdin"]
+  spec.email         = ["yanberdint@gmail.com"]
+
+  spec.summary       = "Pomodoro timer for tmux"
+  spec.homepage      = "https://github.com/mendab1e/tmuxodoro"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = "tmuxodoro"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop", "~> 0.8"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: tmuxodoro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Timur Yanberdin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- yanberdint@gmail.com
+executables:
+- tmuxodoro
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/tmuxodoro
+- lib/tmuxodoro.rb
+- lib/tmuxodoro/pomodoro.rb
+- lib/tmuxodoro/version.rb
+- tmuxodoro.gemspec
+homepage: https://github.com/mendab1e/tmuxodoro
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Pomodoro timer for tmux
+test_files: []