alego_pdf 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: af1c4d29195fc9f0cc0648b710923a8e63bf63c6e7d48feaf9373bf76ae7c536
-  data.tar.gz: f67c101c414c719d10c695504ca4454d1e3c41924304c3c4b30d6dd96d184bde
+SHA1:
+  metadata.gz: c18e67ee692d9a16b56d8a3d9cfde913dd5c344c
+  data.tar.gz: a769b0fd00f864c4f924c4242752ab28a62a02e9
 SHA512:
-  metadata.gz: 998a826b0368b40fa1a1d43964f241dc2229d8423096a73f25d930b9ae49cfaa4ab15369dcd28da21dc2d4f7599500c84b0572d1654549f3d752121c288af071
-  data.tar.gz: 40f26d1de7c0cbd1b0b07df2b7136a4d9defa0405017960de99d007b35a2f39b9d300f38d62e0b75577a5bf192024c24256f8f43e375dd47f2222b60af95adc2
+  metadata.gz: 1911376a281719e8830569f0d890ebc2e6c21bb1cae6019d4cdaac44feabe02af644adbed26d3b61633c8ab3a7592d2bd81665e3c7c069b05c3cb096539c2e30
+  data.tar.gz: 0c9007c161e74d0ab7d362fd8b8dbc46a1a52578f92e8fc5ad188e7d47f71f0c29e8e4fdd5bd755c491bf0ebded17ed17bbc708b9bd58a5569f8c1614f03af45

data/README.md

@@ -26,49 +26,79 @@ Ou instale isto você mesmo usando o comando:
 ## Uso
 A gem 'alego_pdf' depende da gem 'hexapdf' para fazer a juntada de arquivos.
 Veja mais sobre a gem 'hexapdf' no Github: https://github.com/gettalong/hexapdf
-A gem 'alego_pdf' faz a leitura dos arquivos via URI e Tempfile e a gem 'hexapdf' junta-os. Veja o exemplo na gem alego_pdf:
-
+A gem 'alego_pdf' busca os objeto faz a leitura dos arquivos via URI e Tempfile e a gem 'hexapdf' junta-os. Veja o exemplo na gem alego_pdf:
 ```
-    def call
-        target = HexaPDF::Document.new
-
-        # filepaths é um array com as url's dos arquivos
-        filepaths.each do |filepath|
-            uri = URI.parse(filepath).open(&:read) # leitura do arquivo
-            tempfile = Tempfile.new
-            tempfile.write(uri.force_encoding('UTF-8')) # escrita no arquivo Tempfile
-            tempfile.close # fecha o arquivo
-
-            pdf = HexaPDF::Document.open(tempfile)
-            pdf.pages.each { |page| target.pages << target.import(page) } # junta os arquivos em um novo HexaPDF
+require 'hexapdf'
+require 'open-uri'
+
+module AlegoPdf
+    class Merging
+        attr_reader :ids, :model, :attribute, :filename
+
+        def initialize(ids, model, attribute, filename = 'tmp/merge_files.pdf')
+            @ids = ids
+            @model = model
+            @attribute = attribute
+            @filename = filename
         end
 
-        target.write(filename, optimize: true)
-    end
-```
+        def call
+            array = model.is_a?(String) ? model.camelize.constantize.where(id: ids) : model.where(id: ids)
+            target = HexaPDF::Document.new
+
+            array.each do |objeto|
+                file = objeto[attribute]
+                filepath = file.try(:url) || objeto.try(:arquivo_url)
 
-Após instalar a gem 'alego_pdf', deve buscar a URL dos arquivos e passar estas URL's como parâmetro. Veja o exemplo a seguir:
+                next if filepath.blank?
+
+                uri = URI.parse(filepath).open(&:read)
+                tempfile = Tempfile.new
+                tempfile.write(uri.force_encoding('UTF-8'))
+                tempfile.close
+
+                pdf = HexaPDF::Document.open(tempfile)
+                pdf.pages.each { |page| target.pages << target.import(page) }
+            end
 
+            target.write(filename, optimize: true)
+        end
+    end
+end
 ```
+Obs.: Os parâmetros 'ids', 'model' e 'attribute' são obrigatórios. O parâmetro 'filename' é por default 'tmp/merge_files.pdf', porém pode-se atribuir um caminho pré-definido.
+Após instalar a gem 'alego_pdf', deve criar uma rota '/rota_merge_arquivos' e deve buscar os ids dos arquivos e passá-los como parâmetro junto com o model e o atributo que onde é guardado os metadados dos arquivos. A gem procura também por um atributo chamado 'arquivo_url', caso não encontre a 'url' (ex.: attribute.try(:url)) Veja o exemplo a seguir:
+```
+    # organogramas_controller.rb
     def merge_arquivos
-        # O atributo "arquivo_url" deve ser a url onde o arquivo está armazenado.
-        # Exemplo: https://spiderminio-dev.al.go.leg.br:9000/portal-rails/uploads/transparencia/organograma/arquivo/1/Manual_do_stimuus_-_6_Instalando_o_esti%CC%81mulo_no_seu_aplicativo.pdf?X-Amz-Expires=600&X-Amz-Date=20220909T165125Z&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=BUjuSkJYyf0wzRmG%2F20220909%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Signature=791bbc7db8aac7bd0c61dc7a60d04ec3d39f6d63d60f9d971383c97b55e9815a
-
-        filepaths = Model.order('id desc').map(&:arquivo_url)
+        organograma_ids = ::Transparencia::Organograma.order('data desc').map(&:id)
 
         respond_to do |format|
             format.html
             format.pdf do
-                filename = 'tmp/arquivos.pdf'
-                AlegoPdf::Merging.new(filepaths, filename).call
+                filename = 'tmp/organogramas.pdf' # nome e local onde será salvo o arquivo temporário
+                AlegoPdf::Merging.new(organograma_ids, ::Transparencia::Organograma, :arquivo, filename).call
 
                 pdf_filename = File.join(Rails.root, filename)
-                send_file(pdf_filename, filename: 'merge-arquivos.pdf', type: 'application/pdf')
+                send_file(pdf_filename, filename: 'organogramas.pdf', type: 'application/pdf')
             end
         end
     end
 ```
-
+PS: caso não exista nenhum arquivo, é feito download de uma página em branco, portanto certifique-se que contenha ao menos 1 objeto com upload PDF antes fazer a chamada AlegoPdf::Merging ou apresentar o botão na view que chama a rota e faz o download dos arquivos. Veja o exemplo:
+```
+    // index.html.erb
+    <% @organograma_pdf_any = ::Transparencia::Organograma.any?(&:arquivo_url) # verifica se existe ao menos 1 url do arquivo %>
+
+    <% if @organograma_pdf_any %>
+        <a href="/organogramas/merge_arquivos.pdf" target="_blank" title="Juntar arquivos" class="bt bt--secundario">
+            Todos organogramas
+            <svg class="ico">
+            <use xlink:href="<%= asset_path('ico.svg#download') %>" />
+            </svg>
+        </a>
+    <% end %>
+```
 ## Contribuição
 
 Relatórios de bugs e pull requests são bem-vindos no GitLab em https://gitlab.al.go.leg.br/sistemas/gem/alego_pdf.

data/alego_pdf.gemspec

@@ -5,9 +5,9 @@ Gem::Specification.new do |spec|
   spec.version       = AlegoPdf::VERSION
   spec.authors       = ['Rodrigo de Sá']
   spec.email         = ['rodrigo.sa@al.go.leg.br']
-  spec.homepage      = 'https://gitlab.al.go.leg.br/gem/alego_pdf'
-  spec.summary       = 'Summary of AlegoPdf.'
-  spec.description   = 'Description of AlegoPdf.'
+  spec.homepage      = 'https://gitlab.al.go.leg.br/sistemas/gem/alego_pdf'
+  spec.summary       = "Gem responsible for joining 1 or more PDF in the same file."
+  spec.description   = "Gem responsible for joining 1 or more PDF in the same file."
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 

data/lib/alego_pdf/merging.rb

@@ -3,17 +3,25 @@ require 'open-uri'
 
 module AlegoPdf
   class Merging
-    attr_reader :filepaths, :filename
+    attr_reader :ids, :model, :attribute, :filename
 
-    def initialize(filepaths, filename)
-      @filepaths = filepaths
+    def initialize(ids, model, attribute, filename = 'tmp/merge_files.pdf')
+      @ids = ids
+      @model = model
+      @attribute = attribute
       @filename = filename
     end
 
     def call
+      array = model.is_a?(String) ? model.camelize.constantize.where(id: ids) : model.where(id: ids)
       target = HexaPDF::Document.new
 
-      filepaths.each do |filepath|
+      array.each do |object|
+        file = object[attribute]
+        filepath = file.try(:url) || object.try(:arquivo_url)
+
+        next if filepath.blank?
+
         uri = URI.parse(filepath).open(&:read)
         tempfile = Tempfile.new
         tempfile.write(uri.force_encoding('UTF-8'))

data/lib/alego_pdf/version.rb

@@ -1,3 +1,3 @@
 module AlegoPdf
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alego_pdf
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Rodrigo de Sá
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,34 +94,32 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Description of AlegoPdf.
+description: Gem responsible for joining 1 or more PDF in the same file.
 email:
 - rodrigo.sa@al.go.leg.br
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".gitlab-ci.yml"
-- ".ruby-version"
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
+- alego_pdf-1.0.0.gem
 - alego_pdf.gemspec
 - bin/console
 - bin/setup
 - lib/alego_pdf.rb
 - lib/alego_pdf/merging.rb
 - lib/alego_pdf/version.rb
-homepage: https://gitlab.al.go.leg.br/gem/alego_pdf
+homepage: https://gitlab.al.go.leg.br/sistemas/gem/alego_pdf
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.al.go.leg.br/gem/alego_pdf
-post_install_message: 
+  homepage_uri: https://gitlab.al.go.leg.br/sistemas/gem/alego_pdf
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,8 +134,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14.4
+signing_key:
 specification_version: 4
-summary: Summary of AlegoPdf.
+summary: Gem responsible for joining 1 or more PDF in the same file.
 test_files: []

data/.gitignore

@@ -1,18 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/.idea
-/log/*.log
-/test/dummy/db/*.sqlite3
-/test/dummy/db/*.sqlite3-journal
-/test/dummy/log/*.log
-/test/dummy/node_modules/
-/test/dummy/yarn-error.log
-/test/dummy/storage/
-/test/dummy/tmp/
-/vendor/*

data/.gitlab-ci.yml

@@ -1,28 +0,0 @@
-stages:
-  - build
-
-#testes:
-#  stage: test
-#  script:
-#    - echo "Executanto testes automatizados"
-#    - export RAILS_ENV="test"
-#    - rbenv install -s
-#    - if ! rbenv which bundle; then gem install bundler --no-ri --no-rdoc; rbenv rehash; fi
-#    - bundle install
-#    - rspec spec
-#  tags:
-#    - tester
-
-build:
-  stage: build
-  script:
-    - if ! rbenv shell 2.7.3; then rbenv install -s 2.7.3; rbenv rehash; fi
-    - if ! rbenv which bundle; then gem install bundler --no-ri --no-rdoc; rbenv rehash; fi
-    - bundle install
-    - rake build
-    - rake release
-#    - rake force_release
-  only:
-    - /^[0-9]{1,2}\.[0-9]{1,2}\.[0-9]{1,2}$/
-  tags:
-    - deployer

data/.ruby-version

@@ -1 +0,0 @@
-2.7.3