hobo 1.1.0 → 1.3.0.RC

data/lib/generators/hobo/subsite.rb

@@ -0,0 +1,48 @@
+require 'fileutils'
+module Generators
+  module Hobo
+    Subsite = classy_module do
+
+      include Generators::Hobo::InviteOnly
+      include Generators::Hobo::Taglib
+
+      class_option :make_front_site,
+                 :type => :boolean,
+                 :desc => "Rename application.dryml to front_site.dryml"
+
+      # check_class_collision :suffix => 'SiteController'
+
+      def move_and_generate_files
+        if options[:make_front_site]
+          unless can_mv_application_to_front_site?
+            say "Cannot rename application.dryml to #{file_name}_site.dryml"
+            exit 1
+          end
+          say "Renaming app/views/taglibs/application.dryml to app/views/taglibs/front_site.dryml" \
+              unless options[:quiet]
+          unless options[:pretend]
+            FileUtils.mv('app/views/taglibs/application.dryml', "app/views/taglibs/front_site.dryml")
+            copy_file "application.dryml", 'app/views/taglibs/application.dryml'
+          end
+        end
+
+        template "controller.rb.erb", File.join('app/controllers', file_name, "#{file_name}_site_controller.rb")
+      end
+
+      hook_for :test_framework, :as => :controller do | instance, controller_test |
+        instance.invoke controller_test, ["#{instance.name}_site"]
+      end
+
+      private
+
+      def subsite_name
+        class_name
+      end
+
+      def can_mv_application_to_front_site?
+        File.exist?('app/views/taglibs/application.dryml') && !File.exist?('app/views/taglibs/front_site.dryml')
+      end
+
+    end
+  end
+end

data/lib/generators/hobo/subsite/subsite_generator.rb

@@ -0,0 +1,16 @@
+module Hobo
+  class SubsiteGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def self.banner
+      "rails generate hobo:subsite NAME [options]"
+    end
+
+    include Generators::Hobo::Subsite
+
+    def generate_site_taglib
+      invoke 'hobo:subsite_taglib', [name], options
+    end
+
+  end
+end

data/{rails_generators/hobo_subsite/templates/controller.rb → 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/subsite_taglib/subsite_taglib_generator.rb

@@ -0,0 +1,16 @@
+module Hobo
+  class SubsiteTaglibGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+    include Generators::Hobo::InviteOnly
+    include Generators::Hobo::Taglib
+
+    def self.banner
+      "rails generate hobo:subsite_taglib NAME [options]"
+    end
+
+    def generate_taglib
+      template "taglib.dryml.erb", File.join('app/views/taglibs', "#{file_name}_site.dryml")
+    end
+
+  end
+end

data/{rails_generators/hobo_admin_site/templates/site_taglib.dryml → lib/generators/hobo/subsite_taglib/templates/taglib.dryml.erb}

@@ -1,32 +1,31 @@
-<!-- Tag definitions for the <%= subsite_name %> subsite -->
-  
-<% if options[:rapid] -%>
-<include src="rapid" plugin="hobo"/>
+<!-- Tag definitions for the <%= file_name %> subsite -->
+
+<include src="rapid" gem="hobo"/>
 
 <include src="taglibs/auto/<%= file_name %>/rapid/cards"/>
 <include src="taglibs/auto/<%= file_name %>/rapid/pages"/>
 <include src="taglibs/auto/<%= file_name %>/rapid/forms"/>
 
 <set-theme name="clean"/>
-<% end -%>
 
-<def tag="app-name"><%= app_name %></def>
+<% if options[:admin]%>
 
 <extend tag="page">
   <old-page merge>
     <append-stylesheets:>
-      <stylesheet name="admin"/>
+      <stylesheet name="<%= file_name %>"/>
     </append-stylesheets:>
     <footer:>
-      <a href="#{base_url}/">View Site</a>
+      <a href="#{base_url}/"><t key="hobo.subsite.back_link">View Site</t></a>
     </footer:>
   </old-page>
 </extend>
+<% end -%>
 <% if invite_only? -%>
 
-<extend tag="card" for="User">
+<extend tag="card" for="<%= options[:user_resource_name].camelcase %>">
   <old-card merge>
     <append-header:><%%= h this.state.titleize %></append-header:>
   </old-card>
 </extend>
-<% end -%>
+<% end -%>

data/lib/generators/hobo/taglib.rb

@@ -0,0 +1,12 @@
+module Generators
+  module Hobo
+    Taglib = classy_module do
+
+      class_option :user_resource_name,
+                   :type => :string,
+                   :desc => "User Resource Name",
+                   :default => 'user'
+
+    end
+  end
+end

data/lib/generators/hobo/test_framework/test_framework_generator.rb

@@ -0,0 +1,72 @@
+require 'bundler/cli'
+module Hobo
+  class TestFrameworkGenerator < Rails::Generators::NamedBase
+
+    include Generators::Hobo::TestOptions
+
+    FRAMEWORKS = %w[test_unit rspec shoulda rspec_with_shoulda]
+
+    def self.banner
+      "rails generate hobo:test_framework NAME [options]"
+    end
+
+    def initialize(*)
+      super
+      @finalize_hooks = []
+    end
+
+    def setup_framework
+      if FRAMEWORKS.include?(name)
+        eval 'setup_' + name
+      else
+        say "'#{name}' is not supported. You should configure it manually."
+        exit 1
+      end
+    end
+
+    def fixture_replacement_installation
+      return if options[:fixture_replacement].blank?
+      gem options[:fixture_replacement], :group => :test
+    end
+
+    def finalize_installation
+      # add the block only if it's not the default
+      add_generators_block unless (name == 'test_unit' && options[:fixtures] && options[:fixture_replacement].blank?)
+      invoke Bundler::CLI, :update if options[:update] && @should_update
+      @finalize_hooks.each {|h| h.call }
+    end
+
+private
+
+    def setup_test_unit
+    end
+
+    def setup_rspec
+      gem 'rspec-rails', '>= 2.5.0', :group => [:test, :development]
+      @should_update = true
+      return unless options[:update]
+      @finalize_hooks << lambda {say "Finalizing rspec installation..."; system 'rails g rspec:install'}
+    end
+
+    def setup_shoulda
+      gem 'shoulda', :group => :test
+      @should_update = true
+    end
+
+    def setup_rspec_with_shoulda
+      setup_rspec
+      setup_shoulda
+    end
+
+    def add_generators_block
+      n = name == 'rspec_with_shoulda' ? 'rspec' : name
+      block = "\n    config.generators do |g|"
+      block << "\n      g.test_framework :#{n}, :fixtures => #{options[:fixtures].inspect}" if !options[:fixtures] || name != 'test_unit'
+      block << "\n      g.fallbacks[:#{n}] = :test_unit" unless name == 'test_unit'
+      block << "\n      g.fixture_replacement = :#{options[:fixture_replacement]}" unless options[:fixture_replacement].blank?
+      block << "\n    end\n"
+      environment block
+    end
+
+  end
+end

data/lib/generators/hobo/test_options.rb

@@ -0,0 +1,19 @@
+module Generators
+  module Hobo
+    TestOptions = classy_module do
+
+      class_option :test_framework, :type => :string,
+      :desc => "Use a specific test framework"
+
+      class_option :fixtures, :type => :boolean,
+      :desc => "Add the fixture option to the test framework", :default => true
+
+      class_option :fixture_replacement, :type => :string,
+      :desc => "Use a specific fixture replacement"
+
+      class_option :update, :type => :boolean,
+      :desc => "Run bundle update to install the missing gems"
+
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+class <%= class_name %>Controller < ApplicationController
+
+  hobo_user_controller
+
+  auto_actions :all, :except => [ :index, :new, :create ]
+
+  # Normally, users should be created via the user lifecycle, except
+  #  for the initial user created via the form on the front screen on
+  #  first run.  This method creates the initial user.
+  def create
+    hobo_create do
+      if valid?
+        self.current_user = this
+        flash[:notice] = t("hobo.messages.you_are_site_admin", :default=>"You are now the site administrator")
+        redirect_to home_page
+      end
+    end
+  end
+<% if invite_only? -%>
+
+  def do_accept_invitation
+    do_transition_action :accept_invitation do
+      if this.valid?
+        self.current_user = this
+        flash[:notice] = t("hobo.messages.you_signed_up", :default=>"You have signed up")
+      end
+    end
+  end
+<% end -%>
+
+end

data/lib/generators/hobo/user_controller/user_controller_generator.rb

@@ -0,0 +1,25 @@
+module Hobo
+  class UserControllerGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    # overrides the default
+    argument :name, :type => :string, :default => 'users', :optional => true
+
+    include Generators::Hobo::Controller
+    include Generators::Hobo::InviteOnly
+
+    def self.banner
+      "rails generate hobo:user_controller [NAME=users] [options]"
+    end
+
+    def generate_controller
+      template 'controller.rb.erb', File.join('app/controllers',"#{file_path}_controller.rb")
+    end
+
+    def generate_accept_invitation
+      return unless invite_only?
+      template "accept_invitation.dryml", File.join('app/views', file_path, "accept_invitation.dryml")
+    end
+
+  end
+end

data/lib/generators/hobo/user_mailer/templates/activation.erb

@@ -0,0 +1,9 @@
+<%%= @<%= name.underscore -%> %>,
+
+To activate your account for <%%= @app_name %>, click on this link:
+
+  <%%= <%= name.underscore -%>_activate_url :id => @<%= name.underscore -%>, :key => @key %>
+
+Thank you,
+
+The <%%= @app_name %> team.

data/{rails_generators/hobo_user_model → lib/generators/hobo/user_mailer}/templates/forgot_password.erb

@@ -1,9 +1,9 @@
-<%%= @user %>,
+<%%= @<%= name.underscore -%> %>,
 
 If you have forgotten your password for <%%= @app_name %>, you can choose
 a new one by clicking on this link:
 
-  <%%= <%= name -%>_reset_password_url :host => @host, :id => @user, :key => @key %>
+  <%%= <%= name.underscore -%>_reset_password_url :id => @<%= name.underscore -%>, :key => @key %>
 
 Thank you,
 

data/{rails_generators/hobo_user_model → lib/generators/hobo/user_mailer}/templates/invite.erb

@@ -1,8 +1,8 @@
-<%%= @user %>,
+<%%= @<%= name.underscore %> %>,
 
 You have been invited to join <%%= @app_name %>. If you wish to accept, please click on the following link
 
-  <%%= user_accept_invitation_url :host => @host, :id => @user, :key => @key %>
+  <%%= <%= name.underscore %>_accept_invitation_url :id => @<%= name.underscore %>, :key => @key %>
 
 Thank you,
 

data/lib/generators/hobo/user_mailer/templates/mailer.rb.erb

@@ -0,0 +1,25 @@
+class <%= class_name -%>Mailer < ActionMailer::Base
+  default :from => "no-reply@#{host}"
+
+  def forgot_password(<%= name.underscore %>, key)
+    @<%= name.underscore %>, @key = <%= name.underscore %>, key
+    mail( :subject => "#{app_name} -- forgotten password",
+          :to      => <%= name.underscore %>.email_address )
+  end
+
+<% if invite_only? -%>
+  def invite(<%= name.underscore %>, key)
+    @<%= name.underscore %>, @key = <%= name.underscore %>, key
+    mail( :subject => "Invitation to #{app_name}",
+          :to      => <%= name.underscore %>.email_address )
+  end
+
+<% elsif options[:activation_email] %>
+  def activation(<%= name.underscore %>, key)
+    @<%= name.underscore %>, @key = <%= name.underscore %>, key
+    mail( :subject => "#{app_name} -- activate",
+          :to      => <%= name.underscore %>.email_address )
+  end
+
+<% end -%>
+end

data/lib/generators/hobo/user_mailer/user_mailer_generator.rb

@@ -0,0 +1,33 @@
+module Hobo
+  class UserMailerGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    # overrides the default
+    argument :name, :type => :string, :default => 'user', :optional => true
+
+    include Generators::Hobo::InviteOnly
+    include Generators::Hobo::ActivationEmail
+
+    def self.banner
+      "rails generate hobo:user_mailer [NAME=user] [options]"
+    end
+
+    # check_class_collision :suffix => 'Mailer'
+
+    def generate_mailer
+      template 'mailer.rb.erb', File.join('app/mailers', "#{file_path}_mailer.rb")
+    end
+
+    def generate_mails
+      mailer_dir = File.join("app/views", class_path[0..-2], "#{file_name.singularize}_mailer")
+      template 'forgot_password.erb', File.join(mailer_dir, "forgot_password.erb")
+      template( 'invite.erb', File.join(mailer_dir, "invite.erb")) if invite_only?
+      template( 'activation.erb', File.join(mailer_dir, "activation.erb")) if options[:activation_email]
+    end
+
+    hook_for :test_framework, :as => :mailer do | instance, mailer |
+      instance.invoke mailer, ["#{instance.name}_mailer"]
+    end
+
+  end
+end

data/lib/generators/hobo/user_model/USAGE

@@ -0,0 +1,12 @@
+Description:
+    The model generator creates stubs for a new user model.
+
+    The generator takes a model name as its argument.  The
+    model name may be given in CamelCase or under_score and
+    should not be suffixed with 'Model'.
+
+    The generator creates a model class in app/models, invokes
+    the hobo:user_mailer andgenerator the test framework.
+
+Examples:
+    $ rails generate hobo:user_model User

data/{rails_generators/hobo_user_model/templates/model.rb → lib/generators/hobo/user_model/templates/model_injection.rb.erb}

@@ -1,4 +1,3 @@
-class <%= class_name %> < ActiveRecord::Base
 
   hobo_user_model # Don't put anything above this
 
@@ -9,17 +8,22 @@ class <%= class_name %> < ActiveRecord::Base
     timestamps
   end
 
-  # This gives admin rights to the first sign-up.
+  # This gives admin rights and an :active state to the first sign-up.
   # Just remove it if you don't want that
-  before_create { |user| user.administrator = true if !Rails.env.test? && count == 0 }
+  before_create do |user|
+    if !Rails.env.test? && user.class.count == 0
+      user.administrator = true
+      user.state = "active"
+    end
+  end
 
 <% if invite_only? -%>
   def new_password_required_with_invite_only?
-    new_password_required_without_invite_only? || User.count==0
+    new_password_required_without_invite_only? || self.class.count==0
   end
   alias_method_chain :new_password_required?, :invite_only
 <% end -%>
-  
+
   # --- Signup lifecycle --- #
 
   lifecycle do
@@ -30,46 +34,64 @@ class <%= class_name %> < ActiveRecord::Base
 
     create :invite,
            :available_to => "acting_user if acting_user.administrator?",
+           :subsite => "<%= options[:admin_subsite_name] %>",
            :params => [:name, :email_address],
            :new_key => true,
            :become => :invited do
-       UserMailer.deliver_invite(self, lifecycle.key)
+       <%= class_name %>Mailer.invite(self, lifecycle.key).deliver
     end
-  
+
     transition :accept_invitation, { :invited => :active }, :available_to => :key_holder,
                :params => [ :password, :password_confirmation ]
-  
+
+<% elsif options[:activation_email] -%>
+    state :inactive, :default => true
+    state :active
+
+    create :signup, :available_to => "Guest",
+      :params => [:name, :email_address, :password, :password_confirmation],
+      :become => :inactive, :new_key => true  do
+      <%= class_name %>Mailer.activation(self, lifecycle.key).deliver
+    end
+
+    transition :activate, { :inactive => :active }, :available_to => :key_holder
+
+    transition :request_password_reset, { :inactive => :inactive }, :new_key => true do
+      <%= class_name %>Mailer.activation(self, lifecycle.key).deliver
+    end
+
 <% else -%>
     state :active, :default => true
 
     create :signup, :available_to => "Guest",
            :params => [:name, :email_address, :password, :password_confirmation],
            :become => :active
-             
+
 <% end -%>
     transition :request_password_reset, { :active => :active }, :new_key => true do
-      <%= class_name %>Mailer.deliver_forgot_password(self, lifecycle.key)
+      <%= class_name %>Mailer.forgot_password(self, lifecycle.key).deliver
     end
 
     transition :reset_password, { :active => :active }, :available_to => :key_holder,
                :params => [ :password, :password_confirmation ]
 
   end
-  
 
+<% if options[:activation_email] -%>
+  def signed_up?
+    state=="active"
+  end
+
+<% end -%>
   # --- Permissions --- #
 
   def create_permitted?
-<% if invite_only? -%>
-    # Only the initial admin user can be created, from there it's invite-only
-    User.count == 0
-<% else -%>
-    false
-<% end -%>
+    # Only the initial admin user can be created
+    self.class.count == 0
   end
 
   def update_permitted?
-    acting_user.administrator? || 
+    acting_user.administrator? ||
       (acting_user == self && only_changed?(:email_address, :crypted_password,
                                             :current_password, :password, :password_confirmation))
     # Note: crypted_password has attr_protected so although it is permitted to change, it cannot be changed
@@ -83,5 +105,3 @@ class <%= class_name %> < ActiveRecord::Base
   def view_permitted?(field)
     true
   end
-
-end