prb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97fa1172495612ccf5109e932970c74bdaf02690e9399f7da5a451f41598cfdf
+  data.tar.gz: 1df513efca5f84ac516121e0f720c1522474eb97581a390777ad37786e6caf98
+SHA512:
+  metadata.gz: 4c3f24a6477fcca54805d9ed7a799a45f97e2afdf1007882131045f796b4ae9373b9af293fc0a8831bb2623e8398543150d6c7f32d9f03e837bd6787df19c96f
+  data.tar.gz: a0995f9549574d236c49dfd5f99f0c927c61de46c0841d4e34dbd2c9b764dddc5311f18d391a50def038ebec010aefa596a0cbb312cd7b7883fb3ea1e29b5f2e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    prb (0.1.0)
+      optimist
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    optimist (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  prb!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Richard Ramsden
+
+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 @@
+# Prb
+
+`prb` is a light-weight timer service written in Ruby for the pomodoro
+technique.
+
+## Installation
+
+Install the gem
+
+    $ gem install prb
+
+## Usage
+
+```
+prb v0.1.0 - Pomodoro timer service
+
+Usage:
+  prb [COMMAND] [SUB_COMMAND]
+
+Options:
+  -d, --daemonize    Start the service in the background
+
+Commands:
+  start      Start pomodoro service
+  stop       Stop pomodoro service
+  status     Print status of pomodoro service
+  skip       Skip the current timer
+  reset      Reset the current timer
+  pause      Pause the current timer
+  -v, --version      Print version and exit
+  -h, --help         Show this message
+```
+
+## 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/rramsden/potime.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "prb"
+
+# 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/exe/prb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require "optimist"
+require "bundler/setup"
+require "prb"
+
+COMMAND_MAP = {
+  'start' => 'Start pomodoro service',
+  'stop' => 'Stop pomodoro service',
+  'status' => 'Print status of pomodoro service',
+  'skip' => 'Skip the current timer',
+  'reset' => 'Reset the current timer',
+  'pause' => 'Pause the current timer'
+}
+
+opts = Optimist::options do
+  version "prb v#{Prb::VERSION}"
+  banner "prb v#{Prb::VERSION} - Pomodoro timer service\n \n"
+  banner "Usage:"
+  banner "  prb [COMMAND] [SUB_COMMAND]\n \n"
+  banner "Options:"
+  opt :daemonize, 'Start the service in the background', short: '-d'
+  banner "\nCommands:"
+  COMMAND_MAP.each { |cmd, desc| banner format("  %-10s %s", cmd, desc)  }
+end
+
+commands = COMMAND_MAP.keys & ARGV
+cmd = commands.first
+
+if COMMAND_MAP.keys.include?(cmd)
+  Prb::CommandRunner.new(opts).send(cmd)
+else
+  Optimist.educate 
+end

data/lib/prb.rb

@@ -0,0 +1,8 @@
+require_relative "prb/version"
+require_relative "prb/timer"
+require_relative "prb/timer_control"
+require_relative "prb/server"
+require_relative "prb/command_runner"
+
+module Prb
+end

data/lib/prb/command_runner.rb

@@ -0,0 +1,57 @@
+module Prb
+  class CommandRunner
+    def initialize(opts)
+      @opts = opts
+    end
+
+    def start
+      if Prb::Server.running?
+        puts "A prb server is already running."
+        exit(1)
+      end
+
+      Process.daemon() if @opts[:daemonize]
+
+      Prb::Server.new.start
+    end
+
+    def status
+      response = send_command('STATUS')
+      puts response
+    end
+
+    def skip
+      send_command('SKIP')
+    end
+
+    def pause
+      send_command('PAUSE')
+    end
+
+    def reset
+      send_command('RESET')
+    end
+
+    def stop
+      send_command('QUIT')
+    end
+
+    private
+
+    def send_command(cmd)
+      Timeout::timeout(1) do
+        begin
+          s = TCPSocket.new('127.0.0.1', PRB_PORT)
+          s.puts(cmd)
+          response = s.gets.chomp
+          s.close
+          return response
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+          puts "A prb server is not running"
+          exit(1)
+        end
+      end
+    end
+  end
+
+end

data/lib/prb/server.rb

@@ -0,0 +1,76 @@
+require 'socket'
+require 'timeout'
+
+module Prb
+  PRB_PORT = 3838
+
+  class Server
+    def initialize
+      @controller = TimerControl.new
+    end
+
+    def start
+      @controller.start
+
+      server = TCPServer.open('127.0.0.1', PRB_PORT)
+      puts "Server listening on #{PRB_PORT}"
+
+      while true
+        Thread.start(server.accept) do |socket|
+          while cmd = socket.gets.chomp
+            puts "RECV: #{cmd}"
+
+            output = "OK"
+            case cmd
+            when 'STATUS'
+              output = status_line
+            when 'SKIP'
+              @controller.toggle
+            when 'RESET'
+              @controller.reset
+            when 'PAUSE'
+              @controller.pause
+            when 'QUIT'
+              socket.puts "OK"
+              exit(0)
+            else
+              puts "ERR: #{cmd} not a command"
+              output = "ERR: #{cmd} not a command"
+            end
+
+            socket.puts output
+          end
+
+          socket.close
+        end
+      end
+
+      server.close
+    end
+
+    def self.running?
+      Timeout::timeout(1) do
+        begin
+          s = TCPSocket.new('127.0.0.1', PRB_PORT)
+          s.close
+          return true
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+          return false
+        end
+      end
+    end
+
+    private
+
+    def status_line
+      status = ""
+      status << @controller.timer.render
+      status << ","
+      status << "WORKING" if @controller.is_working?
+      status << "BREAK" if !@controller.is_working?
+      status << ",PAUSED" if @controller.paused?
+      status << ",RUNNING" if !@controller.paused?
+      status
+    end
+  end
+end

data/lib/prb/timer.rb

@@ -0,0 +1,41 @@
+module Prb
+  class Timer
+    def initialize(minutes)
+      @paused = false
+      set_timer(minutes)
+    end
+
+    def set_timer(minutes)
+      @_seconds = minutes * 60
+      @seconds = @_seconds
+    end
+
+    def tick
+      sleep 1
+      @seconds -= 1 unless @paused or finished?
+    end
+
+    def finished?
+      @seconds == 0
+    end
+
+    def reset
+      @seconds = @_seconds
+    end
+
+    def pause
+      @paused = !@paused
+    end
+
+    def paused?
+      @paused
+    end
+
+    def render
+      min = (@seconds / 60) % 60
+      sec = (@seconds % 60)
+
+      format("%02d:%02d", min, sec)
+    end
+  end
+end

data/lib/prb/timer_control.rb

@@ -0,0 +1,45 @@
+module Prb
+  class TimerControl
+    WORK_MINUTES = 25
+    BREAK_MINUTES = 5
+
+    attr_reader :timer
+
+    def initialize
+      @timer = Timer.new(WORK_MINUTES)
+      @is_working = true
+    end
+
+    def start
+      Thread.new do
+        loop do
+          @timer.tick
+          toggle if @timer.finished?
+        end
+      end
+    end
+
+    def reset
+      @timer.reset
+    end
+
+    def pause
+      @timer.pause
+    end
+
+    def paused?
+      @timer.paused?
+    end
+
+    def is_working?
+      @is_working
+    end
+
+    def toggle
+      @is_working = !@is_working
+      @timer.set_timer(@is_working ?
+                      WORK_MINUTES : BREAK_MINUTES)
+      @timer.pause unless @timer.paused?
+    end
+  end
+end

data/lib/prb/version.rb

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

data/prb.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "prb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "prb"
+  spec.version       = Prb::VERSION
+  spec.authors       = ["Richard Ramsden"]
+  spec.email         = ["richard@rramsden.ca"]
+
+  spec.summary       = "Pomodoro timer CLI written in Ruby"
+  spec.description   = "Small CLI client for rendering a pomodoro timer"
+  spec.homepage      = "https://github.com/rramsden/prb"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "optimist"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: prb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Ramsden
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: Small CLI client for rendering a pomodoro timer
+email:
+- richard@rramsden.ca
+executables:
+- prb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- exe/prb
+- lib/prb.rb
+- lib/prb/command_runner.rb
+- lib/prb/server.rb
+- lib/prb/timer.rb
+- lib/prb/timer_control.rb
+- lib/prb/version.rb
+- prb.gemspec
+homepage: https://github.com/rramsden/prb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rramsden/prb
+  source_code_uri: https://github.com/rramsden/prb
+  changelog_uri: https://github.com/rramsden/prb
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Pomodoro timer CLI written in Ruby
+test_files: []