estimator 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2845164bd7621caea7c3d9723f4f548ca070a9bc
-  data.tar.gz: f6710f320d6f4d55bf49085683fa3bcffb4c636e
+  metadata.gz: d42b21689bf6ebcbd2d922c3493497e529b9c2c7
+  data.tar.gz: dd163639bdb879081bbc0e1858d5f838cbb95497
 SHA512:
-  metadata.gz: 7858fb248066599e0c546a740602269527df372c89187e7a5bb92e9af30eb16305a931b086920903b71c0d05e6e6b4710044c558528d13572de1613e1addf5c6
-  data.tar.gz: 50e1dcfe8d96b89d297807458fc26f3f8a24ffa2931335bf22be013e4155c4d08c506416a29a80e5d77d27dcf357c77b6bef2068ecde0dad244fabb2ecb345ba
+  metadata.gz: c4cd3f8c31e88b9d323ca525214f3bb8e4d0ba6648ea46863d97970de93c160e57221a2d608c1469564714ca91f1c62d6c3b7fea139a893e22b509242cf3b515
+  data.tar.gz: 3151b8a4285cab073b67fabaf063963806d7aa2cc898bf0f460c9d55e1f98cddcb7c474a5794e8ec3ed01ad44dbfceec0207180c69df5b78207342bd696265d8

data/Rakefile

@@ -23,39 +23,17 @@ def dump_load_path
     puts "Found in #{path}"
   end
 end
+
 require 'bundler'
 require 'rake/clean'
-
 require 'rake/testtask'
 
-require 'cucumber'
-require 'cucumber/rake/task'
-gem 'rdoc' # we need the installed RDoc gem, not the system one
-require 'rdoc/task'
-
 include Rake::DSL
 
 Bundler::GemHelper.install_tasks
 
-
 Rake::TestTask.new do |t|
-  t.pattern = 'test/tc_*.rb'
-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
+  t.pattern = 'test/*_test.rb'
 end
 
-Rake::RDocTask.new do |rd|
-  
-  rd.main = "README.rdoc"
-  
-  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
-end
-
-task :default => [:test,:features]
-
+task :default => :test

data/bin/estimator

@@ -1,38 +1,42 @@
 #!/usr/bin/env ruby
-
 require 'optparse'
 require 'methadone'
 require 'estimator'
 
 class App
-  include Methadone::Main
-  include Methadone::CLILogging
+    include Methadone::Main
+    include Methadone::CLILogging
 
-  main do |value, time|
-    fm = Estimator::Estimate.new( options[:file] )
-    fm.load
+    main do |value, time|
+        estimator_db_name = options.fetch( :file, 'estimator_db.yml' )
+        estimator_db_path = "#{Dir.pwd}/#{estimator_db_name}"
+        debug "creating estimator with db [#{estimator_db_path}]"
 
-    if value.nil?
-      if options[:'last-estimate']
-        puts fm.last_estimate
-      else
-        puts fm.estimate
-      end
-    else
-      time = fm.add_value( value, time )
-      puts "added #{value} on #{time}"
-    end
+        fm = Estimator::Estimate.new( estimator_db_path )
+        # TODO: check for exception
+        fm.load
 
-    fm.save!
-  end
+        unless value.nil?
+            time = fm.add_value( value, time )
+            info "added #{value} on #{time}"
+        else
+            if options[:'last-estimate']
+                info fm.last_estimate
+            else
+                info fm.estimate
+            end
+        end
+
+        fm.save!
+    end
 
-  description "Estimate remaining time based on previous values"
-  on      '--file NAME',  'Database file name'
-  on  '--last-estimate',  'Show last estimate (saved on database)'
-  arg :value, :optional,  'Value to estimate'
-  arg  :time, :optional,  'When the value happened'
+    description 'Estimate remaining time based on previous values'
+    on      '--file NAME',  'Database file name'
+    on  '--last-estimate',  'Show last estimate (saved on database)'
+    arg :value, :optional,  'Value to estimate'
+    arg  :time, :optional,  'When the value happened'
 
-  version Estimator::VERSION
-  use_log_level_option
-  go!
+    version Estimator::VERSION
+    use_log_level_option
+    go!
 end

data/estimator.gemspec

@@ -4,21 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'estimator/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "estimator"
-  gem.version       = Estimator::VERSION
-  gem.authors       = ["Marcos Trovilho"]
-  gem.email         = ["marcos@trovilho.com"]
-  gem.description   = %q{Estimate remaining time based on previous values}
-  gem.summary       = %q{Estimate remaining time based on previous values}
-  gem.homepage      = ""
+    gem.name          = 'estimator'
+    gem.version       = Estimator::VERSION
+    gem.authors       = ['Marcos Trovilho']
+    gem.email         = ['marcos@trovilho.com']
+    gem.description   = %q{Estimate remaining time based on previous values}
+    gem.summary       = %q{Estimate remaining time based on previous values}
+    gem.homepage      = 'https://github.com/mtrovilho/estimator'
+    gem.license       = 'MIT'
 
-  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.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_dependency('methadone')
+    gem.add_dependency 'methadone'
 
-  gem.add_development_dependency('rake')
-  gem.add_development_dependency('aruba')
+    gem.add_development_dependency 'bundler'
+    gem.add_development_dependency 'rake'
 end

data/lib/estimator/version.rb

@@ -1,3 +1,3 @@
 module Estimator
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end

data/lib/estimator.rb

@@ -2,46 +2,54 @@ require 'estimator/version'
 require 'yaml'
 
 module Estimator
-  class Estimate
-    attr_reader :values
-    attr_reader :last_estimate
-    attr_reader :file_path
-
-    def initialize( file_name )
-      file_name  = 'estimator_db.yml' if file_path.nil?
-      @file_path = "#{Dir.pwd}/#{file_name}"
-    end
+    class Estimate
+        LAST_ESTIMATE_EMPTY_STRING = 'last estimate is empty'
 
-    def load
-      save! unless File.exists?( @file_path )
-      yaml_file      = ( YAML.load_file( @file_path ) || {} )
-      @values        = ( yaml_file[:values] || {} )
-      @last_estimate = ( yaml_file[:last_estimate] || 'last estimate is empty' )
-    end
+        attr_reader :values
+        attr_reader :last_estimate
+        attr_reader :file_path
 
-    def save!
-      File.open( @file_path, 'w' ) do |f|
-        f.write( {
-          values: @values,
-          last_estimate: @last_estimate
-        }.to_yaml )
-      end
-    end
+        # TODO: handle file better
+        def initialize( file_path )
+            @file_path = file_path
+            @values = {}
+            @last_estimate = LAST_ESTIMATE_EMPTY_STRING
+        end
 
-    def add_value( value, time = nil )
-      time = Time.now if time.nil?
-      @values[value.to_i] = time
-    end
+        def load( file_path = @file_path )
+            # TODO: change to exception?
+            return nil unless File.exists?( file_path )
+            # TODO: check for exception
+            yaml_file      = YAML.load_file( file_path )
+            @values        = yaml_file.fetch( :values, {} )
+            @last_estimate = yaml_file.fetch( :last_estimate, LAST_ESTIMATE_EMPTY_STRING )
+        end
 
-    def estimate
-      return 'add more values before estimating' unless @values.count > 1
-      # y = ax+b
-      b = @values.keys.sort.last
-      y = @values.keys.sort.first
-      x = @values[y] - @values[b]
-      a = (y-b)/x
-      @last_estimate = @values[b] + (-b/a)
-    end
+        def save!
+            File.open( @file_path, 'w' ) do |f|
+                f.write( {
+                    values: @values,
+                    last_estimate: @last_estimate
+                }.to_yaml )
+            end
+        end
+
+        def add_value( value, time = nil )
+            time = Time.now if time.nil?
+            @values[value] = time
+        end
 
-  end
+        # TODO: Moving Averages
+        # http://en.wikipedia.org/wiki/Moving_average
+        def estimate
+            return 'add more values before estimating' unless @values.count > 1
+            # y = ax+b
+            b = @values.keys.sort.last
+            y = @values.keys.sort.first
+            x = @values[y] - @values[b]
+            a = (y-b)/x
+            @last_estimate = @values[b] + (-b/a)
+        end
+
+    end
 end

data/test/estimator_test.rb

@@ -1,9 +1,37 @@
-require 'minitest/autoload'
+require 'minitest/autorun'
+require 'estimator'
+require 'yaml'
+require 'time'
 
 class EstimatorTest < MiniTest::Unit::TestCase
 
-  def test_truth
-    assert true
-  end
+    def setup
+        yaml_file = "#{Dir.pwd}/test/fixtures/sample_db.yml"
+        @yaml = YAML.load_file( yaml_file )
+        @estimator = Estimator::Estimate.new( yaml_file )
+    end
+
+    def test_load_yaml
+        yaml_file = "#{Dir.pwd}/test/fixtures/sample_db.yml"
+        yaml = YAML.load_file( yaml_file )
+        @estimator.load( yaml_file )
+
+        yaml[:values].each do |key, value|
+            assert_equal value, @estimator.values[key]
+        end
+        assert_equal yaml[:last_estimate], @estimator.last_estimate
+    end
+
+    def test_add_value
+        value = Random.rand
+        @estimator.add_value( value )
+        assert @estimator.values.has_key?( value )
+    end
+
+    def test_estimate
+        @estimator.add_value( 100, Time.parse('2014-05-07') )
+        @estimator.add_value(  50, Time.parse('2014-05-08') )
+        assert_equal Time.parse('2014-05-09'), @estimator.estimate
+    end
 
 end

data/test/fixtures/sample_db.yml

@@ -0,0 +1,5 @@
+---
+:values:
+  100.0: 2014-05-07 20:16:32.954822000 -03:00
+  50.0: 2014-05-07 20:16:38.054459000 -03:00
+:last_estimate: 2014-05-07 20:16:43.154095999 -03:00

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: estimator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Marcos Trovilho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: methadone
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -67,14 +67,13 @@ files:
 - Rakefile
 - bin/estimator
 - estimator.gemspec
-- features/estimator.feature
-- features/step_definitions/estimator_steps.rb
-- features/support/env.rb
 - lib/estimator.rb
 - lib/estimator/version.rb
 - test/estimator_test.rb
-homepage: ''
-licenses: []
+- test/fixtures/sample_db.yml
+homepage: https://github.com/mtrovilho/estimator
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -97,8 +96,6 @@ signing_key:
 specification_version: 4
 summary: Estimate remaining time based on previous values
 test_files:
-- features/estimator.feature
-- features/step_definitions/estimator_steps.rb
-- features/support/env.rb
 - test/estimator_test.rb
+- test/fixtures/sample_db.yml
 has_rdoc: 

data/features/estimator.feature

@@ -1,13 +0,0 @@
-Feature: My bootstrapped app kinda works
-  In order to get going on coding my awesome app
-  I want to have aruba and cucumber setup
-  So I don't have to do it myself
-
-  Scenario: App just runs
-    When I get help for "estimator"
-    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|
-    And the banner should document that this app takes no arguments

data/features/step_definitions/estimator_steps.rb

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

data/features/support/env.rb

@@ -1,16 +0,0 @@
-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
-  # Using "announce" causes massive warnings on 1.9.2
-  @puts = true
-  @original_rubylib = ENV['RUBYLIB']
-  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
-end
-
-After do
-  ENV['RUBYLIB'] = @original_rubylib
-end