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

contentment 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 (7) hide show

data/README.rdoc CHANGED Viewed

@@ -2,9 +2,61 @@
 ===Contentment is a extremely basic Content Management System.
+How often do your clients want to manage / edit some piddly little portion of the site you're building for them?
+Every time?  Yeah me too.  If what you need is a way for your clients to manage the FAQ or Testimonials, contentment is for you.
+It's blindingly simple to use and it will save you time.
 The primary advantage it offers over a roll-your-own CMS is consistency.
 Use Contentment whenever you need a basic CMS and you can stop re-inventing the wheel and start pumping code.
+==Get Contentment
+Add it to your gemfile
+	gem 'contentment'
+and run
+	bundle install
+==Use Contentment
+	rails g contentment
+	rake db:migrate
+This will create the Content model and a migration to add the contents table to your database, if it doesn't already exist.
+It will also create contents_controller.rb for you with all the CRUD already done.
+	rails g contentment_views
+Will create the views to manage your Content.
+Fire up the server and you're ready to go.
+==Details
+title and body are pretty self explanatory, perfect for question and answer, or header and paragraph.
+tipe is not type to get around rails polymorphic associations stuff and exists because then you can
+do things like Content.for_FAQ or Content.for_navigation.
+dom_id is rarely used, but sometimes you need to manipulate Content programmatically and this is there for that.
+position, because clients love ordering stuff around.
+visible, because clients like to hide things from their users.
+==Live Preview of Content on Edit
+Slap this in your application.js to get live preview of the title attribute of content
+	$('.edit_content').keyup(function(){
+		var bob = $('#content_title').val();
+	 	$('.content_preview_title').html(bob);
+	})
+I'm using TinyMCE Hammer to get TinyMCE in my projects, and if you install it too you can have live preview of the body of your content pretty easily.
+(I'm working on getting TinyMCE included in this gem)
+TinyMCE is nice because your clients probably want the ability to add line breaks and other styling without having to learn HTML.
+So.  Install the TinyMCE Hammer plugin https://github.com/trevorrowe/tinymce_hammer or http://tinymcehammer.lanalot.com/ , I don't know which is canonical.
+Then add
+	<%= yield :scripts %>
+to the <head> section of whatever layout (probably application.html.erb) is rendered around the contents/edit.html.erb file.
+Donezo.  You should now see the changes made to the title and body of your content on the edit view live and in real time in the preview area.
+Clients love that.
+==That's It!
+If we did anything else it wouldn't be simple anymore.
+Questions, Thoughts, Comments to larrick@gmail.com
 ==Thanks

data/lib/generators/contentment/contentment_views_templates/contents/edit.html.erb CHANGED Viewed

@@ -1,36 +1,34 @@
 <%= link_to 'New content', new_content_path, :class => 'button', :id => "add-content" %>
 <%= link_to "Back to Content List", contents_path, :class => 'button', :id => 'back-to-contents' %>
 <div class="panel clearfix">
-    <h3>Edit content</h3>
-    <% form_for(@content) do |f| %>
-      <div class="tools">
-        <%= link_to 'Back', contents_path %>
-        <%= f.submit 'Update' %>
-      </div>
-      <div class="main">
-        <%= f.text_field :title, :placeholder => "Content Title", :class => 'title' %>
-        <%= f.label :body %>
-        <%= f.text_area :body %>
-      </div>
-      <div class="side">
-        <p>
-            <%= f.label :type %>
-            <%= f.select :tipe, content_tipe_options %>
-        </p>
-        <p>
-            <%= f.label "DOM id" %>
-            <%= f.text_field :dom_id %>
-        </p>
-        <p>
-            <%= f.label :position %>
-            <%= f.text_field :position %>
-        </p>
-        <p>
-            <%= f.label :visible %>
-            <%= f.check_box :visible%>
-        </p>
-      </div>
-    <% end %>
+  <h3>Edit content</h3>
+  <% form_for(@content) do |f| %>
+    <p>
+      <%= f.text_field :title, :placeholder => "Content Title", :class => 'title' %>
+    </p>
+    <p>
+      <%= f.label :body %>
+      <%= f.text_area :body %>
+    </p>
+    <p>
+      <%= f.label :type %>
+      <%= f.select :tipe, content_tipe_options %>
+    </p>
+    <p>
+      <%= f.label "DOM id" %>
+      <%= f.text_field :dom_id %>
+    </p>
+    <p>
+      <%= f.label :position %>
+      <%= f.text_field :position %>
+    </p>
+    <p>
+      <%= f.label :visible %>
+      <%= f.check_box :visible%>
+    </p>
+    <%= link_to 'Back', contents_path %>
+    <%= f.submit 'Update' %>
+  <% end %>
 </div>
 <%= render :partial => "preview", :locals => { :form => '.edit_content', :content => @content } %>

data/lib/generators/contentment/contentment_views_templates/contents/new.html.erb CHANGED Viewed

@@ -1,37 +1,34 @@
 <div class="panel clearfix">
-    <h3>New content</h3>
-    <% form_for(@content) do |f| %>
-    <div class="tools">
-        <%= link_to 'Cancel', contents_path %>
-        <%= f.submit 'Create' %>
-    </div>
-    <div class="main">
-        <%= f.text_field :title, :placeholder => "Content Title", :class => 'title' %>
-        <%= f.label :body %>
-        <%= f.text_area :body %>
-    </div>
-    <div class="side">
-        <p>
-            <%= f.label :type %>
-            <%= f.select :tipe, content_tipe_options %>
-        </p>
-        <p>
-            <%= f.label "DOM id" %>
-            <%= f.text_field :dom_id %>
-        </p>
-        <p>
-            <%= f.label :position %>
-            <%= f.text_field :position %>
-        </p>
-        <p>
-            <%= f.label :visible %>
-            <%= f.check_box :visible%>
-        </p>
-    </div>
-    <% end %>
+  <h3>New content</h3>
+  <% form_for(@content) do |f| %>
+    <p>
+      <%= f.text_field :title, :placeholder => "Content Title", :class => 'title' %>
+    </p>
+    <p>
+      <%= f.label :body %>
+      <%= f.text_area :body %>
+    </p>
+    <p>
+      <%= f.label :type %>
+      <%= f.select :tipe, content_tipe_options %>
+    </p>
+    <p>
+      <%= f.label "DOM id" %>
+      <%= f.text_field :dom_id %>
+    </p>
+    <p>
+      <%= f.label :position %>
+      <%= f.text_field :position %>
+    </p>
+    <p>
+      <%= f.label :visible %>
+      <%= f.check_box :visible%>
+    </p>
+    <%= link_to 'Cancel', contents_path %>
+    <%= f.submit 'Create' %>
+  <% end %>
 </div>
 <%= render :partial => "preview", :locals => { :form => '.new_content', :content => @content } %>

data/lib/generators/contentment/contentment_views_templates/contents_helper.rb CHANGED Viewed

@@ -1,4 +1,7 @@
 module ContentsHelper
+	# Is a helper really necessary?  Apparently I thought so at some point.  <%= f.select :tipe, content_tipe_options %>
+	# When the helper is longer than what it replaces you've got a problem.
 	def content_tipe_options
     Content.tipes
   end

data/lib/generators/contentment/templates/content.rb CHANGED Viewed

@@ -1,10 +1,12 @@
 class Content < ActiveRecord::Base
-# ADJUST_POSTIONS DOES NOT WORK RIGHT NOW
-#	before_save :adjust_positions
+	before_save :adjust_positions
 	class << self; attr_accessor :tipes; end
+	# Put all the different kinds of content you will have in here to get a select helper and some named scopes
+	# generated for you.
   @tipes = [
 	# "Billboard",
 	# "What You Learn",
@@ -16,23 +18,27 @@ class Content < ActiveRecord::Base
 	# "Navigation",
 	]
+	# Pretty much always want to only find content of one tipe at a time, so generate scopes for all tipes.
   @tipes.each do |thing|
     scope "for_#{thing.downcase.gsub(' ', '_')}".intern, where("tipe = ?", thing)
   end
+	# It's pretty common to want the ability to hide some content.  Use the visible scope liberally.
 	scope :visible, lambda {|x| where(:visible => x)}
+	# Returns all Content with like tipe.
 	def brothers
 		Content.where("tipe = ?", self.tipe).where("id NOT in (#{self.id})")
 	end
 	private
+		#  It's a pain with ordered content to have to manually update each piece of content when rearranging them.
+		#  adjust_positions will make sure when you change the position of one content, all other content of that tipe
+		#  has position changed to keep a reasonable order.
   	def adjust_positions
 			return true unless changed.include?('position')
 			return true unless brothers.map{|x| x.position}.include?(self.position)
-			brothers.where("position < ?", self.position).update_all("position = (position - 1)")
 			brothers.where("position >= ?", self.position).update_all("position = (position + 1)")
 		end

data/lib/generators/contentment/templates/content_test.rb CHANGED Viewed

@@ -1,16 +1,34 @@
 require 'test_helper'
 class ContentTest < ActiveSupport::TestCase
+	def setup
+    @a = Content.create(:app_id => 1, :position => 1, :title => 'a', :tipe => 'test')
+    @b = Content.create(:app_id => 1, :position => 2, :title => 'b', :tipe => 'test')
+    @c = Content.create(:app_id => 1, :position => 3, :title => 'c', :tipe => 'test')
+	end
   # Replace this with your real tests.
-  test "content should fix position on save" do
-    a = Content.create(:position => 1, :title => 'a', :tipe => 'test')
-    b = Content.create(:position => 2, :title => 'b', :tipe => 'test')
-    c = Content.create(:position => 3, :title => 'c', :tipe => 'test')
-		c.position = 1
-		c.save
+  test "content should fix position of other content with similar tipe on save" do
+		@c.position = 1
+		@c.save
-		assert(c.reload.position == 1)
-		assert(a.reload.position == 2)
-		assert(b.reload.position == 3)
+		assert(@c.reload.position == 1)
+		assert(@a.reload.position == 2)
+		assert(@b.reload.position == 3)
   end
+	test "saving multiple pieces of content things kind of escalate out of control ... " do
+		@a.position = 3
+		@a.save
+		assert(3 == @a.reload.position)
+		assert(2 == @b.reload.position)
+		assert(4 == @c.reload.position)
+		@b.position = 3
+		@b.save
+		assert(3 == @b.reload.position)
+		assert(5 == @c.reload.position)
+		assert(4 == @a.reload.position)
+	end
 end

metadata CHANGED Viewed

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments:
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Bob Larrick
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-01-12 00:00:00 -05:00
+date: 2011-01-14 00:00:00 -05:00
 default_executable:
 dependencies: []