ascii_invoicer 2.5.5

data/lib/ascii_invoicer.rb

@@ -0,0 +1,17 @@
+begin
+  require "ascii_invoicer/version"
+  require "ascii_invoicer/settings_manager"
+  require "ascii_invoicer/InvoiceProject"
+  require "ascii_invoicer/hash_transformer"
+  require "ascii_invoicer/tweaks"
+  require "ascii_invoicer/mixins"
+  require "ascii_invoicer/ascii_logger"
+rescue LoadError
+  require "./lib/ascii_invoicer/version"
+  require "./lib/ascii_invoicer/settings_manager"
+  require "./lib/ascii_invoicer/InvoiceProject"
+  require "./lib/ascii_invoicer/hash_transformer"
+  require "./lib/ascii_invoicer/tweaks"
+  require "./lib/ascii_invoicer/mixins"
+  require "./lib/ascii_invoicer/ascii_logger"
+end

data/lib/ascii_invoicer/InvoiceProject.rb

@@ -0,0 +1,356 @@
+require 'yaml'
+require 'csv'
+require 'date'
+require 'euro'
+
+require File.join __dir__, 'hash_transformer.rb'
+require File.join __dir__, 'projectFileReader.rb'
+require File.join __dir__, 'rfc5322_regex.rb'
+require File.join __dir__, 'texwriter.rb'
+require File.join __dir__, 'filters.rb'
+require File.join __dir__, 'generators.rb'
+
+## TODO requirements and validity
+## TODO open, YAML::parse, [transform, ] read_all, generate, validate
+## TODO statemachine!!
+# http://www.zenspider.com/Languages/Ruby/QuickRef.html
+class InvoiceProject < LuigiProject
+  attr_reader :project_path, :project_folder,
+    :raw_data,
+    :status,    :errors,
+    :settings,  :defaults
+
+  attr_writer :raw_data, :defaults
+
+  include TexWriter
+  include Filters
+  include Generators
+  include ProjectFileReader
+
+  # keys that are in the original file and that will be filtered
+  @@filtered_keys=%i[
+    format    lang      created
+    client    event     manager
+    offer     invoice   canceled
+    messages  products  hours
+    includes
+  ]
+
+  # keys that are not originally in the file will be generated
+  @@generated_keys=%i[
+    client_fullname
+    client_addressing
+    hours_time
+    hours_total
+    event_date
+    event_age
+    event_prettydate
+    caterers
+    offer_number
+    offer_costs    offer_taxes   offer_total   offer_final
+    invoice_costs  invoice_taxes invoice_total invoice_final
+    invoice_delay
+    invoice_paydelay
+    invoice_longnumber
+    event_calendaritems
+    productsbytax
+  ]
+
+  #def initialize(project_path = nil, template_path = nil, settings = $settings, name = nil)
+  def initialize(hash)
+    @path          = hash[:path]
+    @settings      = hash[:settings]
+    @template_path = hash[:template_path]
+    @data          = hash[:data]
+    @data        ||= {}
+
+    @name          = File.basename @path, '.yml'
+    @settings      = hash[:settings]
+    @status        = :ok
+    @errors        = []
+    @defaults      = {}
+    @defaults      = @settings[:defaults] unless @settings[:defaults].nil?
+
+    @defaults['format'] = '1.0.0'
+    @logger             = $logger
+
+    unless @template_path.nil?
+      create @template_path
+    end
+
+    open(@path) unless @path.nil?
+  end
+
+  ## open given .yml and parse into @raw_data
+  def open(project_path)
+    #puts "opening \"#{project_path}\""
+    raise "already opened another project" unless @project_path.nil?
+    @project_path   = project_path
+    @project_folder = File.split(project_path)[0]
+
+    error "FILE \"#{project_path}\" does not exist!" unless File.exists?(project_path)
+
+    ## setting the name
+    @data[:name] = File.basename File.split(@project_path)[0]
+
+    ## opening the project file
+    begin
+      @raw_data        = YAML::load(File.open(project_path))
+    rescue SyntaxError => error
+      @logger.warn "SyntaxError in #{project_path}, use \"edit\" to correct it.", :both
+      @logger.error error, :file
+      @status = :unparsable
+      return false
+    rescue Psych::SyntaxError => error
+      @logger.warn "SyntaxError in #{project_path}, use \"edit\" to correct it.", :both
+      @logger.error error, :file
+      @status = :unparsable
+      return false
+    else
+      @data[:valid] = true # at least for the moment
+      @status = :ok
+      @data[:project_path]  = project_path
+    end
+
+    #load format and transform or not
+    @data[:format] = @raw_data['format'] ? @raw_data['format'] : "1.0.0"
+    if @data[:format] < "2.4.0"
+      begin
+        @raw_data = import_100 @raw_data
+      rescue =>error
+        @status = :unparsable
+        @logger.warn "#{error} parsing #{@project_path}"
+        puts $@
+        return false
+      end
+    end
+
+    prepare_data()
+    return true
+  end
+
+  # displays "CANCELED: name if canceled"
+  def pretty_name
+    @data[:canceled] ? "CANCELED: #{@data[:name]}" : @data[:name]
+  end
+
+  # returns the name (LuigiProject Interface)
+  def name
+    @data[:name]
+  end
+
+  # returns the date (LuigiProject Interface)
+  def date
+    return @data[:event][:date] if @data[:event][:date]
+    return @data[:created]      if @data[:created]
+    return Date.parse "01.01.0000"
+  end
+
+  # returns the manager
+  def manager
+    data :manager
+  end
+
+  def path
+    @project_path
+  end
+
+  def fill_template
+    project_name = @name.sub(?_, " ") #latex build fails if values contain a "_"
+    manager_name = @settings.manager_name
+    version = @settings.version
+    template = File.basename(@template_path, ".yml.erb")
+
+    return binding()
+  end
+
+  # returns index for sorting (year+invoicenumber)
+  def index
+    return @data[:invoice][:number] + date.strftime('%Y%m%d') if @data[:invoice][:number]
+    return "zzz" + date.strftime('%Y%m%d')
+  end
+
+  ## currently only from 1.0.0 to 2.4.0 Format
+  def import_100 hash
+    rules = [
+      { old:"client",       new:"client/fullname"   },
+      { old:"address",      new:"client/address"    },
+      { old:"email",        new:"client/email"      },
+      { old:"event",        new:"event/name"        },
+      { old:"location",     new:"event/location"    },
+      { old:"description",  new:"event/description" }, #trim
+      { old:"manumber",     new:"offer/number"      },
+      { old:"anumber",      new:"offer/appendix"    },
+      { old:"rnumber",      new:"invoice/number"    },
+      { old:"payed_date",   new:"invoice/payed_date"},
+      { old:"invoice_date", new:"invoice/date"      },
+      { old:"signature",    new:"manager"           }, #trim
+      #{ old:"hours/time",  new:"hours/total"       },
+    ]
+    ht = HashTransformer.new :rules => rules, :original_hash => hash
+    new_hash = ht.transform()
+    new_hash[ 'created' ] = "01.01.0000"
+
+    date = strpdates(hash['date'])
+    new_hash.set_path("event/dates/0/begin", date[0])
+    new_hash.set_path("event/dates/0/end",   date[1]) unless date[1].nil?
+    new_hash.set_path("event/dates/0/time/begin", new_hash.get_path("time"))     if date[1].nil?
+    new_hash.set_path("event/dates/0/time/end",   new_hash.get_path("time_end")) if date[1].nil?
+
+    new_hash['manager']= new_hash['manager'].lines.to_a[1] if new_hash['manager'].lines.to_a.length > 1
+
+    if new_hash.get_path("client/fullname").words.class == Array
+      new_hash.set_path("client/title",     new_hash.get_path("client/fullname").lines.to_a[0].strip)
+      new_hash.set_path("client/last_name", new_hash.get_path("client/fullname").lines.to_a[1].strip)
+      new_hash.set_path("client/fullname",  new_hash.get_path("client/fullname").gsub("\n",' ').strip)
+    else
+      fail_at :client_fullname
+    end
+    new_hash.set_path("offer/date", Date.today)
+    new_hash.set_path("invoice/date", Date.today) unless new_hash.get_path("invoice/date")
+
+    return hash
+  end
+
+  def products
+    data :products
+  end
+
+
+  def prepare_data
+    @@filtered_keys.each {|key| read key }
+    @@generated_keys.each {|key|
+      value = apply_generator key, @data
+      @data.set_path key, value, ?_, true # symbols = true
+    }
+  end
+
+  def validate choice = :invoice
+    blockers(choice).length == 0
+  end
+
+  def blockers choice = :invoice
+    inval = {} # invalidators
+    inval[ :minimal ] = [:client_last_name, :caterers, :manager, :products, :event_dates]
+    inval[ :offer   ] = [:offer_number ] + inval[:minimal]
+    inval[ :invoice ] = inval[:offer]    + [:invoice_number, :invoice_date]
+    inval[ :payed   ] = inval[:invoice]  + [:invoice_payed]
+    inval[ :archive ] = inval[:payed]
+    inval[ :calendar] = inval[:offer]
+    inval[choice] & @errors
+  end
+
+  def to_s
+    name
+  end
+
+  def to_yaml
+    @raw_data.to_yaml
+  end
+
+
+  #getters for path_through_document
+  #getting path['through']['document']
+  def data key = nil
+    return @data if key.nil?
+    return @data.get_path key
+  end
+
+  def export_filename choice, ext=""
+    offer_number   = data 'offer/number'
+    invoice_number = data 'invoice/number'
+    name = data 'name'
+    date = data('event/date').strftime "%Y-%m-%d"
+
+    ext.prepend '.' unless ext.length > 0 and ext.start_with? '.'
+
+    if choice == :invoice
+      "#{invoice_number} #{name} #{date}#{ext}"
+    elsif choice == :offer
+      "#{offer_number} #{name}#{ext}"
+    else
+      return false
+    end
+  end
+end
+
+class InvoiceProduct
+  attr_reader :name, :hash, :tax, :valid, :returned,
+    :total_invoice, :cost_offer, :cost_invoice, :cost_offer,
+    :tax_invoice, :tax_offer, :tax_value,
+    :price, :unit
+
+  def initialize(hash, settings)
+    @hash      = hash
+    @name      = hash[:name]
+    @price     = hash[:price]
+    @unit      = hash[:unit]
+    @amount    = hash[:amount]
+    @settings  = settings
+    if hash[:tax]
+      @tax_value = hash[:tax]
+    else
+      @tax_value = @settings[:defaults][:tax]
+    end
+
+    fail "TAX MUST NOT BE > 1" if @tax_value > 1
+
+    @valid = true
+    calculate() unless hash.nil?
+  end
+
+  def to_csv *args
+    [@name, @price, @amount, @sold, @tax_value].to_csv(*args)
+  end
+
+  def to_s
+    "#{@amount}/#{@sold} #{@name}, #{@price} cost (#{@cost_offer}|#{@cost_invoice}) total(#{@total_offer}|#{@total_invoice} #{@tax_value}) "
+  end
+
+  def calculate()
+    return false if @hash.nil?
+    @valid    = false unless @hash[:sold].nil? or @hash[:returned].nil?
+    @valid    = false unless @hash[:amount] and @hash[:price]
+    @sold     = @hash[:sold]
+    @price    = @hash[:price].to_euro
+    @amount   = @hash[:amount]
+    @returned = @hash[:returned]
+
+    if @sold
+      @returned = @amount - @sold
+    elsif @returned
+      @sold = @amount - @returned
+    else
+      @sold = @amount
+      @returned = 0
+    end
+
+    @hash[:cost_offer]   = @cost_offer   = (@price * @amount).to_euro
+    @hash[:cost_invoice] = @cost_invoice = (@price * @sold).to_euro
+
+    @hash[:tax_offer]    = @tax_offer    = (@cost_offer   * @tax_value)
+    @hash[:tax_invoice]  = @tax_invoice  = (@cost_invoice * @tax_value)
+
+    @hash[:total_offer]    = @total_offer    = (@cost_offer   + @tax_offer)
+    @hash[:total_invoice]  = @total_invoice  = (@cost_invoice + @tax_invoice)
+    self.freeze
+  end
+
+  def amount choice
+    return @sold   if choice == :invoice
+    return @amount if choice == :offer
+    return -1
+  end
+
+  def cost choice
+    return @cost_invoice if choice == :invoice
+    return @cost_offer   if choice == :offer
+    return -1.to_euro
+  end
+
+  def tax choice
+    return @tax_invoice if choice == :invoice
+    return @tax_offer   if choice == :offer
+    return -1.to_euro
+  end
+end

data/lib/ascii_invoicer/ascii_logger.rb

@@ -0,0 +1,64 @@
+#http://stackoverflow.com/questions/6407141/how-can-i-have-ruby-logger-log-output-to-stdout-as-well-as-file
+require 'logger'
+require 'fileutils'
+
+class MultiIO
+  def initialize(*targets)
+     @targets = targets
+  end
+
+  def write(*args)
+    @targets.each {|t| t.write(*args); t.flush}
+  end
+
+  def close
+    @targets.each(&:close)
+  end
+end
+
+class AsciiLogger
+
+  # logger.log, "message", :stdo
+  # logger.log, "message", :file
+  # logger.log, "message", :both
+  # log, error, info, warn, fatal, unknown
+  def initialize name, path
+    path = File.expand_path path
+    FileUtils.touch path
+    @log_file = File.open path, ?a
+    @known_loggers = [:file, :stdo, :both]
+    @known_methods = [:info, :warn, :error, :fatal, :unknown]
+
+    @file_logger = Logger.new MultiIO.new @log_file
+    @stdo_logger = Logger.new STDOUT
+    @both_logger = Logger.new MultiIO.new STDOUT, @log_file
+
+    @file_logger.progname = name
+    @stdo_logger.progname = name
+    @both_logger.progname = name
+  end
+
+  def log logger_name, method_name, message
+    raise "#{method_name}, unknown method type, use #{@known_methods}" unless @known_methods.include? method_name
+    raise "#{logger_name}, unknown logger type, use #{@known_loggers}" unless @known_loggers.include? logger_name
+
+    logger_name = "@#{(logger_name.to_s)}_logger".to_sym
+    if instance_variables.include? logger_name
+      logger = instance_variable_get logger_name
+      logger.method(method_name).call message
+    else
+      puts "ERROR: logger not found (#{logger_name})"
+    end
+  end
+
+  # imitates stdlib logger interface -> AsciiLogger::error message, {:stdo\:file\:both}
+  def method_missing method_name, *stuff
+    if @known_methods.include? method_name.to_sym
+      message = stuff[0]
+      logger  = stuff[1].to_sym if stuff[1]
+      logger  = :both unless @known_loggers.include? logger
+      log logger, method_name.to_sym, message
+    end
+  end
+
+end

data/lib/ascii_invoicer/filters.rb

@@ -0,0 +1,129 @@
+require 'date'
+#require File.join __dir__ + '/rfc5322_regex.rb'
+
+module Filters
+
+
+  def strpdates(string,pattern = nil)
+    return [Date.today] unless string.class == String
+    if pattern
+      return [Date.strptime(string, pattern).to_date]
+    else
+      p = string.split('.')
+      p_range = p[0].split('-')
+
+      if p_range.length == 1
+        t = Date.new p[2].to_i, p[1].to_i, p[0].to_i
+        return [t]
+
+      elsif p_range.length == 2
+        t1 = Date.new p[2].to_i, p[1].to_i, p_range[0].to_i
+        t2 = Date.new p[2].to_i, p[1].to_i, p_range[1].to_i
+        return [t1,t2]
+
+      else
+        fail
+      end
+    end
+  end
+
+  def check_email email
+    email =~ $RFC5322
+  end
+
+  def filter_client_email email
+    return fail_at :client_email unless check_email email
+    email
+  end
+
+  def filter_canceled canceled
+    @STATUS = :canceled if @STATUS != :unparsable and canceled
+    canceled
+  end
+
+  def filter_event_dates dates
+    dates.each {|d|
+      unless d[:time].nil? or d[:end].nil? ## time and end is missleading
+        @logger.warn "FILTER: #{name} missleading: time and end_date"
+        return fail_at :event_dates
+      end
+
+      d[:begin] = Date.parse(d[:begin]) if d[:begin].class == String
+
+      if not d[:time].nil?
+        d[:time][:begin] = DateTime.strptime("#{d[:time][:begin]} #{d[:begin]}", "%H:%M %d.%m.%Y" ) if d[:time][:begin]
+        d[:time][:end]   = DateTime.strptime("#{d[:time][:end]  } #{d[:begin]}", "%H:%M %d.%m.%Y" ) if d[:time][:end]
+      end
+
+      if d[:end].class == String
+        d[:end] = Date.parse(d[:end])
+      else
+        d[:end] = d[:begin]
+      end
+    }
+    dates
+  end
+
+  def filter_event_description string
+    return "" unless string
+    string.strip
+  end
+
+  def filter_manager string
+    string.strip
+  end
+
+  def filter_messages messages
+    messages[ @data[:lang].to_sym ]
+  end
+
+  def filter_products products
+    new_products = []
+    products.each{|k,v|
+      if [String, Symbol].include?  k.class
+        v[:name] = k
+        new_products.push InvoiceProduct.new v , @settings
+      elsif k.class == Hash
+        new_products.push InvoiceProduct.new k.merge(v), @settings
+        #new_products.push k.merge(v)
+      else
+        return k
+        throw :filter_error
+      end
+    }
+
+    return new_products
+  end
+
+  def filter_created date
+    return Date.parse date if date.class == String
+    fail_at :created_date
+  end
+
+  def filter_offer_date date
+    return Date.parse date if date.class == String
+    fail_at :offer_date
+    return Date.today
+  end
+
+  def filter_invoice_number number
+    return fail_at :invoice_number if number.nil?
+    "R#{number.to_s.rjust(3, ?0)}"
+  end
+
+  def filter_invoice_date date
+    return Date.parse date if date.class == String
+    fail_at :invoice_date
+    return Date.today
+  end
+
+  def filter_invoice_payed_date date
+    return Date.parse date if date.class == String
+    return fail_at :invoice_payed
+  end
+
+  def filter_hours_salary salary
+    salary.to_euro
+  end
+
+end