macaw-ruby 0.0.20 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05fc2a1fdb3d2b9d9a5cb8e7c94c74cbeb678ce6
-  data.tar.gz: 5fd80a594c7182cbb3dea0b5d373ffc7a347c2e6
+  metadata.gz: 419b4f3eb4d30ade847d09c3cca5271be02a8778
+  data.tar.gz: 5d94f419c91aebda33ca2ab0f5f4b771b1793844
 SHA512:
-  metadata.gz: bf9a693533151a390e4b84ba35d727899eea257927483259c24d04565ed581d21fcc5d434cd14de9f2d1c4cdc53becd10367abec859a8ff72c6701cb19a00cbd
-  data.tar.gz: 574e3ff18d58972270499b9c65840c716270c79847513801cffbf3867957a2b9b7b0dc1833e18ef6fa2c980eae74806afa904beac19bcdc2872a24bb40d72132
+  metadata.gz: f3cf56c902c48414fef468b631854ba55fe25a53688f6aa56039ac39b251d01bc48bc159c9c5436c718455596b89c20e9b64d69034c2f5a29ad1f107123f6376
+  data.tar.gz: ef08fbafe0d4723286c203650bf3d50a3494d1e8643e311d9662aa7e86c42621436ae7c46139a607552ce8b36fcd8f6b8ab8d886be63166e4a06ae63162dd857

data/Gemfile.lock

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

data/README.md

@@ -1,29 +1,47 @@
 # Macaw
 
-TODO: Write a gem description
+Macaw is a Ruby Arara, a Ruby port of http://cereda.github.io/arara/. This is in many aspects very rough around the
+edges at this moment as it was written in a weekend while I was busy doing other things. Ruby does rock.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To install, make sure you have Ruby 1.9 or later installed, and then (on a command line, sorry) type
 
-    gem 'macaw'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install macaw
+    gem install macaw-ruby
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+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.
+
+## Custom rules
+
+Macaw doesn't use yaml for its rules; rules are Ruby scripts. Macaw will read your araraconfig.yaml to find the paths to
+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).
+      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'
+        port ||= 23119
+
+        # this adds the optional parameters to the url
+        params = []
+        params << "&exportCharset=#{exportCharset}" if exportCharset
+        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.
+        bib = ~"#{@base}.bib"
+        url = ~"http://localhost:#{port}/better-bibtex/collection?#{collection}.#{format}#{params}"
+
+        # Macaw.system executes the command, captures output, does logging, etc
+        Macaw.system "curl --connect-timeout 5 -z #{bib} -o #{bib} #{url}"
+      end
+    end

data/bin/macaw

@@ -204,7 +204,7 @@ class Macaw
     @@log
   end
 
-  def self.system(cmd)
+  def self.system(cmd, failonerror=true)
     cmd = cmd.compact.join(' ') if cmd.is_a?(Array)
     puts cmd
 
@@ -219,11 +219,11 @@ class Macaw
           end
 
           exit_status = wait_thr.value
-          error "cmd failed: #{cmd}" unless exit_status.success?
+          error "cmd failed: #{cmd}" unless exit_status.success? && failonerror
         end
       }
     rescue Timeout::Error
-      error "#{cmd}: timed out after #{@@options[:timeout]} seconds"
+      error "#{cmd}: timed out after #{@@options[:timeout]} seconds" if failonerror
     end
     return output
   end

data/lib/macaw/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: macaw-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
 platform: ruby
 authors:
 - Emiliano Heyns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-09 00:00:00.000000000 Z
+date: 2014-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler