qb_iif 0.1.0

data/lib/qb_iif/dsl/trns.rb

@@ -0,0 +1,56 @@
+module QbIif::DSL
+  class Trns < Base
+    HEADER_COLUMNS = [
+      :trnsid,
+      :trnstype,
+      :date,
+      :accnt,
+      :name,
+      :class,
+      :amount,
+      :docnum,
+      :memo,
+      :clear,
+      :toprint,
+      :addr1,
+      :addr2,
+      :addr3,
+      :addr4,
+      :addr5,
+      :saddr1,
+      :saddr2,
+      :saddr3,
+      :saddr4,
+      :saddr5,
+      :duedate,
+      :terms,
+      :paid,
+      :paymeth,
+      :shipdate,
+      :rep,
+      :ponum,
+      :invtitle,
+      :invmemo
+    ]
+    START_COLUMN = 'TRNS'
+    END_COLUMN = 'ENDTRNS'
+
+    def headers
+      [
+        ["!#{START_COLUMN}"].concat(HEADER_COLUMNS.map(&:upcase)),
+        ["!SPL"].concat(Spl::HEADER_COLUMNS.map(&:upcase)),
+        ["!#{END_COLUMN}"]
+      ]
+    end
+
+    def rows
+      @rows << [END_COLUMN]
+    end
+
+    def spl(&block)
+      Spl.new.build(&block)[:rows].each do |row|
+        @rows << row
+      end
+    end
+  end
+end

data/lib/qb_iif/dsl/vend.rb

@@ -0,0 +1,39 @@
+module QbIif::DSL
+  class Vend < Base
+    HEADER_COLUMNS = [
+      :name,
+      :printas,
+      :addr1,
+      :addr2,
+      :addr3,
+      :addr4,
+      :addr5,
+      :vtype,
+      :cont1,
+      :phone1,
+      :phone2,
+      :faxnum,
+      :note,
+      :taxid,
+      :limit,
+      :terms,
+      :notepad,
+      :salutation,
+      :companyname,
+      :firstname,
+      :midinit,
+      :lastname,
+      :custfld1,
+      :custfld2,
+      :custfld3,
+      :custfld4,
+      :custfld5,
+      :custfld6,
+      :custfld7,
+      :"1099",
+      :note
+    ]
+    START_COLUMN = 'VEND'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/dsl/vtype.rb

@@ -0,0 +1,9 @@
+module QbIif::DSL
+  class Vtype < Base
+    HEADER_COLUMNS = [
+      :name
+    ]
+    START_COLUMN = 'VTYPE'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/iif.rb

@@ -0,0 +1,64 @@
+require 'csv'
+
+require 'qb_iif/keywords'
+require 'qb_iif/dsl/base'
+
+require 'qb_iif/dsl/accnt'
+require 'qb_iif/dsl/bud'
+require 'qb_iif/dsl/ctype'
+require 'qb_iif/dsl/cust'
+require 'qb_iif/dsl/emp'
+require 'qb_iif/dsl/invitem'
+require 'qb_iif/dsl/invmemo'
+require 'qb_iif/dsl/class'
+require 'qb_iif/dsl/othername'
+require 'qb_iif/dsl/paymeth'
+require 'qb_iif/dsl/shipmeth'
+require 'qb_iif/dsl/spl'
+require 'qb_iif/dsl/terms'
+require 'qb_iif/dsl/timeact'
+require 'qb_iif/dsl/timerhdr'
+require 'qb_iif/dsl/todo'
+require 'qb_iif/dsl/trns'
+require 'qb_iif/dsl/vend'
+require 'qb_iif/dsl/vtype'
+
+module QbIif
+  class IIF
+    include QbIif::Keywords
+
+    def initialize(&block)
+      @output = {}
+      if block_given?
+        if block.arity == 1
+          yield(self)
+        else
+          instance_eval(&block)
+        end
+      end
+    end
+
+    def output
+      CSV.generate(col_sep: "\t") do |tsv|
+
+        @output.each do |_, list|
+          list[:headers].uniq.each do |header|
+            tsv << header
+          end
+          list[:rows].each do |row|
+            tsv << row
+          end
+        end
+      end
+    end
+
+    def method_missing(method_name, *args, &block)
+      class_name = escaped(method_name).to_s.split('_').map(&:capitalize).join('')
+      result = QbIif::DSL.const_get(class_name).new.build(&block)
+
+      @output[method_name] ||= { headers: [], rows: [] }
+      @output[method_name][:headers].concat(result[:headers])
+      @output[method_name][:rows].concat(result[:rows])
+    end
+  end
+end

data/lib/qb_iif/keywords.rb

@@ -0,0 +1,12 @@
+module QbIif
+  module Keywords
+    ESCAPED_KEYWORDS = {
+      _class: :class,
+      _1099: :"1099"
+    }
+
+    def escaped(symbol)
+      ESCAPED_KEYWORDS[symbol] || symbol
+    end
+  end
+end

data/lib/qb_iif/rails/renderer.rb

@@ -0,0 +1,15 @@
+module QbIif
+  module Rails
+    class Renderer
+      ActionController::Renderers.add :iif do |iif_string, options|
+        filename = options[:filename] || options[:template]
+        send_data(
+          iif_string,
+          filename: "#{filename}.iif",
+          type: Mime::IIF,
+          disposition: 'attachment'
+        )
+      end
+    end
+  end
+end

data/lib/qb_iif/rails/template_handler.rb

@@ -0,0 +1,20 @@
+module QbIif
+  module Rails
+    class TemplateHandler
+      cattr_accessor :default_format
+      self.default_format = Mime::IIF
+
+      def self.call(template)
+        <<-RUBY
+          iif = ::QbIif::IIF.new
+
+          #{template.source}
+
+          iif.output
+        RUBY
+      end
+
+      ActionView::Template.register_template_handler :riif, self
+    end
+  end
+end

data/lib/qb_iif/railtie.rb

@@ -0,0 +1,17 @@
+require 'rails'
+
+module QbIif
+  class Railtie < ::Rails::Railtie
+    initializer 'qb_iif' do
+      ::ActiveSupport.on_load(:action_view) do
+        unless ::Mime::Type.lookup_by_extension(:iif)
+          ::Mime::Type.register "application/qbooks", :iif,
+            %w(application/qbookspro text/iif)
+        end
+
+        require 'qb_iif/rails/template_handler'
+        require 'qb_iif/rails/renderer'
+      end
+    end
+  end
+end

data/lib/qb_iif/version.rb

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

data/lib/qb_iif.rb

@@ -0,0 +1,7 @@
+require 'qb_iif/version'
+require 'qb_iif/iif'
+require 'qb_iif/railtie' if defined?(Rails)
+
+module QbIif
+  # Your code goes here...
+end

data/qb_iif.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qb_iif/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "qb_iif"
+  gem.version       = QbIif::VERSION
+  gem.authors       = ["Pracstrat"]
+  gem.email         = ["xinlangzi@gmail.com"]
+  gem.description   = "A simple DSL to generate QuickBooks IIF file"
+  gem.summary       = "A simple DSL to generate QuickBooks IIF file"
+  gem.homepage      = "https://github.com/pracstrat/qb-iif"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rails'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'awesome_print'
+  gem.add_development_dependency 'combustion', '~> 0.3.1'
+  gem.add_development_dependency 'fuubar'
+  gem.add_development_dependency 'coveralls'
+end

data/spec/controllers/invoices_controller_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe InvoicesController do
+  render_views
+
+  let(:expected) { File.read('spec/fixtures/rails/invoices.iif') }
+
+  describe '#index' do
+
+    before do
+      get :index, format: 'iif'
+    end
+
+    it 'respond with rendered iif' do
+      response.body.should eq expected
+    end
+
+    it 'respond with QuickBooks content type' do
+      response.header['Content-Type'].should eq 'application/qbooks'
+    end
+
+    it 'respond with filename: batman.iif' do
+      response.header['Content-Disposition'].should =~ /filename="batman\.iif"/
+    end
+  end
+end

data/spec/fixtures/accnt.iif

@@ -0,0 +1,2 @@
+!ACCNT	NAME	ACCNTTYPE	OBAMOUNT	DESC	SCD	ACCNUM	EXTRA
+ACCNT	Jun Lin	AR				47

data/spec/fixtures/bud.iif

@@ -0,0 +1,2 @@
+!BUD	ACCNT	PERIOD	AMOUNT	STARTDATE	CLASS	CUSTOMER
+BUD	Accounts Receivable	MONTH	foo	3/14/12

data/spec/fixtures/class.iif

@@ -0,0 +1,2 @@
+!CLASS	NAME
+CLASS	Foo

data/spec/fixtures/ctype.iif

@@ -0,0 +1,2 @@
+!CTYPE	NAME
+CTYPE	Bar

data/spec/fixtures/cust.iif

@@ -0,0 +1,2 @@
+!CUST	NAME	BADDR1	BADDR2	BADDR3	BADDR4	BADDR5	SADDR1	SADDR2	SADDR3	SADDR4	SADDR5	PHONE1	PHONE2	FAXNUM	CONT1	CONT2	CTYPE	TERMS	TAXABLE	LIMIT	RESALENUM	REP	TAXITEM	NOTEPAD	SALUTATION	COMPANYNAME	FIRSTNAME	MIDINIT	LASTNAME	CUSTFLD1	CUSTFLD2	CUSTFLD3	CUSTFLD4	CUSTFLD5	CUSTFLD6	CUSTFLD7	JOBDESC	JOBTYPE	JOBSTATUS	JOBSTART	JOBPROJEND	JOBEND	NOTE
+CUST	Jun Lin											12312323242

data/spec/fixtures/emp.iif

@@ -0,0 +1,2 @@
+!EMP	NAME	INIT	ADDR1	ADDR2	ADDR3	ADDR4	ADDR5	SSNO	PHONE1	PHONE2	NOTEPAD	FIRSTNAME	MIDINIT	LASTNAME	SALUTATION	CUSTFLD1	CUSTFLD2	CUSTFLD3	CUSTFLD4	CUSTFLD5	CUSTFLD6	CUSTFLD7	NOTE
+EMP	Alfred	Master	Backer	37											Doctor

data/spec/fixtures/invitem.iif

@@ -0,0 +1,2 @@
+!INVITEM	NAME	INVITEMTYPE	DESC	PURCHASEDESC	ACCNT	ASSETACCNT	COGSACCNT	PRICE	COST	TAXABLE	PAYMETH	TAXVEND	TAXDIST	TOPRINT	PREFVEND	REORDERPOINT	EXTRA	CUSTFLD1	CUSTFLD2	CUSTFLD3	CUSTFLD4	CUSTFLD5	DEP_TYPE	ISPASSEDTHRU
+INVITEM	invitem 1	INVENTORY																					1

data/spec/fixtures/invmemo.iif

@@ -0,0 +1,2 @@
+!INVMEMO	NAME
+INVMEMO	invmemo 1

data/spec/fixtures/mixed.iif

@@ -0,0 +1,13 @@
+!CUST	NAME	BADDR1	BADDR2	BADDR3	BADDR4	BADDR5	SADDR1	SADDR2	SADDR3	SADDR4	SADDR5	PHONE1	PHONE2	FAXNUM	CONT1	CONT2	CTYPE	TERMS	TAXABLE	LIMIT	RESALENUM	REP	TAXITEM	NOTEPAD	SALUTATION	COMPANYNAME	FIRSTNAME	MIDINIT	LASTNAME	CUSTFLD1	CUSTFLD2	CUSTFLD3	CUSTFLD4	CUSTFLD5	CUSTFLD6	CUSTFLD7	JOBDESC	JOBTYPE	JOBSTATUS	JOBSTART	JOBPROJEND	JOBEND	NOTE
+CUST	Batman	Amoy
+CUST	Joker	Amoy
+!BUD	ACCNT	PERIOD	AMOUNT	STARTDATE	CLASS	CUSTOMER
+BUD	Accounts Receivable	MONTH	foo	3/14/12
+BUD	Accounts Payable	MONTH	123	3/15/12
+!TRNS	TRNSID	TRNSTYPE	DATE	ACCNT	NAME	CLASS	AMOUNT	DOCNUM	MEMO	CLEAR	TOPRINT	ADDR1	ADDR2	ADDR3	ADDR4	ADDR5	SADDR1	SADDR2	SADDR3	SADDR4	SADDR5	DUEDATE	TERMS	PAID	PAYMETH	SHIPDATE	REP	PONUM	INVTITLE	INVMEMO
+!SPL	SPLID	TRNSTYPE	DATE	ACCNT	NAME	CLASS	AMOUNT	DOCNUM	MEMO	CLEAR	QNTY	PRICE	INVITEM	PAYMETH	TAXABLE	REIMBEXP	EXTRA
+!ENDTRNS
+TRNS	foo
+SPL	joker
+SPL	foobar
+ENDTRNS

data/spec/fixtures/othername.iif

@@ -0,0 +1,2 @@
+!OTHERNAME	NAME	BADDR1	BADDR2	BADDR3	BADDR4	BADDR5	PHONE1	PHONE2	FAXNUM	CONT1	NOTEPAD	SALUTATION	COMPANYNAME	FIRSTNAME	MIDINIT	LASTNAME	NOTE
+OTHERNAME	Alfred	Backer	37						123

data/spec/fixtures/paymeth.iif

@@ -0,0 +1,2 @@
+!PAYMETH	NAME
+PAYMETH	paymeth 1

data/spec/fixtures/rails/invoices.iif

@@ -0,0 +1,6 @@
+!TRNS	TRNSID	TRNSTYPE	DATE	ACCNT	NAME	CLASS	AMOUNT	DOCNUM	MEMO	CLEAR	TOPRINT	ADDR1	ADDR2	ADDR3	ADDR4	ADDR5	SADDR1	SADDR2	SADDR3	SADDR4	SADDR5	DUEDATE	TERMS	PAID	PAYMETH	SHIPDATE	REP	PONUM	INVTITLE	INVMEMO
+!SPL	SPLID	TRNSTYPE	DATE	ACCNT	NAME	CLASS	AMOUNT	DOCNUM	MEMO	CLEAR	QNTY	PRICE	INVITEM	PAYMETH	TAXABLE	REIMBEXP	EXTRA
+!ENDTRNS
+TRNS	12345	BILL	3/14/1984	Accounts Payable	EZ		-300	12345		N
+SPL	1	BILL	3/14/1984	Payable	CMA		300		foo		3	150	Base Rate
+ENDTRNS

data/spec/fixtures/shipmeth.iif

@@ -0,0 +1,2 @@
+!SHIPMETH	NAME
+SHIPMETH	shipmeth 1

data/spec/fixtures/terms.iif

@@ -0,0 +1,2 @@
+!TERMS	NAME	DUEDAYS	DISCPER	DISCDAYS	TERMSTYPE
+TERMS	terms 1	10	0.3	1	0

data/spec/fixtures/timeact.iif

@@ -0,0 +1,4 @@
+!TIMERHDR	VER	REL	COMPANYNAME	IMPORTEDBEFORE	FROMTIMER	COMPANYCREATETIME
+TIMERHDR	8	0	Import Test Company	N	Y	1208544781
+!TIMEACT	DATE	JOB	EMP	ITEM	PITEM	DURATION	PROJ	NOTE	BILLINGSTATUS
+TIMEACT	06/21/97	job 1	Jun	item 1		13:40	klass 1		0

data/spec/fixtures/todo.iif

@@ -0,0 +1,2 @@
+!TODO	REFNUM	ISDONE	DATE	DESC
+TODO	1234234	Y	7/11/2013	Pickup

data/spec/fixtures/trns.iif

@@ -0,0 +1,7 @@
+!TRNS	TRNSID	TRNSTYPE	DATE	ACCNT	NAME	CLASS	AMOUNT	DOCNUM	MEMO	CLEAR	TOPRINT	ADDR1	ADDR2	ADDR3	ADDR4	ADDR5	SADDR1	SADDR2	SADDR3	SADDR4	SADDR5	DUEDATE	TERMS	PAID	PAYMETH	SHIPDATE	REP	PONUM	INVTITLE	INVMEMO
+!SPL	SPLID	TRNSTYPE	DATE	ACCNT	NAME	CLASS	AMOUNT	DOCNUM	MEMO	CLEAR	QNTY	PRICE	INVITEM	PAYMETH	TAXABLE	REIMBEXP	EXTRA
+!ENDTRNS
+TRNS	123	INVOICE	8/31/1988	Accounts Receivable	Customer	tires:deeptread	20	1		N	N	Baker	Customer				Watson	Recipient									BOB
+SPL	777	INVOICE	8/31/1988	Income Account			-20			N	-2	10	Sales Item		N
+SPL	888
+ENDTRNS

data/spec/fixtures/vend.iif

@@ -0,0 +1,2 @@
+!VEND	NAME	PRINTAS	ADDR1	ADDR2	ADDR3	ADDR4	ADDR5	VTYPE	CONT1	PHONE1	PHONE2	FAXNUM	NOTE	TAXID	LIMIT	TERMS	NOTEPAD	SALUTATION	COMPANYNAME	FIRSTNAME	MIDINIT	LASTNAME	CUSTFLD1	CUSTFLD2	CUSTFLD3	CUSTFLD4	CUSTFLD5	CUSTFLD6	CUSTFLD7	1099	NOTE
+VEND	Jun Lin									12312323242																				Y

data/spec/fixtures/vtype.iif

@@ -0,0 +1,2 @@
+!VTYPE	NAME
+VTYPE	vtype 1

data/spec/internal/app/controllers/invoices_controller.rb

@@ -0,0 +1,7 @@
+class InvoicesController < ActionController::Base
+  def index
+    respond_to do |format|
+      format.iif { render iif: render_to_string, filename: 'batman'}
+    end
+  end
+end

data/spec/internal/app/views/invoices/index.iif.riif

@@ -0,0 +1,27 @@
+iif.trns do
+  row do
+    trnsid 12345
+    trnstype 'BILL'
+    date '3/14/1984'
+    accnt 'Accounts Payable'
+    name 'EZ'
+    amount -300
+    docnum 12345
+    clear 'N'
+  end
+
+  spl do
+    row do
+      splid 001
+      trnstype 'BILL'
+      date '3/14/1984'
+      accnt 'Payable'
+      invitem 'Base Rate'
+      name 'CMA'
+      amount 300
+      memo "foo"
+      qnty 3
+      price 150
+    end
+  end
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :invoices
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/qb_iif/dsl/accnt_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe QbIif::DSL::Accnt do
+
+  let(:expected) { File.read('spec/fixtures/accnt.iif') }
+
+  let(:accnt) {
+    QbIif::IIF.new do
+      accnt do
+        row do
+          name 'Jun Lin'
+          accnttype 'AR'
+          accnum 47
+        end
+      end
+    end
+  }
+
+  subject { accnt }
+
+  its(:output) { should eq expected }
+end

data/spec/qb_iif/dsl/bud_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+class Invoice
+  attr_accessor :name
+  def initialize(n)
+    @name = n
+  end
+end
+describe QbIif::DSL::Bud do
+
+  let(:expected) { File.read('spec/fixtures/bud.iif') }
+
+  let(:bud) {
+    QbIif::IIF.new do
+      bud do
+        row do
+          accnt 'Accounts Receivable'
+          period 'MONTH'
+          amount 'foo'
+          startdate '3/14/12'
+        end
+      end
+    end
+  }
+
+  subject { bud }
+
+  its(:output) { should eq expected }
+end

data/spec/qb_iif/dsl/class_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe QbIif::DSL::Class do
+
+  let(:expected) { File.read('spec/fixtures/class.iif') }
+
+  let(:klass) {
+    QbIif::IIF.new do
+      _class do
+        row do
+          name 'Foo'
+        end
+      end
+    end
+  }
+
+  subject { klass }
+
+  its(:output) { should eq expected }
+end

data/spec/qb_iif/dsl/ctype_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe QbIif::DSL::Ctype do
+  let(:expected) { File.read('spec/fixtures/ctype.iif') }
+
+  let(:ctype) {
+    QbIif::IIF.new do
+      ctype do
+        row do
+          name 'Bar'
+        end
+      end
+    end
+  }
+
+  subject { ctype }
+
+  its(:output) { should eq expected }
+end

data/spec/qb_iif/dsl/cust_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe QbIif::DSL::Cust do
+  let(:expected) { File.read('spec/fixtures/cust.iif') }
+
+  let(:cust) {
+    QbIif::IIF.new do
+      cust do
+        row do
+          name 'Jun Lin'
+          phone1 '12312323242'
+        end
+      end
+    end
+  }
+
+  subject { cust }
+
+  its(:output) { should eq expected }
+end

data/spec/qb_iif/dsl/emp_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe QbIif::DSL::Emp do
+
+  let(:expected) { File.read('spec/fixtures/emp.iif') }
+
+  let(:emp) {
+    QbIif::IIF.new do
+      emp do
+        row do
+          name 'Alfred'
+          init 'Master'
+          addr1 'Backer'
+          addr2 '37'
+          salutation 'Doctor'
+        end
+      end
+    end
+  }
+
+  subject { emp }
+
+  its(:output) { should eq expected }
+end

data/spec/qb_iif/dsl/invitem_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe QbIif::DSL::Invitem do
+  let(:expected) { File.read('spec/fixtures/invitem.iif') }
+
+  let(:invitem) {
+    QbIif::IIF.new do
+      invitem do
+        row do
+          name 'invitem 1'
+          invitemtype 'INVENTORY'
+          dep_type 1
+        end
+      end
+    end
+  }
+
+  subject { invitem }
+
+  its(:output) { should eq expected }
+end

data/spec/qb_iif/dsl/invmemo_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe QbIif::DSL::Invmemo do
+  let(:expected) { File.read('spec/fixtures/invmemo.iif') }
+
+  let(:invmemo) {
+    QbIif::IIF.new do
+      invmemo do
+        row do
+          name 'invmemo 1'
+        end
+      end
+    end
+  }
+
+  subject { invmemo }
+
+  its(:output) { should eq expected }
+end