activo-rails 1.0

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in activo-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    activo-rails (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activesupport (3.0.1)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.2)
+    nokogiri (1.4.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  activo-rails!
+  nokogiri
+  rake
+  rspec

data/README.md

@@ -0,0 +1,228 @@
+# Activo Rails #
+
+This gem provides a Rails 3 engine which makes using the Activo web application theme
+a more pleasant process.
+
+It places all the required assets in the right places, and
+provides an application layout, saving you from having to strip out the relevant bits
+and build it yourself everytime.
+
+There are also a few view helpers available to simplify the creation of common UI elements
+such as button lists, breadcrumbs, and menus.
+
+## Installing ##
+
+To install the theme add the following line to your application's Gemfile:
+
+    gem "activo-rails"
+
+And then run `bundle install`. If you have an application layout then you'll need to remove
+or rename it, since your application's assets will always take priority.
+
+## Hello, World! ##
+
+A basic view, with a single content block, and a page title would look something like this.
+
+    <% page_title "Hello, world!" %>
+
+    <div class="block">
+      <div class="content">
+        <h2>Hello, World!</h2>
+        <div class="inner">
+          <p>This is a basic Activo template.</p>
+        </div>
+      </div>
+    </div>
+
+Unfortunatly there's a bit of divitis involved in using Activo. I'd like to reduce that with
+some more helpers, but I'm not entirely sure how to do so cleanly at the moment. It's probably
+worth it though.
+
+If you're using a decent text editor, it should be automatable anyway.
+
+## View Helpers ##
+
+There are a few view helpers available to use which deal with some of the more awkward parts of
+Activo.
+
+### Setting the Page Title ###
+
+As shown in the previous example, you can call `page_title` to set the title to be displayed.
+
+    <% page_title "My Lovely Page" %>
+
+### Icons ###
+
+To display icons use the `icon` helper. Activo includes the Fatcow icons from www.fatcow.com/free-icons,
+which are licensed under the Creative Commons Attribution 3.0 license. It's up to you to either
+comply with that license, or replace them with something else.
+
+    <%= icon "delete", :large, :alt => "Delete Item" %>
+
+The first argument is the filename of the icon, without extension.
+
+The second is the size. :small gives a 16x16 icon, :large gives 32x32.
+
+Finally, a hash of options. Currently the only valid option is :alt which sets the alt text to be
+included in the image tag. Further options will probably be supported in the future.
+
+### Navigation Tabs ####
+
+The `secondary_navigation` helper is used to add some tabs to the top of a content block.
+    
+    <% page_title "About Us" %>
+
+    <div class="block">
+      <%= secondary_navigation do |n|
+        n.item "The Company", about_path("company"), :active => true
+        n.item "Our Offices", about_path("offices")
+        n.item "Jobs", about_path("jobs"), :class => "highlighted"
+      end %>
+      <div class="content">
+        <h2>About Us</h2>
+        <div class="inner">
+          <p>We're an amazing company! We do things!</p>
+          <p>To find out more, click the tabs above.</p>
+        </div>
+      </div>
+    </div>
+
+Each item can be passed a hash of options. Valid options are:
+
+  active (boolean): If set to true, the tab will be highlighted as the current tab.
+  class (string): Additional classes to apply to the tab.
+  link\_options (hash): A hash of options to pass to link\_to.
+
+### Breadcrumbs ###
+
+These are much like tabs, but appear at the bottom of a block as a trail of pages.
+They're added using the `breadcrumbs` helper.
+
+    <% page_title "News Item 3" %>
+
+    <div class="block">
+      <div class="content">
+        <h2>News Item 3</h2>
+        <div class="inner">
+          <p>We've got some new news here. Read all about it!</p>
+        </div>
+      </div>
+      <%= breadcrumbs do |b|
+        b.item "Home", root_path
+        b.item "News", news_path
+        b.item "News Item 3", news_path(3), :active => true
+      end %> 
+    </div>
+
+Valid options are teh same as for tabs.
+
+### Controls ###
+
+To add a set of buttons to the top of a block, use the `controls` helper.
+
+    <% page_title "News Item 3 (Admin Mode)" %>
+
+    <div class="block">
+      <div class="content">
+        <%= controls do |c|
+          c.item "Delete", news_path(3), :link_options => { :method => :delete, :confirm => "Really delete News Item 3?" }, :icon => "delete"
+          c.item "Edit", edit_news_path(3), :icon => "edit"
+        end %>
+        <h2>News Item 3</h2>
+        <div class="inner">
+          <p>We've got some new news here. Read all about it!</p>
+        </div>
+      </div>
+    </div>
+
+Valid options are the same as for tabs, with an additional `icon` option, which will be passed
+to the `icon` helper.
+
+## Customising the Layout ##
+
+You probably want to add a few menus of your own, and maybe a sidebar as well. That's done by
+providing some helpers within your application which if they exist will be called by Activo to
+fill in the empty spaces.
+
+### Navigation ###
+
+The main and user navigation areas at the top of the page are populated in the same way. The main
+navigation is the text based one on the left hand side, while the user navigation is the row of icons
+on the right.
+
+To populate them create a helper called either `main_navigation` or `user_navigation`. The method
+will be passed a NavigationBuilder instance which can be filled with items.
+    
+    module ApplicationHelper
+      def main_navigation(menu)
+        menu.item "Home", root_path
+        menu.iten "News", news_path, :active => true
+      end
+    end
+
+When populating the user navigation you probably want to make the first argument a call to `image_tag`
+since the space available isn't big enough for anything other icons.
+
+### Status ###
+
+In the top right, opposite the logo, there's a section which can be filled with text to notify your users
+of important information. If a `status_menu` helper exists, the return value will be used to fill that space.
+    
+    module ApplicationHelper
+      def status_menu
+        "Welcome back Jon!"
+      end
+    end
+
+### The Sidebar ###
+
+The sidebar is filled by a `sidebar` helper if one exists.
+    
+    module ApplicationHelper
+      def sidebar
+        content_tag("div", :class => "block") do
+          content_tag("ul", :class => "navigation") do
+            content_tag("li", link_to("News Item 3", news_path(3)))
+          end
+        end
+      end
+    end
+
+It's probably easier to render a partial here, especially if your sidebar is going to change frequently.
+
+### Hiding the Sidebar ###
+
+If you don't want a sidebar at all you can expand the content area to fill the available space. Set the `full_width`
+instance variable to do so.
+
+    class ApplicationController < ActionController::Base
+      before_filter :hide_sidebar
+      
+      def hide_sidebar
+        @full_width = true
+      end
+      protected :hide_sidebar
+    end
+
+## Using Formtastic ##
+
+Activo is already set up to be used with Formtastic, but doesn't directly depend on it, since form
+builders are very much a matter of taste.
+
+If you would like to use it (and I recommend it), then just add `gem 'formtastic'` to your Gemfile, and everything
+will work out of the box.
+
+## Contributing ##
+
+This is currently a very young gem. I'm using it in a couple of projects quite happily, but it could certainly
+use some smoothing out of the edges, and more view helpers. If you want to contribute, fork this repository, and
+send me a pull request when your feature is ready.
+
+## Credits ##
+
+For the original (and beautiful) Activo web app theme: David Francisco (http://github.com/dmfrancisco/activo)
+Icons: FatCow (http://www.fatcow.com/free-icons)
+Fixing jQuery UI image paths: Mike Park (http://github.com/mikepinde/)
+
+And thanks to the people brave enough to use this before it was released, or even had a readme, for provoking me into
+actually releasing the damn thing.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.name = "spec"
+  t.pattern = "spec/*_spec.rb"
+end

data/activo-rails.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "activo-rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "activo-rails"
+  s.version     = ActivoRails::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jon Wood"]
+  s.email       = ["jon@blankpad.net"]
+  s.homepage    = "http://github.com/jellybob/activo-rails"
+  s.summary     = %q{Provides Rails integration for the Activo web app theme.}
+  s.description = %q{Provides Rails integration for the Activo web app theme.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "nokogiri"
+  s.add_development_dependency "actionpack"
+end

data/app/views/layouts/application.html.erb

@@ -0,0 +1,57 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title><%= @title || "Untitled Page" %></title>
+  
+  <%= stylesheet_link_tag "jquery-ui.css", :media => "screen" %>
+  <%= stylesheet_link_tag "base.css", :media => "screen" %>
+  <%= stylesheet_link_tag "jquery.tipsy.css", :media => "screen" %>
+  <%= stylesheet_link_tag "activo/activo.css", :media => "screen", :id => "current-theme" %>
+  <!--[if IE]>
+    <%= stylesheet_link_tag "activo/activo-ie.css", :media => "screen" %>
+  <![endif]-->
+  <%= stylesheet_link_tag "activo-attrtastic/attrtastic_changes.css", :media => "screen" %>
+  <%= stylesheet_link_tag "activo-formtastic/formtastic.css", :media => "screen" %>
+  <%= stylesheet_link_tag "activo-formtastic/formtastic_changes.css", :media => "screen" %>
+  <%= stylesheet_link_tag "application.css", :media => "screen" %>
+  
+  <%= javascript_include_tag "https://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js" %>
+  <%= javascript_include_tag "https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.6/jquery-ui.min.js" %>
+  <%= javascript_include_tag "jquery.scrollTo.js" %>
+  <%= javascript_include_tag "jquery.localscroll.js" %>
+  <%= javascript_include_tag "application.js" %>
+  <%= javascript_include_tag "jquery.tipsy.js" %>
+  <%= javascript_include_tag "rails.js" %>
+  
+  <%= csrf_meta_tag %>
+
+  <%= yield :head %>
+</head>
+
+<body>
+  <div id="container">
+    <div id="header">
+      <%= content_tag("div", status_menu, :id => "status") if respond_to? :status_menu %>
+      <h1><a href="index.html"></a></h1>
+      <%= navigation(:id => "user-navigation") { |n| user_navigation(n) } if respond_to?(:user_navigation) %>
+      <%= navigation(:id => "main-navigation") { |n| main_navigation(n) } if respond_to?(:main_navigation) %>
+    </div>
+    <div id="wrapper" class="wat-cf">
+      <div id="<%= @full_width ? 'full-main' : 'main' %>">
+        <div class="flash">
+          <% [ :warning, :notice, :error ].each do |f| -%>
+            <%= content_tag("div", "<p>#{flash[f]}</p>".html_safe, :class => "message #{f}") unless flash[f].nil? %>
+          <% end %>
+        </div>
+        <%= yield %>
+      </div>
+      <% if respond_to? :sidebar %>
+        <div id="sidebar">
+          <%= sidebar %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</body>
+</html>

data/example_app/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/**/*

data/example_app/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.1'
+gem 'activo-rails', :path => ".."

data/example_app/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: /Users/jon/Work/OpenSource/activo-rails
+  specs:
+    activo-rails (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.1)
+      actionpack (= 3.0.1)
+      mail (~> 2.2.5)
+    actionpack (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+    activesupport (3.0.1)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.2)
+    mail (2.2.9)
+      activesupport (>= 2.3.6)
+      i18n (~> 0.4.1)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.1)
+      actionmailer (= 3.0.1)
+      actionpack (= 3.0.1)
+      activerecord (= 3.0.1)
+      activeresource (= 3.0.1)
+      activesupport (= 3.0.1)
+      bundler (~> 1.0.0)
+      railties (= 3.0.1)
+    railties (3.0.1)
+      actionpack (= 3.0.1)
+      activesupport (= 3.0.1)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    thor (0.14.3)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activo-rails!
+  rails (= 3.0.1)