flammarion 0.1.0 → 0.1.1

data/Readme.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/flammarion.svg)](https://badge.fury.io/rb/flammarion)
 
 * [Source](https://github.com/zach-capalbo/flammarion)
-* [Documentation](http://zach-capalbo.github.io/flammarion/doc/Flammarion)
+* [Documentation](http://zach-capalbo.github.io/flammarion/doc/Flammarion.html)
 
 ## Overview
 
@@ -76,8 +76,8 @@ f.button("Click Here!!!") {f.puts "You clicked the button!"}
 f.input("Placeholder > ") {|msg| f.puts "You wrote: #{msg['text'].light_magenta}"}
 ```
 
-The [api documetaion](http://zach-capalbo.github.io/flammarion/doc/Flammarion)
-is available at <http://zach-capalbo.github.io/flammarion/doc/Flammarion>.
+The [api documetaion](http://zach-capalbo.github.io/flammarion/doc/Flammarion.html)
+is available at <http://zach-capalbo.github.io/flammarion/doc/Flammarion.html>.
 
 ## Screenshots / Samples
 

data/lib/flammarion/engraving.rb

@@ -26,8 +26,10 @@ module Flammarion
     # @option options [Boolean] :close_on_exit (false) Will close the window
     #  when the process exits if this is true. Otherwise, it will just stay
     #  around, but not actually be interactive.
-    # @opion options [String] :title The initial title of the engraving. If
+    # @option options [String] :title The initial title of the engraving. If
     #  empty, a random title will be generated.
+    # @raise {SetupError} if neither chrome nor electron is set up correctly and
+    #  and Flammarion is unable to display the engraving.
     def initialize(options = {})
       options = {:title => options} if options.is_a?(String)
       @chrome = OpenStruct.new

data/lib/flammarion/revelator.rb

@@ -1,8 +1,19 @@
 module Flammarion
+  # Raised when flammarion cannot find any way to display an engraving.
+  # On Linux, Flammarion will first try to launch Electron using the command
+  # +electron+. If that fails, it will try common aliases of Google Chrome. If
+  # none of them execute succesfully, it will raise this error. On Windows, it
+  # will try to launch Google Chrome from Program Files (x86). If chrome has
+  # been installed somewhere else, the user can set the environment variable
+  # FLAMMARION_REVELATOR_PATH to point to +chrome.exe+.
+  # @see http://electron.atom.io/
+  # @see http://www.google.com/chrome/
+  class SetupError < StandardError; end
+
   # @api private
   # @todo This all needs a lot of clean up
   module Revelator
-    CHROME_PATH = 'C:\Program Files (x86)\Google\Chrome\Application\chrome.exe'
+    CHROME_PATH = ENV["FLAMMARION_REVELATOR_PATH"] || 'C:\Program Files (x86)\Google\Chrome\Application\chrome.exe'
     def open_a_window_on_windows(options)
       file_path = File.absolute_path(File.join(File.dirname(__FILE__), ".."))
       file_path = `cygpath -w '#{file_path}'`.strip if RbConfig::CONFIG["host_os"] == "cygwin"
@@ -10,6 +21,7 @@ module Flammarion
       resource = "http://localhost:4567/" if ENV["FLAMMARION_DEVELOPMENT"] == "true"
       chrome_path = CHROME_PATH
       chrome_path = `cygpath -u '#{CHROME_PATH}'`.strip if RbConfig::CONFIG["host_os"] == "cygwin"
+      raise SetupError.new("Cannot find #{chrome_path}. You need to install Google Chrome or set the environment variable FLAMMARION_REVELATOR_PATH to point to chrome.exe") unless File.exist?(chrome_path)
       Process.detach(spawn(chrome_path, %[--app=#{resource}?path=#{@window_id}&port=#{server.port}&title="#{options[:title] || "Flammarion%20Engraving"}"]))
     end
 
@@ -26,12 +38,13 @@ module Flammarion
         return
       end
 
-      %w[google-chrome google-chrome-stable chromium chromium-browser chrome C:\Program\ Files\ (x86)\Google\Chrome\Application\chrome.exe].each do |executable|
+      %w[google-chrome google-chrome-stable chromium chromium-browser chrome].each do |executable|
+        next unless which(executable)
         @chrome.in, @chrome.out, @chrome.err, @chrome.thread = Open3.popen3("#{executable} --app='#{host}?path=#{@window_id}&port=#{server.port}&title=#{@expect_title}'")
         break if @chrome.in
       end
 
-      raise StandardError.new("Cannot launch any browser") unless @chrome.in
+      raise SetupError.new("You must have either electron or google-chrome installed and accesible via your path.") unless @chrome.in
     end
 
     private

data/lib/flammarion/version.rb

@@ -1,3 +1,3 @@
   module Flammarion
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end

data/lib/html/build/javascripts/actions.js

@@ -68,7 +68,7 @@ void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=n.find.attr(a,b),null==e?voi
       console.log("Path: " + ($qs.get("path")) + ", Port: " + ($qs.get("port")) + ", Host: " + host);
       this.ws = new WebSocket("ws://" + host + ":" + ($qs.get("port")) + "/" + ($qs.get("path")));
       this.actions["__parent"] = this;
-      document.title = $qs.get("title") || "Flammarion Unconnected";
+      document.title = decodeURIComponent($qs.get("title")) || "Flammarion";
       this.ws.onopen = function(msg) {
         return $('body').addClass("connected");
       };

data/lib/html/build/javascripts/all.js

@@ -6689,7 +6689,7 @@ if (typeof module !== 'undefined') {
       console.log("Path: " + ($qs.get("path")) + ", Port: " + ($qs.get("port")) + ", Host: " + host);
       this.ws = new WebSocket("ws://" + host + ":" + ($qs.get("port")) + "/" + ($qs.get("path")));
       this.actions["__parent"] = this;
-      document.title = $qs.get("title") || "Flammarion Unconnected";
+      document.title = decodeURIComponent($qs.get("title")) || "Flammarion";
       this.ws.onopen = function(msg) {
         return $('body').addClass("connected");
       };

data/lib/html/build/javascripts/input.js

@@ -68,7 +68,7 @@ void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=n.find.attr(a,b),null==e?voi
       console.log("Path: " + ($qs.get("path")) + ", Port: " + ($qs.get("port")) + ", Host: " + host);
       this.ws = new WebSocket("ws://" + host + ":" + ($qs.get("port")) + "/" + ($qs.get("path")));
       this.actions["__parent"] = this;
-      document.title = $qs.get("title") || "Flammarion Unconnected";
+      document.title = decodeURIComponent($qs.get("title")) || "Flammarion";
       this.ws.onopen = function(msg) {
         return $('body').addClass("connected");
       };

data/lib/html/build/javascripts/map.js

@@ -68,7 +68,7 @@ void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=n.find.attr(a,b),null==e?voi
       console.log("Path: " + ($qs.get("path")) + ", Port: " + ($qs.get("port")) + ", Host: " + host);
       this.ws = new WebSocket("ws://" + host + ":" + ($qs.get("port")) + "/" + ($qs.get("path")));
       this.actions["__parent"] = this;
-      document.title = $qs.get("title") || "Flammarion Unconnected";
+      document.title = decodeURIComponent($qs.get("title")) || "Flammarion";
       this.ws.onopen = function(msg) {
         return $('body').addClass("connected");
       };

data/lib/html/build/javascripts/websocket.js

@@ -68,7 +68,7 @@ void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=n.find.attr(a,b),null==e?voi
       console.log("Path: " + ($qs.get("path")) + ", Port: " + ($qs.get("port")) + ", Host: " + host);
       this.ws = new WebSocket("ws://" + host + ":" + ($qs.get("port")) + "/" + ($qs.get("path")));
       this.actions["__parent"] = this;
-      document.title = $qs.get("title") || "Flammarion Unconnected";
+      document.title = decodeURIComponent($qs.get("title")) || "Flammarion";
       this.ws.onopen = function(msg) {
         return $('body').addClass("connected");
       };

data/lib/html/source/javascripts/websocket.coffee

@@ -7,7 +7,7 @@ class WSClient
     console.log "Path: #{$qs.get("path")}, Port: #{$qs.get("port")}, Host: #{host}"
     @ws = new WebSocket "ws://#{host}:#{$qs.get("port")}/#{$qs.get("path")}"
     @actions["__parent"] = this
-    document.title = $qs.get("title") || "Flammarion Unconnected"
+    document.title = decodeURIComponent($qs.get("title")) || "Flammarion"
     @ws.onopen = (msg) ->
       $('body').addClass("connected")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flammarion
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-01 00:00:00.000000000 Z
+date: 2016-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-websocket