contentable 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 metasoarous
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,40 @@
+h1. Contentable
+
+Contentable is a gem for easing the integration of chunks of dynamic content. For situations in which content which needs to be inserted here in there in some web application, but which should be updatable on the fly, you could go with a content management system, but if you also need other models and the rest of the power of rails, that isn't the best solution. This gem addresses this issue by allowing you to create content_items which house content (using textile) and give you easy display (etc) access to this content, either as full page content or as a simple block of content to be embedded within some other dynamic page. 
+
+h2. How to use
+
+The basics of use of this gem are as follows.
+
+# First, include the gem in your Gemfile
+# Next scaffold out a content_item model with fields @name:string title:string description:string text:text@. Alternatively (preferably really) there is a migration helper which goes along the lines of @create_content_items@ that does this for you; just include that method call within @def self.up@.
+# Put the line @acts_as_contentable@ in your @ContentItem@ model
+# Use @display_content(content_item)@ in your views (or @display_textile(some_textile_text)@)
+# Include @Contentable::Controller@ in your @ContentItemController@ to gain access to the @find_content_item@ controller method which first looks to see if @params[:id]@ is defined and then looks to see if @params[name]@ is defined. The the first isn't but the latter is, the action will grab the content item based on the name passed through. Now you can set up routes that easily take advantage of this so that your content item @name@ attributes can behave like parts of a path.
+# You can also call @ContentItem#safe_find_by_name(name)@ directly (the method able is just a wrapper of this). If that name queried for is not found, the method returns a (either new or old, depending on whether the situation has ever happened before) content item named @content_missing@. This content item will be given a @missing@ attribute (in local memory, not in db) which stores the name of the missing content item. This name can then be used for easier creation of content that should exist but does not yet.
+
+h2. TODO
+
+* Make it so that the class you include contentable in can be named whatever your want (BIG ONE)
+* Make helpers for using javascript to automatically render the textile as you type it. 
+* Put in validations on @name@ of content items so that they can always be used as paths?
+* Create validations/protections on changing the content_item @name@
+* Create generators for view code, (migrations, etc?)
+* ContentItem manager (a sort of default content item index which allows an admin to manage content items)
+* Support other markup languages
+* Integrate the textile helper
+* Routing helpers
+
+h2. Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add specs for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h2. Copyright
+
+Copyright (c) 2010 metasoarous (Christopher Small). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+	require 'jeweler'
+	Jeweler::Tasks.new do |gem|
+		gem.name = "contentable"
+		gem.summary = %Q{Rails 3 gem for streamlining the management of chunks of html (textile) content within an application}
+		gem.description = %Q{Contentable allows rails developers to place chunks of content in "content_items" whcih store content text, titles and descriptions in order to make content more easily updateable manageable.}
+		gem.email = "metasoarous@gmail.com"
+		gem.homepage = "http://github.com/metasoarous/contentable"
+		gem.authors = ["metasoarous"]
+		gem.add_dependency "RedCloth"
+		gem.add_development_dependency "rspec", ">= 1.2.9"
+		# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+	end
+	Jeweler::GemcutterTasks.new
+rescue LoadError
+	puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+# Complaining about not being able to find Spec
+# 
+# Spec::Rake::SpecTask.new(:rcov) do |spec|
+#		spec.libs << 'lib' << 'spec'
+#		spec.pattern = 'spec/**/*_spec.rb'
+#		spec.rcov = true
+# end
+
+task :spec => :check_dependencies
+
+# task :default => :spec
+desc 'Default: Run all specs.'
+task :default => :all_specs
+
+desc "Run all specs"
+task :all_specs do
+	Dir['spec/**/Rakefile'].each do |rakefile|
+		directory_name = File.dirname(rakefile)
+		sh <<-CMD
+			cd #{directory_name} 
+			bundle exec rake
+		CMD
+	end
+end
+
+
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+	version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+	rdoc.rdoc_dir = 'rdoc'
+	rdoc.title = "contentable #{version}"
+	rdoc.rdoc_files.include('README*')
+	rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/contentable.gemspec

@@ -0,0 +1,133 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{contentable}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["metasoarous"]
+  s.date = %q{2011-01-17}
+  s.description = %q{Contentable allows rails developers to place chunks of content in "content_items" whcih store content text, titles and descriptions in order to make content more easily updateable manageable.}
+  s.email = %q{metasoarous@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "contentable.gemspec",
+     "lib/contentable.rb",
+     "lib/version.rb",
+     "spec/rails3/Gemfile",
+     "spec/rails3/Gemfile.lock",
+     "spec/rails3/Rakefile",
+     "spec/rails3/app_root/.gitignore",
+     "spec/rails3/app_root/README",
+     "spec/rails3/app_root/app/controllers/application_controller.rb",
+     "spec/rails3/app_root/app/controllers/content_items_controller.rb",
+     "spec/rails3/app_root/app/helpers/application_helper.rb",
+     "spec/rails3/app_root/app/helpers/content_items_helper.rb",
+     "spec/rails3/app_root/app/models/content_item.rb",
+     "spec/rails3/app_root/app/views/content_items/_form.html.erb",
+     "spec/rails3/app_root/app/views/content_items/edit.html.erb",
+     "spec/rails3/app_root/app/views/content_items/index.html.erb",
+     "spec/rails3/app_root/app/views/content_items/new.html.erb",
+     "spec/rails3/app_root/app/views/content_items/show.html.erb",
+     "spec/rails3/app_root/app/views/layouts/application.html.erb",
+     "spec/rails3/app_root/config.ru",
+     "spec/rails3/app_root/config/application.rb",
+     "spec/rails3/app_root/config/boot.rb",
+     "spec/rails3/app_root/config/database.yml",
+     "spec/rails3/app_root/config/environment.rb",
+     "spec/rails3/app_root/config/environments/development.rb",
+     "spec/rails3/app_root/config/environments/in_memory.rb",
+     "spec/rails3/app_root/config/environments/production.rb",
+     "spec/rails3/app_root/config/environments/test.rb",
+     "spec/rails3/app_root/config/initializers/backtrace_silencers.rb",
+     "spec/rails3/app_root/config/initializers/inflections.rb",
+     "spec/rails3/app_root/config/initializers/mime_types.rb",
+     "spec/rails3/app_root/config/initializers/secret_token.rb",
+     "spec/rails3/app_root/config/initializers/session_store.rb",
+     "spec/rails3/app_root/config/locales/en.yml",
+     "spec/rails3/app_root/config/routes.rb",
+     "spec/rails3/app_root/db/migrate/20110102070953_create_content_items.rb",
+     "spec/rails3/app_root/db/schema.rb",
+     "spec/rails3/app_root/db/seeds.rb",
+     "spec/rails3/app_root/doc/README_FOR_APP",
+     "spec/rails3/app_root/lib/tasks/.gitkeep",
+     "spec/rails3/app_root/public/404.html",
+     "spec/rails3/app_root/public/422.html",
+     "spec/rails3/app_root/public/500.html",
+     "spec/rails3/app_root/public/favicon.ico",
+     "spec/rails3/app_root/public/images/rails.png",
+     "spec/rails3/app_root/public/index.html",
+     "spec/rails3/app_root/public/javascripts/application.js",
+     "spec/rails3/app_root/public/javascripts/controls.js",
+     "spec/rails3/app_root/public/javascripts/dragdrop.js",
+     "spec/rails3/app_root/public/javascripts/effects.js",
+     "spec/rails3/app_root/public/javascripts/prototype.js",
+     "spec/rails3/app_root/public/javascripts/rails.js",
+     "spec/rails3/app_root/public/robots.txt",
+     "spec/rails3/app_root/public/stylesheets/.gitkeep",
+     "spec/rails3/app_root/public/stylesheets/scaffold.css",
+     "spec/rails3/app_root/script/rails",
+     "spec/rails3/contentable_spec.rb",
+     "spec/rails3/spec.opts",
+     "spec/rails3/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/metasoarous/contentable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rails 3 gem for streamlining the management of chunks of html (textile) content within an application}
+  s.test_files = [
+    "spec/rails3/app_root/app/controllers/application_controller.rb",
+     "spec/rails3/app_root/app/controllers/content_items_controller.rb",
+     "spec/rails3/app_root/app/helpers/application_helper.rb",
+     "spec/rails3/app_root/app/helpers/content_items_helper.rb",
+     "spec/rails3/app_root/app/models/content_item.rb",
+     "spec/rails3/app_root/config/application.rb",
+     "spec/rails3/app_root/config/boot.rb",
+     "spec/rails3/app_root/config/environment.rb",
+     "spec/rails3/app_root/config/environments/development.rb",
+     "spec/rails3/app_root/config/environments/in_memory.rb",
+     "spec/rails3/app_root/config/environments/production.rb",
+     "spec/rails3/app_root/config/environments/test.rb",
+     "spec/rails3/app_root/config/initializers/backtrace_silencers.rb",
+     "spec/rails3/app_root/config/initializers/inflections.rb",
+     "spec/rails3/app_root/config/initializers/mime_types.rb",
+     "spec/rails3/app_root/config/initializers/secret_token.rb",
+     "spec/rails3/app_root/config/initializers/session_store.rb",
+     "spec/rails3/app_root/config/routes.rb",
+     "spec/rails3/app_root/db/migrate/20110102070953_create_content_items.rb",
+     "spec/rails3/app_root/db/schema.rb",
+     "spec/rails3/app_root/db/seeds.rb",
+     "spec/rails3/contentable_spec.rb",
+     "spec/rails3/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<RedCloth>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<RedCloth>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<RedCloth>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/contentable.rb

@@ -0,0 +1,117 @@
+require "redcloth"
+
+module Contentable
+	
+	class Railtie < Rails::Railtie
+		config.to_prepare do
+			ActiveRecord::Base.send :extend, Contentable::Hook
+		end
+		initializer "contentable.initialize" do |app|
+
+		end
+	end
+	
+	# Extends ActiveRecord::Base in order to grant it's decendents
+	# the acts_as_hook
+	module Hook
+		def acts_as_contentable
+			self.send :include, Model
+			ActiveRecord::Migration.extend MigrationHelper
+		end
+	end
+	
+	# Gets auto included in your ApplicationHelper when you include the
+	# Model module in the model class
+	module Helpers
+		def display_textile(text)
+			RedCloth.new(text).to_html
+		end
+		def display_content(content_item, edit = false)
+			html = display_textile(content_item.text)
+			if edit
+				edit_path = content_item.missing ? new_content_item_path(:title => content_item.missing) : edit_content_item_path(content_item)
+				html += "<p>#{link_to("Edit Content", edit_path)}</p> " 
+			end
+			return html
+		end
+	end
+	
+	# Once included in your model (which at least as of now should be named
+	# ContentItem) you get class method safe_find_by_title which lets you
+	# search for a ContentItem using a specific title and if it can't find
+	# it it presents a default content content_item.
+	module Model
+		def self.included(model)
+			model.extend ClassMethods
+			model.send :attr_accessor, :missing
+			model.validates_uniqueness_of :title
+			ActionView::Base.send :include, Helpers
+		end
+		module ClassMethods
+			def safe_find_by_name(name)
+				found_by_name = find_by_title(name)
+				if found_by_name
+					return found_by_name
+				else
+					content_missing = find_or_create_by_name(:name => "content_missing", :title => "Content Missing", :description => "This is the display page returned when there is no content found that matches a particular name.", :text => "This content has yet to be created.")
+					# This lets the content_missing content item know what 
+					# name was requested so that one can ask it for the 
+					# name and create a new content item with that name.
+					content_missing.missing = name
+					return content_missing
+				end
+			end
+		end
+	end
+	
+	# After includng this module in the ContentItem, take the
+	# @content_item assignments as these will be set up for you
+	# with the before filter. Or, alternatively, make a call to
+	# find_content_item yourself.
+	module Controller
+		# Sets up before filter for us.
+		def self.included(controller)
+			controller.before_filter :find_content_item
+		end
+		private
+		# This method can be used as a controller helper mehtod to be
+		# used in a before filter
+		def find_content_item
+			if params[:id]
+				@content_item = ContentItem.find(params[:id])
+			elsif params[:name]
+				@content_item = ContentItem.safe_find_by_name(params[:name])
+				@missing = @content_item.missing
+			else
+				@content_item = ContentItem.safe_find_by_name("content_missing")
+			end
+		end
+	end
+	
+	# This module gives us some migration helpers that let us easily
+	# create the fields necessary for content items. We are switching
+	# this so that title can contain title information to show up in
+	# the resulting document title, while path is where you go to get
+	# there.
+	#
+	# This doesn't work yet - might want to consider scrapping it for
+	# now, but it would be good to have later. When we do that, we should
+	# make it model name agnostic...
+	module MigrationHelper
+		def create_content_items
+			create_table :content_items do |t|
+				t.string :name
+				t.string :title
+				t.string :description
+				t.text :text
+				
+				t.timestamps
+			end
+		end
+		
+		def drop_content_items
+			drop_table :content_items
+		end
+	end
+	
+end

data/lib/version.rb

@@ -0,0 +1,4 @@
+module Contentable
+	version_filename = File.join(File.dirname(__FILE__), "/../VERSION" )
+	VERSION =  File.read(version_filename)
+end

data/spec/rails3/Gemfile

@@ -0,0 +1,37 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.2'
+
+gem 'rspec'
+gem 'rspec-rails'
+gem 'ruby-debug'
+
+gem "contentable", :path => "../.."
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3-ruby', :require => 'sqlite3'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end