termodoro 0.1.9 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bedddd976063c2aff3aa487dc6040c547c062a9b
-  data.tar.gz: 8e8f652f79d584c05cf98ffabd374b159cb6f80f
+  metadata.gz: e28ec45a4d531ae0799b06ce31cd75ec88edf3b7
+  data.tar.gz: a85d9385d4e7aaad04cfb9948c338066be54b27b
 SHA512:
-  metadata.gz: a809c70f16150e9fb6abaffa20bfd56eef33973c104d2157ce3f88858eda9f3e827a62a9f21c80b8d48c3289e514f481d5230e39d598d911812b1edad2fccf3c
-  data.tar.gz: ab177bd909c3a0f467fe099db214934d7a0f4a1489daabe450608b0d92e2191c578ee0d63722c94a443613666b1d6dbc80be9b6c9942e668e27f7c4d20e3ad0c
+  metadata.gz: 39845df2b62a2d2d28cd113e228b0d6dc2a9f08e9a4028265e2974fd32dcaafde1bf9b74996e66fd4f589400791be2e0532b14a37e77a81ddd51425da7e19096
+  data.tar.gz: 00966d8256cb2d33359e3aa8eb2be226da9884717327f6476f54b315072483dad8e4d077d5b2c21d394e33a139d95c04c70cbdf502cdc9f882ca0ea97cc20450

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+termodoro-*
+Gemfile.lock
+pkg
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  # - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  # - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  # - rbx-18mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### 0.2.5 (10/29/2013)
+ 
+* Integrate Travis CI. Add Bundler and Rake. Add License. Minor changes to gemspec file. Add this changelog file.
+
+### 0.2.0 (10/29/2013)
+
+* Adds [@scottcreynold](https://github.com/scottcreynolds)'s feature which allows for omitting the message. Also includes the first tests. - [@vcavallo](http://github.com/vcavallo)
+
+### 0.1.9 (10/24/2013)
+
+* First working public release. - [@vcavallo](http://github.com/vcavallo)

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rspec"
+gem "terminal-notifier"
+gem "rake"

data/README.md

@@ -0,0 +1,73 @@
+# Termodoro
+
+## What is this?
+
+***Termodoro*** is an ultra-simple, frictionless BASH reminder / pomodoro timer ( in fact it's portmanteau of *terminal* and *[pomodoro](http://en.wikipedia.org/wiki/Pomodoro_Technique)* )  
+You pass it an amount of time and a message. After the specified amount of time elapses the message pops up. *Simple!*
+
+## Why would I use this?
+
+Maybe you're hard at work coding and you realize that there's something you need to do in 10 minutes… Rather than try to remember on your own or risk derailing your excellent programming groove by firing up a bulky reminder app, just enter a simple command into your terminal (where you're probably staring anyway). Hit enter and quickly get back to what you were doing!  
+
+Perhaps you're pair-programming and you want to switch roles in a given amount of time… Throw a quick command in between `cd`s and `ls`s and be on your way. Zero distractions. 
+
+You're already busy. Don't also be forgetful.  
+Too often I avoid setting a simple reminder because I don't want to interrupt my current flow - that shouldn't be a thing, and now it doesn't have to be.
+
+## Useage
+
+-----
+
+### Install:
+
+`gem install termodoro`
+
+### Use:
+
+`termodoro 40 minutes switch pairs`  
+`termodoro 5m make a commit`  
+`termodoro 1 hr remember to eat`  
+`termodoro 10 seconds test termodoro`
+
+..etc...
+
+-----
+
+## A gentle warning…
+
+This is the first gem I've built. I do not claim that it is perfect, nor that it follows best practices, nor that it is perfectly secure. Use at your own risk and feel free to fork this repo and improve any flaws you encounter. I'm wide open to suggestions for features as well.
+
+## Things I need to do:
+
+- The biggest one:
+  - ~~[Make it a gem!](https://rubygems.org/gems/termodoro)~~ 
+- After that:
+  - ~~Object-Orient (shame on me.) / Actually think about design.~~
+  - ~~Instead of getting input from `gets`, the duration and message should be able to be passed in as flags/options (I need to figure out the difference.)~~
+  - set defaults to something agreeable (like maybe 20 minutes and some generic 'do that thing you wanted to do' message) such that you could just do `termodoro` and it'll do that default.
+  - Make it useable in other shells and without the terminal-notifier gem.
+  - Sanitize the message so as to not cause bash issues
+  - Write good tests!
+  - Make sure to follow gem best-practices
+  - A bunch of other stuff I'll add here
+  - Make sure it persists through computer sleep
+  - Make sure I'm using ARGV properly and issuing the system command properly
+    - Generally revise to adhere to best practices. 
+
+## Upcoming features:
+
+- set your own global defaults and shortcuts
+- option to set a reminder to repeat
+- other stuff.. don't want it to get bloated though.
+
+-----
+
+## Contributing:
+
+You know the drill, right?
+
+* Fork.
+* Topic branches make puppies smile.
+* Make your feature addition or bug fix and be sure to include tests.
+* Update the CHANGELOG.md.
+* Send a pull request.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+ 
+Bundler.setup(:default, :development)
+ 
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+ 
+task :default => :spec

data/bin/termodoro

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
-require 'termodoro'
+require_relative '../config/environment'
+# require 'termodoro'
 
 a = Termodoro.new(ARGV.join(" "))
 exec(a.command)

data/config/environment.rb

@@ -0,0 +1 @@
+require_relative '../lib/termodoro/termodoro'

data/lib/{termodoro.rb → termodoro/termodoro.rb}

@@ -12,8 +12,14 @@ class Termodoro
     # title on/off -- probably going to drop this
   end
 
+  # parse class
+    # Parse.new(input)
+      # 
+  # calculate class
+  # run clean_message
+
   def parse_time_part
-    segment = @arguments.scan(/[\D]+[^\w]/).first.split(" ").first
+    segment = @arguments.match(/\D+/)[0].split(' ').first
     self.time_part = segment
     #=> hours/minutes/seconds, etc.
   end
@@ -26,8 +32,8 @@ class Termodoro
 
   def parse_message
     # .split(/[\d]+.[\w]+/).last 
-    parsed_message = @arguments.split(/^\s*[\d]+\s*[\w]+/).last.strip
-    self.message = parsed_message
+    parsed_message = @arguments.split(/^\s*[\d]+\s*[\w]+/).last || 'Termodoro'
+    self.message = parsed_message.strip
   end
 
   def calculate_time
@@ -38,7 +44,7 @@ class Termodoro
     elsif seconds?
       seconds = parse_number_part
     end
-  
+
     seconds #=> returns seconds
   end
 
@@ -69,8 +75,9 @@ class Termodoro
   def command
     # title = "title" -- leaving off title for now.
     # if title on/off call one or the other
-  
-    "sleep #{calculate_time} && terminal-notifier -message '#{parse_message}' -title 'Termodoro' & disown"
+    time_part = calculate_time
+    msg_part = parse_message
+    "sleep #{time_part} && terminal-notifier -message '#{msg_part}' -title 'Termodoro' & disown"
     #=> return the fully-formed command string for Bash
   end
 

data/license.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Vinney Cavallo
+
+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/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require_relative '../config/environment.rb'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/termodoro_spec.rb

@@ -0,0 +1,15 @@
+require_relative 'spec_helper'
+
+describe "Termodoro" do
+  it "takes a well-formed time and message string" do
+    arg = "10 seconds do something"
+    term = Termodoro.new(arg)
+    term.command.should be_an_instance_of(String)
+  end
+
+  it "allows the message to be optional" do
+    arg = "10 seconds"
+    term = Termodoro.new(arg)
+    term.command.should be_an_instance_of(String)
+  end
+end

data/termodoro.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'termodoro'
+  s.version     = '0.2.5'
+  s.date        = '2013-10-24'
+  s.summary     = "A lightweight CL reminder app"
+  s.description = "Use this little utility to set simple reminders from the command line. See the github page below for more information"
+  s.authors     = ["Vinney Cavallo"]
+  s.email       = 'vcavallo@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.executables << 'termodoro'
+  s.add_runtime_dependency "terminal-notifier"
+  s.homepage    =
+    'https://github.com/vcavallo/termodoro'
+  s.license       = 'MIT'
+
+  s.add_development_dependency 'rspec'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: termodoro
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.5
 platform: ruby
 authors:
 - Vinney Cavallo
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !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: Use this little utility to set simple reminders from the command line.
   See the github page below for more information
 email: vcavallo@gmail.com
@@ -32,9 +46,20 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/termodoro.rb
-- lib/run.rb
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
 - bin/termodoro
+- config/environment.rb
+- lib/termodoro/termodoro.rb
+- license.md
+- spec/spec_helper.rb
+- spec/termodoro_spec.rb
+- termodoro.gemspec
 homepage: https://github.com/vcavallo/termodoro
 licenses:
 - MIT

data/lib/run.rb

@@ -1,7 +0,0 @@
-require_relative './lib/termodoro'
-
-class Run
-  def self.execute(input)
-  a = Termodoro.new(input)
-  exec(a.command)
-end