browser_gui 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in browser_gui.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jack Veenstra
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# BrowserGui
+
+Create simple GUI apps in Ruby, using the web browser as the GUI.
+
+Use this gem with Sinatra to automatically open a web page that is controlled by
+your Ruby script.  This allows you to package up a simple Sinatra server as a
+command-line script and share that script with others. When someone runs that
+script, it opens up a new tab in a web browser and they can immediately start
+interacting with it.
+
+Works on Mac, Linux, and Windows.
+
+## Installation
+
+Install using:
+
+    $ [sudo] gem install browser_gui
+
+## Example Usage
+
+### A simple HTML form
+
+```
+#!/usr/bin/env ruby
+
+require "sinatra"
+require "browser_gui"
+
+FORM = '<form action="/action" method="post">
+  Name: <input type="text" name="text" size="30"><br><input type="submit">
+  </form>'
+
+get "/" do
+  FORM
+end
+
+post "/action" do
+  params.inspect
+end
+```
+
+### A simple Markdown example
+
+```
+#!/usr/bin/env ruby
+
+require "sinatra"
+require "browser_gui"
+
+CONTENTS_MD =<<EOF
+# An Example Using Markdown and Sinatra
+* [Click me](/action/1)
+* [No, click me](/action/2)
+EOF
+
+get "/" do
+  markdown CONTENTS_MD
+end
+
+get "/action/:id" do
+  "You clicked link #{params[:id]}"
+end
+```
+
+## Using command-line options
+
+```
+#!/usr/bin/env ruby
+
+# Handle options before 'require "sinatra"'
+
+require "trollop"
+
+opts = Trollop::options do
+  banner "Usage: #$0 [options]"
+  opt :gui, "Use gui", :default => true
+  opt :text, "text", :type => :string, :required => true
+end
+
+if opts[:gui] == false
+  puts opts[:text]
+  exit 0
+end
+
+require "sinatra"
+require "browser_gui"
+
+get "/" do
+  opts[:text]
+end
+```
+
+If you want to support command-line options in your script, you need to process
+the options before `require "sinatra"`. The example above uses the
+[Trollop](http://trollop.rubyforge.org/) gem to parse the options. This example
+supports a `--no-gui` option to disable the default behavior of opening a web
+page, and it requires a `--text` string argument (or `-t`). If the example code
+above is in the file `gui_optional.rb`, you could run it like this:
+
+```
+./gui_optional.rb -t "Hello, world."   # Displays "Hello, world." in a web page
+```
+or
+```
+./gui_optional.rb -t "Hello, world." --no-gui  # Displays "Hello, world" to the console.
+```
+
+You can still pass arguments to Sinatra (such as setting the port number), like this:
+
+```
+./gui_optional.rb -t "Hello, world." -- -p 5678
+```
+
+The double dash `--` stops the option processing in the script and passes the
+remaining options to Sinatra.  The `-t` option is parsed by the script and the
+`-p` option is parsed by Sinatra.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/browser_gui.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/browser_gui/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jack Veenstra"]
+  gem.email         = ["veenstra@gmail.com"]
+  gem.description   = %q{Use with Sinatra to create command-line scripts that open the browser as a GUI.}
+  gem.summary       = %q{Use the browser as a GUI.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "browser_gui"
+  gem.require_paths = ["lib"]
+  gem.version       = BrowserGui::VERSION
+end

data/examples/gui_optional.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+# Handle options before 'require "sinatra"'
+
+require "trollop"
+
+opts = Trollop::options do
+  banner "Usage: #$0 [options]"
+  opt :gui, "Use gui", :default => true
+  opt :text, "text", :type => :string, :required => true
+end
+
+if opts[:gui] == false
+  puts opts[:text]
+  exit 0
+end
+
+require "sinatra"
+require "browser_gui"
+
+get "/" do
+  opts[:text]
+end

data/examples/simple_form.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "sinatra"
+require "browser_gui"
+
+FORM = '<form action="/action" method="post">
+  Name: <input type="text" name="text" size="30"><br><input type="submit">
+  </form>'
+
+get "/" do
+  FORM
+end
+
+post "/action" do
+  params.inspect
+end

data/examples/simple_markdown.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "sinatra"
+require "browser_gui"
+
+CONTENTS_MD =<<EOF
+# An Example Using Markdown and Sinatra
+* [Click me](/action/1)
+* [No, click me](/action/2)
+EOF
+
+
+get "/" do
+  markdown CONTENTS_MD
+end
+
+get "/action/:id" do
+  "You clicked link #{params[:id]}"
+end

data/lib/browser_gui/version.rb

@@ -0,0 +1,3 @@
+module BrowserGui
+  VERSION = "0.0.1"
+end

data/lib/browser_gui.rb

@@ -0,0 +1,22 @@
+require "browser_gui/version"
+
+unless defined? settings
+  warn "Cannot find Sinatra settings. Did you require \"sinatra\"?"
+  exit 1
+end
+
+module BrowserGui
+  def self.open_browser(url)
+    if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/ then
+      system("start #{url}")
+    elsif RbConfig::CONFIG['host_os'] =~ /darwin/ then
+      system("open #{url}")
+    elsif RbConfig::CONFIG['host_os'] =~ /linux/ then
+      system("xdg-open #{url}")
+    end
+  end
+end
+
+# Sinatra uses an "at_exit" block to start the server, so we have to use
+# an "at_exit" block to open the browser.
+at_exit { BrowserGui.open_browser("http://localhost:#{settings.port}/") }

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: browser_gui
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jack Veenstra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-22 00:00:00.000000000 Z
+dependencies: []
+description: Use with Sinatra to create command-line scripts that open the browser
+  as a GUI.
+email:
+- veenstra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- browser_gui.gemspec
+- examples/gui_optional.rb
+- examples/simple_form.rb
+- examples/simple_markdown.rb
+- lib/browser_gui.rb
+- lib/browser_gui/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Use the browser as a GUI.
+test_files: []
+has_rdoc: