your_platform 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d4f4254548dff774d063fd40e179c3e06189f97
+  data.tar.gz: da0eb80eaa45c980cedc8058e84cde0c514452d5
+SHA512:
+  metadata.gz: 2e1cd54d69ff299c954eb839409122955c90e2f1e9f76d12265160190032cbcc6df87f25a3f9c4208249dde489c5f22540dd30e705f16f10da2051227802c432
+  data.tar.gz: 1d6a2f147d4abe217de66389ee16d7b4625b8d7f2ce94d1e35459c82c16a878586f1fdae580c2a9d26d3955d01c3cae664110873727df465c09cdfaafed62536

data/README.md

@@ -1,24 +1,40 @@
 # YourPlatform
 
-TODO: Write a gem description
+[![Join the chat at https://gitter.im/fiedl/your_platform](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/fiedl/your_platform?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Build Status](https://travis-ci.org/fiedl/your_platform.svg?branch=master)](https://travis-ci.org/fiedl/your_platform)
+[![Code Climate](https://codeclimate.com/github/fiedl/your_platform/badges/gpa.svg)](https://codeclimate.com/github/fiedl/your_platform)
+[![Dependency Status](https://gemnasium.com/fiedl/your_platform.svg)](https://gemnasium.com/fiedl/your_platform)
 
-## Installation
+YourPlatform is a [ruby on rails](http://rubyonrails.org) engine that provides the basis for administrtive and social network platforms for closed user groups such as alumni organizations.
 
-Add this line to your application's Gemfile:
+The application serves four main purposes: Centralized or decentralized member management, networking features for members, exchange of information and documents and communication.
 
-    gem 'your_platform'
+## Getting Started Developing
 
-And then execute:
+1. Have a look at our demo application: *We are currently moving to another server. After that, the demo link will be provided here.*
+2. Check out the demo application locally:
+  
+  ```bash
+  git clone git@github.com:fiedl/your_platform.git
+  cd your_platform/demo_app/my_platform
+  
+  # provide a config/database.yml according to your local mysql credentials
+  
+  bundle install
+  bundle exec rake db:create db:migrate
+  bundle exec foreman start
+  bundle exec rails server
+  ```
+  
+  View the application at [http://localhost:3000](http://localhost:3000).
+3. If you want to create an application based on the YourPlatform engine, please follow the [GETTING STARTED GUIDE](https://github.com/fiedl/your_platform/wiki/GettingStarted) in the wiki.
 
-    $ bundle
+If you have any troubles, **feel free to contact us on our [gitter channel](https://gitter.im/fiedl/your_platform)**.
 
-Or install it yourself as:
+## Documentation
 
-    $ gem install your_platform
+Our [code documentation can be found on rubydoc.info](http://www.rubydoc.info/github/fiedl/your_platform).
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Contributing
 
@@ -27,3 +43,15 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Authors and License
+
+**Copyright** (c) 2012-2015, Sebastian Fiedlschuster
+
+**Contributors**: Jörg Reichardt, Manuel Zerpies, Joachim Back
+
+**License**: The Source Code is released under the GNU Affero General Public License (AGPL). Explicitely excluded are the images and fonts.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

data/Rakefile

@@ -1 +1,15 @@
-require "bundler/gem_tasks"
+#!/usr/bin/env rake
+
+require File.expand_path('../demo_app/my_platform/config/application', __FILE__)
+require 'rspec/core/rake_task'
+require 'rspec-rerun'
+
+MyPlatform::Application.load_tasks
+
+pattern = "{./spec/**/*_spec.rb}"
+
+ENV['RSPEC_RERUN_RETRY_COUNT'] ||= '3'
+ENV['RSPEC_RERUN_PATTERN'] ||= pattern
+
+task default: 'rspec-rerun:spec'
+

data/app/assets/javascripts/app-ng.js.coffee

@@ -0,0 +1,5 @@
+@app = angular.module( "YourPlatform", [ "ngResource" ] )
+
+$(document).on('ready page:load', ->
+  angular.bootstrap(document, ['YourPlatform'])
+)

data/app/assets/javascripts/attachments.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/controllers-ng/bookmark_list_controller.js.coffee

@@ -0,0 +1,30 @@
+#
+# This is the angular js controller for bookmark lists.
+#
+
+@app.controller( "BookmarkListCtrl", ["$scope", "Bookmark", "current_user_bookmarks", ($scope, Bookmark, current_user_bookmarks)->
+
+  # The bookmark objects may be provided by the ng-init attribute of the corresponding
+  # controller tag. Therefore, wait 200ms for them to appear.
+  #
+  setTimeout( ->
+
+    # If the bookmarks are there, upstream them to the bookmarks service to share them
+    # with other controllers.
+    if $scope.bookmarks
+      current_user_bookmarks.fill( $scope.bookmarks )
+
+    # If the scope's bookmarks array is empty, the bookmarks are not prepopulated
+    # by the backend. In this case, fetch the bookmarks from the JSON interface.
+    if not $scope.bookmarks
+      if current_user_bookmarks.length == 0
+        current_user_bookmarks.find_all_by_user_id( $scope.user_id )
+
+  , 200 )
+
+  $scope.$on( 'bookmarksChange', ->
+    $scope.bookmarks = current_user_bookmarks
+  )
+
+] )
+

data/app/assets/javascripts/controllers-ng/box_controller.js.coffee

@@ -0,0 +1,37 @@
+#
+# This is the angular js controller for the box directive.
+# It, for example, takes track of the edit mode and whether the 'edit' button
+# has to be shown.
+#
+# TODO:
+# - die erste box braucht noch ein "first"-css-Attribut.
+#
+
+@app.controller( "BoxCtrl", ["$scope", ($scope)->
+
+  # This variable takes track of whether there are editable elements
+  # inside the box. If that is the case, the 'edit' button is shown.
+  #
+  $scope.editablesInside = false
+
+  # Controllers of editable elements have to broadcast an 'inPlaceEditorInitiated' event
+  # to the box controller as follows:
+  #
+  #     $scope.box_scope().$broadcast( 'inPlaceEditorInitiated' )
+  #
+  $scope.$on( 'inPlaceEditorInitiated', -> $scope.editablesInside = true )
+  $scope.$on( 'editableElementInitiated', -> $scope.editablesInside = true )
+
+  # A box may be in editMode, which means that all editable elements
+  # within the box are set to their editing state, e.g. in place editable elements.
+  #
+  $scope.editMode = false
+
+  # This method is called by the 'edit' button in order to toggle the edit mode.
+  #
+  $scope.toggleEditMode = ->
+    $scope.editMode = not $scope.editMode
+    $scope.transclude_scope().$broadcast( 'editModeChange', {newState: $scope.editMode} )
+
+] )
+

data/app/assets/javascripts/controllers-ng/profile_angular.js.coffee

@@ -0,0 +1,151 @@
+
+# TODO:
+# - directives für in_place_edit und remove_button
+# - das directive-template muss in eine Datei
+# - die erste box braucht noch ein "first"-css-Attribut.
+
+
+
+# PfileField Model
+@app.factory "ProfileField", ["$resource", ($resource) ->
+
+  # these are temporary defined in the local scope of this block,
+  # since we need them in the following initialization of the
+  # ProfileField model.
+  profileable_id = $( "#profile" ).data( "profileable-id" )
+  profileable_type = $( "#profile" ).data( "profileable-type" )
+
+  # Model initialization: Bind it to an AJAX resource.
+  ProfileField = $resource(
+    "/profile_fields/:id?profileable_id=:profileable_id&profileable_type=:profileable_type&parent_id=:parent_id",
+    { id: "@id", profileable_id: profileable_id, profileable_type: profileable_type },
+    { update: { method: "PUT" } }
+  )
+
+  # Add further instance methods here:
+
+  # This method will request the child profile fields of this profile field.
+  # There is also a children attribute with pre-populated json data.
+  # But the elements of the children array are no resource objects,
+  # i.e. no JSON operations are possible on them.
+  # Therefore, this getChildren() method is required, returning
+  # an array of Resource objects of the child profile fields.
+  #
+  # Example:
+  #     profile_fields = ProfileField.query( { profileable_type: "User", profileable_id: 2 } )
+  #     parent_field = profile_fields[2]
+  #     child_fields = parent_field.getChildren()   # Array of Resources
+  #     child_fields = parent_field.children        # Array of Objects
+  #
+  ProfileField.prototype.getChildren = ->
+    ProfileField.query( { parent_id: @id, profileable_id: null, profileable_type: null } )
+
+  ProfileField.prototype.loadChildrenResource = ->
+    this.children = this.getChildren() if this.children.length > 0
+
+  # Add further class methods here.
+  ProfileField.someClassMethod = (arg) ->
+    console.log arg
+
+  # The factory needs to return the model object.
+  return ProfileField
+]
+
+# see: https://gist.github.com/Mithrandir0x/3639232
+@app.service( "Profileable", ->
+  this.id = $( "#profile" ).data( "profileable-id" )
+  this.type = $( "#profile" ).data( "profileable-type" )
+  this.attributes = $( "#profile" ).data( "profileable" )
+  this.title = this.attributes.title
+)
+
+
+@app.controller( "ProfileCtrl", ["$scope", "ProfileField", "Profileable", "$resource", ($scope, ProfileField, Profileable, $resource) ->
+
+  $scope.editMode = false;
+
+  # Load Data
+  # ------------------------------------------------------------------------------------------
+
+  # profileable, i.e. the object that has the profile fields
+  $scope.profileable = Profileable
+
+  # profile fields
+#  $scope.profile_fields = ProfileField.query( {
+#    profileable_type: $scope.profileable.type, profileable_id: $scope.profileable.id
+#  },
+#  -> # done loading, load the child profile fields:
+#    angular.forEach( $scope.profile_fields, (profile_field)->
+#      profile_field.loadChildrenResource()
+#    )
+#  )
+
+  $scope.profile_fields = $( "#profile" ).data( 'profile-fields' )
+
+  # FOR DEBUG:
+  # TODO: DELETE THIS
+  $.ProfileField = ProfileField
+  $.scope = $scope
+  # / FOR DEBUG
+
+  # Controller Actions
+  # ------------------------------------------------------------------------------------------
+
+  $scope.addProfileField = ->
+    profile_field = ProfileField.save( $scope.new_profile_field )
+    $scope.profile_fields.push( profile_field )
+    $scope.new_profile_field = {}
+
+  $scope.deleteProfileField = (profile_field) ->
+    id_to_remove_from_list = profile_field.id
+    profile_field.$remove( (removed_profile_field, responseHeader) ->
+      index = $scope.profile_fields.indexOf( removed_profile_field )
+      $scope.profile_fields.splice( index, 1 ) unless index == -1
+    )
+
+  $scope.$on( 'editModeChange', (event, args)->
+    newState = args[ 'newState' ]
+    $scope.editMode = newState
+  )
+
+
+] )
+
+@app.controller( "ProfileFieldCtrl", [ "$scope", ($scope) ->
+  $scope.isChildField = true if $scope.profile_field.parent_id
+] )
+
+@app.controller( "InPlaceEditCtrl", [ "$scope", "ProfileField", ($scope, ProfileField) ->
+#  $scope.editMode = false # this does not inherit from the box scope, since the box is a directive.
+  $scope.editorEnabled = $scope.editMode
+
+  # Let the box know that there is an in place edit field inside.
+  # Then the box can show the 'edit' button.
+  #
+  $scope.box_scope().$broadcast( 'inPlaceEditorInitiated' )
+
+
+  $.inplacescope = $scope unless $.inplacescope
+  $scope.$on( 'editModeChange', (event, args)->
+    newState = args[ 'newState' ]
+    $scope.editMode = newState
+    $scope.edit() if newState == true
+    $scope.save() if newState == false
+  )
+  $scope.$on( 'clickOutside', ->
+    $scope.editMode = false
+    $scope.save() if not $scope.editMode
+  )
+  $scope.edit = ->
+    $scope.editorEnabled = true
+    $scope.editorEnabledJustNow = true
+    setTimeout( ->
+      $scope.editorEnabledJustNow = false
+    , 200 )
+  $scope.save = ->
+    unless $scope.editorEnabledJustNow
+      # because if it has been enabled just now, this save()
+      # has been triggered by a bubbled click event accidentally.
+      new ProfileField( $scope.profile_field ).$update() # typecast for pre-populated data
+      $scope.editorEnabled = false
+] )

data/app/assets/javascripts/directives-ng/box_directive.js.coffee

@@ -0,0 +1,91 @@
+#
+# This file specifies the box directive within the angular js framework.
+# This directive allows to add box elements, i.e. certain sections, to the
+# html structure:
+#
+#    <box caption="The header of the box">
+#      This content is displayed <strong>inside the box</strong>.
+#    </box>
+#
+# If editable elements are added inside the box, the box will show an
+# 'edit' button that toggles all editable fields within the box.
+# Therefore, editable elements have to let the box know that they are there:
+#
+#    # within the scope of the editable element's controller
+#    $scope.box_scope().$broadcast( 'inPlaceEditorInitiated' )  # or:
+#    $scope.box_scope().$broadcast( 'editableElementInitiated' )
+#
+# TODO:
+# - das directive-template muss in eine Datei
+# - die erste box braucht noch ein "first"-css-Attribut.
+#
+
+@app.directive( "box", -> {
+  priority: 0,
+  template: '<div class="box" ng-controller="BoxCtrl">' +
+              '<div class="head"><table><tr>' +
+                '<td class="box_heading">' +
+                  '<h1>{{caption}} </h1>' + # the space in the h1 is really needed!
+                '</td>' +
+                '<td class="box_toolbar">' +
+                  '<button class="btn" type="button" data-toggle="button" ng-click="toggleEditMode()" ng-show="editablesInside">' +
+                    '<i class="icon-edit icon-black"></i> ' +
+                    'Edit' +
+                  '</button>' +
+                '</td>' +
+              '</tr></table></div>' +
+              '<div class="divider"></div>' +
+              '<div class="content" ng-transclude></div>' +
+            '</div>',
+# templateUrl: 'some.html',
+  replace: false,
+  transclude: true,
+  restrict: 'E',
+  #
+  # the scope structure looks like this:
+  #
+  #    some_div_controller_scope
+  #            |---------------- box_scope
+  #            |                     |------ BoxCtrl_scope
+  #            |
+  #            |---------------- transclude_scope
+  #
+  # whereas the DOM structure looks like this:
+  #
+  #    some_div
+  #       |-------- box
+  #                  |---- BoxCtrl_div
+  #                           |--------- transclude_div
+  #
+  # I'm not sure why, but that's how angular does ist. Therefore, we have to
+  # apply a patch in order to be able to broadcast to the transclude and back.
+  #
+  # Therefore, the method `$scope.transclude_scope()` is added.
+  # One can broadcast to the elements inside the box as follows:
+  #
+  #     $scope.transclude_scope().$broadcast( "myEvent", { my_argument: my_value } )
+  #
+  scope: true
+  link: (scope, element, attrs)->
+    scope.$watch( (->attrs.caption), (value)->
+      scope.caption = attrs.caption
+    )
+  controller: [ "$scope", "$element", "$attrs", "$transclude", ($scope, $element, $attrs, $transclude)->
+
+    # This method allows to access the transclude scope from the box controller:
+    #
+    #     scope_inside_the_box = $scope.transclude_scope()  # inside the BoxCtrl
+    #
+    $scope.transclude_scope = -> $scope.$$nextSibling
+
+    # This will allow to access the box scope from the scope inside the box:
+    #
+    #     box_scope = $scope.box_scope()  # from inside the box (transclude).
+    #
+    $scope.$watch( (->$scope.$$nextSibling), (transclude_scope)->
+      transclude_scope.box_scope = -> $scope
+    )
+  ]
+
+} )
+

data/app/assets/javascripts/directives-ng/star_tool_directive.js.coffee

@@ -0,0 +1,111 @@
+#
+# This file specifies the star-tool directive within the angular js framework.
+# This allows to add a tag that allows the user to star or unstar an navable
+# object, i.e. to bookmark it.
+#
+# Use the tag like this:
+#
+#     <star-tool bookmarkable-type="User" bookmarkable-id="2403" user-id="382" bookmark="{JSON object...}" />
+#
+# where the arguments are as follows:
+#
+#     bookmarkable-type, bookmarkable-id      identify the object to be starred/unstarred
+#     user-id                                 identify the user that is starring/unstarring the object
+#     bookmark  (JSON)                        allows to pre-populate the star object (model instance).
+#
+
+@app.directive( "starTool", -> {
+  priority: 0,
+  template: '<span class="starred star has_tooltip" ng-show="bookmarked" ng-click="unbookmarkIt()" ' +
+                   'title="Click here to remove {{bookmark.bookmarkable.title}} from your list of bookmarks.">&#9733;</span>' +
+            '<span class="unstarred star has_tooltip" ng-hide="bookmarked" ng-click="bookmarkIt()" ' +
+                   'title="Click here to add {{bookmark.bookmarkable.title}} to your list of bookmarks.">&#9734;</span>',
+# templateUrl: 'some.html',
+  replace: false,
+  transclude: false,
+  restrict: 'E',
+  scope: true,
+  link: (scope, element, attrs)->
+    scope.$watch( (->attrs.bookmark), (value)->
+      unless scope.bookmarkable_type or scope.bookmarkable_id or scope.user_id or scope.bookmark
+        scope.bookmarkable_type = attrs.bookmarkableType
+        scope.bookmarkable_id = attrs.bookmarkableId
+        scope.user_id = attrs.userId
+        scope.bookmark = $.parseJSON( attrs.bookmark )
+    )
+  controller: [ "$scope", "$attrs", "Bookmark", "current_user_bookmarks", "$rootScope", ($scope, $attrs, Bookmark, current_user_bookmarks, $rootScope)->
+
+    $scope.bookmarked = false
+
+    # If given, use the bookmark attribute to pre-populate the object.
+    # Otherwise, load the object from the JSON resource.
+    #
+    # If the attribute is given, but there exists no bookmark record,
+    # the variable is 'null'. If not given, i.e. have to look it up,
+    # the variable is 'undefined'.
+    #
+    # The $scope becomes available later, the $attrs are available, yet.
+    # Therefore, use the $attrs, here.
+    #
+    # Since it is possible that the parent scope provides the bookmark,
+    # wait 200ms for the scope to be ready.
+    #
+    setTimeout( ->
+      unless $scope.bookmark
+        if typeof $attrs.bookmark == 'undefined'
+          $scope.bookmark = Bookmark.get( {
+            user_id: $scope.user_id,
+            bookmarkable_type: $scope.bookmarkable_type,
+            bookmarkable_id: $scope.bookmarkable_id
+          } )
+    , 200 )
+
+    # Set the bookmarked state to true if there is a bookmark. Otherwise, currently
+    # no bookmark exists.
+    #
+    $scope.$watch( 'bookmark', ->
+      $scope.bookmarked = true if $scope.bookmark
+    )
+
+    # This method bookmarks the object for the user, i.e. creates a bookmark.
+    #
+    $scope.bookmarkIt = ->
+
+      # mark the current star tool element as bookmarked, i.e. display the filled star.
+      $scope.bookmarked = true
+
+      # create a bookmark object
+      $scope.bookmark = new Bookmark( {
+        bookmarkable_type: $scope.bookmarkable_type,
+        bookmarkable_id: $scope.bookmarkable_id,
+        user_id: $scope.user_id
+      } )
+
+      # add the bookmark object to the current user's list of bookmarks,
+      # i.e. display it in the bookmarks menu, instantly.
+      current_user_bookmarks.add( $scope.bookmark )
+
+      # make the bookmark objet persistent
+      $scope.bookmark.$save()
+
+    # This method unbookmarks the object for the user, i.e. removes an existing bookmark.
+    #
+    $scope.unbookmarkIt = ->
+      $scope.bookmarked = false
+      current_user_bookmarks.remove( $scope.bookmark )
+      new Bookmark( $scope.bookmark ).$remove()
+
+    # Some other controller may change the bookmarks lists.
+    # This controller needs to track this in order to display the proper status.
+    #
+    $scope.$on( 'bookmarksChange', ->
+      if $.inArray( $scope.bookmark, current_user_bookmarks ) == -1
+        $scope.bookmarked = false
+      else
+        $scope.bookmarked = true
+    )
+
+  ]
+
+} )
+