Welcome to Authorly

Here be Dragons

Setup the application

1. Clone the repository on your machine
2. Create a suitable config/database.yml (production runs on MySQL)
3. bundle install
4. bundle exec rake db:create:all
5. bundle exec rake db:migrate
6. bundle exec rake db:seed
7. bundle exec rails server starts the server

Setup for getting transcoded video and audio versions

bundle exec zencoder_fetcher --loop --interval 10 --url 'http://127.0.0.1:3000/zencoder' <ZENCODER_API_KEY>

Setup for creating mobile applications

Install dependencies:

1. Install redis

2. Clone the mobile code

   cd ../.. git clone git@github.com:curiousminds/interapptive.git mv interapptive Crucible

Start workers:

1. redis-server starts redis
2. bundle exec rake environment resque:work QUEUE='ios_compilation' RAILS_ENV=development starts the compilation queue

Start compilation from the web application ('Compile to iOS' icon). Currently does not work because the code assumes it is run by a certain user, needs the keychain password in config/keychain_password.txt. Stopped trying to make this work on my machine. 2013-06-19@dira

Tests

Rails tests

`bundle exec rake`

Continuous testing:

`bundle exec guard -i`

Javascript tests

1. Install PhantomJS

In the browser:

`bundle exec guard -i`

The output contains the URL where it mounted the jasmine runner (something like http://localhost:[port]/jasmine). That URL works in the browser and you have the full UI (i.e. you can click on a test and it will only run that test)

Command line:

`guard-jasmine`
or
`bundle exec rake guard:jasmine`

Write Javascript tests

Write your model, view or collections tests under corresponding directories inside spec/javascripts/coffeescripts.

Builder

Synopsis

Builder is a custom widget framework/base class that provides a relevant API for making and running different type of widgets, which are objects that can be added to the canvas. Builder abstracts cocos2d-js which is a two-dimensional drawing library that's primarily used functionally. In this way, Builder provides a nice inheritable OO interface, which is great for testing and great for reuse.

Find it in app/assets/javascripts/builder/.

Some important Cocos2d Concepts

First, you should see this link for more information about the core concepts of Cocos.

To summarize, however:

• A scene is pretty self-explanatory. Think levels on a video game, or multiple, independent televisions screens. They're mostly independent of each other, but they have some logic for transitioning between each other
• The director, a singleton object that handles transitions between scenes, and handles main window instantiation in py-cocos2d;
• Layers are used to handle z-orientation of groups of items. Frequently are the location where event handlers are defined, and respond to events from front to back until one layer handles an event.
• Sprites are 2d images that can be transformed.
• Events are part of a standard Subscribe pattern. In short, some items act as emitters, which send out notifications when they receive certain stimulus. Other objects that have subscribed to the notifications will receive this notification and can chose to respond to it (called Listeners, usually).
  • Cocos uses events to specify user input, window status change, and to communicate across parts of a framework (decoupling).
• CocosNode is the superclass of the above (omitting the director?), and provides some default common functionality like positioning, controlling child elements, time management, and rendering.

cc is the Cocos2d namespace.

Cocos2d-html links:

• code
• download
• upgrade guides
• docs

Loading

1. application.js, with all generic js
2. /storybook/show starts loading cocos2d
3. the cocos2d configuration indicates that, when cocos2d is ready, builder should be laoded
4. cocos2d automatically loads /main.js, which is redirected (from Rails) to /assets/init_storybook.js
5. which initializes the builder and makes the canvas work

Widgets

Widgets are represented by two classes - a Backbone Model (that stores and manages the widget data) and a Builder View (which takes care of representing it on the UI and managing events).

How widgets work

1. The WidgetLayer manages widget space. It performs the following tasks too:

   • sets up a double-click watcher for the canvas;
   • defines methods for adding and removing widgets;
   • defines a method for getting a widget at a point
   • handles touch behaviour/moving and translates that into mouse behaviour.

2. The Widget parent class is what all widgets inherit from. It defines:

   • abstract mouseover/mouseout/dblclick responses;
   • abstract highlighting
   • opacity setters and getters

Fixtures

Reside in /spec/fixtures

Loading:

> cp spec/fixtures/stranger-in-the-woods.yml db/data.yml
> bundle exec rake db:data:load

Grab the JSON - in the web inspector console:

> storybook = App.currentSelection.get('storybook')
> json = (new App.JSON(storybook)).app
> JSON.stringify(json)

Run the iOS simulator:

• copy the json from the web inspector console (without the encompassing quotes)

• paste it over HelloWorld/Resources/structure-ipad.json (in the interapptive project)

• fix the asset paths by running

  sed -i '' 's/read_it_myself/read-it-myself/g;s/auto_play/autoplay/g;s/read_to_me/read-to-me/g;s//assets/sprites///g;s/https://interapptive.s3.amazonaws.com/[a-z_]/[0-9]///g' HelloWorld/Resources/structure-ipad.json

• run the iOS project ( HelloWorld/ios in the interraptive repo)