bollettino 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcb4a547cf48a198870007c60f5f9ce9053745d8
-  data.tar.gz: 460f4967b8cb0f276591dabe5056bc7a22fdd3ba
+  metadata.gz: a0b223ed26fc417da43231d1b0b00401f5e7678d
+  data.tar.gz: ae5d7419f111d646bfdf29ecb247937daf7b249b
 SHA512:
-  metadata.gz: 2cfdc508fae66d3757bf95ca6da9e6f93c8723ae4b143d0274d22ad3933266f6ae5a5f5f776fe50f4a0a89bea050e35467ddf4773ad615deba6f33b715070502
-  data.tar.gz: a47e95ddaddb0508e5f01a20b7a37e3a8c36eba9605b106b196ce6390148e2ccb76ae9b3910759b9b1ce0d0c1a4b3e97d18ecb0834eb4b3297cefec5a0d34cfb
+  metadata.gz: 6df33c335ebcb630c902b4a3430ee085c757995cd3627bd31d345a5eb493b3d0f2ad090402f2fc4cd359c8055ab6fd931bc815c1ce35830d379c9f5231df5533
+  data.tar.gz: a7a3825d317e1599ec4262554eef27aa4f7b08b22c8e5db5a1405b52c474b6e37d9751f330e97b62193ec03194b942090142109871fcf9a430a0948d701155dd

data/.gitignore

@@ -13,4 +13,3 @@
 *.o
 *.a
 mkmf.log
-*.gem

data/CHANGELOG.md

@@ -1,6 +1,3 @@
-Changelog
-=========
-
-0.1.0
------
+0.1.0 (November 23rd, 2014)
+===========================
 - First working version

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Alessandro Desantis
+Copyright (c) 2014 InterConn
 
 MIT License
 

data/README.md

@@ -1,5 +1,6 @@
 # Bollettino
 
+[![Gem Version](https://badge.fury.io/rb/bollettino.svg)](http://badge.fury.io/rb/bollettino)
 [![Build Status](https://travis-ci.org/interconn-isp/bollettino.svg?branch=master)](https://travis-ci.org/interconn-isp/bollettino)
 [![Dependency Status](https://gemnasium.com/interconn-isp/bollettino.svg)](https://gemnasium.com/interconn-isp/bollettino)
 [![Code Climate](https://codeclimate.com/github/interconn-isp/bollettino/badges/gpa.svg)](https://codeclimate.com/github/interconn-isp/bollettino)
@@ -75,3 +76,18 @@ generator.generate!(slip, 'slip.png')
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Related projects
+
+- For a command line interface, see [bollettino-cli](https://github.com/interconn-isp/bollettino-cli).
+- For converting numbers into words, see [Abaco](https://github.com/interconn-isp/abaco).
+
+## Maintainers
+
+Bollettino is developed and maintained by [Alessandro Desantis](https://github.com/alessandro1997).
+
+## License
+
+Bollettino is released under the MIT license.
+
+[![InterConn](http://www.gravatar.com/avatar/b3f5893b97323096977545477e0066c5.jpg?s=100)](http://www.interconn.it)

data/lib/bollettino/generator.rb

@@ -1,10 +1,22 @@
+# Generator
+#
+# Generates an image from a slip.
+#
+# @author Alessandro Desantis <desa.alessandro@gmail.com>
 class Bollettino::Generator
   attr_reader :options
 
+  # Initializes the generator.
+  #
+  # @param options [Hash]
   def initialize(options = {})
     @options = options
   end
 
+  # Generates the given slip.
+  #
+  # @param slip [Bollettino::Slip]
+  # @param path [String]
   def generate!(slip, path)
     image = MiniMagick::Image.open(File.expand_path('../../../assets/slip.png', __FILE__))
     Bollettino::Renderer::SlipRenderer.render(image, slip)

data/lib/bollettino/models/address.rb

@@ -1,7 +1,18 @@
+# Address
+#
+# @author Alessandro Desatnis <desa.alessandro@gmail.com>
 class Bollettino::Address
   include Virtus.model
 
+  # !@attribute [rw] street
+  #   @return [String] the address street
   attribute :street, String
+
+  # !@attribute [rw] zip
+  #   @return [String] the address ZIP
   attribute :zip, String
+
+  # !@attribute [rw] location
+  #   @return [String] the address location (city, state etc.)
   attribute :location, String
 end

data/lib/bollettino/models/payee.rb

@@ -1,6 +1,17 @@
+# Payee
+#
+# The payee is the party requesting payment. A payee is associated with a
+# postal account.
+#
+# @author Alessandro Desatnis <desa.alessandro@gmail.com>
 class Bollettino::Payee
   include Virtus.model
 
+  # !@attribute [rw] account_number
+  #   @return [String] the postal account's number
   attribute :account_number, String
+
+  # !@attribute [rw] name
+  #   @return [String] the account holder's name
   attribute :name, String
 end

data/lib/bollettino/models/payer.rb

@@ -1,6 +1,16 @@
+# Payer
+#
+# The payer is the party making the payment.
+#
+# @author Alessandro Desatnis <desa.alessandro@gmail.com>
 class Bollettino::Payer
   include Virtus.model
 
+  # !@attribute [rw] name
+  #   @return [String] the payer's full name
   attribute :name, String
+
+  # !@attribute [rw] address
+  #   @return [Bollettino::Address] the payer's address
   attribute :address, Bollettino::Address
 end

data/lib/bollettino/models/payment_order.rb

@@ -1,9 +1,20 @@
-require 'virtus'
-
+# Payment order
+#
+# A payment order is a request for payment from the payee to the payer.
+#
+# @author Alessandro Desatnis <desa.alessandro@gmail.com>
 class Bollettino::PaymentOrder
   include Virtus.model
 
+  # !@attribute [rw] numeric amount
+  #   @return [Float] the payment's amount
   attribute :numeric_amount, Float
+
+  # !@attribute [rw] text amount
+  #   @return [String] the payment's amount in letters
   attribute :text_amount, String
+
+  # !@attribute [rw] reason
+  #   @return [String] the reason for the payment
   attribute :reason, String
 end

data/lib/bollettino/models/slip.rb

@@ -1,7 +1,21 @@
+# Slip
+#
+# A slip is just the composition of a Payee, a Payer and a PaymentOrder. It is
+# passed to {#Bollettino::Generator} to create the final image.
+#
+# @author Alessandro Desatnis <desa.alessandro@gmail.com>
 class Bollettino::Slip
   include Virtus.model
 
+  # !@attribute [rw] payee
+  #   @return [Bollettino::Payee] the payee
   attribute :payee, Bollettino::Payee
+
+  # !@attribute [rw] payer
+  #   @return [Bollettino::Payer] the payer
   attribute :payer, Bollettino::Payer
+
+  # !@attribute [rw] payment order
+  #   @return [Bollettino::PaymentOrder] the payment order
   attribute :payment_order, Bollettino::PaymentOrder
 end

data/lib/bollettino/renderer.rb

@@ -1,3 +1,8 @@
+# Base rebder
+#
+# @abstract Subclass and override {.render} to create a renderer
+#
+# @author Alessandro Desantis <desa.alessandro@gmail.com>
 class Bollettino::Renderer
   KERNING_NORMAL = 1
 
@@ -8,6 +13,16 @@ class Bollettino::Renderer
   FONT_SIZE_NORMAL = 30
   FONT_SIZE_SMALL = 25
 
+  # Renders the given model on the image.
+  #
+  # @param image [MiniMagick::Image]
+  # @param model
+  #
+  # @abstract This method must be overridden by the renderers
+  def self.render(image, model)
+    raise NotImplementedError
+  end
+
   protected
 
   def self.write_text(image, coords, text, kerning = KERNING_NORMAL, font_size = FONT_SIZE_NORMAL)
@@ -21,6 +36,12 @@ class Bollettino::Renderer
     end
   end
 
+  # Rendering error
+  #
+  # This error is usually raised when some data can't be renderered because
+  # it's malformed.
+  #
+  # @author Alessandro Desantis <desa.alessandro@gmail.com>
   class RenderingError < StandardError
   end
 end

data/lib/bollettino/renderers/payer_renderer.rb

@@ -11,7 +11,7 @@ class Bollettino::Renderer::PayerRenderer < Bollettino::Renderer
     write_text(image, [85, 315], payer.name[25..49])
 
     write_text(image, [1508, 375], payer.name[0..22], KERNING_BOX_SMALLEST)
-    write_text(image, [1508, 330], payer.name[22..44], KERNING_BOX_SMALLEST)
+    write_text(image, [1508, 330], payer.name[23..45], KERNING_BOX_SMALLEST)
   end
 
   def self.render_address(image, payer)

data/lib/bollettino/version.rb

@@ -1,3 +1,3 @@
 module Bollettino
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bollettino
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-23 00:00:00.000000000 Z
+date: 2014-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler