limarka 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e80dfd0083b8c812e3e18a87a5a7be782af7cd17
-  data.tar.gz: afdfd32814f5ae0b81ebf69c242cfb4b32bffdad
+  metadata.gz: 69320eab968ea33365d7a9a347f289130571b284
+  data.tar.gz: 9a10d6489984755eaf4ae8349a722e67ad9a6b36
 SHA512:
-  metadata.gz: dd8ba50b21f7bbab31d65f29e179989cd01d35fddbbc290ec985c67ab4d451affd9cbafe5fa2ec3b941eb99c48bc456992dc21672dddbc6cb902a2ab65bdeb96
-  data.tar.gz: 3a48ac85cbd764a260524ba2d4a194e4e838dc274ccb1d6c49b5804ee3cd6dde04a53d86e35fbb6c5cc32a6f700699d0a7a3d0998fe3985ce002e6a5f480efd2
+  metadata.gz: afae1b22f9f82fa1c01767f62bd08c13669f208e2e00002d252688795c265e6c90c4caeb13864681d72bb3e41ad23c376a4923a498e401c899d9bc8c94dfe14b
+  data.tar.gz: 3f06293cf304e34e6256c10292000027f2b9731026c82fc3d3518469d96a04d09b97900de0339ea5933bdc85e859cb8e76fec475daee1ed0ffbbb5df6b185f95

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [v0.6.5](https://github.com/abntex/limarka/tree/v0.6.5) (2017-01-16)
+[Full Changelog](https://github.com/abntex/limarka/compare/v0.6.4...v0.6.5)
+
+**Melhorias implementadas:**
+
+- Documentação da API [\#121](https://github.com/abntex/limarka/issues/121)
+
 ## [v0.6.4](https://github.com/abntex/limarka/tree/v0.6.4) (2017-01-16)
 [Full Changelog](https://github.com/abntex/limarka/compare/v0.6.3...v0.6.4)
 

data/docs/paper/codemeta.json

@@ -19,5 +19,5 @@
   "keywords": "limarka,ABNT,markdown,dissertation,thesis",
   "license": "MIT",
   "title": "limarka",
-  "version": "v0.6.4"
+  "version": "v0.6.5"
 }

data/lib/limarka/cli.rb

@@ -13,6 +13,12 @@ require 'terminal-table'
 
 module Limarka
 
+  # Essa classe é responsável por interpretar e executar os comandos de linha
+  # da ferramenta. Para compreender sua utilização recomendo consultar a
+  # documentação do [thor](http://whatisthor.com).
+  #
+  # @author Eduardo de Santana Medeiros Alexandre
+  # 
   class Cli < Thor
     include Thor::Actions
     

data/lib/limarka/configuracao.rb

@@ -8,6 +8,10 @@ require 'open3'
 
 module Limarka
 
+  # Representa os comandos de linha sobre configuracao.
+  #
+  # Invoque `limarka help configuracao` para verificar os comandos.
+  # @see Cli
   class Configuracao < Thor
 
     method_option :output_dir, :aliases => '-o', :desc => 'Diretório onde será salvo a exportação', :default => '.'

data/lib/limarka/conversor.rb

@@ -10,9 +10,13 @@ require 'bibtex'
 
 module Limarka
 
+  # Essa class é responsável por ser a abstração de converter o arquivo
+  # em Markdown para Latex.
   class Conversor
-    # trabalho
+    # o trabalho
     attr_accessor :t
+    # opções de execução
+    # @see Cli
     attr_accessor :options
     attr_accessor :pretextual_tex
     attr_accessor :postextual_tex
@@ -27,7 +31,7 @@ module Limarka
     end
 
 
-    ## Cria o arquivo 
+    ## Converte o trabalho para Latex
     def convert()
       FileUtils.mkdir_p(options[:output_dir])
 
@@ -73,6 +77,8 @@ module Limarka
 
     PRETEXTUAL = "templates/pretextual.tex"
 
+    # Escreve no arquivo o conteúdo gerado referente ao pretextual do documento.
+    # @param tempfile arquivo onde será escrito
     def pretextual(tempfile)
       s = StringIO.new
       necessita_de_arquivo_de_texto = ["errata"]
@@ -100,6 +106,8 @@ module Limarka
     end
 
     POSTEXTUAL = "templates/postextual.tex"
+    # Escreve no arquivo o conteúdo gerado referente ao pós-textual do documento.
+    # @param tempfile arquivo onde será escrito    
     def postextual(tempfile)
       # Referências (obrigatório)
       # Glossário (opcional)
@@ -137,25 +145,6 @@ module Limarka
       b.save_to referencias_bib_file
     end
     
-    def secao(template, condicao_para_conteudo, conteudo_externo)
-      s = StringIO.new
-      
-      Open3.popen3("pandoc -f markdown \"--data-dir=#{options[:templates_dir]}\" --template=#{template} --chapter -t latex") {|stdin, stdout, stderr, wait_thr|
-        stdin.write(hash_to_yaml(t.configuracao))
-        stdin.write("\n")
-        if (condicao_para_conteudo) then
-          stdin.write(conteudo_externo)
-          stdin.write("\n")
-        end
-        stdin.close
-        s << stdout.read
-        exit_status = wait_thr.value # Process::Status object returned.
-        if(exit_status!=0) then puts ("Erro: " + stderr.read).red end
-      }
-      s.string
-    end
-
-    
     def secao_referencias
       secao("postextual1-referencias", false, t.referencias)
     end
@@ -168,9 +157,11 @@ module Limarka
       secao("postextual4-anexos", t.anexos?, t.anexos)
     end
     
+    # @note Ainda não implementado
     def secao_glossario
     end
 
+    # @note Ainda não implementado
     def secao_indice
     end
     
@@ -236,6 +227,27 @@ module Limarka
 
     end
 
+    private
+    
+    # Utilizado para gerar seções específicas do documento
+    def secao(template, condicao_para_conteudo, conteudo_externo)
+      s = StringIO.new
+      
+      Open3.popen3("pandoc -f markdown \"--data-dir=#{options[:templates_dir]}\" --template=#{template} --chapter -t latex") {|stdin, stdout, stderr, wait_thr|
+        stdin.write(hash_to_yaml(t.configuracao))
+        stdin.write("\n")
+        if (condicao_para_conteudo) then
+          stdin.write(conteudo_externo)
+          stdin.write("\n")
+        end
+        stdin.close
+        s << stdout.read
+        exit_status = wait_thr.value # Process::Status object returned.
+        if(exit_status!=0) then puts ("Erro: " + stderr.read).red end
+      }
+      s.string
+    end
+
   end
 end
 

data/lib/limarka/cronograma.rb

@@ -2,7 +2,9 @@
 
 module Limarka
 
+  # Tentativa para criar um modelo de cronograma. Não é utilizado ainda.
   # Ver https://github.com/abntex/limarka/issues/90
+  # @see Cli
   class Cronograma
     attr_accessor :tabela, :legenda, :fonte, :rotulo
     

data/lib/limarka/pdfconf.rb

@@ -7,18 +7,28 @@ require 'open3'
 
 module Limarka
 
+  # Essa classe é responsável por ler os valores salvos em um formulário PDF
+  # e gerar um hash compatível com configuração de um {Trabalho}.
+  # @see Trabalho#configuracao
   class Pdfconf
 
+
+    # @return [PdfForms::Pdf]    
     attr_reader :pdf
-    
+
+    # @param pdf [PdfForms::Pdf]
     def initialize(pdf: nil)
       @pdf = pdf
     end
 
+    # Atualiza um campo do formulário. Útil para execução de testes.
     def update(field, value)
       pdf.field(field).instance_variable_set(:@value, value)
     end
 
+    # Exporta um hash que será utilizado como configuração.
+    # @return [Hash] que é utilizado como configuração
+    # @see {Trabalho#configuracao}
     def exporta(valida=true)
       h = {}
       h.merge! caixas_de_texto

data/lib/limarka/ref.rb

@@ -6,6 +6,10 @@ require 'clipboard'
 
 module Limarka
 
+  # Essa classe contem os comandos de linhas referente aos comandos de `ref`.
+  # Execute `limarka help ref` para conhecer os comandos.
+  # Ela é incluída em {Cli}, utiliza a mesma sintaxe daquela classe.
+  # @see Cli
   class Ref < Thor
     include Thor::Actions
     

data/lib/limarka/trabalho.rb

@@ -1,8 +1,12 @@
 # coding: utf-8
 
 module Limarka
+
+  # Esta classe representa o seu trabalho acadêmico.
+  # @author Eduardo de Sanana Medeiros Alexandre
   class Trabalho
-    # Todas as chaves de configuração devem ser string (e não utilizar simbolos!)
+    # Todas as chaves de configuração devem ser string (não utilizar simbolos!)
+    # @return [Hash] a configuração desse trabalho.
     attr_accessor :configuracao
     attr_accessor :texto, :anexos, :apendices, :errata
     attr_reader :referencias
@@ -21,6 +25,9 @@ module Limarka
 #      @configuracao = c.inject({}){|h,(k,v)| h[k.to_s] = v; h} # convert to strings
 #    end
 
+
+    # Atualiza a configuração do trabalho.
+    # @param configuracao [Hash]
     def configuracao=(configuracao)
       @configuracao = configuracao or {}
       siglas = @configuracao['siglas']
@@ -30,6 +37,7 @@ module Limarka
     end
 
 
+
     def anexos=(a)
       @anexos = a
       if (a) then
@@ -39,14 +47,17 @@ module Limarka
       end
     end
 
+    # @return o valor de `anexos` na configuração.
     def anexos?
       @configuracao['anexos']
     end
 
+    # @return o valor de `errata` na configuração.
     def errata?
       @configuracao['errata']
     end
 
+    # Atualiza errata na configuração
     def errata=(e)
       @errata = e
       if (e) then
@@ -103,6 +114,8 @@ module Limarka
       'configuracao.yaml'
     end
 
+    # Ler os arquivos e atualiza a configuração, texto, referências, apendices e anexos.
+    # @param options opção criada em {Cli}
     def atualiza_de_arquivos(options)
       self.configuracao = ler_configuracao(options)
       puts "Configuração lida: #{configuracao}" if options[:verbose]
@@ -114,6 +127,11 @@ module Limarka
       self.anexos = ler_anexos if anexos?
     end
 
+    # Ler a configuração. A origem da configuração é determinada pelo valor de `options[:configuracao_yaml]`.
+    # Se contém valor verdadeiro, ler do arquivo `configuracao.yaml`, caso contrário ler de `configuracao.pdf`.
+    # @param options [Hash] criado na classe {Cli}
+    # @return configuracao
+    # @see {Cli}
     def ler_configuracao(options)
       if options and options[:configuracao_yaml] then
         raise IOError, "Arquivo configuracao.yaml não foi encontrado, talvez esteja executando dentro de um diretório que não contém um projeto válido?" unless File.exist?('configuracao.yaml')
@@ -124,6 +142,10 @@ module Limarka
       end
     end
 
+    # Ler configuração do arquivo pdf
+    # @param file arquivo pdf
+    # @return [Hash] configuração exportada a partir da leitura do arquivo pdf
+    # @see Pdfconf#exporta
     def ler_configuracao_pdf(file)
       raise IOError, 'Arquivo não encontrado: ' + file unless File.exist? (file)
       pdf = PdfForms::Pdf.new file, (PdfForms.new 'pdftk'), utf8_fields: true
@@ -140,6 +162,7 @@ module Limarka
     end
     
     def ler_texto(rascunho_file)
+      # Ficou estranho esse código, merece um refactory.
       if (rascunho_file) then
         File.open(rascunho_file, 'r') {|f| f.read}
       else  
@@ -147,18 +170,25 @@ module Limarka
       end
     end
     
+    # Ler referências do arquivo de referências.
+    # @return [String] conteúdo do arquivo de referências
     def ler_referencias(configuracao)
       arquivo_de_referencias = configuracao['referencias_caminho']
       File.open(arquivo_de_referencias, 'r') {|f| f.read}
     end
 
+    # Salva o hash no formato yaml no caminho especificado. Adiciona o `\n---\n`
+    # para manter compatível com o leitor pandoc.
+    # @param hash que será exportado.
+    # @param caminho [String] aonde será salvo o arquivo
     def self.save_yaml(hash, caminho)
       File.open(caminho, 'w') do |f|
         f.write YAML.dump(hash)
         f.write "\n---\n"
       end
     end
-    
+   
+    # Salva os conteúdos do trabalho em arquivos no diretórios especificado. 
     def save(dir)
       Dir.chdir(dir) do
         File.open(Trabalho.default_texto_file, 'w'){|f| f.write texto} if texto

data/lib/limarka/version.rb

@@ -1,3 +1,3 @@
 module Limarka
-  VERSION = "0.6.4"
+  VERSION = "0.6.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: limarka
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Eduardo de Santana Medeiros Alexandre
@@ -306,4 +306,3 @@ signing_key:
 specification_version: 4
 summary: Ferramenta para compilação de trabalhos acadêmicos com markdown e abnTeX2
 test_files: []
-has_rdoc: