zen 0.3 → 0.4

data/lib/zen/public/admin/{js/zen → zen/js}/lib/window.js

@@ -1,3 +1,7 @@
+"use strict";
+
+namespace('Zen');
+
 /**
  * The Window class can be used to create basic windows with a title and a set
  * of buttons. These windows can be used for a preview of an article, showing an
@@ -78,17 +82,33 @@ Zen.Window = new Class(
         move: false,
 
         // A collection of buttons to display inside the window
-        buttons: []
+        buttons:
+        [
+            {
+                name:   'close',
+                label:   lang('zen_general.buttons.close'),
+                onClick: function(instance)
+                {
+                    instance.destroy();
+                }
+            }
+        ]
     },
 
     /**
      * DOM element for the current window instance.
      *
      * @since  0.2.6
-     * @var    {element}
      */
     element: null,
 
+    /**
+     * The background overlay for the current window.
+     *
+     * @since 18-12-2011
+     */
+    overlay: null,
+
     /**
      * Creates a new instance of the class and displays the window.
      *
@@ -106,60 +126,53 @@ Zen.Window = new Class(
 
         this.setOptions(options);
 
-        // Create the HTML for the window
-        var container = new Element(
-            'article',
+        var container = new Element('div',
+        {
+            'class': 'window',
+            styles:
             {
-                'class': 'window',
-                styles:
-                {
-                    width:  this.options.width,
-                    height: this.options.height
-                }
+                width:  this.options.width,
+                height: this.options.height
             }
-        );
+        });
 
-        var header  = new Element('header', {'class': 'clearfix'});
-        var close   = new Element('div'   , {'class': 'close'});
-        var body    = new Element('div'   , {'class': 'body', html: content});
+        var body    = new Element('div', {'class': 'body', html: content});
         var current = this;
 
         // Do we have a title?
         if ( this.options.title !== null )
         {
-            var title = new Element('h1', {html: this.options.title});
+            var header = new Element('div', {'class': 'header'});
+            var title  = new Element('h2', {html: this.options.title});
+
             title.inject(header);
+            header.inject(container);
         }
 
-        close.addEvent('click', function()
-        {
-            current.destroy();
-        });
-
-        // Inject the base elements
-        close.inject(header);
-        header.inject(container);
         body.inject(container);
 
         // Add all the buttons
         if ( this.options.buttons.length > 0 )
         {
             var buttons_container = new Element(
-                'div', {'class': 'buttons clearfix'}
+                'div',
+                {'class': 'buttons'}
             );
 
             this.options.buttons.each(function(button)
             {
-                var div = new Element('div', {'class': 'button ' + button.name});
-                var btn = new Element('button', {text: button.label});
+                var btn = new Element('button',
+                {
+                    text:    button.label,
+                    'class': 'button ' + button.name
+                });
 
                 btn.addEvent('click', function()
                 {
                     button.onClick(current);
                 });
 
-                btn.inject(div);
-                div.inject(buttons_container);
+                btn.inject(buttons_container);
             });
 
             buttons_container.inject(container);
@@ -183,9 +196,16 @@ Zen.Window = new Class(
         var margin = this.options.width - ( this.options.width * 1.5 );
         container.setStyle('margin-left', margin);
 
+        if ( $$('.window_overlay').length <= 0 )
+        {
+            this.overlay = new Element('div', {'class': 'window_overlay'});
+            this.overlay.inject(document.body);
+        }
+
         // Last step: inject the HTML into the DOM
         this.element = container;
         this.element.inject(document.body);
+
     },
 
     /**
@@ -196,5 +216,10 @@ Zen.Window = new Class(
     destroy: function()
     {
         this.element.destroy();
+
+        if ( this.overlay )
+        {
+            this.overlay.destroy();
+        }
     }
 });

data/lib/zen/security.rb

@@ -0,0 +1,50 @@
+module Zen
+  ##
+  # Module for dealing with various security related actions such as sanitizing
+  # user input/output.
+  #
+  # @since 07-01-2012
+  #
+  module Security
+    class << self
+      ##
+      # Sanitizes the string by escaping all Etanni template tags in it so that
+      # they aren't executed. Optionally this method can also remove all
+      # dangerous HTML using Loofah.
+      #
+      # It is recommended to use this method whenever your code accepts used
+      # input. Since removing HTML isn't always needed (sometimes you actually
+      # want to allow certain HTML tags) this is turned off by default.
+      #
+      # @example
+      #  input = 'Hello #{puts 10}'
+      #
+      #  Zen::Input.sanitize(input) # => "Hello \#\{puts 10\}"
+      #
+      # @since  03-01-2012
+      # @param  [String] input The input string to sanitize.
+      # @param  [TrueClass|FalseClass] clean_html When set to true certain HTML
+      #  elements will be removed using Loofah.
+      # @return [String] The sanitized string.
+      #
+      def sanitize(input, clean_html = false)
+        return input unless input.is_a?(String)
+
+        # Cheap way of escaping the template tags.
+        input = input.gsub('<?r', '\<\?r') \
+          .gsub('?>', '\?\>') \
+          .gsub('#{', '\#\{') \
+          .gsub('}', '\}')
+
+        if clean_html == true
+          input = Loofah.fragment(input) \
+            .scrub!(:whitewash) \
+            .scrub!(:nofollow) \
+            .to_s
+        end
+
+        return input
+      end
+    end # class << self
+  end # Input
+end # Zen

data/lib/zen/spec/helper.rb

@@ -10,6 +10,9 @@ end
 require 'capybara/dsl'
 require 'ramaze/spec/bacon'
 
+require __DIR__('helper/general')
+require __DIR__('helper/capybara')
+
 Bacon.extend(Bacon::TapOutput)
 
 # Configure Capybara
@@ -18,130 +21,12 @@ Capybara.configure do |config|
   config.app            = Ramaze.middleware
 end
 
-##
-# Logs the user in using the spec user.
-#
-# @since  0.2.8
-#
-def capybara_login
-  # Log the user in
-  login_url     = ::Users::Controller::Users.r(:login).to_s
-  dashboard_url = ::Sections::Controller::Sections.r(:index).to_s
-
-  visit(login_url)
-  ::Ramaze::Log.loggers.clear
-
-  within('#login_form') do
-    fill_in('Email'   , :with => 'spec@domain.tld')
-    fill_in('Password', :with => 'spec')
-    click_button('Login')
-  end
-end
-
-##
-# Runs the block in a new thread and redirects $stdout and $stderr. The output
-# normally stored in these variables is stored in an instance of StringIO which
-# is returned as a hash.
-#
-# @example
-#  out = catch_output do
-#    puts 'hello'
-#  end
-#
-#  puts out # => {:stdout => "hello\n", :stderr => ""}
-#
-# @since  0.2.8
-# @return [Hash]
-#
-def catch_output
-  data = {
-    :stdout => nil,
-    :stderr => nil
-  }
-
-  Thread.new do
-    $stdout, $stderr = StringIO.new, StringIO.new
-
-    yield
-
-    $stdout.rewind
-    $stderr.rewind
-
-    data[:stdout], data[:stderr] = $stdout.read, $stderr.read
-
-    $stdout, $stderr = STDOUT, STDERR
-  end.join
-
-  return data
-end
-
-##
-# Allows developers to create stubbed objects similar to Mocha's stub() method.
-#
-# @example
-#  obj = stub(:language => 'Ruby')
-#  puts obj.language # => "Ruby"
-#
-# @since  0.2.8
-# @param  [Hash] attributes A hash containing all the attributes to set and
-# their values.
-# @return [Class]
-#
-def stub(attributes)
-  obj = Struct.new(*attributes.keys).new
-
-  attributes.each do |k, v|
-    obj.send("#{k}=", v)
-  end
-
-  return obj
-end
-
-##
-# Returns a hash with a stubbed custom field and a stubbed custom field value.
-#
-# @since  0.2.8
-# @param  [String] field_type_name The name of the field type.
-# @param  [Hash] options Additional options to pass to the stub() call for the
-# custom field.
-# @return [Hash]
-#
-def stub_custom_field(field_type_name, options = {})
-  custom_field_type = CustomFields::Model::CustomFieldType[
-    :name => field_type_name
-  ]
-
-  options = {
-    :id                    => 1,
-    :name                  => 'Field',
-    :slug                  => 'field',
-    :description           => 'A stubbed field',
-    :sort_order            => 0,
-    :format                => 'markdown',
-    :required              => false,
-    :text_editor           => false,
-    :textarea_rows         => nil,
-    :text_limit            => 100,
-    :custom_field_group_id => 1,
-    :custom_field_type_id  => custom_field_type.id,
-    :custom_field_type     => custom_field_type
-  }.merge(options)
-
-  return {
-    :custom_field       => stub(options),
-    :custom_field_value => stub(
-      :id               => 1,
-      :value            => 'Ruby',
-      :custom_field_id  => 1,
-      :section_entry_id => 1
-    )
-  }
-end
-
 shared :capybara do
   Ramaze.setup_dependencies
   extend Capybara::DSL
   extend WebMock::API
+  extend Zen::Spec::Helper::Capybara
+  extend Zen::Spec::Helper::General
 
   capybara_login
 end

data/lib/zen/spec/helper/capybara.rb

@@ -0,0 +1,75 @@
+module Zen
+  module Spec
+    module Helper
+      ##
+      # Module providing various helper methods for Capybara based tests.
+      #
+      # @since 18-02-2012
+      #
+      module Capybara
+        ##
+        # Logs the user in using the spec user.
+        #
+        # @since  0.2.8
+        #
+        def capybara_login
+          # Log the user in
+          login_url     = ::Users::Controller::Users.r(:login).to_s
+          dashboard_url = ::Sections::Controller::Sections.r(:index).to_s
+
+          visit(login_url)
+          ::Ramaze::Log.loggers.clear
+
+          within('#login_form') do
+            fill_in('Email'   , :with => 'spec@domain.tld')
+            fill_in('Password', :with => 'spec')
+            click_button('Login')
+          end
+        end
+
+        ##
+        # Automatically saves a form with the given ID.
+        #
+        # @since 18-02-2012
+        # @param [String] id The ID of the form.
+        #
+        def autosave_form(id)
+          page.evaluate_script(
+            "new Zen.Autosave(
+              $('#{id}'),
+              $('#{id}').get('data-autosave-url'),
+              {interval: 1000}
+            );"
+          )
+
+          sleep(2.5)
+
+          page.has_selector?('span.error').should == false
+        end
+
+        ##
+        # Switches Capybara's driver to the default Javascript driver.
+        #
+        # @since 18-02-2012
+        #
+        def enable_javascript
+          WebMock.disable!
+
+          ::Capybara.current_driver = ::Capybara.javascript_driver
+
+          capybara_login
+        end
+
+        ##
+        # Switches Capybara's driver back to the default driver.
+        #
+        # @since 18-02-2012
+        #
+        def disable_javascript
+          ::Capybara.use_default_driver
+          WebMock.enable!
+        end
+      end # Capybara
+    end # Helper
+  end # Spec
+end # Zen

data/lib/zen/spec/helper/general.rb

@@ -0,0 +1,75 @@
+module Zen
+  module Spec
+    module Helper
+      ##
+      # Module providing general spec helpers.
+      #
+      # @since 18-02-2012
+      #
+      module General
+        ##
+        # Allows developers to create stubbed objects similar to Mocha's stub() method.
+        #
+        # @example
+        #  obj = stub(:language => 'Ruby')
+        #  puts obj.language # => "Ruby"
+        #
+        # @since  0.2.8
+        # @param  [Hash] attributes A hash containing all the attributes to set and
+        # their values.
+        # @return [Class]
+        #
+        def stub(attributes)
+          obj = Struct.new(*attributes.keys).new
+
+          attributes.each do |k, v|
+            obj.send("#{k}=", v)
+          end
+
+          return obj
+        end
+
+        ##
+        # Returns a hash with a stubbed custom field and a stubbed custom field value.
+        #
+        # @since  0.2.8
+        # @param  [String] field_type_name The name of the field type.
+        # @param  [Hash] options Additional options to pass to the stub() call for the
+        # custom field.
+        # @return [Hash]
+        #
+        def stub_custom_field(field_type_name, options = {})
+          custom_field_type = CustomFields::Model::CustomFieldType[
+            :name => field_type_name
+          ]
+
+          options = {
+            :id                    => 1,
+            :name                  => 'Field',
+            :slug                  => 'field',
+            :description           => 'A stubbed field',
+            :sort_order            => 0,
+            :format                => 'markdown',
+            :required              => false,
+            :text_editor           => false,
+            :textarea_rows         => nil,
+            :text_limit            => 100,
+            :custom_field_group_id => 1,
+            :custom_field_type_id  => custom_field_type.id,
+            :custom_field_type     => custom_field_type
+          }.merge(options)
+
+          return {
+            :custom_field       => stub(options),
+            :custom_field_value => stub(
+              :id               => 1,
+              :value            => 'Ruby',
+              :custom_field_id  => 1,
+              :section_entry_id => 1
+            )
+          }
+        end
+      end # General
+    end # Helper
+  end # Spec
+end # Zen