simple_invoice 0.0.1

data/spec/model/billing_period_type_monthly_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+module SimpleInvoice
+  describe BillingPeriodType::Monthly do
+
+    context "monthly" do
+      subject { BillingPeriodType::Monthly.new 1 }
+
+      describe "#last_day_of_period" do
+        specify do
+          {
+            '2012-02-01' => '2012-02-29',
+            '2013-02-01' => '2013-02-28',
+            '2013-09-01' => '2013-09-30',
+            '2013-10-01' => '2013-10-31',
+            '2013-12-01' => '2013-12-31'
+          }.each do |first_day, last_day|
+            subject.last_day_of_period(Date.parse(first_day)).should == Date.parse(last_day)
+          end
+        end
+      end
+
+      describe "#first_day_of_next_period" do
+        specify do
+          {
+            '2012-02-01' => '2012-03-01',
+            '2013-02-01' => '2013-03-01',
+            '2013-09-01' => '2013-10-01',
+            '2013-10-01' => '2013-11-01',
+            '2013-12-01' => '2014-01-01'
+          }.each do |first_day, last_day|
+            subject.first_day_of_next_period(Date.parse(first_day)).should == Date.parse(last_day)
+          end
+        end
+      end
+    end
+
+    context "quarterly" do
+      subject { BillingPeriodType::Monthly.new 3 }
+
+      describe "#last_day_of_period" do
+        specify do
+          {
+            '2011-12-01' => '2012-02-29',
+            '2012-12-01' => '2013-02-28',
+            '2012-02-01' => '2012-04-30',
+            '2013-02-01' => '2013-04-30',
+            '2013-09-01' => '2013-11-30',
+            '2013-10-01' => '2013-12-31',
+            '2013-12-01' => '2014-02-28',
+            '2013-06-18' => '2013-09-17'
+          }.each do |first_day, last_day|
+            subject.last_day_of_period(Date.parse(first_day)).should == Date.parse(last_day)
+          end
+        end
+      end
+
+      describe "#first_day_of_next_period" do
+        specify do
+          {
+            '2011-12-01' => '2012-03-01',
+            '2012-12-01' => '2013-03-01',
+            '2012-02-01' => '2012-05-01',
+            '2013-02-01' => '2013-05-01',
+            '2013-09-01' => '2013-12-01',
+            '2013-10-01' => '2014-01-01',
+            '2013-12-01' => '2014-03-01',
+            '2013-06-18' => '2013-09-18'
+          }.each do |first_day, last_day|
+            subject.first_day_of_next_period(Date.parse(first_day)).should == Date.parse(last_day)
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/model/billing_period_type_weekly_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+module SimpleInvoice
+  describe BillingPeriodType::Weekly do
+
+    context "weekly" do
+      subject { BillingPeriodType::Weekly.new 1 }
+
+      describe "#last_day_of_period" do
+        specify do
+          {
+            '2012-02-27' => '2012-03-04',
+            '2013-02-27' => '2013-03-05',
+            '2013-09-01' => '2013-09-07',
+            '2013-10-27' => '2013-11-02',
+            '2013-12-27' => '2014-01-02'
+          }.each do |first_day, last_day|
+            subject.last_day_of_period(Date.parse(first_day)).should == Date.parse(last_day)
+          end
+        end
+      end
+
+      describe "#first_day_of_next_period" do
+        specify do
+          {
+            '2012-02-27' => '2012-03-05',
+            '2013-02-27' => '2013-03-06',
+            '2013-09-01' => '2013-09-08',
+            '2013-10-27' => '2013-11-03',
+            '2013-12-27' => '2014-01-03'
+          }.each do |first_day, last_day|
+            subject.first_day_of_next_period(Date.parse(first_day)).should == Date.parse(last_day)
+          end
+        end
+      end
+    end
+
+    context "fortnightly" do
+      subject { BillingPeriodType::Weekly.new 2 }
+
+      describe "#last_day_of_period" do
+        specify do
+          {
+            '2012-02-27' => '2012-03-11',
+            '2013-02-27' => '2013-03-12',
+            '2013-09-01' => '2013-09-14',
+            '2013-10-27' => '2013-11-09',
+            '2013-12-27' => '2014-01-09'
+          }.each do |first_day, last_day|
+            subject.last_day_of_period(Date.parse(first_day)).should == Date.parse(last_day)
+          end
+        end
+      end
+
+      describe "#first_day_of_next_period" do
+        specify do
+          {
+            '2012-02-27' => '2012-03-12',
+            '2013-02-27' => '2013-03-13',
+            '2013-09-01' => '2013-09-15',
+            '2013-10-27' => '2013-11-10',
+            '2013-12-27' => '2014-01-10'
+          }.each do |first_day, last_day|
+            subject.first_day_of_next_period(Date.parse(first_day)).should == Date.parse(last_day)
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/model/invoice_data_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module SimpleInvoice
+  describe InvoiceData do
+    subject { InvoiceData.new 'INV-123', '2013-09-01', '2013-09-08' }
+
+    describe "#invoice_number=" do
+      it "should store as a string" do
+        InvoiceData.new(123).invoice_number.should == '123'
+      end
+    end
+
+    describe "#set_dates" do
+      subject { InvoiceData.new 'INV-123' }
+      context "given dates as String" do
+        it "should parse date strings to Date" do
+          subject.set_dates '2013-09-01', '2013-09-08'
+          subject.issue_date.should == Date.parse('2013-09-01')
+          subject.due_date.should == Date.parse('2013-09-08')
+        end
+      end
+      context "given dates as Date" do
+        it "should accept dates as Date type" do
+          subject.set_dates Date.parse('2013-09-01'), Date.parse('2013-09-08')
+          subject.issue_date.should == Date.parse('2013-09-01')
+          subject.due_date.should == Date.parse('2013-09-08')
+        end
+      end
+      context "given due days instead of due_date" do
+        it "should interpret a Fixnum as due days" do
+          subject.set_dates '2013-09-01', 7
+          subject.issue_date.should == Date.parse('2013-09-01')
+          subject.due_date.should == Date.parse('2013-09-08')
+        end
+      end
+    end
+
+    describe "#due_days" do
+      it "should be the difference between the due date and issue date" do
+        subject.due_days.should be_a Fixnum
+        subject.due_days.should == 7
+      end
+    end
+  end
+end

data/spec/model/line_item_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module SimpleInvoice
+  describe LineItem do
+
+    subject { LineItem.new "", 29_95, 2 }
+
+    describe "#total" do
+      it "sums line items" do
+        subject.total.should == 29_95 * 2
+      end
+    end
+
+  end
+end

data/spec/model/line_items_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+module SimpleInvoice
+  describe LineItems do
+
+    describe "#total" do
+      it "sums line items" do
+        subject.push double("line item 1", :total => 49_95)
+        subject.push double("line item 2", :total => 59_90)
+        subject.total.should == 49_95 + 59_90
+      end
+    end
+
+  end
+end

data/spec/model/subscription_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module SimpleInvoice
+  describe Subscription do
+
+    subject do
+      Subscription.new.tap do |sub|
+        sub.start_date = Date.parse('2013-01-02')
+        sub.billing_period_type = :monthly
+      end
+    end
+
+    describe "#billing_periods" do
+      specify do
+        billing_periods = subject.billing_periods
+        [
+          '2013-01-02',
+          '2013-02-02',
+          '2013-03-02',
+          '2013-04-02'
+        ].each do |date|
+          billing_periods.next.first_day.should == Date.parse(date)
+        end
+      end
+    end
+
+  end
+end

data/spec/services/create_invoice_for_subscription_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module SimpleInvoice
+  describe Services::CreateInvoiceForSubscription do
+
+    let(:line_item_1) { LineItem.new "line item 1", 49_95, 1 }
+    let(:line_item_2) { LineItem.new "line item 2", 49_95, 2 }
+    let(:line_items) { LineItems.new [line_item_1, line_item_2]}
+    let(:template) do
+      double 'invoice_template', :line_items => line_items
+    end
+    let(:contact) { double('contact') }
+    let(:subscription) do
+      double 'subscription', :contact => contact,
+                             :invoice_template => template,
+                             :due_days => 7
+    end
+    let(:issue_date) { Date.parse('2013-10-01') }
+    subject do
+      Services::CreateInvoiceForSubscription.new(subscription, issue_date).tap do |inst|
+        inst.stub(:allocate_invoice_number => nil)
+      end
+    end
+
+    describe "#create_invoice" do
+      let(:invoice) { subject.create_invoice }
+      it "should produce an invoice" do
+        invoice.should be_a Invoice
+      end
+      it "should set issue date and due date" do
+        invoice.issue_date.should == issue_date
+        invoice.due_date.should == Date.parse('2013-10-08')
+      end
+      it "should set contact" do
+        invoice.contact.should == contact
+      end
+      it "should not set an invoice number" do
+        invoice.invoice_number.should be_nil
+      end
+      it "should add line items" do
+        invoice.line_items.length.should == 2
+      end
+      it "should copy line items" do
+        invoice.line_items.should_not equal line_items
+        line_item = invoice.line_items.to_a.first
+        line_item.should == line_item_1 # same value
+        line_item.should_not equal line_item_1 # different object
+      end
+    end
+
+  end
+end

data/spec/services/process_subscription_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module SimpleInvoice
+  describe Services::ProcessSubscription do
+
+    let(:template) do
+      double 'invoice_template', :line_items => LineItems.new([])
+    end
+
+    def subscription
+      double 'subscription', :contact => nil,
+                             :invoice_template => template,
+                             :due_days => 7,
+                             :start_date => Date.parse('2013-01-02'),
+                             :billing_periods => ([
+                               '2013-01-02',
+                               '2013-02-02',
+                               '2013-03-02',
+                               '2013-04-02',
+                               '2013-05-02',
+                               '2013-06-02'
+                             ].collect do |date|
+                               double('billing_period', :first_day => Date.parse(date))
+                             end).each #=> Enumerator
+    end
+
+    def call date
+      Services::ProcessSubscription.call date, subscription
+    end
+
+    specify do
+      call('2012-12-02').should be_nil
+      call('2013-01-01').should be_nil
+      call('2013-01-02').should be_a Invoice
+      call('2013-01-03').should be_nil
+      call('2013-02-01').should be_nil
+      call('2013-02-02').should be_a Invoice
+      call('2013-02-03').should be_nil
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'simple_invoice'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

data/test-examples.rb

@@ -0,0 +1,23 @@
+# bundle exec ruby test-examples.rb
+
+failed = []
+
+example_dir = File.expand_path('example', File.dirname(__FILE__))
+Dir["#{example_dir}/*.expected-output.txt"].each do |output_file|
+  script_file = output_file.sub('.expected-output.txt', '.rb')
+  expected_output = File.read(output_file).strip
+  actual_output = `cd #{example_dir}; bundle exec ruby #{script_file}`.strip
+  if expected_output != actual_output
+    failed << script_file
+  end
+end
+
+if failed.any?
+  puts "Failed examples:"
+  failed.each do |script_file|
+    puts script_file
+  end
+  exit 1
+else
+  exit 0
+end

data/test.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+bundle exec rspec &&
+bundle exec ruby test-examples.rb

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: simple_invoice
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joel Plane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Very simple invoice library with minimal dependencies
+email:
+- joel.plane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- example/Gemfile
+- example/create_invoice_from_subscription.expected-output.txt
+- example/create_invoice_from_subscription.rb
+- example/create_one_off_invoice.expected-output.txt
+- example/create_one_off_invoice.rb
+- example/lib/example_subscriptions/gardening_subscription.rb
+- example/lib/example_subscriptions/lawn_mowing_subscription.rb
+- example/lib/invoice_number_allocator.rb
+- example/lib/invoice_plain_text_formatter.rb
+- example/run_daily_process_subscriptions.expected-output.txt
+- example/run_daily_process_subscriptions.rb
+- git-hooks/INSTALL.sh
+- git-hooks/pre-commit.sh
+- lib/simple_invoice.rb
+- lib/simple_invoice/billing_period.rb
+- lib/simple_invoice/billing_period_type.rb
+- lib/simple_invoice/billing_period_type/monthly.rb
+- lib/simple_invoice/billing_period_type/weekly.rb
+- lib/simple_invoice/config.rb
+- lib/simple_invoice/contact.rb
+- lib/simple_invoice/invoice.rb
+- lib/simple_invoice/invoice_data.rb
+- lib/simple_invoice/invoice_template.rb
+- lib/simple_invoice/line_item.rb
+- lib/simple_invoice/line_items.rb
+- lib/simple_invoice/services.rb
+- lib/simple_invoice/services/allocate_invoice_number.rb
+- lib/simple_invoice/services/create_invoice.rb
+- lib/simple_invoice/services/create_invoice_for_subscription.rb
+- lib/simple_invoice/services/create_invoice_template.rb
+- lib/simple_invoice/services/process_subscription.rb
+- lib/simple_invoice/services/process_subscriptions.rb
+- lib/simple_invoice/subscription.rb
+- lib/simple_invoice/version.rb
+- simple_invoice.gemspec
+- spec/model/billing_period_spec.rb
+- spec/model/billing_period_type_monthly_spec.rb
+- spec/model/billing_period_type_weekly_spec.rb
+- spec/model/invoice_data_spec.rb
+- spec/model/line_item_spec.rb
+- spec/model/line_items_spec.rb
+- spec/model/subscription_spec.rb
+- spec/services/create_invoice_for_subscription_spec.rb
+- spec/services/process_subscription_spec.rb
+- spec/spec_helper.rb
+- test-examples.rb
+- test.sh
+homepage: https://github.com/joelplane/simple_invoice
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: simple invoice library
+test_files: []