tamarillo 0.1.0

data/spec/lib/tamarillo/monitor_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../../../lib/tamarillo/monitor'
+
+describe Tamarillo::Monitor do
+  let(:tomato) do
+    tomato = double('tomato')
+    tomato.stub(:completed?).and_return(false, true)
+    tomato
+  end
+
+  let(:notifier) do
+    notifier = double('notifier')
+    notifier.should_receive(:call)
+    notifier
+  end
+
+  # XXX This test relies on system time passing,
+  # so it's unfortunately slow.
+  subject { Tamarillo::Monitor.new(tomato, notifier) }
+
+  # as a result it is horrible.
+  it "watches a tomato for completion" do
+    pending "not sure how to test when forking"
+    subject.start
+    sleep 0.1
+  end
+end
+

data/spec/lib/tamarillo/notification/bell_spec.rb

@@ -0,0 +1,7 @@
+require_relative '../../../../lib/tamarillo/notification/bell'
+
+describe Tamarillo::Notification::Bell do
+  subject { Tamarillo::Notification::Bell.new }
+  it { should respond_to(:call) }
+  # specify { subject.call }
+end

data/spec/lib/tamarillo/notification/growl_spec.rb

@@ -0,0 +1,7 @@
+require_relative '../../../../lib/tamarillo/notification/growl'
+
+describe Tamarillo::Notification::Growl do
+  subject { Tamarillo::Notification::Growl.new }
+  it { should respond_to(:call) }
+  # specify { subject.call }
+end

data/spec/lib/tamarillo/notification/speech_spec.rb

@@ -0,0 +1,7 @@
+require_relative '../../../../lib/tamarillo/notification/speech'
+
+describe Tamarillo::Notification::Speech do
+  subject { Tamarillo::Notification::Speech.new }
+  it { should respond_to(:call) }
+  # specify { subject.call }
+end

data/spec/lib/tamarillo/notification_spec.rb

@@ -0,0 +1,22 @@
+require_relative '../../../lib/tamarillo/notification'
+
+include Tamarillo
+
+describe Tamarillo::Notification do
+  subject { Tamarillo::Notification }
+
+  describe ".valid!" do
+    specify { subject.valid!(:bell).should == Notification::BELL }
+    specify { subject.valid!('speech').should == Notification::SPEECH }
+    specify { subject.valid!('Growl').should == Notification::GROWL }
+    specify { subject.valid!('bogus').should == nil }
+  end
+
+  describe ".for" do
+    specify { subject.for(Notification::BELL).should be_a(Notification::Bell) }
+    specify { subject.for(Notification::GROWL).should be_a(Notification::Growl) }
+    specify { subject.for(Notification::SPEECH).should be_a(Notification::Speech) }
+    specify { subject.for(Notification::NONE).should be_a(Notification::None) }
+    specify { subject.for('bogus').should be_a(Notification::None) }
+  end
+end

data/spec/lib/tamarillo/storage_spec.rb

@@ -0,0 +1,171 @@
+require_relative '../../../lib/tamarillo/storage'
+require 'fakefs/spec_helpers'
+require 'active_support/core_ext/numeric/time'
+
+include Tamarillo
+
+# Storage layout looks like this
+# |,tamarillo
+#   |-config
+#   |-basket.sqlite
+#   |-basket
+#     |-2012
+#       |-0401
+#         |-060101
+
+describe Storage do
+  include FakeFS::SpecHelpers
+
+  let(:time) { Time.local(2011,1,1,6,0,0) }
+  let(:date) { Date.new(2011,1,1) }
+  let(:storage_path) { Pathname.new( File.expand_path('tmp/tamarillo')) }
+  let(:config_path) { storage_path.join('config.yml') }
+  let(:tomato_path) { storage_path.join('2011/0101/20110101060000') }
+  let(:sample_tomato) { <<EOS }
+#{time.iso8601}
+Some task I'm working on
+completed
+EOS
+
+  def create_tomato_file(time, options = {})
+    folder_path = storage_path.join(time.strftime('%Y/%m%d'))
+    tomato_path = folder_path.join(time.strftime('%Y%m%d%H%M%S'))
+    state = options.fetch(:state) { 'completed' }
+
+    FileUtils.mkdir_p(folder_path)
+    File.open(tomato_path, 'w') { |f| f << <<EOS }
+#{time.iso8601}
+Some task I'm working on
+#{state}
+EOS
+
+    tomato_path
+  end
+
+
+  subject { Storage.new(storage_path) }
+
+  it "creates the storage directory if it is missing" do
+    expect { Storage.new(storage_path) }.
+      to change { File.directory?(storage_path) }
+  end
+
+  it "has a path to the storage directory" do
+    subject.path.should == storage_path
+  end
+
+  it "has a default configuration" do
+    subject.config.should be_a(Tamarillo::Config)
+  end
+
+  it "can accept a specific configuration" do
+    config = stub(:duration => 10)
+    storage = Storage.new(storage_path, config)
+    storage.config.duration.should == 10
+  end
+
+  describe "writing config to the filesystem" do
+    it "writes files to the right place" do
+      FakeFS::FileSystem.clear
+      FakeFS do
+        expect { subject.write_config }.
+          to change { File.exist?(config_path) }
+      end
+    end
+  end
+
+  describe "reading config from the filesystem" do
+  end
+
+  describe "reading monitor from the filesystem" do
+  end
+
+  describe "writing tomatoes to the filesystem" do
+    it "writes files to the right place" do
+      FakeFS::FileSystem.clear
+      FakeFS do
+        tomato = stub(:started_at => time, :state => :active)
+        expect { subject.write_tomato(tomato) }.
+          to change { File.exist?(tomato_path) }
+      end
+    end
+
+    it "returns a path to the tomato" do
+      tomato = stub(:started_at => time, :state => :active)
+      path = subject.write_tomato(tomato)
+      path.should == subject.path.join(tomato_path)
+    end
+
+    describe "tomato file" do
+      before do
+        tomato = stub(:started_at => time, :date => date, :state => :active)
+        Storage.new(storage_path).write_tomato(tomato)
+      end
+
+      subject { FakeFS { File.readlines(tomato_path.to_s) } }
+
+      specify { subject[0].should == time.iso8601}
+      specify { subject[1].should == "Some task I'm working on" }
+      specify { subject[2].should == 'active' }
+    end
+  end
+
+  describe "reading tomatoes from the filesystem" do
+    before do
+      create_tomato_file(time)
+    end
+
+    it "can read tomatoes from the filesystem" do
+      tomato = subject.read_tomato(tomato_path)
+      tomato.should be
+    end
+
+    it "returns nil of not found" do
+      tomato = subject.read_tomato('NOTHING')
+      tomato.should be_nil
+    end
+
+    describe "the tomato" do
+      let(:config) { stub(:duration_in_seconds => 10.minutes) }
+      let(:storage) { Storage.new(storage_path, config) }
+      subject { storage.read_tomato(tomato_path) }
+
+      its(:started_at) { should == time }
+      its(:date) { should == date }
+      its(:duration) { should == 10.minutes }
+      it { should be_completed }
+    end
+
+    it "handles interrupted tomatoes" do
+      create_tomato_file(time, :state => 'interrupted')
+      tomato = subject.read_tomato(tomato_path)
+      tomato.should be_interrupted
+    end
+  end
+
+  describe "finding most recent tomato" do
+    subject { Storage.new(storage_path).latest }
+
+    context "when there are many tomatoes" do
+      before do
+        create_tomato_file(Date.today.to_time + 6.hours)
+        create_tomato_file(Date.today.to_time + 6.hours + 15.minutes)
+      end
+
+      its(:started_at) { should == Date.today.to_time + 6.hours + 15.minutes }
+    end
+
+    context "when there are no tomatoes for the day" do
+      before do
+        create_tomato_file(Date.today.to_time - 1.days)
+      end
+
+      it { should be_nil }
+    end
+  end
+
+  # it "can count how many tomatoes are stored"
+  # it "can find tomatoes by week"
+  # it "can find tomatoes by month"
+  # something can group them by day and maybe task
+end

data/spec/lib/tamarillo/tomato_file_spec.rb

@@ -0,0 +1,41 @@
+require_relative '../../../lib/tamarillo/tomato_file'
+require_relative '../../../lib/tamarillo/tomato'
+require_relative '../../../lib/tamarillo/clock'
+
+describe Tamarillo::TomatoFile do
+  # FIXME Timezones will change when running test, argh
+  let(:time) { Time.local(2011,1,1, 6,0,0) }
+  let(:today) { Date.new(2011,1,1) }
+  let(:clock) { Tamarillo::Clock.new(time) }
+  let(:tomato) { Tamarillo::Tomato.new(25 * 60, clock) }
+
+  subject { Tamarillo::TomatoFile.new(tomato) }
+
+  its(:name) { should == '20110101060000' }
+  its(:path) { should == '2011/0101/20110101060000' }
+  its(:content) { should == <<-EOS.chomp }
+#{time.iso8601}
+Some task I'm working on
+completed
+  EOS
+
+  it "can write an interrupted tomato" do
+    tomato.interrupt!
+    subject.content.should include('interrupted')
+  end
+
+  describe ".path" do
+    subject { Tamarillo::TomatoFile }
+    
+    specify do
+      path = subject.path(Time.new(1999,12,31,11,59,59))
+      path.should == '1999/1231/19991231115959' 
+    end
+
+    specify do
+      path = subject.path(Time.new(2012,04,10,6,0,23))
+      path.should == '2012/0410/20120410060023' 
+    end
+  end
+
+end

data/spec/lib/tamarillo/tomato_spec.rb

@@ -0,0 +1,116 @@
+require 'active_support/core_ext/numeric/time'
+require_relative '../../../lib/tamarillo/tomato'
+
+include Tamarillo
+
+describe Tomato do
+  subject { Tomato.new(25.minutes, clock) }
+
+  describe "basic attibutes" do
+    let(:now) { Time.new(2012,1,1,6,0,0) }
+    let(:today) { Date.new(2012,1,1) }
+    let(:clock) { stub(:start_time => now, :start_date => today, :elapsed => 60) }
+
+    its(:duration) { should == 25.minutes }
+    its(:started_at) { should == now }
+    its(:date) { should == today }
+    its(:elapsed) { should == clock.elapsed }
+
+    it "update the duration" do
+      subject.duration = 5.minutes
+      subject.duration.should == 5.minutes
+    end
+  end
+
+  describe "comparison" do
+    it "is the same if the start-times match" do
+      clock = stub(:start_time => Time.new)
+      tomato_a = Tomato.new(25.minutes, clock)
+      tomato_b = Tomato.new(25.minutes, clock)
+
+      tomato_a.should eql(tomato_b)
+    end
+
+    # FIXME This ensures two tomatoes from the same
+    # time cannot co-exist, but it seems confusing
+    it "is the same if the duration differs" do
+      clock = stub(:start_time => Time.new)
+      tomato_a = Tomato.new(10.minutes, clock)
+      tomato_b = Tomato.new(20.minutes, clock)
+
+      tomato_a.should eql(tomato_b)
+    end
+  end
+
+  describe "remaining time" do
+    let(:clock) { stub(:elapsed => elapsed) }
+    let(:elapsed) { 0 }
+
+    context "when no time has elapsed" do
+      let(:elapsed) { 0 }
+      its(:remaining) { should == 25.minutes }
+    end
+
+    context "if some time has elapsed" do
+      let(:elapsed) { 10.minutes }
+      its(:remaining) { should == 15.minutes }
+    end
+
+    context "when all time has elapsed" do
+      let(:elapsed) { 25.minutes }
+      its(:remaining) { should == 0 }
+    end
+
+    context "when excessive time has elapsed" do
+      let(:elapsed) { 30.minutes }
+      its(:remaining) { should == 0 }
+    end
+
+    context "when it has been interrupted" do
+      before do
+        subject.interrupt!
+      end
+
+      its(:remaining) { should == 0 }
+    end
+  end
+
+  describe "states" do
+    let(:clock) { stub(:elapsed => elapsed) }
+    let(:elapsed) { 0 }
+
+    context "when just started" do
+      let(:elapsed) { 0 }
+      it { should be_active }
+      it { should_not be_completed }
+      it { should_not be_interrupted }
+    end
+
+    context "when time remains" do
+      let(:elapsed) { 15.minutes }
+      it { should be_active }
+      it { should_not be_completed }
+      it { should_not be_interrupted }
+    end
+
+    context "when time has elapsed" do
+      let(:elapsed) { 25.minutes }
+      it { should_not be_active }
+      it { should be_completed }
+      it { should_not be_interrupted }
+    end
+
+    context "when it has been interrupted" do
+      before do
+        subject.interrupt!
+      end
+
+      it { should be_interrupted }
+      it { should_not be_completed }
+    end
+
+  end
+
+  # it "can be distracted" ??
+  
+end

data/spec/support/invalid-config.yml

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

data/spec/support/sample-config.yml

@@ -0,0 +1,3 @@
+---
+duration: 30
+notifier: growl

data/tamarillo.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tamarillo/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "tamarillo"
+  gem.version       = Tamarillo::VERSION
+  gem.authors       = ["Tim Uruski"]
+  gem.email         = ["timuruski@gmail.com"]
+  gem.description   = %q{Manage pomodoros from the command-line.}
+  gem.summary       = %q{A command-line application for managing the pomodoro technique.}
+  gem.homepage      = "https://github.com/timuruski/tamarillo"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'aruba', '~> 0.4.11'
+  gem.add_development_dependency 'active_support', '~> 3.0.0'
+  gem.add_development_dependency 'fakefs', '~> 0.4.0'
+  gem.add_development_dependency 'rspec', '~> 2.9.0'
+  gem.add_development_dependency 'timecop', '~> 0.3.5'
+
+  gem.add_runtime_dependency 'methadone', '~> 1.0.0.rc5'
+
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: tamarillo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tim Uruski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &70235404161660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.11
+  type: :development
+  prerelease: false
+  version_requirements: *70235404161660
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &70235404160820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70235404160820
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: &70235404160260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70235404160260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70235404159400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *70235404159400
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70235404158380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :development
+  prerelease: false
+  version_requirements: *70235404158380
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: &70235404157700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70235404157700
+description: Manage pomodoros from the command-line.
+email:
+- timuruski@gmail.com
+executables:
+- tam
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/tam
+- features/config.feature
+- features/step_definitions/tamarillo_steps.rb
+- features/support/env.rb
+- features/tamarillo.feature
+- lib/tamarillo.rb
+- lib/tamarillo/clock.rb
+- lib/tamarillo/command.rb
+- lib/tamarillo/config.rb
+- lib/tamarillo/controller.rb
+- lib/tamarillo/monitor.rb
+- lib/tamarillo/notification.rb
+- lib/tamarillo/notification/bell.rb
+- lib/tamarillo/notification/growl.rb
+- lib/tamarillo/notification/none.rb
+- lib/tamarillo/notification/speech.rb
+- lib/tamarillo/notification/touch.rb
+- lib/tamarillo/storage.rb
+- lib/tamarillo/tomato.rb
+- lib/tamarillo/tomato_file.rb
+- lib/tamarillo/version.rb
+- spec/lib/tamarillo/clock_spec.rb
+- spec/lib/tamarillo/command_spec.rb
+- spec/lib/tamarillo/config_spec.rb
+- spec/lib/tamarillo/controller_spec.rb
+- spec/lib/tamarillo/monitor_spec.rb
+- spec/lib/tamarillo/notification/bell_spec.rb
+- spec/lib/tamarillo/notification/growl_spec.rb
+- spec/lib/tamarillo/notification/speech_spec.rb
+- spec/lib/tamarillo/notification_spec.rb
+- spec/lib/tamarillo/storage_spec.rb
+- spec/lib/tamarillo/tomato_file_spec.rb
+- spec/lib/tamarillo/tomato_spec.rb
+- spec/support/invalid-config.yml
+- spec/support/sample-config.yml
+- tamarillo.gemspec
+homepage: https://github.com/timuruski/tamarillo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 734855712674183534
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 734855712674183534
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A command-line application for managing the pomodoro technique.
+test_files:
+- features/config.feature
+- features/step_definitions/tamarillo_steps.rb
+- features/support/env.rb
+- features/tamarillo.feature
+- spec/lib/tamarillo/clock_spec.rb
+- spec/lib/tamarillo/command_spec.rb
+- spec/lib/tamarillo/config_spec.rb
+- spec/lib/tamarillo/controller_spec.rb
+- spec/lib/tamarillo/monitor_spec.rb
+- spec/lib/tamarillo/notification/bell_spec.rb
+- spec/lib/tamarillo/notification/growl_spec.rb
+- spec/lib/tamarillo/notification/speech_spec.rb
+- spec/lib/tamarillo/notification_spec.rb
+- spec/lib/tamarillo/storage_spec.rb
+- spec/lib/tamarillo/tomato_file_spec.rb
+- spec/lib/tamarillo/tomato_spec.rb
+- spec/support/invalid-config.yml
+- spec/support/sample-config.yml