web-app-theme 0.5.3 → 0.6.0

data/.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
-pkg
+pkg
+web-app-theme-*.gem

data/README.md

@@ -8,13 +8,12 @@ it wants to be an idea to start developing a complete web application layout.
 Installation
 ------------
 
-Install the gem with:
+You can use web-app-theme >= 0.6.0 with Rails 3. If you want to use it with rails 2, use web-app-theme 0.5.3
+Specify the web-app-theme gem in your Gemfile, only for :development and :test
 
-    sudo gem install web-app-theme -s http://gemcutter.org
-  
-You can also install it as a rails plugin:
-
-    script/plugin install git://github.com/pilu/web-app-theme.git
+    group :development, :test do
+      gem 'web-app-theme', '>= 0.6.0'
+    end
 
 Usage
 -----
@@ -22,33 +21,33 @@ Usage
 ### Theme Generator
 
 Used without parameters, it generates the layout inside the application.html.erb file using the default theme.
-  
-    script/generate theme
+
+    rails g web_app_theme:theme
 
 You can specify the layout file name in the first parameter:
 
-    script/generate theme admin # it will generate a layout called `admin.html.erb`
+    rails g web_app_theme:theme admin # it will generate a layout called `admin.html.erb`
 
 If you want to use another theme, instead of the default, you can use the `--theme` option:
 
-    script/generate theme --theme="drastic-dark"
+    rails g web_app_theme:theme admin --theme="drastic-dark"
 
 You can specify the template engine with `--engine=name` option, where name can be erb (default) or haml:
 
-    script/generate theme --engine=haml
+    rails g web_app_theme:theme --engine=haml # you must specify haml in your Gemfile
 
 If you want to generate the stylesheets of a specific theme without changing the previously generated layout you can pass the `--no-layout` option:
 
-    script/generate theme --theme=bec --no_layout
+    rails g web_app_theme:theme --theme=bec --no-layout
 
 
 You can specify the text used in the header with the `--app-name` option:
 
-    script/generate theme --app_name="My New Application"
+    rails g web_app_theme:theme --app-name="My New Application"
   
 If you need a layout for login and signup pages, you can use the `--type` option with `sign` as value. Ìf not specified, the default value is `administration`
 
-    script/generate theme --type=sign
+    rails g web_app_theme:theme sign --layout-type=sign
 
 ### Themed Generator
 
@@ -56,43 +55,44 @@ Start creating your controllers manually or with a scaffold, and then use the `t
 
 If you have a controller named like the plural of the used model you can specify just the first parameter:
 
-    script/generate themed posts # you have a model named Post and a controller named PostsController
+    rails g web_app_theme:themed posts # you have a model named Post and a controller named PostsController
     
-    script/generate themed admin/gallery_pictures # you have a model named GalleryPicture and a controller named Admin::GalleryPicturesController
+    rails g web_app_theme:themed admin/gallery_pictures # you have a model named GalleryPicture and a controller named Admin::GalleryPicturesController
 
 Use the `--layout` option specifying the previously generated layout to add a link to the controller you are working on:
 
-    script/generate themed posts --layout=admin # you will see the `Posts` link in the navigation
+    rails g web_app_theme:themed posts --layout=admin # you will see the `Posts` link in the navigation
 
 If the controller has a name different to the model used, specify the controller path in the first parameter and the model name in the second one:
 
-    script/generate themed items post
+    rails g web_app_theme:themed items post
     
-    script/generate themed admin/items post
+    rails g web_app_theme:themed admin/items post
 
 If you use `will_paginate` for pagination use the `--with_will_paginate`:
 
-    script/generate themed items post --with_will_paginate        
+    rails g web_app_theme:themed items post --will-paginate
 
 You can specify the template engine with `--engine=name` option, where name can be erb (default) or haml:
 
-    script/generate themed posts --engine=haml
+    rails g web_app_theme:themed posts --engine=haml
 
 If you have something like `map.resource :dashboard` in your `routes.rb` file, you can use the `--type=text` to generate a view with just text:
     
-    script/generate themed homes --type=text
+    rails g web_app_theme:themed dashboards --themed-type=text
 
 If you want to show form error messages inside the generated forms, use the following code inside your `environment.rb`
 
     ActionView::Base.field_error_proc = Proc.new do |html_tag, instance| 
       if html_tag =~ /<label/
-        %|<div class="fieldWithErrors">#{html_tag} <span class="error">#{[instance.error_message].join(', ')}</span></div>|
+        %|<div class="fieldWithErrors">#{html_tag} <span class="error">#{[instance.error_message].join(', ')}</span></div>|.html_safe
       else
         html_tag
       end
     end
 
 If you want to have translated pages, simple create in your locale.yml the keys just like config/locales/en_us.yml example.
+
 	en_us:
 	  web-app-theme: 
 	    save: Save
@@ -150,6 +150,7 @@ Contributors
 * Roberto Klein
 * Bryan Woods
 * Sandro Duarte
+* David Francisco
 
 Credits
 -------

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.6.0

data/index.html

@@ -344,6 +344,7 @@
           <h3>Switch Theme</h3>
           <ul class="navigation">
             <li><a href="#" onclick="Theme.activate('default'); return false;">Default</a></li>
+            <li><a href="#" onclick="Theme.activate('activo'); return false;">Activo</a></li>
             <li><a href="#" onclick="Theme.activate('amro'); return false;">Amro</a></li>
             <li><a href="#" onclick="Theme.activate('bec'); return false;">Bec</a></li>
             <li><a href="#" onclick="Theme.activate('bec-green'); return false;">Bec-Green</a></li>

data/{rails_generators/theme/templates/view_layout_administration.html.erb → lib/generators/web_app_theme/theme/templates/layout_admin.html.erb}

@@ -1,21 +1,22 @@
-<!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">
+<!DOCTYPE html>
+<html>
 <head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <title><%= options[:app_name] %></title>
-  <%%= stylesheet_link_tag "web_app_theme", "web_app_theme_override", "themes/<%= options[:theme] %>/style", :cache => true %>
+  <title><%= options.app_name %></title>
+  <%%= stylesheet_link_tag "web-app-theme/base", "web-app-theme/themes/<%= options.theme %>/style", "web-app-theme/override", :cache => true %>
+  <%%= javascript_include_tag :defaults, :cache => true %>
+  <%%= csrf_meta_tag %>
 </head>
 <body>
   <div id="container">
     <div id="header">
-      <h1><a href="/"><%= options[:app_name] %></a></h1>
+      <h1><a href="/"><%= options.app_name %></a></h1>
       <div id="user-navigation">
         <ul class="wat-cf">
           <li><a href="#"><%%= t("web-app-theme.profile", :default => "Profile") %></a></li>
           <li><a href="#"><%%= t("web-app-theme.settings", :default => "Settings") %></a></li>
           <li><a href="/logout" class="logout"><%%= t("web-app-theme.logout", :default => "Logout") %></a></li>
         </ul>
-      </div>      
+      </div>
       <div id="main-navigation">
         <ul class="wat-cf"></ul>
       </div>
@@ -32,7 +33,7 @@
         <%%= yield %>
         <div id="footer">
           <div class="block">
-            <p>Copyright &copy; <%%= Time.now.year %> <%= options[:app_name] %>.</p>
+            <p>Copyright &copy; <%%= Time.now.year %> <%= options.app_name %>.</p>
           </div>      
         </div>
       </div>

data/lib/generators/web_app_theme/theme/templates/layout_sign.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= options.app_name %></title>
+  <%%= stylesheet_link_tag "web-app-theme/base", "web-app-theme/themes/<%= options.theme %>/style", "web-app-theme/override", :cache => true %>
+  <%%= csrf_meta_tag %>
+</head>
+<body>
+  <div id="container">
+    <div id="box">
+      <%%= yield %>            
+    </div>
+  </div>
+</body>
+</html>

data/lib/generators/web_app_theme/theme/theme_generator.rb

@@ -0,0 +1,61 @@
+module WebAppTheme
+  class ThemeGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    
+    argument :layout_name, :type => :string, :default => 'application'
+    
+    class_option :theme,        :type => :string,   :default => :default,   :desc => 'Specify the layout theme'
+    class_option :app_name,     :type => :string,   :default => 'Web App',  :desc => 'Specify the application name'
+    class_option :engine,       :type => :string,   :default => 'erb',      :desc => 'Specify the template engine'
+    class_option :no_layout,    :type => :boolean,  :default => false,      :desc => 'Use this option if you want to generate only stylesheets'
+    class_option :layout_type,  :type => :string,   :default => 'admin',    :desc => 'Layout type, admin or sign'
+    
+    def copy_layout
+      return if options.no_layout      
+      admin_layout_name = options.layout_type == 'sign' ? "layout_sign.html.erb" : "layout_admin.html.erb"
+      case options.engine
+      when 'erb'
+        template  admin_layout_name, "app/views/layouts/#{layout_name.underscore}.html.erb"
+      when 'haml'
+        generate_haml_layout(admin_layout_name)        
+      end                  
+    end
+
+    def copy_base_stylesheets
+      copy_file "#{stylesheets_path}/base.css",     "public/stylesheets/web-app-theme/base.css"
+      copy_file "#{stylesheets_path}/override.css", "public/stylesheets/web-app-theme/override.css"
+    end
+    
+    def copy_theme_stylesheets
+      directory "#{stylesheets_path}/themes/#{options.theme}", "public/stylesheets/web-app-theme/themes/#{options.theme}"
+    end
+    
+    def copy_images
+      directory "#{images_path}", "public/images/web-app-theme"
+    end
+    
+  protected
+  
+    def stylesheets_path
+      "../../../../../stylesheets"
+    end
+    
+    def images_path
+      "../../../../../images"
+    end
+    
+    def generate_haml_layout(admin_layout_name)
+      require 'haml'
+      Dir.mktmpdir('web-app-theme-haml') do |haml_root|
+        tmp_html_path = "#{haml_root}/#{admin_layout_name}"
+        tmp_haml_path = "#{haml_root}/#{admin_layout_name}.haml"
+        template admin_layout_name, tmp_html_path, :verbose => false
+        `html2haml -r #{tmp_html_path} #{tmp_haml_path}`
+        copy_file tmp_haml_path, "app/views/layouts/#{layout_name.underscore}.html.haml"
+      end
+    rescue LoadError
+      say "HAML is not installed, or it is not specified in your Gemfile."
+      exit
+    end
+  end
+end

data/{rails_generators → lib/generators/web_app_theme}/themed/templates/view_edit.html.erb

@@ -9,7 +9,7 @@
   <div class="content">            
     <h2 class="title"><%%= t("web-app-theme.edit", :default => "Edit") %> <%= model_name %></h2>
     <div class="inner">
-      <%% form_for @<%= model_name.underscore  %>, :url => <%= singular_controller_routing_path %>_path(@<%= resource_name %>), :html => { :class => :form } do |f| -%>
+      <%%= form_for @<%= model_name.underscore  %>, :url => <%= singular_controller_routing_path %>_path(@<%= resource_name %>), :html => { :class => :form } do |f| -%>
         <%%= render :partial => "form", :locals => {:f => f} %>
       <%% end -%>
     </div>

data/{rails_generators → lib/generators/web_app_theme}/themed/templates/view_form.html.erb

@@ -7,7 +7,7 @@
 <%- end -%>        
 <div class="group navform wat-cf">
   <button class="button" type="submit">
-    <%%= image_tag("web-app-theme/tick.png", :alt => "#{t("web-app-theme.save", :default => "Save")}") %> <%%= t("web-app-theme.save", :default => "Save") %>
+    <%%= image_tag("web-app-theme/icons/tick.png", :alt => "#{t("web-app-theme.save", :default => "Save")}") %> <%%= t("web-app-theme.save", :default => "Save") %>
   </button>  
-  <%%= link_to "#{image_tag("web-app-theme/cross.png", :alt => "#{t("web-app-theme.cancel", :default => "Cancel")}")} #{t("web-app-theme.cancel", :default => "Cancel")}", <%= controller_routing_path %>_path, :class => "button" %> 
+  <%%= link_to image_tag("web-app-theme/icons/cross.png", :alt => "#{t("web-app-theme.cancel", :default => "Cancel")}") + " " + t("web-app-theme.cancel", :default => "Cancel"), <%= controller_routing_path %>_path, :class => "button" %> 
 </div>

data/{rails_generators → lib/generators/web_app_theme}/themed/templates/view_new.html.erb

@@ -8,7 +8,7 @@
   <div class="content">            
     <h2 class="title"><%%= t("web-app-theme.new", :default => "New")%>  <%= model_name %></h2>
     <div class="inner">
-      <%% form_for :<%= model_name.underscore  %>, :url => <%= controller_routing_path %>_path, :html => { :class => :form } do |f| -%>
+      <%%= form_for :<%= model_name.underscore  %>, :url => <%= controller_routing_path %>_path, :html => { :class => :form } do |f| -%>
         <%%= render :partial => "form", :locals => {:f => f} %>
       <%% end -%>
     </div>

data/{rails_generators → lib/generators/web_app_theme}/themed/templates/view_show.html.erb

@@ -15,8 +15,8 @@
         </p>
       <%- end -%>
       <div class="wat-cf">
-        <%%= link_to "#{image_tag("web-app-theme/application_edit.png", :alt => "#{t("web-app-theme.edit", :default=> "Edit")}")} #{t("web-app-theme.edit", :default=> "Edit")}", edit_<%= singular_controller_routing_path %>_path(@<%= resource_name %>), :class => "button" %> 
-        <%%= link_to "#{image_tag("web-app-theme/cross.png", :alt => "#{t("web-app-theme.delete", :default=> "Delete")}")} #{t("web-app-theme.delete", :default => "Delete")}", <%= singular_controller_routing_path %>_path(@<%= resource_name %>), :method => "delete", :class => "button", :confirm => "#{t("web-app-theme.confirm", :default => "Are you sure?")}" %>
+        <%%= link_to image_tag("web-app-theme/icons/application_edit.png", :alt => "#{t("web-app-theme.edit", :default=> "Edit")}") + " " + t("web-app-theme.edit", :default=> "Edit"), edit_<%= singular_controller_routing_path %>_path(@<%= resource_name %>), :class => "button" %> 
+        <%%= link_to image_tag("web-app-theme/icons/cross.png", :alt => "#{t("web-app-theme.delete", :default=> "Delete")}") + " " + t("web-app-theme.delete", :default => "Delete"), <%= singular_controller_routing_path %>_path(@<%= resource_name %>), :method => "delete", :class => "button", :confirm => "#{t("web-app-theme.confirm", :default => "Are you sure?")}" %>
       </div>      
     </div>
   </div>

data/{rails_generators → lib/generators/web_app_theme}/themed/templates/view_tables.html.erb

@@ -43,7 +43,7 @@
       <div class="actions-bar wat-cf">
         <div class="actions">
         </div>
-        <% if options[:will_paginate] %>
+        <% if options.will_paginate %>
         <%%= will_paginate @<%= plural_resource_name %>  %>
         <% end %>
       </div>

data/lib/generators/web_app_theme/themed/themed_generator.rb

@@ -0,0 +1,126 @@
+require 'rails/generators/generated_attribute'
+
+module WebAppTheme
+  class ThemedGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+        
+    argument :controller_path,  :type => :string
+    argument :model_name,       :type => :string, :required => false    
+    
+    class_option :layout,         :type => :string,   :desc => 'Specify the layout name'
+    class_option :engine,         :type => :string,   :default => 'erb', :desc => 'Specify the template engine'
+    class_option :will_paginate,  :type => :boolean,  :default => false, :desc => 'Specify if you use will_paginate'
+    class_option :themed_type,    :type => :string,   :default => 'crud', :desc => 'Specify the themed type, crud or text. Default is crud'
+    
+    def initialize(args, *options)
+      super(args, *options)
+      initialize_views_variables
+    end
+    
+    def copy_views
+      generate_views      
+      unless options.layout.blank?
+        gsub_file(File.join('app/views/layouts', "#{options[:layout]}.html.#{options.engine}"), /\<div\s+id=\"main-navigation\">.*\<\/ul\>/mi) do |match|
+          match.gsub!(/\<\/ul\>/, "")
+          if @engine.to_s =~ /haml/
+            %|#{match}
+          %li{:class => controller.controller_path == '#{@controller_file_path}' ? 'active' : '' }
+            %a{:href => #{controller_routing_path}_path} #{plural_model_name}
+          </ul>|
+          else
+            %|#{match} <li class="<%= controller.controller_path == '#{@controller_file_path}' ? 'active' : '' %>"><a href="<%= #{controller_routing_path}_path %>">#{plural_model_name}</a></li></ul>|
+          end
+        end
+      end
+    end
+
+  protected
+    
+    def initialize_views_variables
+      @base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(controller_path)
+      @controller_routing_path = @controller_file_path.gsub(/\//, '_')
+      @model_name = @base_name.singularize unless @model_name
+      @model_name = @model_name.camelize
+    end
+    
+    def controller_routing_path
+      @controller_routing_path
+    end
+    
+    def singular_controller_routing_path
+      @controller_routing_path.singularize
+    end
+    
+    def model_name
+      @model_name
+    end
+    
+    def plural_model_name
+      @model_name.pluralize
+    end
+    
+    def resource_name
+      @model_name.underscore
+    end
+    
+    def plural_resource_name
+      resource_name.pluralize
+    end
+    
+    def columns
+      excluded_column_names = %w[id created_at updated_at]
+      Kernel.const_get(@model_name).columns.reject{|c| excluded_column_names.include?(c.name) }.collect{|c| Rails::Generators::GeneratedAttribute.new(c.name, c.type)}
+    end
+    
+    def extract_modules(name)
+      modules = name.include?('/') ? name.split('/') : name.split('::')
+      name    = modules.pop
+      path    = modules.map { |m| m.underscore }
+      file_path = (path + [name.underscore]).join('/')
+      nesting = modules.map { |m| m.camelize }.join('::')
+      [name, path, file_path, nesting, modules.size]
+    end
+    
+    def generate_views
+      views = {
+        'crud' => {
+          'view_tables.html.erb'  => File.join('app/views', @controller_file_path, "index.html.#{options.engine}"),
+          'view_new.html.erb'     => File.join('app/views', @controller_file_path, "new.html.#{options.engine}"),
+          'view_edit.html.erb'    => File.join('app/views', @controller_file_path, "edit.html.#{options.engine}"),
+          'view_form.html.erb'    => File.join('app/views', @controller_file_path, "_form.html.#{options.engine}"),
+          'view_show.html.erb'    => File.join('app/views', @controller_file_path, "show.html.#{options.engine}"),
+          'view_sidebar.html.erb' => File.join('app/views', @controller_file_path, "_sidebar.html.#{options.engine}")
+        },
+        'text' => {
+          'view_text.html.erb'    => File.join('app/views', @controller_file_path, "show.html.#{options.engine}"),
+          'view_sidebar.html.erb' => File.join('app/views', @controller_file_path, "_sidebar.html.#{options.engine}")
+        }
+      }
+      selected_views = views[options.themed_type]
+      options.engine == 'haml' ? generate_haml_views(selected_views) : generate_erb_views(selected_views)
+    end
+    
+    def generate_erb_views(views)
+      views.each do |template_name, output_path|
+        template template_name, output_path
+      end
+    end
+    
+    def generate_haml_views(views)
+      require 'haml'
+      Dir.mktmpdir('web-app-theme-haml') do |haml_root|
+        views.each do |template_name, output_path|
+          tmp_html_path = "#{haml_root}/#{template_name}"
+          tmp_haml_path = "#{haml_root}/#{template_name}.haml"
+          template template_name, tmp_html_path, :verbose => false
+          `html2haml -r #{tmp_html_path} #{tmp_haml_path}`
+          copy_file tmp_haml_path, output_path
+        end
+      end
+      
+    rescue LoadError
+      say "HAML is not installed, or it is not specified in your Gemfile."
+      exit
+    end
+  end
+end