hobo 1.3.0.pre19 → 1.3.0.pre20

data/lib/generators/hobo/rapid/templates/themes/clean/views/clean.dryml

@@ -7,4 +7,4 @@
       <stylesheet name="application" param="app-stylesheet"/>
     </stylesheets:>
   </old-page>
-</extend>  
+</extend>

data/lib/generators/hobo/setup_wizard/setup_wizard_generator.rb

@@ -78,6 +78,17 @@ module Hobo
                                     :update => true
     end
 
+    def user_options
+      if wizard?
+        say_title 'User Resource'
+        @user_resource_name = ask("Choose a name for the user resource [<enter>=user|<custom_name>]:", 'user')
+        @activation_email = @invite_only ? false : yes_no?("Do you want to send an activation email to activate the user?")
+      else
+        @user_resource_name = options[:user_resource_name]
+        @activation_email = options[:activation_email]
+      end
+    end
+
     def site_options
       if wizard?
         say_title 'Invite Only Option'
@@ -99,8 +110,8 @@ NOTE: You might want to sign up as the administrator before adding this!
       end
       inject_into_file 'app/controllers/application_controller.rb', <<EOI, :after => "protect_from_forgery\n" if private_site
   include Hobo::Controller::AuthenticationSupport
-  before_filter :except => :login do
-     login_required unless User.count == 0
+  before_filter :except => [:login, :forgot_password] do
+     login_required unless #{@user_resource_name.camelize}.count == 0
   end
 EOI
     end
@@ -113,17 +124,6 @@ EOI
       invoke 'hobo:rapid'
     end
 
-    def user_options
-      if wizard?
-        say_title 'User Resource'
-        @user_resource_name = ask("Choose a name for the user resource [<enter>=user|<custom_name>]:", 'user')
-        @activation_email = @invite_only ? false : yes_no?("Do you want to send an activation email to activate the user?")
-      else
-        @user_resource_name = options[:user_resource_name]
-        @activation_email = options[:activation_email]
-      end
-    end
-
     def front_controller
       if wizard?
         say_title 'Front Controller'
@@ -201,8 +201,9 @@ EOI
         environment "config.i18n.default_locale = #{default_locale.to_sym.inspect}"
       end
       ls = (locales - %w[en]).map {|l| ":#{l}" }
+      lstr = ls.to_sentence
       invoke 'hobo:i18n', locales
-      say( "NOTICE: You should manually install in 'config/locales' also the official Rails locale #{ls.size==1 ? 'file' : 'files'} for #{ls.to_sentence} that your application will use.", Color::YELLOW) unless ls.empty?
+      say( "NOTICE: You should manually install in 'config/locales' also the official Rails locale #{ls.size==1 ? 'file' : 'files'} for #{lstr} that your application will use.", Color::YELLOW) unless ls.empty?
     end
 
     def git_repo

data/lib/generators/hobo/subsite/templates/controller.rb.erb

@@ -1,5 +1,5 @@
 class <%= subsite_name %>::<%= subsite_name %>SiteController < ApplicationController
 
   hobo_controller
-  
+
 end

data/lib/generators/hobo/user_controller/templates/controller.rb.erb

@@ -8,7 +8,7 @@ class <%= class_name %>Controller < ApplicationController
     hobo_create do
       if valid?
         self.current_user = this
-        flash[:notice] = I18n.t("hobo.messages.you_are_site_admin", :default=>"You are now the site administrator")
+        flash[:notice] = t("hobo.messages.you_are_site_admin", :default=>"You are now the site administrator")
         redirect_to home_page
       end
     end
@@ -18,7 +18,7 @@ class <%= class_name %>Controller < ApplicationController
   def do_accept_invitation
     do_transition_action :accept_invitation do
       self.current_user = this
-      flash[:notice] = I18n.t("hobo.messages.you_signed_up", :default=>"You have signed up")
+      flash[:notice] = t("hobo.messages.you_signed_up", :default=>"You have signed up")
     end
   end
 <% end -%>

data/lib/hobo.rb

@@ -17,6 +17,7 @@ module Hobo
   class Error < RuntimeError; end
   class PermissionDeniedError < RuntimeError; end
   class UndefinedAccessError < RuntimeError; end
+  class I18nError < RuntimeError; end
 
   # Empty class to represent the boolean type.
   class Boolean; end

data/lib/hobo/controller.rb

@@ -71,12 +71,12 @@ module Hobo
 
     def ajax_update_response(page_path, render_specs, results={})
       if page_path
-        rr = ActionController::Routing::Routes.recognize_path(page_path)
-        identifier = view_context.view_paths.find( rr[:action],
-                                                   rr[:controller],
+        controller, action = controller_action_from_page_path(page_path)
+        identifier = view_context.view_paths.find( action,
+                                                   controller,
                                                    false,
                                                    view_context.lookup_context.instance_variable_get('@details')).identifier
-        renderer = Dryml.page_renderer(view_context, identifier, [], rr[:controller])
+        renderer = Dryml.page_renderer(view_context, identifier, [], controller)
       end
 
       render :update do |page|
@@ -131,7 +131,7 @@ module Hobo
       results_hash = Hobo.find_by_search(query)
       all_results = results_hash.values.flatten.select { |r| r.viewable_by?(current_user) }
       if all_results.empty?
-        render :text => "<p>"+ I18n.t("hobo.live_search.no_results", :default=>["Your search returned no matches."]) + "</p>"
+        render :text => "<p>"+ t("hobo.live_search.no_results", :default=>["Your search returned no matches."]) + "</p>"
       else
         # TODO: call one tag that renders all the search results with headings for each model
         render_tags(all_results, :search_card, :for_type => true)
@@ -156,7 +156,7 @@ module Hobo
       elsif render :not_found, :status => 404
         # cool
       else
-        render(:text => I18n.t("hobo.messages.not_found", :default=>["The page you requested cannot be found."]) , :status => 404)
+        render(:text => t("hobo.messages.not_found", :default=>["The page you requested cannot be found."]) , :status => 404)
       end
     end
 

data/lib/hobo/controller/authentication_support.rb

@@ -67,7 +67,7 @@ module Hobo
           accepts.xml do
             headers["Status"]           = "Unauthorized"
             headers["WWW-Authenticate"] = %(Basic realm="Web Password")
-            render :text => I18n.t("hobo.messages.unauthenticated", :default=>["Couldn't authenticate you"]), :status => '401 Unauthorized'
+            render :text => t("hobo.messages.unauthenticated", :default=>["Couldn't authenticate you"]), :status => '401 Unauthorized'
           end
         end
         false

data/lib/hobo/controller/model.rb

@@ -552,7 +552,7 @@ module Hobo
 
 
     def create_response(new_action, options={}, &b)
-      flash_notice (ht( :"#{@this.class.name.tableize}.messages.create.success", :default=>["The #{@this.class.model_name.human} was created successfully"])) if valid?
+      flash_notice (ht( :"#{@this.class.to_s.underscore}.messages.create.success", :default=>["The #{@this.class.model_name.human} was created successfully"])) if valid?
 
       response_block(&b) or
         if valid?
@@ -566,7 +566,7 @@ module Hobo
 			errors = this.errors.full_messages.join("\n")
             wants.html { re_render_form(new_action) }
             wants.js   { render(:status => 500,
-                                :text => ht( :"#{this.class.name.pluralize.underscore}.messages.create.error", :errors=>errors,:default=>["Couldn't create the #{this.class.name.titleize.downcase}.\n #{errors}"])
+                                :text => ht( :"#{this.class.to_s.underscore}.messages.create.error", :errors=>errors,:default=>["Couldn't create the #{this.class.name.titleize.downcase}.\n #{errors}"])
                                )}
           end
         end
@@ -577,7 +577,7 @@ module Hobo
       options = args.extract_options!
 
       self.this ||= args.first || find_instance
-      changes = options[:attributes] || attribute_parameters or raise RuntimeError, I18n.t("hobo.messages.update.no_attribute_error", :default=>["No update specified in params"])
+      changes = options[:attributes] || attribute_parameters or raise RuntimeError, t("hobo.messages.update.no_attribute_error", :default=>["No update specified in params"])
       this.user_update_attributes(current_user, changes)
 
       # Ensure current_user isn't out of date
@@ -590,7 +590,7 @@ module Hobo
 
     def update_response(in_place_edit_field=nil, options={}, &b)
 
-      flash_notice (ht(:"#{@this.class.name.pluralize.underscore}.messages.update.success", :default=>["Changes to the #{@this.class.model_name.human} were saved"])) if valid?
+      flash_notice (ht(:"#{@this.class.name.to_s.underscore}.messages.update.success", :default=>["Changes to the #{@this.class.model_name.human} were saved"])) if valid?
 
       response_block(&b) or
         if valid?
@@ -617,7 +617,7 @@ module Hobo
             errors = @this.errors.full_messages.join("\n")
             wants.html { re_render_form(:edit) }
             wants.js { render(:status => 500,
-                              :text => ht(:"#{@this.class.name.pluralize.underscore}.messages.update.error",:default=>["There was a problem with that change.\n#{errors}"], :errors=>errors)
+                              :text => ht(:"#{@this.class.to_s.underscore}.messages.update.error",:default=>["There was a problem with that change.\n#{errors}"], :errors=>errors)
                              ) }
           end
         end
@@ -628,7 +628,7 @@ module Hobo
       options = args.extract_options!
       self.this ||= args.first || find_instance
       this.user_destroy(current_user)
-      flash_notice ht( :"#{model.name.pluralize.underscore}.messages.destroy.success", :default=>["The #{model.name.titleize.downcase} was deleted"])
+      flash_notice ht( :"#{model.to_s.underscore}.messages.destroy.success", :default=>["The #{model.name.titleize.downcase} was deleted"])
       destroy_response(options, &b)
     end
 
@@ -669,7 +669,7 @@ module Hobo
 			errors = this.errors.full_messages.join("\n")
             wants.html { re_render_form(name) }
             wants.js   { render(:status => 500,
-                                :text => ht(:"#{@this.class.name.pluralize.underscore}.messages.creator.error", :default=>["Couldn't do creator #{name}.\n#{errors}"], :name=>name, :errors=>errors)
+                                :text => ht(:"#{@this.class.to_s.underscore}.messages.creator.error", :default=>["Couldn't do creator #{name}.\n#{errors}"], :name=>name, :errors=>errors)
                                )}
           end
         end
@@ -711,7 +711,7 @@ module Hobo
 			errors = this.errors.full_messages.join("\n")
             wants.html { re_render_form(name) }
             wants.js   { render(:status => 500,
-                                :text => ht(:"#{@this.class.name.pluralize.underscore}.messages.transition.error", :default=>["Couldn't do transition #{name}.\n#{errors}"], :name=>name, :errors=>errors)
+                                :text => ht(:"#{@this.class.to_s.underscore}.messages.transition.error", :default=>["Couldn't do transition #{name}.\n#{errors}"], :name=>name, :errors=>errors)
                                )}
           end
         end
@@ -767,11 +767,11 @@ module Hobo
             if render :permission_denied, :status => 403
               # job done
             else
-              render :text => I18n.t("hobo.messages.permission_denied", :default=>["Permission Denied"]), :status => 403
+              render :text => t("hobo.messages.permission_denied", :default=>["Permission Denied"]), :status => 403
             end
           end
           wants.js do
-            render :text => I18n.t("hobo.messages.permission_denied", :default=>["Permission Denied"]), :status => 403
+            render :text => t("hobo.messages.permission_denied", :default=>["Permission Denied"]), :status => 403
           end
         end
       end

data/lib/hobo/controller/user.rb

@@ -62,8 +62,8 @@ module Hobo
       end
 
       login_attr = model.human_attribute_name(model.login_attribute)
-      options.reverse_merge!(:success_notice => ht(:"users.messages.login.success", :default=>["You have logged in."]),
-                             :failure_notice => ht(:"users.messages.login.error", :login=>login_attr, :default=>["You did not provide a valid #{login_attr} and password."]))
+      options.reverse_merge!(:success_notice => ht(:"#{model.to_s.underscore}.messages.login.success", :default=>["You have logged in."]),
+                             :failure_notice => ht(:"#{model.to_s.underscore}.messages.login.error", :login=>login_attr, :default=>["You did not provide a valid #{login_attr} and password."]))
 
       if request.post?
         user = model.authenticate(params[:login], params[:password])
@@ -113,7 +113,7 @@ module Hobo
     def hobo_do_signup(&b)
       do_creator_action(:signup) do
         if valid?
-          flash[:notice] = ht(:"users.messages.signup.success", :default=>["Thanks for signing up!"])
+          flash[:notice] = ht(:"#{model.to_s.underscore}.messages.signup.success", :default=>["Thanks for signing up!"])
         end
         response_block(&b) or if valid?
                                 self.current_user = this if this.account_active?
@@ -127,7 +127,7 @@ module Hobo
 
 
     def hobo_logout(options={})
-      options = options.reverse_merge(:notice => ht(:"users.messages.logout", :default=>["You have logged out."]),
+      options = options.reverse_merge(:notice => ht(:"#{model.to_s.underscore}.messages.logout", :default=>["You have logged out."]),
                                       :redirect_to => base_url)
 
       logout_current_user
@@ -155,7 +155,7 @@ module Hobo
       do_transition_action :reset_password do
         response_block(&b) or if valid?
                                 self.current_user = this
-                                flash[:notice] = ht(:"users.messages.reset_password", :default=>["Your password has been reset"])
+                                flash[:notice] = ht(:"#{model.to_s.underscore}.messages.reset_password", :default=>["Your password has been reset"])
                                 respond_to do |wants|
                                   wants.html { redirect_to(home_page) }
                                   wants.js { hobo_ajax_response }
@@ -167,7 +167,7 @@ module Hobo
 
     def hobo_update_with_account_flash(*args)
       hobo_update_without_account_flash(*args) do
-        flash[:notice] = ht(:"users.messages.update.success", :default=>["Changes to your account were saved"]) if valid? && @this == current_user
+        flash[:notice] = ht(:"#{model.to_s.underscore}.messages.update.success", :default=>["Changes to your account were saved"]) if valid? && @this == current_user
         yield if block_given?
       end
     end

data/lib/hobo/engine.rb

@@ -14,6 +14,7 @@ module Hobo
       h.rapid_generators_path = Pathname.new File.expand_path('lib/hobo/rapid/generators', Hobo.root)
       h.auto_taglibs_path = Pathname.new File.expand_path('app/views/taglibs/auto', Rails.root)
       h.read_only_file_system = !!ENV['HEROKU_TYPE']
+      h.show_translation_keys = false
     end
 
     ActiveSupport.on_load(:action_controller) do
@@ -35,6 +36,7 @@ module Hobo
 
     ActiveSupport.on_load(:action_view) do
       require 'hobo/extensions/action_view/tag_helper'
+      require 'hobo/extensions/action_view/translation_helper'
     end
 
     ActiveSupport.on_load(:before_initialize) do
@@ -44,6 +46,10 @@ module Hobo
       Dryml::DrymlGenerator.enable([h.rapid_generators_path], h.auto_taglibs_path)
     end
 
+    initializer 'hobo.i18n' do |app|
+      require 'hobo/extensions/i18n' if app.config.hobo.show_translation_keys
+    end
+
     initializer 'hobo.routes' do |app|
       h = app.config.hobo
       # generate at first boot, so no manual generation is required

data/lib/hobo/extensions/action_view/translation_helper.rb

@@ -0,0 +1,20 @@
+ActionView::Helpers::TranslationHelper.module_eval do
+
+  # we need to remove the <span> tag because it will mess up
+  # the dryml tags when ht is used in some place
+  # we redefine the method since we cannot catch the rescued exception
+  # although the only difference is the rescue block
+  def translate(key, options = {})
+    translation = I18n.translate(scope_key_by_partial(key), options.merge!(:raise => true))
+    if html_safe_translation_key?(key) && translation.respond_to?(:html_safe)
+      translation.html_safe
+    else
+      translation
+    end
+  rescue I18n::MissingTranslationData => e
+    keys = I18n.normalize_keys(I18n.locale, key, options[:scope]).join('.')
+    "[MISSING: #{keys}]"
+  end
+  alias_method :t, :translate
+
+end

data/lib/hobo/extensions/active_model/translation.rb

@@ -21,7 +21,7 @@ ActiveModel::Translation.class_eval do
     # otherwise it returns "".
     def attribute_help(attribute, options = {})
       defaults = lookup_ancestors.map do |klass|
-        :"#{self.i18n_scope}.attribute_help.#{klass.model_name.underscore}.#{attribute}"
+        :"#{self.i18n_scope}.attribute_help.#{klass.to_s.underscore}.#{attribute}"
       end
 
       defaults << :"attribute_help.#{attribute}"

data/lib/hobo/extensions/i18n.rb

@@ -0,0 +1,16 @@
+I18n.module_eval do
+  class << self
+
+    def translate_with_show_keys(key, options = {})
+      translation = translate_without_show_keys(key, options)
+      keys = normalize_keys(locale, key, options[:scope]).join('.')
+      "[#{keys}]" + translation
+    end
+    alias_method_chain :translate, :show_keys
+
+    alias_method :t_without_show_keys, :t
+    alias_method :t, :translate_with_show_keys
+
+  end
+end
+

data/lib/hobo/helper.rb

@@ -113,7 +113,7 @@ module Hobo
     def app_name(add_subsite=true)
       an = Rails.application.config.hobo.app_name
       if add_subsite && subsite
-        subsite_name = I18n.t 'hobo.admin.subsite_name', :default => subsite.titleize
+        subsite_name = t 'hobo.admin.subsite_name', :default => subsite.titleize
         an = an + " - #{subsite_name}"
       end
       an
@@ -127,7 +127,7 @@ module Hobo
 
 
     def recognize_page_path
-      ActionController::Routing::Routes.recognize_path(params[:page_path])
+      Rails.application.routes.recognize_path(params[:page_path])
     end
 
     def url_for_page_path(options={})

data/lib/hobo/helper/translations.rb

@@ -2,92 +2,73 @@ module Hobo
   module Helper
     module Translations
 
-      # --- Translation Helper --- #
-      #
-      # Uses RoR native I18n.translate.
-      #
-      # Adds some conventions for easier hobo translation.
-      # 1. Assumes the first part of the key to be a model name (e.g.: users.index.title -> user)
-      # 2. Tries to translate the model by lookup for: (e.g.: user-> activerecord.models.user)
-      # 3. Adds a default fallback to the beginning of the fallback chain
-      #    by replacing the first part of the key with "hobo" and using the translated model name
-      #    as additional attribute. This allows us to have default translations
-      #    (e.g.: hobo.index.title: "{{model}} Index")
-      #
-      # Is also used as a tag in the dryml-view files. The syntax is:
-      # <ht key="my.app">My Application</ht>
-      #   --> Will lookup the "my.app"-key for your locale and replaces the "My Application" content
-      #       if found.
-      #
-      # <ht key="my" app="Program">My Application</ht>
-      #   --> Will look up both the "my"- and "app"-key for your locale, and replaces the
-      #       "My Application" with the "my"-key contents (interpolated using the "app"-key.
-      #       sample.en.yml-file:
-      #       "no":
-      #         my: "Mitt {{app}}"
-      #       The output should be: Mitt Program
-      #
-      # The "count" option is passed to the I18n.t method as is
-      #
-      def ht(key, options={})
-
-        # Check if called as a tag, i.e. like this <ht></ht>
-        if (key.class == Hash)
-          if key.has_key?(:default) && !key[:default].blank?
-            Rails.logger.warn "hobo-i18n: 'default' should not be used as an attribute on the ht-tag. If used, then you need to make sure that the tags inner-contents are not used. These are normally treated as defaults automatically, but if there is a default attribute then that inner-content will be hidden from this method - and will not be replaced with the translation found."
-          end
-          defaults = options[:default];
-          # Swap key and options, remove options[:key]
-          options = key
-          key = options.delete(:key) # returns value for options[:key] as well as deleting it
-          # Set options[:default] to complete the tag-argument-conversion process.
-          options[:default] = (defaults.class == Proc) ? [defaults.call(options)] : (options[:default].blank? ? [] : [options[:default]])
-        else
-          # Not called as a tag. Prepare options[:default].
-          if options[:default].nil?
-            options[:default]=[]
-          elsif options[:default].class != Array
-            options[:default] = [options[:default]]
-          end
-        end
+      # simple wrapper around the translate helper
+      # it implements a dryml <translate> and a <t> tag
 
-        # assume the first part of the key to be the model
-        keys = key.to_s.split(".")
-        if keys.length > 1
-          model = keys.shift()
-          subkey = keys.join(".")
-        else
-          subkey = key
-        end
+      def translate(*args)
+        key, options = normalize_args(*args)
+        super key.to_sym, options
+      end
+      alias_method :t, :translate
 
-        # will skip useless code in case the first part of the key is 'hobo'
-        model = '' if model.eql?('hobo')
-
-        unless model.blank?
-          klass = begin
-                    model.singularize.camelize.constantize
-                  rescue NameError
-                  end
-          # add :"hobo.#{key}" as the first fallback
-          options[:default].unshift("hobo.#{subkey}".to_sym)
-          # translate the model
-          # the singularize method is used because Hobo does not keep the ActiveRecord convention in its tags
-          # no default needed because human_name defaults to the model name
-          # try because Hobo class is not an ActiveRecord::Base subclass
-          translated_pluralized_model = klass.try.model_name.try.human(:count=>options[:count]||1)
-          options[:model] = translated_pluralized_model
-        end
+=begin
+
+hobo_translate / ht
+
+Wrapper around the Rails :translate helper with hobo added features.
+
+It can be used as a regular helper or as a dryml tag.
+
+Hobo Added Features
 
-        key_prefix = "<span class='translation-key'>#{key}</span>" if defined?(HOBO_SHOW_LOCALE_KEYS) && HOBO_SHOW_LOCALE_KEYS
+The first part of the key must be a model name (e.g.: user.index.title -> user). This method will add a "model" interpolation variable set to the translated and pluralized Model.model_name.human. Besides, it will add a default 'hobo.' fallback, (e.g.: hobo.index.title) at the beginning of the fallback chain.
 
-        Rails.logger.info "..translate(#{key}, #{options.inspect}) to #{I18n.locale}" if defined?(HOBO_VERBOSE_TRANSLATIONS)
+You can also pass any other :translate option like for example :count.
 
-        translation = I18n.translate(key.to_sym, options)
-        if translation.respond_to? :to_str
-          key_prefix ? translation.to_str+key_prefix : translation
-        else
-          "translation invalid: #{key}"
+Example:
+
+<%= ht :key=>'user.index.title', :default=>'Index'  %>
+<ht key="user.index.title">Index</ht>
+#=> "Index" # if "user.index.title" or "hobo.index.title" is not found
+#=> "User Index" # with the below en.yml file
+
+=== en.yml ===
+en:
+  hobo:
+    index:
+      title: %{model} Index
+
+=end
+
+      def hobo_translate(*args)
+        key, options = normalize_args(*args)
+        keys = key.to_s.split(".")
+        model_name = keys.shift
+        model_class = begin model_name.camelize.constantize; rescue; end
+        unless model_class && model_class < ActiveRecord::Base
+          raise Hobo::I18nError, %(wrong model name: "#{model_name}" (extracted from translation key). You might want to use the translate/t tag/method instead.)
+        end
+        options[:default].unshift("hobo.#{keys.join(".")}".to_sym)
+        options[:model] = model_class.model_name.human(:count=>options[:count]||1)
+        translate key.to_sym, options
+      end
+      alias_method :ht, :hobo_translate
+
+    private
+
+      def normalize_args(key, options={})
+        if (key.class == Hash) # called as a tag
+          if key.has_key?(:default) && !key[:default].blank?
+            Rails.logger.warn "hobo-i18n: 'default' should not be used as an attribute on *translate tags. If used, then you need to make sure that the tags inner-contents are not used. These are normally treated as defaults automatically, but if there is a default attribute then that inner-content will be hidden from this method - and will not be replaced with the translation found."
+          end
+          defaults = options[:default]
+          options = key
+          key = options.delete(:key)
+          # Set options[:default] to complete the tag-argument-conversion process.
+          options[:default] = defaults.call(options) if defaults.class == Proc
         end
+        options[:default] = Array.wrap options[:default]
+        [key, options]
       end
 
     end