afd_parser 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23281239730f2fc9a56515c9cc307eca390d957a
+  data.tar.gz: 4919382b66f53e7796168b3cc3bdf8f71aeac03d
+SHA512:
+  metadata.gz: 4498b18497c30a5c580090b3f751bf0f450148a775ef0dd82d152e1e0a84488c96cf7bddb9615093333ab28c032b69da1ec1280ad7ad6d8b400edd87349f895a
+  data.tar.gz: '038906e8404160933b602f429259a72e83c98bb08573ac494721b7e4c283ade240fc767c4a0149113073c5838cf0fa73831fca62fd703a5977816b074393fbd6'

data/lib/afd_parser.rb

@@ -0,0 +1,257 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require 'date'
+
+# Parser para a PORTARIA No 1.510, DE 21 DE AGOSTO DE 2009, do
+# Ministério do Trabalho;
+
+class AfdParser
+  require 'afd_parser/clock_in_out'
+  require 'afd_parser/header'
+  require 'afd_parser/set_employee'
+  require 'afd_parser/set_employer'
+  require 'afd_parser/set_time'
+  require 'afd_parser/trailer'
+
+  class AfdParserException < Exception; end
+  attr_reader :records, :header, :trailer
+
+  def initialize(*args)
+    if args.size == 1
+      initialize_variables(args[0])
+    elsif args.size == 2
+      initialize_variables(args[1])
+      File.open(args[0], "r") do |file|
+        @raw_data = file.readlines
+      end
+    else
+      raise AfdParser::AfdParserException.new("wrong number of arguments, should be 1 or 2")
+    end
+  end
+
+  def parse
+    @raw_data.each_with_index do |line, index|
+      parse_line(line, index)
+    end
+
+    if @validate_structure and not trailer_found?
+      raise AfdParser::AfdParserException.new("AFD ended without a trailer record")
+    end
+  end
+
+  def parse_line(line, index)
+    line_id, record_type_id = line.unpack("A9A").collect{|id| id.to_i}
+    record_type = get_record_type(line_id, record_type_id, line)
+
+    @previous_line_id = @current_line_id unless @current_line_id == 0
+    @current_line_id = line_id
+
+    if @validate_structure
+      validate_afd(line, line_id, @previous_line_id, index, record_type)
+    end
+
+    case record_type
+    when :header
+      @header = Header.new(line)
+      return @header
+    when :set_employer
+      @records << SetEmployer.new(line)
+    when :clock_in_out
+      @records << ClockInOut.new(line)
+    when :set_time
+      @records << SetTime.new(line)
+    when :set_employee
+      @records << SetEmployee.new(line)
+    when :trailer
+      @trailer = Trailer.new(line, count_records)
+      return @trailer
+    else
+      if @validate_structure
+        raise AfdParser::AfdParserException.new("Unknown record type found in AFD file, line #{index.to_s}: '#{line}'")
+      end
+    end
+
+    return @records.last
+  end
+
+  def create_header(employer_type, employer_document, employer_cei, employer_name, rep_serial_number, afd_start_date,afd_end_date, afd_creation_time)
+    if header_found?
+      raise AfdParser::AfdParserException.new("Cannot add a second AFD header")
+    else
+      @header = Header.new(employer_type, employer_document, employer_cei, employer_name, rep_serial_number, afd_start_date,afd_end_date, afd_creation_time)
+    end
+  end
+
+  def create_trailer
+    if trailer_found?
+      raise AfdParser::AfdParserException.new("Cannot add a second AFD trailer")
+    else
+      @trailer = Trailer.new(count_records)
+    end
+  end
+
+  def export
+    exported_data = ""
+    (exported_data += @header.export + "\r\n") if @header
+    @records.each do |record|
+      exported_data += record.export + "\r\n"
+    end
+    (exported_data += @trailer.export + "\r\n") if @trailer
+
+    exported_data
+  end
+
+  def first_creation_date
+    record = @records[0]
+    if record
+      time = record.creation_time
+      return Date.civil(time.year, time.month, time.day)
+    end
+  end
+
+  def last_creation_date
+    record = @records[-1]
+    if record
+      time = record.creation_time
+      return Date.civil(time.year, time.month, time.day)
+    end
+  end
+
+  def ==(other)
+    return self.class == other.class && @records == other.records
+  end
+
+  # get the first id after the AFD header
+  def first_id
+    first_record = @records[0]
+    first_record ? first_record.line_id : nil
+  end
+
+  # get the last id before the AFD trailer
+  def last_id
+    last_record = @records[-1]
+    last_record ? last_record.line_id : nil
+  end
+
+  def merge(other)
+    other_first_id, other_last_id = other.first_id, other.last_id
+    if other_first_id.nil? || other_last_id.nil?
+      raise AfdParser::AfdParserException.new("Cannot merge with a empty parser")
+    end
+
+    @header = other.header if other.header
+
+    # merge is done by grouping all the records by line id, and replacing
+    # the ones in "self" by duplicates of the ones in "other".
+    this_records_by_line_id = @records.group_by{|record| record.line_id}
+    other_records_by_line_id = other.records.group_by{|record| record.line_id}
+    other_records_by_line_id.keys.each do |key|
+      this_records_by_line_id[key] = other_records_by_line_id[key].dup
+    end
+    @records = this_records_by_line_id.keys.sort.collect{|key| this_records_by_line_id[key]}.flatten
+
+    @trailer = nil
+    create_trailer
+  end
+
+  private
+  def initialize_variables(options)
+    @records = []
+    @current_line_id = nil
+    @previous_line_id = nil
+    if options.is_a?(Hash)
+      @validate_structure = options[:validate_structure]
+      @validate_expected_afd_records_ids = options[:validate_expected_afd_records_ids]
+    else
+      @validate_expected_afd_records_ids = @validate_structure = !!options
+    end
+  end
+
+  def get_record_type(line_id, record_type_id, line)
+    if record_type_id == 1
+      return :header
+    elsif line_id == 999999999 and line.unpack("x45A").first.to_i == 9
+      return :trailer
+    elsif line_id != 0
+      case record_type_id
+      when 2
+        return :set_employer
+      when 3
+        return :clock_in_out
+      when 4
+        return :set_time
+      when 5
+        return :set_employee
+      end
+    end
+
+    return nil
+  end
+
+  def validate_afd(line, line_id, previous_line_id, index, record_type)
+    raise AfdParser::AfdParserException.new("Line #{index.to_s} is blank") if line.nil? || line.empty?
+
+    if trailer_found?
+      raise AfdParser::AfdParserException.new("Unexpected AFD record found after trailer, line #{index.to_s}: '#{line}'")
+    end
+
+    if not header_found? and record_type != :header
+      raise AfdParser::AfdParserException.new("Unexpected AFD record found before header, line #{index.to_s}: '#{line}'")
+    end
+
+    if header_found? and record_type == :header
+      raise AfdParser::AfdParserException.new("Unexpected second AFD header found, line #{index.to_s}: '#{line}'")
+    end
+
+    if @validate_expected_afd_records_ids and previous_line_id.nil? and index == 1 and line_id != index
+      raise AfdParser::AfdParserException.new("AFD records starts at an unexpected line ID; expected '1', got '#{line_id.to_s}'.")
+    end
+
+    if not previous_line_id.nil? and line_id != previous_line_id + 1 and not (line_id == 999999999 and not trailer_found?)
+      raise AfdParser::AfdParserException.new("Out-of-order line id on line 1; expected '#{index.to_s}', got '#{line_id.to_s}'")
+    end
+  end
+
+  def header_found?
+    !@header.nil?
+  end
+
+  def trailer_found?
+    !@trailer.nil?
+  end
+
+  def count_records
+    counter = {:set_employer => 0, :clock_in_out => 0, :set_time => 0, :set_employee => 0}
+    @records.each do |record|
+      case record
+      when *SetEmployer
+        counter[:set_employer] += 1
+      when *ClockInOut
+        counter[:clock_in_out] += 1
+      when *SetTime
+        counter[:set_time] += 1
+      when *SetEmployee
+        counter[:set_employee] += 1
+      end
+    end
+    return counter
+  end
+end

data/lib/afd_parser/clock_in_out.rb

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require 'afd_parser/record_parser'
+
+class AfdParser::ClockInOut < AfdParser::RecordParser
+  attr_reader :line_id, :record_type_id, :creation_time, :pis
+
+  def initialize(line)
+    self.line_id, self.record_type_id, self.creation_time, self.pis =
+      line.unpack("A9AA12A12").collect{|str| _clean!(str)}
+  end
+
+  def export
+    line_export = ""
+    line_export += line_id.to_s.rjust(9,"0")
+    line_export += record_type_id.to_s
+    line_export += format_time(creation_time)
+    line_export += pis.to_s.rjust(11,"0")
+    line_export
+  end
+
+  def self.size
+    34
+  end
+
+  def ==(other)
+    return self.class == other.class && [:line_id, :record_type_id, :creation_time, :pis].all? do |reader|
+      self.send(reader) == other.send(reader)
+    end
+  end
+
+  private
+  def line_id=(data)
+    @line_id = well_formed_number_string?(data) ? data.to_i : data
+  end
+
+  def record_type_id=(data)
+    @record_type_id = well_formed_number_string?(data) ? data.to_i : data
+  end
+
+  def pis=(data)
+    @pis = well_formed_number_string?(data.strip) ? data.to_i : data
+  end
+
+  def creation_time=(raw_time)
+    begin
+      parsed_time = parse_time(raw_time)
+      @creation_time = parsed_time
+    rescue
+      @creation_time = ""
+    end
+  end
+end

data/lib/afd_parser/header.rb

@@ -0,0 +1,144 @@
+# -*- coding: utf-8 -*-
+# Controle de Horas - Sistema para gestão de horas trabalhadas
+# Copyright (C) 2009  O.S. Systems Softwares Ltda.
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Rua Clóvis Gularte Candiota 132, Pelotas-RS, Brasil.
+# e-mail: contato@ossystems.com.br
+
+require 'afd_parser/record_parser'
+
+class AfdParser::Header < AfdParser::RecordParser
+  attr_reader :line_id, :record_type_id, :employer_type, :employer_document, :employer_cei, :employer_name, :rep_serial_number, :afd_start_date, :afd_end_date, :afd_creation_time
+
+  EMPLOYER_TYPES = {1 => :cnpj, 2 => :cpf}
+
+  def initialize(*args)
+    if args.size == 1
+      line = args[0]
+
+      self.line_id, self.record_type_id, self.employer_type, self.employer_document,
+      self.employer_cei, self.employer_name, self.rep_serial_number, self.afd_start_date,
+      self.afd_end_date, self.afd_creation_time =
+        line.unpack("A9AAA14A12A150A17A8A8A12").collect{|str| _clean!(str)}
+    elsif args.size == 8
+      @line_id           = 0
+      @record_type_id    = 1
+      @employer_type     = args[0]
+      @employer_document = args[1]
+      @employer_cei      = args[2]
+      @employer_name     = args[3]
+      @rep_serial_number = args[4]
+      @afd_start_date    = args[5]
+      @afd_end_date      = args[6]
+      @afd_creation_time = args[7]
+    else
+      raise AfdParser::AfdParserException.new("wrong number of arguments for header object, should be 1 or 8")
+    end
+  end
+
+  def export
+    line_export = ""
+    line_export += @line_id.to_s.rjust(9,"0")
+    line_export += @record_type_id.to_s
+    line_export += get_employer_type_number(@employer_type).to_s
+    line_export += @employer_document.to_s.rjust(14, "0")
+    line_export += @employer_cei.to_s.rjust(12, "0")
+    line_export += @employer_name.to_s.ljust(150, " ")
+    line_export += @rep_serial_number
+    line_export += format_date(@afd_start_date)
+    line_export += format_date(@afd_end_date)
+    line_export += format_time(@afd_creation_time)
+    line_export
+  end
+
+  def self.size
+    232
+  end
+
+  def ==(other)
+    return self.class == other.class && [:line_id, :record_type_id, :employer_type, :employer_document, :employer_cei, :employer_name, :rep_serial_number, :afd_start_date, :afd_end_date, :afd_creation_time].all? do |reader|
+      self.send(reader) == other.send(reader)
+    end
+  end
+
+  private
+  def line_id=(data)
+    @line_id = well_formed_number_string?(data) ? data.to_i : data
+  end
+
+  def record_type_id=(data)
+    @record_type_id = well_formed_number_string?(data) ? data.to_i : data
+  end
+
+  def employer_type=(data)
+    @employer_type = get_employer_type(data.to_i)
+  end
+
+  def employer_document=(data)
+    @employer_document = well_formed_number_string?(data) ? data.to_i : data
+  end
+
+  def employer_cei=(data)
+    @employer_cei = well_formed_number_string?(data) ? data.to_i : data
+  end
+
+  def employer_name=(data)
+    @employer_name = data.rstrip
+  end
+
+  def rep_serial_number=(data)
+    @rep_serial_number = data
+  end
+
+  def afd_start_date=(raw_date)
+    begin
+      parsed_date = parse_date(raw_date)
+      @afd_start_date = parsed_date
+    rescue
+      @afd_start_date = raw_date
+    end
+  end
+
+  def afd_end_date=(raw_date)
+    begin
+      parsed_date = parse_date(raw_date)
+      @afd_end_date = parsed_date
+    rescue
+      @afd_end_date = raw_date
+    end
+  end
+
+  def afd_creation_time=(raw_time)
+    begin
+      parsed_time = parse_time(raw_time)
+      @afd_creation_time = parsed_time
+    rescue
+      @afd_creation_time = raw_time
+    end
+  end
+
+  def get_employer_type(employer_type_id)
+    type = EMPLOYER_TYPES[employer_type_id]
+    if type.nil?
+      raise AfdParser::AfdParserException.new("Unknown employer type id '#{employer_type_id.to_s}' found in AFD header")
+    end
+    type
+  end
+
+  def get_employer_type_number(employer_type)
+    EMPLOYER_TYPES.invert[employer_type]
+  end
+end