invoice_creator 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4adede3f3b67b7489075f69ddb3c89ff5fd30bc923afaa1247f988c56dd019ed
+  data.tar.gz: 7b8e9aeadacb1fb330c39f3107bd32fde8af4bf294ab25b354242042a67ac7f0
+SHA512:
+  metadata.gz: 689c22c4f20833e887bbef7d94648356c94d5e5b9be9c0b6761a69797e550678f5f12c066d50ffd7bc17b9bd93f7f648af9a044985218bbcfbed5887d5973a39
+  data.tar.gz: 89bfbd8b8bcabb3e4ddb3c3877e013b8afffe6230148719169aefc941fb6749e94c353e04b8963c9f73c54e7a872fc367fd249a87b59713666d665f35f453d74

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.0 10/01/2020
+* Initial gem release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at npufal@doximity.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    invoice_creator (0.1.0)
+      prawn (= 2.2.2)
+      prawn-table (= 0.2.2)
+      thor (= 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    pdf-core (0.7.0)
+    prawn (2.2.2)
+      pdf-core (~> 0.7.0)
+      ttfunk (~> 1.5)
+    prawn-table (0.2.2)
+      prawn (>= 1.3.0, < 3.0.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thor (0.20.0)
+    ttfunk (1.6.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  invoice_creator!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © 2018 Nicholas Pufal
+
+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,29 @@
+# Invoice Creator
+
+A simple invoice creation tool to help you bill your IT clients.
+
+![Sample Invoice](https://user-images.githubusercontent.com/680151/47966699-92c76200-e03c-11e8-8b22-f4fa3e63ef75.png)
+
+## Set up
+
+The codebase has been converted into a Ruby gem so you can just install it with:
+
+```bash
+  gem install invoice_creator
+```
+
+...and the binary should be available to you globally 🎉
+
+Just make sure to go into the gem's folder and edit the file `config.yml` so that it's tailored to
+your needs - define your rate, date format, filename format, etc.
+
+You can do `gem open invoice_creator` for quick access to the gem's folder.
+
+## Usage example
+
+Let's say we want to create an invoice that represents 168 billable hours and has
+invoice number set to 10:
+
+```bash
+./bin/invoice_creator create 168 --number 10
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "invoice_creator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/invoice_creator

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "invoice_creator"
+InvoiceCreator::Cli.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.yml

@@ -0,0 +1,26 @@
+settings:
+  rate: 100.00
+  date_format: "%b %d, %Y"
+  currency_abbreviation: "USD"
+  currency_format: "$%.02f"
+  due_day: 10 # 10th of the current month
+  invoice_identifier: "INV-%04d"
+  filename: "invoice-%Y-%m-%d.pdf" # absolute or relative path
+
+data:
+  from: |
+    John Smith
+    123 10th Ave
+    Fake City, SK, T2ZABC
+    Fake Country
+  to: |
+    Acme Inc.
+    123 1st St. Suite 001
+    Fake Country
+    12345 AZ
+  extra_info: |
+    <b>Payment information:</b>
+    Account Holder: John Smith
+    Account Number: 1234567
+    Transit number: 0909
+    Branch number: 9898

data/invoice_creator.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/invoice_creator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "invoice_creator"
+  spec.version       = InvoiceCreator::VERSION
+  spec.authors       = ["Nicholas Pufal"]
+  spec.email         = ["github@npufal.com"]
+  spec.summary       = %q{A simple invoice creation tool to help you bill your tech clients.}
+  spec.homepage      = "https://github.com/nicholaspufal/invoice_creator"
+  spec.license       = "MIT"
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "prawn", "2.2.2"
+  spec.add_runtime_dependency "prawn-table", "0.2.2"
+  spec.add_runtime_dependency "thor", "0.20.0"
+
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/invoice_creator.rb

@@ -0,0 +1,8 @@
+require "invoice_creator/version"
+require "invoice_creator/config_reader"
+require "invoice_creator/models/invoice"
+require "invoice_creator/services/invoice_printer"
+require "invoice_creator/presenters/invoice"
+require "invoice_creator/cli"
+
+module InvoiceCreator; end

data/lib/invoice_creator/cli.rb

@@ -0,0 +1,45 @@
+require "thor"
+
+module InvoiceCreator
+  class Cli < Thor
+    desc "create HOURS [EXPENSES_AMOUNT]", "Generates an invoice for the given amount of HOURS"
+    option :number, required: true
+    long_desc <<-LONGDESC
+    `./bin/invoice_generator create HOURS` will generate an invoice based on an amount of hours
+    of your choosing. Please update `config.yml` with your preferences before
+    running this command.
+
+    You can optionally specify a second parameter that represents an expenses
+    amount and which will be shown as part of a second row in your invoice.
+
+    Example:
+    > $ ./bin/invoice_generator create 168 450.25
+
+    A flag `--number` can also be used to define the invoice's number (the default is 1).
+    The actual number mask is defined within `config.yml`
+
+    > $ ./bin/invoice_generator create --number 25 168 450.25
+    LONGDESC
+    def create(hours, expenses_amount = 0.0)
+      invoice = Models::Invoice.new(
+        rate: ConfigReader.instance.rate,
+        due_day: ConfigReader.instance.due_day,
+        billable_hours: hours.to_f,
+        expenses_amount: expenses_amount.to_f,
+        number: options[:number]
+      )
+
+      presenter = Presenters::Invoice.new(
+        invoice: invoice,
+        config: ConfigReader.instance
+      )
+
+      Services::InvoicePrinter.new(presenter: presenter).print
+
+      puts <<~MESSAGE
+      Invoice created.
+      You can find it @ #{presenter.filename}
+      MESSAGE
+    end
+  end
+end

data/lib/invoice_creator/config_reader.rb

@@ -0,0 +1,33 @@
+require "yaml"
+require "ostruct"
+require "singleton"
+
+module InvoiceCreator
+  class ConfigReader
+    include Singleton
+
+    def initialize
+      @yaml = YAML.load_file("config.yml")
+    end
+
+    def settings
+      @settings ||= OpenStruct.new(@yaml["settings"])
+    end
+
+    def data
+      @data ||= OpenStruct.new(@yaml["data"])
+    end
+
+    # Hacky way to avoid having to define a method for each of the config properties.
+    # Here just for fun and to make it easier to play around with the code.
+    # This causes undesireable downstream effects, i.e. calling `respond_to?(:anything)`
+    # would return true, which it's fine in this codebase/project
+    def method_missing(method, *args, &block)
+      settings.public_send(method) || data.public_send(method) || super
+    end
+
+    def respond_to_missing?(method_name, *args)
+      true
+    end
+  end
+end

data/lib/invoice_creator/models/invoice.rb

@@ -0,0 +1,34 @@
+require "date"
+
+module InvoiceCreator
+  module Models
+    class Invoice
+      attr_reader :expenses_amount,
+        :billable_hours,
+        :invoice_date,
+        :rate,
+        :number
+
+      def initialize(rate:, due_day:, billable_hours:, expenses_amount: 0.0, invoice_date: Date.today, number: 1)
+        @rate = rate
+        @billable_hours = billable_hours
+        @expenses_amount = expenses_amount
+        @invoice_date = invoice_date
+        @due_day = due_day
+        @number = number
+      end
+
+      def due_date
+        Date.new(@invoice_date.year, @invoice_date.month, @due_day)
+      end
+
+      def total
+        billable_amount + @expenses_amount
+      end
+
+      def billable_amount
+        @billable_hours * @rate
+      end
+    end
+  end
+end

data/lib/invoice_creator/presenters/invoice.rb

@@ -0,0 +1,62 @@
+require "forwardable"
+
+module InvoiceCreator
+  module Presenters
+    class Invoice
+      extend Forwardable
+
+      def initialize(invoice:, config:)
+        @invoice = invoice
+        @config = config
+      end
+
+      def filename
+        @invoice.invoice_date.strftime(@config.filename)
+      end
+
+      def due_date
+        @invoice.due_date.strftime(@config.date_format)
+      end
+
+      def date
+        @invoice.invoice_date.strftime(@config.date_format)
+      end
+
+      def billable_amount
+        amount(@invoice.billable_amount)
+      end
+
+      def rate
+        amount(@invoice.rate)
+      end
+
+      def invoice_identifier
+        sprintf(@config.invoice_identifier, @invoice.number)
+      end
+
+      def expenses_amount
+        amount(@invoice.expenses_amount)
+      end
+
+      def has_expenses?
+        @invoice.expenses_amount > 0
+      end
+
+      def total
+        amount(@invoice.total)
+      end
+
+      def_delegators :@invoice, :billable_hours
+      def_delegators :@config, :to
+      def_delegators :@config, :from
+      def_delegators :@config, :extra_info
+      def_delegators :@config, :currency_abbreviation
+
+      private
+
+      def amount(amount)
+        sprintf(@config.currency_format, amount)
+      end
+    end
+  end
+end

data/lib/invoice_creator/services/invoice_printer.rb

@@ -0,0 +1,67 @@
+require "prawn"
+require "prawn/table"
+
+module InvoiceCreator
+  module Services
+    class InvoicePrinter
+      def initialize(presenter:)
+        @presenter = presenter
+        @prawn = Prawn::Document.new
+      end
+
+      def print
+        @prawn.define_grid(:columns => 5, :rows => 8, :gutter => 10)
+
+        @prawn.grid([0,3], [0,4]).bounding_box do
+          @prawn.text "<b>INVOICE</b>", size: 30, align: :right, inline_format: true
+        end
+
+        @prawn.grid([1,3], [1,4]).bounding_box do
+          @prawn.text "<b>Invoice#</b> #{@presenter.invoice_identifier}", align: :right, inline_format: true
+          @prawn.move_down 5
+          @prawn.text "<b>Invoice Date</b> #{@presenter.date}", align: :right, inline_format: true
+          @prawn.move_down 5
+          @prawn.text "<b>Due Date</b> #{@presenter.due_date}", align: :right, inline_format: true
+        end
+
+        @prawn.grid([0,0], [0,2]).bounding_box do
+          @prawn.text "<b>From</b>", align: :left, inline_format: true
+          @prawn.text @presenter.from
+        end
+
+        @prawn.grid([1,0], [1,2]).bounding_box do
+          @prawn.text "<b>To</b>", align: :left, inline_format: true
+          @prawn.text @presenter.to
+        end
+
+        @prawn.table([%w[Item HRS/QTY Rate Amount], *rows], row_colors: ["F0F0F0", "FFFFFF"], width: 550)
+
+        @prawn.move_down 20
+        @prawn.text "<b>Total (#{@presenter.currency_abbreviation}) #{@presenter.total}</b>", align: :right, inline_format: true
+        @prawn.move_down 20
+        @prawn.stroke_horizontal_rule
+        @prawn.move_down 20
+
+        @prawn.text @presenter.extra_info, inline_format: true
+
+        @prawn.render_file @presenter.filename
+      end
+
+      private
+
+      def rows
+        rows = []
+
+        rows << Array(
+          ["Software Development", @presenter.billable_hours, @presenter.rate, @presenter.billable_amount]
+        )
+
+        if @presenter.has_expenses?
+          rows << Array(["Expenses", 1, @presenter.expenses_amount, @presenter.expenses_amount])
+        end
+
+        rows
+      end
+    end
+  end
+end

data/lib/invoice_creator/version.rb

@@ -0,0 +1,3 @@
+module InvoiceCreator
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: invoice_creator
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nicholas Pufal
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- github@npufal.com
+executables:
+- console
+- invoice_creator
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/invoice_creator
+- bin/setup
+- config.yml
+- invoice_creator.gemspec
+- lib/invoice_creator.rb
+- lib/invoice_creator/cli.rb
+- lib/invoice_creator/config_reader.rb
+- lib/invoice_creator/models/invoice.rb
+- lib/invoice_creator/presenters/invoice.rb
+- lib/invoice_creator/services/invoice_printer.rb
+- lib/invoice_creator/version.rb
+homepage: https://github.com/nicholaspufal/invoice_creator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nicholaspufal/invoice_creator
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A simple invoice creation tool to help you bill your tech clients.
+test_files: []