flms 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTI5N2E2Zjc2YzRkNGNjYWQyYThkM2E0MzJmNDk5M2YxN2FiYzVkZg==
+  data.tar.gz: !binary |-
+    YzhlNDFlOTY4M2RkNjU2ZjQ3MzU2NTE0YjAzYjkzY2NkOGY3ZDdhMw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZWI5NDZiODI1NzAxOGNlNGYxYjNlMzFmNTk5NThkZWZhMzVhMDM5YzNmOTJl
+    Y2M5OWRhNzQyNDM3YjFkZGZkNjUwMDAxNTg3NWIzNjRjYTNlODRhMWNjMzg4
+    NDJhN2NlOTNiMzRhNDRkZjc3MzgwMGNjNmYwODc1ZGFjMjkyOTA=
+  data.tar.gz: !binary |-
+    ODdhYTQzMWI5NjllZjE5OTg3MWFiY2EwYjYwZGU4NTkxNmExODJjNDZjMGM4
+    NzRhNTc3YTAzZjFkOTBmNjYxOGJlOTllZjMxMDUyYTQzMGRkMWY4NTMwYzYw
+    MDg5MTQ0YjkwNjU1OTFkMjJlNmRiYzY2MzJiYWVlNGQwNWIxMWI=

data/README.md

@@ -1,3 +1,103 @@
-= Flms [![Build Status](https://travis-ci.org/Originate-Inc/flms.png?branch=travis)](https://travis-ci.org/Originate-Inc/flms) [![Code Climate](https://codeclimate.com/github/Originate-Inc/flms.png)](https://codeclimate.com/github/Originate-Inc/flms)
+= Flms [![Build Status](https://travis-ci.org/Originate-Inc/flms.png?branch=travis)](https://travis-ci.org/Originate-Inc/flms) [![Code Climate](https://codeclimate.com/github/Originate-Inc/flms.png)](https://codeclimate.com/github/Originate-Inc/flms) [![Coverage Status](https://coveralls.io/repos/Originate/flms/badge.png?branch=master)](https://coveralls.io/r/Originate/flms) [![Dependency Status](https://gemnasium.com/Originate/flms.png)](https://gemnasium.com/Originate/flms)
 
-This project rocks and uses MIT-LICENSE.
+FLMS: the Floating Layer Management System
+==========================================
+
+FLMS is a CMS for web pages that use interactive layers to present animated content.  Essentially, it is an easy way to leverage the excellent [skrollr.js library](https://github.com/Prinzhorn/skrollr), included in this plugin. Creating the numerous data-xxxx styling tags to animate skrollr content gets tedious quickly, so FLMS automates the task.
+
+Via the CMS, users can create 'layers' containing various types of rich content:
+* Basic images (uploader included)
+* Text banners
+* Paragraphs with headings
+* Embedded HTML (useful for things like YouTube videos and the like)
+* Animated images (sprited animations that progress as the viewer scrolls)
+
+The end result: create animated, parallax-scrolling sites via a CMS without needing to write a line of code.  So sweet.
+
+Setup
+-----
+
+Install the engine in your Rails app:
+
+    gem install flms
+
+Install FLMS-related migrations to the host app and run them:
+
+    rake flms:install:migrations
+    rake db:migrate
+
+Create a user:
+
+    rake flms:create_user[YourEmailAddressHere@example.com]
+
+...start your rails server, and you can log in at 0.0.0.0:3000/flms/login.
+
+Basic Concepts
+==============
+
+FLMS includes a built-in user authentication built via Devise, and the FLMS CMS pages all require login (with a few exceptions as noted below).  The intent is to allow users to get up and running quickly with a usable CMS in a minimum of fuss.
+
+FLMS includes the Carrierwave gem for handling file uploads.
+
+Content in FLMS is built around the following core models: Layers, Blocks, and Pages.
+
+Layers
+------
+
+The primary content model is the layer.  A layer in the most basic sense is a HTML DIV element that is animated via a series of  keyframes (i.e., snapshots of CSS properties).  The DIV can contain any content desired, although FLMS provides some basic layer types that provide an easy shortcut for creating basic animations.
+
+The following 'simplified' layer types are provided by FLMS:
+* Image: a simple div containing an uploaded image as the background-image.
+* Text: a textual string, with controls for text size and color.
+* Paragraph: a 'descriptive' block of text, with a header and body copy.
+* Embed: allows users to embed arbitrary HTML, very useful for things like video elements from YouTube.
+* Animation: users can upload an image containing animation frames vertically stiched together as a sprite, and specify how 'playback' of the animation frames is performed as the user scrolls.
+
+These layer types simplify the process of creating animations by placing some constraints on how the animations are constructed. Specifically, the layers contain only three keyframes, to specify the beginning ('start'), middle ('target'), and final ('end') state of the layer.  The keyframes allow for animation of a small set of common CSS attributes.  Even with these constraints, a wide variety of animations can be created.
+
+In addition to these types, FLMS provides an 'advanced' layer type that allows for an arbitrary number of keyframes and much greater power in CSS animation.
+
+Blocks
+------
+
+A block is a collection of layers.  By definition parallax scrolling requires the differing movement of several layers simultaneously, so FLMS collects a set of layers within a block.  Blocks are identified by both a CSS name and human-friendly name, and can be given a thumbnail identifier image.
+
+Pages
+-----
+
+A page is given a name and a URL, and houses a collection of blocks, which are shown to the user in sequence as they scroll down the body of the page.
+
+Pages provide a convenient endpoint for populating content into the host Rails app - simply add the following catch-all line to your routes.rb file in the host app to show FLMS pages as if they were full-fledged elements of your site:
+
+    match '*id' => 'flms/pages#show'
+
+Customization
+==============
+
+You can customize the views and or assets of FLMS in your app with either of the following rake commands:
+
+    rake flms:generate:views
+
+or
+
+    rake flms:generate:assets
+
+These commands allow you to edit the styles and or views in your app.  Views will appear in 'app/views/flms', assets in 'app/assets/flms'.  When using assets remember to require the stylesheets in application.css with the following line:
+
+    *= require_directory ./flms
+
+To undo the generators use the respective commands as listed below:
+
+    rake flms:destroy:views
+
+or
+
+    rake flms:destroy:assets
+
+to remove the added views or assets from you application.
+
+Credits
+=======
+
+FLMS is brought to you by the fine folks at [Originate](http://www.originate.com), and is distributed under the MIT-LICENSE.
+Thanks of course due to Alexander Prinzhorn and the team behind the Skrollr library, on top of which this project is built.

data/app/assets/javascripts/flms/admin.js

@@ -14,5 +14,5 @@
 //= require jquery_ujs
 //= require jquery-ui
 //= require modularity/modularity
-//= require_tree .
+//= require_tree ./admin/
 //= require bootstrapSwitch

data/app/assets/javascripts/flms/{layout.coffee → admin/layout.coffee}

@@ -1,8 +1,8 @@
 $ ->
-  setTimeout remove_flash, 3000
+  setTimeout remove_flash, 1500
 
 
 # Fades out the flash messages.
 remove_flash = ->
-  $('.flash').fadeOut 1500, ->
+  $('.flash').fadeOut 1000, ->
     $('.flash').remove()

data/app/assets/javascripts/flms/{blocks/index → admin/pages/edit}/block_list.coffee

@@ -17,4 +17,4 @@ class @BlockList extends modularity.Module
 
   # Called when the sorting is done.
   sorting_finished: =>
-    @fire 'sorting_finished'
+    @trigger 'sorting_finished'

data/app/assets/javascripts/flms/{blocks/index/index.coffee → admin/pages/edit/edit.coffee}

@@ -1,5 +1,5 @@
-# Page controller for the 'index' page for blocks.
-class @BlocksIndexPage extends modularity.Module
+# Page controller for the 'edit' screen for pages.
+class @PageEditPage extends modularity.Module
 
   constructor: ->
     super 'body'

data/app/assets/javascripts/flms/public.js

@@ -0,0 +1,17 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery.easing.1.3
+//= require skrollr.min
+//= require jquery.quicksand.js
+//= require_self

data/app/assets/stylesheets/flms/admin.css

@@ -1,7 +1,7 @@
 /*
  * CSS for the flms pages.
  *
- *= require_tree .
+ *= require_tree ./admin/.
  *= require jquery-ui
  *= require bootstrap
  *= require bootstrapSwitch

data/app/assets/stylesheets/flms/{home.sass → admin/home.sass}

@@ -27,4 +27,3 @@ h4
   color: #333333
   border: 0
   border-bottom: 1px solid #e5e5e5
-

data/app/assets/stylesheets/flms/admin/layers/form.sass

@@ -0,0 +1,4 @@
+form
+  textarea
+    max-height: 150px
+    resize: none

data/app/assets/stylesheets/flms/{blocks/index.sass → admin/pages/edit.sass}

@@ -1,7 +1,7 @@
 $drag-color: rgba(255, 255, 200, 0.6)
 
 
-body.blocks.index
+body.pages.edit
 
   td
     vertical-align: middle

data/app/assets/stylesheets/flms/public.css

@@ -0,0 +1,8 @@
+/*
+ * CSS for public facing flms pages.
+ *
+ *= require_tree ./public/.
+ *= require jquery-ui
+ *= require bootstrap
+ *= require bootstrapSwitch
+ */

data/app/assets/stylesheets/flms/public/public.sass

@@ -0,0 +1,52 @@
+body
+  padding-top: 20px
+  padding-bottom: 40px
+
+.container-narrow
+  margin: 0 auto
+  max-width: 700px
+
+#skrollr-body
+  #page
+    width: 100%
+    height: 100%
+    position: fixed
+    top: 0
+    left: 0
+    background-color: #000
+
+    .block
+      .image-layer
+        position: absolute
+        background-attachment: fixed
+
+        .image-div
+          background-repeat: no-repeat
+          background-position: center center
+          width: 100%
+          height: 100%
+
+      .text-layer
+        position: absolute
+        text-align: center
+        white-space: nowrap
+
+      .paragraph-layer
+        position: absolute
+        .box
+          padding: 10px 10px
+
+      .embed-layer
+        position: absolute
+        iframe
+          width: 100%
+          height: 100%
+
+      .animation-layer
+        position: absolute
+        .animation-frames
+          background-repeat: no-repeat
+
+    .scroll
+      left: 50%
+      margin-left: -25px

data/app/controllers/flms/abstract_layer_controller.rb

@@ -0,0 +1,45 @@
+require_dependency "flms/application_controller"
+
+module Flms
+  class AbstractLayerController < ApplicationController
+    layout 'flms/admin'
+    before_filter :authenticate_user!
+    before_filter :load_block
+    before_filter :load_layer, only: [:show, :edit, :update, :delete]
+
+    # All layer controllers utilize the same edit action
+    def edit
+    end
+
+  protected
+
+    # Call from create action in derived controller to complete create action
+    def do_create
+      @layer.block = @block
+      if @layer.save
+        redirect_to edit_block_path(@block), notice: 'Layer created'
+      else
+        render action: "new"
+      end
+    end
+
+    # Call with result of update_attributes call from update action in
+    # derived controller
+    def do_update status
+      if status
+        redirect_to edit_block_path(@block), notice: 'Layer updated'
+      else
+        render action: "edit"
+      end
+    end
+
+    def load_block
+      @block = Block.find params[:block_id]
+    end
+
+    def load_layer
+      raise 'I should be overridden in a derived class to load the proper layer type!'
+    end
+  end
+end
+

data/app/controllers/flms/animation_layers_controller.rb

@@ -0,0 +1,26 @@
+module Flms
+  class AnimationLayersController < AbstractLayerController
+
+    def new
+      @layer = AnimationLayer.new.build_default_keyframes
+    end
+
+    def create
+      @layer = AnimationLayer.new params[:animation_layer]
+      @layer.image = params[:animation_layer][:image]
+      do_create
+    end
+
+    def update
+      do_update @layer.update_attributes(params[:animation_layer])
+    end
+
+  protected
+
+    def load_layer
+      @layer = AnimationLayer.find params[:id]
+    end
+
+  end
+end
+

data/app/controllers/flms/application_controller.rb

@@ -1,4 +1,17 @@
 module Flms
   class ApplicationController < ActionController::Base
+
+    # When we want to render a partial as HTML, but specify the plain_html custom
+    # format to a view, we need this method to swap the format to html so that
+    # Rails can properly resolve the partials (since we use *.html.haml for both
+    # :html and :plain_html formats)
+    def with_format format
+      old_formats = formats
+      self.formats = [format]
+      yield
+      self.formats = old_formats
+      nil
+    end
+
   end
 end

data/app/controllers/flms/blocks_controller.rb

@@ -3,14 +3,22 @@ require_dependency "flms/application_controller"
 module Flms
   class BlocksController < ApplicationController
     layout 'flms/admin'
-    before_filter :authenticate_user!
-    before_filter :load_page
+    before_filter :authenticate_user!, except: [ :show ]
     before_filter :load_block, only: [:show, :edit, :update, :destroy]
+    layout :resolve_layout
 
     def index
+      @blocks = Block.all
     end
 
     def show
+      respond_to do |format|
+        format.plain_html { with_format('html') { render partial: 'flms/elements/block',
+                                                         layout: 'flms/plain_styling',
+                                                         locals: { block: @block, scroll_offset: 0 } } }
+        format.html
+        format.json { render json: @page }
+      end
     end
 
     def new
@@ -22,9 +30,9 @@ module Flms
 
     def create
       @block = Block.new(params[:block])
+
       if @block.save
-        @block.pages << @page
-        redirect_to page_blocks_path(@page), notice: 'Block created.'
+        redirect_to blocks_path, notice: 'Block created.'
       else
         render action: "new"
       end
@@ -32,36 +40,26 @@ module Flms
 
     def update
       if @block.update_attributes(params[:block])
-        redirect_to [@page, :blocks], notice: 'Block was successfully updated.'
+        redirect_to blocks_path, notice: 'Block was successfully updated.'
       else
         render action: "edit"
       end
     end
 
-    def update_all
-      params[:block_data].each_with_index do |block_data, pos|
-        position = @page.position_for_block block_data[:id].to_i
-        position.active = block_data[:active]
-        position.ordering = pos
-        position.save!
-      end
-      render text: ''
-    end
-
     def destroy
       @block.destroy
-      redirect_to page_blocks_path(@page), notice: 'Block deleted'
+      redirect_to blocks_path, notice: 'Block deleted'
     end
 
-
-    private
-
-    def load_page
-      @page = Page.find_by_url params[:page_id]
-    end
+  private
 
     def load_block
       @block = Block.find params[:id]
     end
+
+    def resolve_layout
+      action_name == 'show' ? 'flms/public' : 'flms/admin'
+    end
+
   end
 end