efo_nelfo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1766eab8e78076ddd1e00b0bd831975ab51cf86
+  data.tar.gz: d0188d51f9e52fd7bd133717261540334d2abf3f
+SHA512:
+  metadata.gz: 2f4522a7ac95b3655348404e92b8dab3bd79d8787b9c4128033e7e2f5d8c8b1659730144c8a136bb17f0b33438e9e1af2c9107c26ed8d1a65a17f1b0b594afcb
+  data.tar.gz: 6708ebf094bb145c2a30f7a4e7c4d81887fdcdd5d1603b1c470898ba76a466eb86fb4b86f81edb05f6400128a9c1fcf49d55e64d1d33eb739a88e4f4ab7f08a0

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/Gemfile

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

data/Guardfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gudleik Rasch
+
+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,46 @@
+# EfoNelfo
+
+Gem for parsing and writing EfoNelfo documents.
+
+Supported versions:
+
+* 4.0
+
+Supported formats:
+
+* Bestilling
+
+
+## Usage
+
+Importing a CSV file:
+
+    # EfoNelfo.parse_csv "B12345678.332.csv"    # => EfoNelfo::V40::Order
+
+Exporting CSV:
+
+    # order = EfoNelfo::V40::Order.new
+    # order.add EfoNelfo::V40::Order::Line.new item_number: '442', order_number: 'abc'
+    # order.to_csv
+
+
+## TODO
+
+* Export to json
+* Support more filetypes
+* Support more versions
+* Support XML
+
+
+## Resources
+
+* http://www.efo.no/Portals/5/docs/ImplementasjonsGuide%20EFONELFO%204.0.pdf
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = false
+end

data/efo_nelfo.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'efo_nelfo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "efo_nelfo"
+  spec.version       = EfoNelfo::VERSION
+  spec.authors       = ["Gudleik Rasch"]
+  spec.email         = ["gr@skalar.no"]
+  spec.description   = %q{Parser for EFONELFO format}
+  spec.summary       = %q{Parser for EFONELFO format}
+  spec.homepage      = "http://efo.no"
+  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 "awesome_print"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "rb-fsevent"
+  spec.add_development_dependency "terminal-notifier-guard"
+end

data/lib/efo_nelfo/array.rb

@@ -0,0 +1,10 @@
+module EfoNelfo
+
+  class Array < ::Array
+    def to_a
+      map(&:to_a).flatten(1)
+    end
+  end
+
+end
+

data/lib/efo_nelfo/attribute_assignment.rb

@@ -0,0 +1,13 @@
+module EfoNelfo
+
+  module AttributeAssignment
+    def initialize_attributes(*args)
+      if args && args.first.is_a?(Hash)
+        args.first.each do |attr, value|
+          send "#{attr}=", value
+        end
+      end
+    end
+  end
+
+end

data/lib/efo_nelfo/errors.rb

@@ -0,0 +1,4 @@
+module EfoNelfo
+  class UnsupportedPostType < StandardError; end
+  class DuplicateProperty < StandardError; end
+end

data/lib/efo_nelfo/foo.rb

@@ -0,0 +1,26 @@
+class Order
+  def initialize
+    @lines = [ ['c', 'd'] ]
+    @attrs = [ 'a', 'b' ]
+  end
+
+  def to_a
+    # [ @attrs ] << lines
+    arr = [ @attrs ]
+    lines.each do |i|
+      arr += i
+    end
+    arr
+  end
+
+  def lines
+    @lines
+  end
+
+  def to_csv
+    to_a
+  end
+end
+
+
+puts Order.new.to_csv.inspect

data/lib/efo_nelfo/post_type.rb

@@ -0,0 +1,51 @@
+module EfoNelfo
+
+  class PostType
+    include EfoNelfo::Property
+
+    attr_reader :post_type
+
+    @modules = []
+
+    class << self
+      def inherited(klass)
+        @modules << klass
+      end
+
+      def for(type, version=nil)
+        @modules.select { |mod| mod.can_parse?(type, version) }.first
+      end
+
+      def can_parse?(post_type, check_version=nil)
+        if check_version
+          self::POST_TYPES.keys.include?(post_type) && check_version == version
+        else
+          self::POST_TYPES.keys.include?(post_type)
+        end
+      end
+
+      # Extracts version number from class namespace.
+      # Example: EfoNelfo::V41::Some::Class.version  # => "4.1"
+      def version
+        (self.to_s.match(/::V(?<version>\d+)::/)[:version].to_f / 10).to_s
+      end
+
+    end
+
+    def initialize(*args)
+      initialize_attributes *args
+      @post_type = self.class::POST_TYPES.keys.first
+      @version   = self.class.version
+    end
+
+    # This is for adding posttypes
+    def add(something)
+    end
+
+    def post_type_human
+      self.class::POST_TYPES[post_type]
+    end
+
+  end
+
+end

data/lib/efo_nelfo/property.rb

@@ -0,0 +1,132 @@
+module EfoNelfo
+
+  module Property
+    include EfoNelfo::AttributeAssignment
+
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    def attributes
+      @attributes ||= initialize_default_attributes
+    end
+
+    def properties
+      self.class.properties
+    end
+
+    def to_a
+      properties.keys.map { |prop| formatted_for_csv(prop) }
+    end
+
+    private
+
+    def initialize_default_attributes
+      properties.inject({}) { |h,(name,options)| h[name] = options[:default]; h }
+    end
+
+    def format_value(value, type)
+      case type
+      when :integer
+        value.nil? ? nil : value.to_i
+      when :date
+        if value.nil?
+          nil
+        elsif value.kind_of? String
+          Date.parse value
+        else
+          value
+        end
+      when :boolean
+        value.nil? || value == true || value == 'J' || value == '' ? true : false
+      else
+        value
+      end
+    end
+
+    def formatted_for_csv(attr)
+      value = send(attr)
+
+      type  = properties[attr][:type]
+      case type
+      when :date
+        value ? value.strftime("%Y%m%d") : nil
+      when :boolean
+        value == true ? "J" : nil
+      else
+        value
+      end
+    end
+
+    module ClassMethods
+      # Creates an attribute with given name.
+      #
+      # Options
+      #   - type      String, Integer etc. Default is String
+      #   - required  whether attribute is required. Default is false
+      #   - limit     Length the attribute can be. Default is nil
+      #   - alias     Norwegian alias name for the attribute
+      #
+      def property(name, options={})
+        options = {
+          type: :string,
+          required: false,
+        }.update options
+
+        name = name.to_sym
+
+        # Store property info in @properties
+        raise EfoNelfo::DuplicateProperty if properties.has_key?(name)
+        properties[name] = options
+
+        create_reader_for(name, options)
+        create_setter_for(name, options) unless options[:read_only]
+        create_question_for(name)        if options[:type] == :boolean
+        create_alias_for(name, options)  if options[:alias]
+      end
+
+      # Returns all properties
+      def properties
+        @_properties ||= {}
+      end
+
+      private
+
+      # Creates an attribute accessor for name
+      def create_reader_for(name, options)
+        define_method name do
+          attributes[name]
+        end
+      end
+
+      # Creates an attribute setter for name
+      def create_setter_for(name, options)
+        define_method "#{name}=" do |value|
+          attributes[name] = format_value(value, options[:type])
+        end
+      end
+
+      # Creates a name? accessor
+      def create_question_for(name)
+        define_method "#{name}?" do
+          attributes[name] == true
+        end
+      end
+
+      def create_alias_for(name, options)
+        define_method(options[:alias]) do
+          send name
+        end
+
+        unless options[:read_only]
+          define_method("#{options[:alias]}=") do |val|
+            send "#{name}=", val
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/efo_nelfo/reader/csv.rb

@@ -0,0 +1,67 @@
+require 'csv'
+
+module EfoNelfo
+  module Reader
+
+    class CSV
+      CSV_OPTIONS = {
+        col_sep: ';',
+        headers: false,
+        row_sep: "\r\n",
+        encoding: "iso-8859-1",
+        quote_char: "\x00",
+        force_quotes: false,
+        skip_blanks: true
+      }
+
+      attr_reader :csv, :data
+
+      def initialize(options)
+        if options[:filename]
+          @data = File.read(options[:filename], encoding: CSV_OPTIONS[:encoding])
+        else
+          @data = options[:data]
+        end
+
+        @csv = ::CSV.new @data, CSV_OPTIONS
+      end
+
+      def parse
+        # Create the head object based on the first row
+        head = parse_head csv.first
+        head.source = @data
+
+        # Read rest of the file and add them to the head
+        csv.each do |row|
+          # Find the correct posttype module for given posttype and version
+          klass = EfoNelfo::PostType.for row[0]
+          next if klass.nil?
+
+          line = initialize_object_with_properties klass, row
+          head.add line
+        end
+
+        head
+      end
+
+      private
+
+      def parse_head(row)
+        klass = EfoNelfo::PostType.for row[0], row[2]
+        raise EfoNelfo::UnsupportedPostType.new("Don't know how to handle v#{row[2]} of #{row[0]}") if klass.nil?
+
+        initialize_object_with_properties klass, row
+      end
+
+      def initialize_object_with_properties(klass, columns)
+        object = klass.new
+        object.class.properties.each_with_index do |property, i|
+          object.send "#{property.first}=", columns[i]
+        end
+        object
+      end
+
+    end
+
+  end
+end

data/lib/efo_nelfo/v40/order/line.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+module EfoNelfo
+  module V40
+    class Order
+      class Line < EfoNelfo::PostType
+        POST_TYPES = {
+          'BL' => 'Bestilling vareLinjepost',
+          'IL' => 'Forespørsel vareLinjepost'
+        }
+
+        # It's important to list the property in the same order as specified in the specs
+        property :post_type,         alias: :PostType,   limit: 2,   default: 'BL'
+        property :index,             alias: :LinjeNr,    limit: 4,   type: :integer
+        property :order_number,      alias: :BestNr,     limit: 10,  required: true
+        property :item_type,         alias: :VareMrk,    limit: 1,   required: true, type: :integer
+        property :item_number,       alias: :VareNr,     limit: 14,  required: true
+        property :item_name,         alias: :VaBetg,     limit: 30,  required: true
+        property :item_description,  alias: :VaBetg2,    limit: 30
+        property :item_count,        alias: :Ant,        limit: 9,   required: true, type: :integer
+        property :price_unit,        alias: :PrisEnhet,  limit: 3,   required: true
+        property :buyer_item_number, alias: :KVareNr,    limit: 25
+        property :delivery_date,     alias: :LevDato,    type: :date
+        property :buyer_ref,         alias: :KjøpersRef, limit: 25
+        property :splitable,         alias: :DelLev,     type: :boolean, default: true
+        property :replacable,        alias: :AltKode,    type: :boolean, default: true
+
+        attr_accessor :text
+
+        # Returns an array with one or more elements
+        def to_a
+          [ super, text.to_a ].reject(&:empty?)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/efo_nelfo/v40/order/order.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+module EfoNelfo
+  module V40
+    class Order < EfoNelfo::PostType
+      POST_TYPES = {
+        'BH' => 'Bestilling Hodepost',
+        'IH' => 'Forespørsel Hodepost'
+      }
+
+      attr_reader   :lines
+      attr_accessor :source
+
+      # It's important to list the property in the same order as specified in the specs
+      property :post_type,                   alias: :PostType,      limit: 2, default: 'BH'
+      property :format,                      alias: :Format,        limit: 8, default: 'EFONELFO'
+      property :version,                     alias: :Versjon,       limit: 3, default: version
+      property :seller_id,                   alias: :SelgersId,     limit: 14
+      property :buyer_id,                    alias: :KjøpersId,     limit: 14, required: true
+      property :order_number,                alias: :BestNr,        limit: 10, required: true
+      property :customer_id,                 alias: :KundeNr,       limit: 10, required: true
+      property :contract_type,               alias: :AvtaleIdMrk,   limit: 1, type: :integer
+      property :contract_id,                 alias: :AvtaleId,      limit: 10
+      property :buyer_order_number,          alias: :KOrdNr,        limit: 10
+      property :buyer_customer_id,           alias: :KundAvd,       limit: 10
+      property :project_id,                  alias: :ProsjektNr,    limit: 10
+      property :buyer_warehouse_location,    alias: :KLagerMrk,     limit: 1
+      property :buyer_warehouse,             alias: :KLager,        limit: 14
+      property :seller_warehoure_location,   alias: :SLagerMrk,     limit: 1
+      property :seller_warehouse,            alias: :SLager,        limit: 14
+      property :external_ref,                alias: :EksternRef,    limit: 36
+      property :buyer_ref,                   alias: :KjøpersRef,    limit: 25
+      property :label,                       alias: :Merket,        limit: 25
+      property :confirmation_type,           alias: :ObkrType,      limit: 2
+      property :transport_type,              alias: :TransportMåte, limit: 25
+      property :transport_msg,               alias: :Melding,       limit: 25
+      property :delivery_date,               alias: :LevDato,       type: :date
+      property :origin,                      alias: :BestOpp,       limit: 2
+
+      property :receiver_delivery_location,  alias: :LAdrLok,       limit: 14
+      property :receiver_name,               alias: :LFirmaNavn,    limit: 35
+      property :receiver_address1,           alias: :LAdr1,         limit: 35
+      property :receiver_address2,           alias: :LAdr2,         limit: 35
+      property :receiver_zip,                alias: :LPostNr,       limit: 9
+      property :receiver_office,             alias: :LPostSted,     limit: 35
+      property :receiver_country,            alias: :LLandK,        limit: 2
+
+      property :buyer_name,                  alias: :KFirmaNavn,    limit: 35
+      property :buyer_address1,              alias: :KAdr1,         limit: 35
+      property :buyer_address2,              alias: :KAdr2,         limit: 35
+      property :buyer_zip,                   alias: :KPostNr,       limit: 9
+      property :buyer_office,                alias: :KPostSted,     limit: 35
+      property :buyer_country,               alias: :KLandK,        limit: 2
+      property :buyer_email,                 alias: :KEPost,        limit: 60
+      property :buyer_web,                   alias: :KWebAdr,       limit: 40
+
+      property :seller_name,                 alias: :SFirmaNavn,    limit: 35
+      property :seller_address1,             alias: :SAdr1,         limit: 35
+      property :seller_address2,             alias: :SAdr2,         limit: 35
+      property :seller_zip,                  alias: :SPostNr,       limit: 9
+      property :seller_office,               alias: :SPostSted,     limit: 35
+      property :seller_country,              alias: :SLandK,        limit: 2
+
+      def initialize(*args)
+        super
+        @lines = EfoNelfo::Array.new
+      end
+
+      def add(post_type)
+        case
+        when post_type.is_a?(Order::Line) then add_order_line(post_type)
+        when post_type.is_a?(Order::Text) then add_text_to_order_line(post_type)
+        end
+      end
+
+      def to_a
+        [ super ] + lines.to_a
+      end
+
+      def to_csv
+        CSV.generate EfoNelfo::Reader::CSV::CSV_OPTIONS do |csv|
+          to_a.each do |row|
+            csv << row unless row.empty?
+          end
+        end
+      end
+
+      private
+
+      # Appends a order line to the order
+      def add_order_line(line)
+        line.index = lines.length + 1
+        lines << line
+      end
+
+      # Add text to the last added orderline
+      def add_text_to_order_line(text)
+        lines.last.text = text
+      end
+
+    end
+  end
+end

data/lib/efo_nelfo/v40/order/text.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module EfoNelfo
+  module V40
+    class Order
+      class Text < EfoNelfo::PostType
+        POST_TYPES = {
+          'BT' => 'Bestilling Fritekstlinje',
+          'IT' => 'Forespørsel Fritekstlinje'
+        }
+
+        # It's important to list the property in the same order as specified in the specs
+        property :post_type, alias: :PostType, limit: 2, default: 'BT'
+        property :text,      alias: :FriTekst, limit: 30
+
+        def to_s
+          text
+        end
+
+      end
+    end
+  end
+end

data/lib/efo_nelfo/version.rb

@@ -0,0 +1,3 @@
+module EfoNelfo
+  VERSION = "0.0.1"
+end

data/lib/efo_nelfo.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+# Common stuff
+require 'efo_nelfo/version'
+require 'efo_nelfo/errors'
+require 'efo_nelfo/array'
+require 'efo_nelfo/attribute_assignment'
+require 'efo_nelfo/property'
+require 'efo_nelfo/post_type'
+
+# EfoNelfo v4.0 modules
+require 'efo_nelfo/v40/order/order'
+require 'efo_nelfo/v40/order/line'
+require 'efo_nelfo/v40/order/text'
+
+# Reader modules (import)
+require 'efo_nelfo/reader/csv'
+
+module EfoNelfo
+
+  class << self
+
+    def load(filename)
+      Reader::CSV.new(filename: filename).parse
+    end
+
+    def parse(data)
+      Reader::CSV.new(data: data).parse
+    end
+
+  end
+
+
+end
+