your_platform 0.0.1 → 0.0.2

data/app/models/attachment.rb

@@ -0,0 +1,76 @@
+class Attachment < ActiveRecord::Base
+  attr_accessible :description, :file, :parent_id, :parent_type, :title, :author
+
+  belongs_to :parent, polymorphic: true
+  belongs_to :author, :class_name => "User", foreign_key: 'author_user_id'
+  
+  mount_uploader :file, AttachmentUploader
+
+  before_save :update_file_attributes
+  before_create :set_default_title_if_empty
+  before_destroy :remove_file!
+
+  def thumb_url
+    url = file.url( :thumb ) if has_type?( "image" ) or has_type?( "pdf" )
+    url = file.url( :video_thumb ) if has_type?( "video" )
+    url = helpers.image_path( 'file.png' ) unless url
+    return url
+  end
+  
+  def medium_url
+    file.url(:medium) if has_type? 'image'
+  end
+
+  def has_type?( type )
+    self.content_type.include? type
+  end
+
+  def filename 
+    self.file.to_s.split( "/" ).last if self.file
+  end
+
+  def file_size_human
+    helpers.number_to_human_size( self.file_size )
+  end
+
+  def self.find_by_type( type )
+    where( "content_type like ?", "%" + type + "%" )
+  end
+
+  def self.find_without_types( *types )
+    self.where(true).to_a.collect do |attachment|
+      re = attachment
+      for type in types
+        if not attachment.content_type
+          re = []
+        else
+          if attachment.content_type.include? type
+            re = []
+          end
+        end
+      end
+      re
+    end.flatten
+  end
+
+  private
+
+  def helpers
+    ActionController::Base.helpers
+  end
+
+  def update_file_attributes
+    if file.present? and file_changed?
+      self.file_size = file.file.size
+      self.content_type = file.file.content_type
+    end
+    true
+  end
+
+  def set_default_title_if_empty
+    if file.present? && file.filename.present? && file_changed?
+      self.title ||= File.basename(file.filename, '.*').titleize
+    end
+  end
+
+end

data/app/models/bashpass_password.rb

@@ -0,0 +1,32 @@
+class BashpassPassword < Password
+  
+  def initialize
+    generate!
+  end
+  
+  def self.generate
+    correct_battery_horse_staple_de
+  end
+  
+  # This uses bashpass and a German dictionary to generate xkcd passwords
+  # like "correct horse battery staple".
+  #
+  # See: vendor/scripts/bashpass
+  #
+  def self.correct_battery_horse_staple_de
+    `cd #{bashpass_dir} && #{osx_shuf_path_workaround} #{bashpass_command}`.gsub("\n", "").gsub(" n ", "")
+  end
+  
+  def self.bashpass_dir
+    YourPlatform::Engine.root.join('vendor/scripts/bashpass').to_s
+  end
+  
+  def self.bashpass_command
+    './bashpass -d german.dic -n 4 |tr "&1234567890\`=@+#~\!\%*_^-" " "'
+  end
+  
+  def self.osx_shuf_path_workaround
+    'PATH="/usr/local/opt/coreutils/libexec/gnubin:$PATH"'
+  end  
+  
+end

data/app/models/blog_post.rb

@@ -0,0 +1,2 @@
+class BlogPost < Page
+end

data/app/models/bookmark.rb

@@ -0,0 +1,67 @@
+#
+# This model represents bookmarks. User can bookmark objects by clicking on a star beside
+# the object's title. Their bookmarks are listed for them in a quick menu, thus
+# users have quick access to bookmarked objects.
+# 
+# Such bookmarkable objects may be other users, or pages, groups, et cetera.
+#
+class Bookmark < ActiveRecord::Base
+  attr_accessible :bookmarkable_id, :bookmarkable_type, :user_id, :user, :bookmarkable
+
+  belongs_to :bookmarkable, polymorphic: true
+  belongs_to :user
+
+
+  # Finder Methods
+  # ==========================================================================================
+
+  def self.find_by( args )
+    if args[ :user ].present?
+      user = args[ :user ]
+      args[ :user_id ] = user.id
+      args.delete( :user )
+    end
+    if args[ :bookmarkable ].present?
+      bookmarkable = args[ :bookmarkable ]
+      args[ :bookmarkable_id ] = bookmarkable.id
+      args[ :bookmarkable_type ] = bookmarkable.class.name
+      args.delete( :bookmarkable )
+    end
+    super args
+  end
+
+  def self.find_by_user_and_bookmarkable( user, bookmarkable )
+    (self.find_all_by_user( user ).find_all_by_bookmarkable( bookmarkable )).first
+  end
+
+  def self.find_all_by_user( user )
+    self.where( :user_id => user.id )
+  end
+
+  def self.find_all_by_bookmarkable( bookmarkable )
+    self.where( :bookmarkable_type => bookmarkable.class.name, :bookmarkable_id => bookmarkable.id )
+  end
+
+
+  # API Export // Data Serialization
+  # ==========================================================================================
+  #
+  # Include some associated data in serialized representations of this object,
+  # since this additional information is most likely required by the API and
+  # external components.
+  #
+  def serializable_hash( options = {} )
+    options.merge!(
+                   {
+                     :include => {
+                       :bookmarkable => {
+                         :methods => [ :title, :url ]
+                       }
+                     }
+                   } )
+    super( options )
+  end
+
+end
+
+

data/app/models/cache_additions.rb

@@ -0,0 +1,15 @@
+module CacheAdditions
+  def entry(name)
+    options = merged_options(nil)
+    key = namespaced_key(name, options)
+    read_entry(key, options)
+  end
+  
+  # This method reveals when a cache entry has been created.
+  #
+  def created_at(name)
+    Time.at(entry(name).created_at) if entry(name)
+  end
+end
+
+ActiveSupport::Cache::Store.include(CacheAdditions)

data/app/models/cache_store_extension.rb

@@ -0,0 +1,78 @@
+# This extends the class of Rails.cache.
+# This file is required by the cache_store_extension initializer.
+#
+module CacheStoreExtension
+
+  def uncached
+    @ignore_cache = true
+    result = yield
+    @ignore_cache = false
+    return result
+  end
+  
+  def fetch(key, options = {}, &block)
+    rescue_from_undefined_class_or_module do
+      rescue_from_other_errors(block) do
+        super(key, {force: @ignore_cache}.merge(options), &block)
+      end
+    end
+  end
+  
+  def delete_regex(regex)
+    if @data
+      keys = @data.keys.select { |key| key =~ regex }
+      @data.del(*keys) if keys.count > 0
+    end
+  end
+  
+  # This autoloads classes or modules that are required to instanciate
+  # the cached objects.
+  #
+  # See: https://github.com/rails/rails/issues/8167
+  # and: https://github.com/dementrock/rails/blob/ceadd4ad63d5be39b2903fe725132d9f9e236448/activesupport/lib/active_support/core_ext/marshal.rb
+  #
+  def rescue_from_undefined_class_or_module
+    begin
+      yield
+    rescue ArgumentError, NameError => exc
+      if exc.message.match(%r|undefined class/module (.+)|)
+        $1.constantize
+        retry
+      else
+        raise exc
+      end
+    end
+  end
+  private :rescue_from_undefined_class_or_module
+  
+  # # This provides a solution to errors like
+  # # "year too big to marshal: 16 UTC".
+  # #
+  # # Note that this error confusingly does not neccessarily have
+  # # something to do with caching dates.
+  # #
+  # def rescue_from_too_big_to_marshal
+  #   begin
+  #     yield
+  #   rescue ArgumentError, NameError => exc
+  #     if exc.message.match(%r|year too big to marshal: (.+)|)
+  #       yield.reload  # Reloading the ActiveRecord objects can help.
+  #     else
+  #       raise exc
+  #     end
+  #   end
+  # end
+  
+  def rescue_from_other_errors(block_without_fetch, &block_with_fetch)
+    begin
+      yield
+    rescue => e
+      p "CACHE: RESCUE: #{e.message}"
+      block_without_fetch.call  # Circumvent the caching at all.
+    end
+  end
+  private :rescue_from_other_errors
+  
+end
+
+ActiveSupport::Cache::Store.send(:prepend, CacheStoreExtension)

data/app/models/concerns/user_avatar.rb

@@ -0,0 +1,16 @@
+# This module contains all the Avatar-related methods of a User.
+# The avatar feature is done using the refile gem.
+#
+# Have a look at:
+# * https://www.gorails.com/episodes/file-uploads-with-refile
+# * https://github.com/refile/refile
+#
+module UserAvatar
+  extend ActiveSupport::Concern
+  
+  included do
+    attachment :avatar, type: :image
+    attr_accessible :avatar, :remove_avatar
+  end
+
+end

data/app/models/concerns/user_corporations.rb

@@ -0,0 +1,44 @@
+# This module contains all the Corporation-related methods of a User.
+# 
+# A user can be member of several corporations. Therefore,
+# User responds to `User#corporations`.
+# 
+# There is also a usecase, where a User should have a primary corporation
+# or be just in one Corporation at all. For those usecases, we provide
+# the `User#corporation` method---and the `User#corporation_name` method,
+# which is more convenient for the view layer.
+#
+module UserCorporations
+  extend ActiveSupport::Concern
+  
+  included do
+    attr_accessible :corporation_name
+  end
+    
+  def corporation_id
+    (Corporation.pluck(:id) & self.ancestor_group_ids).first
+  end
+  
+  # Returns the (single) Corporation the user is associated with.
+  # If in your domain, a User is member of several corporations,
+  # use the `corporations` method instead.
+  #
+  def corporation
+    cached { Corporation.find corporation_id if corporation_id }
+  end
+  
+  # Returns the name of the Corporation the user is associated with.
+  #
+  def corporation_name
+    corporation.try(:name)
+  end
+  
+  # Sets the name of the Corporation the user is associated with.
+  # If no matching corporation exists, the corporation is created.
+  # The user is added as member to this corporation.
+  #
+  def corporation_name=(new_corporation_name)
+    Corporation.find_or_create_by_name(new_corporation_name).assign_user self
+  end
+  
+end

data/app/models/concerns/user_date_of_birth.rb

@@ -0,0 +1,74 @@
+# This module contains all the methods of a user related to his
+# date of birth.
+# 
+module UserDateOfBirth
+  extend ActiveSupport::Concern
+  
+  included do
+  end
+  
+  def date_of_birth
+    cached { date_of_birth_profile_field.value.to_date if date_of_birth_profile_field.value if date_of_birth_profile_field }
+  end
+  def date_of_birth=( date_of_birth )
+    find_or_build_date_of_birth_profile_field.value = date_of_birth
+  end
+
+  def date_of_birth_profile_field
+    @date_of_birth_profile_field ||= profile_fields.where( type: "ProfileFieldTypes::Date", label: 'date_of_birth' ).limit(1).first
+  end
+  def build_date_of_birth_profile_field
+    raise 'profile field already exists' if date_of_birth_profile_field
+    @date_of_birth_profile_field = profile_fields.build( type: "ProfileFieldTypes::Date", label: 'date_of_birth' )
+  end
+
+  def find_or_build_date_of_birth_profile_field
+    date_of_birth_profile_field || build_date_of_birth_profile_field
+  end
+  def save_date_of_birth_profile_field
+    date_of_birth_profile_field.try(:save)
+  end
+  private :save_date_of_birth_profile_field
+  
+  def find_or_create_date_of_birth_profile_field
+    date_of_birth_profile_field || ( build_date_of_birth_profile_field.save && date_of_birth_profile_field)
+  end
+
+  def localized_date_of_birth
+    I18n.localize self.date_of_birth if self.date_of_birth
+  end
+  def localized_date_of_birth=(str)
+    begin
+      self.date_of_birth = str.to_date
+    rescue
+      self.date_of_birth = nil
+    end
+  end
+  
+  def age
+    cached do
+      now = Time.now.utc.to_date
+      dob = self.date_of_birth
+      if dob
+        now.year - dob.year - ((now.month > dob.month || (now.month == dob.month && now.day >= dob.day)) ? 0 : 1)
+      else
+        nil
+      end
+    end
+  end
+  
+  def birthday_this_year
+    cached do
+      begin
+        date_of_birth.change(:year => Time.zone.now.year)
+      rescue
+        if date_of_birth.try(:month) == 2 && date_of_birth.try(:day) == 29
+          date_of_birth.change(year: Time.zone.now.year, month: 3, day: 1)
+        else
+          nil
+        end
+      end
+    end
+  end
+  
+end

data/app/models/concerns/user_profile.rb

@@ -0,0 +1,102 @@
+# This module contains all the profile-related methods of a User.
+# 
+module UserProfile
+  extend ActiveSupport::Concern
+  
+  included do
+    has_profile_fields profile_sections: [:contact_information, :about_myself, :study_information, :career_information,
+       :organizations, :bank_account_information]
+    
+    # TODO: This is already Rails 4 syntax. Use this when we switch to Rails 4.
+    # http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html#method-i-has_one
+    #
+    # has_one                   :date_of_birth_profile_field, -> { where label: 'date_of_birth' }, class_name: "ProfileFieldTypes::Date", as: :profileable, autosave: true
+    #
+    # The old Rails 3.2 syntax would be:
+    #
+    # has_one                   :date_of_birth_profile_field, class_name: "ProfileFieldTypes::Date", conditions: "label = 'date_of_birth'", as: :profileable, autosave: true
+    #
+    # But on build_date_of_birth_profile_field the condition is not set automatically. There are some other issues with this behaviour.
+    # We would still have to use an instance variable. Therefore, we just build the association from scratch.
+    # See code down at #date_of_birth_profile_field.
+    #
+    after_save                :save_date_of_birth_profile_field
+  end
+
+  def phone_profile_fields
+    profile_fields.where(type: 'ProfileFieldTypes::Phone').select do |field|
+      not field.label.downcase.include? 'fax'
+    end
+  end
+  
+  def landline_profile_fields
+    phone_profile_fields - mobile_phone_profile_fields
+  end
+  def mobile_phone_profile_fields
+    phone_profile_fields.select do |field|
+      field.label.downcase.include?('mobil') or field.label.downcase.include?('handy')
+    end
+  end
+  
+  def phone
+    (landline_profile_fields + phone_profile_fields).first.try(:value)
+  end
+  def phone=(new_number)
+    (landline_profile_fields.first || profile_fields.create(label: I18n.t(:phone), type: 'ProfileFieldTypes::Phone')).update_attributes(value: new_number)
+  end
+  
+  def mobile
+    (mobile_phone_profile_fields + phone_profile_fields).first.try(:value)
+  end
+  def mobile=(new_number)
+    (mobile_phone_profile_fields.first || profile_fields.create(label: I18n.t(:mobile), type: 'ProfileFieldTypes::Phone')).update_attributes(value: new_number)
+  end
+
+  def profile_field_value(label)
+    profile_fields.where(label: label).first.try(:value).try(:strip)
+  end
+  def personal_title
+    cached { profile_field_value 'personal_title' }
+  end
+  
+  def academic_degree
+    cached { profile_field_value 'academic_degree' }
+  end
+
+  def name_surrounding_profile_field
+    profile_fields.where(type: "ProfileFieldTypes::NameSurrounding").first
+  end
+  def text_above_name
+    name_surrounding_profile_field.try(:text_above_name).try(:strip)
+  end
+  def text_below_name
+    name_surrounding_profile_field.try(:text_below_name).try(:strip)
+  end
+  def text_before_name
+    name_surrounding_profile_field.try(:name_prefix).try(:strip)
+  end
+  def text_after_name
+    name_surrounding_profile_field.try(:name_suffix).try(:strip)
+  end
+  
+      
+  def fill_in_template_profile_information
+    self.profile_fields.create(label: :personal_title, type: "ProfileFieldTypes::General")
+    self.profile_fields.create(label: :academic_degree, type: "ProfileFieldTypes::AcademicDegree")
+
+    self.profile_fields.create(label: :work_address, type: "ProfileFieldTypes::Address")
+    self.profile_fields.create(label: :phone, type: "ProfileFieldTypes::Phone") unless self.phone
+    self.profile_fields.create(label: :mobile, type: "ProfileFieldTypes::Phone") unless self.mobile
+    self.profile_fields.create(label: :fax, type: "ProfileFieldTypes::Phone")
+    self.profile_fields.create(label: :homepage, type: "ProfileFieldTypes::Homepage")
+
+    pf = self.profile_fields.build(label: :bank_account, type: "ProfileFieldTypes::BankAccount")
+    pf.becomes(ProfileFieldTypes::BankAccount).save
+
+    pf = self.profile_fields.create(label: :name_field, type: "ProfileFieldTypes::NameSurrounding")
+      .becomes(ProfileFieldTypes::NameSurrounding)
+    pf.text_above_name = ""; pf.name_prefix = "Herrn"; pf.name_suffix = ""; pf.text_below_name = ""
+    pf.save
+  end
+  
+end