overtimer 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTY5MzUyYTE2NzJjYWM4MDljMWU3M2QxZjc3OGQ4MDFmZmViMzFhZg==
+  data.tar.gz: !binary |-
+    ZGVjZDBjOWVhODkzMTgzMzQwNWU4YWUxYmY0NTljYTJiNzA0MTY4Mg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTYxNTNlZWM5MmNmOWZmNmE3Y2M2YmM4MGY3YzFlODkyYTI0OGVhNGE4YzM5
+    NDIxZWNiZmM0N2Y1N2Y0NDdiODY5OWZmYmZmZWJmZWVhNjlkMDZiZjNhYzQx
+    OGQ5NWQ2NjhiNzYzMTdkMjRiOTk5YjFjZDQ1OGY5ZWEyZTA3NGY=
+  data.tar.gz: !binary |-
+    OWE0MzJlMGQzNDhkMzJiYzMwODE0ZGRlMTI5ODBjNzQ1MDdmNjA5ZmFlOGU4
+    M2Q4YTcxMGI1YTg5MTQ2MzA1YWZlOTdlYmQ4NTAwY2Y5ZTllZDkxZmNlNTRk
+    MWYyZTE3NDFjODFjZTNkNGVmOWQ4MjZkNjg5MzI2YTY2ZjY4Zjk=

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

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

data/.ruby-version

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Keyvan Fatehi
+
+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,30 @@
+# overtimer
+
+Calculates employee payroll info based on California laws (overtime, doubletime, etc)
+
+## Usage
+
+Assuming you've installed the gem with `gem install overtimer`:
+
+```ruby
+require 'rubygems'
+require 'overtimer'
+
+# Create a workweek using an array of hours per day for 1 week
+ww = Overtimer::Workweek.new [17,12,15,11,12,4,0]
+
+# Do the deductions meet your expectation (pull requests welcome)
+ww.total == 71
+ww.regular == 40,
+ww.overtime == 23
+ww.doubletime == 8
+
+# What about only one of the days in the workweek?
+wd = ww[0]
+
+# How about these? Are they correct? They are for me anyway.
+wd.total == 17
+wd.regular == 8
+wd.overtime == 4
+wd.doubletime == 5
+```

data/Rakefile

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

data/config.example.yml

@@ -0,0 +1,3 @@
+COMPANY_ID: 'mycompany'
+LOGIN: 'keyvan@mycompany.com'
+PASSWORD: "3$@#rafoiawjof23"

data/lib/overtimer.rb

@@ -0,0 +1,5 @@
+require "overtimer/version"
+require "overtimer/workweek"
+
+module Overtimer
+end

data/lib/overtimer/version.rb

@@ -0,0 +1,3 @@
+module Overtimer
+  VERSION = "0.1.0"
+end

data/lib/overtimer/workbase.rb

@@ -0,0 +1,51 @@
+module Overtimer
+  class Workbase
+    attr_reader :total, :regular, :overtime
+    attr_accessor :doubletime
+    def max_regular
+      self.class.max_regular
+    end
+
+    def max_overtime
+      if self.class.respond_to? :max_overtime
+        self.class.max_overtime
+      else
+        999
+      end
+    end
+
+    def initialize *args
+      @total = 0
+      @regular = 0
+      @overtime = 0
+      @doubletime = 0
+    end
+
+    def regular=(val)
+      @regular = val
+      if @regular >= max_regular
+        overflow = @regular - max_regular
+        self.overtime += overflow
+        @regular -= overflow
+      end
+    end
+
+    def overtime=(val)
+      @overtime = val
+      if @overtime >= max_overtime
+        overflow = @overtime - max_overtime
+        self.doubletime += overflow
+        @overtime -= overflow
+      end
+    end
+
+    def account_for_hours hours
+      if @regular <= max_regular
+        self.regular += hours
+      else
+        self.overtime += hours
+      end
+      @total += hours
+    end
+  end
+end

data/lib/overtimer/workweek.rb

@@ -0,0 +1,43 @@
+require 'overtimer/workbase'
+
+module Overtimer
+  class Workday < Workbase
+    def self.max_regular
+      8
+    end
+    def self.max_overtime
+      4
+    end
+    def initialize hours
+      super
+      account_for_hours hours
+    end
+  end
+
+  class Workweek < Workbase
+    def self.max_regular
+      40
+    end
+
+    def initialize days
+      super
+      @days = days.map!{|i| Workday.new(i) }
+
+      if defined? ALEX_DOUBLE_TIME
+        if days.reject{|i| i.total == 0}.size == 7
+          @total += @doubletime += days.pop.total
+        end
+      end
+
+      days.each do |day|
+        account_for_hours day.total
+        self.doubletime += day.doubletime
+        self.overtime -= day.doubletime
+      end
+    end
+
+    def [] index
+      @days[index]
+    end
+  end
+end

data/overtimer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'overtimer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "overtimer"
+  spec.version       = Overtimer::VERSION
+  spec.authors       = ["Keyvan Fatehi"]
+  spec.email         = ["keyvan@digitalfilmtree.com"]
+  spec.description   = %q{Calculates employee payroll info based on California laws (overtime, doubletime, etc)}
+  spec.summary       = %q{calculates overtime based on California law}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'overtimer'
+require 'support/workweek_helpers'
+
+RSpec.configure do |config|
+  config.extend WorkweekHelpers
+end

data/spec/support/workweek_helpers.rb

@@ -0,0 +1,23 @@
+module WorkweekHelpers
+  def expect_week hash
+    describe "week" do
+      hash.each do |meth,val|
+        describe "##{meth}" do
+          specify { subject.send(meth).should eq val }
+        end
+      end
+    end
+  end
+
+  def expect_day index, hash
+    describe "day #{index}" do
+      hash.each do |meth,val|
+        describe "##{meth}" do
+          specify do
+            subject[index].send(meth).should eq val
+          end
+        end
+      end
+    end
+  end
+end

data/spec/workweek_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Overtimer::Workweek do
+  context 'standard' do
+    subject { Overtimer::Workweek.new [8,8,8,8,8,0,0] }
+    expect_week({
+      total:40,
+      regular:40,
+      overtime:0,
+      doubletime:0
+      })
+  end
+
+  context 'worked on Saturday' do
+    subject { Overtimer::Workweek.new [8,8,8,8,8,8,0] }
+    expect_week({
+      total:48,
+      regular:40,
+      overtime:8,
+      doubletime:0
+      })
+  end
+
+  context 'worked on Saturday and Sunday' do
+    # Alex Says: The seventh consecutive day is considered doubletime
+    # Ruthy Says: Joann's rules make above untrue
+    subject { Overtimer::Workweek.new [8,8,8,8,8,8,8] }
+    expect_week({
+      total:56,
+      regular:40,
+      overtime:16,
+      doubletime:0
+      })
+  end
+
+  context 'worked hard' do
+    subject { Overtimer::Workweek.new [17,12,15,11,12,4,0] }
+    expect_day(0, {
+      total:17,
+      regular:8,
+      overtime:4,
+      doubletime:5
+      })
+    expect_week({
+      total:71,
+      regular:40,
+      overtime:23,
+      doubletime:8
+      })
+  end
+
+  context 'worked soft' do
+    subject { Overtimer::Workweek.new [7,5,3,4,0,0,0] }
+    expect_week({
+      total:19,
+      regular:19,
+      overtime:0,
+      doubletime:0
+      })
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: overtimer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keyvan Fatehi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-28 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  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: pry
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: guard-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: Calculates employee payroll info based on California laws (overtime,
+  doubletime, etc)
+email:
+- keyvan@digitalfilmtree.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config.example.yml
+- lib/overtimer.rb
+- lib/overtimer/version.rb
+- lib/overtimer/workbase.rb
+- lib/overtimer/workweek.rb
+- overtimer.gemspec
+- spec/spec_helper.rb
+- spec/support/workweek_helpers.rb
+- spec/workweek_spec.rb
+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.0.6
+signing_key: 
+specification_version: 4
+summary: calculates overtime based on California law
+test_files:
+- spec/spec_helper.rb
+- spec/support/workweek_helpers.rb
+- spec/workweek_spec.rb