hobo 1.1.0 → 1.3.0.RC

data/lib/hobo/model/user_base.rb

@@ -0,0 +1,184 @@
+require 'digest/sha1'
+
+module Hobo
+  module Model
+    module UserBase
+
+      @user_models = []
+
+      def self.default_user_model
+        @user_models.first._?.constantize
+      end
+
+      AUTHENTICATION_FIELDS = [:salt, :crypted_password, :remember_token, :remember_token_expires_at]
+
+      # Extend the base class with AuthenticatedUser functionality
+      # This includes:
+      # - plaintext password during login and encrypted password in the database
+      # - plaintext password validation
+      # - login token for rembering a login during multiple browser sessions
+      def self.included(base)
+        @user_models << base.name
+
+        base.extend(ClassMethods)
+
+        base.class_eval do
+
+          fields do
+            crypted_password          :string, :limit => 40
+            salt                      :string, :limit => 40
+            remember_token            :string
+            remember_token_expires_at :datetime
+          end
+
+          validates_confirmation_of :password,              :if => :new_password_required?
+          validate :validate_password
+          validate :validate_current_password_when_changing_password
+
+          # Virtual attributes for setting and changing the password
+          # note that :password_confirmation= is also defined by
+          # validates_confirmation_of, so this line must follow any
+          # validates_confirmation_of statements.
+          # https://hobo.lighthouseapp.com/projects/8324-hobo/tickets/530
+          attr_accessor :current_password, :password, :password_confirmation, :type => :password
+
+          before_save :encrypt_password
+          after_save :stash_current_password
+
+          never_show *AUTHENTICATION_FIELDS
+
+          attr_protected *AUTHENTICATION_FIELDS
+
+
+        end
+      end
+
+      # Additional classmethods for authentication
+      module ClassMethods
+
+
+        def login_attribute=(attr, validate=true)
+          @login_attribute = attr = attr.to_sym
+          unless attr == :login
+            alias_attribute(:login, attr)
+            declare_attr_type(:login, attr_type(attr)) if table_exists? # this breaks if the table doesn't exist
+          end
+
+          if validate
+            validates_length_of     attr, :within => 3..100
+            validates_uniqueness_of attr, :case_sensitive => false
+          end
+        end
+
+        inheriting_cattr_reader :login_attribute
+
+
+        # Authenticates a user by their login name and unencrypted password.  Returns the user or nil.
+        def authenticate(login, password)
+          u = where("#{@login_attribute} = ?", login).first # need to get the salt
+
+          if u && u.authenticated?(password)
+            if u.respond_to?(:last_login_at) || u.respond_to?(:login_count)
+              u.last_login_at = Time.now if u.respond_to?(:last_login_at)
+              u.login_count = (u.login_count.to_i + 1) if u.respond_to?(:login_count)
+              u.save
+            end
+            u
+          else
+            nil
+          end
+        end
+
+        # Encrypts some data with the salt.
+        def encrypt(password, salt)
+          Digest::SHA1.hexdigest("--#{salt}--#{password}--")
+        end
+
+      end
+
+      def account_active?
+        lifecycle.active_state?
+      end
+
+      # Encrypts the password with the user salt
+      def encrypt(password)
+        self.class.encrypt(password, salt)
+      end
+
+      # Check if the encrypted passwords match
+      def authenticated?(password)
+        crypted_password == encrypt(password)
+      end
+
+      # Do we still need to remember the login token, or has it expired?
+      def remember_token?
+        remember_token_expires_at && Time.now.utc < remember_token_expires_at
+      end
+
+      # These create and unset the fields required for remembering users between browser closes
+      def remember_me
+        self.remember_token_expires_at = 2.weeks.from_now.utc
+        self.remember_token            = encrypt("#{login}--#{remember_token_expires_at}")
+        save(:validate => false)
+      end
+
+      # Expire the login token, resulting in a forced login next time.
+      def forget_me
+        self.remember_token_expires_at = nil
+        self.remember_token            = nil
+        save(:validate => :false)
+      end
+
+      def guest?
+        false
+      end
+
+      def signed_up?
+        true
+      end
+
+      protected
+      # Before filter that encrypts the password before having it stored in the database.
+      def encrypt_password
+        return if password.blank?
+        self.salt = Digest::SHA1.hexdigest("--#{Time.now.to_s}--#{login}--") if salt.blank?
+        self.crypted_password = encrypt(password)
+      end
+
+      # after filter that sets current_password so we can pass
+      # validate_current_password_when_changing_password if you save
+      # again.  See
+      # https://hobo.lighthouseapp.com/projects/8324-hobo/tickets/590
+      def stash_current_password
+        @current_password ||= password
+      end
+
+      def changing_password?
+        !new_record? && !lifecycle_changing_password? &&
+          (current_password.present? || password.present? || password_confirmation.present?)
+      end
+
+
+      def lifecycle_changing_password?
+        self.class.has_lifecycle? && lifecycle.active_step && :password.in?(lifecycle.active_step.parameters)
+      end
+
+      # Is a new password (and confirmation) required? (i.e. signing up or changing password)
+      def new_password_required?
+        (new_record? && password) || lifecycle_changing_password? || changing_password?
+      end
+
+      # Validation of the plaintext password. Override this function to change your validation.
+      def validate_password
+        errors.add(:password, I18n.t("hobo.messages.validate_password", :default => "must be at least 6 characters long and must not consist solely of lowercase letters")) \
+          if new_password_required? && (password.nil? || password.length<6 || /^[[:lower:]]*$/.match(password))
+      end
+
+      def validate_current_password_when_changing_password
+        errors.add :current_password, I18n.t("hobo.messages.current_password_is_not_correct", :default => "is not correct") \
+          if changing_password? && !authenticated?(current_password)
+      end
+
+    end
+  end
+end

data/lib/hobo/model/view_hints.rb

@@ -0,0 +1,123 @@
+module Hobo
+  module Model
+    class ViewHints
+
+      class << self
+
+        # allows delayed set of children in order to avoid circular references
+        # triggered by declaring children in the model
+        def children(*args)
+          if args.empty? # reader
+            if @children_args.nil? # value already set
+              @children ||= []
+            else # set
+              child_model = model.reflect_on_association(@children_args.first).klass
+              if child_model.view_hints.parent.nil? and !child_model.view_hints.parent_defined
+                parent = model.reverse_reflection(@children_args.first)
+                child_model.view_hints.parent(parent.name, :undefined => true) if parent
+              end
+              @children = @children_args
+              @children_args = nil
+              @children
+            end
+          else # writer (only stores the args for delayed setting)
+            @children_args = args
+          end
+        end
+
+        def inline_booleans(*args)
+          if args.empty? # reader
+            if @inline_booleans_args.nil?
+              @inline_booleans ||= []
+            else
+              @inline_booleans = if @inline_booleans_args.first == true
+                                   model.columns.select { |c| c.type == :boolean }.*.name
+                                 else
+                                   @inline_booleans_args.*.to_s
+                                 end
+              @inline_booleans_args = nil
+              @inline_booleans
+            end
+          else # writer
+            @inline_booleans_args = args
+          end
+        end
+
+        def parent(*args)
+          if args.empty? #reader
+            @parent
+          else # writer
+            options = args.extract_options!
+            parent_defined(true) unless options[:undefined]
+            @parent = args.first
+          end
+        end
+
+        def parent_defined(arg=nil)
+          if arg.nil?
+            @parent_defined
+          else
+            @parent_defined = arg
+          end
+        end
+
+        def paginate?(arg=nil)
+          if arg.nil?
+            @paginate ||= !sortable?
+          else
+            @paginate = arg
+          end
+        end
+
+        def sortable?(arg=nil)
+          if arg.nil?
+            @sortable ||= defined?(ActiveRecord::Acts::List::InstanceMethods) &&
+                          model < ActiveRecord::Acts::List::InstanceMethods &&
+                          model.table_exists? &&
+                          model.new.try.scope_condition == "1 = 1"
+          else
+            @sortable = arg
+          end
+        end
+
+        def _name
+          @_name ||= name.sub(/Hints$/, '')
+        end
+
+        def model
+          @model ||= _name.constantize
+        end
+
+        def primary_children
+          children.first
+        end
+
+        def secondary_children
+          children.rest
+        end
+
+
+  ##### LEGACY METHODS TO REMOVE #####
+
+        def model_name(*)
+          raise NotImplementedError, "ViewHints.model_name is no longer supported, please use model.model_name.human and set a the activerecord.models.<model_name> key in a locale file"
+        end
+
+        def model_name_plural(*)
+          raise NotImplementedError, "ViewHints.model_name_plural is no longer supported, please use model.model_name.human(:count => n) and set a the activerecord.models.<model_name> key in a locale file"
+        end
+
+        def field_name(*)
+          raise NotImplementedError, "ViewHints.field_name is no longer supported, please use model..human_attribute_name and set a the activerecord.attributes.<model_name>.<field_name> key in a locale file"
+        end
+
+        def field_names(*)
+          raise NotImplementedError, "ViewHints.field_names is no longer supported, please set the activerecord.attributes.<model_name>.<field_name> keys in a locale file"
+        end
+
+      end
+
+    end
+
+  end
+end

data/{rapid_generators → lib/hobo/rapid/generators}/rapid/cards.dryml.erb

@@ -19,7 +19,7 @@ has_body    = (!show_link && description_attribute) || creator_link || creator_a
 
 show_title = !show_link && (name_attribute || !has_body)
 
-model_key = model.name.pluralize.underscore
+model_key = model.to_s.underscore
 -%>
 <def tag="card" for="<%= model.name %>">
   <card class="<%= model_class %>" param="default" merge>
@@ -53,7 +53,7 @@ model_key = model.name.pluralize.underscore
       <view:<%= creator_attribute %> param="creator"/>
 <% end -%>
 <% if primary_collection -%>
-      <ht key="<%= primary_collection.to_s.pluralize.underscore %>.collection.count" count="&this.<%= primary_collection %>.size">
+      <ht key="<%= model.reflect_on_association(primary_collection).klass.to_s.underscore %>.collection.count" count="&this.<%= primary_collection %>.size">
          <count:<%= primary_collection%> param/>
       </ht>
 <% end -%>

data/{rapid_generators → lib/hobo/rapid/generators}/rapid/forms.dryml.erb

@@ -4,7 +4,7 @@ form_fields = standard_fields :belongs_to, :has_many
 
 cancel_to_show_page  = linkable?(:show)
 cancel_to_index_page = !cancel_to_index_page && linkable?(:index)
-model_key = model.name.tableize
+model_key = model.to_s.underscore
 -%>
 <def tag="form" for="<%= model.name %>">
   <form merge param="default">
@@ -37,10 +37,10 @@ model_key = model.name.tableize
     <input type="hidden" name="key" value="&this.lifecycle.provided_key" if="&this.lifecycle.provided_key"/>
     <field-list fields="<%= transition.parameters * ', ' %>" param/>
     <div param="actions">
-      <submit label="#{ht '<%= model_key %>.actions.<%= transition.name.to_s %>', :default=>['<%= transition.name.to_s.titleize %>']}" param/><or-cancel param="cancel"/>
+      <submit label="#{t 'activerecord.attributes.<%= model_key %>.lifecycle.transitions.<%= transition.name.to_s %>', :default=>['<%= transition.name.to_s.titleize %>']}" param/><or-cancel param="cancel"/>
     </div>
   </form>
 </def>
 <% end -%>
 
-<% end # of each_model do -%>
+<% end # of each_model do -%>

data/{rapid_generators → lib/hobo/rapid/generators}/rapid/pages.dryml.erb

@@ -3,8 +3,8 @@
 <def tag="main-nav">
   <navigation class="main-nav" merge-attrs param="default">
     <nav-item href="#{base_url}/">Home</nav-item>
-<% models.select { |m| linkable?(m, :index) }[0..4].each do |m| -%>
-    <nav-item with="&<%= m.name %>"><ht key="<%= m.name.tableize %>.nav_item"><%= m.view_hints.model_name_plural %></ht></nav-item>
+<% models.select { |m| linkable?(m, :index) }.each do |m| -%>
+    <nav-item with="&<%= m.name %>"><ht key="<%= m.to_s.underscore %>.nav_item" count="100"><model-name-human count="100"/></ht></nav-item>
 <% end -%>
   </navigation>
 </def>
@@ -17,24 +17,24 @@
 <%
 new_link = linkable?(:new)
 new_form = !new_link && linkable?(model, :create, :method => :post)
-model_key = model.name.tableize
+model_key = model.to_s.underscore
 -%>
 
 <def tag="index-page" for="<%= model.name %>">
-  <page merge title="#{ht '<%= model_key %>.index.title', :default=>['<%= sq_escape(model_name :plural) %>'] }">
+  <page merge title="#{ht '<%= model_key %>.index.title', :default=>[model.model_name.human(:count=>100)] }">
     <body: class="index-page <%= model_class %>" param/>
 
     <content: param>
       <header param="content-header">
         <h2 param="heading">
           <ht key="<%= model_key %>.index.heading">
-            <%= model_name :plural %>
+            <model-name-human model="&model"/>
           </ht>
         </h2>
 
         <p param="count" if>
-          <ht key="<%= model_key %>.collection.count" count="&this.size">
-            There <count prefix="are"/>
+          <ht key="<%= model_key %>.collection.count" count="&collection_count">
+            <count summary/>
           </ht>
         </p>
       </header>
@@ -101,14 +101,16 @@ model_key = model.name.tableize
 
 <%
 back_link      = model.view_hints.parent
-boolean_fields = model.columns.select { |c| c.type == :boolean }.*.name - model.view_hints.inline_booleans
+back_link_human_name = model.reflections[back_link] && model.reflections[back_link].klass unless back_link.blank?
+back_link_human_name = back_link_human_name && back_link_human_name.model_name.human
+boolean_fields = model.table_exists? ? (model.columns.select { |c| c.type == :boolean }.*.name - model.view_hints.inline_booleans) : []
 creator        = model.creator_attribute
 creator_link   = creator && model.reflections[creator] && linkable?(model.reflections[creator].klass, :show)
 edit_link      = linkable?(:edit)
 main_content   = model.primary_content_attribute
 show_fields    = standard_fields(:belongs_to).*.to_s - [model.name_attribute, main_content, creator, back_link, *boolean_fields].*.to_s
 
-is_user_model = model < Hobo::User
+is_user_model = model < Hobo::Model::UserBase
 
 collection     = model.view_hints.primary_children
 if collection
@@ -137,10 +139,10 @@ end
 <% end -%>
           <header param="content-header">
 <% if back_link -%>
-            <a:<%= back_link %> param="parent-link">&laquo; <ht key="<%= model_key %>.actions.back" to="<%= back_link %>"><name/></ht></a:<%= back_link %>>
+            <a:<%= back_link %> param="parent-link">&laquo; <ht key="<%= model_key %>.actions.back_to_parent" parent="<%= back_link_human_name %>" name="&this">Back to <name/></ht></a:<%= back_link %>>
 <% end -%>
             <h2 param="heading">
-              <ht key="<%= model_key %>.show.heading" name="&this.respond_to?(:to_s) ? this.to_s : ''">
+              <ht key="<%= model_key %>.show.heading" name="&this.respond_to?(:name) ? this.name : ''">
                 <name/>
               </ht>
             </h2>
@@ -165,7 +167,7 @@ end
 <% end -%>
           </header>
 
-          <section param="content-body"<%= ' with-flash-messages' if aside_collections %>>
+          <section param="content-body">
 <% if main_content -%>
             <view:<%= main_content %> param="description"/>
 <% end -%>
@@ -175,8 +177,8 @@ end
 <% if collection -%>
             <section param="collection-section">
               <h3 param="collection-heading">
-                <ht key="<%= collection.to_s.tableize %>.collection.heading.<%= (is_user_model ? 'your':'other') %>" >
-                  <%= '<Your/>' if is_user_model %><%= collection.to_s.titleize %>
+                <ht key="<%= collection_class.to_s.underscore %>.collection.heading" count="&this.<%= collection.to_s %>.count" >
+                  <human-collection-name collection="<%= collection %>" your/>
                 </ht>
               </h3>
 
@@ -188,21 +190,21 @@ end
 <%   if add_link -%>
 
               <a:<%= collection %> action="new" if="&can_create?(@<%= model.name.underscore %>.<%= collection %>)" param="new-link">
-                <ht key="<%= collection.to_s.pluralize %>.actions.new">
-                  New <%= collection.to_s.singularize.titleize %>
+                <ht key="<%= collection_class.to_s.underscore %>.actions.new" count="1">
+                  New <%= collection_class.to_s.titleize %>
                 </ht>
               </a:<%= collection %>>
 <%   elsif add_form -%>
 
               <section param="add-to-collection" if="&can_create?(@<%= model.name.underscore %>.<%= collection %>)">
                 <h3 param="add-form-heading">
-                  <ht key="<%= collection.to_s.pluralize %>.collection.add_form_heading">
-                    Add <%= a_or_an collection.to_s.singularize.titleize %>
+                  <ht key="<%= collection_class.to_s.underscore %>.collection.add_form_heading" count="1">
+                    Add <%= a_or_an collection_class.to_s.titleize %>
                   </ht>
                 </h3>
                 <form with="&@<%= collection_class.name.underscore %> || new_for_current_user(@<%= model.name.underscore %>.<%= collection %>)" owner="<%= owner %>" without-cancel param>
                   <field-list: skip="<%= owner %>"/>
-                  <submit: label="#{ht '<%= sq_escape collection.to_s.pluralize %>.actions.add', :default=>['Add'] }"/>
+                  <submit: label="#{ht '<%= sq_escape collection_class.to_s.underscore %>.actions.add', :default=>['Add'] }"/>
                 </form>
               </section>
 <%   end -%>
@@ -215,23 +217,14 @@ end
         <aside param>
 <%   for refl, reverse_refl in aside_collections -%>
 <%     if linkable?(refl.klass, :"index_for_#{reverse_refl.name}") -%>
-          <preview-with-more:<%= refl.name %>.recent param="<%= refl.name %>-preview">
-<%       if is_user_model -%>
-            <heading:>
-              <ht key="hobo.undefined">  
-                <Your with="&@<%= model.name.underscore %>"/> <%= refl.name.to_s.titleize %>
-              </ht>
-            </heading:>
-<%       end -%>
-            <more:>
-              <ht key="hobo.actions.more">more</ht>
-            </more:>
-          </preview-with-more:<%= refl.name %>.recent>
+         <collection-preview:<%= refl.name %>.recent param="<%= refl.name %>-preview">
+           <heading-content:><human-collection-name with="&this.origin" collection="<%= refl.name %>" your/></heading-content:>
+         </collection-preview:<%= refl.name %>.recent>
 <%     else -%>
           <section param="<%= refl.name %>-collection-section">
             <h3 param="<%= refl.name %>-collection-heading">
-              <ht key="<%= refl.name.to_s.pluralize %>.collection.heading.other" >
-                <%= refl.name.to_s.titleize %>
+              <ht key="<%= refl.klass.to_s.underscore %>.collection.heading" count="&this.<%= refl.name.to_s %>.count" >
+                <human-collection-name collection="<%= refl.name %>" your/>
               </ht>
             </h3>
             <collection:<%= refl.name %>  param="<%= refl.name %>-collection"/>
@@ -259,7 +252,7 @@ name_attribute = model.name_attribute
       <section param="content-header">
         <h2 param="heading">
           <ht key="<%= model_key %>.edit.heading" name="&this.respond_to?(:name) ? this.name : ''">
-            Edit <type-name/>
+            Edit <%= model_name %>
           </ht>
         </h2>
         <delete-button label="#{ht '<%= model_key %>.actions.delete', :default=>['Remove This <%= sq_escape model_name %>']}" param/>
@@ -280,7 +273,7 @@ owner_model     = model.reflections[owner].klass
 linkable_owner  = linkable?(owner_model, :show)
 owner_tag       = linkable_owner ? "a" : "name"
 
-owner_is_user = owner_model < Hobo::User
+owner_is_user = owner_model < Hobo::Model::UserBase
 
 owner = model.reflections[owner].macro == :has_many ? owner.to_s.singularize : owner.to_s
 -%>
@@ -290,27 +283,21 @@ new_link = :new.in?(actions)
 -%>
 <def tag="index-for-<%= owner.dasherize %>-page" polymorphic/>
 <def tag="index-for-<%= owner.dasherize %>-page" for="<%= model.name %>">
-  <page merge title="#{ht '<%= model_key %>.index_for_owner.title', :default=>['<%= sq_escape(model_name :plural) %> for']} #{name :with => @<%= owner %>, :no_wrapper => true}">    
+  <page merge title="#{ht '<%= model_key %>.index_for_owner.title', :count=>100, :default=>['<%= sq_escape(model_name(:plural)) %> for']} #{name :with => @<%= owner %>, :no_wrapper => true}">
     <body: class="index-for-owner-page <%= owner.dasherize %> <%= model_class %>" param/>
     <content: param>
       <header param="content-header">
 <% if linkable_owner -%>
         <div param="back-to">
-          <ht key="hobo.actions.back">Back to</ht> <a with="&@<%= owner %>"/>
+          <t key="hobo.actions.back">Back to</t> <a with="&@<%= owner %>"/>
         </div>
 <% end -%>
-<% if owner_is_user %>
-        <h2 param="heading">
-          <ht key="<%= model_key %>.index_for_owner.heading.your">
-            <Your with="&@<%= owner %>"/> <%= model_name :plural %>
-          </ht>
-        </h2>
-<% else -%>
-        <h2 param="heading">
-          <ht key="<%= model_key %>.index_for_owner.heading.other">
-            <%= model_name :plural %>
+        <h2 param="heading" if="&@owner">
+          <ht key="<%= model_key %>.index_for_owner.heading" count="&@<%= owner %>.<%= collection_name %>.count">
+            <human-collection-name with="&@<%= owner %>" collection="<%= collection_name %>" your/>
           </ht>
         </h2>
+<% unless owner_is_user %>
         <h3 param="subheading">
           <ht key="<%= model_key %>.index_for_owner.subheading">
             For:
@@ -319,8 +306,8 @@ new_link = :new.in?(actions)
         </h3>
 <% end -%>
         <p param="count" if>
-          <ht key="<%= model_key %>.collection.count" count="&this.size">
-            There <count prefix="are"/>
+          <ht key="<%= model_key %>.collection.count" count="&collection_count">
+            <count summary/>
           </ht>
         </p>
       </header>
@@ -382,8 +369,8 @@ new_link = :new.in?(actions)
 <% creator_names.each do |creator| -%>
 <def tag="<%= creator.dasherize %>-page" polymorphic/>
 <def tag="<%= creator.dasherize %>-page" for="<%= model.name %>">
-  
-  <page title="#{ht '<%=model_key %>.<%= creator.underscore %>.title', :default=>['<%= sq_escape creator.titleize %>']}" merge>  
+
+  <page title="#{ht '<%=model_key %>.<%= creator.underscore %>.title', :default=>['<%= sq_escape creator.titleize %>']}" merge>
 
     <body: class="lifecycle-start-page <%= creator.dasherize %>-page" param/>