kenny_dialoggins 0.1.2 → 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/.specification

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kenny_dialoggins
 version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Coroutine
@@ -16,10 +17,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-29 00:00:00 -05:00
+date: 2010-07-29 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 3
+        - 4
+        version: 2.3.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 3
+        - 4
+        version: 2.3.4
+  type: :development
+  version_requirements: *id002
 description: Kenny Dialoggins allows you to include scriptaculous dialogs in Rails applications using the same syntax employed for rendering partials.
 email: gems@coroutine.com
 executables: []
@@ -34,9 +66,9 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- generators/kenny_dialoggins_assets/kenny_dialoggins_assets_generator.rb
-- generators/kenny_dialoggins_assets/templates/kenny_dialoggins.css
-- generators/kenny_dialoggins_assets/templates/kenny_dialoggins.js
+- generators/kenny_dialoggins/kenny_dialoggins_generator.rb
+- generators/kenny_dialoggins/templates/kenny_dialoggins.css
+- generators/kenny_dialoggins/templates/kenny_dialoggins.js
 - init.rb
 - kenny_dialoggins.gemspec
 - lib/kenny_dialoggins.rb
@@ -54,23 +86,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Dead simple, beautiful dialogs for Rails.

data/README.rdoc

@@ -94,7 +94,7 @@ Either way, then generate the stylesheet and javascript files I need.
 
 == IE6 Support
 
-I'm not what you'd call a huge fan on IE6, so I don't provide a blocking 
+I'm not what you'd call a huge fan of IE6, so I don't provide a blocking 
 iframe for my dialogs by default.  But I can.  You just need to ask nicely.
 
 At the top of the generated javascript file, just change the obviously-named property 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/kenny_dialoggins.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kenny_dialoggins}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Coroutine", "Tim Lowrimore", "John Dugan"]
@@ -16,7 +16,8 @@ Gem::Specification.new do |s|
     "README.rdoc"
   ]
   s.files = [
-    ".specification",
+    ".gitignore",
+     ".specification",
      "MIT-LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -26,6 +27,9 @@ Gem::Specification.new do |s|
      "generators/kenny_dialoggins/templates/kenny_dialoggins.js",
      "init.rb",
      "kenny_dialoggins.gemspec",
+     "lib/generators/kenny_dialoggins/kenny_dialoggins_generator.rb",
+     "lib/generators/kenny_dialoggins/templates/kenny_dialoggins.css",
+     "lib/generators/kenny_dialoggins/templates/kenny_dialoggins.js",
      "lib/kenny_dialoggins.rb",
      "lib/kenny_dialoggins/helpers.rb",
      "rails/init.rb",

data/lib/generators/kenny_dialoggins/kenny_dialoggins_generator.rb

@@ -0,0 +1,18 @@
+class KennyDialogginsGenerator < Rails::Generator::Base
+
+  # This method establishes the path to the templates directory.
+  #
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+
+  # This method copies stylesheet and javascript files to the 
+  # corresponding public directories.
+  #
+  def copy_assets
+    copy_file "kenny_dialoggins.js",  "public/javascripts/kenny_dialoggins.js"
+    copy_file "kenny_dialoggins.css", "public/stylesheets/kenny_dialoggins.css"
+  end
+  
+end

data/lib/generators/kenny_dialoggins/templates/kenny_dialoggins.css

@@ -0,0 +1,20 @@
+/**  
+ * These styles are provided as examples.  Feel free to change them however you like.
+ */
+.kenny_dialoggins_dialog {                   
+    position:               absolute;
+    padding:                1em;
+    border:                 1px solid #BBB;
+    background:             #FFF;
+    z-index:                2;
+    -moz-box-shadow:        4px 4px 16px rgba(0,0,0,0.5);
+    -webkit-box-shadow:     4px 4px 16px rgba(0,0,0,0.5);
+    filter:                 alpha(opacity=100);     /* really only needed if ie6 suport is enabled */
+}
+
+.kenny_dialoggins_dialog_frame {
+    position:               absolute;
+    border:                 none;
+    z-index:                1;
+    filter:                 alpha(opacity=0);       /* really only needed if ie6 suport is enabled */
+}

data/lib/generators/kenny_dialoggins/templates/kenny_dialoggins.js

@@ -0,0 +1,268 @@
+/**
+ * Kenny Dialoggins creates pretty dialogs using prototype and 
+ * scriptaculous. These functions work with ActionView 
+ * helpers to provide dialog components that can be programmed 
+ * using the same syntax as rendering partials.
+ *
+ * 
+ * Brought to you by the good folks at Coroutine.  Hire us!
+ * http://coroutine.com
+ */
+var KennyDialoggins = {}
+
+
+/**
+ * This property governs whether or not KD bothers creating and
+ * managing a blocking iframe to accommodate ie6.
+ * 
+ * Defaults to false, but override if you must.
+ */
+KennyDialoggins.SUPPORT_IE6_BULLSHIT = false;   
+
+
+
+/**
+ * This function puts you on the highway to the danger
+ * zone by defining the KD dialog class.
+ */
+KennyDialoggins.Dialog = function(content, options) {
+    options             = options || {};
+    
+    this._element       = null;
+    this._frame         = null;
+    this._hideListener  = this._generateHideListener();
+    this._is_showing    = false;
+    
+    this._beforeShow    = options["beforeShow"] || Prototype.emptyFunction
+    this._afterShow     = options["afterShow"]  || Prototype.emptyFunction
+    this._beforeHide    = options["beforeHide"] || Prototype.emptyFunction
+    this._afterHide     = options["afterHide"]  || Prototype.emptyFunction
+    
+    this._makeDialog();
+    this.setContent(content);
+    document.body.appendChild(this._element);
+    
+    if (KennyDialoggins.SUPPORT_IE6_BULLSHIT) {
+        this._makeFrame();
+        document.body.appendChild(this._frame);
+    }
+}
+
+
+
+// ----------------------------------------------------------------------------
+// Class methods
+// ----------------------------------------------------------------------------
+
+/**
+ * This hash maps the dialog id to the dialog object itself. It allows the Rails 
+ * code a way to specify the js object it wishes to invoke.
+ */ 
+KennyDialoggins.Dialog.instances = {};
+
+
+/**
+ * This hash is a convenience that allows us to write slightly denser code when 
+ * calculating the dialog's position.
+ */
+KennyDialoggins.Dialog._POSITION_FN_MAP = $H({
+    left:   "getWidth",
+    top:    "getHeight"
+});
+
+
+/**
+ * This method shows the dialog with the corresponding id.
+ *
+ * @param {String} id   The id value of the dialog element (also the key 
+ *                      in the instances hash.)
+ *
+ * @return {Object} an instance of KennyDialoggins.Dialog
+ *
+ */
+KennyDialoggins.Dialog.show = function(id) {
+    var dialog = this.instances[id];
+    if(dialog) {
+        dialog.show();
+    }
+    return dialog;
+}
+
+
+/**
+ * This method hides the dialog with the corresponding id.
+ *
+ * @param {String} id   The id value of the dialog element (also the key 
+ *                      in the instances hash.)
+ *
+ * @return {Object} an instance of KennyDialoggins.Dialog
+ *
+ */
+KennyDialoggins.Dialog.hide = function(id) {
+    var dialog = this.instances[id];
+    if(dialog) {
+        dialog.hide();
+    }
+    return dialog;
+}
+
+
+/**
+ * This method returns a boolean indiciating whether or not the 
+ * dialog with the corresponding id is showing.
+ *
+ * @param {String} id   The id value of the dialog element (also the key 
+ *                      in the instances hash.)
+ *
+ * @return {Boolean}    Whether or not the dialog with the corresponding 
+ *                      id is showing.
+ *
+ */
+KennyDialoggins.Dialog.is_showing = function(id) {
+    var dialog = this.instances[id];
+    if (!dialog) {
+        throw "No dialog cound be found for the supplied id.";
+    }
+    return dialog.is_showing();
+}
+
+
+
+// ----------------------------------------------------------------------------
+// Instance methods
+// ----------------------------------------------------------------------------
+
+Object.extend(KennyDialoggins.Dialog.prototype, {
+    
+    /**
+     * This function constructs the dialog element and hides it by default.
+     *
+     * The class name is set outside the element constructor to accommodate
+     * a discrepancy in how prototype handles this particular attribute. The
+     * attribute is set as className in IE8--rather than class--which means the 
+     * styles are not applied and the element's positioning gets royally
+     * screwed up.
+     */
+    _makeDialog: function() {
+        if (!this._element) {
+            this._element = new Element("DIV");
+            this._element.className = "kenny_dialoggins_dialog";
+            this._element.hide();
+        }
+    },
+    
+    
+    /**
+     * This function constructs the iframe element and hides it by default.
+     *
+     * The class name is set outside the element constructor to accommodate
+     * a discrepancy in how prototype handles this particular attribute. The
+     * attribute is set as className in IE8--rather than class--which means the 
+     * styles are not applied and the element's positioning gets royally
+     * screwed up.
+     */
+    _makeFrame: function() {
+        if (!this._frame) {
+            this._frame = new Element("IFRAME");
+            this._frame.className = "kenny_dialoggins_dialog_frame";
+            this._frame.setAttribute("src", "about:blank");
+            this._frame.hide();
+        }
+    },
+    
+    
+    /**
+     * This function creates the function that handles click events when the dialog is 
+     * shown.  The handler ignores clicks targeted from within the dialog; any click 
+     * targeted outside the dialog causes the dialog to hide itself and cancel the 
+     * observer.
+     */
+    _generateHideListener: function() {
+        return function(evt) {
+            var origin = evt.findElement(".kenny_dialoggins_dialog");
+            if (this._element !== origin) {
+                this.hide();
+            }
+        }.bind(this);
+    },
+    
+    
+    /**
+     * This function sets the content of the dialog element.
+     *
+     * @param {Object} content  The html content for the dialog.
+     */
+    setContent: function(content) {
+        this._element.update(content);
+    },
+    
+    
+    /**
+     * This function displays the dialog. It uses a scriptaculous effect to fade in,
+     * centers the dialog in the viewport (and adjusts the blocking iframe, if in use), 
+     * and connects a click observer to hide the dialog whenever mouse focus leaves 
+     * the dialog.
+     */
+    show: function() {
+        KennyDialoggins.Dialog._POSITION_FN_MAP.each(function(pair) {
+            var method = pair.last();
+            this._element.style[pair.first()] = 
+                (document.viewport[method]() / 2 + document.viewport.getScrollOffsets()[pair.first()] - this._element[method]() / 2) + "px";
+        }.bind(this));
+        
+        if (this._frame) {
+            this._frame.style.top       = this._element.style.top;
+            this._frame.style.left      = this._element.style.left;
+            this._frame.style.width     = this._element.getWidth() + "px";
+            this._frame.style.height    = this._element.getHeight() + "px";
+            
+            new Effect.Appear(this._frame, {
+                duration: 0.2
+            });
+        }
+        
+        new Effect.Appear(this._element, { 
+            duration:       0.2,
+            beforeStart:    this._beforeShow,
+            afterFinish:    function() {
+                this._is_showing = true;
+                this._afterShow();
+                document.observe("click", this._hideListener);
+            }.bind(this)
+        });
+    },
+    
+    
+    /**
+     * This function hides the dialog. It uses a scriptaculous effect to fade out 
+     * and disconnects the click observer to prevent memory leaks.
+     */
+    hide: function() {
+        new Effect.Fade(this._element, {
+            duration: 0.2,
+            beforeStart:    this._beforeHide,
+            afterFinish:    function() {
+                this._is_showing = false;
+                this._afterHide();
+                document.stopObserving("click", this._hideListener);
+            }.bind(this)
+        });
+        
+        if (this._frame) {
+            new Effect.Fade(this._frame, {
+                duration: 0.2
+            });
+        }
+    },
+    
+    
+    /**
+     * This function indicates whether or not the dialog is currently 
+     * being shown.
+     *
+     * @return {Boolean}    Whether or not the dialog is being shown.
+     */
+    is_showing: function() {
+        return this._is_showing;
+    }
+});

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kenny_dialoggins
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Coroutine
@@ -61,6 +61,7 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .gitignore
 - .specification
 - MIT-LICENSE
 - README.rdoc
@@ -71,6 +72,9 @@ files:
 - generators/kenny_dialoggins/templates/kenny_dialoggins.js
 - init.rb
 - kenny_dialoggins.gemspec
+- lib/generators/kenny_dialoggins/kenny_dialoggins_generator.rb
+- lib/generators/kenny_dialoggins/templates/kenny_dialoggins.css
+- lib/generators/kenny_dialoggins/templates/kenny_dialoggins.js
 - lib/kenny_dialoggins.rb
 - lib/kenny_dialoggins/helpers.rb
 - rails/init.rb