documentation-editor 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d8db49d46ea03aed0cf4ef19c9efa168153cfda
-  data.tar.gz: bd00b630e7c9905c85424b731bddf19dafa6f04e
+  metadata.gz: 64861b09302704f3c7b7f0c55dc3d49145889b1b
+  data.tar.gz: 5608cade9583700de74092931b3981e87ce0ca02
 SHA512:
-  metadata.gz: bb8c4efb42208c0a7a978f66a7e9dae2fe5c80c6f34d88501f61756133e16463d1fe5ed457c46f8d7c0e226fa820a2ebdfd17695487da56b011ff13a70a79c51
-  data.tar.gz: 7254b3d293888ecde417416c03d2c8b7662b4f876516093f89a4093ab8be447f80a3dedffdb252d36be5f3bb83cd28e06d779ae1b3cc7b7478f920ab1c6417e3
+  metadata.gz: 1354ceb452217b3cfe0ea3a2a860272438383e94976f0d1d151d6df7d95d74a7f4f51e38199119258f45d906e7453dc339cd193b838a28c1b211baada99ff9f9
+  data.tar.gz: ff350a5d4650de4ec38e3862e04722f57592abd06af38e4649695f5cf670ad55316f33601fb79387ddbd906b7d4b2ba7e932f0b0bd1e81d0411166b1fc5a07be

data/app/assets/stylesheets/documentation_editor/pages.css.sass

@@ -4,6 +4,9 @@
 #documentation-editor
   position: relative
 
+  .nowrap
+    white-space: nowrap
+
   .editor-header
     background-color: white
     display: block

data/app/controllers/documentation_editor/pages_controller.rb

@@ -32,11 +32,11 @@ module DocumentationEditor
     end
 
     def update
-      @page.position = params[:page][:position] || 0
+      @page.position = params[:page][:position] unless params[:page][:position].nil?
       @page.title = params[:page][:title] unless params[:page][:title].nil?
       @page.slug = params[:page][:slug] unless params[:page][:slug].nil?
       @page.description = params[:page][:description] unless params[:page][:description].nil?
-      @page.languages = params[:page][:languages] unless params[:page][:languages].nil?
+      @page.languages_raw = params[:page][:languages_raw] unless params[:page][:languages_raw].nil?
       @page.section = params[:page][:section] unless params[:page][:section].nil?
       @page.save!
       render nothing: true
@@ -53,7 +53,7 @@ module DocumentationEditor
       p.title = params[:page][:title]
       p.slug = params[:page][:slug]
       p.description = params[:page][:description]
-      p.languages = params[:page][:languages]
+      p.languages_raw = params[:page][:languages_raw]
       p.section = params[:page][:section]
       p.save!
       redirect_to edit_page_path(p)

data/app/models/documentation_editor/page.rb

@@ -8,6 +8,8 @@ module DocumentationEditor
 
     belongs_to :thumbnail, class_name: 'Image'
 
+    serialize :languages, Array
+
     after_create :add_first_revision
 
     def add_revision!(content, publish = false, author_id = nil)
@@ -26,6 +28,14 @@ module DocumentationEditor
       thumbnail.try(:image).try(:url)
     end
 
+    def languages_raw
+      self.languages.join(',')
+    end
+
+    def languages_raw=(v)
+      self.languages = v.to_s.split(/\s*,\s*/).reject { |x| x.blank? }
+    end
+
     private
     def add_first_revision
       r = Revision.new

data/app/models/documentation_editor/revision.rb

@@ -3,6 +3,7 @@ module DocumentationEditor
     belongs_to :page
 
     def to_html(options = {})
+      options = defaulted(options)
       html = parse_document(options).to_html
       # resolve the variables
       html = resolve_variables(options, html)
@@ -15,6 +16,7 @@ module DocumentationEditor
     end
 
     def to_toc(options = {})
+      options = defaulted(options)
       roots = []
       levels = []
       h1 = nil
@@ -41,6 +43,7 @@ module DocumentationEditor
     end
 
     def section_title(options, section)
+      options = defaulted(options)
       doc = parse_document(options.merge(no_wrap: true))
       ids = id_generator(doc)
       doc.root.children.each do |child|
@@ -119,5 +122,10 @@ module DocumentationEditor
       end
     end
 
+    def defaulted(options)
+      options[:language] = options[:language] || options['language'] || (page && page.languages.first)
+      options
+    end
+
   end
 end

data/app/views/documentation_editor/pages/edit.html.haml

@@ -3,35 +3,35 @@
     .editor-header
       %ul.list-inline.pull-right
         %li
-          %a.btn.btn-default.btn-sm{href: admin_path}
+          %a.btn.btn-default.btn-xs{href: admin_path}
             %i.fa.fa-chevron-left
-            Back to Admin
+            Home
         %li
-          %a.btn.btn-default.btn-sm{href: '#', 'ng-click' => 'save($event)', 'ng-disabled' => '!diff()'}
+          %a.btn.btn-default.btn-xs{href: '#', 'ng-click' => 'save($event)', 'ng-disabled' => '!diff()'}
             %i.fa.fa-save
             Save
         %li
-          %a.btn.btn-success.btn-sm{href: '#', 'ng-click' => 'preview($event)'}
+          %a.btn.btn-success.btn-xs{href: '#', 'ng-click' => 'preview($event)'}
             %i.fa.fa-eye
             Save & Preview
         %li
-          %a.btn.btn-danger.btn-sm{href: '#', 'ng-click' => 'publish($event)', 'ng-disabled' => 'published_revision_id === last_revision_id'}
+          %a.btn.btn-danger.btn-xs{href: '#', 'ng-click' => 'publish($event)', 'ng-disabled' => 'published_revision_id === last_revision_id'}
             %i.fa.fa-save
             Save & Publish
         %li
-          %a.btn.btn-default.btn-sm{href: '#', 'ng-click' => 'toggleView($event)'}
+          %a.btn.btn-default.btn-xs{href: '#', 'ng-click' => 'toggleView($event)'}
             %i.fa.fa-arrows-h
             Switch View
         %li
-          %a.btn.btn-default.btn-sm{href: '#', 'data-toggle' => 'modal', "data-target" => "#upload-thumbnail"}
+          %a.btn.btn-default.btn-xs{href: '#', 'data-toggle' => 'modal', "data-target" => "#upload-thumbnail"}
             %i.fa.fa-upload
             Thumbnail
         %li
-          %a.btn.btn-default.btn-sm{href: history_path(@page)}
+          %a.btn.btn-default.btn-xs{href: history_path(@page)}
             %i.fa.fa-history
             History
         %li
-          %a.btn.btn-warning.btn-sm{href: '#', 'ng-click' => 'undo($event)', 'ng-disabled' => 'undoRedo.length === 0'}
+          %a.btn.btn-warning.btn-xs{href: '#', 'ng-click' => 'undo($event)', 'ng-disabled' => 'undoRedo.length === 0'}
             %i.fa.fa-undo
             Undo
       %h1

data/app/views/documentation_editor/pages/history.html.haml

@@ -5,11 +5,11 @@
   .editor-header
     %ul.list-inline.pull-right
       %li
-        %a.btn.btn-default.btn-sm{href: admin_path}
+        %a.btn.btn-default.btn-xs{href: admin_path}
           %i.fa.fa-chevron-left
-          Back to Admin
+          Home
       %li
-        %a.btn.btn-default.btn-sm{href: edit_page_path(@page)}
+        %a.btn.btn-default.btn-xs{href: edit_page_path(@page)}
           %i.fa.fa-edit
           Edit
     %h1

data/app/views/documentation_editor/pages/index.html.haml

@@ -3,20 +3,18 @@
     %h1 Edit documentation
 
   .editor-content
+    = link_to '#', class: 'btn btn-success pull-right', onclick: '$("#modal-new-page").modal("show"); return false;' do
+      %i.fa.fa-plus-circle
+      Add a new page
     %h3 Pages
     %table.table.table-striped.pages
       %thead
         %tr
           %th Thumbnail
-          %th Position
-          %th Title
-          %th Slug
-          %th Description
-          %th Languages
-          %th Section
-          %th Last modification
-          %th Published at
-          %th Published by
+          %th.nowrap Position
+          %th.nowrap Title
+          %th.nowrap Slug
+          %th Metadata
           %th.text-right Actions
       %tbody
         - DocumentationEditor::Page.order('position ASC').each do |p|
@@ -24,33 +22,55 @@
             %td
               - if p.thumbnail
                 = image_tag p.thumbnail_url
-            %td= best_in_place p, :position, url: update_path(p)
-            %td= best_in_place p, :title, url: update_path(p)
-            %td= best_in_place p, :slug, url: update_path(p)
-            %td= best_in_place p, :description, url: update_path(p)
-            %td= best_in_place p, :languages, url: update_path(p)
-            %td= best_in_place p, :section, url: update_path(p)
-            %td= l p.created_at, format: :short
-            %td= p.published_revision ? l(p.published_revision.created_at, format: :long) : ''
-            %td= p.published_revision ? p.published_revision.author_id : ''
-            %td.text-right
-              = link_to edit_page_path(p), class: 'btn btn-default btn-sm' do
+            %td.nowrap= best_in_place p, :position, url: update_path(p)
+            %td.nowrap= best_in_place p, :title, url: update_path(p)
+            %td.nowrap= best_in_place p, :slug, url: update_path(p)
+            %td
+              %ul.list-unstyled
+                %li
+                  %strong Description:
+                  = best_in_place p, :description, url: update_path(p)
+                %li
+                  %strong Languages:
+                  = best_in_place p, :languages_raw, url: update_path(p)
+                %li
+                  %strong Section:
+                  = best_in_place p, :section, url: update_path(p)
+                %li
+                  %strong Last modification:
+                  = l p.created_at, format: :short
+                %li
+                  %strong Published at:
+                  = p.published_revision ? l(p.published_revision.created_at, format: :long) : ''
+                %li
+                  %strong Published by:
+                  = p.published_revision ? p.published_revision.author_id : ''
+            %td.text-right.nowrap
+              = link_to edit_page_path(p), class: 'btn btn-default btn-xs' do
                 %i.fa.fa-edit
                 Edit
-              = link_to preview_page_path(p), class: 'btn btn-default btn-sm' do
+              = link_to preview_page_path(p), class: 'btn btn-default btn-xs' do
                 %i.fa.fa-eye
                 Preview
-              = link_to history_path(p), class: 'btn btn-default btn-sm' do
+              = link_to history_path(p), class: 'btn btn-default btn-xs' do
                 %i.fa.fa-history
                 History
-              = link_to delete_page_path(p), class: 'btn btn-danger btn-sm', data: { confirm: 'Are you sure you want to delete this page?', method: :delete } do
+              = link_to delete_page_path(p), class: 'btn btn-danger btn-xs', data: { confirm: 'Are you sure you want to delete this page?', method: :delete } do
                 %i.fa.fa-trash
                 Delete
-    %h3 Create a new page
-    = form_for DocumentationEditor::Page.new, url: admin_path, html: { class: 'form form-inline' } do |f|
-      = f.text_field :title, placeholder: 'Title', class: 'form-control'
-      = f.text_field :slug, placeholder: 'tutorials/my-tutorial', class: 'form-control'
-      = f.text_field :description, placeholder: 'Description', class: 'form-control'
-      = f.text_field :languages, placeholder: 'ruby, php, python', class: 'form-control'
-      = f.text_field :section, placeholder: 'getting-started', class: 'form-control'
-      = f.submit 'Create', class: 'btn btn-success'
+
+.modal.fade#modal-new-page
+  .modal-dialog
+    .modal-content
+      .modal-header
+        %button.close{type: 'button', 'data-dismiss' => 'modal', 'aria-label' => 'Close'}
+          %span{'aria-hidden' => true} ×
+        %h4.modal-title Create a new page
+      .modal-body
+        = form_for DocumentationEditor::Page.new, url: admin_path, html: { class: 'form' } do |f|
+          %p= f.text_field :title, placeholder: 'Title', class: 'form-control'
+          %p= f.text_field :slug, placeholder: 'Slug (ex: tutorials/my-tutorial)', class: 'form-control'
+          %p= f.text_field :description, placeholder: 'Description', class: 'form-control'
+          %p= f.text_field :languages_raw, placeholder: 'Languages (ex: ruby, php, python)', class: 'form-control'
+          %p= f.text_field :section, placeholder: 'Section name (ex: getting-started)', class: 'form-control'
+          %p.text-center= f.submit 'Create', class: 'btn btn-success'

data/lib/documentation_editor/parser.rb

@@ -6,7 +6,7 @@ require 'htmlentities'
 class Kramdown::Parser::BlockKramdown < Kramdown::Parser::Kramdown
 
   def initialize(source, options)
-    @language = options[:language] || options['language']
+    @language = options[:language]
     super
     @span_parsers.unshift(:block_tags)
   end

data/lib/documentation_editor/version.rb

@@ -1,3 +1,3 @@
 module DocumentationEditor
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentation-editor
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Algolia Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails