antw-kin 0.3.2

data/CHANGELOG

@@ -0,0 +1,21 @@
+== 0.3.1 2009-08-26
+
+* When setting on which controller and actions a nav item can be active, you
+  may use a glob for the action: 'home/{dashboard,accounts,users}'.
+
+== 0.3.0 2009-08-25
+
+* Kin::Nav now figures out which tab is active depending on the current
+  controller and action (see fixture/active.html.haml).
+
+== 0.2.0 2009-08-22
+
+* Renamed gem from Potion to Kin.
+* Added kin.js from Torque project.
+* SASS stylesheets will no longer be added to the SASS load path, rather you
+  should use `rake kin:copy_assets` to copy Kin's SASS and javascripts to your
+  application.
+* Navigation configuration will be autoloaded from navigation.rb in your
+  application's config directory (Merb.dir_for(:config)).
+* Added Kin::Configurable which replaces application-specific #config and
+  #configure methods.

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Anthony Williams
+
+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/Rakefile

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = 'kin'
+    s.platform    = Gem::Platform::RUBY
+    s.has_rdoc    = false
+    s.summary     = 'Components commonly used in Showcase which can be ' +
+                    'applied to other projects.'
+    s.description = s.summary
+    s.author      = 'Anthony Williams'
+    s.email       = 'anthony@ninecraft.com'
+
+    s.extra_rdoc_files = ['README', 'CHANGELOG', 'LICENSE']
+
+    s.files = %w(LICENSE README CHANGELOG Rakefile VERSION.yml) +
+              Dir.glob("{lib,spec}/**/*") - %w(spec/merb_test.log)
+  end
+rescue LoadError
+  puts 'Jeweler not available. Install it with: gem install ' +
+       'technicalpickles-jeweler -s http://gems.github.com'
+end
+
+##############################################################################
+# rSpec & rcov
+##############################################################################
+
+desc "Run all examples (or a specific spec with TASK=xxxx)"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts  = ["-c -f s"]
+  t.spec_files = begin
+    if ENV["TASK"]
+      ENV["TASK"].split(',').map { |task| "spec/**/#{task}_spec.rb" }
+    else
+      FileList['spec/**/*_spec.rb']
+    end
+  end
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('spec:rcov') do |t|
+  t.spec_files = FileList['spec/**/*.rb']
+  t.spec_opts = ['-c -f s']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+##############################################################################
+# YARD Documentation
+##############################################################################
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files = %w( CHANGELOG LICENSE lib/**/*.rb )
+  end
+rescue LoadError
+  puts 'Yardoc not available. Install it with: gem install yardoc'
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 2
+:major: 0
+:minor: 3

data/lib/kin.rb

@@ -0,0 +1,41 @@
+require 'merb-helpers'
+
+# Make sure we're running inside Merb.
+if defined?(Merb::Plugins)
+  kin = File.expand_path(File.join(File.dirname(__FILE__), 'kin'))
+
+  require File.join(kin, 'core_ext', 'date')
+  require File.join(kin, 'core_ext', 'string')
+  require File.join(kin, 'core_ext', 'time')
+
+  require File.join(kin, 'configurable')
+  require File.join(kin, 'form_builder')
+  require File.join(kin, 'masthead')
+  require File.join(kin, 'nav')
+
+  Merb::Plugins.add_rakefiles(File.join(kin, 'tasks', 'sync_assets'))
+
+  # Default nav formatter. Can be overridden in an after_app_loads block, or
+  # on a case-by-case basis in +display_navigation+.
+  Merb::Plugins.config[:kin] = { :nav_formatter => Kin::Nav::BasicFormatter }
+
+  Merb::BootLoader.after_app_loads do
+    # Add default time formats.
+    unless Time.formats.include?(:full)
+      Time.add_format(:full, '%A %d %B, %H:%M')
+    end
+
+    unless Time.formats.include?(:date_only)
+      Time.add_format(:date_only, '%A %d %B')
+    end
+
+    unless Time.formats.include?(:date_with_year)
+      Time.add_format(:date_with_year, '%d %B %Y')
+    end
+
+    # After the application loads, see if there is a config/navigation.rb file
+    # to initialize the nav instances.
+    nav_rb = File.join(Merb.dir_for(:config), 'navigation.rb')
+    load(nav_rb) if File.exists?(nav_rb)
+  end
+end

data/lib/kin/assets/javascripts/kin.js

@@ -0,0 +1,260 @@
+// Copyright (c) 2009 Anthony Williams, Torque
+//
+// 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.
+
+// This file is placed here by the kin:copy_assets rake task and will be
+// overwritten whenever that task is run. Do not edit this file directly.
+
+(function() {
+
+    var R_ISO_8601 = new RegExp(
+        "(\\d\\d\\d\\d)(-)?" +   // YYYY              capture:1-2
+        "(\\d\\d)(-)?" +         // MM                capture:3-4
+        "(\\d\\d)" +             // DD                capture:5
+        "(T)?(\\d\\d)(:)?" +     // HH                capture:6-8
+        "(\\d\\d)(:)?" +         // MM                capture:9-10
+        "(\\d\\d)(\.\\d+)?" +    // SS                capture:11-12
+        "(Z|([+-])" +            // Zulu or Timezone  capture:13-14
+        "(\\d\\d)(:)?(\\d\\d))"  // HH::MM            capture:15-17
+    )
+
+    Date.fromISO8601 = function (isoString) {
+        var match  = isoString.match(R_ISO_8601),
+            date   = new Date(),
+            offset = 0;
+
+        if (! match)
+            return NaN;
+
+        date.setUTCDate(1);
+        date.setUTCFullYear(match[1].toInt());
+        date.setUTCMonth(match[3].toInt() - 1);
+        date.setUTCDate(match[5].toInt());
+        date.setUTCHours(match[7].toInt());
+        date.setUTCMinutes(match[9].toInt());
+        date.setUTCSeconds(match[11].toInt());
+
+        if(match[12]) {
+            date.setUTCMilliseconds(match[12].toFloat() * 100);
+        } else {
+            date.setUTCMilliseconds(0);
+        }
+
+        if (match[13] != 'Z') {
+            offset  = (match[15].toInt() * 60) + match[17].toInt();
+            offset *= ((match[14] == '-') ? -1 : 1);
+            date.setTime(date.getTime() - offset * 60 * 1000);
+        }
+
+        return date;
+    }
+
+})();
+
+// ---------------------------------------------------------------------------
+
+var Kin = {};
+
+/**
+ * Creates a button.
+ */
+Kin.Button = new Class({
+    Implements: [Options, Element.ToElement],
+
+    options: {
+        // Main buttons are shown in blue.
+        main:  false,
+        // An optional icon name to be added (as a CSS class).
+        icon:  false,
+        // Right-align the button?
+        right: false,
+        // Additional CSS classes to add.
+        css: ''
+    },
+
+    initialize: function(text, options) {
+        this.setOptions(options);
+        this.text = text;
+        this.tag = 'button';
+    },
+
+    build: function() {
+        this.element = new Element(this.tag).addClass('button');
+
+        if(this.options.css)
+            this.element.addClass(this.options.css);
+
+        if(this.options.main)
+            this.element.addClass('blue');
+
+        if(this.options.right)
+            this.element.addClass('right');
+
+        // If the button has an icon, the text gets wrapped in an 'icon' span,
+        // otherwise, the text is added straight to the button itself.
+        if(this.options.icon) {
+            this.element.adopt(
+                new Element('span').set('text', this.text).
+                    addClass('icon').addClass(this.options.icon)
+            );
+        } else {
+            this.element.set('text', this.text);
+        }
+
+        return this.element;
+    }
+});
+
+/**
+ * Creates a link which looks like a button.
+ */
+Kin.Button.Link = new Class({
+    Extends: Kin.Button,
+
+    initialize: function(text, url, options) {
+        this.parent(text, options);
+        this.tag = 'a';
+        this.url = url;
+    },
+
+    build: function() {
+        return this.parent().set('href', this.url);
+    }
+});
+
+// ---------------------------------------------------------------------------
+
+/**
+ * Creates a modal dialog.
+ */
+Kin.Dialog = new Class({
+    Extends: StickyWin.Modal.Ajax,
+
+    options: {
+        requestOptions: {
+            method: 'get',
+            evalScripts: false
+        },
+
+        handleResponse: function(data) {
+            this.Request.response.text.stripScripts();
+
+            this.content = this.transform(data);
+            this.setContent(new Kin.Dialog.UI(this).build());
+            this.show();
+        },
+
+        closeOnEsc: true
+    },
+
+    initialize: function(options) {
+        options = $merge(options || {}, {
+            modalOptions: {
+                modalStyle: {
+                    'background-color': '#000',
+                    'opacity': 0.7
+                }
+            }
+        });
+
+        this.parent(options);
+    },
+
+    createRequest: function(){
+		this.Request = new Request.JSON(this.options.requestOptions)
+		this.Request.addEvent('onSuccess', this.options.handleResponse.bind(this));
+	},
+
+    // Provides a hook so that subclasses can transform the returned response
+    // data (which is typically JSON) into HTML.
+    transform: function(data) {
+        return data;
+    }
+});
+
+/**
+ * UI wrapper for Kin dialogs.
+ */
+Kin.Dialog.UI = new Class({
+    initialize: function(dialog) {
+        this.dialog = dialog;
+    },
+
+    build: function() {
+        var hide = function(event) {
+            event.stop();
+            this.dialog.hide();
+        }.bind(this);
+
+        var wrapper = new Element('div').addClass('modal_shadow');
+        this.element = wrapper;
+
+        var dialog = new Element('div').addClass('dialog');
+        wrapper.adopt(dialog);
+
+        // Create header.
+        var top = new Element('div').addClass('top');
+        var header = this.buildHeader()
+
+        // Add close button.
+        top.adopt(
+            new Element('a').set('href', window.location.href).
+                addClass('close').addEvent('click', hide)
+        );
+
+        dialog.adopt(top.adopt(header));
+
+        // Create main content.
+        var content = new Element('div').addClass('content');
+        content.adopt(this.buildContent());
+        dialog.adopt(content);
+
+        // Create footer.
+        dialog.adopt(new Element('div').addClass('footer'));
+
+        // Close the dialog if the user clicks on the shadow.
+        wrapper.addEvent('click', hide);
+        // But not when clicking elsewhere in the dialog.
+        dialog.addEvent('click', function(event) {
+            event.stopPropagation();
+        });
+
+        return wrapper;
+    },
+
+    buildHeader: function() {
+        var title = new Element('span').set('text', this.dialog.title);
+
+        if(this.dialog.type) {
+            title.adopt(new Element('span').addClass('note').
+                set('text', ' ' + this.dialog.type));
+        }
+
+        if(this.dialog.icon) {
+            title = new Element('span').addClass('icon').
+                addClass(this.dialog.icon).adopt(title);
+        }
+
+        return new Element('div').addClass('title').adopt(title);
+    },
+
+    buildContent: function() {
+        return new Element('div').adopt(this.dialog.content);
+    }
+});

data/lib/kin/assets/stylesheets/_forms.sass

@@ -0,0 +1,255 @@
+// This file is placed here by the kin:copy_assets rake task and will be
+// overwritten whenever that task is run. Do not edit this file directly.
+
+// Expects your own stylsheets to define:
+//    !width      - width of the content area.
+//    !link_color - colour of your hyperlinks.
+
+// Buttons
+!btn_link_line_height  ||= 18px
+!btn_line_height       ||= !btn_link_line_height
+!btn_link_padding      ||= 3px 11px 3px 12px
+!btn_ie6_padding       ||= 2px 11px 1px 12px
+!btn_ie7_padding       ||= 2px 11px 1px 12px
+!btn_fx_padding        ||= 3px 11px 3px 12px
+
+// Tiny Buttons
+!btn_tiny_line_height  ||= 15px
+!btn_tiny_link_padding ||= 3px 8px 2px 9px
+!btn_tiny_ie6_padding  ||= 2px 8px 0px 9px
+!btn_tiny_ie7_padding  ||= 2px 8px 1px 9px
+!btn_tiny_fx_padding   ||= 3px 8px 2px 9px
+
+!btn_font ||= "\"Lucida Grande\", Arial, sans-serif"
+
+!quiet ||= #777
+
+form
+  label, span.pseudo_label
+    :cursor pointer
+    :display block
+    :font-weight bold
+    :line-height 1
+    :padding 0 0 8px
+    span.req
+      :color #c00
+    span.note
+      +quiet
+      +ismall
+      :font-weight normal
+      :padding-left 5px
+  span.pseudo_label
+    :cursor default
+  ul.form
+    :list-style none
+    :margin 0
+    li
+      :padding-bottom 20px
+  .description
+    +small
+    +quiet
+    :display block
+    :font-weight normal
+    :margin 0
+    :padding 5px 0 0
+  .multiple span.field
+    :display block
+    :float left
+    :padding-right 6px
+
+  // Fields.
+
+  input.text, input.password, input.title, textarea
+    :background #fff url(../images/form_field.png) top left repeat-x
+    :border = !border
+    :border-bottom-color #ddd
+    :border-top-color #999
+    :font-size 1em
+    :line-height 1em
+    :padding 5px 4px
+    &:focus
+      :border-color #999
+      :border-bottom-color #aaa
+      :border-top-color #666
+      // :background-color #fffff0
+      // Safari focus.
+      :outline 0
+    &[disabled=disabled]
+      :background-color #f9f9f9
+  .title input, .title .overTxtDiv
+    :font-size 1.25em
+  input.wide, input.title, textarea
+    :width = !width - 10px
+    &.error
+      :background-color #fef3f3
+  textarea
+    :height 6em
+    :line-height 1.5
+    :margin 0
+  .overTxtDiv
+    +quiet
+    :padding 4px 0 0 2px
+
+  // Radios.
+
+  .radios
+    label
+      :float left
+      :font-weight normal
+      :padding 3px 0 8px 5px
+      :width 628px
+    input
+      :float left
+      :margin 2px
+
+  // Date fields.
+
+  li.date
+    .at, .timesep
+      +quiet
+      :padding-top 4px
+    .hour, .timesep
+      :padding-right 2px
+    .datepicker a
+      +ismall
+      :background url(../images/icons/datepicker.png) 6px 4px no-repeat
+      :display block
+      :padding 3px 5px 4px 26px
+    .datepicker.disabled a
+      +quiet
+      :background-position 6px -26px
+      &:hover
+        :cursor default
+        :text-decoration none
+
+// Buttons.
+form ul.form li.buttons
+  :padding-bottom 0
+
+.buttons
+  :margin 0
+  :padding-bottom 0
+  button, a
+    :background #ecf4f6 url(../images/button.png) repeat-x
+    :-moz-border-radius 3px
+    :-webkit-border-radius 3px
+    :border-radius 3px
+    :border 1px solid #999
+    :color #222
+    :cursor pointer
+    :display block
+    :float left
+    :font-family = !btn_font
+    :font-size 1em
+    :line-height = !btn_link_line_height
+    :margin 0 8px 0 0
+    // Links.
+    :padding = !btn_link_padding
+    :text-decoration none
+    &.right
+      :float right
+      :margin 0 0 0 8px
+    &:active
+      :background-position 0 -40px
+    &:focus
+      :border-color #444
+      // Safari
+      :outline none
+    &.blue
+      :background-position 0 -80px
+      :border-color #2c5b8c
+      :color #fff
+      :text-shadow 0 -1px 0px #2c5b8c
+      &:active
+        :background-position 0 -120px
+    .icon
+      :background-position = 2px (!btn_line_height - 16px)
+      :background-repeat no-repeat
+      :padding 2px 2px 2px 26px
+  button
+    :overflow visible
+    // IE6.
+    :padding = !btn_ie6_padding
+    :width auto
+    &[class]
+      // Firefox.
+      :padding = !btn_fx_padding
+      // Webkit
+      :line-height = !btn_line_height
+    *:first-child+html &
+      // IE7.
+      :padding = !btn_ie7_padding
+  &.tiny
+    a, button
+      +itiny
+      :line-height = !btn_tiny_line_height
+      :margin-right 6px
+      :padding = !btn_tiny_link_padding
+    button
+      // IE6.
+      :padding = !btn_tiny_ie6_padding
+      &[class]
+        // Firefox.
+        :padding = !btn_tiny_fx_padding
+        *:first-child+html &
+          // IE7.
+          :padding = !btn_tiny_ie7_padding
+  &, &.tiny
+    button
+      &[disabled=disabled]
+        :cursor default
+        :opacity 0.5
+        :text-shadow none
+        &:active
+          :background-position 0 0
+        &.blue
+          &:active
+            :background-position 0 -80px
+      &.faux_link
+        :background none
+        :border-color transparent
+        :-moz-box-shadow none
+        :-webkit-box-shadow none
+        :box-shadow none
+        :color = !link_color
+        :font-weight normal
+        :padding-left 0
+        :padding-right 0
+        :text-shadow none
+        &:hover
+          :text-decoration underline
+
+// Error messages
+// ---------------------------------------------------------------------------
+
+div.wide_notice, #gordon div.notice, div.error
+  :background #ecfaff url(../images/icons/information.png) 25px 8px no-repeat
+  :border-top 1px solid #d0e4ec
+  :border-bottom 1px solid #d0e4ec
+  :padding 10px 25px 10px 47px
+  :line-height 1
+  :margin 0 -25px 25px
+  .main
+    :display block
+    :font-weight bold
+  .note
+    +small
+    :color #626d74
+    :display block
+    :margin 6px 0 0
+
+#gordon
+  div.notice
+    :background-color #f5fff0
+    :background-image url(../images/icons/tick.png)
+    :border-color #d7ecd2
+  div.error
+    :background-color #fff0f0
+    :background-image url(../images/icons/cross.png)
+    :border-color #ecd2d2
+
+div.error
+  :background #fffde9 url(/images/icons/exclamation.png) 25px 10px no-repeat
+  :border-color #e3e0c4
+  ul
+    :margin 0