thesis 0.1.1 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0289d1e4ff233b43abad3501bc115e5b5aeaef5f
+  data.tar.gz: 55c4b1fe9a040d4c28a84cc5a6418766cf8ce131
+SHA512:
+  metadata.gz: 44bb0d0bb1729d409dbf66f40ca3223f667ebc340bccce20a78f2dd360c99011bb468cf07d5694dd73d00a55bf0f207e79db21505ffb2fd0ddb6431576076eaa
+  data.tar.gz: 7c76a9717a04dd81de8cf1d71ac5450027476e4daecdbe569912896c09bde52afd63cc8812d74a4158df8a755750f9f0a5384b5393c926e0cdf70e53efc4e21e

data/README.md

@@ -2,20 +2,18 @@
 
 ### Thesis is a Rails CMS gem that integrates as seamlessly as possible into your current Rails website.
 
-Most Rails content management systems make you conform to their system from the start, 
+Most Rails content management systems make you conform to their system from the start,
 making it difficult to just "drop in" the gem and make it work with your CMS. Thesis
 tries to be a drop-in CMS that doesn't hijack your development workflow and stays out
 of the way.
 
 ### Requirements
 
-* Rails 3.2.x (or higher)
+* Rails 4.0.x (or higher)
 * ActiveRecord on MySQL, PostgresQL, or SQLite3
-* Ruby 1.9.3 (or higher)
+* Ruby 2.0.0 (or higher)
 * jQuery
-* jQuery UI
-
-Thesis *might* work with other versions but no guarantees.
+* File hosting or Amazon S3 (for image upload)
 
 ## Getting Started
 
@@ -23,19 +21,41 @@ Thesis *might* work with other versions but no guarantees.
 
 In your Gemfile:
 
-    gem 'thesis'
-    
+    gem 'thesis', '~> 0.1'
+
 Then run these from your command line:
 
     bundle install
     rails g thesis:install
     rake db:migrate
-    
+
 This will install thesis and add the database tables.
 
+[API Reference](#API)
+
+## Using the CMS
+
+### Adding a Page
+
+TODO
+
+### Editing a Page
+
+TODO
+
+### Deleting a Page
+
+TODO
+
+### Rearranging Pages
+
+TODO
+
+## API
+
 ### Authentication
 
-**Thesis does not force you to use a particular authentication strategy.**
+**Thesis does not force you to use a particular user or authentication strategy.**
 
 Instead, it adds a method into your application_controller.rb file that
 allows you to hook up your own authentication logic.
@@ -43,109 +63,124 @@ allows you to hook up your own authentication logic.
 * If you return `false` from this method, nothing will show up client-side nor will the page be editable.
 * If you return `true` from this method, the Thesis editor will appear and the page will be editable.
 
+#### Thesis authentication examples
+
 ```ruby
-# Thesis authentication
 def page_is_editable?(page)
-  # Add your own criteria here for editing privileges. Examples:
-  # current_user.admin? # Basic admin
-  # can? :update, page # CanCan
-  true # EVERYONE has access right now.
+  logged_in? && current_user.admin? # Devise + admin boolean
+end
+
+def page_is_editable?(page)
+  can? :update, page # CanCanCan
+end
+
+def page_is_editable?(page)
+  true # Just let everyone edit everything
+end
+
+def page_is_editable?(page)
+  if current_user.admin?
+    true
+  elsif page.parent == Thesis::Page.find_by(name: "Blog")
+    true
+  else
+    false
+  end
 end
 ```
 
+### Models
+
+Thesis creates two straightforward ActiveRecord tables: pages and page_contents. Since they're normal ActiveRecord models, you're free to use them in your code however you want.
+
+#### Thesis::Page
+
+      t.integer :parent_id
+      t.string  :name
+      t.string  :slug
+      t.string  :title
+      t.string  :description
+      t.integer :sort_order, default: 0, null: false
+      t.string  :template, default: "default", null: false
+      t.timestamps
+
+#### Thesis::PageContent
+
+      t.integer :page_id,           null: false
+      t.string  :name,              null: false
+      t.text    :content,           default: "Edit This Content Area"
+      t.string  :content_type,      default: :html
+      t.timestamps
+
 ### Page Templates
 
 Thesis's installer will drop a `page_templates` folder into your `app/views` folder.
 This is where you put different styles of pages for use in the CMS.
 Thesis will install an ERB, [HAML](http://haml.info), or [Slim](http://slim-lang.com) version, depending on your configuration.
 
-#### Meta information
+### Meta information
 
-Pages come with a few built-in fields for use in meta tags.
+Pages come with a few built-in fields for use in SEO meta tags.
 
-```haml
-%title= current_page.title
-%meta{ content: current_page.description, type: "description" }
+```slim
+head
+  title = current_page.title || "Default Title"
+  meta content="#{current_page.description}" type="description"
 ```
 
-#### Thesis Editor
+### Thesis Editor
 
 Place this right after your opening `body` tag to embed the Thesis editor. It will only show
 up if your `page_is_editable?` method returns `true`.
 
-```haml
-%body
+```slim
+body
   = thesis_editor
 ```
 
-#### Page title
-
-```haml
-%h1= current_page.title
-```
-
-#### Primary Navigation
+### Primary Navigation
 
 Use `root_pages` to get a list of pages at the root level. You can use the
 page's `name` and `path` accessors in your links.
 
-```haml
-%nav
-  %ul
-    %li= link_to "Home", root_path # You can mix and match dynamic and static pages
+```slim
+nav
+  ul
+    li = link_to "Home", root_path # You can mix and match dynamic and static pages
     - root_pages.each do |p|
-      %li= link_to p.name, p.path
-    %li= link_to "Static Page", static_page_path
+      li = link_to p.name, p.path
+    li = link_to "Static Page", static_page_path
 ```
 
-#### Page content
+### Page content
 
 Content areas are accessible from any page using the `content` method. This method
 takes two arguments: name and type. Type defaults to `:html`. The only other type
 is `:text` (for now) which is plain text, no HTML accepted. `:image` will be added soon.
 
-Both content types will wrap their content in a `<div>` or `<span>`.
-
-Referencing a content area in a page template will create one if it doesn't exist already.
+Referencing a content area in a page template will create one if it doesn't exist already, using the `default:` value.
 
-```haml
-%article
+```slim
+article
   = current_page.content("Main Content", :html, default: "<p>This is my default HTML content.<p>")
-%aside
-  = current_page.content("Sidebar Content", :html)  
-%footer
-  %p= current_page.content("Footer Content", :text, default: "Copyright Me")
+  = current_page.content("Splash Image", :image, default: "/assets/default-image.jpg") # coming soon
+aside
+  = current_page.content("Sidebar Content", :html)
+footer
+  p = current_page.content("Footer Content", :text, default: "Copyright Me")
 ```
 
 ### Routing
-        
+
 Thesis will automatically handle routes for pages you create with Thesis. Your
 routes will take precedence over Thesis-created pages, so if you create a page
-with Thesis called "About" and you already have a route for 
+with Thesis called "About" and you already have a route for
 `get "about" => "something#else"` Thesis won't show the page.
-    
-## Using the CMS
-
-### Adding a Page
-
-TODO
-
-### Editing a Page
-
-TODO
-
-### Deleting a Page
-
-TODO
-
-### Rearranging Pages
-
-TODO
 
 ## What Thesis Isn't
 
-You can't have it all. Thesis isn't the same as other -bloated- full-functioned 
-content management systems out there. This is a list of what it's not now and 
+You can't have it all. Thesis isn't the same as other -bloated- full-functioned
+content management systems out there. This is a list of what it's not now and
 not likely to be in the future.
 
 *We reserve the right to change our mind, however, especially with well planned and written

data/app/assets/javascripts/thesis.js

@@ -1,3 +1,4 @@
+//= require ./thesis/utilities
 //= require ./thesis/rangy-core
 //= require ./thesis/hallo
 //= require ./thesis/thesis

data/app/assets/javascripts/thesis/thesis.coffee

@@ -0,0 +1,250 @@
+Thesis =
+  setup: ->
+    @edit_mode = false
+    if this.requirements() && this.page_is_editable()
+      this.draw_editor()
+      this.set_up_bindings()
+
+  requirements: ->
+    if jQuery.ui
+      true
+    else
+      alert "jQuery UI not included. Thesis will not work properly without it."
+      false
+
+  edit_mode: ->
+    @edit_mode
+
+  thesis: ->
+    @thesis = $("#thesis-editor")
+
+  # ATTRIBUTES
+  page_is_editable: ->
+    this.thesis().length > 0
+
+  page_in_edit_mode: ->
+    $("body").hasClass("thesis-editing")
+
+  page_has_unsaved_content: ->
+    $("body .thesis-content.isModified").length
+
+  modal: (blur=false, type="settings")->
+    this.close_modal()
+    $("body").addClass "thesis-blur" if blur
+    $("body").append this["#{type}_modal_markup"]()
+    $("#thesis-modal").fadeIn 300
+
+    $("#thesis-modal").on "click", ".modal-field.cancel", (e)->
+      e.preventDefault()
+      Thesis.close_modal()
+
+    $("#thesis-modal").on "submit", "form", (e) ->
+      alert "To Do: submit form"
+      e.preventDefault() #temp
+      return false       #temp
+
+  close_modal: ->
+    if $("#thesis-modal").length
+      $("body").removeClass "thesis-blur"
+      $("#thesis-modal").remove()
+
+  settings_modal_markup: ->
+    is_win = navigator.appVersion.indexOf("Win")!=-1
+    """
+      <div id="thesis-modal" class="settings #{if is_win then 'windows' else ''}">
+        <div class="modal-icon"><i class="fa fa-wrench fa-2x"></i></div>
+        <div class="modal-title">Page Settings</div>
+        <form action="" method="">
+          <label class="modal-field"><span>Page Name</span><input class="page-settings_page-title" name="page-settings_page-title" type="text" /></label>
+          <label class="modal-field"><span>Page Slug</span><input class="page-settings_page-slug" name="page-settings_page-slug" type="text" /></label>
+          <label class="modal-field"><span>Meta Title</span><input class="page-settings_meta-title" name="page-settings_meta-title" type="text" /></label>
+          <label class="modal-field"><span>Meta Description</span><textarea class="page-settings_meta-description" name="page-settings_meta-description"></textarea></label>
+          <label class="modal-field cancel"><button class="page-settings_submit" name="page-settings_submit"><i class="fa fa-remove fa-2x"></i> <span>Cancel</span></button></label>
+          <label class="modal-field submit"><button class="page-settings_submit" name="page-settings_submit" type="Submit" value=""><i class="fa fa-save fa-2x"></i> <span>Save</span></button></label>
+        </form>
+      </div>
+    """
+
+  # ACTIONS
+  set_up_bindings: ->
+    t = this
+
+    t.thesis.on "mouseenter", ->
+      clearTimeout @hide_editor_delay
+      $(this).addClass "active"
+    .on "mouseleave", ->
+      @hide_editor_delay = Utilities.delay 2000, ()=>
+        $(this).removeClass "active"
+
+    @edit_page_button.on "mouseenter", ->
+      t.change_edit_tooltip_status()
+
+    @edit_page_button.on "click", (e) ->
+      e.preventDefault()
+      t.edit_button_click_actions()
+
+  edit_button_click_actions: ->
+    if this.page_in_edit_mode()
+      if this.page_has_unsaved_content()
+        this.change_edit_tooltip_status("Save Page before Exiting", "error")
+      else
+        this.end_editing()
+    else
+      this.start_editing()
+
+  change_edit_tooltip_status: (edit_text=null, classes=null) ->
+    $tooltip = @edit_page_button.find(".tooltip")
+    $tooltip.removeClass().addClass("tooltip")
+    $tooltip.addClass "#{classes}" if classes
+    unless edit_text
+      if this.page_in_edit_mode()
+        if this.page_has_unsaved_content()
+          edit_text = "Editing Page"
+        else
+          edit_text = "Exit Edit Mode"
+      else
+        edit_text = "Edit Page"
+    $tooltip.text edit_text
+
+  start_editing: ->
+    $("body").append($("<div></div>").addClass("thesis-fader"))
+    $("body").addClass("thesis-editing")
+    $(".thesis-content-html").hallo this.hallo_html_options()
+    $(".thesis-content-text").hallo this.hallo_text_options()
+    this.change_edit_tooltip_status()
+
+  end_editing: ->
+    $(".thesis-fader").remove()
+    $("body").removeClass("thesis-editing")
+    $(".thesis-content-html").hallo editable: false
+    $(".thesis-content-text").hallo editable: false
+    this.change_edit_tooltip_status()
+
+  save_content: ->
+    # Gather the content for posting
+    payload = {}
+    $(".thesis-content-html, .thesis-content-text").each ()->
+      content_area = $(this)
+      content_id = content_area.data("thesis-content-id")
+      payload[content_id] = content_area.html()
+
+    $.ajax
+      url: "/thesis/update_page_content"
+      data: payload
+      type: "put"
+      dataType: "json"
+      success: ->
+        alert "Page saved."
+      error: ->
+        alert "Sorry, couldn't save this page."
+
+  add_page: ->
+    page_name = prompt "What is the name of the new page?"
+    if page_name
+      parent_slug = null
+      if confirm("Make this a subpage of the current page?")
+        parent_slug = window.location.pathname
+      $.ajax
+        url: "/thesis/create_page"
+        data:
+          name: page_name
+          parent_slug: parent_slug
+        type: "post"
+        dataType: "json"
+        success: (resp, status, xhr)->
+          if resp && resp.page
+            window.location = resp.page.slug
+          else
+            alert "Unknown error"
+        error: ->
+          alert "Sorry, couldn't save this page."
+
+  delete_page: ->
+    really_sure = confirm "Are you sure you want to delete this page? There is no undo!"
+    if really_sure
+      $.ajax
+        url: "/thesis/delete_page"
+        data:
+          slug: window.location.pathname
+        type: "delete"
+        # dataType: "json"
+        success: ->
+          alert "Page was deleted."
+        error: ->
+          alert "Sorry, couldn't delete this page."
+
+
+  # OPTIONS
+  hallo_text_options: ->
+    options =
+      editable: true
+
+  hallo_html_options: ->
+    options =
+      editable: true
+      plugins:
+        'halloformat': {}
+        'halloheadings': {}
+        'hallojustify': {}
+        'hallolists': {}
+        'halloreundo': {}
+        'hallolink': {}
+        # 'halloimage': {} # Someday?
+
+
+  # EDITOR
+  draw_editor: ->
+    @thesis.append(this.draw_add_icon())
+    @thesis.append(this.draw_delete_icon())
+    @thesis.append(this.draw_settings_icon())
+    @thesis.append(this.draw_cancel_icon())
+    @thesis.append(this.draw_save_icon())
+    @thesis.append(this.draw_edit_icon())
+    @edit_page_button = @thesis.find(".thesis-button.edit")
+
+  draw_edit_icon: ->
+    $icon = $("<i></i>").addClass "fa fa-edit fa-2x"
+    $tooltip = $("<div></div>").addClass("tooltip").text "Edit Page"
+    $("<div></div>").addClass("thesis-button edit").append $tooltip, $icon
+
+  draw_save_icon: ->
+    $icon = $("<i></i>").addClass "fa fa-save fa-2x"
+    $tooltip = $("<div></div>").addClass("tooltip").text "Save Changes"
+    $button = $("<div></div>").addClass("thesis-button save").append $tooltip, $icon
+    $button.on "click", ->
+      Thesis.save_content()
+      Thesis.end_editing()
+
+  draw_add_icon: ->
+    $icon = $("<i></i>").addClass "fa fa-plus fa-2x"
+    $tooltip = $("<div></div>").addClass("tooltip").text "Add New Page"
+    $button = $("<div></div>").addClass("thesis-button add").append $tooltip, $icon
+    $button.on "click", ->
+      Thesis.add_page()
+
+  draw_settings_icon: ->
+    $icon = $("<i></i>").addClass "fa fa-wrench fa-2x"
+    $tooltip = $("<div></div>").addClass("tooltip").text "Page Settings"
+    $button = $("<div></div>").addClass("thesis-button settings").append $tooltip, $icon
+    $button.on "click", ->
+      Thesis.modal(true, "settings")
+
+  draw_delete_icon: ->
+    $icon = $("<i></i>").addClass "fa fa-trash fa-2x"
+    $tooltip = $("<div></div>").addClass("tooltip").text "Delete Page"
+    $button = $("<div></div>").addClass("thesis-button delete").append $tooltip, $icon
+    $button.on "click", ->
+      Thesis.delete_page()
+
+  draw_cancel_icon: ->
+    $icon = $("<i></i>").addClass "fa fa-remove fa-2x"
+    $tooltip = $("<div></div>").addClass("tooltip").text "Discard Changes"
+    $button = $("<div></div>").addClass("thesis-button cancel").append $tooltip, $icon
+    $button.on "click", ->
+      Thesis.end_editing()
+      location.reload()
+
+jQuery ($)->
+  Thesis.setup()
+
+# window.Thesis = Thesis # Enable if necessary