RubyGems - editable_content - Versions diffs - 0.4.0 → 0.5.0 - Mend

editable_content 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

data/LICENSE +1 -1
data/README.rdoc +136 -3
data/lib/editable_content.rb +7 -3
data/lib/editable_content/controller_helper.rb +131 -84
data/lib/editable_content/view_helpers.rb +138 -0
data/lib/generators/editable_content_generator.rb +2 -2
data/test/helper.rb +2 -0
metadata +5 -5
data/lib/editable_content/application_helpers.rb +0 -88

data/LICENSE CHANGED Viewed

@@ -1,4 +1,4 @@
-Copyright (c) 2009 wmerrell
+Copyright (c) 2010 Will Merrell
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc CHANGED Viewed

@@ -1,9 +1,142 @@
 = editable_content
-Description goes here.
+This plugin manages sections of a page that can be edited by users. I use it to
+manage various boilerplate sections that need to be changed occasionally such as
+welcome messages, contact form instructions, and things like that.
+The editing fuctionality uses Textile markup and is extended to uses Radius tags
+to embed function calls that are evaluated and expanded at run time. This allow
+you to include any custom functionality that you care to write.
+== Requirements
+This gem is for Rails 3 and above only. While I developed most of these
+techniques under Rails 2, that version was too complicated to release.
+This gem requires the JQuery javascript library and the JQuery UI library. This
+gem assumes that these files are already included in your page, and does not
+add them.
+This gem uses the MarkItUp javascript editor library (http://markitup.jaysalvat.com/home/)
+to create the popup editor. You will need that code in your /public/javascript/
+directory in order for this to work. The stylesheets and javascript for this
+will be added automatically on the pages that use an editor.
+This gem also requires the Radius and Redcloth gems.
+== Installation
+Install the gem:
+  gem install editable_content
+Add it to your Gemfile:
+  gem "editable_content"
+This gem inserts stylesheets and javascript into the generated page to create a
+popup editor to edit the section of the page. To allow this, your page must have
+hooks to support adding the required code. Add the following lines to the <head>
+section of the layout file used to genrate the page that will have the editable
+field.
+    <%= yield :stylesheet_list %>
+    <%= yield :javascript_list %>
+    <script type="text/javascript">
+      <%= yield :javascript_data %>
+    </script>
+In addition make sure the layout file includes jquery.js, jquery-ui.js and a
+UI theme css file.
+== Basic Usage
+Use getContent to create a variable that holds the current content. In this
+example +"maintext"+ is the name of the field, and +@maintext_content+ is the variable
+that holds the content. Put the following line in the controller for your action:
+    @maintext_content = getContent("maintext")
+Next put the following lines in the view file for your action:
+    <%= insert_editable_content -%>            # include once only
+    <%= create_content_editor("maintext") -%>  # include once for each field
+Finally display the content somewhere in your view file:
+  <%= @maintext_content %>
+You may use as many editable fields on a page as you wish, as long as each has a
+unique name for the field and variable. These name can be any valid rails
+variable name that you want.
+== Security
+It will usually be desirable to restrict who can edit a field. You will almost
+never want the general public to be able to edit most of your fields. It is
+assumed that you will have some sort of user authentication, but that is beyond
+the scope of this gem. This uses a global variable to control access. If the
+variable is true, the current user can edit all fields. If it is false then the
+current user cannot edit any field, they are display only.
+The way to use this is to set the variable during the page generation process.
+The easiest way to do this is with a before filter that determines whether the
+current user has permission to edit or not. I use this code in my
+application_controller.rb:
+  before_filter proc{ setEditableAuthorization(current_user.is?( :editor )) }
+You can use any code that evaluates to true or false as the parameter to
++setEditableAuthorization+.
+== Additional Functionality
+This gem includes a function called +processContent+ that allows you to use the
+Textile/Radius engine to expand any text and return it as formated HTML. With
+this you can use any textarea or textfield to enter text that will be rendered
+as HTML.
+== Extending Custom Funtionality
+The Radius context used to evaluate Radius tags is exposed via a global variable
+called +$editable_content_radius_context+. To use this create a model file as
+follows, and include it in your application_controller.rb file.
+    module ExtendContent
+      $editable_content_radius_context.with do |c|
+        c.define_tag 'test' do |tag|
+          number = (tag.attr['times'] || '1').to_i
+          result = ''
+          number.times { result << 'test ' }
+          result
+        end
+        c.define_tag 'user' do |tag|
+          if (!tag.attr['email'].blank?) || (!tag.attr['id'].blank?)
+            if !tag.attr['email'].blank?
+              item = User.where(:email=>tag.attr['email']).email
+            elsif !tag.attr['id'].blank?
+              item = User.find(tag.attr['id']).email
+            end
+          else
+            item = "unknown"
+          end
+          item
+        end
+      end # end of context
+    end # end of module
 == Note on Patches/Pull Requests
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
@@ -14,4 +147,4 @@ Description goes here.
 == Copyright
-Copyright (c) 2010 wmerrell. See LICENSE for details.
+Copyright (c) 2010 Will Merrell. See LICENSE for details.

data/lib/editable_content.rb CHANGED Viewed

@@ -1,9 +1,13 @@
-require 'rails'
+require 'rails' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+require 'action_controller'
+require 'action_view'
 require 'radius'
 require 'redcloth'
-require 'editable_content/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+require 'editable_content/engine'
 require 'editable_content/controller_helper'
-require 'editable_content/application_helpers'
+require 'editable_content/view_helpers'
 module EditableContent
 end

data/lib/editable_content/controller_helper.rb CHANGED Viewed

@@ -1,64 +1,112 @@
 module EditableContent
-  module ActionControllerExtensions
-    module ControllerFunctions
-      def getContent(name="")
-        text = "<div id=\"ec_edit_frame_#{name}\">" + getInnerContent(name, controller_name(), action_name()) + "</div>"
-        if $editable_content_authorization
-          text = "<img id=\"ec_edit_button_#{name}\" class=\"edit_icon\" width=\"16\" height=\"16\" src=\"/images/pencil.png\" title=\"Edit this Content\" alt=\"Edit this Content Button\" />" + text
-        end
-        text.html_safe
+  module ControllerFunctions
+    #
+    # This function retrieves the editable content from the database.
+    # If +setEditableAuthorization+ is set to true then a button
+    # to launch the editor is prepended to the content.
+    #
+    # Each editable field needs will need one editor and they are created with
+    # the +create_content_editor+ function in the view file.
+    #
+    # === Parameters:
+    # *name* This is the name of the field. This is the same name that will be
+    # passed into the +create_content_editor+ function.
+    #
+    # === Usage:
+    #   def index
+    #     @content = getContent("maintext")
+    #   end
+    #
+    def getContent(name="")
+      text = "<div id=\"ec_edit_frame_#{name}\">" + getInnerContent(name, controller_name(), action_name()) + "</div>"
+      if $editable_content_authorization
+        text = "<img id=\"ec_edit_button_#{name}\" class=\"edit_icon\" width=\"16\" height=\"16\" src=\"/images/pencil.png\" title=\"Edit this Content\" alt=\"Edit this Content Button\" />" + text
       end
+      text.html_safe
+    end
-      def processContent(content)
-        if content
-          text = parseContent(content.gsub(/&#39;/, "'"))
-        else
-          text = "<div class=\"error\">No Content.</div>".html_safe
-        end
+    #
+    # This function formats the supplied content using the same processor that
+    # editable content uses.
+    #
+    # === Parameters:
+    # *content* The text to be converted. This expects a textile formated string
+    # and returns html formated text suitable for display.
+    #
+    # === Usage:
+    #   def index
+    #     @content = processContent("This is *textile* _text_.")
+    #   end
+    #
+    def processContent(content=nil)
+      if content
+        text = parseContent(content.gsub(/&#39;/, "'"))
+      else
+        text = "<div class=\"error\">No Content.</div>".html_safe
       end
+    end
-    private
+    # This is used to set up the permissions for the editable content system.
+    # This allows you to control who can edit a editable content field.
+    #
+    # === Parameters:
+    # *permission* A boolean value. If +true+ the editor is created and enabled,
+    # if +false+ the editor is not created.
+    #
+    # === Usage:
+    # The easiest way to use the permissions system is to use a +before_filter+
+    # in the application_controller, like this:
+    #
+    #   before_filter proc{ setEditableAuthorization(current_user.is?( :editor )) }
+    #
+    # In this example, if the current user is an editor then they can edit fields.
+    #
+    def setEditableAuthorization(permission = false)
+      $editable_content_authorization = permission
+    end
-      def getInnerContent(name, controller, action)
-        content = EcContent.first( :conditions => { :name => name, :controller => controller, :action => action} )
-        if !content
-          text = "<div class=\"error\">No Content for #{controller}:#{action}.#{name}.</div>"
-          content = EcContent.new({ :name => name, :controller => controller, :action => action, :body => text })
-          content.save
+  private
+    def getInnerContent(name, controller, action)
+      content = EcContent.first( :conditions => { :name => name, :controller => controller, :action => action} )
+      if !content
+        text = "<div class=\"error\">No Content for #{controller}:#{action}.#{name}.</div>"
+        content = EcContent.new({ :name => name, :controller => controller, :action => action, :body => text })
+        content.save
+      else
+        if content.body.blank?
+          text = "<div class=\"error\">Content.body for #{controller}:#{action}.#{name} is blank.</div>"
         else
-          if content.body.blank?
-            text = "<div class=\"error\">Content.body for #{controller}:#{action}.#{name} is blank.</div>"
-          else
-            text = parseContent(content.body.gsub(/&#39;/, "'"))
-          end
+          text = parseContent(content.body.gsub(/&#39;/, "'"))
         end
-        text.html_safe
       end
+      text.html_safe
+    end
-      def parseContent(content)
-        parser = Radius::Parser.new($editable_content_radius_context, :tag_prefix => 'r')
-        text = RedCloth.new(parser.parse(content)).to_html.html_safe
-      end
+    def parseContent(content)
+      parser = Radius::Parser.new($editable_content_radius_context, :tag_prefix => 'r')
+      text = RedCloth.new(parser.parse(content)).to_html.html_safe
+    end
-      # Define tags on a context that will be available to a template:
-      $editable_content_radius_context = Radius::Context.new do |c|
+    # Define tags on a context that will be available to a template:
+    $editable_content_radius_context = Radius::Context.new do |c|
-        c.define_tag 'repeat' do |tag|
-          number = (tag.attr['times'] || '1').to_i
-          result = ''
-          number.times { result << tag.expand }
-          result
-        end
+      c.define_tag 'repeat' do |tag|
+        number = (tag.attr['times'] || '1').to_i
+        result = ''
+        number.times { result << tag.expand }
+        result
+      end
-        c.define_tag 'hello' do |tag|
-          "Hello #{tag.attr['name'] || 'World'}!"
-        end
+      c.define_tag 'hello' do |tag|
+        "Hello #{tag.attr['name'] || 'World'}!"
+      end
-        c.define_tag 'lorem' do |tag|
-          word_count = (tag.attr['wordcount'] || '20').to_i
-          # ===== words
-          words =<<EOS
+      c.define_tag 'lorem' do |tag|
+        word_count = (tag.attr['wordcount'] || '20').to_i
+        # ===== words
+        words =<<EOS
 lorem ipsum dolor sit amet  consectetuer adipiscing elit  integer in mi a mauris ornare sagittis
 suspendisse potenti  suspendisse dapibus dignissim dolor  nam sapien tellus  tempus et  tempus ac
 tincidunt in  arcu  duis dictum  proin magna nulla  pellentesque non  commodo et  iaculis sit amet
@@ -130,48 +178,47 @@ quam  nulla nulla  nunc accumsan  nunc sit amet scelerisque porttitor  nibh pede
 tristique mattis purus eros non velit  aenean sagittis commodo erat  aliquam id lacus  morbi
 vulputate vestibulum elit
 EOS
-          words.gsub!(/\n/,' ')
-          words.gsub!(/  */,' ')
-          words.strip!
-          words = words.split(/ /)
-          lorem = ""
-          # ===== total
-          twn = 0
-          twc = word_count
-          while twn < twc
-            # ===== paragraph
-            pwn = 0
-            pwc = rand(100)+50
-            while pwn < pwc and twn < twc do
-              # ===== sentence
-              swn = 0
-              swc = rand(10)+3
-              while swn < swc and pwn < pwc and twn < twc do
-                word = words[rand(words.length)]
-                if swn == 0
-                  lorem << "#{word.capitalize} "
-                else
-                  lorem << "#{word} "
-                end
-                twn +=1
-                pwn +=1
-                swn +=1
+        words.gsub!(/\n/,' ')
+        words.gsub!(/  */,' ')
+        words.strip!
+        words = words.split(/ /)
+        lorem = ""
+        # ===== total
+        twn = 0
+        twc = word_count
+        while twn < twc
+          # ===== paragraph
+          pwn = 0
+          pwc = rand(100)+50
+          while pwn < pwc and twn < twc do
+            # ===== sentence
+            swn = 0
+            swc = rand(10)+3
+            while swn < swc and pwn < pwc and twn < twc do
+              word = words[rand(words.length)]
+              if swn == 0
+                lorem << "#{word.capitalize} "
+              else
+                lorem << "#{word} "
               end
-              lorem << ". "
+              twn +=1
+              pwn +=1
+              swn +=1
             end
-            lorem << "\n\n"
+            lorem << ". "
           end
-          lorem = lorem.gsub!(/ \./,'.')
-        end # end of lorem
+          lorem << "\n\n"
+        end
+        lorem = lorem.gsub!(/ \./,'.')
+      end # end of lorem
-      end # end of $context
+    end # end of $context
-    end
   end
 end
-ActionController::Base.send :include, EditableContent::ActionControllerExtensions::ControllerFunctions
+ActionController::Base.send :include, EditableContent::ControllerFunctions

data/lib/editable_content/view_helpers.rb ADDED Viewed

@@ -0,0 +1,138 @@
+module EditableContent
+  module ViewHelpers
+    #
+    # This function inserts the code needed for editing editable content
+    # into the head section of the page.
+    #
+    # Each editable field needs will need one editor and they are created with
+    # the +create_content_editor+ function
+    #
+    # === Note
+    # This function creates an unobtursive javascript event handler that
+    # launches the editor. It uses +content_for+ to save the code in
+    # the following variables: +stylesheet_list+, +javascript_list+,
+    # and +javascript_data+. It assumes that you will have the following
+    # in your head section.
+    #
+    #   <%= yield :stylesheet_list %>
+    #   <%= yield :javascript_list %>
+    #   <script type="text/javascript">
+    #     <%= yield :javascript_data %>
+    #   </script>
+    #
+    # === Usage
+    #   <%= insert_editable_content -%>
+    #   <%= create_content_editor("maintext") -%>
+    #   <%= create_content_editor("contacttext") -%>
+    #
+    def insert_editable_content()
+      if $editable_content_authorization
+        content_for(:stylesheet_list) { stylesheet_link_tag "markitup/skins/simple/style.css" }
+        content_for(:stylesheet_list) { stylesheet_link_tag "markitup/sets/textile/style.css" }
+        content_for(:javascript_list) { javascript_include_tag "markitup/jquery.markitup.js" }
+        content_for(:javascript_list) { javascript_include_tag "markitup/sets/textile/set.js" }
+        content_for(:javascript_data) { <<-SCRIPTDATA
+          var content_id = 0;
+          var content_name = "";
+          function openEditor(name, controller, action) {
+            content_name = name;
+            $.get("/contents/edit",
+              {p_name:name, p_controller:controller, p_action:action},
+              jQuery.proxy(this, function(data) {
+                content_id = data.id;
+                $("#ec_edit_textarea").val(data.content);
+                $("#ec_edit_dialog_form").dialog('open');
+            }));
+          }
+          $(function() {
+            // a workaround for a flaw in the demo system (http://dev.jqueryui.com/ticket/4375), ignore!
+            $("#ec_edit_dialog_form").dialog("destroy");
+            $("#ec_edit_textarea").markItUp(mySettings);
+            $("#ec_edit_dialog_form").dialog({
+              autoOpen: false,
+              height: 375,
+              width: 1000,
+              modal: true,
+              buttons: {
+                'Save': function() {
+                  $.post("/contents/update",
+                    {p_id:content_id, p_content:$("#ec_edit_textarea").val()},
+                    jQuery.proxy(this, function(data) {
+                      $("#ec_edit_frame_" + content_name).html(data);
+                    })
+                  );
+                  $(this).dialog('close');
+                },
+                Cancel: function() {
+                  $(this).dialog('close');
+                }
+              },
+              close: function() {
+                $("#ec_edit_textarea").html("");
+              }
+            });
+          });
+SCRIPTDATA
+        }
+        editor_text = <<EDITOR_FORM
+          <div id="ec_edit_dialog_form" title="Edit Content" style="padding: 0; display: none;">
+            <form style="padding: 5px 0 0 0;" >
+              <textarea name="ec_edit_textarea" id="ec_edit_textarea" cols="80" style="width: 99.5%; height: 200px; min_height: 200px;" class="ui_widget_content ui_corner_all" ></textarea>
+            </form>
+          </div>
+EDITOR_FORM
+        editor_text.html_safe
+      end
+    end
+    #
+    # This function inserts the code needed to create the editor for a field
+    # into the head section of the page.
+    # Each editable field needs one editor and this is the function that
+    # creates it.
+    #
+    # === Parameters
+    # *name* This is the name of the field. This is the same name that will be
+    # passed into the +getContent+ function
+    #
+    # === Note
+    # This function creates an unobtursive javascript event handler that
+    # launches the editor. It uses +content_for+ to save the code in
+    # the +javascript_data+ variable. It assumes that you will have the following
+    # in your head section.
+    #
+    #   <script type="text/javascript">
+    #     <%= yield :javascript_data %>
+    #   </script>
+    #
+    # === Usage
+    #   <%= insert_editable_content -%>
+    #   <%= create_content_editor("maintext") -%>
+    #   <%= create_content_editor("contacttext") -%>
+    #
+    #
+    def create_content_editor(name)
+      if $editable_content_authorization
+        content_for(:javascript_data) { <<-SCRIPTDATA
+          $(function() {
+            $("#ec_edit_button_#{name}").click( function(event) {
+              openEditor("#{name}", "#{controller_name()}", "#{action_name()}");
+              event.preventDefault();
+            });
+          });
+SCRIPTDATA
+        }
+      end
+    end
+  end
+end
+ActionView::Base.send :include, EditableContent::ViewHelpers

data/lib/generators/editable_content_generator.rb CHANGED Viewed

@@ -10,14 +10,14 @@ class EditableContentGenerator < Rails::Generators::Base
   class_option :"skip-migration", :type => :boolean, :desc => "Don't generate a migration for the EcContent table"
   class_option :"skip-routes", :type => :boolean, :desc => "Don't generate the routes for Editable Contents"
-  def install_routes(*args)
+  def install_routes(*args) #:nodoc:
     unless options["skip-routes"]
       route "get  '/contents/edit',   :as => :edit_content"
       route "post '/contents/update', :as => :update_content"
     end
   end
-  def copy_files(*args)
+  def copy_files(*args) #:nodoc:
     migration_template MIGRATIONS_FILE, "db/migrate/create_ec_contents.rb" unless options["skip-migration"]
   end

data/test/helper.rb CHANGED Viewed

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'test/unit'
+require 'bundler'
+Bundler.setup
 require 'shoulda'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: editable_content
 version: !ruby/object:Gem::Version
-  hash: 15
+  hash: 11
   prerelease: false
   segments:
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Will Merrell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-11-13 00:00:00 -05:00
+date: 2010-12-19 00:00:00 -05:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -79,9 +79,9 @@ files:
 - app/views/contents/edit.html.erb
 - app/views/layouts/contents.html.erb
 - lib/editable_content.rb
-- lib/editable_content/application_helpers.rb
 - lib/editable_content/controller_helper.rb
 - lib/editable_content/engine.rb
+- lib/editable_content/view_helpers.rb
 - lib/generators/editable_content_generator.rb
 - LICENSE
 - README.rdoc

data/lib/editable_content/application_helpers.rb DELETED Viewed

@@ -1,88 +0,0 @@
-module EditableContent
-  module ActionControllerExtensions
-    module ApplicationHelpers
-      def insert_editable_content()
-        if $editable_content_authorization
-          content_for(:stylesheet_list) { stylesheet_link_tag "markitup/skins/simple/style.css" }
-          content_for(:stylesheet_list) { stylesheet_link_tag "markitup/sets/textile/style.css" }
-          content_for(:javascript_list) { javascript_include_tag "markitup/jquery.markitup.js" }
-          content_for(:javascript_list) { javascript_include_tag "markitup/sets/textile/set.js" }
-          content_for(:javascript_data) { <<-SCRIPTDATA
-            var content_id = 0;
-            var content_name = "";
-            function openEditor(name, controller, action) {
-              content_name = name;
-              $.get("/contents/edit",
-                {p_name:name, p_controller:controller, p_action:action},
-                jQuery.proxy(this, function(data) {
-                  content_id = data.id;
-                  $("#ec_edit_textarea").val(data.content);
-                  $("#ec_edit_dialog_form").dialog('open');
-              }));
-            }
-            $(function() {
-              // a workaround for a flaw in the demo system (http://dev.jqueryui.com/ticket/4375), ignore!
-              $("#ec_edit_dialog_form").dialog("destroy");
-              $("#ec_edit_textarea").markItUp(mySettings);
-              $("#ec_edit_dialog_form").dialog({
-                autoOpen: false,
-                height: 375,
-                width: 1000,
-                modal: true,
-                buttons: {
-                  'Save': function() {
-                    $.post("/contents/update",
-                      {p_id:content_id, p_content:$("#ec_edit_textarea").val()},
-                      jQuery.proxy(this, function(data) {
-                        $("#ec_edit_frame_" + content_name).html(data);
-                      })
-                    );
-                    $(this).dialog('close');
-                  },
-                  Cancel: function() {
-                    $(this).dialog('close');
-                  }
-                },
-                close: function() {
-                  $("#ec_edit_textarea").html("");
-                }
-              });
-            });
-SCRIPTDATA
-          }
-          editor_text = <<EDITOR_FORM
-            <div id="ec_edit_dialog_form" title="Edit Content" style="padding: 0; display: none;">
-              <form style="padding: 5px 0 0 0;" >
-                <textarea name="ec_edit_textarea" id="ec_edit_textarea" cols="80" style="width: 99.5%; height: 200px; min_height: 200px;" class="ui_widget_content ui_corner_all" ></textarea>
-              </form>
-            </div>
-EDITOR_FORM
-          editor_text.html_safe
-        end
-      end
-      def create_content_editor(name)
-        if $editable_content_authorization
-          content_for(:javascript_data) { <<-SCRIPTDATA
-            $(function() {
-              $("#ec_edit_button_#{name}").click( function(event) {
-                openEditor("#{name}", "#{controller_name()}", "#{action_name()}");
-                event.preventDefault();
-              });
-            });
-SCRIPTDATA
-          }
-        end
-      end
-    end
-  end
-end
-ActionView::Base.send :include, EditableContent::ActionControllerExtensions::ApplicationHelpers