limarka 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e81e9fb7ab1a5345d2feb776e012ed8757954f0
-  data.tar.gz: 923a53d79a612a541cee3ec1ec6a2368c4d8904a
+  metadata.gz: fa1896b0e71ab909e97ba9c80795702b4adb45af
+  data.tar.gz: 4977d97a73b3fd227dae4049bdad1be25ba5010f
 SHA512:
-  metadata.gz: f6a4ec252ff8d4382f67a948ce1485a8c08d0e98ccc3138ae7a9be0480284df68e132ad7a01c2cd43ab07a51b682f8be737a51ee4d30cf6f26a2bd911d75bd01
-  data.tar.gz: b8ab8e483dde30ae3903c985549004331b227a83b5055d83b828005b927c099d942036fb4031ab49a5a13649033682e316fa27077c2673ec79e689aab7c630c0
+  metadata.gz: f6928663dd2c372bd139691c3d703f443dac9adc44c9f47bd235786d3d3b5ee6122d6b6212ef3984b11cfa20309322e901b00c75f2c3673c27a7e1da3e4c2298
+  data.tar.gz: d81246bb185e683269733b24e29ec4c4907ba317eb774aab39e5a29f0b7a2a894a89fb372d0f2438cabe74f442c76163b6fd46b4b483ba55e30bddc2a1f923eb

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 # Change Log
 
-## [0.3.0](https://github.com/abntex/limarka/tree/0.3.0) (2016-11-02)
-[Full Changelog](https://github.com/abntex/limarka/compare/0.2.0...0.3.0)
+## [0.4.0](https://github.com/abntex/limarka/tree/0.4.0) (2016-11-16)
+[Full Changelog](https://github.com/abntex/limarka/compare/v0.3.0...0.4.0)
+
+**Implemented enhancements:**
+
+- Indicar a versão de utilização do limarka [\#64](https://github.com/abntex/limarka/issues/64)
+- Aumentar o provisionamento de inclusão de Figura [\#39](https://github.com/abntex/limarka/issues/39)
+
+## [v0.3.0](https://github.com/abntex/limarka/tree/v0.3.0) (2016-11-02)
+[Full Changelog](https://github.com/abntex/limarka/compare/0.2.0...v0.3.0)
 
 **Fixed bugs:**
 

data/README.md

@@ -1,18 +1,53 @@
-# Limarka
+# O que é o limarka?
 
-Gere o PDF do seu trabalho de conclusão de curso (monografia, dissertação ou teste), formatado automaticamente com as normas da ABNT, escrevendo-o no formato Markdown.
+O limarka é uma ferramenta que possibilita o usuário escrever o seu trabalho de conclusão de curso (monografia, dissertação ou teste) em Markdown e produzir PDFs em conformidade com as normas da ABNT.
 
-# Informações técnicas
+# Por que escrever em Markdown ao invés de Latex?
 
-- Escreva o texto utilizando a linguagem Markdown
-- O texto será convertido em Latex, através da ferramenta [pandoc](http://pandoc.org) e templates baseados no [abntex2](http://www.abntex.net.br)
-- O código Latex é compilado e gerado o PDF em conformidade com as normas mais recentes da ABNT.
+O LaTeX é ótimo e bastante útil para quem deseja percorrer uma carreira de Pesquisador. Muitos *journals* disponibilizam modelos somente em LaTeX para produção de artigos, aprender LaTeX irá ser útil nessa carreira.
 
+Mas se você não pretende utilizar LaTeX após a conclusão do seu curso, por que investir na longa curva de aprendizado do LaTeX? 
 
-# Documentação
+> Uma reposta seria: *Com o Latex e abnTeX eu serei capaz de produzir um trabalho em conformidade com as normas da ABNT, isso por si só já compensaria o investimento*.
+
+
+## Markdown como alternativa de aprendizado
+
+Com o limarka você agora possui outra escolha de investimento para elaborar um trabalho de conclusão do curso em conformidade com as Normas da ABNT: *aprender Markdown*.
+
+O [Markdown](https://pt.wikipedia.org/wiki/Markdown) é uma [linguagem simples de marcação](https://en.wikipedia.org/wiki/Lightweight_markup_language). Os princípios das linguagem simples de marcação estão sendo popularizados em diversas ferramentas de interação social, veja alguns exemplos: [Github](https://help.github.com/articles/basic-writing-and-formatting-syntax/), [Moodle](https://docs.moodle.org/23/en/Markdown), [WhatsApp](https://www.whatsapp.com/faq/en/general/26000002), [Facebook](http://wersm.com/facebook-is-testing-rich-text-formatting-with-markdown/) [Google Plus](https://plus.google.com/+SarahHill/posts/TWYwPctEpJp), [Jekyll](http://jekyllrb.com), etc.
+
+Após ou durante conclusão do seu curso, você pretende:
+
+- Interagir através da escrita em redes sociais ou fóruns de discussão?
+- Editar Wikis ou formatar mensagens?
+- Participar em projetos no Github?
+- Escrever documentações de softwares?
+- Gerar código HTML a partir de texto?
+- Elaborar *ebooks*?
+
+Se você respondeu afirmativamente a algumas dessas perguntas, aprender uma linguagem simples de marcação (como o Markdown) é um investimento que provavelmente agilizará as realizações destas ações.
+
+**OBS:** A implementação atual do limarka ainda exige conhecimentos mínimos do Latex.
 
-A documentação do projeto será mantida no [wiki](https://github.com/abntex/limarka/wiki)
 
+# Qual a relação do limarka com o abnTeX?
+
+O [abnTeX](https://github.com/abntex) provém  uma suíte para LaTeX que atende os requisitos das normas da ABNT (Associação Brasileira de Normas Técnicas) para elaboração de trabalhos acadêmicos como teses, dissertações, projetos de pesquisa e outros documentos do gênero.
+
+O limarka converte os textos produzidos em Markdown para LaTeX, utilizando os modelos do abnTeX2 que são extensivamente testados e incrementados pela comunidade nacional. O limarka é um projeto pertencente ao grupo do [abnTeX](https://github.com/abntex).
+
+
+# Informações técnicas
+
+- Escreva o texto utilizando a linguagem Markdown;
+- Configure diversos aspectos do trabalho através de um formulário PDF;
+- O texto será convertido em Latex, através da ferramenta [pandoc](http://pandoc.org), templates baseados no [abntex2](http://www.abntex.net.br) e as configurações do formulário;
+- Um PDF em conformidade com as normas mais recentes da ABNT é gerado através da compilação do código Latex.
+
+# Documentação
+
+A documentação do limarka será mantida no [wiki do projeto](https://github.com/abntex/limarka/wiki).
 
 # Origem do projeto
 

data/lib/limarka/cli.rb

@@ -7,10 +7,13 @@ require 'open3'
 
 require 'limarka/configuracao'
 require 'limarka/conversor'
+require 'clipboard'
 
 module Limarka
 
   class Cli < Thor
+    include Thor::Actions
+    
     default_command :exec  
 
     method_option :configuracao_yaml, :aliases => '-y', :type => :boolean, :desc => 'Ler configuração exportada (configuracao.yaml) em vez de configuracao.pdf', :default => false
@@ -19,8 +22,16 @@ module Limarka
     method_option :compila_tex, :aliases => '-c', :desc => 'Compila arquivo tex gerando um PDF', :default => true, :type => :boolean
     method_option :templates_dir, :aliases => '-t', :desc => 'Diretório que contem a pasta templates (pandoc --data-dir)', :default => Dir.pwd
     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
+        return
+      end
+      
       #options[:output_dir] = File.absolute_path(options[:output_dir]) 
       Dir.chdir(options[:input_dir]) do
         t = Limarka::Trabalho.new
@@ -39,6 +50,150 @@ module Limarka
       system "pandoc", "-t", "markdown", "-o", "#{diretorio}/trabalho-academico.md", arquivo
     end
 
+    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 :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.'
+    method_option :dimensoes, :aliases => '-d', :desc => 'Dimensões percentuais para redimencionar a figura. Se mais de uma dimensão for especificada será apresentado um código para inclusão da imagem para cada dimensão. Útil quando deseja experimentar diversas dimensões para a Figura. Ex: 80 90 100', :default => [100], :type => :array
+
+    long_desc <<-DESC
+Esse comando imprime (1) o código para inclusão de uma figura (2) e como referenciá-la no texto. Para as figuras serem apresentadas, em conformidade com as Normas da ABNT, elas precisam serem incluídas como código Latex (abnTeX2).
+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
+
+      if (arquivo) then
+        if arquivo.start_with?("file://") then
+          arquivo = arquivo[7,-1]
+        end
+      end       
+
+      
+      if (options[:interativo]) then
+        arquivo =   ask_figura_arquivo(arquivo)
+        legenda =   ask_figura_legenda
+        fonte =     ask_figura_fonte
+        rotulo =    ask_figura_rotulo(rotulo, arquivo)
+        dimensoes = ask_figura_dimensoes
+      else
+        legenda = options[:legenda]
+        fonte = options[:fonte]
+        rotulo = options[:rotulo]
+        if (not arquivo) then
+          arquivo = ask_figura_arquivo(nil)
+        end       
+        rotulo = "fig:" + propoe_rotulo(File.basename arquivo, ".*") if rotulo.nil?
+        dimensoes = options[:dimensoes]
+      end
+      
+      valida_figura_arquivo(arquivo)
+      valida_figura_rotulo(rotulo)
+      
+      say "\n<!--\nPara referenciar essa figura no texto utilize: Figura \\ref\{#{rotulo}} \n-->\n"
+      dimensoes.each do |dim|
+
+        legenda = options[:legenda]
+        escala = (dim.to_f)/100
+        
+        figura_tex = <<TEX
+\\begin{figure}[htbp]
+\\caption{\\label{#{rotulo}}#{legenda}}
+\\begin{center}
+\\includegraphics[width=#{escala}\\textwidth]{#{arquivo}}
+\\end{center}
+\\legend{Fonte: #{fonte}}
+\\end{figure}
+
+TEX
+
+        say figura_tex
+      end
+    end
+
+    no_commands do
+      def valida_figura_rotulo (rotulo)
+        if (not rotulo =~ (/^[a-zA-Z][\w\-:]*$/)) then
+          raise RuntimeError, "O rótulo não deve conter caracteres especiais. Forneça um rótulo ou remova os caracteres especiais do nome do arquivo. Rótulo atual: #{rotulo}"
+        end
+      end
+
+      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)        
+        if arquivo.nil? then
+          arquivos = Dir["imagens/*"].select{ |f| File.file? f }.sort
+          print_table arquivos.map.with_index{ |a, i| [i+1, *a]}
+          selecao = ask("Escolha um arquivo para a Figura:").to_i
+          arquivo=arquivos[selecao-1]
+        end
+
+        arquivo
+      end
+      def ask_figura_legenda
+        legenda_padrao = "Legenda da figura."
+        legenda_lida = ask("Insira o texto da legenda [#{legenda_padrao}]):")
+        if legenda_lida == "" then
+          legenda = legenda_padrao
+        else
+          legenda = legenda_lida
+        end 
+      end
+      
+      def ask_figura_fonte
+        fonte_padrao = "Autor."
+        fonte_lida = ask("Insira o texto da fonte [#{fonte_padrao}]):")
+        if fonte_lida == "" then
+          fonte = fonte_padrao
+        else
+          fonte = fonte_lida
+        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:" )
+          if rotulo_lido.empty? then
+            rotulo = rotulo_proposto
+          else
+            rotulo = "fig:"+rotulo_lido
+          end
+        end      
+        rotulo
+      end
+
+      def propoe_rotulo(string_base)
+        encoding_options = {
+          :invalid           => :replace,  # Replace invalid byte sequences
+          :undef             => :replace,  # Replace anything not defined in ASCII
+          :replace           => '-',        # Use a blank for those replacements
+        }
+
+        rotulo_proposto = string_base.gsub(/\s+/, '-').encode(Encoding.find('ASCII'), encoding_options)
+      end
+
+      def ask_figura_dimensoes
+        dimensoes = ask("Forneça as dimensões separadas por espaço [100]:")
+        if dimensoes.empty? then
+          [100]
+        else
+          dimensoes.split(" ")
+        end
+      end
+    end
+
+
+    
 =begin
     method_option :entrada, :default => "configuracao.pdf", :aliases => "-i", :banner => "FILE"
     method_option :saida, :default => "templates/configuracao.yaml", :aliases => "-o", :banner => "FILE"

data/lib/limarka/version.rb

@@ -1,3 +1,3 @@
 module Limarka
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/limarka.gemspec

@@ -22,8 +22,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 11.0"
   spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "pry-byebug"
-  spec.add_dependency "github_changelog_generator"
+  spec.add_development_dependency "github_changelog_generator"
   
+  spec.add_dependency "clipboard"
   spec.add_dependency "colorize"
   spec.add_dependency "pdf-forms", "~> 1.1.1"
   spec.add_dependency "pandoc-ruby"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limarka
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Eduardo de Santana Medeiros Alexandre
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2016-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: clipboard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="