berichtsheft 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ad0f771e69f3a773bb43b552553e9eae7154a80
-  data.tar.gz: 021bff1d94421cf0896b179be1effc0b2c8c242e
+  metadata.gz: b7c39f79323197b3be83526974cb624730e97151
+  data.tar.gz: 70e8c3659bcdc9de3d93bfacf94fdd27ade71fb4
 SHA512:
-  metadata.gz: d7d85afd086d0097999546e59ca654d8f7f7501a1c2a15d1da9893fd054d9c0e8bb9e1347d14049b0fde2c6930a7c48c432b28bedd1a0056be6e4308f4550487
-  data.tar.gz: e78896aeb05c184dd7005e09b06696930503eac5a0363b1202bed53a91b18131c4cd2f7f7778dae618707060baa85ee7123e7e231b49d359e9e09269a847ba0e
+  metadata.gz: 8657a1591a8d6755bef43825652b347d61c05fdd6bde2d337074cbddc17baf2f5f0f0cbc00874814e1e2b1bfff0fcaae43d83cce971539626dc2e67bcf1f9b7d
+  data.tar.gz: 0e7b9d82b6d0a57fe9a8340a2849c6d189111c155f909c0643bed4c8727632ca02bed4de78c2b050cba4962a24a9c9228b6cebeafe7375b02fc9d90122ee1f5b

data/Gemfile

@@ -1,5 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'prawn'
+gem "prawn"
 
 gemspec

data/README.md

@@ -1,34 +1,52 @@
 Berichtsheft
 ============
 
-Berichtsheft is a ruby library that helps apprentices working in Germany to
-create weekly reports. The default document template has been approved by
+Berichtsheft is a ruby library that helps apprentices working in Germany create
+weekly reports. The default document template has been approved by
 [IHK München / Oberbayern](https://www.muenchen.ihk.de/).
 
 ## Installation
-    $ gem install berichtsheft
+You need a working Ruby installation (2.1.1 or higher) to use this library. I
+recommend using rvm to set up your environment. This way you can ride with multiple
+Ruby versions installed on your machine. Also one of rvm's benefits is, that
+it installs everything into your home folder, so you won't have to mess around
+with sudo or your systems Ruby installation.
 
-## Usage
-
-```ruby
-require 'berichtsheft'
-
-# id_for_week is a natural number that represents the workweek.
-# The second argument is the file path where the generated documents are saved.
-settings = Berichtsheft::Settings.new(id_for_week, '/path/to/file/')
+To set up rvm on a unix machine, open your terminal and type:
+```
+$ \curl -sSL https://get.rvm.io | bash -s stable --ruby
+```
+This command will also install the current stable release of Ruby.
 
-employee = Berichtsheft::Employee.new('first name', 'last name', 'department')
+You can verify that the installation was successful with:
+```
+$ which ruby
+```
+This should display the location of your current ruby installation.
 
-# Expected order for values in CSV files:
-# id_for_week,description_for_activity,date(YYYY-MM-DD),duration
-parser = Berichtsheft::CSVParser.new('/path/to/file')
+After setting everything up, installing the berichtsheft gem is just simple as this:
+```
+$ gem install berichtsheft
+```
 
-activities = Berichtsheft::Activities.new(parser.data, settings.id_for_week)
+Done :)
 
-document = Berichtsheft::Document.new(user, activities, settings)
+## Usage
 
-document.generate
+```ruby
+require 'berichtsheft'
 
+weekly = Berichtsheft::Weekly.new(
+  :csv_file => "~/berichtsheft/activities.csv",
+  :save_to => "~/berichtsheft/documents/",
+  :first_name => "Erkan",
+  :last_name => "Alles",
+  :department => "Wunderwerk",
+  :id_for_week => 1,
+  :template => "ihk_muenchen"
+)
+
+weekly.generate
 ```
 
 ## Contact

data/Rakefile

@@ -0,0 +1,7 @@
+require "rake/testtask"
+
+Rake::TestTask.new do | t |
+  t.libs << "test"
+  t.test_files = FileList["test/test*.rb"]
+  t.verbose = false
+end

data/berichtsheft.gemspec

@@ -1,21 +1,20 @@
-# -*- encodingL utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+`git ls-files`.split("\n") - %w[.gitignore]# -*- encodingL utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'berichtsheft/version'
+require "berichtsheft/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'berichtsheft'
+  s.name        = "berichtsheft"
   s.version     = Berichtsheft::VERSION
-  s.licenses    = ['GPLv3']
-  s.summary     = 'Create weekly reports'
-  s.description = 'Berichtsheft is a ruby library that helps apprentices ' \
-                  'working in Germany to create weekly reports.'
-  s.authors     = ['Volkan Edis']
-  s.email       = 'mail@vedis.io'
+  s.licenses    = ["GPLv3"]
+  s.summary     = "Create weekly reports"
+  s.description = "Berichtsheft is a ruby library that helps apprentices r" \
+                  "working in Germany create weekly reports."
+  s.authors     = ["Volkan Edis"]
+  s.email       = "mail@vedis.io"
   s.files       = `git ls-files`.split("\n") - %w[.gitignore]
-  s.homepage    = 'https://github.com/vedis/berichtsheft'
+  s.homepage    = "https://github.com/vedis/berichtsheft"
 
-  s.required_ruby_version = '>= 2.1.1'
-  s.add_dependency('prawn', '~> 1.0', '>= 1.0.0')
-  s.add_development_dependency('rspec', '~> 2.14', '>= 2.14.1')
+  s.required_ruby_version = ">= 2.1.1"
+  s.add_dependency("prawn", "~> 1.0", ">= 1.0.0")
 end

data/lib/berichtsheft.rb

@@ -1,5 +1,47 @@
-require_relative 'berichtsheft/settings'
-require_relative 'berichtsheft/employee'
-require_relative 'berichtsheft/parser'
-require_relative 'berichtsheft/activities'
-require_relative 'berichtsheft/document'
+require_relative "berichtsheft/settings"
+require_relative "berichtsheft/employee"
+require_relative "berichtsheft/parser"
+require_relative "berichtsheft/activities"
+require_relative "berichtsheft/document"
+
+module Berichtsheft
+  class Weekly
+    def initialize(args)
+      @csv_file = args[:csv_file]
+      @save_to = args[:save_to]
+      @first_name = args[:first_name]
+      @last_name = args[:last_name]
+      @department = args[:department]
+      @id_for_week = args[:id_for_week]
+      @template = args[:template]
+    end
+
+    def settings
+      Berichtsheft::Settings.new(@id_for_week, @save_to)
+    end
+
+    def employee
+      Berichtsheft::Employee.new(
+        :first_name => @first_name,
+        :last_name => @last_name,
+        :department => @department
+      )
+    end
+
+    def parser
+      Berichtsheft::CSVParser.new(@csv_file)
+    end
+
+    def activities
+      Berichtsheft::Activities.new(parser.data, @id_for_week)
+    end
+
+    def document
+      Berichtsheft::Document.new(employee, activities, settings)
+    end
+
+    def generate
+      document.generate
+    end
+  end
+end

data/lib/berichtsheft/activities.rb

@@ -1,4 +1,4 @@
-require 'date'
+require "date"
 
 module Berichtsheft
   # Holds information for activities in an array of hashes.
@@ -14,7 +14,7 @@ module Berichtsheft
     def for_week(data, id_for_week)
       activities_for_week = []
       data.each do |activity|
-        if id_for_week == activity['id_for_week']
+        if id_for_week == activity["id_for_week"]
           activities_for_week.push(activity)
         end
       end
@@ -23,12 +23,12 @@ module Berichtsheft
     end
 
     def start_date
-      format_date(@all[0]['date'])
+      format_date(@all[0]["date"])
     end
 
     def end_date
       last_entry = @all.count - 1
-      format_date(@all[last_entry]['date'])
+      format_date(@all[last_entry]["date"])
     end
 
     def format_date(date)
@@ -42,7 +42,7 @@ module Berichtsheft
       monday = []
 
       @all.each do |entry|
-        if Date.parse(entry['date']).monday?
+        if Date.parse(entry["date"]).monday?
           monday.push(entry)
         end
       end
@@ -54,7 +54,7 @@ module Berichtsheft
       tuesday = []
 
       @all.each do |entry|
-        if Date.parse(entry['date']).tuesday?
+        if Date.parse(entry["date"]).tuesday?
           tuesday.push(entry)
         end
       end
@@ -66,7 +66,7 @@ module Berichtsheft
       wednesday = []
 
       @all.each do |entry|
-        if Date.parse(entry['date']).wednesday?
+        if Date.parse(entry["date"]).wednesday?
           wednesday.push(entry)
         end
       end
@@ -78,7 +78,7 @@ module Berichtsheft
       thursday = []
 
       @all.each do |entry|
-        if Date.parse(entry['date']).thursday?
+        if Date.parse(entry["date"]).thursday?
           thursday.push(entry)
         end
       end
@@ -90,7 +90,7 @@ module Berichtsheft
       friday = []
 
       @all.each do |entry|
-        if Date.parse(entry['date']).friday?
+        if Date.parse(entry["date"]).friday?
           friday.push(entry)
         end
       end
@@ -102,55 +102,55 @@ module Berichtsheft
       if for_monday
         time = 0
         for_monday.each do |activity|
-          time += convert_string_to_time(activity['duration'])
+          time += convert_string_to_time(activity["duration"])
         end
       end
 
-      Time.at(time).utc.strftime('%H:%M')
+      Time.at(time).utc.strftime("%H:%M")
     end
 
     def total_time_tuesday
       if for_tuesday
         time = 0
         for_tuesday.each do |activity|
-          time += convert_string_to_time(activity['duration'])
+          time += convert_string_to_time(activity["duration"])
         end
       end
 
-      Time.at(time).utc.strftime('%H:%M')
+      Time.at(time).utc.strftime("%H:%M")
     end
 
     def total_time_wednesday
       if for_wednesday
         time = 0
         for_wednesday.each do |activity|
-          time += convert_string_to_time(activity['duration'])
+          time += convert_string_to_time(activity["duration"])
         end
       end
 
-      Time.at(time).utc.strftime('%H:%M')
+      Time.at(time).utc.strftime("%H:%M")
     end
 
     def total_time_thursday
       if for_thursday
         time = 0
         for_thursday.each do |activity|
-          time += convert_string_to_time(activity['duration'])
+          time += convert_string_to_time(activity["duration"])
         end
       end
 
-      Time.at(time).utc.strftime('%H:%M')
+      Time.at(time).utc.strftime("%H:%M")
     end
 
     def total_time_friday
       if for_friday
         time = 0
         for_friday.each do |activity|
-          time += convert_string_to_time(activity['duration'])
+          time += convert_string_to_time(activity["duration"])
         end
       end
 
-      Time.at(time).utc.strftime('%H:%M')
+      Time.at(time).utc.strftime("%H:%M")
     end
 
     def convert_string_to_time(time)

data/lib/berichtsheft/document.rb

@@ -1,4 +1,4 @@
-require 'prawn'
+require "prawn"
 
 module Berichtsheft
   # Implements the default document template for weekly reports.
@@ -16,11 +16,11 @@ module Berichtsheft
       pdf.define_grid(columns: 3, rows: 9, gutter: 5)
 
       pdf.grid(0, 0).bounding_box do
-        pdf.text '<b>Name und Vorname: </b>', inline_format: true
+        pdf.text "<b>Name und Vorname: </b>", inline_format: true
         pdf.move_down 5
-        pdf.text '<b>Ausbildungsabteilung: </b>', inline_format: true
+        pdf.text "<b>Ausbildungsabteilung: </b>", inline_format: true
         pdf.move_down 5
-        pdf.text '<b>Ausbildungsnachweis Nr.: </b>', inline_format: true
+        pdf.text "<b>Ausbildungsnachweis Nr.: </b>", inline_format: true
       end
 
       pdf.grid(0, 1).bounding_box do
@@ -43,80 +43,80 @@ module Berichtsheft
       pdf.move_down -10
 
       data = [[
-        'Tag', 'Ausgeführte Arbeiten', 'Einzelstunden', 'Gesamtstunden'
+        "Tag", "Ausgeführte Arbeiten", "Einzelstunden", "Gesamtstunden"
       ]]
 
-      activities_for_monday = ''
-      time_for_monday = ''
+      activities_for_monday = ""
+      time_for_monday = ""
 
       @activities.for_monday.each do |activity|
-        activities_for_monday += "#{activity['description']}\n"
-        time_for_monday += "#{activity['duration']}\n"
+        activities_for_monday += "#{activity["description"]}\n"
+        time_for_monday += "#{activity["duration"]}\n"
       end
 
       data += [[
-        'Mo',
+        "Mo",
         activities_for_monday,
         time_for_monday,
         @activities.total_time_monday
         ]]
 
 
-      activities_for_tuesday = ''
-      time_for_tuesday = ''
+      activities_for_tuesday = ""
+      time_for_tuesday = ""
 
       @activities.for_tuesday.each do |activity|
-        activities_for_tuesday += "#{activity['description']}\n"
-        time_for_tuesday += "#{activity['duration']}\n"
+        activities_for_tuesday += "#{activity["description"]}\n"
+        time_for_tuesday += "#{activity["duration"]}\n"
       end
 
       data += [[
-        'Di',
+        "Di",
         activities_for_tuesday,
         time_for_tuesday,
         @activities.total_time_tuesday
         ]]
 
-      activities_for_wednesday = ''
-      time_for_wednesday = ''
+      activities_for_wednesday = ""
+      time_for_wednesday = ""
 
       @activities.for_wednesday.each do |activity|
-        activities_for_wednesday += "#{activity['description']}\n"
-        time_for_wednesday += "#{activity['duration']}\n"
+        activities_for_wednesday += "#{activity["description"]}\n"
+        time_for_wednesday += "#{activity["duration"]}\n"
       end
 
       data += [[
-        'Mi',
+        "Mi",
         activities_for_wednesday,
         time_for_wednesday,
         @activities.total_time_wednesday
         ]]
 
-      activities_for_thursday = ''
-      time_for_thursday = ''
+      activities_for_thursday = ""
+      time_for_thursday = ""
 
       @activities.for_thursday.each do |activity|
-        activities_for_thursday += "#{activity['description']}\n"
-        time_for_thursday += "#{activity['duration']}\n"
+        activities_for_thursday += "#{activity["description"]}\n"
+        time_for_thursday += "#{activity["duration"]}\n"
       end
 
       data += [[
-        'Do',
+        "Do",
         activities_for_thursday,
         time_for_thursday,
         @activities.total_time_thursday
         ]]
 
-      activities_for_friday = ''
-      time_for_friday = ''
+      activities_for_friday = ""
+      time_for_friday = ""
 
       @activities.for_friday.each do |activity|
-        activities_for_friday += "#{activity['description']}\n"
-        time_for_friday += "#{activity['duration']}\n"
+        activities_for_friday += "#{activity["description"]}\n"
+        time_for_friday += "#{activity["duration"]}\n"
       end
 
       data += [[
-        'Fr',
+        "Fr",
         activities_for_friday,
         time_for_friday,
         @activities.total_time_friday
@@ -131,20 +131,20 @@ module Berichtsheft
 
       pdf.move_down 20
 
-      pdf.text 'Bemerkung des Ausbilders/Auszubildenden'
-      note_field = [['']]
+      pdf.text "Bemerkung des Ausbilders/Auszubildenden"
+      note_field = [[""]]
       pdf.table note_field, column_widths: { 0 => 540 } do
         rows(0).height = 35
       end
 
       pdf.move_down 20
 
-      footer_data = [['', '', '', '']]
+      footer_data = [["", "", "", ""]]
       footer_data += [[
         "Auszubildender\nDatum und Unterschrift",
         "Ausbilder\nDatum und Unterschrift",
         "Gesetzlicher Vertreter\nDatum und Unterschrift",
-        'Bemerkung'
+        "Bemerkung"
       ]]
 
       pdf.table footer_data, column_widths: {

data/lib/berichtsheft/employee.rb

@@ -1,14 +1,12 @@
 module Berichtsheft
   # Provides user specific information.
   class Employee
-    attr_accessor :first_name
-    attr_accessor :last_name
-    attr_accessor :department
+    attr_reader :first_name, :last_name, :department
 
-    def initialize(first_name, last_name, department)
-      @first_name = first_name
-      @last_name = last_name
-      @department = department
+    def initialize(args)
+      @first_name = args[:first_name]
+      @last_name = args[:last_name]
+      @department = args[:department]
     end
   end
 end

data/lib/berichtsheft/parser.rb

@@ -1,34 +1,43 @@
 module Berichtsheft
-  # Implements the CSV parser. Each line represents one activity. The values
-  # have to in the following order:
-  # id_for_week,description_for_activity,date(YYYY-MM-DD),duration
+  # Implements the CSV parser.
   class CSVParser
     attr_reader :data
 
+    def initialize(csv_file)
+      @data = read_file(csv_file)
+    end
+
+    def data
+      @data
+    end
+
     def read_file(csv_file)
       all_activities = []
-      file = File.open(csv_file, 'r')
-
-      while (line = file.gets)
-        entry = line.force_encoding(Encoding::UTF_8).split(',')
-        id_for_week = entry[0]
-        description = entry[1]
-        date = entry[2]
-        duration = entry[3]
 
-        all_activities.push(
-          'id_for_week' => id_for_week.to_i,
-          'description' => description,
-          'date' => date,
-          'duration' => duration[0..4]
-        )
+      begin
+        file = File.open(csv_file, "r")
+        while line = file.gets
+          all_activities.push parse_line(line)
+        end
+      rescue IOError => e
+        puts e
+      ensure
+        file.close unless file.nil?
       end
 
       all_activities
     end
 
-    def initialize(csv_file)
-      @data = read_file(csv_file)
+    # Expected values for each line:
+    # date(YYYY-MM-DD),description,duration(HH-MM),id_for_week
+    def parse_line(line)
+      entity = line.force_encoding(Encoding::UTF_8).split(",")
+      Hash[
+        "date" => entity[0],
+        "description" => entity[1],
+        "duration" => entity[2],
+        "id_for_week" => entity[3].to_i
+      ]
     end
   end
 end

data/lib/berichtsheft/version.rb

@@ -1,3 +1,3 @@
 module Berichtsheft
-  VERSION = '0.0.4'
+  VERSION = "0.0.5"
 end

data/test/helper.rb

@@ -0,0 +1,15 @@
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "minitest/autorun"
+require "berichtsheft"
+
+class Berichtsheft::TestCase < MiniTest::Unit::TestCase
+  def setup
+    @settings = Berichtsheft::Settings.new(13, "/usr")
+    @employee = Berichtsheft::Employee.new("John", "Doe", "Wonderland")
+  end
+
+  def teardown
+    @settings = nil
+  end
+end

data/test/test_employee.rb

@@ -0,0 +1,19 @@
+require File.expand_path("../helper", __FILE__)
+
+class TestEmployee < Berichtsheft::TestCase
+  def test_employee_can_be_created
+    refute_nil @employee
+  end
+
+  def test_first_name_is_not_nil
+    refute_nil @employee.first_name
+  end
+
+  def test_last_name_is_not_nil
+    refute_nil @employee.last_name
+  end
+
+  def test_department_is_not_nil
+    refute_nil @employee.department
+  end
+end

data/test/test_settings.rb

@@ -0,0 +1,23 @@
+require File.expand_path("../helper", __FILE__)
+
+class TestSettings < Berichtsheft::TestCase
+  def test_settings_can_be_created
+    refute_nil @settings
+  end
+
+  def test_id_for_week_is_not_nil
+    refute_nil @settings.id_for_week
+  end
+
+  def test_id_for_week_is_a_fixnum
+    assert_instance_of Fixnum, @settings.id_for_week
+  end
+
+  def test_file_path_is_not_nil
+    refute_nil @settings.file_path
+  end
+
+  def test_file_path_is_a_directory
+    assert true, File.directory?(@settings.file_path)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berichtsheft
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Volkan Edis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-27 00:00:00.000000000 Z
+date: 2014-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -30,28 +30,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-description: Berichtsheft is a ruby library that helps apprentices working in Germany
-  to create weekly reports.
+description: Berichtsheft is a ruby library that helps apprentices rworking in Germany
+  create weekly reports.
 email: mail@vedis.io
 executables: []
 extensions: []
@@ -60,6 +40,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - berichtsheft.gemspec
 - lib/berichtsheft.rb
 - lib/berichtsheft/activities.rb
@@ -68,6 +49,9 @@ files:
 - lib/berichtsheft/parser.rb
 - lib/berichtsheft/settings.rb
 - lib/berichtsheft/version.rb
+- test/helper.rb
+- test/test_employee.rb
+- test/test_settings.rb
 homepage: https://github.com/vedis/berichtsheft
 licenses:
 - GPLv3