qb_iif 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dde2ea9aa7d439940a02bd99be6d77ba1192ecaa
+  data.tar.gz: ef4cb4fdaa8578ada05a0c71b5ea050e31eee89c
+SHA512:
+  metadata.gz: 36f12edbb2bdf8de52b2ca6adbd04b44b515079a61c61089e619cb3e1119c18097df540e39d19894908ef584dfc1266f398a4d5fd105e297bb9c3f5214130eee
+  data.tar.gz: bf34cf13a78b38940967deeeff8827a5281df7577d603b4bf2f01e9fcdbeb9697ea8c306cc205d34ccb7db6c5a961a7aeda98812ebf2954853f1889b0ea8dba3

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/.rspec

@@ -0,0 +1,3 @@
+--color
+--format Fuubar
+

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+## 0.1.0
+  * Implement OTHERNAME
+  * Implement TIMEACT
+  * Implement TERMS
+  * Implement VEND
+  * Implement VTYPE
+  * Implement SHIPMETH
+  * Implement PAYMETH
+  * Implement INVMEMO
+  * Implement INVITEM
+  * Implement CTYPE
+  * Implement CLASS
+  * Implement ACCNT
+  * Implement EMP
+  * Implement CUST
+  * Implement TRNS and SPL
+  * Implement Mixed document in one IIF file. (DSL had been changed)
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Practical Strategies, Inc.
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jordan
+
+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,188 @@
+QBIif
+========
+
+A simple DSL to generate IIF file for QuickBook and extend Rails render builder.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'qb_iif'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qb_iif
+## Keywords
+
+Please use underscore before the keyword. The keyword mapping as follow:
+```ruby
+ESCAPED_KEYWORDS = {
+  _class: :class,
+  _1099: :"1099"
+}
+```
+
+## Usage
+
+### With Rails
+
+With a custom template handler, it works with Rails.
+
+```ruby
+# invoices_controller.rb
+
+class InvoicesController < ApplicationController
+  def show
+    respond_to do |format|
+      format.iif { render iif: render_to_string, filename: 'batman'}
+      format.html
+    end
+  end
+end
+```
+
+```ruby
+# show.iif.riif
+
+iif.trns do
+  row do
+    trnsid 123
+    trnstype 'INVOICE'
+    date '8/31/1988'
+    accnt 'Accounts Receivable'
+    name 'Customer'
+    amount 20
+    docnum invoice.id
+    clear 'N'
+    toprint 'N'
+    addr1 'Baker'
+    addr2 'Customer'
+  end
+
+  spl do
+    row do
+      splid '777'
+      trnstype 'INVOICE'
+      date '8/31/1988'
+      accnt 'Income Account'
+      amount '-20'
+      clear 'N'
+      qnty '-2'
+      price 10
+      invitem 'Sales Item'
+      taxable 'N'
+    end
+  end
+
+  spl do
+    row do
+      splid '888'
+    end
+  end
+end
+```
+
+### Without Rails
+
+```ruby
+QbIif::IIF.new do
+  trns do
+    row do
+      trnsid 123
+      trnstype 'INVOICE'
+      date '8/31/1988'
+      accnt 'Accounts Receivable'
+      name 'Customer'
+      amount 20
+      docnum 1
+      clear 'N'
+      toprint 'N'
+      addr1 'Baker'
+      addr2 'Customer'
+    end
+
+    spl do
+      row do
+        splid '777'
+        trnstype 'INVOICE'
+        date '8/31/1988'
+        accnt 'Income Account'
+        amount '-20'
+        clear 'N'
+        qnty '-2'
+        price 10
+        invitem 'Sales Item'
+        taxable 'N'
+      end
+    end
+
+    spl do
+      row do
+        splid '888'
+      end
+    end
+  end
+end
+```
+
+Result:
+
+```
+!TRNS TRNSID  TRNSTYPE  DATE  ACCNT NAME  CLASS AMOUNT  DOCNUM  MEMO  CLEAR TOPRINT ADDR1 ADDR2 ADDR3 ADDR4 ADDR5 DUEDATE TERMS PAID  SHIPDATE
+!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    20  1   N N Baker Customer
+SPL 777 INVOICE 8/31/1988 Income Account      -20     N -2  10  Sales Item    N
+SPL 888
+ENDTRNS
+```
+
+If you prefer, you can pass an argument along with your block:
+
+```ruby
+QbIif::IIF.new do |riif|
+  riif.trns do |trns|
+    trns.row do |row|
+      row.trnsid 123
+      row.trnstype 'INVOICE'
+      row.date '8/31/1988'
+      row.accnt 'Accounts Receivable'
+      row.name 'Customer'
+    end
+  end
+end
+```
+
+## Editors
+
+### Vim
+
+```VimL
+au BufWinEnter,BufRead,BufNewFile *.riif set filetype=ruby
+```
+
+## Resources
+
+[Use Intuit Interchange Format (.iif) files](http://support.quickbooks.intuit.com/support/articles/HOW12778)
+
+## 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
+
+## Contributors
+
+https://github.com/pracstrat
+
+## Changes
+
+See [CHANGELOG.md](CHANGELOG.md)
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/lib/qb_iif/dsl/accnt.rb

@@ -0,0 +1,15 @@
+module QbIif::DSL
+  class Accnt < Base
+    HEADER_COLUMNS = [
+      :name,
+      :accnttype,
+      :obamount,
+      :desc,
+      :scd,
+      :accnum,
+      :extra
+    ]
+    START_COLUMN = 'ACCNT'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/dsl/base.rb

@@ -0,0 +1,54 @@
+module QbIif::DSL
+  class Base
+
+    include QbIif::Keywords
+
+    def initialize
+      @rows = []
+      @current_row = []
+    end
+
+    def build(&block)
+
+      instance_eval(&block)
+
+      output
+    end
+
+    def row(&block)
+      @current_row = [self.class::START_COLUMN]
+
+      instance_eval(&block)
+
+      @rows << @current_row
+    end
+
+    def output
+      {
+        headers: headers,
+        rows: rows
+      }
+    end
+
+    def headers
+      [
+        ["!#{self.class::START_COLUMN}"].concat(
+          self.class::HEADER_COLUMNS.map(&:upcase)
+        )
+      ]
+    end
+
+    def rows
+      @rows
+    end
+
+    def method_missing(method_name, *args, &block)
+      method_name = escaped(method_name)
+      if self.class::HEADER_COLUMNS.include?(method_name)
+        @current_row[self.class::HEADER_COLUMNS.index(method_name) + 1] = args[0]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/qb_iif/dsl/bud.rb

@@ -0,0 +1,14 @@
+module QbIif::DSL
+  class Bud < Base
+    HEADER_COLUMNS = [
+      :accnt,
+      :period,
+      :amount,
+      :startdate,
+      :class,
+      :customer
+    ]
+    START_COLUMN = 'BUD'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/dsl/class.rb

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

data/lib/qb_iif/dsl/ctype.rb

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

data/lib/qb_iif/dsl/cust.rb

@@ -0,0 +1,51 @@
+module QbIif::DSL
+  class Cust < Base
+    HEADER_COLUMNS = [
+      :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
+    ]
+    START_COLUMN = 'CUST'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/dsl/emp.rb

@@ -0,0 +1,31 @@
+module QbIif::DSL
+  class Emp < Base
+    HEADER_COLUMNS = [
+      :name,
+      :init,
+      :addr1,
+      :addr2,
+      :addr3,
+      :addr4,
+      :addr5,
+      :ssno,
+      :phone1,
+      :phone2,
+      :notepad,
+      :firstname,
+      :midinit,
+      :lastname,
+      :salutation,
+      :custfld1,
+      :custfld2,
+      :custfld3,
+      :custfld4,
+      :custfld5,
+      :custfld6,
+      :custfld7,
+      :note
+    ]
+    START_COLUMN = 'EMP'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/dsl/invitem.rb

@@ -0,0 +1,32 @@
+module QbIif::DSL
+  class Invitem < Base
+    HEADER_COLUMNS = [
+      :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
+    ]
+    START_COLUMN = 'INVITEM'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/dsl/invmemo.rb

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

data/lib/qb_iif/dsl/othername.rb

@@ -0,0 +1,25 @@
+module QbIif::DSL
+  class Othername < Base
+    HEADER_COLUMNS = [
+      :name,
+      :baddr1,
+      :baddr2,
+      :baddr3,
+      :baddr4,
+      :baddr5,
+      :phone1,
+      :phone2,
+      :faxnum,
+      :cont1,
+      :notepad,
+      :salutation,
+      :companyname,
+      :firstname,
+      :midinit,
+      :lastname,
+      :note
+    ]
+    START_COLUMN = 'OTHERNAME'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/dsl/paymeth.rb

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

data/lib/qb_iif/dsl/shipmeth.rb

@@ -0,0 +1,10 @@
+module QbIif::DSL
+  class Shipmeth < Base
+    HEADER_COLUMNS = [
+      :name
+    ]
+    START_COLUMN = 'SHIPMETH'
+    END_COLUMN = ''
+  end
+end
+

data/lib/qb_iif/dsl/spl.rb

@@ -0,0 +1,29 @@
+module QbIif::DSL
+  class Spl < Base
+    HEADER_COLUMNS = [
+      :splid,
+      :trnstype,
+      :date,
+      :accnt,
+      :name,
+      :class,
+      :amount,
+      :docnum,
+      :memo,
+      :clear,
+      :qnty,
+      :price,
+      :invitem,
+      :paymeth,
+      :taxable,
+      :reimbexp,
+      :extra
+    ]
+    START_COLUMN = 'SPL'
+    END_COLUMN = ''
+
+    def headers
+      []
+    end
+  end
+end

data/lib/qb_iif/dsl/terms.rb

@@ -0,0 +1,13 @@
+module QbIif::DSL
+  class Terms < Base
+    HEADER_COLUMNS = [
+      :name,
+      :duedays,
+      :discper,
+      :discdays,
+      :termstype,
+    ]
+    START_COLUMN = 'TERMS'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/dsl/timeact.rb

@@ -0,0 +1,17 @@
+module QbIif::DSL
+  class Timeact < Base
+    HEADER_COLUMNS = [
+      :date,
+      :job,
+      :emp,
+      :item,
+      :pitem,
+      :duration,
+      :proj,
+      :note,
+      :billingstatus
+    ]
+    START_COLUMN = 'TIMEACT'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/dsl/timerhdr.rb

@@ -0,0 +1,14 @@
+module QbIif::DSL
+  class Timerhdr < Base
+    HEADER_COLUMNS = [
+      :ver,
+      :rel,
+      :companyname,
+      :importedbefore,
+      :fromtimer,
+      :companycreatetime
+    ]
+    START_COLUMN = 'TIMERHDR'
+    END_COLUMN = ''
+  end
+end

data/lib/qb_iif/dsl/todo.rb

@@ -0,0 +1,12 @@
+module QbIif::DSL
+  class Todo < Base
+    HEADER_COLUMNS = [
+      :refnum,
+      :isdone,
+      :date,
+      :desc
+    ]
+    START_COLUMN = 'TODO'
+    END_COLUMN = ''
+  end
+end