documentation-editor 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e6bd0a7e0fd131c4cc89835f651bd4fd6394a72
-  data.tar.gz: af014098a71b07a5782d2d8cbc6861b0fac2a250
+  metadata.gz: dbb5969b82e47ef0d7a854fb6f5b1885525c89ac
+  data.tar.gz: b3d341801cbce4302874858a865e2a0d8271b0cc
 SHA512:
-  metadata.gz: cd2f4e684959b41a21be1794a0ddf60669e60dd7bc6e3ce7aa86719eccb605ddaffabeed0c5080d528ad9d9a89c4cc26c81dad28d92ff27485f3347d3ba20a70
-  data.tar.gz: 7dbff47da968167994ec8eee56b2b3701b441e2d11269d66cbe3eaaedd38668247707ab86a9b25c9a39e4bd068eca904921adf5ab951f13a059bdbbc4f6e0aa9
+  metadata.gz: 535949a0f92af8f2ea32836807a93e9e47d231dc6fdb067e8462fbe094209aab0515830f3ffb3b0973ddefcbd0c6ec261b1dddb39c25a5d6fd8b1c829d8d7fbf
+  data.tar.gz: 46ea675dbf81e60efba33e724f7bc3dcc31621699bc27d8702168f7762bc52b8092c03fe893231b65c80fbcd620e07e19eda7067491c9926e6c3fef261a129c6

data/app/assets/javascripts/documentation_editor/pages.js

@@ -1,3 +1,9 @@
+//= require best_in_place
+
+$(document).ready(function() {
+  $(".best_in_place").best_in_place();
+});
+
 angular.module('documentationEditorApp', ['ngFileUpload'])
   .config(['$locationProvider', function($locationProvider) {
     $locationProvider.html5Mode({ enabled: true, requireBase: false, rewriteLinks: false });

data/app/controllers/documentation_editor/pages_controller.rb

@@ -19,7 +19,7 @@ module DocumentationEditor
       before_filter DocumentationEditor::Config.before_filter, only: [:preview, :show]
     end
 
-    before_filter :setup_page, only: [:edit, :source, :update, :preview, :destroy, :history, :versions]
+    before_filter :setup_page, only: [:edit, :source, :update, :commit, :preview, :destroy, :history, :versions]
 
     def index
     end
@@ -32,6 +32,13 @@ module DocumentationEditor
     end
 
     def update
+      @page.title = params[:page][:title]
+      @page.slug = params[:page][:slug]
+      @page.save!
+      render nothing: true
+    end
+
+    def commit
       @page.add_revision!(params[:data], params[:preview].to_s == 'false', respond_to?(:current_user) ? current_user.id : nil)
       render nothing: true
     end
@@ -39,6 +46,7 @@ module DocumentationEditor
     def create
       p = Page.new
       p.author_id = respond_to?(:current_user) ? current_user.id : nil
+      p.title = params[:page][:title]
       p.slug = params[:page][:slug]
       p.save!
       redirect_to edit_page_path(p)

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

@@ -7,6 +7,7 @@
     %table.table.table-striped
       %thead
         %tr
+          %th Title
           %th Slug
           %th Last modification
           %th Published at
@@ -15,7 +16,8 @@
       %tbody
         - DocumentationEditor::Page.order('id DESC').each do |p|
           %tr
-            %td= link_to "#{request.path.split('/admin').first}/#{p.slug}", edit_page_path(p)
+            %td= best_in_place p, :title, url: update_path(p)
+            %td= best_in_place p, :slug, 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 : ''
@@ -34,6 +36,6 @@
                 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.submit 'Create', class: 'btn btn-success'
-      %p.text-muted Will be appended to #{page_path('')}

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

@@ -3,6 +3,8 @@
   - cache("page-#{id}-toc") do
     = render partial: 'menu_items', object: @revision.to_toc(@options)
 
+- content_for :page_title, @page.title
+
 .markdown-page
   - if DocumentationEditor::Config.is_admin && send(DocumentationEditor::Config.is_admin)
     .text-right

data/config/routes.rb

@@ -7,7 +7,8 @@ DocumentationEditor::Engine.routes.draw do
 
     get '/:id', :controller => 'pages', :action => 'source'
     get '/:id/edit', as: :edit_page, :controller => 'pages', :action => 'edit'
-    post '/:id', :controller => 'pages', :action => 'update'
+    put '/:id', as: :update, :controller => 'pages', :action => 'update'
+    post '/:id', :controller => 'pages', :action => 'commit'
     delete '/:id', as: :delete_page, :controller => 'pages', :action => 'destroy'
     get '/:id/preview', as: :preview_page, :controller => 'pages', :action => 'preview'
     get '/:prev/:cur/diff', :controller => 'pages', :action => 'diff'

data/db/migrate/20150818102838_add_title_to_pages.rb

@@ -0,0 +1,5 @@
+class AddTitleToPages < ActiveRecord::Migration
+  def change
+    add_column :documentation_editor_pages, :title, :string, limit: 255
+  end
+end

data/lib/documentation_editor.rb

@@ -10,6 +10,8 @@ require 'sass-rails'
 require 'paperclip'
 ## diff
 require 'diffy'
+## best in place
+require 'best_in_place'
 
 module DocumentationEditor
 end

data/lib/documentation_editor/version.rb

@@ -1,3 +1,3 @@
 module DocumentationEditor
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentation-editor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Algolia Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: best_in_place
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The goal of this project is to provide an easy & frictionless way to
   edit an online tech documentation. The sweet spot of this editor is to be able to
   generate pages containing multiple snippets of highlighted code & conditional sections
@@ -143,6 +157,7 @@ files:
 - db/migrate/20150722230424_create_documentation_editor_pages.rb
 - db/migrate/20150725063642_create_documentation_editor_images.rb
 - db/migrate/20150728040718_create_documentation_editor_revisions.rb
+- db/migrate/20150818102838_add_title_to_pages.rb
 - lib/documentation-editor.rb
 - lib/documentation_editor.rb
 - lib/documentation_editor/configuration.rb
@@ -170,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Mountable Rails application providing an extended Markdown documentation