your_platform 0.0.1 → 0.0.2

data/app/models/may_need_review.rb

@@ -0,0 +1,54 @@
+module MayNeedReview
+  
+  def may_need_review
+    
+    raise 'The model needs to be able to have flags associated.' if not self.instance_methods.include? :flags
+    
+    extend ClassMethods
+    include InstanceMethods
+    
+  end
+  
+  module ClassMethods
+  
+    # This class method gets all ProfileFields that are marked as :needs_review.
+    # 
+    def find_all_that_need_review
+      self.joins(:flags).where('flags.key' => :needs_review, 'flags.flagable_type' => 'ProfileField')
+    end
+    
+    # This class method gets all ProfileFields that match the given ids
+    # and are marked as :needs_review.
+    #
+    def find_all_that_need_review_by_profile_field_ids(profile_field_ids)
+      self.find_all_that_need_review.where(id: profile_field_ids)
+    end
+    
+  end
+
+  module InstanceMethods
+    
+    def needs_review?
+      has_flag? :needs_review
+    end
+    def needs_review!
+      self.needs_review = true
+    end
+    def needs_review
+      self.needs_review?
+    end
+    def needs_review=(new_needs_review)
+      new_needs_review = false if new_needs_review == "false"
+      if new_needs_review != self.needs_review
+        attribute_will_change!(:needs_review) 
+      end
+      if new_needs_review
+        self.add_flag :needs_review
+      else
+        self.remove_flag :needs_review
+      end
+    end
+    
+  end
+
+end

data/app/models/metric_logger.rb

@@ -0,0 +1,83 @@
+# This class provides an interface to log events in a metrics database.
+# Here, fnordmetric and redis are used.
+#
+# For more information, check out this resources:
+#
+#   * http://railscasts.com/episodes/378-fnordmetric
+#   * https://github.com/paulasmuth/fnordmetric
+#
+# In the ApplicationController, this class is instanciated as 
+# metric_logger, which is made available as controller helper method.
+# 
+# This, you may access this in a controller like this:
+#
+#   class UsersController
+#     def show
+#       # ...
+#       metric_logger.log_event(@user, type: 'show_user')
+#     end
+#   end
+#
+class MetricLogger
+  
+  def initialize(options = {})
+    @current_user = options[:current_user]
+    @session_id = options[:session_id]
+  end
+  
+  def current_user
+    @current_user
+  end
+  
+  def session_id
+    #@session_id
+    @current_user.try(:id).try(:to_s)
+  end
+  
+  # Log the event with the given information.
+  # The FNORD_METRIC constant, which provides a direct connection to the redis
+  # database, is defined in the fnordmetric initializer:
+  #   config/initializers/fnordmetric.rb
+  #
+  # options: 
+  #   type :    the type of event that is recorded here
+  #
+  def log_event(data, options = {})
+    register_session unless options[:type].in? ["_set_name", "_set_picture"]
+    data.merge!({ _type: options[:type] })
+    data.merge!({ _session: session_id })
+    FNORD_METRIC.event(data) unless Rails.env.test?
+  end
+  
+  # This is a shortcut for one-line logs, where no current_user is required.
+  # Then, one may just call:
+  # 
+  #   MetricLogger.log_event(...) 
+  # 
+  def self.log_event(data, options = {})
+    self.new.log_event(data, options)
+  end
+  
+  # These options tells fnordmetric, which user does the request. 
+  #   http://fnordmetric.io/documentation/classic_event_handlers/
+  #
+  # We use the user's unique id as session id, since 
+  def register_session
+    if current_user
+      log_event({ name: current_user.title }, type: "_set_name")
+      log_event({ url: ApplicationController.helpers.user_avatar_url(current_user) }, type: "_set_picture")
+    end
+  end
+  
+  def log_cpu_usage
+    if RUBY_PLATFORM.to_s.include? "linux"
+      cpu_usage = `top -bn1 | grep "Cpu(s)" | \
+             sed "s/.*, *\([0-9.]*\)%* id.*/\1/" | \
+             awk '{print 100 - $1}'`.to_i 
+    end
+    if cpu_usage
+      log_event({ percentage: cpu_usage }, type: :cpu_usage)
+    end
+  end
+  
+end

data/app/models/nav_node.rb

@@ -0,0 +1,169 @@
+# -*- coding: utf-8 -*-
+#
+# Each Navable object has got an associated NavNode, i.e. an object representing the information
+# relevant to the position of the Navable object within the navigational structure.
+#
+class NavNode < ActiveRecord::Base
+  attr_accessible :breadcrumb_item, :hidden_menu, :menu_item, :slim_breadcrumb, :slim_menu, :slim_url, :url_component
+
+  belongs_to :navable, polymorphic: true
+
+  # The +url_component+ represents the part of the url, which is contributed by
+  # the Navable object. 
+  #
+  # If you have the following url 
+  #   http://example.com/products/phones/ ,
+  # and the current Navable is the Page @products_page, then its +url_component+ is
+  # 'products/'.
+  #
+  #     @products_page = Page.find_by_title("Products")
+  #     @products_page.nav_node.url_component  # => "products/"
+  #
+  # The default +url_component+ uses the Navable's title.
+  # But you can override the url_component of a Navable just by setting it.
+  # 
+  #     @nav_node = @products_page.nav_node
+  #     @nav_node.url_component = "our_products/"
+  #     @nav_node.save
+  # 
+  def url_component
+    super || "#{self.navable.title.parameterize}/"
+  end
+
+  # The +breadcrumb_item+ is the string representing the Navable in a breadcrumb navigation.
+  # 
+  # For example:   example.com  >  Products  >  Phones
+  #                                --------
+  # The String "Products" is the +breadcrumb_item+ of the @products_page. 
+  # It defaults to the Navable's title and can be customized using the setter method
+  # +breadcrumb_item=+.
+  #
+  def breadcrumb_item
+    super || self.navable.title
+  end
+  
+  # The +menu_item+ is the string representing the Navable in the vertical menu.
+  # It defaults to the Navable's title and can be customized using the setter method
+  # +menu_item=+.
+  #
+  def menu_item
+    super || self.navable.title
+  end
+  
+  # The +hidden_menu+ attribute says if the Navable should be hidden from
+  # the vertical menu. 
+  #
+  # By default, 
+  #   * Pages are shown in the menu
+  #   * Groups are shown in the menu
+  #   *   exception: The :officers_parent groups are hidden in the menu.
+  #   * Users are hidden in the menu
+  #   * Events are hidden in the menu
+  #   * Workflows are hidden in the menu
+  #
+  # You can override the setting for a Navable by using the setter method 
+  # +hidden_menu=+ on the NavNode.
+  #
+  def hidden_menu
+    hidden = super
+    hidden = true if self.navable.kind_of? User if hidden.nil?
+    hidden = true if self.navable.kind_of? Event if hidden.nil?
+    hidden = true if self.navable.title == I18n.t(:officers_parent) if hidden.nil?
+    hidden = true if self.navable.kind_of?(Page) && (self.navable.type == "BlogPost")
+    hidden = false if hidden.nil?
+    return hidden
+  end
+  
+  # +slim_breadcrumbs+ marks if the Navable should be hidden from the breadcrumb navigation
+  # in order to save space.
+  # 
+  # By default, no element is hidden from the breadcrumb navigation.
+  # To hide an element, just set 
+  #
+  #   @some_page.nav_node.update_attribute(:slim_breadcrumb, true)
+  # 
+  def slim_breadcrumb
+    super || false
+  end
+
+  # +url+ returns the joined url_components of this NavNode's Navable and its ancestors
+  # resulting in the generated url of the Navable.
+  # 
+  # Example:
+  #   Breadcrumb:  Example.com  >  Products  >  Phones
+  #   Url:         http://example.com/products/phones
+  #
+  # A possible trailing slash is removed from the +url+. Thus, the example's url does
+  # end on 'phones' rather than 'phones/'.
+  #
+  def url
+    url = ancestor_nodes_and_self.collect do |nav_node|
+      nav_node.url_component
+    end.join.gsub( /(\/)$/, '' ) # The gsub call removes the trailing slash.
+  end
+  
+  # +breadcrumbs+ returns an Array of breadcrumb Hashes representing the route to the
+  # Navable associated with this NavNode.
+  #
+  # Example:
+  #   Breadcrumb:  Example.com  >  Products  >  Phones
+  #   Url:         http://example.com/products/phones
+  #
+  #     @phones_page.nav_node.breadcrumbs  
+  #       # => [ {title: "Example.com", navable: @root_page, slim: false},
+  #              {title: "Products", navable: @products_page, slim: false},
+  #              {title: "Phones", navable: @phones_page, slim: false} ]
+  #
+  def breadcrumbs
+    breadcrumbs_to_return = []
+    navables = self.ancestor_navables_and_own
+    for navable in navables do
+      breadcrumbs_to_return << { title: navable.nav_node.breadcrumb_item, 
+                                 navable: navable, 
+                                 slim: navable.nav_node.slim_breadcrumb }
+    end
+    return breadcrumbs_to_return
+  end
+
+  # This returns the Navable ancestors of the Navable associated with this NavNode as an Array.
+  #
+  def ancestor_navables
+    path = []
+    current_navable = self.navable
+    until current_navable.nil?
+      new_navable = nil
+      new_navable ||= current_navable.status_group_in_primary_corporation if current_navable.kind_of? User
+      new_navable ||= current_navable.parents.select do |parent|
+        parent.respond_to? :nav_node
+      end.first
+      path << new_navable if new_navable
+      current_navable = new_navable
+    end
+    path.reverse
+  end
+  
+  # This returns the Navable ancestors of the Navable associated with this NavNode as an Array
+  # plus this NavNode's Navable as last element.
+  #
+  def ancestor_navables_and_own
+    ancestor_navables + [ self.navable ]
+  end
+  
+  # +ancestor_nodes+ returns an Array of the NavNodes of the ancestors of the Navable
+  # associated with this NavNode.
+  #
+  def ancestor_nodes
+    @ancestor_nodes ||= self.ancestor_navables.collect do |ancestor|
+      ancestor.nav_node
+    end
+  end
+  
+  # +ancestor_nodes_and_self+ returns an Array of the NavNodes of the ancestors of the
+  # Navable associated with this NavNode  plus  this NavNode as last element.
+  # 
+  def ancestor_nodes_and_self
+    ancestor_nodes + [ self ]
+  end
+
+end
+

data/app/models/navable.rb

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+#
+# This module provides the +is_navable+ method for ActiveRecord::Base.
+# Calling this method marks the model (User, Page, ...) as navable, i.e. has menu, breadcrumbs, etc. 
+#
+# The inclusion in ActiveRecord::Base is done in
+# config/initializers/active_record_navable_extension.rb.
+#
+
+module Navable
+  def is_navable
+    has_one                :nav_node, as: :navable, dependent: :destroy, autosave: true
+    
+    include InstanceMethodsForNavables
+  end
+  module InstanceMethodsForNavables
+    def is_navable? 
+      true
+    end
+    
+    def navable?
+      is_navable?
+    end
+
+    def nav_node
+      node = super
+      node = build_nav_node unless node
+      return node
+    end
+
+    def navnode
+      nav_node
+    end
+
+    def nav
+      nav_node
+    end
+
+    def navable_children
+      children.select { |child| child.respond_to? :nav_node }
+    end
+
+    private
+
+  end
+end

data/app/models/object_to_b_extension.rb

@@ -0,0 +1,12 @@
+module ObjectToBExtension
+
+  # This method converts the object to the boolean type.
+  # The method returns either +true+ or +false+.
+  #
+  def to_b 
+    !! self
+  end
+
+end
+
+Object.send( :include, ObjectToBExtension )

data/app/models/page.rb

@@ -0,0 +1,212 @@
+class Page < ActiveRecord::Base
+
+  attr_accessible        :content, :title, :redirect_to, :author
+
+  is_structureable       ancestor_class_names: %w(Page User Group Event), descendant_class_names: %w(Page User Group)
+  is_navable
+
+  has_many :attachments, as: :parent, dependent: :destroy
+
+  belongs_to :author, :class_name => "User", foreign_key: 'author_user_id'
+  
+
+  def fill_cache
+    group
+  end
+  
+  
+  # This is the page title. If the title is not given in the
+  # database, try to translate the flag of the page, e.g. 
+  # for the 'imprint' page.
+  #
+  def title
+    super.present? ? super : I18n.translate(self.flags.first, default: '')
+  end
+  
+  # This is the group the page belongs to, for example:
+  #
+  #     group_1
+  #       |----- group_2
+  #       |        |------ page_2 : belongs to group_2
+  #       |
+  #       |--------------- page_1 : belongs to group_1
+  #
+  def group
+    # Do not use `ancestor_groups.last` here. Where this would work somethimes, it depends on the
+    # order of creation of the links.
+    cached do
+      next_parent = parent_groups.first || parent_pages.first
+      until next_parent.nil? or next_parent.kind_of? Group
+        next_parent = next_parent.parent_groups.first || next_parent.parent_pages.first
+      end
+      next_parent
+    end
+  end
+
+  # Url
+  # ----------------------------------------------------------------------------------------------------
+
+  # This sets the format of the Page urls to be
+  # 
+  #     example.com/pages/24-products
+  #
+  # rather than just
+  #
+  #     example.com/pages/24
+  #
+  def to_param
+    "#{id} #{title}".parameterize
+  end
+  
+  
+  # Quick Assignment of Children
+  # ----------------------------------------------------------------------------------------------------
+
+  # Add a child to this page. This could be a blog entry or another page or even a group.
+  # Example:
+  # 
+  #     my_page << another_page
+  #
+  def <<(child)
+    unless child.in? self.children
+      if child.in? self.descendants
+        link = DagLink.where(
+          ancestor_type: 'Page', ancestor_id: self.id, 
+          descendant_type: child.class.name, descendant_id: child.id
+        ).first
+        link.make_direct
+        link.save
+      else
+        self.child_pages << child if child.kind_of? Page
+        self.child_groups << child if child.kind_of? Group
+      end
+    end
+  end
+
+
+  # Redirection
+  # ----------------------------------------------------------------------------------------------------
+
+  def redirect_to
+
+    # http://example.com
+    return super if super.kind_of?(String) && super.include?("://")
+
+    # users#index
+    if super.kind_of?(String) && super.include?("#")
+      controller, action = super.split("#")
+      return { controller: controller, action: action } if controller && action
+    end
+
+    # { controller: "users", action: "index" }
+    return super if super.kind_of? Hash
+
+    # else
+    return nil
+  end
+
+
+
+  # Association Related Methods
+  # ----------------------------------------------------------------------------------------------------
+
+  # This return alls attachments of a certain type.
+  # +type+ could be something like `image` or `pdf`. It will be compared to the attachments' mime type.
+  #
+  def attachments_by_type( type )
+    attachments.find_by_type type
+  end
+
+
+  # Blog Entries
+  # ----------------------------------------------------------------------------------------------------
+
+  # This method returns all Page objects that can be regarded as blog entries of self.
+  # Blog entries are simply child pages of self that have the :blog_entry flag.
+  # They won't show up in the vertical menu.
+  #
+  # Page: "My Blog"
+  #   |------------------ Page: "Entry 1"
+  #   |------------------ Page: "Entry 2"
+  #
+  def blog_entries
+    self.child_pages.where(type: "BlogPost").order('created_at DESC')
+  end
+
+
+  # Finder and Creator Methods
+  # ----------------------------------------------------------------------------------------------------
+
+
+  # root
+
+  def self.find_root
+    Page.find_by_flag( :root )
+  end
+
+  def self.find_or_create_root
+    self.find_root || self.create_root
+  end
+
+  def self.create_root(attrs = {})
+    root_page = Page.create(title: "Root")
+    root_page.update_attributes attrs
+    root_page.add_flag :root
+    n = root_page.nav_node; n.slim_menu = true; n.save; n = nil
+    return root_page
+  end
+
+
+  # intranet root
+
+  def self.find_intranet_root
+    Page.find_by_flag( :intranet_root )
+  end
+
+  def self.find_or_create_intranet_root
+    self.find_intranet_root || self.create_intranet_root
+  end
+
+  def self.create_intranet_root(attrs = {})
+    root_page = Page.find_by_flag :root
+    root_page = self.create_root unless root_page
+    intranet_root = root_page.child_pages.create(title: "Intranet")
+    intranet_root.update_attributes attrs
+    intranet_root.add_flag :intranet_root
+    return intranet_root
+  end
+
+  def self.intranet_root
+    self.find_or_create_intranet_root
+  end
+
+
+  # help page
+
+  def self.find_help_page
+    Page.find_by_flag( :help )
+  end
+
+  def self.find_or_create_help_page
+    self.find_help_page || self.create_help_page
+  end
+
+  def self.create_help_page
+    help_page = Page.create
+    help_page.add_flag :help
+    n = help_page.nav_node; n.hidden_menu = true; n.save;
+    return help_page
+  end
+  
+  # imprint
+  
+  def self.create_imprint
+    imprint_page = Page.create
+    imprint_page.add_flag :imprint
+    return imprint_page
+  end
+  def self.find_imprint
+    Page.find_by_flag :imprint
+  end
+  
+end