work_calculator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d9fa66e96b75e609d3d55285bd7ce43280c58d5
+  data.tar.gz: b285b4bcc1880dfc77af2f630f51179ae895bb9f
+SHA512:
+  metadata.gz: d6900a38f0002c1000961c8dbbdaa65a11229fc4144b2e84241fff903fd4aa743e903b2203408c2bf55d726346861f068e2b99df46cd6dd594e95440117883d2
+  data.tar.gz: cc865c6f13d59d9a2cdbdf851b58f1c47e85c4d06935f8a14602d818db2baa5ee8ebac0051627b266c77688e10b5633095dff463b43c200a211a5d2db87eb782

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 den10
+
+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,31 @@
+# WorkCalculator
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'work_calculator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install work_calculator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/work_calculator/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/work_calculator

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'rake'
+require 'work_calculator'
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: work_calculator COMMAND [OPTIONS]"
+  opt.separator ""
+  opt.separator "Commands"
+  opt.separator " run: Run the experiment"
+  opt.separator " test: Test all cases are working correctly"
+  opt.separator ""
+  opt.separator "Options"
+  opt.separator " start: The start date of the experiment"
+  opt.separator " finish: The finish date of the experiment"
+  opt.separator ""
+
+  opt.on("-s", "--start=DD/MM/YYYY", "Mandatory Start Date, Between 01/01/1901 and 31/12/2999") do |date|
+    options[:start] = date
+  end
+
+  opt.on("-f", "--finish=DD/MM/YYYY",  "Mandatory Finish Date, Between 01/01/1901 and 31/12/2999") do |date|
+    options[:finish] = date
+  end
+
+  opt.on("-h", "--help", "help") do
+    puts opt_parser
+  end
+
+  opt.parse!
+end
+
+# opt_parser.parse!
+command = ARGV[0]
+
+case command
+when "run"
+  puts "Running calculation..."
+  begin
+    mandatory = [:start, :finish]
+    missing = mandatory.select{ |param| options[param].nil? }
+
+    if missing.empty?
+      calculator = WorkCalculator.new options[:start], options[:finish]
+      calculator.print_elapsed_days_worked()
+    else
+      puts "Missing mandatory options: #{missing.join(', ')}"
+      puts ""
+      puts opt_parser
+    end
+  rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+    puts $!.to_s
+    puts opt_parser
+  end
+when "test"
+  puts "running tests..."
+  Rake::Task[task].invoke("test")
+else
+  puts opt_parser
+end

data/lib/work_calculator/version.rb

@@ -0,0 +1,3 @@
+class WorkCalculator
+  VERSION = "1.0.0"
+end

data/lib/work_calculator.rb

@@ -0,0 +1,75 @@
+require "work_calculator/version"
+require 'date'
+
+class WorkCalculator
+  attr :start, :finish
+
+  VALID_START_DATE = Date.parse('01/01/1901')
+  VALID_FINISH_DATE = Date.parse('31/12/2999')
+
+  def start=(date)
+    begin
+      @start = check_date(date)
+    rescue Exception => message
+      puts message
+    end
+  end
+
+  def finish=(date)
+    begin
+      @finish = check_date(date)
+    rescue Exception => message
+      puts message
+    end
+  end
+
+  def initialize(start, finish)
+    self.start = start
+    self.finish = finish
+  end
+
+  # Prints the number of full days worked in human friendly message
+  # @return [String] the resulting message
+  def print_elapsed_days_worked
+    elapsed_days = get_elapsed_days()
+
+    case elapsed_days
+    when 0
+      puts "No day's worked"
+    when 1
+      puts "#{elapsed_days} full day worked."
+    else
+      puts "#{elapsed_days} full days worked."
+    end
+  end
+
+  # Calculates the total number of worked days by subtracting the end date to the start date
+  # Subtracting 1 by total days in required because the last day work is not considered a full days work
+  # It is possible the start date is before end date, thus we convert any negative days work to positive
+  # @return [Number] the resulting number of days worked
+  def get_elapsed_days
+    (@finish - @start).to_i.abs - 1
+  end
+
+  private
+
+  # Validates start/finish date
+  # @return [Date] the resulting date
+  def check_date(date)
+    date = Date.parse(date)
+    if date == nil
+      raise "Date calculator needs a #{date.key} date"
+    elsif !is_within_valid_dates(date)
+      raise "#{date.key} date is not valid, check the date is between #{VALID_START_DATE} to #{VALID_FINISH_DATE}"
+    else
+      date
+    end
+  end
+
+  # Checks if the date is not before the valid start date and end start date threshold
+  # @param name [Date] the date to validate against
+  # @return [Bool] the resulting validation
+  def is_within_valid_dates date
+    date.between?(VALID_START_DATE, VALID_FINISH_DATE)
+  end
+end

data/work_calculator.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'work_calculator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "work_calculator"
+  spec.version       = WorkCalculator::VERSION
+  spec.authors       = ["den10"]
+  spec.email         = ["tang.graphics@gmail.com"]
+  spec.summary       = %q{Dead simple calculator}
+  spec.description   = %q{CLI work calculator}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: work_calculator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- den10
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: CLI work calculator
+email:
+- tang.graphics@gmail.com
+executables:
+- work_calculator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/work_calculator
+- lib/work_calculator.rb
+- lib/work_calculator/version.rb
+- work_calculator.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Dead simple calculator
+test_files: []