clinvoice 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35661ec618db20cd56909ccdfdb1a99275d7b6a213556c07a6183999c3d295d1
-  data.tar.gz: 0aeddf3853cab0467be7170a5d42c9a506f498e7746f410afcac9b914c306d3d
+  metadata.gz: 91cafc96e465f58bae419d2fa0c98afd7deb9c87fefbd1fd012503f95da54a3e
+  data.tar.gz: 3896731fa5455499b5a244f255a4783cb1a9188d9598712cae1b2af830d7bbde
 SHA512:
-  metadata.gz: ea545374247c9054ee7d7f09869888eacf0d3264eab2f983167123055d4bd38a039d74d12788eea6c902c42a40c61ab5a846bceb91df72740a3e29d362d6308d
-  data.tar.gz: ca58014e08e934f003b3260466d54f10ba9dfbc24532fdeee24042155d6945d1396e3f2c787b7da5e5a057be5dbe0a0519b28826b8a7901c9e490c97784b987d
+  metadata.gz: a2b92a43c80a24486f82e75e447090319af551ba96bd2bcf48b6d33c9ffcdd326b3e91f3ae645ef91e20d5e24ea94beb278c239de36fa5538631e4b752a645d0
+  data.tar.gz: d146ee8a6259498a254dd30212f2c7d625346deb5998d443b5e10f409e4d22960d2a02a842b12226050e0cfda63988c5063baae2400347315debc207fb7260f4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.pdf
+*.yml
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.4

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 andrewaguiar6@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in clinvoice.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andrew S Aguiar
+
+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,67 @@
+# Clinvoice
+
+Generates invoices using command line based on yaml files
+
+```shell
+clinvoice init <datafile> # starts a new template with id 1 and empty entries.
+clinvoice new <filename> # generates a pdf invoice based on a data file `yml`.
+clinvoice next <datafile> # generates the next data file `yml`.
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clinvoice'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clinvoice
+
+## Usage
+
+1 - Create a new client template:
+
+    $ clinvoice init doge-client
+
+This will create a `doge-client-1.yml` data file.
+
+2 - Edit the data file:
+
+    $ vim doge-client-1.yml
+
+3 - Now we can generate our pdf invoice based on the data file
+
+    $ clinvoice new doge-client-1
+
+This will create a `doge-client-1.pdf` file based on the data file `doge-client-1.yml`.
+
+4 - Generate a next datafile
+
+    $ clinvoice next doge-client
+
+This will create a `doge-client-2.yml` data file, based on the last data file id + 1.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/clinvoice. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Clinvoice project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/clinvoice/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/clinvoice

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'clinvoice'
+
+Clinvoice.execute(ARGV)

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'clinvoice'
+
+# 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/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/clinvoice.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'clinvoice/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'clinvoice'
+  spec.version       = Clinvoice::VERSION
+  spec.authors       = ['Andrew S Aguiar']
+  spec.email         = ['andrewaguiar6@gmail.com']
+  spec.summary       = 'Generates invoices using command line'
+  spec.description   = 'Generates invoices using command line based on yaml file'
+  spec.homepage      = 'https://github.com/andrewaguiar/clinvoice'
+  spec.license       = 'MIT'
+
+  # 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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'prawn', '~> 2.2'
+  spec.add_dependency 'prawn-table', '~> 0.2.2'
+end

data/lib/clinvoice.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'clinvoice/initialize_template'
+require 'clinvoice/generate_next_template'
+require 'clinvoice/generate_pdf'
+require 'clinvoice/version'
+
+module Clinvoice
+  def self.execute(args)
+    show_usage_and_exit! if args.empty?
+
+    command = args[0]
+    file = args[1]
+
+    case command
+    when 'init'
+      Clinvoice::InitializeTemplate.call(file)
+    when 'new'
+      Clinvoice::GeneratePDF.call(file)
+    when 'next'
+      Clinvoice::GenerateNextTemplate.call(file)
+    else
+      show_usage_and_exit!
+    end
+  end
+
+  def self.show_usage_and_exit!
+    puts <<~USAGE
+      Usage:
+
+        clinvoice init <datafile> # starts a new template with id 1 and empty entries.
+        clinvoice new <filename> # generates a pdf invoice based on a data file `yml`.
+        clinvoice next <datafile> # generates the next data file `yml`.
+
+      Args:
+
+        - datafile: the yaml template without number and extention, example 'doge' ('doge-*.yml' templates)
+        - filename: the yaml template with number but without extention, example 'doge-3' ('doge-3.yml' templates)
+
+      Examples / Flow:
+
+        1 - First lets create a new client template:
+
+          `$ clinvoice init doge-client`
+
+          This will create a `doge-client-1.yml` data file, lets edit it and generate our pdf invoice.
+
+        2 - Edit the data file:
+
+          `$ vim doge-client-1.yml`
+
+        3 - Now we can generate our pdf invoice based on the data file
+
+          `$ clinvoice new doge-client-1`
+
+          This will create a `doge-client-1.pdf` file based on the data file `doge-client-1.yml`.
+
+        4 - Generate a next datafile
+
+          `$ clinvoice next doge-client`
+
+          This will create a `doge-client-2.yml` data file, based on the last data file id + 1.
+
+    USAGE
+
+    exit
+  end
+end

data/lib/clinvoice/data.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Clinvoice
+  class Data
+    attr_reader :invoice_id, :contractor, :client, :items, :notes, :total, :file
+
+    def initialize(file)
+      @file = file
+
+      data = YAML.load_file("#{file}.yml")['data']
+
+      @invoice_id = data['id']
+      @currency = data['currency']
+      @contractor = data['contractor']
+      @client = data['client']
+      @items = data['items'].map do |item|
+        [
+          item['description'],
+          item['unit_cost'],
+          item['quantity'],
+          item['quantity'] * item['unit_cost']
+        ]
+      end
+
+      @notes = data['notes']
+      @total = @items.map(&:last).sum
+    end
+  end
+end

data/lib/clinvoice/generate_next_template.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Clinvoice
+  module GenerateNextTemplate
+    def self.call(file)
+      last_data_file = Dir["#{file}-*.yml"].max
+      template_content = File.read(last_data_file)
+
+      next_id = template_content.scan(/id: (\d*)/).first.first.to_i + 1
+
+      next_template_content = template_content.sub(/id: (\d*)/, "id: #{next_id}")
+
+      File.write("#{file}-#{next_id}.yml", next_template_content)
+    end
+  end
+end

data/lib/clinvoice/generate_pdf.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'prawn'
+require 'prawn/table'
+require 'clinvoice/data'
+require 'clinvoice/helper'
+require 'clinvoice/render_items'
+require 'clinvoice/render_name_and_address'
+require 'clinvoice/render_notes'
+require 'clinvoice/render_title'
+require 'clinvoice/render_total'
+
+module Clinvoice
+  module GeneratePDF
+    def self.call(file)
+      data = Clinvoice::Data.new(file)
+
+      Prawn::Document.generate("#{data.file}.pdf") do |pdf|
+        Prawn::Font::AFM.hide_m17n_warning = true
+
+        pdf.font 'Helvetica'
+
+        Clinvoice::RenderTitle.call(pdf)
+
+        pdf.font_size 9
+
+        Clinvoice::RenderNameAndAddress.call(pdf, 'From', data.contractor)
+        Clinvoice::RenderNameAndAddress.call(pdf, 'To', data.client)
+        Clinvoice::RenderItems.call(pdf, data.items)
+        Clinvoice::RenderTotal.call(pdf, data.total)
+        Clinvoice::RenderNotes.call(pdf, data.notes)
+      end
+    end
+  end
+end

data/lib/clinvoice/helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Clinvoice
+  module Helper
+    def self.format_currency(number)
+      format('$%.2f', number.to_f)
+    end
+  end
+end

data/lib/clinvoice/initialize_template.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Clinvoice
+  module InitializeTemplate
+    def self.call(file)
+      template_content = <<~TEMPLATE
+        data:
+          id: 1
+          currency: "USD"
+          contractor:
+            name: "You"
+            address:
+              line1: "123, Street, 451233"
+              line2: "City, State, Country"
+          client:
+            name: "Your Client"
+            address:
+              line1: "123, Street, 451233"
+              line2: "City, State, Country"
+          items:
+            -
+              description: "Example service 1"
+              quantity: 1
+              unit_cost: 1.00
+            -
+              description: "Example service 2"
+              quantity: 1
+              unit_cost: 2.00
+          notes: "footer notes optional"
+      TEMPLATE
+
+      File.write("#{file}-1.yml", template_content)
+    end
+  end
+end

data/lib/clinvoice/render_items.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Clinvoice
+  module RenderItems
+    def self.call(pdf, items)
+      pdf.move_down 20
+
+      header = ['Description', 'Unit Cost', 'Quantity', 'Line Total']
+      blank_line = [' ', ' ', ' ', ' ']
+
+      formatted_items = items.map do |item|
+        [
+          item[0],
+          Clinvoice::Helper.format_currency(item[1]),
+          item[2],
+          Clinvoice::Helper.format_currency(item[3])
+        ]
+      end
+
+      rows = [header] + formatted_items + [blank_line]
+
+      pdf.table(rows, width: pdf.bounds.width) do
+        style(row(1..-1).columns(0..-1), padding: [4, 5, 4, 5], borders: [:bottom], border_color: 'dddddd')
+        style(row(0), background_color: 'e9e9e9', border_color: 'dddddd', font_style: :bold)
+        style(row(0).columns(0..-1), borders: %i[top bottom])
+        style(row(0).columns(0), borders: %i[top left bottom])
+        style(row(0).columns(-1), borders: %i[top right bottom])
+        style(row(-1), border_width: 2)
+        style(column(2..-1), align: :right)
+        style(columns(0), width: 280)
+      end
+
+      pdf.move_down 10
+    end
+  end
+end

data/lib/clinvoice/render_name_and_address.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Clinvoice
+  module RenderNameAndAddress
+    def self.call(pdf, label, entity)
+      pdf.font 'Helvetica', style: :bold
+      pdf.text_box label, at: [8,  pdf.cursor]
+      pdf.font 'Helvetica', style: :normal
+
+      pdf.move_down 12
+      pdf.text_box entity['name'], at: [8, pdf.cursor]
+      pdf.move_down 12
+      if entity['address']
+        pdf.text_box entity['address']['line1'], at: [8, pdf.cursor]
+        pdf.move_down 12
+        pdf.text_box entity['address']['line2'], at: [8, pdf.cursor]
+        pdf.move_down 12
+      end
+
+      pdf.move_down 10
+    end
+  end
+end

data/lib/clinvoice/render_notes.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Clinvoice
+  module RenderNotes
+    def self.call(pdf, notes)
+      return unless notes
+
+      pdf.table([['Notes'], [notes]], width: 275) do
+        style(row(0..-1).columns(0..-1), padding: [1, 0, 1, 0], borders: [])
+        style(row(0).columns(0), font_style: :bold)
+      end
+    end
+  end
+end

data/lib/clinvoice/render_title.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Clinvoice
+  module RenderTitle
+    def self.call(pdf)
+      pdf.move_down 5
+
+      pdf.font 'Helvetica', style: :bold
+      pdf.font_size 20
+      pdf.text_box 'INVOICE', at: [230, pdf.cursor]
+      pdf.font 'Helvetica', style: :normal
+
+      pdf.move_down 30
+    end
+  end
+end

data/lib/clinvoice/render_total.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Clinvoice
+  module RenderTotal
+    def self.call(pdf, total)
+      invoice_services_totals_data = [
+        ['Total', Clinvoice::Helper.format_currency(total)]
+      ]
+
+      pdf.table(invoice_services_totals_data, position: 425, width: 115) do
+        style(row(0), font_style: :bold)
+        style(row(0), background_color: 'e9e9e9', border_color: 'dddddd', font_style: :bold)
+        style(row(0..1).columns(0..1), padding: [3, 5, 3, 5], borders: [])
+        style(column(1), align: :right)
+      end
+
+      pdf.move_down 25
+    end
+  end
+end

data/lib/clinvoice/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Clinvoice
+  VERSION = '1.0.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clinvoice
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew S Aguiar
@@ -69,10 +69,37 @@ dependencies:
 description: Generates invoices using command line based on yaml file
 email:
 - andrewaguiar6@gmail.com
-executables: []
+executables:
+- clinvoice
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/clinvoice
+- bin/console
+- bin/setup
+- clinvoice.gemspec
+- lib/clinvoice.rb
+- lib/clinvoice/data.rb
+- lib/clinvoice/generate_next_template.rb
+- lib/clinvoice/generate_pdf.rb
+- lib/clinvoice/helper.rb
+- lib/clinvoice/initialize_template.rb
+- lib/clinvoice/render_items.rb
+- lib/clinvoice/render_name_and_address.rb
+- lib/clinvoice/render_notes.rb
+- lib/clinvoice/render_title.rb
+- lib/clinvoice/render_total.rb
+- lib/clinvoice/version.rb
 homepage: https://github.com/andrewaguiar/clinvoice
 licenses:
 - MIT