climer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1815265c9df127e40509416005508ad43aa7fc95
+  data.tar.gz: ff96f4313b44a6c327ce9abe7b2b43dc034ed53a
+SHA512:
+  metadata.gz: 41a617fb9f1c584d03a9ea418268b06abc11415d5e0218933a203292986cb3e48133523a32e0ac590ba7b05ab9221050c1bdc8f1e45fd3cb2ae663a6868ddcac
+  data.tar.gz: c33f1e92e333482383b569f441968a682ae30cf1d6fe1b0c594fa1e36b8dda09bf1fd6e3f255cff26c9559f3f73381b057dce3ae1942155457424da9195ea7f5

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+results.html
+pkg
+html
+coverage
+Gemfile.lock

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dustin Morrill
+
+MIT License
+
+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,29 @@
+# Climer
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'climer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install climer
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,54 @@
+#!/usr/bin/env rake
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+
+require 'rake/clean'
+require 'rake/testtask'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.libs << "lib" << 'spec/support'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = false
+  t.warning = false # pry-rescue has a lot of warnings
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+task :default => [:test,:features]

data/bin/climer

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require_relative '../lib/climer.rb'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do |*time_until_notification|
+    time_until_notification.each do |time|
+      t = Climer::Timer.alert_in(time)
+      sleep(t.time_remaining.total + 5)
+    end
+  end
+
+  # supplemental methods here
+
+  # Declare command-line interface here
+
+  # description "one line description of your app"
+  #
+  # Accept flags via:
+  # on("--flag VAL","Some flag")
+  # options[flag] will contain VAL
+  #
+  # Specify switches via:
+  # on("--[no-]switch","Some switch")
+  #
+  # Or, just call OptionParser methods on opts
+  #
+  # Require an argument
+  # arg :some_arg
+  #
+  # # Make an argument optional
+  # arg :optional_arg, :optional
+
+  arg :time_until_notification, :many
+
+  version Climer::VERSION
+
+  use_log_level_option
+
+  go!
+end

data/climer.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'climer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "climer"
+  spec.version       = Climer::VERSION
+  spec.authors       = ["Dustin Morrill"]
+  spec.email         = ["morrill@ualberta.ca"]
+  spec.description   = %q{Simple CLI timer}
+  spec.summary       = %q{Simple CLI timer}
+  spec.homepage      = "https://github.com/dmorrill10/climer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'methadone', '~> 1.3.0'
+  spec.add_dependency 'time_distribution'
+  spec.add_dependency 'rufus-scheduler'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'rake', '~> 0.9.2'
+  spec.add_development_dependency 'turn', '~> 0.9'
+  spec.add_development_dependency 'minitest', '~> 4.7'
+  spec.add_development_dependency 'awesome_print', '~> 1.0'
+  spec.add_development_dependency 'pry-rescue', '~> 1.0'
+  spec.add_development_dependency 'simplecov', '~> 0.7'
+  spec.add_development_dependency 'timecop'
+  # spec.add_development_dependency 'mocha', '~> 0.13'
+end

data/features/climer.feature

@@ -0,0 +1,32 @@
+Feature: Help documentation
+  In order to tell user's how to use this app
+  I want to show useful help documentation.
+
+  Scenario: App just runs and shows help
+    When I get help for "climer"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+      |--log-level|
+
+# Feature: Shows the time when notifications will go off
+#   As a user of this app
+#   I want to specify time durations
+#   And see the time that notifications will go off after those durations.
+
+  # Scenario: Shows times when notifications
+    # When I run "cli_timer "
+  #   Then the exit status should be 0
+  #   And the banner should be present
+  #   And the banner should document that this app takes options
+  #   And the following options should be documented:
+  #     |--version|
+  #     |--log-level|
+
+# Feature: Shows a useful notification message and plays a chime when a timer goes off
+#   As a user of this app
+#   I want to specify time durations
+#   And once those durations have elapsed
+#   I want to see a useful notification message and hear a chime

data/features/step_definitions/cli_timer_steps.rb

@@ -0,0 +1 @@
+# Put your step definitions here

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  @announce_cmd = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/climer/human_duration.rb

@@ -0,0 +1,29 @@
+require 'time_distribution/smart_duration'
+
+module Climer
+module HumanDuration
+  refine Time do
+    alias_method :old_plus, :+
+    alias_method :old_minus, :-
+
+    def +(other)
+      old_plus(
+        if other.kind_of?(String)
+          TimeDistribution::SmartDuration.parse(other).total || other
+        else
+          other
+        end
+      )
+    end
+    def -(other)
+      old_minus(
+        if other.kind_of?(String)
+          TimeDistribution::SmartDuration.parse(other).total || other
+        else
+          other
+        end
+      )
+    end
+  end
+end
+end

data/lib/climer/timer.rb

@@ -0,0 +1,55 @@
+require 'rufus-scheduler'
+require 'duration'
+require 'time_distribution/smart_duration'
+require_relative 'human_duration'
+using Climer::HumanDuration
+
+module Rufus::Scheduler
+  def self.scheduler() @scheduler ||= start_new end
+  def self.every(duration)
+    job = scheduler.every TimeDistribution::SmartDuration.parse(duration).total do
+      yield if block_given?
+    end
+  end
+  def self.at(time)
+    job = scheduler.at time do
+      yield if block_given?
+    end
+  end
+end
+
+module Climer
+class Timer
+  class << self; alias_method :alert_in, :new; end
+
+  attr_reader :alert_time
+
+  CARRIAGE_RETURN = "\r"
+  def initialize(duration)
+    @alert_time = Time.now + duration
+    puts "Alert set to activate at #{@alert_time.asctime}"
+    print countdown_string
+
+    countdown_update_interval = '1 second'
+    job = Rufus::Scheduler.every countdown_update_interval do
+      print "#{CARRIAGE_RETURN}#{countdown_string}"
+    end
+
+    Rufus::Scheduler.at @alert_time do
+      Rufus::Scheduler.scheduler.unschedule(
+        job.job_id
+      )
+      sleep TimeDistribution::SmartDuration.parse(countdown_update_interval).total
+      puts ''
+      puts "ALERT! Timer expired!"
+    end
+  end
+
+  def time_remaining
+    Duration.new(@alert_time - Time.now)
+  end
+  def countdown_string
+    time_remaining.format('%h:%M:%S')
+  end
+end
+end

data/lib/climer/version.rb

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

data/lib/climer.rb

@@ -0,0 +1,7 @@
+require_relative "climer/version"
+
+require_relative 'climer/human_duration'
+require_relative 'climer/timer'
+
+module Climer
+end

data/spec/human_duration_spec.rb

@@ -0,0 +1,13 @@
+require_relative 'support/spec_helper'
+
+require_relative '../lib/climer/human_duration'
+using Climer::HumanDuration
+
+describe 'Climer::HumanDuration' do
+  it '#+ given an English formatted time returns a time given an elapsed time' do
+    (Time.new(0) + '2 hours').must_equal Time.new(0, 1, 1, 2)
+  end
+  it '#- given an English formatted time returns a time given an elapsed time' do
+    (Time.new(0, 1, 1, 2) - '2 hours').must_equal Time.new(0)
+  end
+end

data/spec/support/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest/spec'
+require 'minitest/autorun'
+
+begin
+  require 'turn'
+
+  Turn.config do |c|
+    # use one of output formats:
+    # :outline  - turn's original case/test outline mode [default]
+    # :progress - indicates progress with progress bar
+    # :dotted   - test/unit's traditional dot-progress mode
+    # :pretty   - new pretty reporter
+    # :marshal  - dump output as YAML (normal run mode only)
+    # :cue      - interactive testing
+    c.format  = :dotted
+    # use humanized test names (works only with :outline format)
+    c.natural = true
+  end
+
+  require 'awesome_print'
+  module Minitest::Assertions
+    def mu_pp(obj)
+      obj.awesome_inspect
+    end
+  end
+
+  require 'pry-rescue/minitest'
+  #require 'mocha/setup'
+rescue LoadError
+end

data/spec/timer_spec.rb

@@ -0,0 +1,17 @@
+require_relative 'support/spec_helper'
+require 'timecop'
+
+require_relative '../lib/climer/timer'
+
+describe 'Climer::Timer' do
+  describe '#alert_in' do
+    it 'should show the end time' do
+      Timecop.freeze Time.new(0)
+      time_at_alert = Time.new(0) + 60*60
+      -> { Climer::Timer.alert_in('1 hour') }.must_output(
+        "Alert set to activate at #{time_at_alert.asctime}\n" <<
+        "1:00:00"
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification
+name: climer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dustin Morrill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: time_distribution
+  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: rufus-scheduler
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: Simple CLI timer
+email:
+- morrill@ualberta.ca
+executables:
+- climer
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/climer
+- climer.gemspec
+- features/climer.feature
+- features/step_definitions/cli_timer_steps.rb
+- features/support/env.rb
+- lib/climer.rb
+- lib/climer/human_duration.rb
+- lib/climer/timer.rb
+- lib/climer/version.rb
+- spec/human_duration_spec.rb
+- spec/support/spec_helper.rb
+- spec/timer_spec.rb
+homepage: https://github.com/dmorrill10/climer
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Simple CLI timer
+test_files:
+- features/climer.feature
+- features/step_definitions/cli_timer_steps.rb
+- features/support/env.rb
+- spec/human_duration_spec.rb
+- spec/support/spec_helper.rb
+- spec/timer_spec.rb