bollettino 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a0b223ed26fc417da43231d1b0b00401f5e7678d
-  data.tar.gz: ae5d7419f111d646bfdf29ecb247937daf7b249b
+SHA256:
+  metadata.gz: abb194eae400dfa894bf8fee673189d33acec4c8f6753e9cf19e068642186537
+  data.tar.gz: 434195007bade47b2485b379764d1ed26d4dbfb262d7165231938dee5d7f8f0a
 SHA512:
-  metadata.gz: 6df33c335ebcb630c902b4a3430ee085c757995cd3627bd31d345a5eb493b3d0f2ad090402f2fc4cd359c8055ab6fd931bc815c1ce35830d379c9f5231df5533
-  data.tar.gz: a7a3825d317e1599ec4262554eef27aa4f7b08b22c8e5db5a1405b52c474b6e37d9751f330e97b62193ec03194b942090142109871fcf9a430a0948d701155dd
+  metadata.gz: e3d26f0dd542d77e88ea33bdc71ec97ebf35698b5b14bf74afb9e59bc8bfb1fa9998e800fb605da8465162e528abdfa8102c83aaafdf17f5f5e884493a7ac9ff
+  data.tar.gz: e8f942c19f8d71b2a6bf38942849731fc0e786089a110445feac372df3d3eac0aa454d94f7877a2284f08829a354dcfb731b3cf0c83c44880d6637c714d5c1c5

data/.rubocop.yml

@@ -0,0 +1,103 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+   - 'bin/*'
+   - 'db/**/*'
+   - 'vendor/bundle/**/*'
+   - 'spec/spec_helper.rb'
+   - 'spec/rails_helper.rb'
+   - 'spec/support/**/*'
+   - 'config/**/*'
+   - '**/Rakefile'
+   - '**/Gemfile'
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/requests/**/*'
+    - 'spec/integration/**/*'
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+  AllowURI: true
+
+Layout/FirstParameterIndentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive

data/.travis.yml

@@ -1,5 +1,5 @@
+sudo: false
 language: ruby
 rvm:
-  - 2.1.5
-  - 2.0.0
-  - 1.9.3
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -1,3 +1,31 @@
-0.1.0 (November 23rd, 2014)
-===========================
-- First working version
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.1]
+
+### Changed
+
+- Updated and linted codebase.
+
+## [1.0.0]
+
+First stable release.
+
+### Fixed
+
+- Fixed overlap issue with payer's name
+
+## [0.1.0]
+
+First public release.
+
+[Unreleased]: https://github.com/pragmarb/pragma/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/pragmarb/pragma/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/pragmarb/pragma/compare/v0.1.0...v1.0.0
+[0.1.0]: https://github.com/interconn-isp/bollettino/tree/v0.1.0

data/README.md

@@ -1,9 +1,9 @@
 # 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)
+[![Dependency Status](https://gemnasium.com/badges/github.com/interconn-isp/bollettino.svg)](https://gemnasium.com/github.com/interconn-isp/bollettino)
+[![Maintainability](https://api.codeclimate.com/v1/badges/27f20f87ffab300c2530/maintainability)](https://codeclimate.com/github/interconn-isp/bollettino/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/interconn-isp/bollettino/badge.svg?branch=master)](https://coveralls.io/github/interconn-isp/bollettino?branch=master)
 
 Bollettino is a tool for generating Italian postal payment slips.
 
@@ -39,27 +39,27 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-payee = Bollettino::Payee.new(
+payee = Bollettino::Model::Payee.new(
   account_number: '0123456789',
   name: 'Acme Inc.'
 )
 
-payer = Bollettino::Payer.new(
+payer = Bollettino::Model::Payer.new(
   name: 'John Doe',
-  address: Bollettino::Address.new(
+  address: Bollettino::Model::Address.new(
     street: '3681 Foggy Moor',
     zip: '19147-0834',
     location: 'Grayson'
   )
 )
 
-payment_order = Bollettino::PaymentOrder.new(
+payment_order = Bollettino::Model::PaymentOrder.new(
   numeric_amount: 54.31,
   text_amount: 'Cinquantaquattro/31',
   reason: 'Invoice INV-1391'
 )
 
-slip = Bollettino::Slip.new(
+slip = Bollettino::Model::Slip.new(
   payee: payee,
   payer: payer,
   payment_order: payment_order

data/bollettino.gemspec

@@ -1,4 +1,6 @@
-# coding: utf-8
+
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bollettino/version'
@@ -9,7 +11,6 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Alessandro Desantis']
   spec.email         = ['desa.alessandro@gmail.com']
   spec.summary       = 'Bollettino is a tool for generating Italian postal payment slips.'
-  spec.description   = 'Bollettino is a tool for generating postal payment slips in the Italian format.'
   spec.homepage      = 'https://github.com/interconn-isp/bollettino'
   spec.license       = 'MIT'
 
@@ -18,11 +19,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.3'
-  spec.add_development_dependency 'rspec', '~> 3.1'
-  spec.add_development_dependency 'mocha', '~> 1.1'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.22'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
 
+  spec.add_runtime_dependency 'mini_magick', '~> 4.8'
   spec.add_runtime_dependency 'virtus', '~> 1.0'
-  spec.add_runtime_dependency 'mini_magick', '~> 4.0'
 end

data/lib/bollettino.rb

@@ -1,21 +1,24 @@
+# frozen_string_literal: true
+
 require 'virtus'
 require 'mini_magick'
 
 require 'bollettino/version'
 
-require 'bollettino/models/address'
-require 'bollettino/models/payee'
-require 'bollettino/models/payer'
-require 'bollettino/models/payment_order'
-require 'bollettino/models/slip'
-
-require 'bollettino/renderer'
+require 'bollettino/model/base'
+require 'bollettino/model/address'
+require 'bollettino/model/payee'
+require 'bollettino/model/payer'
+require 'bollettino/model/payment_order'
+require 'bollettino/model/slip'
 
-require 'bollettino/renderers/address_renderer'
-require 'bollettino/renderers/payer_renderer'
-require 'bollettino/renderers/payee_renderer'
-require 'bollettino/renderers/payment_order_renderer'
-require 'bollettino/renderers/slip_renderer'
+require 'bollettino/renderer/base'
+require 'bollettino/renderer/errors'
+require 'bollettino/renderer/address'
+require 'bollettino/renderer/payer'
+require 'bollettino/renderer/payee'
+require 'bollettino/renderer/payment_order'
+require 'bollettino/renderer/slip'
 
 require 'bollettino/generator'
 

data/lib/bollettino/generator.rb

@@ -1,25 +1,29 @@
-# Generator
-#
-# Generates an image from a slip.
-#
-# @author Alessandro Desantis <desa.alessandro@gmail.com>
-class Bollettino::Generator
-  attr_reader :options
+# frozen_string_literal: true
 
-  # Initializes the generator.
+module Bollettino
+  # Generator
   #
-  # @param options [Hash]
-  def initialize(options = {})
-    @options = options
-  end
-
-  # Generates the given slip.
+  # Generates an image from a 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)
-    image.write path
+  # @author Alessandro Desantis <desa.alessandro@gmail.com>
+  class 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::Slip.render(image, slip)
+      image.write path
+    end
   end
 end

data/lib/bollettino/model/address.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Bollettino
+  module Model
+    # Address
+    #
+    # @author Alessandro Desatnis <desa.alessandro@gmail.com>
+    class Address < Base
+      # !@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
+  end
+end

data/lib/bollettino/model/base.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Bollettino
+  module Model
+    class Base
+      include Virtus.model
+    end
+  end
+end

data/lib/bollettino/model/payee.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Bollettino
+  module Model
+    # Payee
+    #
+    # The payee is the party requesting payment. A payee is associated with a
+    # postal account.
+    #
+    # @author Alessandro Desatnis <desa.alessandro@gmail.com>
+    class Payee < Base
+      # !@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
+  end
+end

data/lib/bollettino/model/payer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bollettino
+  module Model
+    # Payer
+    #
+    # The payer is the party making the payment.
+    #
+    # @author Alessandro Desatnis <desa.alessandro@gmail.com>
+    class Payer < Base
+      # !@attribute [rw] name
+      #   @return [String] the payer's full name
+      attribute :name, String
+
+      # !@attribute [rw] address
+      #   @return [Address] the payer's address
+      attribute :address, Address
+    end
+  end
+end

data/lib/bollettino/model/payment_order.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Bollettino
+  module Model
+    # Payment order
+    #
+    # A payment order is a request for payment from the payee to the payer.
+    #
+    # @author Alessandro Desatnis <desa.alessandro@gmail.com>
+    class PaymentOrder < Base
+      # !@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
+  end
+end

data/lib/bollettino/model/slip.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Bollettino
+  module Model
+    # 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 Slip < Base
+      # !@attribute [rw] payee
+      #   @return [Payee] the payee
+      attribute :payee, Payee
+
+      # !@attribute [rw] payer
+      #   @return [Payer] the payer
+      attribute :payer, Payer
+
+      # !@attribute [rw] payment order
+      #   @return [PaymentOrder] the payment order
+      attribute :payment_order, PaymentOrder
+    end
+  end
+end