vitrage 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c668c147525e7adc7619a7c059273fdbed9cfd0d
-  data.tar.gz: c8c65f7cfffd9a0d231eddeb8133670bff403942
+SHA256:
+  metadata.gz: 266999f8015d3ceb887463b45bf24b74cbfd55eaa742182f45ed65b2e5442bd9
+  data.tar.gz: 6d2cee221763193b3d02afe29e8bb081b2124e97d15851b976fecae95e094f5d
 SHA512:
-  metadata.gz: 9ab5a9b4d656a6fd8ff087d732b34f2ed203555dccb14c83421bbaf8c3579b3c24a9c09ce42c224b42de2f9c82ef517aef5a4db5a258cf66d0d328ee1499cca0
-  data.tar.gz: 96169ea834658d55a05b46cc4173cb3ed3e1d0b6d988495ca1654ab4e30d4cd75350231dd58fab80b03989e607cf10883c25944b5c129db1e72cf5cf51b043ef
+  metadata.gz: 9f52fe81e123bcb423d6d71aac3a7844424692cbf3685061c162dd4ef7c5971590ea69a910a87bc425a0a5f57250d79a0795ca3da3e9a2fe1e0de5bc455baf4c
+  data.tar.gz: 3864193fc3736f6475ecdcec557cdb25d7490f290077e5ca88c088103827d84cb2d31435b007b511709b553b7ef3a217b2ff654d4c629ad4ce27bd9a697932c6

data/README.md

@@ -1,10 +1,15 @@
 Vitrage
 =======
 
-Vitrage allows store and manage your Rails application web-pages content as separated pieces of different types: text, image, slider, several-columned text etc. Pieces are objects of different Rails models having their specific views for show and edit. Vitrage allows you inline editing of content pieces.
+> [!WARNING]
+> This project has been archived and is no longer supported.
+
+Vitrage allows you to store and manage your Rails application content as separated pieces of different types: text, image, slider, several-columned text etc. Pieces are objects of different Rails models, that have their specific views for show and edit actions. Vitrage allows you to edit the content pieces inline.
 
 <img src="http://www.vitroart.ru/upload/information_system_35/4/2/2/item_422/information_items_1242584051.jpg" alt="vitrage of glass" height="600" width="379">
 
+[![Gem Version](https://badge.fury.io/rb/vitrage.svg)](http://badge.fury.io/rb/vitrage)
+[![vitrage API Documentation](https://www.omniref.com/ruby/gems/vitrage.png)](https://www.omniref.com/ruby/gems/vitrage)
 
 Installation
 ------------
@@ -32,8 +37,14 @@ Now, migrate your database: `bin/rake db:migrate`
 
 Require js in your js file (`application.js` by default):
 
+    //= require jquery
+    //= require jquery_ujs
+    //= require jquery.remotipart
     //= require vitrage/vitrage
 
+Vitrage needs jquery, jquery_ujs and jquery.remotipart for correct work.
+If you have this scripts already required, just skip inserting they strings.
+
 Require vitrage css in your css file (`application.css` by default):
 
     *= require vitrage/vitrage

data/app/assets/javascripts/vitrage/editor.js.coffee

@@ -1,23 +1,68 @@
 $(document).ready ->
   if $(".vtrg-add-new-wrapper").length
 
+    # # # SORTABLE module # TODO find correct place for this module
+    sortableo = null
+    sortable_el = document.getElementById('vitrage-edit')
+
+    initSortable = ->
+      if sortableo
+        sortableo.destroy()
+        sortableo = null
+      sortableo = Sortable.create document.getElementById('vitrage-edit'),
+        sort: true
+        handle: ".vtrg-edit-control-move"
+        onUpdate: (evnt) ->
+          draggedItem = $(evnt.item)
+          nextItem = draggedItem.next()
+          # console.log "Next item has id = " + nextItem.data("id")
+          $.ajax
+            url: "/vitrage/pieces/" + draggedItem.data("id") + "/reorder"
+            type: "POST"
+            dataType: "json"
+            data:
+              beforeid: if nextItem.length then nextItem.data("id") else "end"
+            # success: (data, textStatus, jqXHR) ->
+            # error: null # TODO
+
+    initSortable()
+    # # # END OF SORTABLE module
+
+    event_provider = $(".vtrg-add-new-wrapper")
+
     toggleEditorBlocker = ($editWrapper, act) ->
       $editWrapper.toggleClass 'blocked', act
 
-    # --- # --- VIEW --- # --- #
-    restoreViewState = ($editWrapper, viewdata) ->
+    showPieceInputsErrors = ($editWrapper, responseText) ->
+      $editWrapper.find("li.input.error").removeClass("error")
+
+      data = null
+      try
+        data = JSON.parse(responseText)
+      catch error
+        a = 12 # at least we tried
+      return true unless data
+
+      if data.piece && data.errors
+        for key, val of data.errors
+          $errorIWrapper = $editWrapper.find "li.input#vitrage_pieces_" + data.piece.toString() + "_" + key.toString() + "_input"
+          $errorIWrapper.addClass "error"
+
+    # --- # --- SHOW --- # --- #
+    restoreShowState = ($editWrapper, viewdata) ->
       if viewdata
         $editWrapper.removeClass "editmode"
         $editWrapper.children(".vtrg-edit-body").html viewdata
         toggleEditorBlocker $editWrapper, false
+        event_provider.trigger "vitrageshowed", [ $editWrapper[0] ]
       else
         $.ajax
           url: "/vitrage/pieces/" + $editWrapper.data("id")
           # type: "GET"
           dataType: "html"
           success: (data, textStatus, jqXHR) ->
-            restoreViewState $editWrapper, data
-          # error: null
+            restoreShowState $editWrapper, data
+          # error: null # TODO
 
     # --- # --- UPDATE and cancel editing --- # --- #
     coverEditFormActions = ($editWrapper) ->
@@ -29,9 +74,14 @@ $(document).ready ->
         return true # do your work buddy
 
       $blockForm.on "ajax:success", (evnt, data, textStatus, jqXHR) ->
-        restoreViewState $(@).closest(".vtrg-edit-wrapper"), data
-      # $blockForm.on "ajax:error"
-      # $blockForm.on "ajax:complete"
+        event_provider.trigger "vitrageupdated"
+        restoreShowState $(@).closest(".vtrg-edit-wrapper")
+
+      $blockForm.on "ajax:error", (evnt, xhr, status, error) ->
+        showPieceInputsErrors $(@).closest(".vtrg-edit-wrapper"), xhr.responseText
+
+      $blockForm.on "ajax:complete", (evnt, para1, para2) ->
+        toggleEditorBlocker $(@).closest(".vtrg-edit-wrapper"), false
 
 
       # cover Cancel action
@@ -41,7 +91,7 @@ $(document).ready ->
         if clickedAnchorParentID && clickedAnchorParentID.substr(clickedAnchorParentID.length - 13) == "cancel_action"
           evnt.preventDefault()
           toggleEditorBlocker $editWrapper, true
-          restoreViewState $editWrapper
+          restoreShowState $editWrapper
           return false
 
     # --- # --- EDIT --- # --- #
@@ -52,14 +102,14 @@ $(document).ready ->
         toggleEditorBlocker $editWrapper, true
         $.ajax
           url: "/vitrage/pieces/" + $editWrapper.data("id") + "/edit"
-          # type: "GET"
           dataType: "html"
           success: (data, textStatus, jqXHR) ->
             $editWrapper.addClass "editmode"
             $editWrapper.children(".vtrg-edit-body").html data
             coverEditFormActions $editWrapper
             toggleEditorBlocker $editWrapper, false
-          # error: null
+            event_provider.trigger "vitrageedit", [ $editWrapper ]
+          # error: null # TODO
         return
       return
     # init edit control for all exists
@@ -78,7 +128,8 @@ $(document).ready ->
             dataType: "html"
             success: (data, textStatus, jqXHR) ->
               $editWrapper.remove()
-            # error: null
+              event_provider.trigger "vitragedestroyed"
+            # error: null # TODO
         return
       return
     # init destroy control for all exists
@@ -94,18 +145,18 @@ $(document).ready ->
         return true # do your work buddy
 
       $blockForm.on "ajax:success", (evnt, data, textStatus, jqXHR) ->
-        clwr = $(@).closest(".vtrg-edit-wrapper")
-        if $(@).data('remotipartSubmitted')
-          a = 12
-          console.log "ololo"
-        else
-          clwr.after data
-        brandNewWrapper = clwr.next()
-        clwr.remove()
-        initDestroyControl brandNewWrapper
-        initEditControl brandNewWrapper
-      # $blockForm.on "ajax:error"
-      $blockForm.on "ajax:complete", ->
+        $editWrapper = $(@).closest(".vtrg-edit-wrapper")
+        $editWrapper.attr 'data-id', data
+        initDestroyControl $editWrapper
+        initEditControl $editWrapper
+        event_provider.trigger "vitragecreated", [ $editWrapper ]
+        restoreShowState $editWrapper
+        initSortable()
+
+      $blockForm.on "ajax:error", (evnt, xhr, status, error) ->
+        showPieceInputsErrors $(@).closest(".vtrg-edit-wrapper"), xhr.responseText
+
+      $blockForm.on "ajax:complete", (evnt, para1, para2) ->
         toggleEditorBlocker $(@).closest(".vtrg-edit-wrapper"), false
 
       # cover Cancel action
@@ -120,7 +171,11 @@ $(document).ready ->
     # --- # --- NEW --- # --- #
     $createAnchors = $(".vtrg-new-block-kinds a")
     $createAnchors.on "ajax:success", (evnt, data, textStatus, jqXHR) ->
-      $(".vtrg-add-new-wrapper").before data
-      coverNewFormActions $(".vtrg-edit-wrapper:last")
-    # $createAnchors.on "ajax:error"
-    # $createAnchors.on "ajax:complete"
+      # $(".vtrg-add-new-wrapper").before data
+      $("#vitrage-edit").append data
+      $editWrapper = $(".vtrg-edit-wrapper:last")
+      coverNewFormActions $editWrapper
+      event_provider.trigger "vitragenew", [ $editWrapper ]
+
+    # $createAnchors.on "ajax:error" # TODO
+    # $createAnchors.on "ajax:complete" # TODO

data/app/assets/javascripts/vitrage/vitrage.js

@@ -1,3 +1,4 @@
-//= require jquery
-//= require jquery_ujs
+// must be required jquery
+// must be required jquery_ujs
+//= require Sortable
 //= require vitrage/editor

data/app/assets/stylesheets/vitrage/editor.scss

@@ -13,6 +13,7 @@ $vtrg-act-color: #c19a6b; // Цвет увядших листьев
   .vtrg-edit-control {
     display: none;
     position: absolute;
+    z-index: 99;
     &.top { top: 0; left: 0; }
     &.bottom { right: 0; bottom: 0; }
     padding: 4px;
@@ -38,6 +39,8 @@ $vtrg-act-color: #c19a6b; // Цвет увядших листьев
 }
 
 // ==== add new block button ==== ==== ==== ==== ==== ==== ==== ==== ==== ====
+.vtrg-add-new-wrapper { margin: 32px; }
+
 .vtrg-add-new {
   display: block;
   text-align: center;

data/app/controllers/vitrage/pieces_controller.rb

@@ -7,7 +7,7 @@ module Vitrage
         format.html { render layout: false }
       end
     end
-   
+
     def new
       piece_class = params[:kind]
       unless piece_class &&
@@ -15,75 +15,95 @@ module Vitrage
         piece_class = VitrageOwnersPiecesSlot::PIECE_CLASSES_STRINGS.first
       end
       @piece = VitragePieces.const_get(piece_class).new
-      
+
       respond_to do |format|
         format.html { render layout: false }
       end
     end
-   
+
     def edit
       respond_to do |format|
         format.html { render layout: false }
       end
     end
-   
+
     def create
-      wrong_params_here = false
+      error_state = nil
 
       # check existance of params
       unless params[:kind] &&
              VitrageOwnersPiecesSlot::PIECE_CLASSES_STRINGS.include?(params[:kind]) &&
              params[:owner_type] &&
              params[:owner_id]
-        wrong_params_here = true
+        error_state = { descr: "Necessary parameters didn't exist error" }
       end
 
       # get the owner of vitrage
-      unless wrong_params_here
+      if error_state.nil?
         @owner = nil
         begin
           @owner = Object.const_get(params[:owner_type]).find params[:owner_id]
         rescue Exception => e
-          wrong_params_here = true
+          error_state = { descr: "Owner find error" }
         end
       end
 
       # create piece
-      unless wrong_params_here
+      if error_state.nil?
         @piece = VitragePieces.const_get(params[:kind]).new
         @piece.assign_attributes vitrage_piece_params
-        wrong_params_here = true unless @piece.save
+        unless @piece.save
+          error_state = {
+            descr: "Piece save error",
+            piece: @piece.class.name.demodulize.underscore,
+            errors: @piece.errors
+          }
+        end
       end
 
       # create vitrage slot
-      unless wrong_params_here
+      if error_state.nil?
         @slot = VitrageOwnersPiecesSlot.new owner: @owner, piece: @piece
         unless @slot.save
-          wrong_params_here = true
+          error_state = { descr: "Slot save error" }
           @piece.destroy
         end
       end
 
-      if wrong_params_here
+      if error_state
         respond_to do |format|
-          format.html { render text: "error", status: :unprocessable_entity }
+          format.html { render json: error_state.merge({ status: 'error' }),
+                        status: :unprocessable_entity }
         end
       else
-        # respond_to do |format|
-        #   format.html { render layout: false }
-        # end
-        render layout: false
+        respond_to do |format|
+          format.html { render layout: false }
+          format.js # for remotipart gem correct work (ajax multipart form)
+        end
+        # render layout: false
       end
     end
-   
-    def update
-      @piece.update vitrage_piece_params
 
-      respond_to do |format|
-        format.html { render action: "show", layout: false }
+    def update
+      if @piece.update(vitrage_piece_params)
+        respond_to do |format|
+          format.html { render text: "" }
+          format.js { render text: "" }
+        end
+      else
+        error_state = {
+          status: 'error',
+          descr: "Piece save error",
+          piece: @piece.class.name.demodulize.underscore,
+          errors: @piece.errors
+        }
+        respond_to do |format|
+          format.html { render json: error_state, status: :unprocessable_entity }
+          format.js { render json: error_state, status: :unprocessable_entity }
+        end
       end
     end
-   
+
     def destroy
       @slot = VitrageOwnersPiecesSlot.find params[:id]
       @slot.destroy
@@ -93,6 +113,53 @@ module Vitrage
       end
     end
 
+    def reorder
+      moved_slot = VitrageOwnersPiecesSlot.find params[:id]
+      wrong_params = false
+
+      if params[:beforeid].present?
+        if params[:beforeid] == "end"
+          max_ordn = moved_slot.owner.vitrage_slots.maximum(:ordn)
+          moved_slot.update_attributes ordn: max_ordn ? max_ordn + 1 : 1
+        else
+
+          slot_after_moved = VitrageOwnersPiecesSlot.find_by_id params[:beforeid]
+          if slot_after_moved.present? && slot_after_moved.owner == moved_slot.owner
+            ordn_for_moved = slot_after_moved.ordn
+            all_slots_after_moved = moved_slot.owner.vitrage_slots.
+                                                     where("vitrage_owners_pieces_slots.ordn >= ?", ordn_for_moved).
+                                                     where.not(id: moved_slot.id).
+                                                     order(ordn: :asc)
+            all_slots_after_moved.each do |slot|
+              slot.update_attributes ordn: slot.ordn + 1
+            end
+            moved_slot.update_attributes ordn: ordn_for_moved
+
+          else
+            wrong_params = true
+          end
+        end
+      else
+        wrong_params = true
+      end
+
+      if wrong_params
+        render text: "wrong params", status: :unprocessable_entity
+      else
+        render text: "ok"
+      end
+    end
+
+    def restore_order
+      owners = VitrageOwnersPiecesSlot.all.collect { |vp| vp.owner }.uniq
+      owners.each do |owner|
+        owner.vitrage_slots.each_with_index do |slot, indx|
+          slot.update_attributes ordn: indx + 1
+        end
+      end
+      render text: "ok"
+    end
+
     private
 
     def find_vitrage_piece

data/app/views/vitrage/_edit.html.erb

@@ -1,11 +1,13 @@
 <%= evil_icons_sprite %>
-<% owner.vitrage_slots.each do |slot| %>
-  <%= render partial: "vitrage/edit_wraped_piece", locals: { slot: slot } %>
-<% end %>
+<div id="vitrage-edit">
+  <% owner.vitrage_slots.each do |slot| %>
+    <%= render partial: "vitrage/edit_wraped_piece", locals: { slot: slot } %>
+  <% end %>
+</div>
 
 <div class="vtrg-add-new-wrapper">
   <div class="vtrg-new-block-kinds">
-    <span><%= evil_icon 'ei-plus', size: "l" %></span>
+    <span><%= evil_icon 'ei-plus', size: "m" %></span>
     <% VitrageOwnersPiecesSlot::PIECE_CLASSES_STRINGS.each do |piece_class_string| %>
       <%= link_to "", Rails.application.routes.url_helpers.new_vitrage_piece_path(kind: piece_class_string, owner_type: owner.class.name, owner_id: owner.id), role: "button", class: piece_class_string.underscore.dasherize, remote: true %>
     <% end %>

data/app/views/vitrage/_edit_wraped_piece.html.erb

@@ -1,8 +1,12 @@
+<% slot = slot || nil %>
 <% piece = piece || slot.piece %>
 
-<div class="vtrg-edit-wrapper" data-id="<%= slot.id %>">
+<div class="vtrg-edit-wrapper" data-id="<%= (slot ? slot.id : 'new') %>">
   <% ['top', 'bottom'].each do |position_class| %>
     <div class="vtrg-edit-control <%= position_class %>">
+      <a href="javascript:void(0)" role="button" rel="move" class="vtrg-edit-control-move" title="<%= t('vitrage.move') %>">
+        <%= evil_icon 'ei-retweet', size: "m" %>
+      </a>
       <a href="javascript:void(0)" role="button" rel="edit" title="<%= t('vitrage.edit') %>">
         <%= evil_icon 'ei-pencil', size: "m" %>
       </a>

data/app/views/vitrage/pieces/create.html.erb

@@ -1 +1 @@
-<%= render partial: "vitrage/edit_wraped_piece", locals: { slot: @slot, piece: @piece } %>
+<%= @slot.id %>

data/app/views/vitrage/pieces/create.js.erb

@@ -0,0 +1 @@
+<%= @slot.id %>

data/app/views/vitrage/pieces/new.html.erb

@@ -1,4 +1,19 @@
 <div class="vtrg-edit-wrapper editmode">
+    <% ['top', 'bottom'].each do |position_class| %>
+    <div class="vtrg-edit-control <%= position_class %>">
+      <a href="javascript:void(0)" role="button" rel="move" class="vtrg-edit-control-move" title="<%= t('vitrage.move') %>">
+        <%= evil_icon 'ei-retweet', size: "m" %>
+      </a>
+      <a href="javascript:void(0)" role="button" rel="edit" title="<%= t('vitrage.edit') %>">
+        <%= evil_icon 'ei-pencil', size: "m" %>
+      </a>
+      <a href="javascript:void(0)" role="button" rel="destroy" title="<%= t('vitrage.destroy') %>">
+        <%= evil_icon 'ei-trash', size: "m" %>
+      </a>
+    </div>
+  <% end %>
   <div class="vtrg-edit-block-cover"><%= evil_icon 'ei-spinner', size: "m" %></div>
-  <%= render partial: "vitrage/form_wrap", locals: { piece: @piece } %>
+  <div class="vtrg-edit-body">
+    <%= render partial: "vitrage/form_wrap", locals: { piece: @piece } %>
+  </div>
 </div>

data/app/views/vitrage/pieces/show.html.erb

@@ -1 +1 @@
-<%= render partial: "vitrage/#{@item.class.name.demodulize.underscore}", locals: { piece: @piece } %>
+<%= render partial: "vitrage/#{@piece.class.name.demodulize.underscore}", locals: { piece: @piece } %>

data/config/locales/vitrage_en.yml

@@ -1,4 +1,5 @@
 en:
   vitrage:
     edit: "Edit"
-    destroy: "Delete"
+    destroy: "Delete"
+    move: "Move"

data/config/locales/vitrage_ru.yml

@@ -2,3 +2,4 @@ ru:
   vitrage:
     edit: "Редактировать"
     destroy: "Удалить"
+    move: "Переместить"

data/lib/generators/vitrage/templates/vitrage_slot.rb

@@ -4,7 +4,20 @@ class VitrageOwnersPiecesSlot < ActiveRecord::Base
   belongs_to :owner, polymorphic: true
   belongs_to :piece, polymorphic: true, dependent: :destroy
 
+  before_create :set_correct_order_num
+
   default_scope -> { order(ordn: :asc, id: :asc) }
 
   PIECE_CLASSES_STRINGS = [  ] # add pieces class names strings here (demodulized)
+
+  private
+
+  # TODO wrap this becausetroubles with updating this code in the future
+  def set_correct_order_num
+    self.ordn = 1
+    if owner
+      max_ordn = owner.vitrage_slots.maximum(:ordn)
+      self.ordn = max_ordn + 1 if max_ordn
+    end
+  end
 end

data/lib/vitrage/router.rb

@@ -2,19 +2,20 @@ module Vitrage
   module Router
 
     def routes(rails_router, options = {})
-      if options[:controller]
-        cs = options[:controller].to_s
-        rails_router.post   '/vitrage/pieces'           => "#{cs}#create", as: :vitrage_pieces
-        rails_router.get    '/vitrage/pieces/new'       => "#{cs}#new",    as: :new_vitrage_piece
-        rails_router.get    '/vitrage/pieces/:id/edit'  => "#{cs}#edit",   as: :edit_vitrage_piece
-        rails_router.get    '/vitrage/pieces/:id'       => "#{cs}#show",   as: :vitrage_piece
-        rails_router.match  '/vitrage/pieces/:id'       => "#{cs}#update", via: [:patch, :put]
-        rails_router.delete '/vitrage/pieces/:id'       => "#{cs}#destroy"
-      else
-        rails_router.namespace :vitrage do
-          rails_router.resources :pieces, except: [:index]
-        end
-      end
+      cs = options[:controller] ? options[:controller].to_s : "pieces"
+
+      rails_router.post   '/vitrage/pieces'             => "#{cs}#create", as: :vitrage_pieces
+      rails_router.get    '/vitrage/pieces/new'         => "#{cs}#new",    as: :new_vitrage_piece
+      rails_router.get    '/vitrage/pieces/restore_order' => "#{cs}#restore_order", as: :restore_order_vitrage_pieces
+      rails_router.get    '/vitrage/pieces/:id/edit'    => "#{cs}#edit",   as: :edit_vitrage_piece
+      rails_router.get    '/vitrage/pieces/:id'         => "#{cs}#show",   as: :vitrage_piece
+      rails_router.match  '/vitrage/pieces/:id'         => "#{cs}#update", via: [:patch, :put]
+      rails_router.delete '/vitrage/pieces/:id'         => "#{cs}#destroy"
+      rails_router.post   '/vitrage/pieces/:id/reorder' => "#{cs}#reorder", as: :vitrage_piece_reoder
+
+      # rails_router.namespace :vitrage do
+      #   rails_router.resources :pieces, except: [:index]
+      # end
     end
 
   end

data/lib/vitrage/version.rb

@@ -1,3 +1,3 @@
 module Vitrage
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end