documentation 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6a7eb85e7b85787e4d484056de4034f93aea7b8
-  data.tar.gz: 235d5670da70ba8f1b7468dac9584eb2fdfe52cb
+  metadata.gz: 7ee69981e399c23b45190208a36587d22ef937fa
+  data.tar.gz: c681d1aa01d8d237697e5fd742cfb26620f11f74
 SHA512:
-  metadata.gz: cfc40c753fe359e3697e9fedd1cd30245c0e73f5df68e8aa4f0f17f416a7bec369a71d441bf3adfdef9401e37715269ab48c23ec540e1d45909be3ca74b9f918
-  data.tar.gz: e2a26c2538c3bdaccce81624ad5bee3d3566bfd6b3ad7ba5e8ee243880037c272a75c3281076f79e5819e0aeabec881674b551e420ffc9f3b993d323bd70893f
+  metadata.gz: b73915ea29d76182c81f0b8f2aee4986bdbbf0794c08a4571817df2539405cabe4658521c31f963c053f81dac9dbc490eac724446c85f18f995a2f966b44c670
+  data.tar.gz: ac5424d483dff52ec3e1ec9dcb5a05a7e3c99a1e34282009667626972bcb59cda977251506465ac7b26c2e9492db45f3fc8bda33d152329cfc3a7493e10887b1

data/app/assets/javascripts/documentation/application.coffee

@@ -2,6 +2,7 @@
 #= require jquery_ujs
 #= require documentation/jquery-ui
 #= require documentation/jquery.autosize
+#= require nifty/dialog
 
 $ ->
   $('form.pageForm textarea').autosize({append: '\n\n'})
@@ -11,4 +12,67 @@ $ ->
       form = $(this).parents('form')
       url = form.attr('action')
       $.post(url, form.serialize());
-  
+  
+  $('.js-screenshot').on 'click', (e)->
+    e.preventDefault()
+    openUploadDialog()
+
+  $('.edit-article').on 'drop', (e)->
+    e.stopPropagation()
+    e.preventDefault()
+
+    file = e.originalEvent.dataTransfer.files[0]
+
+    openUploadDialog(file)
+
+  openUploadDialog = (file)->
+    editForm = $('.edit-article').find('form')
+    contentArea = editForm.find('#page_content')
+    caretPosition = contentArea.get(0).selectionStart
+    content = contentArea.val()
+
+    uploadFormUrl = editForm.find('.js-screenshot').attr('href')
+    uploadFormUrl = uploadFormUrl + "?filename=#{file.name}" if file?
+
+    Nifty.Dialog.open
+      url:  uploadFormUrl
+      afterLoad: (dialog)->
+        form = dialog.find('form')
+        form.find('#screenshot_alt_text').focus()
+
+        dialog.on 'submit', 'form', (e)->
+          form = $(this)
+          formData = new FormData(form.get(0))
+
+          if file?
+            filename = file.name
+            formData.append('screenshot[upload_file]', file)
+          else
+            filename = form.find('#screenshot_upload_file').val()
+
+          fileExt = filename.split('.').pop().toLowerCase()
+          if $.inArray(fileExt, ['gif','png','jpg','jpeg']) == -1
+            alert("Invalid file extension (allowed: gif, png, jpg, jpeg)")
+            return false
+
+          $.ajax
+            url: form.attr('action')
+            type: form.attr('method')
+            data: formData
+            processData: false
+            contentType: false
+            success: (data)->
+              screenshotLink = "![#{data.title}*centre](#{data.path})"
+              newContent = content.substring(0, caretPosition) + screenshotLink + content.substring(caretPosition)
+              newCaretPosition = (content.substring(0, caretPosition) + screenshotLink).length
+              contentArea.val(newContent)
+
+              contentArea.focus()
+              contentArea.get(0).setSelectionRange(newCaretPosition, newCaretPosition)
+
+              Nifty.Dialog.closeTopDialog()
+              
+            error: (xhr, status, errorThrown)->
+              console.log xhr.responseText
+
+          false

data/app/assets/stylesheets/documentation/application.scss

@@ -1,5 +1,6 @@
 /*
  *= require documentation/reset
+ *= require nifty/dialog
  *= require_self
  *= require documentation/markdown
  *= require documentation/page_form
@@ -193,6 +194,7 @@ a.button, input.button {
 	border-radius:5px;
 	margin-left:5px;
 	appearance:none;
+  vertical-align:middle;
 	&.delete {
 		color:#F6744F;
 		border-color:lighten(#F6744F, 20%);

data/app/assets/stylesheets/documentation/page_form.scss

@@ -30,6 +30,7 @@ form.pageForm {
 		dt { width:120px; float:left; color:#999;padding-top:6px;}
 		dd { margin-left:160px; }
 		dd input { width:100%; font-size:1.1em;}
+		dd.padded { padding-top: 6px; }
 	}
 	
 	p.submit {

data/app/controllers/documentation/application_controller.rb

@@ -9,6 +9,12 @@ module Documentation
       render :template => 'documentation/shared/not_found', :layout => false
     end
     
+    before_filter do
+      unless authorizer.can_use_ui?
+        render :template => 'documentation/shared/not_found', :layout => false
+      end
+    end
+    
     private
     
     def authorizer

data/app/controllers/documentation/pages_controller.rb

@@ -44,6 +44,21 @@ module Documentation
       redirect_to @page.parent ? page_path(@page.parent.full_permalink) : root_path, :notice => "Page has been removed successfully."
     end
 
+    def screenshot
+      authorizer.check! :upload, @page
+      if request.post?
+        @screenshot = Screenshot.new(screenshot_params)
+        if @screenshot.save
+          render :json => { :id => @screenshot.id, :title => @screenshot.alt_text, :path => @screenshot.upload.path }, :status => :created
+        else
+          render :json => { :errors => @screenshot.errors }, :status => :unprocessible_entity
+        end
+      else
+        @screenshot = Screenshot.new
+        render 'screenshot', :layout => false
+      end
+    end
+
     def positioning
       authorizer.check! :reposition_page, @page
       @pages = @page ? @page.children : Page.roots
@@ -70,5 +85,9 @@ module Documentation
       params.require(:page).permit(:title, :permalink, :content, :favourite)
     end
 
+    def screenshot_params
+      params.require(:screenshot).permit(:upload_file, :alt_text)
+    end
+
   end
 end

data/app/models/documentation/screenshot.rb

@@ -0,0 +1,14 @@
+module Documentation
+  class Screenshot < ActiveRecord::Base
+
+    attachment :upload
+
+    before_validation do
+      if self.upload_file && self.alt_text.blank?
+        self.alt_text = self.upload_file.original_filename 
+      end
+      true
+    end
+
+  end
+end

data/app/views/documentation/pages/form.html.haml

@@ -1,6 +1,6 @@
 - @page_title = @page.breadcrumb.reverse.map(&:title).join(" - ")
 
-%section.content
+%section.content.edit-article
   = documentation_breadcrumb_for @page
   = form_for @page, :url => @page.new_record? ? new_page_path(@page.parent ? @page.parent.full_permalink : nil) : edit_page_path(@page.full_permalink), :html => {:class => 'pageForm'} do |f|
     = error_messages_for @page
@@ -9,4 +9,8 @@
     %dl
       %dt= f.label :permalink
       %dd= f.text_field :permalink, :placeholder => t('.permalink_placeholder')
-    %p.submit= f.submit t('.save'), :class => 'button'
+
+    %p.submit
+      - if authorizer.can_upload?(@page)
+        = link_to t('.add_screenshot'), upload_screenshot_path, :class => 'button preview js-screenshot'
+      = f.submit t('.save'), :class => 'button'

data/app/views/documentation/pages/screenshot.html.haml

@@ -0,0 +1,15 @@
+= form_for @screenshot, :url => upload_screenshot_path, :html => {:class => 'pageForm'} do |f|
+  %dl
+    %dt= f.label :upload_file, "Upload File"
+    %dd.padded
+      - if params[:filename]
+        = params[:filename]
+      - else
+        = f.file_field :upload_file
+
+  %dl
+    %dt= f.label :alt_text, "Screenshot Title"
+    %dd= f.text_field :alt_text
+
+  %p.submit
+    = f.submit "Upload Screenshot", :class => 'button'

data/config/locales/en.yml

@@ -47,6 +47,7 @@ en:
         title_placeholder: Enter a title for this page
         content_placeholder: 'Use Markdown to enter page content'
         permalink_placeholder: Automatically generated if left blank
+        add_screenshot: Add Screenshot
         save: Save Page
       
       positioning:

data/config/routes.rb

@@ -4,6 +4,7 @@ Documentation::Engine.routes.draw do
   match 'positioning(/*path)', :to => 'pages#positioning', :as => 'page_positioning', :via => [:get, :post]
   match 'edit(/*path)', :to => 'pages#edit', :as => 'edit_page', :via => [:get, :patch]
   match 'delete(/*path)', :to => 'pages#destroy', :as => 'delete_page', :via => [:delete]
+  match 'screenshot', :to => 'pages#screenshot', :as => 'upload_screenshot', :via => [:get, :post]
   get 'search', :to => 'pages#search', :as => 'search'
   get '*path' => 'pages#show', :as => 'page'
   root :to => 'pages#index'

data/db/migrate/20140724111844_create_nifty_attachments_table.rb

@@ -0,0 +1,16 @@
+class CreateNiftyAttachmentsTable < ActiveRecord::Migration
+  
+  def up
+    create_table :nifty_attachments do |t|
+      t.integer :parent_id
+      t.string  :parent_type, :token, :digest, :role, :file_name, :file_type
+      t.binary :data, :limit => 10.megabytes
+      t.timestamps
+    end
+  end
+  
+  def down
+    drop_table :nifty_attachments
+  end
+  
+end

data/db/migrate/20140724114255_create_documentation_screenshots.rb

@@ -0,0 +1,7 @@
+class CreateDocumentationScreenshots < ActiveRecord::Migration
+  def change
+    create_table :documentation_screenshots do |t|
+      t.string :alt_text
+    end
+  end
+end

data/lib/documentation.rb

@@ -4,6 +4,8 @@ require 'sass-rails'
 require 'jquery-rails'
 require 'dynamic_form'
 require 'ostruct'
+require 'nifty/attachments'
+require 'nifty/dialog'
 
 require 'documentation/version'
 require 'documentation/errors'

data/lib/documentation/authorizer.rb

@@ -25,10 +25,18 @@ module Documentation
       true
     end
     
+    def can_upload?(page)
+      true
+    end
+    
     def can_search?
       true
     end
     
+    def can_use_ui?
+      true
+    end
+    
     def check!(action, object = :none)
       action_method_name = "can_#{action}?"
       if self.respond_to?(action_method_name)

data/lib/documentation/version.rb

@@ -1,3 +1,3 @@
 module Documentation
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentation
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -166,6 +166,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nifty-attachments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: nifty-dialog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -207,10 +235,12 @@ files:
 - app/controllers/documentation/pages_controller.rb
 - app/helpers/documentation/application_helper.rb
 - app/models/documentation/page.rb
+- app/models/documentation/screenshot.rb
 - app/views/documentation/pages/_admin_buttons.html.haml
 - app/views/documentation/pages/form.html.haml
 - app/views/documentation/pages/index.html.haml
 - app/views/documentation/pages/positioning.html.haml
+- app/views/documentation/pages/screenshot.html.haml
 - app/views/documentation/pages/search.html.haml
 - app/views/documentation/pages/show.html.haml
 - app/views/documentation/shared/access_denied.html.haml
@@ -221,6 +251,8 @@ files:
 - config/locales/en.yml
 - config/routes.rb
 - db/migrate/20140711185212_create_documentation_pages.rb
+- db/migrate/20140724111844_create_nifty_attachments_table.rb
+- db/migrate/20140724114255_create_documentation_screenshots.rb
 - db/seeds.rb
 - lib/documentation.rb
 - lib/documentation/authorizer.rb