your_platform 0.0.1 → 0.0.2

data/app/models/group.rb

@@ -0,0 +1,224 @@
+# -*- coding: utf-8 -*-
+#
+# This class represents a user group. Besides users, groups may have sub-groups as children.
+# One group may have several parent-groups. Therefore, the relations between groups, users,
+# etc. is stored using the DAG model, which is implemented by the `is_structureable` method.
+# 
+class Group < ActiveRecord::Base
+  
+  attr_accessible( :name, # just the name of the group; example: 'Corporation A'
+                    :body, # a description text displayed on the groups pages top
+                    :token, # (optional) a short-name, abbreviation of the group's name, in 
+                            # a global context; example: 'A'
+                    :internal_token, # (optional) an internal abbreviation, i.e. used by the 
+                                     # members of the group; example: 'AC'
+                    :extensive_name, # (optional) a long version of the group's name;
+                                     # example: 'The Corporation of A'
+                    :direct_members_titles_string # Used for inline-editing: The comma-separated
+                                                  # titles of the child users of the group.
+                    )
+  
+  include ActiveModel::ForbiddenAttributesProtection  # TODO: Move into initializer
+
+  is_structureable( ancestor_class_names: %w(Group Page Event), 
+                    descendant_class_names: %w(Group User Page Workflow Event) )
+  is_navable
+  has_profile_fields
+
+  has_many :posts
+
+  include GroupMixins::Memberships
+  include GroupMixins::Everyone  
+  include GroupMixins::Corporations
+  include GroupMixins::Roles
+  include GroupMixins::Guests
+  include GroupMixins::HiddenUsers
+  include GroupMixins::Developers
+  include GroupMixins::Officers
+
+  include GroupMixins::Import
+
+  after_create     :import_default_group_structure  # from GroupMixins::Import
+  after_save       { self.delay.delete_cache }
+
+  def delete_cache
+    super
+    ancestor_groups(true).each { |g| g.delete_cached(:leaf_groups); g.delete_cached(:status_groups) }
+  end
+    
+  # General Properties
+  # ==========================================================================================
+
+  # The title of the group, i.e. a kind of caption, e.g. used in the <title> tag of the
+  # webpage. By default, this returns just the name of the group. But this may be changed
+  # in the main application.
+  # 
+  def title
+    self.name
+  end
+
+  # The name of the group.
+  # If there is a translation for that group name, e.g. for a generic group name like
+  # 'admins', use the translation.
+  #
+  def name
+    I18n.t( super.to_sym, default: super ) if super.present?
+  end
+  
+  def extensive_name
+    if has_flag? :attendees
+      name + (parent_events.first ? ": " + parent_events.first.name : '')
+    elsif has_flag? :contact_people
+      name + (parent_events.first ? ": " + parent_events.first.name : '')
+    elsif has_flag? :admins_parent
+      name + ": " + parent_groups.first.parent_groups.first.name
+    elsif super.present?
+      super
+    else
+      name
+    end
+  end
+  
+  def name_with_corporation
+    if self.corporation && self.corporation.id != self.id
+      "#{self.name} (#{self.corporation.name})"
+    else
+      self.name
+    end
+  end
+  
+  # This sets the format of the Group urls to be
+  # 
+  #     example.com/groups/24-planeswalkers
+  #
+  # rather than just
+  #
+  #     example.com/groups/24
+  #
+  def to_param
+    "#{id} #{title}".parameterize
+  end
+  
+  
+  # Mark this group of groups, i.e. the primary members of the group are groups,
+  # not users. This does not effect the DAG structure, but may affect the way
+  # the group is displayed.
+  #
+  def group_of_groups?
+    has_flag? :group_of_groups
+  end
+  def group_of_groups=(add_the_flag)
+    add_the_flag ? add_flag(:group_of_groups) : remove_flag(:group_of_groups)
+  end
+  
+  
+  # Associated Objects
+  # ==========================================================================================
+
+  # Workflows
+  # ------------------------------------------------------------------------------------------
+
+  # These methods override the standard methods, which are usual ActiveRecord associations
+  # methods created by the acts-as-dag gem 
+  # (https://github.com/resgraph/acts-as-dag/blob/master/lib/dag/dag.rb).
+  # But since the Workflow in the main application
+  # inherits from WorkflowKit::Workflow and single table inheritance and polymorphic 
+  # associations do not always work together as expected in rails, as can be seen here
+  # http://stackoverflow.com/questions/9628610/why-polymorphic-association-doesnt-work-for-sti-if-type-column-of-the-polymorph,
+  # we have to override these methods. 
+  #
+  # ActiveRecord associations require 'WorkflowKit::Workflow' to be stored in the database's
+  # type column, but by asking for the `child_workflows` we want to get òbjects of the
+  # `Workflow` type, not `WorkflowKit::Workflow`, since Workflow objects may have
+  # additional methods, added by the main application. 
+  #
+  def descendant_workflows
+    Workflow
+      .joins( :links_as_descendant )
+      .where( :dag_links => { :ancestor_type => "Group", :ancestor_id => self.id } )
+      .uniq
+  end
+
+  def child_workflows
+   self.descendant_workflows.where( :dag_links => { direct: true } )
+  end
+
+
+  # Events
+  # ------------------------------------------------------------------------------------------
+  
+  def events
+    self.descendant_events
+  end
+
+  def upcoming_events
+    self.events.upcoming.order('start_at')
+  end
+  
+  
+  # Adress Labels (PDF)
+  # options: 
+  #   - sender:      Sender line including sender address.
+  #   - book_rate:   Whether the "Büchersendung"/"Envois à taxe réduite" badge
+  #                  is to be printed.
+  #
+  def members_to_pdf(options = {sender: '', book_rate: false})
+    timestamp = cached_members_postal_addresses_created_at || Time.zone.now
+    AddressLabelsPdf.new(members_postal_addresses, title: self.title, updated_at: timestamp, **options).render
+  end
+  def members_postal_addresses
+    cached do
+      members
+        .collect { |user| user.address_label }
+        .sort_by { |address_label| (not address_label.country_code == 'DE').to_s + address_label.country_code.to_s + address_label.postal_code.to_s }
+        # .collect { |address_label| address_label.to_s }
+    end
+  end
+  def cached_members_postal_addresses_created_at
+    cached do
+      members.collect { |user| user.cache_created_at(:address_label) || Time.zone.now }.min
+    end
+  end
+
+
+  # Groups
+  # ------------------------------------------------------------------------------------------
+
+  def descendant_groups_by_name( descendant_group_name )
+    self.descendant_groups.where( :name => descendant_group_name )
+  end
+
+  def corporation
+    cached do
+      Corporation.find corporation_id if corporation_id
+    end
+  end
+  def corporation_id
+    (([self.id] + ancestor_group_ids) & Corporation.pluck(:id)).first
+  end
+
+  def corporation?
+    kind_of? Corporation
+  end
+  
+  # This returns all sub-groups of the corporation that have no
+  # sub-groups of their ownes except for officer groups. 
+  # This is needed for the selection of status groups.
+  #
+  def leaf_groups
+    cached do
+      self.descendant_groups.order('id').includes(:flags).select do |group|
+        group.has_no_subgroups_other_than_the_officers_parent? and not group.is_officers_group?
+      end
+    end
+  end
+  
+  def find_deceased_members_parent_group
+    self.descendant_groups.where(name: ["Verstorbene", "Deceased"]).limit(1).first
+  end
+  def deceased
+    find_deceased_members_parent_group
+  end
+
+end
+

data/app/models/group_mixins/corporations.rb

@@ -0,0 +1,141 @@
+#
+# There are certain gloabl special groups, for example the `corporations_parent` group, which contains
+# all corporations.
+#
+# The global accessors for these groups, e.g. `Group.corporations_parent` 
+# are defined in this mixin.
+#
+# The mechanism used by this mixin is defined in `StructureableMixins::HasSpecialGroups`.
+#
+module GroupMixins::Corporations
+
+  extend ActiveSupport::Concern
+
+  included do
+    # see, for example, http://stackoverflow.com/questions/5241527/splitting-a-class-into-multiple-files-in-ruby-on-rails
+  end
+
+  # Corporations
+  # ==========================================================================================
+  #
+  # The parent group for all corporation groups is called `corporations_parent`.
+  # The group structure looks something like this:
+  #
+  #   everyone
+  #      |----- corporations_parent
+  #                       |---------- corporation_a
+  #                       |                |--- ...
+  #                       |---------- corporation_b
+  #                       |                |--- ...
+  #                       |---------- corporation_c
+  #                                        |--- ...
+  #
+  module ClassMethods
+    def find_corporations_parent_group
+      find_special_group(:corporations_parent)
+    end
+    
+    def create_corporations_parent_group
+      g = create_special_group(:corporations_parent)
+      g.add_flag :group_of_groups
+      return g
+    end
+    
+    def find_or_create_corporations_parent_group
+      find_corporations_parent_group || create_corporations_parent_group
+    end
+    
+    def corporations_parent
+      find_or_create_corporations_parent_group
+    end
+    
+    def corporations_parent!
+      find_corporations_parent_group || raise('special group :corporations_parent does not exist.')
+    end
+
+    # Find all corporation groups, i.e. the children of `corporations_parent`.
+    #
+    # FIXME: This method does not filter out the officers_parent child_group.
+    # For some reason this would cause several specs to fail. 
+    #
+    # For the moment, if you want just the corporations, i.e. without the
+    # officers_parent, please use `Corporation.all`.
+    #
+    def find_corporation_groups
+      find_corporations_parent_group.try(:child_groups) || []
+    end
+
+    # Find all corporation groups, i.e. the children of `corporations_parent`.
+    # Alias method for `find_corporation_groups`.
+    #
+    def corporations
+      find_corporation_groups
+    end
+
+    # Find corporation groups of a certain user.
+    #
+    def find_corporation_groups_of( user )
+      ancestor_groups_of_user = user.groups
+      corporation_groups = Group.find_corporation_groups if Group.find_corporations_parent_group
+      return ancestor_groups_of_user & corporation_groups if ancestor_groups_of_user and corporation_groups
+    end
+
+    # Find corporation groups of a certain user.
+    # Alias method of `find_corporation_groups_of`.
+    #
+    def corporations_of( user )
+      self.find_corporation_groups_of user
+    end
+
+    # Find all groups of the corporations branch, i.e. the corporations_parent
+    # and its descendant groups.
+    #
+    #   everyone
+    #      |----- corporations_parent                      <
+    #      |                |---------- corporation_a      <  These groups are returned
+    #      |                |                |--- ...      <  by this method.
+    #      |                |---------- corporation_b      <
+    #      |                                 |--- ...      <
+    #      |----- other_group_1
+    #      |----- other_group_2
+    #
+    def find_corporations_branch_groups
+      if Group.find_corporations_parent_group
+        return [ Group.corporations_parent ] + Group.corporations_parent.descendant_groups
+      end
+    end
+
+    # Find all groups of the corporations branch of a certain user, i.e. all corporations
+    # of a user and the descendant groups of these corporations.
+    #
+    # This is used, for example, in the my-groups view, where the corporations groups
+    # are displayed separately.
+    #
+    def find_corporations_branch_groups_of( user )
+      ancestor_groups = user.groups
+      corporations_branch = self.find_corporations_branch_groups
+      return ancestor_groups & corporations_branch if ancestor_groups and corporations_branch
+    end
+
+    # Find all groups of a certain user that are not part of the user's corporations_branch,
+    # see `self.find_corporations_branch_groups_of`.
+    #
+    # This is used, for example, in the my-groups view, where the corporations groups
+    # are displayed separately.
+    #
+    # Some special groups are excluded manually, since they are not expected to show up
+    # in the groups list, e.g. attendee groups of corporation events.
+    #
+    def find_non_corporations_branch_groups_of( user )
+      ancestor_groups = user.groups
+      corporations_branch = self.find_corporations_branch_groups
+      corporations_branch = [] unless corporations_branch
+      return ancestor_groups - 
+        corporations_branch - 
+        Group.find_all_by_flag(:attendees) -
+        Group.find_all_by_flag(:contact_people) -
+        Group.find_all_by_flag(:officers_parent)
+    end
+  end
+
+end

data/app/models/group_mixins/developers.rb

@@ -0,0 +1,41 @@
+#
+# There are certain gloabl special groups, for example the `developers` group, which contains
+# all users.
+#
+# The global accessors for these groups, e.g. `Group.find_developers_group` or 
+# `Group.developers` for short, are defined in this mixin.
+#
+# The mechanism used by this mixin is defined in `StructureableMixins::HasSpecialGroups`.
+#
+module GroupMixins::Developers
+
+  extend ActiveSupport::Concern
+
+  # Developers
+  # ==========================================================================================
+  #
+  # The group where all developers are members of.
+  #
+  module ClassMethods
+    def find_developers_group
+      find_special_group(:developers)
+    end
+    
+    def create_developers_group
+      create_special_group(:developers)
+    end
+
+    def find_or_create_developers_group
+      find_or_create_special_group(:developers)
+    end
+    
+    def developers
+      find_or_create_developers_group
+    end
+    
+    def developers!
+      find_developers_group || raise('special group :developers does not exist.')
+    end
+  end
+
+end

data/app/models/group_mixins/everyone.rb

@@ -0,0 +1,72 @@
+#
+# There are certain gloabl special groups, for example the `everyone` group, which contains
+# all users.
+#
+# The global accessors for these groups, e.g. `Group.find_everyone_group` or 
+# `Group.everyone` for short, are defined in this mixin.
+#
+# The mechanism used by this mixin is defined in `StructureableMixins::HasSpecialGroups`.
+#
+module GroupMixins::Everyone
+
+  extend ActiveSupport::Concern
+
+  included do
+    # see, for example, http://stackoverflow.com/questions/5241527/splitting-a-class-into-multiple-files-in-ruby-on-rails
+  end
+
+  # Everyone Group
+  # ==========================================================================================
+  #
+  # The 'root group', which is the highest in the group hierarchy.
+  # Everyone is member of this group, even not registered users.
+  #
+  module ClassMethods
+    def find_everyone_group
+      find_special_group(:everyone)
+    end
+    
+    def create_everyone_group
+      create_special_group(:everyone)
+    end
+
+    def find_or_create_everyone_group
+      find_or_create_special_group(:everyone)
+    end
+    
+    def everyone
+      find_or_create_everyone_group
+    end
+    
+    def everyone!
+      find_everyone_group || raise('special group :everyone does not exist.')
+    end
+  end
+  
+  
+  # Members
+  # ==========================================================================================
+  
+  # This method overrides the default association to emulate the bahaviour that really every
+  # user is member of the :everyone group.
+  #
+  def members(reload = nil)
+    if self.has_flag? :everyone
+      User.where(true)
+    else
+      super(reload)
+    end
+  end
+  
+  # This method overrides the default association to emulate the bahaviour that really every
+  # user is direct member of the :everyone group.
+  #
+  def direct_members(reload = nil)
+    if self.has_flag? :everyone
+      User.where(true)
+    else
+      super(reload)
+    end
+  end
+  
+end