lipsiadmin 4.0.0 → 4.1.0

data/CHANGELOG

@@ -1,6 +1,15 @@
+2009-05-15
+  * Bumped version to 4.1.0
+  * Now admin can be completly translated in any languages
+  * Refactored generation of grids
+  * Improved documentation of helpers
+  * Fixed rdoc typos
+  * Imporved backend helpers and rdoc
+
 2009-05-11
   * Bumped version to 4.0.0
-  * Refactored backend.js so javascript in tabs are evalued after render so you can interact with tabs
+  * Added editable grids
+  * Refactored backend.js so javascript in tabs are evaluated after render so you can interact with tabs
   * Refactored Backend.window so now you can do much more with your grids/forms. See rdoc for examples.
   * Small refactor to attachment processor, now original attachments are saved without "_original_" in the filename.
 

data/README

@@ -28,12 +28,12 @@ Haml 2+
   
 Then in your config/environment.rb
   
-  config.gem "lipsiadmin", :version => "< 4.0"
+  config.gem "lipsiadmin", :version => "< 5.0"
   
 Why we need to specify version?
 
-Simply because we mantain backward compatibility until a 4.0 version.
-This mean that before v 4.0 we only do small improvemets, bug fix, doc etc...
+Simply because we mantain backward compatibility until a 5.0 version.
+This mean that before v 5.0 we only do small improvemets, bug fix, doc etc...
 
 If you want install the edge version you can simply do:
 
@@ -52,6 +52,7 @@ So you can do:
   $ script/generate backend # Generate the base admin
   $ script/generate backend_page yourmodel # Generate a "scaffold" for your model
   $ script/generate state_session # Create a "scaffold" for store extjs grid settings in db
+  $ script/generate loops # Generate background workers
   $ script/generate frontend # Generate the base frontend
   $ script/generate attachment # Generate the an attachments
   $ script/generate pdf PdfName # Generate a new pdf document

data/lib/access_control/base.rb

@@ -155,9 +155,9 @@ module Lipsiadmin
         return @allowed.uniq
       end
       
-      # Return the original name or try to humanize the symbol
+      # Return the original name or try to translate or humanize the symbol
       def human_name
-        return @name.is_a?(Symbol) ? @name.to_s.humanize : @name
+        return @name.is_a?(Symbol) ? I18n.t("backend.menus.#{@name}", :default => @name.to_s.humanize) : @name
       end
       
       # Return a unique id for the given project module
@@ -167,9 +167,9 @@ module Lipsiadmin
       
       # Return ExtJs Config for this project module
       def config
-        options = @options.merge(:id => uid, :text => human_name)
+        options = @options.merge(:text => human_name)
         options.merge!(:menu => @menus.collect(&:config)) if @menus.size > 0
-        options.merge!(:handler =>  ActiveSupport::JSON::Variable.new("function(){ Backend.app.load('#{url_for(@url.merge(:only_path => true))}') }")) if @url
+        options.merge!(:handler =>  "function(){ Backend.app.load('#{url_for(@url.merge(:only_path => true))}') }".to_l) if @url
         return options
       end
     end
@@ -202,9 +202,9 @@ module Lipsiadmin
         return @allowed.uniq
       end
       
-      # Return the original name or try to humanize the symbol
+      # Return the original name or try to translate or humanize the symbol
       def human_name
-        return @name.is_a?(Symbol) ? @name.to_s.humanize : @name
+        return @name.is_a?(Symbol) ? I18n.t("backend.menus.#{@name}", :default => @name.to_s.humanize) : @name
       end
       
       # Return a unique id for the given project module
@@ -214,9 +214,9 @@ module Lipsiadmin
       
       # Return ExtJs Config for this menu
       def config
-        options = @options.merge(:id => uid, :text => human_name)
+        options = @options.merge(:text => human_name)
         options.merge!(:menu => @items.collect(&:config)) if @items.size > 0
-        options.merge!(:handler =>  ActiveSupport::JSON::Variable.new("function(){ Backend.app.load('#{url_for(@url.merge(:only_path => true))}') }")) if @url
+        options.merge!(:handler => "function(){ Backend.app.load('#{url_for(@url.merge(:only_path => true))}') }".to_l) if @url
         return options
       end
     end

data/lib/controller/ext.rb

@@ -10,6 +10,7 @@ module Lipsiadmin
       #       @column_store = column_store_for Debtor do |cm|
       #         cm.add :id          
       #         cm.add "full_name_or_company.upcase",   "Full Name",      :sortable => true, :dataIndex => :company
+      #         cm.add :surname  # Header will be autogenerated
       #         cm.add :email,                          "Email",          :sortable => true
       #         cm.add :piva,                           "Piva",           :sortable => true
       #         cm.add :created_at,                     "Creato il",      :sortable => true, :renderer => :date, :align => :right
@@ -62,14 +63,18 @@ module Lipsiadmin
         end
 
         # Method for add columns to the Column Model
-        def add(method, header=nil, options={})
-          options[:method]      = method
-           # Setting hidden and removing query for 
-          # items that don't have headers
-          if header.blank?
-            options[:hidden]  = true
-            options[:query]   = false
-          end
+        def add(*args)
+          options = { :method => args[0] }
+          options[:header]     = args[1].is_a?(String) || args[1].is_a?(Symbol) ? args[1].to_s : nil
+          
+          args.each { |a| options.merge!(a) if a.is_a?(Hash)  }
+          
+          # Add some defaults
+          options[:header]   ||= options[:method].to_s
+          options[:sortable] ||= true
+          
+          # Try to translate header
+          options[:header] = @model.human_attribute_name(options[:header].to_s)
           
           # Reformat DataIndex
           if options[:dataIndex].is_a?(Array)
@@ -101,9 +106,6 @@ module Lipsiadmin
                                                                   gsub(/-+$/, '_').
                                                                   gsub(/^-+$/, '_')
 
-          # Reformat header
-          options[:header] = header || options[:dataIndex].to_s.humanize
-
           @data << options
         end
 
@@ -158,13 +160,6 @@ module Lipsiadmin
           end
         end
 
-        # Returns an object whose <tt>to_json</tt> evaluates to +code+. Use this to pass a literal JavaScript 
-        # expression as an argument to another JavaScriptGenerator method.
-        #
-        def literal(code)
-          ActiveSupport::JSON::Variable.new(code.to_s)
-        end
-        alias_method :l, :literal
       end
     end
   end

data/lib/version.rb

@@ -1,7 +1,7 @@
 module Lipsiadmin
   module VERSION #:nodoc:
     MAJOR = 4
-    MINOR = 0
+    MINOR = 1
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/view/helpers/backend_helper.rb

@@ -2,7 +2,7 @@ module Lipsiadmin
   module View
     module Helpers
       module BackendHelper
-        # This method work like builtin Rails error_message_for but use an Ext.Message.        
+        # This method work like builtin Rails error_message_for but use an Ext.Message.show({..})
         def simple_error_messages_for(*params)
           options = params.last.is_a?(Hash) ? params.pop.symbolize_keys : {}
           objects = params.collect {|object_name| instance_variable_get("@#{object_name}") }.compact
@@ -20,21 +20,132 @@ module Lipsiadmin
           end
         end
         
-        # This method add tab for in your view
+        # This method add tab for in your view.
+        # 
+        # First argument is the name and title of the tab, an interesting thing wose that this helper 
+        # try to translate itself to your current locale ex:
+        # 
+        #   # Look for: I18n.t("backend.tabs.settings", :default => "Settings")
+        #   tab :settings do
+        #     ...
+        # 
+        # The second argument specify if is necessary 10px of padding inside the tab, default is +true+
+        # 
+        # Third argument is an hash that accepts:
+        # 
+        # <tt>:id</tt>::    The id of the tab
+        # <tt>:style</tt>:: Custom style of the tab
+        # 
         def tab(name, padding=true, options={}, &block)
-          options[:id]   ||= name.to_s.downcase.gsub(/[^a-z0-9]+/, '_').gsub(/-+$/, '').gsub(/^-+$/, '')
-          options[:style]  = "padding:10px;#{options[:style]}" if padding
-          options[:title]  = name
+          options[:id]    ||= name.to_s.downcase.gsub(/[^a-z0-9]+/, '_').gsub(/-+$/, '').gsub(/^-+$/, '')
+          options[:style] ||= "padding:10px;#{options[:style]}" if padding
+          options[:title]  = I18n.t("backend.tabs.#{name.to_s.downcase}", :default => name.to_s.humanize)
           options[:tabbed] = true
           options[:class]  = "x-hide-display"
           concat content_tag(:div, capture(&block), options)
         end
         
-        # Set the title of the page
+        # Set the title of the page.
+        # 
+        # An interesting thing wose that this helper 
+        # try to translate itself to your current locale ex:
+        # 
+        #   # Look for: I18n.t("backend.titles.welcome_here", :default => "Welcome Here")
+        #   title :welcome_here
+        # 
         def title(title)
+          title = I18n.t("backend.titles.#{title.to_s.downcase}", :default => title.to_s.humanize)
           content_tag(:script, "Backend.app.setTitle(#{title.to_json})", :type => Mime::JS)
         end
         
+        # Get the title for grids of the specified model based on your
+        # current locale.
+        # 
+        # The locale file for this translation is located: config/locales/backend
+        # 
+        #   # Generate: List all Accounts
+        #   list_title_for(Account)
+        # 
+        #   # Generate: List all My Accounts
+        #   list_title_for("My Accounts")
+        # 
+        def list_title_for(text)
+          I18n.t("backend.general.list", :model => text.is_a?(String) ? text : text.send(:human_name))
+        end
+        
+        # Get the title for edit action of a form based on your current locale
+        # 
+        # The locale file for this translation is located: config/locales/backend
+        # 
+        #   # Generate: Edit Account 18
+        #   edit_title_for(Account, @account.id)
+        #   
+        #   # Generate: Edit My Account Foo Bar
+        #   edit_title_for("My Account", @account.full_name)
+        # 
+        def edit_title_for(text, value)
+          title I18n.t("backend.general.editForm", :model => text.is_a?(String) ? text : text.send(:human_name), :value => value)
+        end
+
+        # Get the title for new action of a form based on your current locale
+        # 
+        # The locale file for this translation is located: config/locales/backend
+        # 
+        #   # Generate: New Account
+        #   new_title_for(Account)
+        #   
+        #   # Generate: New My Account
+        #   new_title_for("My Account")
+        # 
+        def new_title_for(text)
+          title I18n.t("backend.general.newForm", :model => text.is_a?(String) ? text : text.send(:human_name))
+        end
+        
+        # Try to translate the given word
+        # 
+        #   # Generate: I18n.t("backend.labels.add", :default => "Add")
+        #   tl("Add")
+        # 
+        def translate_label(text)
+          I18n.t("backend.labels.#{text.to_s.downcase.gsub(/\s/, "_")}", :default => text.to_s.humanize)
+        end
+        alias_method :tl, :translate_label
+
+        # Try to translate the given pharse
+        # 
+        #   # Generate: I18n.t("backend.labels.lipsiadmin_is_beautifull", :default => "Lipsiadmin is beautifull")
+        #   tt("Lipsiadmin is beautifull")
+        # 
+        def translate_text(text)
+          I18n.t("backend.texts.#{text.to_s.downcase.gsub(/\s/, "_")}", :default => text.to_s.humanize)
+        end
+        alias_method :tt, :translate_text
+        
+        # Return the translated attribute based on your current locale
+        # 
+        #   # In config/locales/backend/models/en.yml
+        #   en:
+        #     activerecord:
+        #       attributes:
+        #         account:
+        #           name: "Account Name"
+        #           suranme: "Custom Title For Surname"
+        #           role: "Im a"
+        #   
+        #   # Generates: 
+        #   #   Account Name
+        #   #   Custom Title For Surname
+        #   #   Im a
+        #   #   Attribute not translated
+        #   human_name_for :account, :name
+        #   human_name_for :account, :surname
+        #   human_name_for :account, :role
+        #   human_name_for :account, :attribute_not_translated
+        # 
+        def human_name_for(instance, method)
+          I18n.t("activerecord.attributes.#{instance}.#{method}", :default => method.to_s.humanize)
+        end
+        
         # Store the location to come back from for example an extjs grid
         def back_to(location)
           content_tag(:script, "Backend.app.backTo(#{url_for(location)})", :type => Mime::JS)
@@ -43,7 +154,7 @@ module Lipsiadmin
         # Generate the menu from the Lispiadmin::AccessControl
         def backend_menu
           config = current_account.maps.collect(&:project_modules)[0].collect(&:config)
-          config << { :text => "Backend.locale.buttons.help".to_l, :handler => "function() { Backend.app.openHelp() }".to_l }
+          config << { :text => I18n.t("backend.menus.help", :default => "Help"), :handler => "function() { Backend.app.openHelp() }".to_l }
           return config.to_json
         end
         

data/lipsiadmin_generators/backend/templates/config/locales/backend/en.yml

@@ -1,14 +1,23 @@
 # If you translate this other language or have something to fix please send me an email at: d.dagostino@lipsiasoft.com
 en:
   backend:
+    tabs:
+      general: "General"
+    titles:
+      welcome: "Welcome"
     general:
+      list: "List {{model}}"
       editForm: "Edit {{model}} {{value}}"
       newForm: "New {{model}}"
       cantDelete: "You cannot delete this record."
     sessions:
       wrong: "Wrong email or password"
       logout: "Correctly Logged Out"
-      
+    menus:
+      account: "Account"
+      list: "List"
+      new: "New"
+      help: "Help"
     javascripts:
       buttons:
         add: "Add"

data/lipsiadmin_generators/backend/templates/config/locales/backend/it.yml

@@ -1,13 +1,22 @@
 it:
   backend:
+    tabs:
+      general: "Generale"
+    titles:  
+      welcome: "Benvenuto"
     general:
+      list: "Elenco {{model}}"
       editForm: "Modifica {{model}} {{value}}"
-      newForm: "Nuova {{model}}"
+      newForm: "Nuovo {{model}}"
       cantDelete: "Non puoi cancellare questo record."
     sessions:
       wrong: "Email o password sbagliati"
       logout: "Sei correttamente uscito dal sistema"
-
+    menus:
+      help: "Aiuto"
+      account: "Account"
+      list: "Elenco"
+      new: "Nuovo"
     javascripts:
       buttons:
         add: "Aggiungi"

data/lipsiadmin_generators/backend/templates/config/locales/models/it.yml

@@ -1,15 +1,15 @@
 # Questo file è utizzato per tradurre il nome dei modell/tabelle e dei suoi attributi/colonne
 it:
   activerecord:
-    # Translate model names. Used in Model.human_name().
-    #models:
-      # For example,
-      #   user: "Dude"
-      # will translate User model name to "Dude"
-    
-    # Translate model attribute names. Used in Model.human_attribute_name(attribute).
-    #attributes:
-      # For example,
-      #   user:
-      #     login: "Handle"
-      # will translate User attribute "login" as "Handle"
+    models:
+      account: Account
+    attributes:
+      account:
+        name: Nome
+        surname: Cognome
+        created_at: Creato Il
+        updated_at: Aggiornato Il
+        role: Gruppo
+        password_confirmation: Conferma Password
+        created_at: Creato il
+        updated_at: Aggiornato il  

data/lipsiadmin_generators/backend/templates/controllers/backend/accounts_controller.rb

@@ -2,11 +2,11 @@ class Backend::AccountsController < BackendController
   def index
     params[:limit] ||= 50
     @column_store = column_store_for Account do |cm|
-      cm.add :name,         "Name",           :sortable => true
-      cm.add :surname,      "Surname",        :sortable => true
-      cm.add :email,        "Email",          :sortable => true
-      cm.add :created_at,   "Created at",     :sortable => true, :renderer => :datetime, :align => :right
-      cm.add :updated_at,   "Updated at",     :sortable => true, :renderer => :datetime, :align => :right
+      cm.add :name
+      cm.add :surname
+      cm.add :email
+      cm.add :created_at, :renderer => :datetime, :align => :right
+      cm.add :updated_at, :renderer => :datetime, :align => :right
     end
     
     respond_to do |format|

data/lipsiadmin_generators/backend/templates/models/account_access.rb

@@ -2,9 +2,22 @@ class AccountAccess < Lipsiadmin::AccessControl::Base
 
   roles_for :administrator do |role|
     # Shared Permission
+    role.allow_all_actions "/backend"
     role.allow_all_actions "/backend/base"
     
-    role.project_module :Account do |project|
+    # Remember that it will try to translate the menu in your current
+    # locale
+    # 
+    #   # Look for: I18n.t("backend.menus.account") in /config/locales/backend/yourlocale.yml
+    #   project_module :account
+    #   # Look for: I18n.t("backend.menus.list") in /config/locales/backend/yourlocale.yml
+    #   project.menu :list
+    # 
+    # It not necessary have a translation you can provide a classic strings like:
+    # 
+    #   role.project_module "My Menu Name"
+    # 
+    role.project_module :account do |project|
       project.menu :list,   "/backend/accounts.js" do |submenu|
         submenu.add :new, "/backend/accounts/new"
       end

data/lipsiadmin_generators/backend/templates/views/backend/accounts/_form.html.haml

@@ -1,21 +1,21 @@
 =simple_error_messages_for :account
--tab "General" do
+-tab :general do
   %table
     %tr
-      %td Name
+      %td=human_name_for :account, :name
       %td=text_field :account, :name
     %tr
-      %td Surname
+      %td=human_name_for :account, :surname
       %td=text_field :account, :surname
     %tr
-      %td Email
+      %td=human_name_for :account, :email
       %td=text_field :account, :email
     %tr
-      %td Password
+      %td=human_name_for :account, :password
       %td=password_field :account, :password
     %tr
-      %td Password Confirmation
+      %td=human_name_for :account, :password_confirmation
       %td=password_field :account, :password_confirmation
     %tr
-      %td Role
+      %td=human_name_for :account, :role
       %td=select :account, :role, AccountAccess.roles

data/lipsiadmin_generators/backend/templates/views/backend/accounts/edit.html.haml

@@ -1,3 +1,3 @@
-=title "Edit Account n. #{@account.id}"
+=edit_title_for(Account, @account.name)
 -form_tag({:action => :update, :id => @account}, :method => :put) do
   =render :partial => "form"

data/lipsiadmin_generators/backend/templates/views/backend/accounts/index.rjs

@@ -1,6 +1,6 @@
 page.grid do |grid|
   grid.id "grid-accounts"
-  grid.title "List All Accounts"
+  grid.title list_title_for(Account)
   grid.base_path "/backend/accounts"
   grid.forgery_protection_token request_forgery_protection_token
   grid.authenticity_token form_authenticity_token
@@ -9,6 +9,7 @@ page.grid do |grid|
     store.url "/backend/accounts.json"
     store.fields @column_store.store_fields
   end
+  grid.before << "groupingStore.setDefaultSort('accounts.created_at', 'DESC');"
   grid.columns do |columns|
     columns.fields @column_store.column_fields
   end

data/lipsiadmin_generators/backend/templates/views/backend/accounts/new.html.haml

@@ -1,3 +1,3 @@
-=title "New Account"
+=new_title_for(Account)
 -form_tag(:action => :create) do
   =render :partial => "form"

data/lipsiadmin_generators/backend_page/REMEMBER

@@ -3,5 +3,6 @@
 
 Added a new resource in routes.rb
 Added a new rules in app/models/account_access.rb
+Translate your attributes in config/locales/models
 
 ================================================================

data/lipsiadmin_generators/backend_page/templates/controller.rb

@@ -5,7 +5,7 @@ class Backend::<%= controller_class_name %>Controller < BackendController
     
     @column_store = column_store_for <%= model_name %> do |cm|
       <%- model_instance.class.content_columns.collect do |column| -%>
-      cm.add :<%= column.name.downcase %>,  "<%= model_instance.class.human_attribute_name(column.name) %>", :sortable => true<% if column.type == :date %>, :renderer => :date <% elsif column.type == :datetime %>, :renderer => :datetime <% end %>
+      cm.add :<%= column.name.downcase %><% if column.type == :date %>, :renderer => :date <% elsif column.type == :datetime %>, :renderer => :datetime <% end %>
       <%- end -%>
     end
     

data/lipsiadmin_generators/backend_page/templates/form.html.haml

@@ -1,5 +1,5 @@
 =simple_error_messages_for :<%= singular_name %>
--tab "General" do
+-tab :general do
   %table
 <%= template_for_inclusion %>
       

data/lipsiadmin_generators/backend_page/templates/view_edit.html.haml

@@ -1,3 +1,3 @@
-=title "Edit <%= model_instance.class.human_name %> n. #{@<%= singular_name %>.id}"
+=edit_title_for(<%= model_instance.class.name %>, <%= "@"+singular_name+".id" %>)
 -form_tag({:action => :update, :id => @<%= singular_name %>}, :method => :put) do
   =render :partial => "form"

data/lipsiadmin_generators/backend_page/templates/view_index.rjs.erb

@@ -1,6 +1,6 @@
 page.grid do |grid|
   grid.id "grid-<%= plural_name %>"
-  grid.title "List all <%= model_instance.class.human_name %>"
+  grid.title list_title_for(<%= model_instance.class.name %>)
   grid.base_path "/backend/<%= plural_name %>"
   grid.forgery_protection_token request_forgery_protection_token
   grid.authenticity_token form_authenticity_token

data/lipsiadmin_generators/backend_page/templates/view_new.html.haml

@@ -1,3 +1,3 @@
-=title "New <%= model_instance.class.human_name %>"
+=new_title_for(<%= model_instance.class.name %>)
 -form_tag({:action => :create}, :method => :post) do
   =render :partial => "form"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: lipsiadmin
 version: !ruby/object:Gem::Version 
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors: 
 - Davide D'Agostino
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-11 00:00:00 +02:00
+date: 2009-05-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency