thesis 0.0.1 → 0.0.4

data/lib/assets/javascripts/thesis/thesis.js.coffee

@@ -0,0 +1,27 @@
+Thesis =
+  setup: ->
+    if this.requirements()
+      this.bindings()
+    
+  
+  requirements: ->
+    if jQuery.ui
+      true
+    else
+      alert "jQuery UI not included. Thesis will not work properly without it."
+      false
+  
+  page_is_editable: ->
+    $("#thesis-editor").length > 0
+
+  bindings: ->
+    thesis = $("#thesis-editor")
+    if thesis
+      thesis.append $("<div></div>").addClass("thesis-container")
+        .append $("<h3></h3>").text("Thesis Editor")
+    
+
+jQuery ($)->
+  Thesis.setup()
+
+# window.Thesis = Thesis # Enable if necessary

data/lib/assets/javascripts/thesis.js

@@ -0,0 +1,2 @@
+//= require ./thesis/hallo
+//= require ./thesis/thesis

data/lib/assets/stylesheets/thesis/thesis.css.scss

@@ -0,0 +1,16 @@
+#thesis-editor {
+  display: block;
+  width:100%;
+  clear:both;
+  height:100px;
+  background-color:#343434;
+  color:#ECECEC;
+  border:solid 2px #444444;
+  
+  & .thesis-container {
+    max-width: 960px;
+    margin: 0 auto;
+  }
+}
+
+

data/lib/assets/stylesheets/thesis.css

@@ -0,0 +1,4 @@
+/*
+ *= require_self
+ *= require_tree .
+*/

data/lib/generators/thesis/install/install_generator.rb

@@ -0,0 +1,108 @@
+require 'rails/generators/migration'
+
+module Thesis
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      
+      source_root File.expand_path('../templates', __FILE__)
+      
+      desc "install or upgrade Thesis"
+      
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "migrations/create_page.rb", "db/migrate/create_page.rb"
+        migration_template "migrations/create_page_content.rb", "db/migrate/create_page_content.rb"
+      end
+
+      def create_folders
+        copy_file "page_templates/default.html.slim", "app/views/page_templates/default.html.slim" if Slim
+        copy_file "page_templates/default.html.haml", "app/views/page_templates/default.html.haml" if Haml
+        copy_file "page_templates/default.html.erb", "app/views/page_templates/default.html.erb" unless Haml || Slim
+      end
+
+      def set_up_routes
+        route "thesis_routes # This needs to be the last route!"
+      end
+
+      def install_js
+        filename = "app/assets/javascripts/application.js"
+        existing = File.binread("#{filename}").include?("require thesis")
+        
+        if existing && generating?
+          say_status("skipped", "insert into #{filename}", :yellow)
+        else
+          insert_into_file "#{filename}", after: %r{//= require +['"]?jquery_ujs['"]?} do
+            "\n//= require jquery-ui" +
+            "\n//= require thesis"
+          end
+        end
+      end
+
+      def install_css
+        filename = "app/assets/stylesheets/application.css.scss"
+        existing = File.binread("#{filename}").include?("require thesis")
+        
+        if existing && generating?
+          say_status("skipped", "insert into #{filename}", :yellow)
+        else
+          insert_into_file "#{filename}", after: %r{ *= require_self} do
+            "\n *= require thesis"
+          end
+        end
+      end
+
+      def install_page_is_editable
+        filename = "app/controllers/application_controller.rb"
+        existing = File.binread("#{filename}").include?("def page_is_editable?")
+        
+        if existing && generating?
+          say_status("skipped", "insert into #{filename}", :yellow)
+        else
+          insert_into_file "#{filename}", after: %r{  protect_from_forgery} do
+            "\n" +
+            "\n  # Thesis authentication" +
+            "\n  def page_is_editable?(page)" +
+            "\n    # Add your own criteria here for editing privileges. Examples:" +
+            "\n    # current_user.admin? # Basic admin" +
+            "\n    # can? :update, page # CanCan" +
+            "\n    true # EVERYONE has access right now." +
+            "\n  end"
+          end
+        end
+      end
+
+      def complete_message
+        require "thesis/colorizer"
+
+        if generating?
+          puts "  "
+          puts "  Thesis installed.".green
+          puts "  Now run `rake db:migrate` to set up your database.".pink
+        else
+          puts "  "
+          puts "  Thesis uninstalled.".red
+          puts "  You will need to remove the database tables manually if you've already run `rake db:migrate`.".pink
+        end
+      end
+
+    protected
+
+      def generating?
+        :invoke == behavior
+      end
+
+      def destroying?
+        :revoke == behavior
+      end  
+    end
+  end
+end

data/lib/generators/thesis/install/templates/migrations/create_page.rb

@@ -0,0 +1,18 @@
+class CreatePage < ActiveRecord::Migration
+  def self.up
+    create_table :pages do |t|
+      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
+    end
+  end
+
+  def self.down
+    drop_table :pages
+  end
+end

data/lib/generators/thesis/install/templates/migrations/create_page_content.rb

@@ -0,0 +1,15 @@
+class CreatePageContent < ActiveRecord::Migration
+  def self.up
+    create_table :page_contents do |t|
+      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
+    end
+  end
+
+  def self.down
+    drop_table :page_contents
+  end
+end

data/lib/generators/thesis/install/templates/page_templates/default.html.erb

@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= current_page.title %></title>
+    <meta type="description" content="<%= current_page.content("Description", :text) %>" />
+    
+    <%= stylesheet_link_tag    "application", :media => "all" %>
+    <%= javascript_include_tag "application" %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <%= thesis_editor %>
+    <header>
+      <h1><%= current_page.title %></h1>
+    </header>
+    
+    <nav>
+      <ul>
+        <% root_pages.each do |p| %>
+          <li><%= link_to p.name, p.path %></li>
+        <% end %>
+      </ul>
+    </nav>
+
+    <article>
+      <div class="main-image"><%= current_page.content("Main Image", :image) %></div>
+      <div class="content"><%= current_page.content("Main Content", :html) %></div>
+    </article>
+
+    <aside>
+      <%= current_page.content("Sidebar Content", :html) %>
+    </aside>
+
+    <footer>
+      <p><%= current_page.content("Footer Content", :text) %></p>
+    </footer>
+  </body>
+</html>

data/lib/generators/thesis/install/templates/page_templates/default.html.haml

@@ -0,0 +1,29 @@
+!!!
+%html
+  %head
+    %title= current_page.title
+    %meta{ content: current_page.content("Description", :text), type: "description" }
+
+    = stylesheet_link_tag    "application", :media => "all"
+    = javascript_include_tag "application"
+    = csrf_meta_tags
+  %body
+    = thesis_editor
+
+    %header
+      %h1= current_page.title
+
+    %nav
+      %ul
+        - root_pages.each do |p|
+          %li= link_to p.name, p.path
+
+    %article
+      .main-image= current_page.content("Main Image", :image)
+      .content= current_page.content("Main Content", :html)
+
+    %aside
+      = current_page.content("Sidebar Content", :html)
+      
+    %footer
+      %p= current_page.content("Footer Content", :text)

data/lib/generators/thesis/install/templates/page_templates/default.html.slim

@@ -0,0 +1,29 @@
+doctype html
+html
+  head
+    title= current_page.title
+    meta content=current_page.content("Description", :text) type="description"
+
+    = stylesheet_link_tag    "application", :media => "all"
+    = javascript_include_tag "application"
+    = csrf_meta_tags
+  body
+    = thesis_editor
+
+    header
+      h1= current_page.title
+
+    nav
+      ul
+        - root_pages.each do |p|
+          li= link_to p.name, p.path
+
+    article
+      .main-image= current_page.content("Main Image", :image)
+      .content= current_page.content("Main Content", :html)
+
+    aside
+      = current_page.content("Sidebar Content", :html)
+      
+    footer
+      p= current_page.content("Footer Content", :text)

data/lib/tasks/thesis_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :thesis do
+#   # Task goes here
+# end

data/lib/thesis/colorizer.rb

@@ -0,0 +1,51 @@
+class String
+  # colorization
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize 31
+  end
+
+  def green
+    colorize 32
+  end
+
+  def yellow
+    colorize 33
+  end
+
+  def pink
+    colorize 35
+  end
+
+  def gray
+    colorize 37
+  end
+
+  def brown
+    colorize 33
+  end
+
+  def blue
+    colorize 34
+  end
+
+  def magenta
+    colorize 35
+  end
+
+  def cyan
+    colorize 36
+  end
+
+  def bold
+    colorize 1
+  end
+
+  def blink
+    colorize 5
+  end
+
+end

data/lib/thesis/controllers/controller_helpers.rb

@@ -0,0 +1,39 @@
+module Thesis
+  module ControllerHelpers
+    module ClassMethods
+      def class_method_here
+        # Sample
+      end
+    end
+    
+    def self.included(base)
+      raise ActiveRecordRequired.new("Currently, Thesis only works with ActiveRecord.") unless defined? ActiveRecord
+
+      # base.extend ClassMethods
+      # base.helper_method :class_method_here
+    end
+
+    def current_page
+      @current_page ||= Page.where(slug: request.fullpath).first
+    end
+
+    def root_pages
+      @root_pages ||= Page.where(parent_id: nil).order("sort_order ASC").all
+    end
+
+    def page_is_editable?(page)
+      raise RequiredMethodNotImplemented.new("Add a `page_is_editable?(page)` method to your controller that returns true or false.")
+    end
+
+    def thesis_editor
+      "<div id='thesis-editor'></div>".html_safe if page_is_editable?(current_page)
+    end
+  end
+end
+
+if defined? ActionController::Base
+  ActionController::Base.class_eval do
+    include Thesis::ControllerHelpers
+    helper_method :current_page, :root_pages, :page_is_editable?, :thesis_editor
+  end
+end

data/lib/thesis/controllers/thesis_controller.rb

@@ -0,0 +1,53 @@
+module Thesis
+  class ThesisController < ActionController::Base
+    include ControllerHelpers
+    
+    def show
+      raise ActionController::RoutingError.new('Not Found') unless current_page
+
+      if current_page.template && template_exists?("page_templates/#{current_page.template}")
+        render "page_templates/#{current_page.template}"
+      else
+        raise PageRequiresTemplate.new("Page requires a template but none was specified.")
+      end
+    end
+    
+    def new_page      
+      page = Page.new
+      return head :forbidden unless page_is_editable?(page)
+
+      update_page_attributes page
+
+      head page.save ? :ok : :not_acceptable
+    end
+    
+    def update_page
+      page = current_page
+      return head :forbidden unless page_is_editable?(page)
+
+      update_page_attributes page
+      
+      head page.save ? :ok : :not_acceptable
+    end
+
+    def page_attributes
+      [ :name, :title, :description, :parent_id ]
+    end
+    
+    def update_page_attributes(page)
+      page_attributes.each { |a| page.send("#{a}=", params[a]) if params[a] }
+      page
+    end
+    
+  protected
+    
+    def page_is_editable?(page)
+      appcon = ApplicationController.new
+      if appcon.respond_to?("page_is_editable?")
+        appcon.page_is_editable?(page)
+      else
+        raise RequiredMethodNotImplemented.new("Add a `page_is_editable?(page)` method to your controller that returns true or false.")
+      end
+    end
+  end
+end

data/lib/thesis/engine.rb

@@ -0,0 +1,5 @@
+module Thesis
+  class Engine < ::Rails::Engine
+    isolate_namespace Thesis
+  end
+end

data/lib/thesis/exceptions.rb

@@ -0,0 +1,17 @@
+module Thesis
+  # A generic Thesis exception
+  class Error < StandardError; end
+
+  # When a required method is not implemented 
+  class RequiredMethodNotImplemented < StandardError; end
+
+  # ActiveRecord is the only ORM that works with this currently
+  class ActiveRecordRequired < StandardError; end
+
+  # 404s
+  # class PageNotFound < ActionController::RoutingError; end
+
+  # No template specified
+  class PageRequiresTemplate < StandardError; end
+
+end

data/lib/thesis/models/page.rb

@@ -0,0 +1,43 @@
+module Thesis
+  class Page < ActiveRecord::Base
+    self.table_name = "pages"
+    
+    belongs_to :parent, class_name: "Page"
+    has_many :subpages, class_name: "Page", foreign_key: "parent_id", order: "sort_order ASC"
+    has_many :page_contents
+
+    before_validation :update_slug
+    after_save :update_subpage_slugs
+    
+    validates :slug, uniqueness: { message: "There's already a page like that. Change your page name." }, presence: true
+    
+    def update_slug
+      self.slug = "/" << self.name.parameterize
+      self.slug = "#{parent.slug.to_s}#{self.slug.to_s}" if parent
+    end
+    
+    def update_subpage_slugs
+      subpages.each(&:save) if slug_changed?
+    end
+    
+    def content(name, content_type = :html)
+      pc = find_or_create_page_content(name, content_type)
+      pc.render
+    end
+    
+    def path
+      self.slug
+    end
+    
+  protected
+    
+    def find_or_create_page_content(name, content_type)
+      page_content = self.page_contents.where(name: name).first_or_create do |pc|
+        pc.content = "Edit This Area"
+      end
+      page_content.content_type = content_type
+      page_content.save if page_content.changed?
+      page_content
+    end
+  end
+end

data/lib/thesis/models/page_content.rb

@@ -0,0 +1,41 @@
+module Thesis
+  class PageContent < ActiveRecord::Base
+    self.table_name = "page_contents"
+
+    belongs_to :page
+    
+    def render
+      case self.content_type.to_sym
+      when :html
+        render_html
+      when :text
+        render_text
+      else
+        render_html
+      end
+    end
+    
+    protected
+    
+    def render_html
+      h = "<div class='thesis-content thesis-content-html' data-thesis-content-id='#{self.id}'>" +
+      "#{self.content}" + 
+      "</div>"
+      h.html_safe
+    end
+    
+    def render_text
+      h = "<span class='thesis-content thesis-content-text' data-thesis-content-id='#{self.id}'>" +
+      "#{self.content}" +
+      "</span>"
+      h.html_safe
+    end
+    
+    def render_image
+      h = "<div class='thesis-content thesis-content-image'>" +
+      "<img src='#{self.content}' />" +
+      "</div>"
+      h.html_safe
+    end
+  end
+end

data/lib/thesis/railtie.rb

@@ -0,0 +1,12 @@
+require 'thesis'
+require 'rails'
+
+module Thesis
+  class Railtie < Rails::Railtie
+    railtie_name :thesis
+
+    rake_tasks do
+      # load File.join(File.dirname(__FILE__), "tasks/db.rake") # Load rake tasks here
+    end
+  end
+end

data/lib/thesis/routing/route_constraint.rb

@@ -0,0 +1,7 @@
+module Thesis
+  class RouteConstraint
+    def self.matches?(request)
+      Page.where(slug: request.path.to_s).select("id").first.present?
+    end
+  end
+end

data/lib/thesis/routing/routes.rb

@@ -0,0 +1,10 @@
+module ActionDispatch::Routing
+  class Mapper
+    def thesis_routes
+      # Page crud (AJAX)
+      post "thesis/new_page", "thesis/thesis#new_page"
+
+      get "*slug" => 'thesis/thesis#show', constraints: ::Thesis::RouteConstraint
+    end
+  end
+end 

data/lib/thesis/version.rb

@@ -1,3 +1,3 @@
 module Thesis
-  VERSION = "0.0.1"
+  VERSION = "0.0.4"
 end

data/lib/thesis.rb

@@ -1,5 +1,14 @@
+require "thesis/engine"
 require "thesis/version"
-require "thesis/base"
+require "thesis/exceptions"
+require "thesis/controllers/controller_helpers" # Included into ActionController::Base
+require "thesis/controllers/thesis_controller"
+require "thesis/routing/route_constraint"
+require "thesis/routing/routes"
+
+# Models
+require "thesis/models/page"
+require "thesis/models/page_content"
 
 module Thesis
 end

data/spec/factories/page_contents.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :page_content, class: Thesis::PageContent do
+    name "Content Block"
+    content "<h1>Some Header</h1><p>A little paragraph.</p>"
+    content_type "html"
+  end
+end

data/spec/factories/pages.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :page, class: Thesis::Page do
+    name "Some Page"
+    slug "some-page"
+    title "An Awesome Page"
+    description "A description goes here"
+    template "default"
+  end
+end