flammarion 0.0.11 → 0.0.12

data/LICENSE

@@ -21,7 +21,11 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 
-# Font Awesome
+# External Packages
+
+Flammarion is bundled with a number of 3rd party packages:
+
+## Font Awesome
 
 This software incorporates
 [Font Awesome by Dave Gandy - http://fontawesome.io](http://fontawesome.io). The
@@ -30,3 +34,60 @@ fonts in Font Awesome are licensed under the
 licensed under the [MIT License](http://opensource.org/licenses/mit-license.html)
 
 C.f. https://fortawesome.github.io/Font-Awesome/license/
+
+## JQuery
+
+jQuery Foundation projects are released under the terms of the license specified in the project's repository or if not specified, under the [MIT license](https://tldrlegal.com/license/mit-license)
+
+## Highlight JS
+
+Copyright (c) 2006, Ivan Sagalaev
+All rights reserved.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of highlight.js nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+## Leaflet
+
+Copyright (c) 2010-2015, Vladimir Agafonkin
+Copyright (c) 2010-2011, CloudMade
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Readme.md

@@ -11,6 +11,15 @@ It is not intended to be a full fledged application development toolkit. It is
 intended instead for small scripts where you just want to show some information
 without going through too much trouble.
 
+## Installation
+
+First you need to install [electron](http://electron.atom.io/)
+and make sure it's in your path. Then you can install the gem:
+
+`gem install flammarion`
+
+or add it to your Gemfile.
+
 ## Documentation
 
 The easiest way to use Flammarion, is similar to how you might use STDOUT:
@@ -61,16 +70,93 @@ f.input("Placeholder > ") {|msg| f.puts "You wrote: #{msg['text'].light_magenta}
 
 There's lots more, too. I'll write more documentation eventually.
 
-## Installation
+## Screenshots / Samples
 
-First you need to install [Google Chrome](https://www.google.com/chrome/browser/desktop/index.html)
-and make sure it's in your path. Then you can install the gem:
+### Message Composer with Address Book
 
-`gem install flammarion`
+```ruby
+f = Flammarion::Engraving.new
+f.orientation = :horizontal
+recipient = f.subpane("number").input("Phone Number")
+text = f.input("Body", multiline:true)
+f.button("Send") { send_message(recipient.to_s, text.to_s); f.status("Message Sent!")}
+f.pane("contacts").puts("Contacts", replace:true)
+icons = %w[thumbs-up meh-o bicycle gears star-o star] + [nil] * 5
+30.times do |i|
+  name = Faker::Name.name
+  f.pane("contacts").button(name, right_icon:icons.sample, left_icon:icons.sample) do
+    recipient = name
+    f.subpane("numer").replace(name)
+  end
+end
+```
+
+![Message Sample](http://zach-capalbo.github.io/flammarion/img/messagesample.png)
+
+### Rake Task Runner
+
+```ruby
+f = Flammarion::Engraving.new(exit_on_disconnect:true)
+f.title "frake #{Dir.pwd}"
+
+def run(task)
+  f2 = Flammarion::Engraving.new
+  f2.title task
+  f2.puts "Running #{task.light_magenta}"
+  Open3.popen3(task) do |i,o,e,t|
+    Thread.new {e.each_line{|l| f2.print l.red}}
+    o.each_line {|l| f2.print l}
+    f2.status t.value.success? ? "Done!".light_green : "Failed!".light_red
+  end
+end
+
+f.markdown "# Rake Tasks: "
+`rake -T`.each_line do |l|
+  f.break
+  parts = l.split("#")
+  task = parts[0]
+  desc = parts[1]
+  f.puts desc
+  f.button(task) do
+    run(task)
+  end
+end
+
+f.wait_until_closed
+```
+
+![Frake](http://zach-capalbo.github.io/flammarion/img/frake.png)
+
+### Tables
+
+```ruby
+f = Flammerion::Engraving.new
+f.orientation = :horizontal
+f.table([["Id", "Name", "Address"].map{|h| h.light_magenta}] + 20.times.map do |i|
+  [i, Faker::Name.name, Faker::Address.street_address]
+end)
+f.pane("sidebar").pane("side1").puts Faker::Hipster.paragraph.red
+f.pane("sidebar").pane("side2").puts Faker::Hipster.paragraph.green
+
+3.times { f.status(Faker::Hipster.sentence.light_green)}
+```
+
+![Table Sample](http://zach-capalbo.github.io/flammarion/img/table.png)
 
-or add it to your Gemfile.
 
 ## Behind the scenes
 
 Flammarion uses Chrome to display a simple html page, and WebSockets to communicate
 between the Javascript and ruby.
+
+# Bundled Packages
+
+Flammarion is distributed with a bunch of useful tools to make everyone's life easier.
+They are:
+
+ * [ansi up](https://github.com/drudru/ansi_up)
+ * [highlihgt.js](https://highlightjs.org/)
+ * [jquery](https://jquery.com/)
+ * [jquery transit](http://ricostacruz.com/jquery.transit/)
+ * [leaflet](http://leafletjs.com/)
+ * [font awesome](https://fortawesome.github.io/Font-Awesome/)

data/electron/preload.coffee

@@ -1,7 +1,5 @@
 window.$remote = require('remote')
 
-window.$search_for = (str) ->
-  if window.find(str, 0, 0, 1)
-    anchor = window.getSelection().anchorNode
-    anchor = anchor.parentNode unless anchor.nodeType == 1
-    anchor.scrollIntoView()
+window.onkeyup = (e) ->
+  if e.ctrlKey and e.keyCode is 70
+    window.show_search_bar()

data/electron/preload.js

@@ -2,4 +2,10 @@
 (function() {
   window.$remote = require('remote');
 
+  window.onkeyup = function(e) {
+    if (e.ctrlKey && e.keyCode === 70) {
+      return window.show_search_bar();
+    }
+  };
+
 }).call(this);

data/lib/flammarion.rb

@@ -113,12 +113,6 @@ module Flammarion
       nil
     end
 
-    # Creates a new pane, and resizes the existing panes to fit it.
-    # @param name [String] The name of the pane.
-    def pane(name)
-      return Pane.new(self, name)
-    end
-
     def alert(text)
       send_json(action:'alert', text:text)
     end

data/lib/flammarion/about.rb

@@ -3,6 +3,9 @@ module Flammarion
     f = Engraving.new(close_on_exit:true)
     f.title "Flammarion #{VERSION}"
     readme = "#{File.absolute_path(File.dirname(__FILE__))}/../../Readme.md"
+    license = "#{File.absolute_path(File.dirname(__FILE__))}/../../LICENSE"
     f.markdown(File.read(readme))
+    f.break
+    f.markdown(File.read(license))
   end
 end

data/lib/flammarion/pane.rb

@@ -4,9 +4,10 @@ module Flammarion
   class Pane
     attr_reader :pane_name
     include Writeable
-    def initialize(front_end, name)
+    def initialize(front_end, name, options = {})
       @front_end = front_end
       @pane_name = name
+      @options = {}
     end
   end
 end

data/lib/flammarion/version.rb

@@ -1,3 +1,3 @@
-module Flammarion
-  VERSION = "0.0.11"
-end
+  module Flammarion
+    VERSION = "0.0.12"
+  end

data/lib/flammarion/writeable.rb

@@ -176,6 +176,8 @@ module Flammarion
     # @option options [Boolean] :autoclear (false) Automatically clears the
     #  input field every time the user changes the value. The callback will only
     #  be called for user initiated changes, not for auto-clear changes.
+    # @option options [Boolean] :history (false) Keeps track of entered values,
+    #  letting the user choose betwen them with the up and down keys.
     # @option options [String] :value Sets the starting value of the field and
     #  the returned +DeferredValue+.
     # @option options [Boolean] :once (false) If true, then the input box will
@@ -299,8 +301,8 @@ module Flammarion
       return Pane.new(@front_end, name)
     end
 
-    def pane(name)
-      send_json({action:'addpane', name:name})
+    def pane(name, options = {})
+      send_json({action:'addpane', name:name}.merge(options))
       return Pane.new(@front_end, name)
     end
 

data/lib/html/build/index.html

@@ -1 +1 @@
-<!DOCTYPE html><html><head><meta content="text/html; charset=UTF-8" http-equiv="content-type" /><meta charset="utf-8" /><meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible" /><meta content="width=device-width, initial-scale=1.0" name="viewport" /><title>Flammarion</title><link href="stylesheets/all.css" rel="stylesheet" type="text/css" /><script src="javascripts/all.js" type="text/javascript"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="hidden" id="toolbar"><a class="tool-button" href="#">Open</a><a class="tool-button" href="#">Save</a></div><div id="panes"><pre class="pane" id="console-default" style="height:100%"></pre></div><div class="hidden" id="dialog"><div id="content"><pre id="message">Hi World</pre><a class="full-button" href="#" id="ok">Ok</a></div></div><div id="status"><div class="left"></div><div class="center"></div><div class="right"></div></div></body></html>
+<!DOCTYPE html><html><head><meta content="text/html; charset=UTF-8" http-equiv="content-type" /><meta charset="utf-8" /><meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible" /><meta content="width=device-width, initial-scale=1.0" name="viewport" /><title>Flammarion</title><link href="stylesheets/all.css" rel="stylesheet" type="text/css" /><script src="javascripts/all.js" type="text/javascript"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="hidden" id="toolbar"><a class="tool-button" href="#">Open</a><a class="tool-button" href="#">Save</a></div><div id="panes"><pre class="pane" id="console-default" style="height:100%"></pre></div><div class="hidden" id="dialog"><div id="content"><pre id="message">Hi World</pre><a class="full-button" href="#" id="ok">Ok</a></div></div><div id="status"><div class="left"></div><div class="center"></div><div class="right"></div></div><div class="hidden" id="searchbar"><i class="fa fa-search"></i><input /></div></body></html>

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

@@ -110,28 +110,41 @@ void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=n.find.attr(a,b),null==e?voi
     };
 
     WSClient.prototype.resize_panes = function(data) {
-      var allPanes, height, i, len, orientation, pane, results, target;
+      var allPanes, i, j, len, orientation, p_height, pane, results, target, total_weight;
       if (data.target) {
         target = this.check_target(data);
       } else {
         target = $('#panes');
       }
       allPanes = target.find('> .pane');
-      height = (100.0 / allPanes.size()).toFixed(0) + "%";
       if (target.hasClass('horizontal')) {
         orientation = 'horizontal';
       } else {
         orientation = 'vertical';
       }
-      console.log(target, allPanes.size(), 100.0 / allPanes.size(), height, orientation);
+      total_weight = ((function() {
+        var j, len, results;
+        results = [];
+        for (j = 0, len = allPanes.length; j < len; j++) {
+          i = allPanes[j];
+          results.push(parseFloat($(i).attr('pane-weight') || 1.0));
+        }
+        return results;
+      })()).reduce(function(t, s) {
+        return t + s;
+      });
+      p_height = function(pane) {
+        return (parseFloat($(pane).attr('pane-weight') || 1.0) / total_weight * 100).toFixed(0) + "%";
+      };
+      console.log(target, allPanes.size(), 100.0 / allPanes.size(), total_weight, orientation);
       results = [];
-      for (i = 0, len = allPanes.length; i < len; i++) {
-        pane = allPanes[i];
+      for (j = 0, len = allPanes.length; j < len; j++) {
+        pane = allPanes[j];
         if (orientation === 'horizontal') {
-          $(pane).css("width", height);
+          $(pane).css("width", p_height(pane));
           results.push($(pane).css("height", '100%'));
         } else {
-          $(pane).css("height", height);
+          $(pane).css("height", p_height(pane));
           results.push($(pane).css("width", '100%'));
         }
       }
@@ -224,14 +237,16 @@ void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=n.find.attr(a,b),null==e?voi
       return $("#console-" + data.target).html("");
     },
     addpane: function(data) {
-      var target;
+      var element, target;
       if (data.target) {
         target = this.__parent.check_target(data);
       } else {
         target = $('#panes');
       }
       if (target.find("#console-" + data.name).size() === 0) {
-        target.append("<pre class='pane full-pane' id='console-" + data.name + "'><pre>");
+        element = $("<pre class='pane full-pane' id='console-" + data.name + "'><pre>");
+        element.attr('pane-weight', data.weight || 1);
+        target.append(element);
       }
       return this.__parent.resize_panes(data);
     },
@@ -297,42 +312,6 @@ void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=n.find.attr(a,b),null==e?voi
       }
       return results;
     },
-    button: function(data) {
-      var class_name, element, left_icon, right_icon, target;
-      target = this.__parent.check_target(data);
-      class_name = data.inline ? 'inline-button' : 'full-button';
-      left_icon = "";
-      data.right_icon || (data.right_icon = data.icon);
-      if (data.left_icon) {
-        left_icon = "<i class='fa fa-" + data.left_icon + " label-icon-left'></i>";
-      }
-      right_icon = "";
-      if (data.right_icon) {
-        right_icon = "<i class='fa fa-" + data.right_icon + " label-icon-right'></i>";
-      }
-      element = $("<a href='#' class='" + class_name + "'>" + left_icon + (this.__parent.escape(data.label, data)) + right_icon + "</a>");
-      element.click((function(_this) {
-        return function() {
-          return _this.__parent.send({
-            id: data.id,
-            action: 'callback',
-            source: 'button',
-            original_msg: data
-          });
-        };
-      })(this));
-      return target.append(element);
-    },
-    buttonbox: function(data) {
-      var element, target;
-      target = this.__parent.check_target(data);
-      element = target.find("#console-" + data.name);
-      if (element.size() === 0) {
-        return target.prepend("<pre class='button-box' id='console-" + data.name + "'></pre>");
-      } else {
-        return element.addClass('button-box');
-      }
-    },
     "break": function(data) {
       var code, target;
       target = this.__parent.check_target(data);
@@ -350,104 +329,6 @@ void 0===c?d&&"get"in d&&null!==(e=d.get(a,b))?e:(e=n.find.attr(a,b),null==e?voi
         return target.append("<pre id='console-" + data.name + "' class='subpane pane " + other_classes + "'></pre>");
       }
     },
-    input: function(data) {
-      var element, target;
-      target = this.__parent.check_target(data);
-      if (data.multiline) {
-        element = $("<textarea placeholder='" + data.label + "' class='inline-text-input'></textarea>");
-      } else {
-        element = $("<input type='text' placeholder='" + data.label + "' class='inline-text-input'>");
-      }
-      if (data.value) {
-        element[0].value = data.value;
-      }
-      element.change((function(_this) {
-        return function() {
-          var replaceText;
-          if (!element.hasClass("unclicked")) {
-            _this.__parent.send({
-              id: data.id,
-              action: 'callback',
-              source: 'input',
-              text: element[0].value,
-              original_msg: data
-            });
-            if (data.once) {
-              replaceText = _this.__parent.escape(element[0].value + "\n");
-              if (data.keep_label) {
-                replaceText = "" + data.label + replaceText;
-              }
-              element.replaceWith(replaceText);
-            }
-            if (data.autoclear) {
-              return element[0].value = "";
-            }
-          }
-        };
-      })(this));
-      target.append(element);
-      if (data.focus) {
-        return element.focus();
-      }
-    },
-    checkbox: function(data) {
-      var element, target;
-      target = this.__parent.check_target(data);
-      element = $("<label class='inline-checkbox'><input type='checkbox'><span>" + (this.__parent.escape(data.label, data)) + "</span></label>'");
-      if (data.value) {
-        element.find('input').attr("checked", true);
-        element.addClass("checked");
-      }
-      element.change((function(_this) {
-        return function(e) {
-          element.toggleClass("checked", element.find('input').prop('checked'));
-          return _this.__parent.send({
-            id: data.id,
-            action: 'callback',
-            source: 'input',
-            checked: element.find('input').prop('checked'),
-            original_msg: data
-          });
-        };
-      })(this));
-      element.click((function(_this) {
-        return function(e) {
-          var all_boxes, start, stop;
-          if (e.shiftKey && _this.__lastChecked) {
-            all_boxes = $('.inline-checkbox');
-            start = all_boxes.index(_this.__lastChecked);
-            stop = all_boxes.index(element);
-            console.log(start, stop);
-            all_boxes.slice(Math.min(start, stop), Math.max(start, stop) + 1).find('input').prop("checked", _this.__lastChecked.find('input').prop("checked"));
-            return all_boxes.change();
-          } else {
-            return _this.__lastChecked = element;
-          }
-        };
-      })(this));
-      return target.append(element);
-    },
-    dropdown: function(data) {
-      var element, i, item, len, ref, target;
-      target = this.__parent.check_target(data);
-      element = $("<select class='inline-dropdown' name='" + data.id + "'></select>");
-      ref = data.options;
-      for (i = 0, len = ref.length; i < len; i++) {
-        item = ref[i];
-        element.append($("<option>" + item + "</option>"));
-      }
-      element.change((function(_this) {
-        return function(e) {
-          return _this.__parent.send({
-            id: data.id,
-            action: 'callback',
-            source: 'dropdown',
-            text: element.find('option:selected').text()
-          });
-        };
-      })(this));
-      return this.__parent.add(element, target, data);
-    },
     alert: function(data) {
       return alert(data.text);
     },