hobo 0.8.10 → 0.9.0

data/lib/hobo.rb

@@ -16,7 +16,7 @@ class HoboError < RuntimeError; end
 
 module Hobo
 
-  VERSION = "0.8.10"
+  VERSION = "0.9.0"
   
   class PermissionDeniedError < RuntimeError; end
 

data/lib/hobo/accessible_associations.rb

@@ -26,6 +26,8 @@ module Hobo
     
     def find_or_create_and_update(owner, association_name, finder, record_hash_or_string)
       if record_hash_or_string.is_a?(String)
+        return nil if record_hash_or_string.blank?
+
         # An ID or a name - the passed block will find the record
         record = find_by_name_or_id(finder, record_hash_or_string)
       

data/lib/hobo/authentication_support.rb

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

data/lib/hobo/controller.rb

@@ -23,6 +23,7 @@ module Hobo
             Thread.current['Hobo.current_controller'] = nil  # should avoid memory-leakage
           end
           @included_taglibs = []
+          rescue_from ActionController::RoutingError, :with => :not_found
         end
         Hobo::HoboHelper.add_to_controller(klass)
       end
@@ -108,9 +109,10 @@ module Hobo
 
     def render_tags(objects, tag, options={})
       for_type = options.delete(:for_type)
+      base_tag = tag
 
       results = objects.map do |o|
-        tag = tag_renderer.find_polymorphic_tag(tag, o.class) if for_type
+        tag = tag_renderer.find_polymorphic_tag(base_tag, o.class) if for_type
         tag_renderer.send(tag, options.merge(:with => o))
       end.join
 
@@ -154,8 +156,14 @@ module Hobo
       request.env['HTTP_CACHE_CONTROL'] =~ /max-age=\s*0/
     end
 
-    def not_found
-
+    def not_found(error)
+      if "not_found_response".in?(self.class.superclass.instance_methods)
+        super
+      elsif render_tag("not-found-page", {}, :status => 404)
+        # cool
+      else
+        render(:text => ht(:"hobo.messages.not_found", :default=>["The page you requested cannot be found."]) , :status => 404)
+      end
     end
 
   end

data/lib/hobo/dryml/dryml_doc.rb

@@ -156,4 +156,4 @@ module Hobo
     
   end
   
-end
+end

data/lib/hobo/fake_initializer.rb

@@ -0,0 +1,14 @@
+# really what we want is a reference to the Initializer used in
+# config/boot.rb.  But since we can't monkey patch that file, we'll
+# use a fake instead.
+
+# this is used by the rapid_summary tag with_plugins
+module Hobo
+  class FakeInitializer
+    attr_reader :configuration
+    
+    def initialize(config = Rails.configuration)
+      @configuration = config
+    end
+  end
+end

data/lib/hobo/hobo_helper.rb

@@ -45,7 +45,7 @@ module Hobo
 
 
     def subsite
-      params[:controller].match(/([^\/]+)\//)._?[1]
+      params[:controller]._?.match(/([^\/]+)\//)._?[1]
     end
 
 
@@ -192,12 +192,20 @@ module Hobo
     
     
     def first_item?
-      this == scope.repeat_collection.first
+      if scope.repeat_collection.respond_to? :each_pair
+        this == scope.repeat_collection.first.try.last
+      else
+        this == scope.repeat_collection.first
+      end
     end
     
     
     def last_item?
-      this == scope.repeat_collection.last
+      if scope.repeat_collection.respond_to? :each_pair
+        this == scope.repeat_collection.last.try.last
+      else
+        this == scope.repeat_collection.last
+      end
     end
 
 
@@ -476,12 +484,16 @@ module Hobo
 
     # --- ViewHint Helpers --- #
     
-    def this_field_name     
-      this_parent.class.try.view_hints.try.field_name(this_field) || this_field
+    def this_field_name
+      key = "#{this_parent.class.try.name.underscore}.#{this_field.to_s}"
+      default = this_parent.class.try.view_hints.try.field_name(this_field) || this_field
+      I18n.t(key, :default => default, :scope => [:activerecord, :attributes], :count => 1)
     end
 
     def this_field_help
-      this_parent.class.try.view_hints.try.field_help[this_field.to_sym]
+      key = "#{this_parent.class.try.name.pluralize.underscore}.hints.#{this_field.to_s}"
+      default = this_parent.class.try.view_hints.try.field_help[this_field.to_sym] || ""
+      I18n.t(key,:default=>default)
     end
 
 
@@ -499,6 +511,82 @@ module Hobo
       logger.debug("###################\n")
       args.first unless args.empty?
     end
+    
+    # --- 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
+    # 
+    # Otherwise with features as the ht method, step 1, 2 and 3 above. 
+    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?
+          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].blank?
+          options[:default]=[]
+        elsif options[:default].class != Array
+          options[:default] = [options[:default]]
+        end
+      end
+      
+      # 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
+    
+      # add :"hobo.#{key}" as the first fallback
+      options[:default].unshift("hobo.#{subkey}".to_sym)
+    
+      # translate the model
+      unless model.blank?
+        translated_model = I18n.translate( "activerecord.models.#{model.singularize.underscore}", :default=>model).titleize
+        options[:model] = translated_model
+      end
+    
+      begin   
+        key_prefix = "<span class='translation-key'>#{key}</span>" if HOBO_SHOW_LOCALE_KEYS
+      rescue
+        puts "Set HOBO_SHOW_LOCALE_KEYS=true in your environment to get all locale keys displayed"
+      end
+    
+      logger.info "..translate(#{key}, #{options.inspect}) to #{I18n.locale}"
+      I18n.translate(key.to_sym, options)+(key_prefix ? key_prefix:"")
+    end
 
   end
 

data/lib/hobo/lifecycles.rb

@@ -20,7 +20,9 @@ module Hobo
                                         :key_timestamp_field => :key_timestamp,
                                         :key_timeout => 999.years)
 
-        if defined? self::Lifecycle
+        # use const_defined so that subclasses can define lifecycles
+        # TODO: figure out how to merge with parent, if desired
+        if self.const_defined?(:Lifecycle)
           lifecycle = self::Lifecycle
         else
           # First call
@@ -35,6 +37,10 @@ module Hobo
 
         default = lifecycle.default_state ? { :default => lifecycle.default_state.name.to_s } : {}
         declare_field(options[:state_field], :string, default)
+        unless options[:index] == false
+          index_options = { :name => options[:index] } unless options[:index] == true
+          index(options[:state_field], index_options || {})
+        end
         never_show      options[:state_field]
         attr_protected  options[:state_field]
 
@@ -76,7 +82,16 @@ module Hobo
 
 
       def lifecycle
-        @lifecycle ||= self.class::Lifecycle.new(self)
+        @lifecycle ||=  if defined? self.class::Lifecycle
+                          self.class::Lifecycle.new(self)
+                        else
+                          # search through superclasses
+                          current = self.class.superclass
+                          until (defined?(current::Lifecycle) || current.nil? || !current.respond_to?(:lifecycle)) do
+                            current = current.superclass
+                          end
+                          current.class::Lifecycle.new(self) if defined? current::Lifecycle
+                        end
       end
 
     end

data/lib/hobo/lifecycles/lifecycle.rb

@@ -126,7 +126,7 @@ module Hobo
 
       def transition(name, user, attributes)
         transition = find_transition(name, user)
-        transition.run!(record, user, attributes)
+        transition.run!(record, user, attributes) unless transition.nil?
       end
 
 

data/lib/hobo/lifecycles/transition.rb

@@ -20,11 +20,19 @@ module Hobo
 
 
       def extract_attributes(attributes)
-        update_attributes = options.fetch(:params, [])
-        attributes & update_attributes
+        model = lifecycle.model
+        params = options.fetch(:params, [])
+        allowed = params.dup
+        params.each do |p|
+          if (refl = model.reflections[p]) && refl.macro == :belongs_to
+            allowed << refl.primary_key_name.to_s
+            allowed << refl.options[:foreign_type] if refl.options[:polymorphic]
+          end
+        end
+        attributes & allowed
       end
-        
-      
+
+
       def change_state(record)
         record.lifecycle.become(get_state(record, end_state))
       end

data/lib/hobo/model.rb

@@ -85,6 +85,7 @@ module Hobo
         @models_loaded = true
       end
 
+      @model_names ||= Set.new
       # ...but only return the ones that registered themselves
       @model_names.map do |name|
         name.safe_constantize || (@model_names.delete name; nil)
@@ -137,8 +138,18 @@ module Hobo
       require 'active_record/viewhints_validations_interceptor'
       include Hobo::ViewHintsValidationsInterceptor
 
+      # TODO: should this be an inheriting_cattr_accessor as well? Probably.
       attr_accessor :creator_attribute
-      attr_writer :name_attribute, :primary_content_attribute
+      inheriting_cattr_accessor :name_attribute => Proc.new { |c|
+        names = c.columns.*.name + c.public_instance_methods
+        NAME_FIELD_GUESS.detect {|f| f.in? names }
+      }
+
+      inheriting_cattr_accessor :primary_content_attribute => Proc.new { |c|
+        names = c.columns.*.name + c.public_instance_methods
+        PRIMARY_CONTENT_GUESS.detect {|f| f.in? names }
+      }
+
 
       def named(*args)
         raise NoNameError, "Model #{name} has no name attribute" unless name_attribute
@@ -157,21 +168,6 @@ module Hobo
       end
 
 
-      def name_attribute
-        @name_attribute ||= begin
-                              names = columns.*.name + public_instance_methods
-                              NAME_FIELD_GUESS.detect {|f| f.in? names }
-                            end
-      end
-
-
-      def primary_content_attribute
-        @primary_content_attribute ||= begin
-                                         names = columns.*.name + public_instance_methods
-                                         PRIMARY_CONTENT_GUESS.detect {|f| f.in? names }
-                                       end
-      end
-
       def dependent_collections
         reflections.values.select do |refl|
           refl.macro == :has_many && refl.options[:dependent]
@@ -203,6 +199,9 @@ module Hobo
         belongs_to_without_test_methods(name, options, &block)
         refl = reflections[name]
         if options[:polymorphic]
+          # TODO: the class lookup in _is? below is incomplete; a polymorphic association to an STI base class
+          #       will fail to match an object of a derived type
+          #       (ie X belongs_to Y (polymorphic), Z is a subclass of Y; @x.y_is?(some_z) will never pass)
           class_eval %{
             def #{name}_is?(target)
               target.class.name == self.#{refl.options[:foreign_type]} && target.id == self.#{refl.primary_key_name}
@@ -214,7 +213,7 @@ module Hobo
         else
           class_eval %{
             def #{name}_is?(target)
-              target.class == ::#{refl.klass.name} && target.id == self.#{refl.primary_key_name}
+              target.class <= ::#{refl.klass.name} && target.id == self.#{refl.primary_key_name}
             end
             def #{name}_changed?
               #{refl.primary_key_name}_changed?
@@ -345,7 +344,7 @@ module Hobo
           
           refl.klass.reflections.values.find do |r|
             r.macro.in?(reverse_macros) &&
-              r.klass == self &&
+              r.klass >= self &&
               !r.options[:conditions] &&
               r.primary_key_name == refl.primary_key_name
           end
@@ -434,14 +433,18 @@ module Hobo
       attr = self.class.creator_attribute
       return unless attr
 
-      # Is creator a string field or an association?
-      if self.class.attr_type(attr)._? <= String
+      attr_type = self.class.creator_type
+
+      # Is creator an instance, a string field or an association?
+      if !attr_type.is_a?(Class)
+        # attr_type is an instance - typically AssociationReflection for a polymorphic association
+        self.send("#{attr}=", user)
+      elsif self.class.attr_type(attr)._? <= String
         # Set it to the name of the current user
         self.send("#{attr}=", user.to_s) unless user.guest?
       else
         # Assume user is a user object, but don't set if we've got a type mismatch
-        t = self.class.creator_type
-        self.send("#{attr}=", user) if t.nil? || user.is_a?(t)
+        self.send("#{attr}=", user) if attr_type.nil? || user.is_a?(attr_type)
       end
     end
 

data/lib/hobo/model_controller.rb

@@ -383,7 +383,7 @@ module Hobo
         (!destroyed && object_url(@this)) ||
 
         # Then the show page of the 'owning' object if there is one
-        (@this.class.default_dependent_on && object_url(@this.send(@this.class.default_dependent_on))) ||
+        object_url(owning_object) ||
 
         # Last try - the index page for this model
         object_url(@this.class) ||
@@ -391,6 +391,11 @@ module Hobo
         # Give up
         home_page
     end
+
+    def owning_object
+      method = @this.class.dependent_on.detect {|m| !@this.send(m).nil?}
+      method ? @this.send(method) : nil
+    end
     
     
     def url_for_page_path
@@ -457,9 +462,9 @@ module Hobo
     
     def find_owner_and_association(owner_association)
       refl = model.reflections[owner_association]
-      klass = refl.klass
-      id = params["#{owner_association}_id"]
-      owner = klass.find(id)
+      owner_name = refl.macro == :has_many ? owner_association.to_s.singularize : owner_association
+      id = params["#{owner_name}_id"]
+      owner = refl.klass.find(id)
       instance_variable_set("@#{owner_association}", owner)
       [owner, owner.send(model.reverse_reflection(owner_association).name)]
     end
@@ -486,7 +491,7 @@ module Hobo
 
     def hobo_show(*args, &b)
       options = args.extract_options!
-      self.this ||= find_instance(options)
+      self.this ||= args.first || find_instance(options)
       response_block(&b)
     end
 
@@ -544,7 +549,7 @@ module Hobo
 
 
     def create_response(new_action, options={}, &b)
-      flash_notice "The #{@this.class.name.titleize.downcase} was created successfully" if valid?
+      flash_notice (ht( :"#{@this.class.name.pluralize.underscore}.messages.create.success", :default=>["The #{@this.class.name.titleize.downcase} was created successfully"])) if valid?
 
       response_block(&b) or
         if valid?
@@ -554,10 +559,12 @@ module Hobo
           end
         else
           respond_to do |wants|
+			# errors is used by the translation helper, ht, below.
+			errors = this.errors.full_messages.join("\n")
             wants.html { re_render_form(new_action) }
             wants.js   { render(:status => 500,
-                                :text => ("Couldn't create the #{this.class.name.titleize.downcase}.\n" +
-                                          this.errors.full_messages.join("\n"))) }
+                                :text => ht( :"#{this.class.name.pluralize.underscore}.messages.create.error", :errors=>errors,:default=>["Couldn't create the #{this.class.name.titleize.downcase}.\n #{errors}"])
+                               )}
           end
         end
     end
@@ -567,7 +574,7 @@ module Hobo
       options = args.extract_options!
 
       self.this ||= args.first || find_instance
-      changes = options[:attributes] || attribute_parameters or raise RuntimeError, "No update specified in params"
+      changes = options[:attributes] || attribute_parameters or raise RuntimeError, ht(:"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
@@ -579,7 +586,8 @@ module Hobo
 
 
     def update_response(in_place_edit_field=nil, options={}, &b)
-      flash_notice "Changes to the #{@this.class.name.titleize.downcase} were saved" if valid?
+      
+      flash_notice (ht(:"#{@this.class.name.pluralize.underscore}.messages.update.success", :default=>["Changes to the #{@this.class.name.titleize.downcase} were saved"])) if valid?
 
       response_block(&b) or
         if valid?
@@ -602,10 +610,12 @@ module Hobo
           end
         else
           respond_to do |wants|
+			# errors is used by the translation helper, ht, below.
+            errors = @this.errors.full_messages.join("\n")
             wants.html { re_render_form(:edit) }
             wants.js { render(:status => 500,
-                              :text => ("There was a problem with that change.\n" +
-                                        @this.errors.full_messages.join("\n"))) }
+                              :text => ht(:"#{@this.class.name.pluralize.underscore}.messages.update.error",:default=>["There was a problem with that change.\n#{errors}"], :errors=>errors)
+                             ) }
           end
         end
     end
@@ -615,7 +625,7 @@ module Hobo
       options = args.extract_options!
       self.this ||= args.first || find_instance
       this.user_destroy(current_user)
-      flash_notice "The #{model.name.titleize.downcase} was deleted"
+      flash_notice ht( :"#{model.name.pluralize.underscore}.messages.destroy.success", :default=>["The #{model.name.titleize.downcase} was deleted"])
       destroy_response(options, &b)
     end
 
@@ -652,10 +662,12 @@ module Hobo
         else
           this.exempt_from_edit_checks = true
           respond_to do |wants|
+  			# errors is used by the translation helper, ht, below.
+			errors = this.errors.full_messages.join("\n")
             wants.html { re_render_form(name) }
             wants.js   { render(:status => 500,
-                                :text => ("Couldn't do creator #{name}.\n" +
-                                          this.errors.full_messages.join("\n"))) }
+                                :text => ht(:"#{@this.class.name.pluralize.underscore}.messages.creator.error", :default=>["Couldn't do creator #{name}.\n#{errors}"], :name=>name, :errors=>errors)
+                               )}
           end
         end
     end
@@ -663,12 +675,13 @@ module Hobo
 
     def prepare_transition(name, options)
       key = options.delete(:key) || params[:key]
-      
-      self.this = find_instance do |record|
-        # The block allows us to perform actions on the records before the permission check
-        record.exempt_from_edit_checks = true
-        record.lifecycle.provided_key = key
-      end
+
+      # we don't use find_instance here, as it fails for key_holder transitions on objects that Guest can't view
+      record = model.find(params[:id])
+      record.exempt_from_edit_checks = true
+      record.lifecycle.provided_key = key
+      self.this = record
+
       this.lifecycle.find_transition(name, current_user) or raise Hobo::PermissionDeniedError
     end
 
@@ -691,10 +704,12 @@ module Hobo
           end
         else
           respond_to do |wants|
+  			# errors is used by the translation helper, ht, below.
+			errors = this.errors.full_messages.join("\n")
             wants.html { re_render_form(name) }
             wants.js   { render(:status => 500,
-                                :text => ("Couldn't do transition #{name}.\n" +
-                                          this.errors.full_messages.join("\n"))) }
+                                :text => ht(:"#{@this.class.name.pluralize.underscore}.messages.transition.error", :default=>["Couldn't do transition #{name}.\n#{errors}"], :name=>name, :errors=>errors)
+                               )}
           end
         end
     end
@@ -748,28 +763,17 @@ module Hobo
             if render_tag("permission-denied-page", { }, :status => 403)
               # job done
             else
-              render :text => "Permission Denied", :status => 403
+              render :text => ht(:"hobo.messages.permission_denied", :default=>["Permission Denied"]), :status => 403
             end
           end
           wants.js do
-            render :text => "Permission Denied", :status => 403
+            render :text => ht(:"hobo.messages.permission_denied", :default=>["Permission Denied"]), :status => 403
           end
         end
       end
     end
 
 
-    def not_found(error)
-      if "not_found_response".in?(self.class.superclass.instance_methods)
-        super
-      elsif render_tag("not-found-page", {}, :status => 404)
-        # cool
-      else
-        render(:text => "The page you requested cannot be found.", :status => 404)
-      end
-    end
-
-
     def this
       @this ||= (instance_variable_get("@#{model.name.underscore}") ||
                  instance_variable_get("@#{model.name.underscore.pluralize}"))
@@ -794,7 +798,8 @@ module Hobo
     def render_with_hobo_model(*args, &block)
       options = args.extract_options!
       self.this = options[:object] if options[:object]
-      this.user_view(current_user) if this && this.respond_to?(:user_view)
+      # this causes more problems than it solves, and Tom says it's not supposed to be here
+      # this.user_view(current_user) if this && this.respond_to?(:user_view)
       render_without_hobo_model(*args + [options], &block)
     end