club 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afd6387d5fb6099d3514b834bd4e3b16577626e6
+  data.tar.gz: db6cf6eef0289dfa03115675319207410b7166db
+SHA512:
+  metadata.gz: 7bdd0849ae6448f3463f9526fb2f3be9d722574fb819d8bed6a71349364b373d1973413f0d064086f10a50f4570518ab415c73d8843e2cf0df8aca1958abab79
+  data.tar.gz: 52b4b7523d3f8af2ad02cee95770736ecceea33d39a30d836f108b8240196e8b3d11c8b02321b2f221dd1905d8079b1b02eb5b6185fb8827cdcd0f2c2221b41b

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+ruby "2.2.1"
+gemspec

data/README.md

@@ -0,0 +1,46 @@
+# CLUB -- Command-line Utility for Business
+
+
+CLUB is a tool that I wrote to move the majority of the applications I use for business into the command line. Most notably, I wanted to be able to track my time from the command-line because it reduces the friction I experience when trying to track my time appropriately.
+
+
+## Time Tracking
+
+CLUB's first role is in tracking time.
+
+### Starting a timer
+
+
+Starting an unnamed timer:
+
+`club time go`
+
+Stopping an unnamed timer:
+
+`club time stop`
+
+Starting a named timer:
+
+`club time go <name>`
+
+Starting a timer scoped to a specific project:
+
+`club time go --project <abbrev>`
+
+Starting a timer with known duration:
+
+`club time go --end 30m`
+
+Starting a pomodoro cycle (25 on, 5 off):
+
+`club time go --pomo`
+
+
+## Starting
+
+- TimeChunk
+  - Holds started_time, time_elapsed, scheduled_end_time, name, state, reference to project
+- Project
+  - Long name, abbreviation
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "club"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/club.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'club/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "club"
+  spec.version       = Club::VERSION
+  spec.authors       = ["Rob Yurkowski"]
+  spec.email         = ["rob@yurkowski.net"]
+
+  spec.summary       = %q{What is this I don't even}
+  spec.description   = %q{What is this I don't even really}
+  spec.homepage      = "https://github.com/robyurkowski/club"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  end
+
+  # spec.add_dependency "thor"
+  spec.add_dependency "aasm"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rspec"
+
+end

data/lib/club.rb

@@ -0,0 +1,4 @@
+require "club/version"
+
+module Club
+end

data/lib/club/version.rb

@@ -0,0 +1,3 @@
+module Club
+  VERSION = "0.0.1"
+end

data/lib/controllers/time_controller.rb

@@ -0,0 +1,101 @@
+require 'entities/time_chunk'
+require 'core_ext/array'
+
+class NoActiveTimeChunkException < Exception; end
+class AmbiguousTimeChunkException < Exception; end
+class InvalidTimeChunkException < Exception; end
+
+class TimeController
+  using CoreExt::Array
+
+  def initialize(timechunk_factory: TimeChunk.method(:new))
+    self.timechunks         = []
+    self.active_timechunks  = []
+    self.timechunk_factory  = timechunk_factory
+  end
+
+
+  ################################################################################
+  # Public API
+  ################################################################################
+  attr_accessor :timechunks,
+                :active_timechunks,
+                :timechunk_factory
+
+
+  # Creates a new timechunk, starting it at the moment of creation (i.e. an
+  # instantly running timer).
+  #
+  # @since x.x.x
+  #
+  def start_timer
+    new_timechunk = timechunk_factory.call.tap(&:start)
+    append_active_timechunk(new_timechunk)
+  end
+
+
+  # Finalizes a running timechunk (a 'timer').
+  #
+  # If there are no running timers, raises `NoActiveTimeChunkException`.
+  #
+  # If there is exactly one running timer, stops that timer.
+  #
+  # If there is more than one timer, and a valid id is provided for one of
+  # them, stops that timer. Otherwise, if the provided id is invalid, raises
+  # `InvalidTimeChunkException`, and if no id is provided,
+  # `AmbiguousTimeChunkException` is raised.
+  #
+  # @param id
+  #   A full or partial id of an active timechunk.
+  #
+  # @since x.x.x
+  def stop_timer(id: nil)
+    case active_timechunks.count
+
+    when 0
+      raise NoActiveTimeChunkException
+
+    when 1
+      timechunk = active_timechunks.shift
+      timechunk.finish
+
+    else
+      raise AmbiguousTimeChunkException if id.nil?
+      timechunk = find_first_active_timechunk_by(id: id)
+      active_timechunks.delete(timechunk)
+      timechunk.finish
+    end
+  end
+
+
+  # Lists all active timers.
+  #
+  # @since x.x.x
+  def list_active_timers
+    active_timechunks
+  end
+
+
+  ################################################################################
+  # Private
+  ################################################################################
+
+  # Finds an active timechunk by its full or partial id
+  private def find_first_active_timechunk_by(id:)
+    chunks = active_timechunks.select {|tc| tc.id.to_s.include? id.to_s }
+
+    if chunks.none?
+      raise InvalidTimeChunkException
+    elsif chunks.many?
+      raise AmbiguousTimeChunkException
+    else
+      chunks.first
+    end
+  end
+
+
+  private def append_active_timechunk(tc)
+    timechunks          << tc
+    active_timechunks   << tc
+  end
+end

data/lib/core_ext/array.rb

@@ -0,0 +1,19 @@
+module CoreExt
+  module Array
+    refine ::Array do
+
+      # Swiped directly from ActiveSupport.
+      def many?
+        cnt = 0
+        if block_given?
+          any? do |element|
+            cnt += 1 if yield element
+            cnt > 1
+          end
+        else
+          any? { (cnt += 1) > 1 }
+        end
+      end
+    end
+  end
+end

data/lib/entities/time_chunk.rb

@@ -0,0 +1,62 @@
+require 'aasm'
+require 'securerandom'
+
+class TimeChunk
+  ################################################################################
+  # Inclusions
+  ################################################################################
+  include AASM
+
+
+  ################################################################################
+  # Public Interface
+  ################################################################################
+  def initialize(name: nil, scheduled_duration: nil, timestamping_method: Time.method(:now))
+    self.id                   = SecureRandom.uuid
+    self.name                 = name
+    self.scheduled_duration   = scheduled_duration
+    self.timestamping_method  = timestamping_method # Injectable clock
+  end
+
+
+  attr_accessor :id,
+                :name,
+                :scheduled_duration,
+                :timestamping_method,
+
+                :start_time,
+                :finish_time
+
+  alias_method  :state, :aasm_read_state
+
+
+  ################################################################################
+  # State
+  ################################################################################
+  aasm do
+    state :idle, initial: true
+    state :running
+    state :finished
+
+    event :start, after: :did_start do
+      transitions from: :idle, to: :running
+    end
+
+    event :finish, after: :did_finish do
+      transitions from: :running, to: :finished
+    end
+  end
+
+
+  ################################################################################
+  # State transition callbacks
+  ################################################################################
+  private def did_start
+    self.start_time = timestamping_method.call
+  end
+
+
+  private def did_finish
+    self.finish_time = timestamping_method.call
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: club
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rob Yurkowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aasm
+  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: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: What is this I don't even really
+email:
+- rob@yurkowski.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- club.gemspec
+- lib/club.rb
+- lib/club/version.rb
+- lib/controllers/time_controller.rb
+- lib/core_ext/array.rb
+- lib/entities/time_chunk.rb
+- vendor/.gitkeep
+homepage: https://github.com/robyurkowski/club
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: What is this I don't even
+test_files: []