simple_invoice 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/example/Gemfile

@@ -0,0 +1,2 @@
+gem 'simple_invoice', :path => '..'
+

data/example/create_invoice_from_subscription.expected-output.txt

@@ -0,0 +1,12 @@
+To:             John Smith
+Invoice number: 123
+Issue Date:     2013-10-01
+Due Date:       2013-10-08
+
+Description            Price      Qty.   Total
+------------------------------------------------
+Monthly lawn mowing    $ 60.00     1     $ 60.00
+------------------------------------------------
+Total                                    $ 60.00
+
+Due in 7 days

data/example/create_invoice_from_subscription.rb

@@ -0,0 +1,15 @@
+# bundle exec ruby create_invoice_from_subscription.rb
+
+require 'simple_invoice'
+require_relative 'lib/invoice_plain_text_formatter'
+require_relative 'lib/invoice_number_allocator'
+require_relative 'lib/example_subscriptions/lawn_mowing_subscription'
+
+SimpleInvoice::Config.allocate_invoice_number ExampleApplication::InvoiceNumberAllocator
+
+subscription = LAWN_MOWING_SUBSCRIPTION
+
+issue_date = '2013-10-01'
+invoice = SimpleInvoice::Services::CreateInvoiceForSubscription.new(subscription, issue_date).create_invoice
+
+puts ExampleApplication::InvoicePlainTextFormatter.new(invoice)

data/example/create_one_off_invoice.expected-output.txt

@@ -0,0 +1,13 @@
+To:             John Smith
+Invoice number: 123
+Issue Date:     2013-10-01
+Due Date:       2013-10-08
+
+Description        Price      Qty.   Total
+--------------------------------------------
+Brown paper bag    $  0.15     1     $  0.15
+Pliers             $  9.95     2     $ 19.90
+--------------------------------------------
+Total                                $ 20.05
+
+Due in 7 days

data/example/create_one_off_invoice.rb

@@ -0,0 +1,19 @@
+# bundle exec ruby create_one_off_invoice.rb
+
+require 'simple_invoice'
+require_relative 'lib/invoice_plain_text_formatter'
+require_relative 'lib/invoice_number_allocator'
+
+SimpleInvoice::Config.allocate_invoice_number ExampleApplication::InvoiceNumberAllocator
+
+# Invoices should be created using CreateInvoice or CreateInvoiceForSubscription
+# which both wrap SimpleInvoice::Invoice.new
+
+invoice = SimpleInvoice::Services::CreateInvoice.call do |inv|
+  inv.contact = SimpleInvoice::Contact.new("John Smith", "12345678", "john.smith@example.com")
+  inv.set_dates '2013-10-01', 7
+  inv.add_item "Brown paper bag", 15
+  inv.add_item "Pliers", 995, 2
+end
+
+puts ExampleApplication::InvoicePlainTextFormatter.new(invoice)

data/example/lib/example_subscriptions/gardening_subscription.rb

@@ -0,0 +1,13 @@
+GARDENING_SUBSCRIPTION = begin
+  invoice_template = SimpleInvoice::Services::CreateInvoiceTemplate.call do |temp|
+    temp.add_item "Monthly gardening", 50_00
+  end
+
+  SimpleInvoice::Subscription.new.tap do |sub|
+    sub.contact = SimpleInvoice::Contact.new("John Smith", "12345678", "john.smith@example.com")
+    sub.invoice_template = invoice_template
+    sub.due_days = 7
+    sub.billing_period_type = :monthly
+    sub.start_date = '2013-01-04'
+  end
+end

data/example/lib/example_subscriptions/lawn_mowing_subscription.rb

@@ -0,0 +1,13 @@
+LAWN_MOWING_SUBSCRIPTION = begin
+  invoice_template = SimpleInvoice::Services::CreateInvoiceTemplate.call do |temp|
+    temp.add_item "Monthly lawn mowing", 60_00
+  end
+
+  SimpleInvoice::Subscription.new.tap do |sub|
+    sub.contact = SimpleInvoice::Contact.new("John Smith", "12345678", "john.smith@example.com")
+    sub.invoice_template = invoice_template
+    sub.due_days = 7
+    sub.billing_period_type = :monthly
+    sub.start_date = '2013-01-02'
+  end
+end

data/example/lib/invoice_number_allocator.rb

@@ -0,0 +1,15 @@
+module ExampleApplication
+  class InvoiceNumberAllocator
+
+    # In a real application, this might do a database query to determine the next
+    # unused invoice number. The application may or may not make use of the
+    # invoice object passed in (eg. the invoice number might simply be sequence,
+    # or it might be based on the issue date - invoice.issue_date() )
+    def self.call invoice
+      # allocate the same number every time - obviously not an appropriate
+      # real-world implementation :)
+      123
+    end
+
+  end
+end

data/example/lib/invoice_plain_text_formatter.rb

@@ -0,0 +1,61 @@
+module ExampleApplication
+  class InvoicePlainTextFormatter
+
+    def initialize invoice
+      @invoice = invoice
+    end
+
+    def to_s
+      "#{header}\n" \
+      "#{line_items}\n" \
+      "#{footer}"
+    end
+
+    private
+
+    def header
+      "To:             #{@invoice.contact.name}\n" \
+      "Invoice number: #{@invoice.invoice_number}\n" \
+      "Issue Date:     #{@invoice.issue_date}\n" \
+      "Due Date:       #{@invoice.due_date}\n"
+    end
+
+    def max_description_length
+      @max_description_length ||= @invoice.line_items.to_a.collect do |item|
+        item.description.length
+      end.max
+    end
+
+    def line_items
+      line_items_header + "\n" +
+      @invoice.line_items.to_a.collect do |item|
+        line_item item
+      end.join("\n") + "\n" + total_line + "\n"
+    end
+
+    def line_items_header
+      "%-#{max_description_length}s    Price      Qty.   Total" % ['Description'] + "\n" +
+      "-" * (max_description_length + 29)
+    end
+
+    def line_item item
+      "%-#{max_description_length}s    %s    %2s     %s" % [item.description, format_price(item.price), item.quantity, format_price(item.total)]
+    end
+
+    def total_line
+      "-" * (max_description_length + 29) + "\n" +
+      "%-#{max_description_length}s                      %s" % ['Total', format_price(@invoice.line_items.total)]
+    end
+
+    def format_price price
+      dollars = price / 100
+      cents = price % 100
+      "$%3d.%02d" % [dollars, cents]
+    end
+
+    def footer
+      "Due in #{@invoice.due_days} days"
+    end
+
+  end
+end

data/example/run_daily_process_subscriptions.expected-output.txt

@@ -0,0 +1,14 @@
+Processed 2 subscriptions and generated 1 invoices
+
+To:             John Smith
+Invoice number: 123
+Issue Date:     2013-01-02
+Due Date:       2013-01-09
+
+Description            Price      Qty.   Total
+------------------------------------------------
+Monthly lawn mowing    $ 60.00     1     $ 60.00
+------------------------------------------------
+Total                                    $ 60.00
+
+Due in 7 days

data/example/run_daily_process_subscriptions.rb

@@ -0,0 +1,27 @@
+# bundle exec ruby run_daily_process_subscriptions.rb
+
+require 'simple_invoice'
+require_relative 'lib/invoice_plain_text_formatter'
+require_relative 'lib/invoice_number_allocator'
+require_relative 'lib/example_subscriptions/lawn_mowing_subscription'
+require_relative 'lib/example_subscriptions/gardening_subscription'
+
+SimpleInvoice::Config.allocate_invoice_number ExampleApplication::InvoiceNumberAllocator
+
+# In a real application, this might be the result of Date.today or ARGV[0]
+today = '2013-01-02'
+
+# Hard-coded subscription objects. In a real application, subscriptions would
+# be reconstructed from database records.
+subscriptions = [LAWN_MOWING_SUBSCRIPTION, GARDENING_SUBSCRIPTION]
+
+invoices = SimpleInvoice::Services::ProcessSubscriptions.call today, subscriptions
+
+# In a real application, invoices would need to be persisted at this point, and
+# perhaps further processed, like generating a PDF and sending it in an email.
+
+puts "Processed #{subscriptions.length} subscriptions and generated #{invoices.length} invoices"
+puts ""
+invoices.each do |invoice|
+  puts ExampleApplication::InvoicePlainTextFormatter.new(invoice)
+end

data/git-hooks/INSTALL.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+# Usage: git-hooks/INSTALL.sh
+# Note run from repo root
+
+if [[ "`pwd`" == *git-hooks* ]]; then
+  echo "Run from repo root instead. ie. cd ..; git-hooks/INSTALL.sh"
+  exit 1;
+fi
+
+unlink .git/hooks/pre-commit 2>/dev/null
+ln -s ../../git-hooks/pre-commit.sh .git/hooks/pre-commit

data/git-hooks/pre-commit.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+tests_pass() {
+  ./test.sh
+}
+
+if [ "$JUST_DO_IT" == "1" ]; then
+  exit 0
+fi
+
+if tests_pass; then
+  echo "[INFO]  tests passed"
+else
+  echo "[ERROR] tests failed"
+  exit 1
+fi

data/lib/simple_invoice.rb

@@ -0,0 +1,14 @@
+module SimpleInvoice
+  autoload :VERSION, 'simple_invoice/version'
+  autoload :Invoice, 'simple_invoice/invoice'
+  autoload :InvoiceData, 'simple_invoice/invoice_data'
+  autoload :LineItems, 'simple_invoice/line_items'
+  autoload :LineItem, 'simple_invoice/line_item'
+  autoload :InvoiceTemplate, 'simple_invoice/invoice_template'
+  autoload :Subscription, 'simple_invoice/subscription'
+  autoload :Contact, 'simple_invoice/contact'
+  autoload :Services, 'simple_invoice/services'
+  autoload :Config, 'simple_invoice/config'
+  autoload :BillingPeriodType, 'simple_invoice/billing_period_type'
+  autoload :BillingPeriod, 'simple_invoice/billing_period'
+end

data/lib/simple_invoice/billing_period.rb

@@ -0,0 +1,40 @@
+module SimpleInvoice
+  class BillingPeriod
+
+    attr_reader :first_day
+
+    # @param [BillingPeriodType, Symbol] billing_period_type
+    # @param [Date, String] first_day
+    def initialize billing_period_type, first_day
+      if billing_period_type.is_a? Symbol
+        @billing_period_type = BillingPeriodType.send(billing_period_type)
+      else
+        @billing_period_type = billing_period_type
+      end
+      @first_day = to_date first_day
+    end
+
+    def last_day
+      @last_day ||= @billing_period_type.last_day_of_period(@first_day)
+    end
+
+    # @return [BillingPeriod]
+    def next_billing_period
+      next_first_day = @billing_period_type.first_day_of_next_period @first_day
+      self.class.new @billing_period_type, next_first_day
+    end
+
+    private
+
+    # @param [String, Date] date
+    # @return [Date]
+    def to_date date
+      if date.is_a? Date
+        date
+      else
+        Date.parse date.to_s
+      end
+    end
+
+  end
+end

data/lib/simple_invoice/billing_period_type.rb

@@ -0,0 +1,44 @@
+module SimpleInvoice
+  class BillingPeriodType
+
+    def self.weekly
+      Weekly.new 1
+    end
+
+    def self.fortnightly
+      Weekly.new 2
+    end
+
+    def self.monthly
+      Monthly.new 1
+    end
+
+    def self.quarterly
+      Monthly.new 3
+    end
+
+    def self.annually
+      Monthly.new 12
+    end
+
+    autoload :Monthly, 'simple_invoice/billing_period_type/monthly'
+    autoload :Weekly, 'simple_invoice/billing_period_type/weekly'
+
+    # @param multiple [Fixnum]
+    def initialize multiple=1
+      @multiple = multiple
+    end
+
+    # @param first_day [Date]
+    def first_day_of_next_period first_day
+      raise "to be implemented in subclass"
+    end
+
+    # @param first_day [Date]
+    # @return [Date]
+    def last_day_of_period first_day
+      first_day_of_next_period(first_day).prev_day
+    end
+
+  end
+end

data/lib/simple_invoice/billing_period_type/monthly.rb

@@ -0,0 +1,12 @@
+module SimpleInvoice
+  class BillingPeriodType
+    class Monthly < BillingPeriodType
+
+      # @param first_day [Date]
+      def first_day_of_next_period first_day
+        first_day.next_month(@multiple)
+      end
+
+    end
+  end
+end

data/lib/simple_invoice/billing_period_type/weekly.rb

@@ -0,0 +1,12 @@
+module SimpleInvoice
+  class BillingPeriodType
+    class Weekly < BillingPeriodType
+
+      # @param first_day [Date]
+      def first_day_of_next_period first_day
+        first_day.next_day(7 * @multiple)
+      end
+
+    end
+  end
+end

data/lib/simple_invoice/config.rb

@@ -0,0 +1,33 @@
+module SimpleInvoice
+  class Config
+    class << self
+
+      extend Forwardable
+      def_delegator :instance, :[]
+
+      def instance
+        @instance ||= new
+      end
+
+      # @param callable [#call] object that responds to call(),
+      #                         which returns the next invoice number.
+      def allocate_invoice_number callable
+        instance[:allocate_invoice_number] = callable
+      end
+
+    end
+
+    def initialize
+      @config_hash = {}
+    end
+
+    def [](key)
+      @config_hash[key]
+    end
+
+    def []=(key, value)
+      @config_hash[key] = value
+    end
+
+  end
+end

data/lib/simple_invoice/contact.rb

@@ -0,0 +1,5 @@
+module SimpleInvoice
+  class Contact < Struct.new(:name, :phone, :email)
+
+  end
+end

data/lib/simple_invoice/invoice.rb

@@ -0,0 +1,22 @@
+module SimpleInvoice
+  class Invoice
+
+    extend Forwardable
+
+    attr_accessor :contact, :void
+    attr_reader :line_items
+    def_delegator :@line_items, :push, :add_line_item
+    def_delegators :@data, :invoice_number, :invoice_number=, :issue_date,
+                           :due_date, :set_dates, :due_days
+
+    # @param inv_number [#to_s, nil]
+    # @param issue_date [#to_s, Date, nil]
+    # @param due_date_or_due_days [#to_s, Date, Fixnum, nil] interpreted as due days if Fixnum
+    def initialize invoice_number=nil, issue_date=nil, due_date_or_due_days=nil
+      @line_items = LineItems.new
+      @data = InvoiceData.new invoice_number=nil, issue_date=nil, due_date_or_due_days=nil
+      @void = false
+    end
+
+  end
+end