macaw-ruby 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 419b4f3eb4d30ade847d09c3cca5271be02a8778
-  data.tar.gz: 5d94f419c91aebda33ca2ab0f5f4b771b1793844
+  metadata.gz: acb0b0f4729eaad142f96daf4678d5bf73bd70ea
+  data.tar.gz: 82fcc20619fb567856368d2a109ad7fd4163d47c
 SHA512:
-  metadata.gz: f3cf56c902c48414fef468b631854ba55fe25a53688f6aa56039ac39b251d01bc48bc159c9c5436c718455596b89c20e9b64d69034c2f5a29ad1f107123f6376
-  data.tar.gz: ef08fbafe0d4723286c203650bf3d50a3494d1e8643e311d9662aa7e86c42621436ae7c46139a607552ce8b36fcd8f6b8ab8d886be63166e4a06ae63162dd857
+  metadata.gz: 1c9f95e64d65299aecb840ff8159fdaedf3dadc42aecd55763b3d6c50c97c446d0230a5acc0740dc62fbe126a50a85ec1009ce1c657f982a098623b216d3fab7
+  data.tar.gz: cb756f8a318b3942e94d2e179de1c2e560f909517456be76c06dfb4d1847b52577d5e7644f535c3bb61edc594415316f6d6c6d11fef1e0e97e11f77f7786bf8e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    macaw-ruby (0.0.21)
+    macaw-ruby (0.0.22)
       i18n
       json_pure
       os

data/README.md

@@ -13,7 +13,15 @@ To install, make sure you have Ruby 1.9 or later installed, and then (on a comma
 
 In day-to-day use it will (should) behave exactly like arara. It accepts the same command line parameters and reads the
 same *standard* rules that are bundled with arara; if you use only those, there's no need to change anything in your
-LaTeX documents.
+LaTeX documents. Instead of
+
+    arara
+
+you call
+
+    macaw
+
+(or macaw.bat if you want to run it from a Windows IDE)
 
 ## Custom rules
 
@@ -21,10 +29,15 @@ Macaw doesn't use yaml for its rules; rules are Ruby scripts. Macaw will read yo
 your custom rules; in that location, you can drop files that end in '.rb', which are structured like this:
 
     class Macaw # this line is mandatory
-      # define your macaw rule here. The name after 'def' is the name of your rule, the options between parenthesis are yor
-      # parameters. Optional parameters are marked using '=nil' (and for those of you who know ruby, this looks familiar but
-      # behaves oddly; using anything else than 'nil' will likewise make the parameter optional, but you will *always* be
-      # passed 'nil' if the arara rule in the tex file did not pass the parameters).
+
+      # define your macaw rule here. The name after 'def' is the name of your rule,
+      # the options between parenthesis are the parameters your rule will accept.
+      # Optional parameters are marked using '=nil'.
+      #
+      # For those of you who know ruby, this looks familiar but behaves oddly;
+      # using anything else than 'nil' will likewise make the parameter optional,
+      # but you will *always* be passed 'nil' if the arara rule in the tex file
+      # did not pass the parameters).
       def zoterobib(collection, format=nil, port=nil, exportCharset=nil, exportNotes=nil, useJournalAbbreviation=nil)
         # ||= assigns a value if it wasn't set; set your default values here
         format ||= 'biblatex'
@@ -36,8 +49,9 @@ your custom rules; in that location, you can drop files that end in '.rb', which
         params << "&exportNotes=#{exportNotes}" if exportNotes
         params << "&useJournalAbbreviation=#{useJournalAbbreviation}" if useJournalAbbreviation
 
-        # the ~ is a Macaw feature -- it will escape the path of the string after it to be safe to be passed on the command
-        # line. It will do the right thing depending on the platform it's being run on.
+        # the ~ is a Macaw feature -- it will escape the path of the string after it to be
+        # safe to be passed on the command line. It will do the right thing depending on
+        # the platform it's being run on.
         bib = ~"#{@base}.bib"
         url = ~"http://localhost:#{port}/better-bibtex/collection?#{collection}.#{format}#{params}"
 
@@ -45,3 +59,21 @@ your custom rules; in that location, you can drop files that end in '.rb', which
         Macaw.system "curl --connect-timeout 5 -z #{bib} -o #{bib} #{url}"
       end
     end
+
+You are not required to use Macaw.system BTW; arara is mainly focused on running shell programs, but since Macaw rules
+are ruby scripts, they can do some things natively:
+
+    # Clean rule for arara
+    # author: Paulo Cereda
+    # requires arara 3.0+
+    class Macaw
+      def clean(files)
+        files.reject{|f| f.downcase == @file.downcase}.each{|f|
+          Macaw.log "removing #{f}"
+          File.unlink(f)
+        }
+      end
+    end
+
+If you don't use Macaw.system, you can use *Macaw.log* to pass output to the logging system (which will be subject to
+choices the user makes on the command line, or *Macaw.error* to show a fatal error message and halt the build.

data/bin/macaw

@@ -13,12 +13,6 @@ require 'timeout'
 require 'i18n'
 require 'open3'
 
-def error(msg)
-  puts "\n\n#{msg}"
-  Macaw.log.close if Macaw.log
-  exit 1
-end
-
 puts [
 ' __  __                          ',
 '|  \/  | __ _  ___ __ ___      __',
@@ -148,6 +142,12 @@ class Macaw
   end
   attr_reader :file, :base
 
+  def self.error(msg)
+    puts "\n\n#{msg}"
+    Macaw.log.close if Macaw.log
+    exit 1
+  end
+
   def self.options
     @@options ||= options!
   end
@@ -200,8 +200,9 @@ class Macaw
     }
   end
 
-  def self.log
-    @@log
+  def self.log(line)
+    puts line if @@options[:verbose]
+    @@log.write(line) if @@log
   end
 
   def self.system(cmd, failonerror=true)
@@ -213,8 +214,7 @@ class Macaw
       Timeout::timeout(@@options[:timeout] || 0) {
         Open3.popen2e(cmd) do |stdin, stdout_err, wait_thr|
           while line = stdout_err.gets
-            puts line if @@options[:verbose]
-            @@log.write(line) if @@log
+            self.log(line)
             output += line + "\n"
           end
 

data/lib/macaw/version.rb

@@ -1,3 +1,3 @@
 class Macaw
-  VERSION = "0.0.21"
+  VERSION = "0.0.22"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macaw-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - Emiliano Heyns