limarka 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9fed953002b9533eee63ec10a0cb46b4d8844f91
-  data.tar.gz: 31d6a9228ce201507adbc2ee7d0aef4cccf96e2a
+SHA256:
+  metadata.gz: 80b7ab1b4b79e61e0ce24216bd77ecb6843e173cf0f1aafd2a52b650cf403825
+  data.tar.gz: 7ab5f7ed12d2c3098ea431da1f3b9bc16c5f93006abfd4cc2f7726f493ee8485
 SHA512:
-  metadata.gz: b62b3d7cf00f913e70ff95d7f826c616b60aedc1c2b6b436dcfa222162008ae888210e53eb17b0f840de265371caddebab3464b5564c2fff608d07c6e5b163cd
-  data.tar.gz: 7273ae8796737df891db7bdb013f997b1163144076b1a51edd55d36dd96b6b6d5f0b53ac00984b2858dd80d4829bb283f1f6614e0528d437e150f4563a02a3f3
+  metadata.gz: b0f4c1dc23f24a578cea102a405d63318dbc136bced4c85cd09198e87bff9196c1d68b4124fe6cc18e1922aa4770fd147c7aceabdceb7e4fad94c341e4d86387
+  data.tar.gz: 7de7eae3c866112aad2e17203c4830e75fa4459bd5966ceca012b040c37767541d34cf28873285230c5a5aa62290b8915ae4c832235ca49fdf446321bd2cbb28

data/.gitignore

@@ -199,3 +199,6 @@ xxx-*
 master.bib
 ./configuracao.yaml
 .emacs.desktop*
+
+test
+.byebug_history

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "modelo-oficial"]
+	path = modelo-oficial
+	url = https://github.com/abntex/trabalho-academico-limarka.git

data/.travis.yml

@@ -8,7 +8,8 @@ before_install:
 - sudo apt-get install -y -qq ruby-full pdftk xclip poppler-utils language-pack-pt libreoffice
 - wget https://github.com/jgm/pandoc/releases/download/1.19.2.1/pandoc-1.19.2.1-1-amd64.deb && sudo dpkg -i pandoc-*.deb
 - wget http://mirror.ctan.org/systems/texlive/tlnet/install-tl-unx.tar.gz && tar -xf install-tl-unx.tar.gz && cd install-tl-* && sudo ./install-tl -no-gui -profile ../spec/dependencias/texlive-abntex2.profile -no-verify-downloads && cd ..
-- export PATH=$PATH:/usr/local/texlive/2016/bin/x86_64-linux
+- export PATH=$PATH:/usr/local/texlive/2018/bin/x86_64-linux
+
 script:
 - latexmk -v
 - xelatex -v
@@ -19,3 +20,4 @@ script:
 - bundle exec rake spec:latex
 after_failure:
 - cd /usr/local/texlive && find . -iname latexmk
+- cat /usr/local/texlive/2017/install-tl.log

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Change Log
 
-## [v0.7.2](https://github.com/abntex/limarka/tree/v0.7.2) (2017-04-08)
+## [v0.8.0](https://github.com/abntex/limarka/tree/v0.8.0) (2018-10-20)
+[Full Changelog](https://github.com/abntex/limarka/compare/v0.7.2...v0.8.0)
+
+**Melhorias implementadas:**
+
+- Possibilita checar e notificar problemas de dependências no sistema [\#165](https://github.com/abntex/limarka/issues/165)
+- limarka --version inclui versões das dependências [\#149](https://github.com/abntex/limarka/issues/149)
+- Limarka dependende de guard-shell possibilitando geração automática [\#141](https://github.com/abntex/limarka/issues/141)
+- Template extraído para submódulo modelo-oficial [\#79](https://github.com/abntex/limarka/issues/79)
+
+**Issues fechados:**
+
+- Distribuição do limarka através de imagem Docker [\#155](https://github.com/abntex/limarka/issues/155)
+
+## [v0.7.2](https://github.com/abntex/limarka/tree/v0.7.2) (2017-04-09)
 [Full Changelog](https://github.com/abntex/limarka/compare/v0.7.1...v0.7.2)
 
 **Melhorias implementadas:**

data/CONTRIBUTING.md

@@ -5,7 +5,7 @@ e [divulgá-la](https://github.com/abntex/limarka/wiki/Imprensa).
 
 [realizar o experimento]: https://github.com/abntex/limarka/wiki/Experimentos
 
-Pull requests são sempre bem vindos. Ao participar desse projeto você está de 
+Pull requests são sempre bem vindos. Ao participar desse projeto você está de
 acordo com o [código de conduda].
 
 O projeto tem como origem uma pesquisa científica (em andamento) sobre utilização de linguagem de marcação de texto para elaboração de monografias.
@@ -16,9 +16,9 @@ Acesse o [chat no gitter](http://gitter.im/abntex/limarka) e fale conosco, indep
 
 # Professor
 
-Como professor você pode contribuir com o limarka divulgando-o e ofertando o limarka como uma opção para seus alunos realizarem tarefas. 
+Como professor você pode contribuir com o limarka divulgando-o e ofertando o limarka como uma opção para seus alunos realizarem tarefas.
 
-- Ao solicitar relatórios de atividades aos alunos, sugira a utilização do limarka. Embora o limarka tenha o propósito de produzir trabalhos de conclusão de curso, ele pode ser facilmente utilizado para elaboração de relatórios. 
+- Ao solicitar relatórios de atividades aos alunos, sugira a utilização do limarka. Embora o limarka tenha o propósito de produzir trabalhos de conclusão de curso, ele pode ser facilmente utilizado para elaboração de relatórios.
 
 - Sugira seus orientandos experimentarem o limarka. O limarka é gratuito e livre, pode ser utilizado no Linux, OS X e Windows. Não recomendamos utilizar o limarka em trabalhos de conclusão que exigam bastante fórmulas, teoremas ou provas. Os editores Latex oferecem melhor suporte para isso.
 
@@ -56,11 +56,11 @@ Ao participar desse projeto você está de acordo com o [código de conduda].
 
 # Desenvolvedor WEB
 
-Nós desejamos melhorar a experiência de utilização da ferramenta implementando 
+Nós desejamos melhorar a experiência de utilização da ferramenta implementando
 um site que gere conteúdos dinâmicos.
 
 Suponha que um usuário deseja adicionar uma referência de um artigo, gostaria
-que o usuário clicasse em "Artigo" e um formulário fosse apresentado para 
+que o usuário clicasse em "Artigo" e um formulário fosse apresentado para
 preenchimento e acordo com os campos bib desse tipo de entrada. Quando o usuário
 vai preenchendo o código bib é gerado automaticamente para inserção no arquivo
 de referências.
@@ -75,6 +75,8 @@ Para compreender a funcionalidade veja o site [http://shields.io](http://shields
 Realize um fork no projeto, depois faça o clone do seu fork:
 
     git clone git@github.com:your-username/limarka.git
+    git submodule init
+    git submodule update
 
 Configure sua máquina:
 
@@ -93,7 +95,7 @@ Realize as alterações. Adicione testes (opicional, mas desejado) para as suas
     rake
     git add arquivo-modificado1 arquivo-modificado2
     git commit
-    
+
 Se existir um Issue referente a funcionalidade implementada [utilize o número do issue na mensagem de commit](https://help.github.com/articles/closing-issues-via-commit-messages/) para manter rastreabilidade.
 
 Faça um Push para o seu fork:
@@ -105,4 +107,3 @@ Faça um Push para o seu fork:
 ## Desenvolvimento
 
 Talvez você deseje consulta a página sobre o [desenvolvimento da ferramenta](https://github.com/abntex/limarka/wiki/Desenvolvimento).
-

data/README.md

@@ -2,7 +2,8 @@
 
 [![Build Status](https://travis-ci.org/abntex/limarka.svg?branch=master)](https://travis-ci.org/abntex/limarka) [![Gem Version](https://badge.fury.io/rb/limarka.svg)](https://badge.fury.io/rb/limarka) [![Join the chat at https://gitter.im/abntex/limarka](https://badges.gitter.im/abntex/limarka.svg)](https://gitter.im/abntex/limarka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-![Normas da ABNT em 2017: Atualizadas](https://img.shields.io/badge/Normas da ABNT em 2017-Atualizadas-brightgreen.svg) ![NBR 14724:2011 100%](https://img.shields.io/badge/NBR 2014724%3A2011-100%25-brightgreen.svg)
+![Normas da ABNT em 2017: Atualizadas](https://img.shields.io/badge/Normas%20da%20ABNT%20em%202017-Atualizadas-brightgreen.svg) 
+![NBR 14724:2011 100%](https://img.shields.io/badge/NBR%202014724%3A2011-100%25-brightgreen.svg)
 
 Olá! Bem vindo ao limarka!
 

data/Rakefile

@@ -48,8 +48,11 @@ end
 
 desc 'Cria configuração padrão para execução dos testes, o libreoffice precisa está fechado!'
 task :configuracao_padrao do
-  system "libreoffice --headless --convert-to pdf configuracao.odt"
-  system 'bundle', 'exec', 'limarka', 'configuracao', 'exporta', '-o', 'spec/configuracao_padrao'
+  Dir.chdir('modelo-oficial') do
+    system "libreoffice --headless --convert-to pdf configuracao.odt"
+  end
+  configuracao_padrao_spec_dir = File.absolute_path('spec/configuracao_padrao')
+  system 'bundle', 'exec', 'limarka', 'configuracao', 'exporta', '-o', configuracao_padrao_spec_dir,'-i','modelo-oficial'
 end
 
 directory 'dissertacao-limarka/output'

data/containers/Dockerfile-ruby-latex-full.production

@@ -0,0 +1,15 @@
+FROM ruby:2.3
+
+LABEL maintainer="eduardo.ufpb@gmail.com"
+
+COPY spec/dependencias/texlive-abntex2.profile /tmp
+WORKDIR /tmp
+
+# Instala texlive
+ADD http://mirror.ctan.org/systems/texlive/tlnet/install-tl-unx.tar.gz /tmp/
+RUN tar -xf install-tl-unx.tar.gz && cd install-tl-* &&  ./install-tl -no-gui -profile ../texlive-abntex2.profile -no-verify-downloads
+# adiciona latex ao caminho
+ENV PATH $PATH:/usr/local/texlive/2017/bin/x86_64-linux
+RUN rm -rf /tmp/install-tl-*
+
+ENTRYPOINT /bin/bash

data/containers/Dockerfile.production

@@ -0,0 +1,48 @@
+FROM edusantana/ruby-latex-full
+
+LABEL maintainer="eduardo.ufpb@gmail.com"
+LABEL limarka.version="v0.7.2"
+
+WORKDIR /tmp
+
+#FROM latex_base as runtime
+# Instala pandoc
+ADD https://github.com/jgm/pandoc/releases/download/1.19.2.1/pandoc-1.19.2.1-1-amd64.deb /tmp/
+RUN dpkg -i pandoc-*.deb && rm pandoc-*.deb
+
+# Instalando dependências de teste
+#FROM runtime as teste
+#COPY . /app/
+#RUN apt-get update && apt-get install -y -qq libreoffice-writer
+RUN gem install limarka guard guard-shell
+
+# Instalando dependências de runtime
+RUN apt-get update && apt-get install -y -qq \
+	locales \
+	pdfgrep \
+	pdftk \
+	poppler-utils \
+	unzip \
+	xclip
+
+VOLUME ["/trabalho"]
+WORKDIR /trabalho
+
+#RUN locale-gen pt_BR && locale-gen pt_BR.UTF-8 && dpkg-reconfigure locales && update-locale 
+
+
+#ENV LANG=pt_BR.UTF-8
+
+# Set the locale
+#RUN apt-get update && apt-get install -y locales && locale-gen pt_BR.UTF-8
+
+#RUN locale-gen --no-purge pt_BR.UTF-8
+#update-locale LANG=pt_BR.UTF-8
+#echo locales locales/locales_to_be_generated multiselect pt_BR.UTF-8 UTF-8 | DEBIAN_FRONTEND=noninteractive debconf-set-selections
+#echo locales locales/default_environment_locale select pt_BR.UTF-8 | DEBIAN_FRONTEND=noninteractive debconf-set-selections
+#DEBIAN_FRONTEND=noninteractive dpkg-reconfigure locales
+
+# Instalando dependências de teste
+CMD ["--help"]
+ENTRYPOINT ["/usr/local/bundle/bin/limarka"]
+

data/lib/limarka.rb

@@ -3,6 +3,7 @@ require "limarka/cli"
 require "limarka/trabalho"
 require "limarka/cronograma"
 require "limarka/pdfconf"
+require "limarka/check"
 
 module Limarka
   # Your code goes here...

data/lib/limarka/check.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+module Limarka
+
+  # Possibilita checar dependencias: pandoc
+  # Ver https://github.com/abntex/limarka/issues/165
+  # @see Cli
+  class Check
+    attr_accessor :pandoc
+    attr_accessor :sistema
+    PANDOC_VERSAO_MINIMA = '1.19.1'
+    PANDOC_VERSAO_MAXIMA = '2.0.0'
+
+    def initialize(pandoc: nil, sistema: true)
+      self.pandoc = pandoc
+      self.sistema = sistema
+    end
+
+    def check
+      if sistema
+        ler_pandoc
+      end
+      verifica_compatibilidade
+      puts "OK."
+    end
+
+
+    private
+
+    def verifica_compatibilidade
+      #byebug
+      if Gem::Version.new(pandoc) < Gem::Version.new(Check::PANDOC_VERSAO_MINIMA) || Gem::Version.new(pandoc) >= Gem::Version.new(Check::PANDOC_VERSAO_MAXIMA)
+        raise VersaoIncompativelError, "Versão incompatível do pandoc. Versão compatível: #{PANDOC_VERSAO_MINIMA} <= Versão < #{PANDOC_VERSAO_MAXIMA}"
+      end
+    end
+
+    def ler_pandoc
+      self.pandoc = `pandoc --version`.split("\n")[0].split(" ")[1]
+    end
+
+  end
+
+  class VersaoIncompativelError < StandardError
+  end
+
+end

data/lib/limarka/cli.rb

@@ -18,11 +18,18 @@ module Limarka
   # documentação do [thor](http://whatisthor.com).
   #
   # @author Eduardo de Santana Medeiros Alexandre
-  # 
+  #
   class Cli < Thor
     include Thor::Actions
-    
-    default_command :exec  
+
+    default_command :exec
+
+    desc "check", "Verifica se o sistema está utilizando as dependências compatíveis"
+    def check
+      c = Limarka::Check.new()
+      c.check()
+    end
+
 
     method_option :configuracao_yaml, :aliases => '-y', :type => :boolean, :desc => 'Ler configuração exportada (configuracao.yaml) em vez de configuracao.pdf', :default => false
     method_option :input_dir, :aliases => '-i', :desc => 'Diretório onde será executado a ferramenta', :default => '.'
@@ -32,16 +39,22 @@ module Limarka
     method_option :rascunho, :aliases => '-r', :desc => 'Ler de um arquivo de rascunho em vez de "trabalho-academico.md"', :banner => "RASCUNHO_FILE"
     method_option :verbose, :aliases => '-v', :desc => 'Imprime mais detalhes da execução', :default => false, :type => :boolean
     method_option :version, :desc => 'Imprime a versão do limarka', :default => false, :type => :boolean
-    
+
     desc "exec", "Executa o sistema para geração do documento latex e compilação"
     def exec
 
       if (options[:version]) then
         puts "limarka "+Limarka::VERSION
+        s = `pandoc --version`
+        s << `ruby --version`
+        s << `pdftk --version`
+        s <<`latexmk --version`
+        s << `xelatex --version `
+        puts s
         return
       end
-      
-      #options[:output_dir] = File.absolute_path(options[:output_dir]) 
+
+      #options[:output_dir] = File.absolute_path(options[:output_dir])
       Dir.chdir(options[:input_dir]) do
         t = Limarka::Trabalho.new
         t.atualiza_de_arquivos(options)
@@ -52,7 +65,7 @@ module Limarka
       end
     end
 
-    
+
     desc "importa ARQUIVO", "Cria um arquivo trabalho-academico.md com o conteúdo convertido de ARQUIVO"
     long_desc "Converte documento do Word (ou similar) para trabalho-academico.md. O arquivo será criado no mesmo diretório que contém ARQUIVO. Útil quando possuímos um arquivo já digitado no word e desejamos utilizar o limarka. Mantém, por exemplo, as marcações de itálico, negrito e notas de rodapé."
     def importa(arquivo)
@@ -63,7 +76,7 @@ module Limarka
     method_option :interativo, :aliases => '-i', :desc => 'Solicita os parâmetros de forma interativa.', :type => :boolean, :default => false
     method_option :clipboard, :aliases => '-c', :desc => 'Utiliza o conteúdo da área de transferência como o nome do arquivo.', :type => :boolean, :default => false
 
-#     method_option :arquivo, :aliases => '-a', :desc => 'Caminho completo ou apenas o nome do arquivo na pasta imagens. Somente arquivos existêntes são válidos. Se não for especificado e o nome do arquivo esteja copiado (na área de transferência), e o arquivo existir, ele será utilizado.'  
+#     method_option :arquivo, :aliases => '-a', :desc => 'Caminho completo ou apenas o nome do arquivo na pasta imagens. Somente arquivos existêntes são válidos. Se não for especificado e o nome do arquivo esteja copiado (na área de transferência), e o arquivo existir, ele será utilizado.'
     method_option :legenda, :aliases => '-l', :desc => 'Legenda da figura.', :default => "Legenda da figura."
     method_option :fonte, :aliases => '-f', :desc => 'Fonte da imagem.', :default => "Autor."
     method_option :rotulo, :aliases => '-r', :desc => 'Rótulo para ser utilizado na referenciação da figura, caso não especificado um será proposto.'
@@ -74,7 +87,7 @@ Esse comando imprime (1) o código para inclusão de uma figura (2) e como refer
 DESC
     desc "fig ARQUIVO", "Imprime códigos para inclusão de imagens em conformidade com ABNT (em LaTeX)"
     def fig(arquivo=nil)
-      
+
       if (options[:clipboard]) then
         arquivo = Clipboard.paste         # Ler do clipboard, requer xclip: sudo apt-get install xclip
       end
@@ -83,9 +96,9 @@ DESC
         if arquivo.start_with?("file://") then
           arquivo = arquivo[7,-1]
         end
-      end       
+      end
+
 
-      
       if (options[:interativo]) then
         arquivo =   ask_figura_arquivo(arquivo)
         valida_figura_arquivo(arquivo) # antecipando validação issue #78
@@ -100,20 +113,20 @@ DESC
         rotulo = options[:rotulo]
         if (not arquivo) then
           arquivo = ask_figura_arquivo(nil)
-        end       
+        end
         valida_figura_arquivo(arquivo) # antecipando validação issue #78
         rotulo = "fig:" + propoe_rotulo(File.basename arquivo, ".*") if rotulo.nil?
         valida_figura_rotulo(rotulo)   # antecipando validação issue #78
         dimensoes = options[:dimensoes]
       end
-      
-      
-      
-      
+
+
+
+
       dimensoes.each do |dim|
 
         escala = (dim.to_f)/100
-        
+
         figura_tex = <<TEX
 
 \\begin{figure}[htbp]
@@ -148,14 +161,14 @@ DESC
       else
         rotulo = "tab:"+(Time.now.to_i % 100000).to_s
       end
-      
+
       nota = options[:nota]
       if nota then
         nota_linha = "  \\nota{#{nota}}%\n"
       else
         nota_linha = ""
       end
-      
+
       valida_tabela_rotulo(rotulo)
 
       say <<TEX
@@ -190,9 +203,9 @@ DESC
    Nome & Nascimento & Documento \\\\
   \\midrule \\midrule
    Maria da Silva & 11/11/1111 & 111.111.111-11 \\\\
-  \\midrule 
+  \\midrule
    João Souza & 11/11/2111 & 211.111.111-11 \\\\
-  \\midrule 
+  \\midrule
    Laura Vicuña & 05/04/1891 & 3111.111.111-11 \\\\
   \\bottomrule
 \\end{tabular}%
@@ -267,7 +280,7 @@ TEX
         t << ["sair","Termina o menu interativo."]
       end
       puts table
-      puts "Pressione TAB para completar o comando ao digitar: 'sa'+TAB completa para 'sair'"      
+      puts "Pressione TAB para completar o comando ao digitar: 'sa'+TAB completa para 'sair'"
       sair = false
       until sair do
         cmd = ask("Qual comando deseja executar?", :limited_to => ["exec", "figura", "tabela", "cronograma","rascunho","web","menu","sair"])
@@ -280,7 +293,7 @@ TEX
           system "limarka","exec"
         when "web"
           puts "https://github.com/abntex/limarka/wiki"
-          puts "" 
+          puts ""
         when "figura"
           system "limarka", "fig","-i"
         when "tabela"
@@ -295,7 +308,7 @@ TEX
         end
       end
 
-      
+
     end
 
 
@@ -314,8 +327,8 @@ TEX
       def valida_figura_arquivo(arquivo)
         raise RuntimeError, "Arquivo especificado para a figura não existe: '#{arquivo}'." unless File.file?(arquivo)
       end
-    
-      def ask_figura_arquivo(arquivo = nil)        
+
+      def ask_figura_arquivo(arquivo = nil)
         if arquivo.nil? then
           arquivos = Dir["imagens/*"].select{ |f| File.file? f }.sort
           print_table arquivos.map.with_index{ |a, i| [i+1, *a]}
@@ -332,9 +345,9 @@ TEX
           legenda = legenda_padrao
         else
           legenda = legenda_lida
-        end 
+        end
       end
-      
+
       def ask_figura_fonte
         fonte_padrao = "Autor."
         fonte_lida = ask("Insira o texto da fonte [#{fonte_padrao}]):")
@@ -342,11 +355,11 @@ TEX
           fonte = fonte_padrao
         else
           fonte = fonte_lida
-        end 
+        end
       end
       def ask_figura_rotulo(rotulo, arquivo)
         # http://stackoverflow.com/questions/1268289/how-to-get-rid-of-non-ascii-characters-in-ruby
-        
+
         if (not rotulo) then
           rotulo_proposto = "fig:" + propoe_rotulo(File.basename arquivo, ".*")
           rotulo_lido = ask("Rótulo para referenciar a figura [#{rotulo_proposto}]. fig:" )
@@ -355,7 +368,7 @@ TEX
           else
             rotulo = "fig:"+rotulo_lido
           end
-        end      
+        end
         rotulo
       end
 
@@ -380,7 +393,7 @@ TEX
     end
 
 
-    
+
 
     desc "configuracao help", "Exporta e atualiza configurações"
     subcommand "configuracao", Limarka::Configuracao
@@ -390,5 +403,3 @@ TEX
 
   end
 end
-
-