kitestrings 1.0.2 → 1.0.3

data/lib/generators/kitestrings/messages_generator.rb

@@ -1,10 +1,73 @@
 module Kitestrings
   module Generators
     class MessagesGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../message_templates", __FILE__)
 
       def setup_messages_model
         template "message.rb.erb", "app/models/message.rb"
+        copy_file "message_mailer.rb", "app/mailers/message_mailer.rb"
+        copy_file "default.text.erb", "app/views/message_mailer/default.text.erb"
+        copy_file "message_spec.rb", "spec/models/message_spec.rb"
+        copy_file "messages.rb", "spec/factories/messages.rb"
+        copy_file "messages_controller.rb", "app/controllers/messages_controller.rb"
+        copy_file "messages_controller_spec.rb", "spec/controllers/messages_controller_spec.rb"
+        copy_file "index.html.haml", "app/views/messages/index.html.haml"
+        copy_file "show.html.haml", "app/views/messages/show.html.haml"
+
+        if Dir.glob(destination_root + "/db/migrate/*create_messages.rb").count == 0
+          migration_template "message_migration.rb", "db/migrate/create_messages.rb"
+        end
+
+        routes = <<RUBY
+  resources :messages, only: [:index, :show]
+  # also nest under user, for example:
+  # resources :user do
+  #   resources :messages, only: [:index, :show]
+  # end
+RUBY
+        inject_into_file "config/routes.rb", routes, :before => /^end/
+
+
+        puts <<OUTPUT
+-------------------------------------------------------------------------------
+
+Kitestrings Message scaffold. Please complete the following manually:
+
+1. Check config/routes.rb for nesting messages under the user model. For example:
+
+  resources :user do
+    resources :messages, only: [:index, :show]
+  end
+
+2. Update CanCan abilities so users can read their messages, for example:
+
+    can(:read, Message) { |message| message.user == user }
+    can(:index_all, Message) if user.admin?
+
+3. Add the following to your user model
+
+  has_many :messages
+
+4. Set the default host. This is needed as the Message model needs to generate
+   absolute URLs to be inserted into email bodies. Example, add to routes.rb:
+
+  default_url_options :host => (ENV['DEFAULT_URL_HOST'] || 'localhost')
+
+5. Add "message" and "message_other" to your common lets. Example:
+
+  # Messages
+  let(:message) { create :message, user: user }
+  let(:message_other) { create :message, user: user_other }
+
+-------------------------------------------------------------------------------
+OUTPUT
+      end
+
+      def self.next_migration_number(dirname)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
       end
     end
   end

data/lib/generators/templates/{deploy.rb → config/deploy.rb}

@@ -5,18 +5,20 @@ require 'airbrake/capistrano'
 
 set :stages, %w(integ, uat, production)
 set :default_stage, "integ"
-set :application, 'pwi'
-set :user, 'pwi'
+set :application, 'APP_NAME'
+set :user, 'APP_NAME'
 set (:deploy_to) { "/home/#{user}/apps/#{rails_env}" }
 set :deploy_via, :remote_cache
 set :use_sudo, false
 set :scm, 'git'
-#set :repository, 'git@github.com:2rk/pwi.git'
+
+#set :repository, 'git@github.com:2rk/APP_NAME.git'
 
 set :ssl, false
-# set :ssl_certificates_path, '/home/amt/ssl'
-# set :ssl_certificates_name, 'amt'
+# set :ssl_certificates_path, '/home/APP_NAME/ssl'
+# set :ssl_certificates_name, 'APP_NAME'
 
+set :rvm_ruby_string, File.read(".ruby-version").chomp
 set :mysql_password, YAML::load_file("config/database.yml.server")["production"]["password"]
 set :bundle_flags, "--deployment"
 
@@ -68,9 +70,11 @@ conf
 
 
   task :github_ssh_key do
-    run "ssh-keygen -t rsa -f ~/.ssh/id_rsa -P ''; ssh -oStrictHostKeyChecking=no git@github.com; cat .ssh/id_rsa.pub"
+    run "if [ ! -f ~/.ssh/id_rsa ]; then ssh-keygen -t rsa -f ~/.ssh/id_rsa -P ''; fi"
+    # This will return an error back but it is not an issue
+    run "ssh -T -oStrictHostKeyChecking=no git@github.com; true"
+    run "cat .ssh/id_rsa.pub"
   end
-
   task :symlink_config do
     run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml"
   end
@@ -102,7 +106,7 @@ namespace :ruby_make do
   desc "Run a task on a remote server."
   # run like: cap staging rake:invoke task=a_certain_task
   task :invoke do
-    run("cd #{deploy_to}/current; /usr/bin/env rake #{ENV['task']} RAILS_ENV=#{rails_env}")
+    run("cd #{deploy_to}/current; bin/rake #{ENV['task']} RAILS_ENV=#{rails_env}")
   end
 end
 
@@ -121,16 +125,15 @@ namespace :deploy do
   end
   desc "reload the database with seed data"
   task :seed do
-    run "cd #{current_path}; bundle exec rake db:seed RAILS_ENV=#{rails_env}"
+    run "cd #{current_path}; bin/rake db:seed RAILS_ENV=#{rails_env}"
   end
 end
 
-namespace :rvm do
-  task :trust_rvmrc do
-    run "rvm rvmrc trust #{release_path}"
-  end
-end
-
-after "deploy", "rvm:trust_rvmrc"
 after 'deploy:setup', 'deploy:create_database', 'deploy:github_ssh_key', 'deploy:nginx_conf', 'deploy:create_shared_database_config'
 after 'deploy:cold', 'deploy:airbrake_test'
+
+before 'deploy:setup', 'rvm:install_rvm' # update RVM
+before 'deploy:setup', 'rvm:install_ruby'
+
+# load additional deploy steps and configuration from lib/capistrano/*.cap files:
+Dir["lib/capistrano/*.cap"].each { |file| load file }

data/lib/generators/templates/config/deploy/integ.rb

@@ -0,0 +1,3 @@
+set :rails_env, 'integ'
+set :branch, 'develop'
+#server 'APP_NAME.integ.tworedkites.com', :web, :app, :db, primary: true

data/lib/generators/templates/config/deploy/production.rb

@@ -0,0 +1,12 @@
+set :rails_env, 'production'
+
+$:.unshift(File.expand_path('./lib', ENV['rvm_path']))
+
+set :rvm_install_ruby_params, '--verify-downloads 1'
+set :rvm_type, :user
+set :branch, 'master'
+
+#default_run_option[:pty] = true
+ssh_options[:forward_agent] = true
+
+#server 'APP_NAME.production.tworedkites.com', :web, :app, :db, primary: true

data/lib/generators/templates/config/deploy/uat.rb

@@ -0,0 +1,3 @@
+set :rails_env, 'uat'
+set :branch, 'develop'
+#server 'APP_NAME.uat.tworedkites.com', :web, :app, :db, primary: true

data/lib/generators/templates/config/environments/integ.rb

@@ -0,0 +1,21 @@
+load File.expand_path("../production.rb", __FILE__)
+
+Rails.application.configure do
+
+  config.loglevel = :debug
+
+  # config.airbrake_api_key = 'AIRBRAKE_KEY'
+
+  # used by message model to create links (outside of a controller / mailer)
+  Rails.application.routes.default_url_options[:host] = 'APP_NAME.integ.tworedkites.com'
+
+  # config.action_mailer.delivery_method = :mail_gate
+  # config.action_mailer.mail_gate_settings = {
+  #     :whitelist => /VALIDATE_EMAIL_REGEX/,
+  #     :subject_prefix   => '[INTEG] ',
+  #     :delivery_method => :smtp,
+  #     :smtp_settings => {
+  #         :address => 'smtp.example.com'
+  #     }
+  # }
+end

data/lib/generators/templates/config/environments/uat.rb

@@ -0,0 +1,21 @@
+load File.expand_path("../production.rb", __FILE__)
+
+Rails.application.configure do
+
+  config.log_level = :info
+
+  # config.airbrake_api_key = 'AIRBRAKE_KEY'
+
+  # used by message model to create links (outside of a controller / mailer)
+  Rails.application.routes.default_url_options[:host] = 'APP_NAME.uat.tworedkites.com'
+
+  # config.action_mailer.delivery_method = :mail_gate
+  # config.action_mailer.mail_gate_settings = {
+  #     :whitelist => /VALIDATE_EMAIL_REGEX/,
+  #     :subject_prefix   => '[UAT] ',
+  #     :delivery_method => :smtp,
+  #     :smtp_settings => {
+  #         :address => 'smtp.example.com'
+  #     }
+  # }
+end

data/lib/generators/templates/views/public/403.html

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Access Denied (403)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>Access Denied.</h1>
+      <p>
+          You do not have permissions to view the current page.
+      </p>
+      <p>&nbsp;</p>
+      <p>Click <a href="/">here</a> to return to the home page.</p>
+  </div>
+</body>
+</html>

data/lib/kitestrings/menu.rb

@@ -0,0 +1,10 @@
+module Kitestrings::Menu
+  extend ActiveSupport::Concern
+
+  # include Kitestrings::Menu into ApplicationController or each controller where required.
+  included do
+    include Controller
+    helper ViewHelper
+    helper_method :current_menu_item
+  end
+end

data/lib/kitestrings/menu/admin_controller.rb

@@ -0,0 +1,21 @@
+module Kitestrings
+  module Menu::AdminController
+    def menu_context
+      Admin.new
+    end
+
+    # this class acts like a Menu::Item
+    class Admin
+
+      # pretend to be a persisted resource (new pages don't show context menu)
+      def persisted?
+        true
+      end
+
+      # use 'admin' as the menu partial name
+      def partial_name
+        "admin"
+      end
+    end
+  end
+end

data/lib/kitestrings/menu/controller.rb

@@ -0,0 +1,24 @@
+module Kitestrings
+  module Menu::Controller
+    # return an array of the menu items constructed as polymorphic paths. For example, if loaded_resources was:
+    # [Company:1, Project:2, Audit:3] then this would return an array of Menu::Item objects for the following paths:
+    #   - /companies/1
+    #   - /companies/1/projects/2
+    #   - /companies/1/projects/2/audits/3
+    #
+    # Each item is constructed with polymorphic path
+    def loaded_menu_items
+      @loaded_menu_items ||= Menu::ItemCollection.new(loaded_resources)
+    end
+
+    # get the menu item for the contextual menu (second row). On an index page, this is the item the index is nested
+    # under, if present. For normal pages it is the last item in the array.
+    def current_menu_item
+      if action_name == "index"
+        loaded_menu_items[-2]
+      else
+        loaded_menu_items[-1]
+      end
+    end
+  end
+end

data/lib/kitestrings/menu/item.rb

@@ -0,0 +1,94 @@
+module Kitestrings::Menu
+  # A class to represent an item in the menu. It is capable of looking up menu item paths and names and a link id,
+  # all the required data to construct links, include links to subpaths
+  class Item
+    include Rails.application.routes.url_helpers
+
+    attr :resources
+    attr_accessor :active
+
+    def initialize(resources)
+      @resources = resources
+    end
+
+    # the path of the item. eg: /companies/1/projects/2/audits/3
+    def path
+      @path ||= polymorphic_path @resources
+    end
+
+    # return a new item with the given extra resources added to the resource list.
+    def sub_item(*extras)
+      Item.new([*@resources, *extras].compact)
+    end
+
+    def parent_item
+      Item.new(resources[0..-2])
+    end
+
+    # return the menu display name for the object. This defaults to the .name method of an instance, and the
+    # localised human name for classes.
+    def name
+      object.try(:menu_display_name)
+    end
+
+    # return the name of a menu partial to use for contextual menus relating to this item.
+    def partial_name
+      last = @resources.last
+      klass = last.is_a?(Class) ? last : last.class
+      klass.model_name.underscore
+    end
+
+    # fetch the last object in the chain. This is the resource that is actually being rendered. If this is an
+    # index action, this will be the class representing the type to be shown in the list.
+    def object
+      @resources.last
+    end
+
+    # a string to use as a link id in the menu link. Eg: for the path /companies/1/projects/2, the link would be
+    # menu_companies_projects_link
+    def link_id
+      names = @resources.map do |resource|
+        case resource
+          when Class
+            resource.name.pluralize.downcase
+          else
+            resource.class.name.downcase
+        end
+      end
+      "menu_#{names.join('_')}_link"
+    end
+
+    # Active is set on the last item in the Menu::ItemCollection based on the assumption that this is the active item
+    # in the collection.
+    def active?
+      @active
+    end
+
+    # Should the item be hidden in the menus? If so, menu_link_to will not generate any output. Implement a menu_hidden
+    # instance or class method to hide that instance or class from the menu.
+    def hidden?
+      if object.respond_to? :menu_hidden
+        object.menu_hidden
+      end
+    end
+
+    def collection?
+      object.is_a?(Class)
+    end
+
+    # if this item is for a resource instance (eg: companies/1 => <# Company id:1 #>, then make a new item representing
+    # the collection of that class, eg: companies/ => <# Company class #>
+    def index_item
+      if @resources.last && @resources.last.is_a?(ActiveRecord::Base)
+        index_resources = @resources.dup
+        index_resources << index_resources.pop.class
+        Item.new index_resources
+      end
+    end
+
+    # true if the object is persisted. Classes are not persisted.
+    def persisted?
+      object.respond_to?(:persisted?) && object.persisted?
+    end
+  end
+end

data/lib/kitestrings/menu/item_collection.rb

@@ -0,0 +1,29 @@
+require 'delegate'
+
+module Kitestrings
+  class Menu::ItemCollection < ::SimpleDelegator
+    attr :items
+
+    def initialize(loaded_resources)
+      length = loaded_resources.length
+      @items = (0...length).map do |count|
+        Menu::Item.new loaded_resources[0..count]
+      end
+
+      # if the last item in the resources is a new_record? object, then substitute it for the class. This will
+      # cause polymorphic path to show the #index action in the breadcrumb instead of the new action, or a route
+      # error looking for an object that has no id.
+      last = @items.last
+      if last && last.object.respond_to?(:new_record?) && last.object.new_record?
+        @items.pop
+        @items << Menu::Item.new(last.resources[0..-2] + [last.object.class])
+      end
+
+      # the last item in the array is assumed to be active.
+      @items.last.active = true unless items.empty?
+
+      # delegate all methods to this array object
+      super(@items)
+    end
+  end
+end

data/lib/kitestrings/menu/model.rb

@@ -0,0 +1,29 @@
+module Kitestrings::Menu::Model
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :menu_name_method
+
+    # default to :name
+    self.menu_name_method = :name
+  end
+
+  # get the display name for this item in the menu structure. Defaults to the :name method, can be specified by setting
+  # the menu_name_method class attribute on the class.
+  def menu_display_name
+    case
+      when respond_to?(menu_name_method)
+        self.send(menu_name_method)
+      else
+        "##{to_key}"
+    end
+  end
+
+  module ClassMethods
+    # Get the display name of the collection for this class (index action). This uses ActiveModel::Naming to fetch
+    # the plural name of the resource class.
+    def menu_display_name
+      self.model_name.human.pluralize.titlecase
+    end
+  end
+end