postino 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9588e87c9cb359ec02b8fd9f6a9549a1c8b4cc86
-  data.tar.gz: 73bd081ec9df15a88d643f9e63d9df9d64afaf76
+  metadata.gz: 980470702b3fe95393d856bec98897a6d71a1d9f
+  data.tar.gz: 056a7e3d03ccc351acd64db10c68ff7a1bc67171
 SHA512:
-  metadata.gz: b14318f8ce294332acfe76abf0f9dba5010567a7aedefa651076ec00b3bf79a36316f86c687a303ee37f53b3e0b77804d9d7d6d5178e90ee563eadb8bcee7114
-  data.tar.gz: bbc992f899f2c55d4439edf3c10d71f5c6b2fc2dde2af12c558cb870561db853ad5cc7d3ae539ddb7410f569c301f8c7bcb9a8c2f4df6e1d153825a56bccc39c
+  metadata.gz: 0ad90cf4adbc4b6d1031aec928e072196c6d8ceb56d57b7edafcacf77180abe05c0b1c82537ec76f42104dd5391308064832f2b0522387532a90e6e92065addc
+  data.tar.gz: 4b8c9fb232d0ccf623647d9fffb340f3d83bf9e4fa5a2c4f3c38fb4da2dcbe2c0b7de15dad527c07dfa075ba6577e7e153fb84e9482be6c08de33a44eceff514

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/**/*.pdf

data/README.md

@@ -1,4 +1,4 @@
-# Postino [![Build Status](https://travis-ci.org/alessandro1997/postino.png?branch=master)](https://travis-ci.org/alessandro1997/postino) [![Dependency Status](https://gemnasium.com/alessandro1997/postino.png)](https://gemnasium.com/alessandro1997/postino)
+# Postino [![Gem Version](https://badge.fury.io/rb/postino.png)](http://badge.fury.io/rb/postino) [![Build Status](https://travis-ci.org/alessandro1997/postino.png?branch=master)](https://travis-ci.org/alessandro1997/postino) [![Dependency Status](https://gemnasium.com/alessandro1997/postino.png)](https://gemnasium.com/alessandro1997/postino) [![Code Climate](https://codeclimate.com/github/alessandro1997/postino.png)](https://codeclimate.com/github/alessandro1997/postino)
 
 [Postino](https://github.com/alessandro1997/postino) is a Ruby gem that allows to quickly generate Italian postal
 payment forms in PDF format using [Prawn](https://github.com/prawnpdf/prawn).
@@ -20,20 +20,21 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-Postino::Generator.generate_form('form.pdf', {
-  account_number: '0123456789',
-  numeric_amount: 11111,
-  text_amount: 'UNDICI MILIONI CENTOUNDICIMILA/00',
-  company_name: 'ACME SRL',
-  reason: 'LOREM IPSUM DOLOR SIT AMET, ADIPISCING CONSECTETUR ELIT',
-  payer_name: 'MARIO ROSSI',
-  address: {
-    street: 'VIA FASULLA, 123',
-    zip_code: '00100',
-    city: 'ROMA',
-    state: 'RM'
-  }
-})
+Postino::Form.new do |f|
+  f.account_number = '0123456789'
+  f.numeric_amount = 11111
+  f.text_amount = 'UNDICIMILACENTOUNDICI/00'
+  f.company_name = 'ACME SRL'
+  f.reason = 'LOREM IPSUM DOLOR SIT AMET, ADIPISCING CONSECTETUR ELIT'
+  f.payer_name = 'MARIO ROSSI'
+
+  f.address.configure do |a|
+    a.street = 'VIA FASULLA, 123'
+    a.zip_code = '00100'
+    a.city = 'ROMA'
+    a.state = 'RM'
+  end
+end.generate('my_form.pdf')
 ```
 
 ## Contributing

data/lib/postino.rb

@@ -1,5 +1,7 @@
 require "postino/version"
 require "postino/generator"
+require "postino/form"
+require "postino/form/address"
 
 module Postino
 end

data/lib/postino/form.rb

@@ -0,0 +1,24 @@
+require 'docile'
+
+module Postino
+  class Form
+    attr_accessor :account_number, :text_amount, :numeric_amount, :payee_name,
+                  :payer_name, :reason
+
+    attr_reader :address
+
+    def initialize(&block)
+      @address = Address.new
+      configure(&block) if block_given?
+    end
+
+    def configure(&block)
+      Docile.dsl_eval(self, self, &block)
+      self
+    end
+
+    def generate(path)
+      Postino::Generator.generate_form(path, self)
+    end
+  end
+end

data/lib/postino/form/address.rb

@@ -0,0 +1,22 @@
+require 'docile'
+
+module Postino
+  class Form
+    class Address
+      attr_accessor :street, :zip_code, :city, :state
+
+      def initialize(&block)
+        configure(&block) if block_given?
+      end
+
+      def configure(&block)
+        Docile.dsl_eval(self, self, &block)
+        self
+      end
+
+      def location
+        "#{city} (#{state})"
+      end
+    end
+  end
+end

data/lib/postino/generator.rb

@@ -9,73 +9,113 @@ module Postino
       TEXT_AMOUNT_COORDINATES = [[515, 243], [87, 243]]
       REASON_COORDINATES = [[32, 180], [400, 180]]
       PAYER_NAME_COORDINATES = [[32, 138], [541, 143]]
+      COMPANY_NAME_COORDINATES = [[32, 220], [397, 220]]
+      ADDRESS_STREET_COORDINATES = [[60, 107], [540, 105]]
+      ADDRESS_ZIP_CODE_COORDINATES = [[60, 92], [540, 80]]
+      ADDRESS_LOCATION_COORDINATES = [[60, 77], [615, 80]]
+
+      # Generates a new postal payment form.
+      #
+      # @param path [String]        The target path
+      # @param form [Postino::Form] The form model
+      def generate_form(path, form)
+        Prawn::Document.generate(path, template: TEMPLATE_PATH, margin: 0) do |pdf|
+          pdf.font 'Courier'
+          pdf.font_size 11
+
+          add_account_number(pdf, form)
+          add_text_amount(pdf, form)
+          add_numeric_amount(pdf, form)
+          add_payee_name(pdf, form)
+          add_reason(pdf, form)
+          add_payer_name(pdf, form)
+          add_address(pdf, form)
+        end
+      end
 
-      def generate_form(path, options = {})
-        options = normalize_options(options)
-        options[:address] = normalize_options(options[:address])
-
-        Prawn::Document.generate(path, template: TEMPLATE_PATH, skip_page_creation: true, margin: 0) do
-          font 'Courier'
-          font_size 11
+      protected
 
+        def add_account_number(pdf, form)
           ACCOUNT_NUMBER_COORDINATES.each do |coordinates|
-            text_box options[:account_number], at: coordinates, character_spacing: 6
+            pdf.text_box form.account_number, at: coordinates, character_spacing: 6
           end
+        end
 
+        def add_text_amount(pdf, form)
           TEXT_AMOUNT_COORDINATES.each do |coordinates|
-            text_box options[:text_amount], at: coordinates
+            pdf.text_box form.text_amount, at: coordinates
           end
+        end
 
-          numeric_amount = ('%.2f' % options[:numeric_amount]).gsub('.', '')
+        def add_numeric_amount(pdf, form)
+          numeric_amount = ('%.2f' % form.numeric_amount).gsub('.', '')
           numeric_amount_y = 363 - 13 * numeric_amount.length
 
-          [
-            [numeric_amount_y, 257],
-            [numeric_amount_y + 473, 257]
-          ].each do |coordinates|
-            text_box numeric_amount, at: coordinates, character_spacing: 6
+          [[numeric_amount_y, 257], [numeric_amount_y + 473, 257]].each do |coordinates|
+            pdf.text_box numeric_amount, at: coordinates, character_spacing: 6
           end
+        end
 
-          text_box options[:company_name], at: [32, 220]
-          text_box options[:company_name], at: [397, 220], character_spacing: 6
+        def add_payee_name(pdf, form)
+          pdf.text_box form.payee_name, at: COMPANY_NAME_COORDINATES[0], width: 300
+          pdf.text_box form.payee_name, at: COMPANY_NAME_COORDINATES[1], character_spacing: 6
+        end
 
-          bounding_box(REASON_COORDINATES[0], width: 300, height: 100) do
-            text_box options[:reason]
+        def add_reason(pdf, form)
+          pdf.bounding_box(REASON_COORDINATES[0], width: 300, height: 100) do
+            pdf.text_box form.reason
           end
 
-          bounding_box(REASON_COORDINATES[1], width: 400, height: 100) do
-            text_box options[:reason]
+          pdf.bounding_box(REASON_COORDINATES[1], width: 400, height: 100) do
+            pdf.text_box form.reason
           end
+        end
 
-          bounding_box(PAYER_NAME_COORDINATES[0], width: 180, height: 100) do
-            text_box options[:payer_name]
+        def add_payer_name(pdf, form)
+          pdf.bounding_box(PAYER_NAME_COORDINATES[0], width: 180, height: 100) do
+            pdf.text_box form.payer_name
           end
 
-          bounding_box(PAYER_NAME_COORDINATES[1], width: 300, height: 100) do
-            text_box options[:payer_name], character_spacing: 6
+          pdf.bounding_box(PAYER_NAME_COORDINATES[1], width: 300, height: 100) do
+            pdf.text_box form.payer_name, character_spacing: 5.7, height: 100, overflow: :truncate
           end
-
-          text_box options[:address][:street], at: [60, 107], width: 130, height: 10, size: 9, overflow: :truncate
-          text_box options[:address][:street], at: [540, 105], width: 300, height: 10, character_spacing: 6, overflow: :truncate
-
-          text_box options[:address][:zip_code], at: [60, 92], size: 9
-          text_box options[:address][:zip_code], at: [540, 80], character_spacing: 6
-
-          location = "#{options[:address][:city]} (#{options[:address][:state]})"
-
-          text_box location, at: [60, 77], width: 200, height: 10, size: 9, overflow: :truncate
-          text_box location, at: [615, 80], width: 200, height: 10, character_spacing: 6, overflow: :truncate
         end
-      end
-
-      private
-
-        def normalize_options(options)
-          options.each do |key, value|
-            value.upcase! if value.is_a?(String)
-          end
 
-          options
+        def add_address(pdf, form)
+          pdf.text_box(form.address.street,
+            at:       ADDRESS_STREET_COORDINATES[0],
+            width:    130,
+            height:   10,
+            size:     9,
+            overflow: :truncate
+          )
+
+          pdf.text_box(form.address.street,
+            at:                ADDRESS_STREET_COORDINATES[1],
+            width:             300,
+            height:            10,
+            character_spacing: 6,
+            overflow:          :truncate
+          )
+
+          pdf.text_box form.address.zip_code, at: ADDRESS_ZIP_CODE_COORDINATES[0], size: 9
+          pdf.text_box form.address.zip_code, at: ADDRESS_ZIP_CODE_COORDINATES[1], character_spacing: 6
+
+          pdf.text_box(form.address.location,
+            at:       ADDRESS_LOCATION_COORDINATES[0],
+            width:    200,
+            height:   10,
+            size:     9,
+            overflow: :truncate
+          )
+
+          pdf.text_box(form.address.location,
+            at:                ADDRESS_LOCATION_COORDINATES[1],
+            width:             200,
+            height:            10,
+            character_spacing: 6,
+            overflow:          :truncate
+          )
         end
     end
   end

data/lib/postino/version.rb

@@ -1,3 +1,3 @@
 module Postino
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/postino.gemspec

@@ -19,9 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "prawn", '< 0.14'
+  spec.add_runtime_dependency "docile", '~> 1.1'
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", '~> 10.1'
   spec.add_development_dependency "rspec", '~> 2.14'
   spec.add_development_dependency "fuubar", '~> 1.3'
+  spec.add_development_dependency "mocha", '~> 1.0'
 end

data/spec/postino/address_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Postino::Form::Address do
+  subject { Postino::Form::Address.new }
+
+  describe '#configure' do
+    it 'takes a block for configuration' do
+      subject.configure do |a|
+        a.zip_code = '00100'
+      end.zip_code.should == '00100'
+    end
+  end
+
+  describe '#location' do
+    before do
+      subject.city = 'Roma'
+      subject.state = 'RM'
+    end
+
+    it 'returns the city and state' do
+      subject.location.should == 'Roma (RM)'
+    end
+  end
+end

data/spec/postino/form_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Postino::Form do
+  subject { Postino::Form.new }
+
+  describe '#configure' do
+    it 'takes a block for configuration' do
+      subject.configure do |f|
+        f.account_number = 'test'
+      end.account_number.should == 'test'
+    end
+  end
+
+  describe '#generate' do
+    it 'generates the PDF form' do
+      Postino::Generator.expects(:generate_form).once
+      subject.generate('test.pdf')
+    end
+  end
+end

data/spec/postino/generator_spec.rb

@@ -2,22 +2,30 @@ require 'spec_helper'
 
 describe Postino::Generator do
   describe '.generate_form' do
+    let(:form) do
+      Postino::Form.new do |f|
+        f.account_number = '1234567890'
+        f.numeric_amount = 11111
+        f.text_amount    = 'UNDICIMILACENTOUNDICI/00'
+        f.payee_name     = 'LOREM IPSUM DOLOR SIT AMET, ADIPISCING CONSECTETUR ELIT CORP.'
+        f.reason         = 'LOREM IPSUM DOLOR SIT AMET, ADIPISCING CONSECTETUR ELIT.'
+        f.payer_name     = 'MARIO ROSSI DI MONTEBIANCO'
+
+        f.address.configure do |a|
+          a.street   = 'VIA FASULLA, 123'
+          a.zip_code = '00100'
+          a.city     = 'ROMA'
+          a.state    = 'RM'
+        end
+      end
+    end
+
     it 'generates the form' do
       expect {
-        Postino::Generator.generate_form(File.expand_path('../form.pdf', __FILE__), {
-          account_number: '0123456789',
-          numeric_amount: 11111,
-          text_amount: 'UNDICI MILIONI CENTOUNDICIMILA/00',
-          company_name: 'ACME SRL',
-          reason: 'LOREM IPSUM DOLOR SIT AMET, ADIPISCING CONSECTETUR ELIT',
-          payer_name: 'MARIO ROSSI',
-          address: {
-            street: 'VIA FASULLA, 123',
-            zip_code: '00100',
-            city: 'ROMA',
-            state: 'RM'
-          }
-        })
+        Postino::Generator.generate_form(
+          File.expand_path('../form.pdf', __FILE__),
+          form
+        )
       }.not_to raise_error
     end
   end

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ 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.mock_with :mocha
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postino
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Alessandro Desantis
@@ -24,6 +24,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: docile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Postino is a gem that allows to generate Italian postal payment forms
   in PDF format using Prawn.
 email:
@@ -97,10 +125,13 @@ files:
 - Rakefile
 - assets/form.pdf
 - lib/postino.rb
+- lib/postino/form.rb
+- lib/postino/form/address.rb
 - lib/postino/generator.rb
 - lib/postino/version.rb
 - postino.gemspec
-- spec/postino/form.pdf
+- spec/postino/address_spec.rb
+- spec/postino/form_spec.rb
 - spec/postino/generator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/alessandro1997/postino
@@ -128,6 +159,7 @@ signing_key:
 specification_version: 4
 summary: A gem to generate Italian postal payment forms.
 test_files:
-- spec/postino/form.pdf
+- spec/postino/address_spec.rb
+- spec/postino/form_spec.rb
 - spec/postino/generator_spec.rb
 - spec/spec_helper.rb