restbox 0.0.1 → 0.1.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Richard Millan
+Copyright (c) 2009 Richard Millan and Joseph Silvashy
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,14 +1,14 @@
 = Restbox
 
-== Prerequisites
-  JQuery 1.3.2
-
 == Install
 
 To install as a Rails plugin, run this command.
 
   script/plugin install http://github.com/richardiux/restbox.git
 
+=== Prerequisites
+  JQuery 1.3.2
+
 == Setup
 
 in your layout after including jQuery:
@@ -16,20 +16,41 @@ in your layout after including jQuery:
   <%= javascript_include_tag 'restbox' %>
   <%= stylesheet_link_tag 'restbox' %>
 
-== Example
+== Example on Rails Application
+
+=== In your application.js
+
+  $(document).ready(function() {
+    jQuery("a.restbox").restbox({})
+  }
 
 === In your view
 
-link_to "edit", order_path(@order), :class => "restbox"
+  <%= link_to "edit", order_path(@order), :class => "restbox" %>
+  
 
+=== In your controller
+
+  def edit
+    @order = Order.find params[:id]
+    respond_to do |format|
+      format.html { }
+      format.js   { }
+    end
+  end
+  
+=== The JS view for the action (edit.js.erb)
+
+You can use the following javascript helpers
 
 To put text in the restbox:
-  <%= restbox({:content => "some text"})%>
+  <%= restbox(:content => 'some text') %>
 
 To put a partial inside the restbox:
-  <%= restbox(:content => render(:partial => 'orders')) %>
+  <%= restbox(:content => render(:partial => 'form')) %>
 
-=== With javascript
+
+== With javascript
 
 To put content in the restbox
   $.restbox({content: "some text"})
@@ -38,6 +59,7 @@ To manually display loading restbox
   $.restbox({})
   
 == Upgrading
+
 === Reinstall the plugin
  script/plugin install http://github.com/richardiux/restbox.git -f
 
@@ -56,8 +78,6 @@ This project can be found on github at the following URL.
 
 http://github.com/richardiux/restbox
 
-Description goes here.
-
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -71,4 +91,4 @@ Description goes here.
 
 == Copyright
 
-Copyright (c) 2009 Richard Millan. See LICENSE for details.
+Copyright (c) 2009 Richard Millan & Joseph Silvashy. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:minor: 1
+:patch: 0
+:build: 
+:major: 0

data/generators/restbox/restbox_generator.rb

@@ -0,0 +1,27 @@
+class RestboxGenerator < Rails::Generator::Base
+  
+  def initialize(*runtime_args)
+    super
+  end
+  
+  def manifest
+    record do |m|
+      m.directory File.join('public', 'stylesheets')
+      m.template 'stylesheets/restbox.css',   File.join('public', 'stylesheets', 'restbox.css')
+      
+      m.directory File.join('public', 'javascripts')
+      m.template 'javascripts/restbox.js',   File.join('public', 'javascripts', 'restbox.js')
+      
+      m.directory File.join('public', 'images')
+      m.template 'images/loader.gif',   File.join('public', 'images', 'loader.gif')
+      m.template 'images/restbox_close.png',   File.join('public', 'images', 'restbox_close.png')
+    end
+  end
+    
+  protected
+  
+  def banner
+    %{Usage: #{$0} #{spec.name}\nCopies restbox.css, restbox.js, and images to it's proper location to public}
+  end
+  
+end

data/generators/restbox/templates/javascripts/restbox.js

@@ -0,0 +1,79 @@
+/*
+ * RestBox - Simple overlay to work with jQuery and Rails
+ * Copyright (c) 2009
+ * Licensed under the MIT License: http://www.opensource.org/licenses/mit-license.php
+*/
+
+(function($) {
+
+  // initialize
+  $(function() {
+    content = 'loading...'
+    $('body').append('<div id=\'restbox_screen\'></div>\n<div id=\'restbox_container\'><div id=\'restbox_content\'></div></div>');
+  });
+  
+  // load content
+  $.fn.restbox = function(options) {
+    return this.unbind("click").click(function(event) {
+      $.restbox(options);
+      $.ajax({
+        url: this.href,
+        dataType: "script"
+      });
+      event.preventDefault();
+    })
+  }  
+    
+  // set defaults
+  $.restbox = function(options) {
+    options = $.extend({
+      loadingClass: "restbox_loading",
+      content: $(content)
+    }, options);
+      
+    // just fade screen in, load content when reqest includes content param
+    if (options.content.length != 0) {
+      $('div#restbox_screen').show();
+      $('div#restbox_container').show();
+      $('div#restbox_container div#restbox_content').removeClass(options.loadingClass).html(options.content);      
+      $('div#restbox_container div#restbox_content').css({top: -($('div#restbox_content').height() + 100) / 2});    
+      $('div#restbox_container div#restbox_content').animate({opacity: "100"}, 3000);
+
+    } else {
+      $('div#restbox_screen').fadeIn(120, function() {
+        $('div#restbox_container').show()
+        $('div#restbox_container div#restbox_content').addClass(options.loadingClass).html(content);
+        $('div#restbox_container div#restbox_content').css({top: -($('div#restbox_content').height() + 100) / 2});
+        $('div#restbox_container div#restbox_content').animate({opacity: "100"}, 3000);
+      });
+    }
+  
+    close_button = $("<span id='restbox_close'></span>").click(function(event){
+      $.restbox_close();
+      event.preventDefault();
+    });
+  
+    $('div#restbox_container div#restbox_content').prepend(close_button);
+  
+    $(document).bind('keydown', function(e){
+       var keycode = e.keyCode;
+       var escapeKey = 27;
+       if (keycode == escapeKey) {
+         $.restbox_close();
+       }
+    })
+  };
+  
+  $.restbox_close = function() {
+    $('div#restbox_screen').hide();
+    $('div#restbox_container').hide();
+    $('div#restbox_content').html('');
+    $(document).unbind('keydown');
+  }
+
+  // initialize
+  $(function() {
+    $(".restbox").restbox({});
+  });
+  
+})(jQuery);

data/generators/restbox/templates/stylesheets/restbox.css

@@ -0,0 +1,14 @@
+body {height:100%;}
+
+div#restbox_screen {display:none; background:black; filter:alpha(opacity=50); opacity:.8; height:100%; width:100%; position:fixed; top:0; left:0; overflow:hidden;}
+div#restbox_screen {background:-webkit-gradient(radial, center center, 1500, center center, 10, from(black), to(rgba(0,0,0,.4)), color-stop(0, black));}
+/*div#restbox_screen {background:-moz-radial-gradient(45px 45px, 10px, 52px 50px, 30px, from(#A7D30C), to(rgba(1,159,98,0)), color-stop(0.90, #019F62));}*/
+
+div#restbox_container {display:none; text-align:center; vertical-align: middle; position:absolute; top:50%; left:0px; width:100%; }
+div#restbox_container div#restbox_content {width: 350px; position:relative; margin:auto; padding:20px 30px; font-size:13px; text-align:left; line-height:18px; color:#222; background:#fff; -webkit-border-radius:5px; -webkit-box-shadow:0px 1px 16px rgba(0,0,0,.6); -moz-box-shadow:black 0px 1px 8px; -moz-border-radius:5px;}
+div#restbox_container div#restbox_content.restbox_loading {background:;}
+
+div#restbox_container div#restbox_content span#restbox_close {position:absolute; top:-12px; left:-12px; height:25px; width:26px; background:url('/images/restbox/restbox_close.png') top left; text-indent:-9999px; cursor:pointer;}
+div#restbox_container div#restbox_content a:active#restbox_close {background-position:bottom;}
+
+div#restbox_content {opacity:0;}

data/init.rb

@@ -0,0 +1 @@
+require 'restbox_view_helper.rb'

data/install.rb

@@ -0,0 +1 @@
+puts "Run `./script/generate restbox` if you want (copies optional config file and some stylesheets into your app)"

data/lib/restbox_view_helper.rb

@@ -0,0 +1,23 @@
+require 'action_view'
+
+module ActionView
+  module Helpers
+    module RestBoxHelper
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+        end
+      end
+      module InstanceMethods
+        def restbox(options = {})
+          content = escape_javascript(options[:content].to_s || '')
+          "jQuery.restbox({content: \"#{content}\"});"
+        end
+      end
+    end
+  end
+end
+
+ActionView::Base.class_eval do
+  include ActionView::Helpers::RestBoxHelper
+end

data/restbox.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{restbox}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Richard Millan"]
+  s.date = %q{2009-11-19}
+  s.description = %q{Simple restful ajax overlay to work with jQuery and Rails}
+  s.email = %q{richardiux@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "generators/restbox/restbox_generator.rb",
+     "generators/restbox/templates/images/loader.gif",
+     "generators/restbox/templates/images/restbox_close.png",
+     "generators/restbox/templates/javascripts/restbox.js",
+     "generators/restbox/templates/restbox.rb",
+     "generators/restbox/templates/stylesheets/restbox.css",
+     "init.rb",
+     "install.rb",
+     "lib/restbox.rb",
+     "lib/restbox_view_helper.rb",
+     "restbox.gemspec",
+     "test/helper.rb",
+     "test/test_restbox.rb"
+  ]
+  s.homepage = %q{http://github.com/richardiux/restbox}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple restful ajax overlay to work with jQuery and Rails}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_restbox.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: restbox
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Richard Millan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-03 00:00:00 -08:00
+date: 2009-11-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,7 +37,18 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- VERSION.yml
+- generators/restbox/restbox_generator.rb
+- generators/restbox/templates/images/loader.gif
+- generators/restbox/templates/images/restbox_close.png
+- generators/restbox/templates/javascripts/restbox.js
+- generators/restbox/templates/restbox.rb
+- generators/restbox/templates/stylesheets/restbox.css
+- init.rb
+- install.rb
 - lib/restbox.rb
+- lib/restbox_view_helper.rb
+- restbox.gemspec
 - test/helper.rb
 - test/test_restbox.rb
 has_rdoc: true