simple_invoice 0.0.1

data/lib/simple_invoice/invoice_data.rb

@@ -0,0 +1,48 @@
+module SimpleInvoice
+  class InvoiceData
+
+    attr_reader :invoice_number, :issue_date, :due_date
+
+    # @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 inv_number=nil, issue_date=nil, due_date_or_due_days=nil
+      self.invoice_number = inv_number unless inv_number.nil?
+      set_dates(issue_date, due_date_or_due_days) unless [issue_date, due_date_or_due_days].any?(&:nil?)
+    end
+
+    # @param inv_number [#to_s]
+    def invoice_number= inv_number
+      @invoice_number = inv_number.to_s
+    end
+
+    # @param issue_date [#to_s, Date]
+    # @param due_date_or_due_days [#to_s, Date, Fixnum] interpreted as due days if Fixnum
+    def set_dates issue_date, due_date_or_due_days
+      @issue_date = to_date issue_date
+      if due_date_or_due_days.is_a? Fixnum
+        @due_date = @issue_date + due_date_or_due_days
+      else
+        @due_date = to_date due_date_or_due_days
+      end
+    end
+
+    # @return [Fixnum]
+    def due_days
+      (due_date - issue_date).to_i
+    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/invoice_template.rb

@@ -0,0 +1,15 @@
+module SimpleInvoice
+  class InvoiceTemplate
+
+    extend Forwardable
+
+    attr_reader :line_items
+    attr_reader :data
+    def_delegator :@line_items, :push, :add_line_item
+
+    def initialize
+      @line_items = LineItems.new
+    end
+
+  end
+end

data/lib/simple_invoice/line_item.rb

@@ -0,0 +1,10 @@
+module SimpleInvoice
+  class LineItem < Struct.new(:description, :price, :quantity)
+
+    # @return [Fixnum]
+    def total
+      price * quantity
+    end
+
+  end
+end

data/lib/simple_invoice/line_items.rb

@@ -0,0 +1,40 @@
+module SimpleInvoice
+  class LineItems
+
+    # @param line_items [Array<LineItem>]
+    def initialize line_items=[]
+      @line_items = line_items
+    end
+
+    # @param line_item [LineItem]
+    def push line_item
+      @line_items.push line_item
+    end
+
+    def length
+      @line_items.length
+    end
+
+    def each &block
+      @line_items.each(&block)
+    end
+
+    def to_a
+      @line_items
+    end
+
+    # @return [Fixnum]
+    def total
+      sum @line_items.collect(&:total)
+    end
+
+    private
+
+    # @param values [Array<Fixnum>]
+    # @return [Finxum]
+    def sum values
+      values.inject(0){|a,b| a + b }
+    end
+
+  end
+end

data/lib/simple_invoice/services.rb

@@ -0,0 +1,10 @@
+module SimpleInvoice
+  module Services
+    autoload :CreateInvoiceForSubscription, 'simple_invoice/services/create_invoice_for_subscription'
+    autoload :CreateInvoice, 'simple_invoice/services/create_invoice'
+    autoload :CreateInvoiceTemplate, 'simple_invoice/services/create_invoice_template'
+    autoload :AllocateInvoiceNumber, 'simple_invoice/services/allocate_invoice_number'
+    autoload :ProcessSubscription, 'simple_invoice/services/process_subscription'
+    autoload :ProcessSubscriptions, 'simple_invoice/services/process_subscriptions'
+  end
+end

data/lib/simple_invoice/services/allocate_invoice_number.rb

@@ -0,0 +1,33 @@
+module SimpleInvoice
+  module Services
+    class AllocateInvoiceNumber
+
+      # Allocate invoice number and apply it to invoice object
+      # @param invoice [SimpleInvoice::Invoice]
+      # @return [String] invoice number
+      def self.call invoice
+        next_invoice_number(invoice).tap do |number|
+          invoice.invoice_number = number
+        end
+      end
+
+      private
+
+      def self.next_invoice_number invoice
+        next_invoice_number_callable.call invoice
+      end
+
+      def self.next_invoice_number_callable
+        SimpleInvoice::Config[:allocate_invoice_number] || lambda do |invoice|
+          # This lambda is just a stub implementation
+          # A real implementation would be provided by the application,
+          # and not this library.
+          @next_invoice_number ||= 0
+          number = @next_invoice_number += 1
+          "INV-#{number}"
+        end
+      end
+
+    end
+  end
+end

data/lib/simple_invoice/services/create_invoice.rb

@@ -0,0 +1,50 @@
+module SimpleInvoice
+  module Services
+    class CreateInvoice
+
+      # @return [SimpleInvoice::Invoice]
+      def self.call &block
+        instance = new
+        block.call instance
+        instance.create_invoice
+      end
+
+      attr_writer :contact
+
+      extend Forwardable
+      def_delegator :invoice, :set_dates
+
+      # @return [SimpleInvoice::Invoice]
+      def create_invoice
+        invoice.tap do |inv|
+          allocate_invoice_number inv
+        end
+      end
+
+      # @param description [String]
+      # @param price [Fixnum]
+      # @param quantity [Fixnum]
+      def add_item description, price, quantity=1
+        line_item = LineItem.new description, price, quantity
+        invoice.add_line_item line_item
+      end
+
+      private
+
+      def invoice
+        @invoice ||= Invoice.new.tap do |inv|
+          inv.contact = contact
+        end
+      end
+
+      def allocate_invoice_number invoice
+        AllocateInvoiceNumber.call invoice
+      end
+
+      def contact
+        @contact ||= Contact.new
+      end
+
+    end
+  end
+end

data/lib/simple_invoice/services/create_invoice_for_subscription.rb

@@ -0,0 +1,53 @@
+module SimpleInvoice
+  module Services
+    class CreateInvoiceForSubscription
+
+      # @param subscription [SimpleInvoice::Subscription]
+      # @param issue_date [Date]
+      def initialize subscription, issue_date
+        @subscription = subscription
+        @issue_date = issue_date
+      end
+
+      # @return [SimpleInvoice::Invoice]
+      def create_invoice
+        invoice
+      end
+
+      private
+
+      # @return [SimpleInvoice::InvoiceTemplate]
+      def template
+        @subscription.invoice_template
+      end
+
+      # @return [SimpleInvoice::Contact]
+      def contact
+        @subscription.contact
+      end
+
+      # @return [SimpleInvoice::Invoice]
+      def invoice
+        @invoice ||= Invoice.new.tap do |invoice|
+          invoice.contact = contact
+          template.line_items.each do |template_line_item|
+            invoice.add_line_item template_line_item.dup
+          end
+          invoice.set_dates invoice_data.issue_date, invoice_data.due_date
+          allocate_invoice_number invoice
+        end
+      end
+
+      # @param issue_date [Date]
+      # @return [SimpleInvoice::InvoiceData]
+      def invoice_data
+        @invoice_data ||= InvoiceData.new nil, @issue_date, @subscription.due_days
+      end
+
+      def allocate_invoice_number invoice
+        AllocateInvoiceNumber.call invoice
+      end
+
+    end
+  end
+end

data/lib/simple_invoice/services/create_invoice_template.rb

@@ -0,0 +1,33 @@
+module SimpleInvoice
+  module Services
+    class CreateInvoiceTemplate
+
+      # @return [SimpleInvoice::InvoiceTemplate]
+      def self.call &block
+        instance = new
+        block.call instance
+        instance.create_invoice_template
+      end
+
+      # @return [SimpleInvoice::InvoiceTemplate]
+      def create_invoice_template
+        invoice_template
+      end
+
+      # @param description [String]
+      # @param price [Fixnum]
+      # @param quantity [Fixnum]
+      def add_item description, price, quantity=1
+        line_item = LineItem.new description, price, quantity
+        invoice_template.add_line_item line_item
+      end
+
+      private
+
+      def invoice_template
+        @invoice_template ||= InvoiceTemplate.new
+      end
+
+    end
+  end
+end

data/lib/simple_invoice/services/process_subscription.rb

@@ -0,0 +1,62 @@
+module SimpleInvoice
+  module Services
+    class ProcessSubscription
+
+      # @param date [Date, String]
+      # @param subscription [SimpleInvoice::Subscription]
+      # @return [nil, SimpleInvoice::Invoice]
+      def self.call date, subscription
+        new(date, subscription).maybe_invoice
+      end
+
+      # @return [nil, SimpleInvoice::Invoice]
+      def maybe_invoice
+        if should_create_an_invoice_today?
+          create_invoice
+        else
+          nil
+        end
+      end
+
+      protected
+
+      # @param date [Date, String]
+      # @param subscription [SimpleInvoice::Subscription]
+      def initialize date, subscription
+        @date = to_date date
+        @subscription = subscription
+      end
+
+      private
+
+      def should_create_an_invoice_today?
+        billing_periods = @subscription.billing_periods
+        catch(:break_with_return_value) do
+          loop do
+            billing_period = billing_periods.next
+            if billing_period.first_day == @date
+              throw :break_with_return_value, true
+            elsif billing_period.first_day > @date
+              throw :break_with_return_value, false
+            end
+          end
+        end
+      end
+
+      def create_invoice
+        CreateInvoiceForSubscription.new(@subscription, @date).create_invoice
+      end
+
+      # @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
+end

data/lib/simple_invoice/services/process_subscriptions.rb

@@ -0,0 +1,16 @@
+module SimpleInvoice
+  module Services
+    class ProcessSubscriptions
+
+      # @param date [Date, String]
+      # @param subscriptions [Array<SimpleInvoice::Subscription>]
+      # @return [Array<SimpleInvoice::Invoice>]
+      def self.call date, subscriptions
+        subscriptions.collect do |sub|
+          ProcessSubscription.call date, sub
+        end.compact
+      end
+
+    end
+  end
+end

data/lib/simple_invoice/subscription.rb

@@ -0,0 +1,26 @@
+module SimpleInvoice
+  class Subscription
+
+    attr_accessor :contact, :invoice_template, :due_days, :start_date, :billing_period_type, :cancelled
+
+    def cancel!
+      @cancelled = true
+    end
+
+    def cancelled?
+      !!@cancelled
+    end
+
+    # @return [Enumerator]
+    def billing_periods
+      Enumerator.new do |y|
+        period = BillingPeriod.new billing_period_type, start_date
+        loop do
+          y.yield period
+          period = period.next_billing_period
+        end
+      end
+    end
+
+  end
+end

data/lib/simple_invoice/version.rb

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

data/simple_invoice.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_invoice/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_invoice"
+  s.version     = SimpleInvoice::VERSION
+  s.authors     = ["Joel Plane"]
+  s.email       = ["joel.plane@gmail.com"]
+  s.homepage    = "https://github.com/joelplane/simple_invoice"
+  s.summary     = %q{simple invoice library}
+  s.description = %q{Very simple invoice library with minimal dependencies}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+end

data/spec/model/billing_period_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module SimpleInvoice
+  describe BillingPeriod do
+
+    subject { BillingPeriod.new :monthly, '2013-09-28' }
+
+    describe "#first_day" do
+      specify do
+        subject.first_day.should == Date.parse('2013-09-28')
+      end
+    end
+
+    describe "#last_day" do
+      specify do
+        subject.last_day.should == Date.parse('2013-10-27')
+      end
+    end
+
+    describe "#next_billing_period" do
+      specify do
+        subject.next_billing_period.first_day.should == Date.parse('2013-10-28')
+        subject.next_billing_period.last_day.should == Date.parse('2013-11-27')
+      end
+    end
+
+  end
+end