technicalpickles-has_markup 0.1.1

data/lib/has_markup.rb

@@ -0,0 +1,2 @@
+require 'has_markup/markdown'
+require 'has_markup/active_record'

data/lib/has_markup/active_record.rb

@@ -0,0 +1,74 @@
+module HasMarkup
+  # Modules to extend ActiveRecord
+  module ActiveRecord #:nodoc:
+    # Methods that are added to ActiveRecord::Base
+    module ClassMethods
+      # Adds the following methods for dealing with markup, using <tt>has_markup :content</tt> as an example:
+      # * <tt>content_html</tt> for generating the html of <tt>:content</tt>.
+      # 
+      # Options are:
+      # * <tt>:required</tt> - column is required
+      # * <tt>:syntax</tt> - syntax of the markup. Currently supports only :markdown, which is the default.
+      # * <tt>:cache_html</tt> - html generated from the markup should be cached in a column. Following the
+      #   example of using <tt>:content</tt>, it would require a column named <tt>:cached_content_html</tt>.
+      #   It also adds a before_save hook <tt>:cache_content_html</tt> for generating the html before saving.
+      #
+      # For adding additional syntaxes, see has_markup/markdown and has_markup/textile. Basically:
+      #
+      # * Create HasMarkup::SyntaxNameHere
+      # * Define sprinkle_syntax_name_here_magic which takes a column name, like <tt>:content</tt>
+      # * In sprinkle_syntax_name_here_magic, create <tt>"#{column}_html"</tt>, which handles the actual generation
+      def has_markup(column, options = {})
+        options = HasMarkup::default_has_markup_options.merge(options)
+        
+        validates_presence_of column if options[:required]
+
+        syntax = options[:syntax]
+        if supported? syntax
+          extend markup_syntax_module(syntax)
+          send("sprinkle_#{syntax}_magic", column)
+        else
+          raise "Unsupported syntax #{syntax.inspect}."
+        end
+        sprinkle_html_caching_magic column if options[:cache_html]
+      end
+      
+      # Is the given syntax supported?
+      def supported?(syntax)
+        begin
+          markup_syntax_module(syntax)
+          return true
+        rescue NameError
+          return false
+        end
+      end
+      
+      def markup_syntax_module(syntax)
+        "HasMarkup::#{syntax.to_s.camelize}".constantize
+      end
+
+      
+      # Sprinkles the magic for caching the html of the given
+      def sprinkle_html_caching_magic(column)
+        define_method "set_cached_#{column}_html" do
+          html = self.send("#{column}_html")
+          self.send("cached_#{column}_html=", html)
+        end
+        before_save "set_cached_#{column}_html".to_sym
+      end
+    end    
+  end
+  
+  def self.default_has_markup_options
+    {
+      :syntax => :markdown,
+      :required => false,
+      :cache_html => false
+    }
+  end
+end
+
+require 'active_record'
+ActiveRecord::Base.class_eval do
+  extend HasMarkup::ActiveRecord::ClassMethods
+end

data/lib/has_markup/markdown.rb

@@ -0,0 +1,38 @@
+module HasMarkup
+  # Provides HasMarkup with markdown[http://daringfireball.net/projects/markdown/] support.
+  module Markdown
+    # Sprinkles the magic needed to support markdown. In particular, it will validate the markdown syntax
+    # on the column, and define a method <tt>column_html</tt> which uses BlueCloth to generate HTML.
+    def sprinkle_markdown_magic(column)
+      require 'bluecloth'
+    
+      extend HasMarkup::Markdown::ClassMethods
+      include HasMarkup::Markdown::InstanceMethods
+    
+      validates_markdown_syntax column
+      define_method "#{column}_html" do
+        markdown = self.send(column)
+        self.generate_html_from_markdown(markdown)
+      end
+    end
+    
+    module InstanceMethods
+      def generate_html_from_markdown(markdown)
+        BlueCloth.new(markdown).to_html unless markdown.blank?
+      end
+    end
+    
+    module ClassMethods
+      # Validates the markdown syntax of the given columns.
+      def validates_markdown_syntax(*columns)
+        validates_each(*columns) do |record, column, value|
+          begin
+            record.generate_html_from_markdown(value)
+          rescue BlueCloth::FormatError => e
+            errors.add column, "has #{e}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/has_markup/shoulda.rb

@@ -0,0 +1,42 @@
+require 'shoulda'
+
+module HasMarkup # :nodoc:
+  # Shoulda macros for has_markup. These get added to <tt>Test::Unit::TestCase</tt>.
+  module Shoulda
+    # Ensure that markup is cached.
+    #
+    #   should_cache_markup :content
+    def should_cache_markup(column)
+      should_have_db_column "cached_#{column}_html"
+      should_have_instance_methods "set_cached_#{column}_html"
+      # TODO test that there's before_save action happening
+    end
+    
+    # Ensure that markup is required.
+    #
+    #   should_require_markup :content
+    def should_require_markup(column)
+      should_require_attributes column
+    end
+    
+    # Ensure that the model has markup. Accepts all the same options that has_markup does.
+    #
+    #   should_have_markup :content
+    def should_have_markup(column, options = {})
+      options = HasMarkup::default_has_markup_options.merge(options)
+      should_have_instance_methods "#{column}_html"
+
+      should_require_markup column if options[:required]
+
+      should_cache_markup column if options[:cache_html]
+    end    
+  end
+end
+
+module Test # :nodoc: all
+  module Unit 
+    class TestCase
+      extend HasMarkup::Shoulda
+    end
+  end
+end

data/lib/has_markup/textile.rb

@@ -0,0 +1,38 @@
+module HasMarkup
+  # Provides HasMarkup with textile[http://hobix.com/textile/] support
+  module Textile
+    # Sprinkles the magic needed to support textile. In particular, it will define a method <tt>column_html</tt> which uses RedCloth to
+    # generate HTML.
+    def sprinkle_textile_magic(column)
+      require 'redcloth'
+    
+      extend HasMarkup::Textile::ClassMethods
+      include HasMarkup::Textile::InstanceMethods
+    
+      validates_textile_syntax column
+      define_method "#{column}_html" do
+        markdown = self.send(column)
+        self.generate_html_from_markdown(markdown)
+      end
+    end
+    
+    module InstanceMethods
+      def generate_html_from_markdown(textile)
+        RedCloth.new(textile).to_html unless textile.blank?
+      end
+    end
+    
+    module ClassMethods
+      # Validates the markdown syntax of the given columns.
+      def validates_textile_syntax(*columns)
+        validates_each(*columns) do |record, column, value|
+          begin
+            record.generate_html_from_markdown(value)
+          rescue e
+            errors.add column, "has #{e}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/has_markup/version.rb

@@ -0,0 +1,7 @@
+module HasMarkup
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 1
+  end
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+plugin_test:
+  adapter: sqlite3
+  database: ':memory:'

data/test/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  has_markup :content, :required => true, :syntax => :markdown, :cache_html => true
+end

data/test/post_test.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class PostTest < Test::Unit::TestCase
+  should_have_markup :content, :required => true, :syntax => :markdown, :cache_html => true
+  
+  context 'A new project without content' do
+    setup do
+      @post = Post.new
+    end
+    
+    context "caching the content, when it's blank" do
+      setup do
+        @post.set_cached_content_html
+      end
+
+      should "not have cached html" do
+        assert_nil @post.cached_content_html
+      end
+    end
+    
+    context "updating the content" do
+      setup do
+        @post.update_attributes(:content => 'hi')
+      end
+
+      should "now have cached html" do
+        assert_equal '<p>hi</p>', @post.cached_content_html
+      end
+    end
+    
+  end
+end

data/test/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :posts, :force => true do |t|
+    t.text :content
+    t.text :cached_content_html
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+
+# Use vendored gem because of limited gem availability on runcoderun
+# This is loosely based on 'vendor everything'.
+Dir[File.join(File.dirname(__FILE__), '..', 'vendor', 'gems', '**')].each do |dir| 
+  lib = "#{dir}/lib"
+  $LOAD_PATH.unshift(lib) if File.directory?(lib)
+end
+
+require 'test/unit'
+require 'active_record'
+require 'shoulda'
+require 'shoulda/active_record'
+require 'factory_girl'
+
+RAILS_ROOT = File.dirname(__FILE__)
+require 'logger'
+RAILS_DEFAULT_LOGGER = Logger.new("#{RAILS_ROOT}/test.log") 
+
+require File.dirname(__FILE__) + '/../init'
+require File.dirname(__FILE__) + '/post.rb'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'plugin_test'])
+
+load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: technicalpickles-has_markup
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Josh Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Manage markup close to home... right in the model! Caching, validation, etc
+email: josh@technicalpickles.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/has_markup
+- lib/has_markup/active_record.rb
+- lib/has_markup/markdown.rb
+- lib/has_markup/shoulda.rb
+- lib/has_markup/textile.rb
+- lib/has_markup/version.rb
+- lib/has_markup.rb
+- test/database.yml
+- test/debug.log
+- test/post.rb
+- test/post_test.rb
+- test/schema.rb
+- test/test.log
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/technicalpickles/has_markup
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Manage markup close to home... right in the model! Caching, validation, etc
+test_files: []
+