has_markup 0.1.5

data/.gitignore

@@ -0,0 +1,4 @@
+test/*.log
+rdoc
+*.swp
+*.swo

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Josh Nichols
+
+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

@@ -0,0 +1,42 @@
+= HasMarkup
+
+I don't know about you, but I'm not too much of a fan of writing out raw HTML when I'm trying to belt out some blog posts. Keeping track of those pesky closing tags, escaping entities, and so on, can really get in the way of your creativity.
+
+As a result, most blogs provide a simplified markup or some sort of editor. For technicalpickles.com[http://technicalpickles.com], I went with markdown[http://daringfireball.net/projects/markdown/].
+
+I extracted this markup magic out of my blog, and this plugin is the result. It lets you:
+
+ * Specify a column contains markup
+ * Specify the syntax (markdown and textile, with markdown being the default)
+ * Specify if the markup column is required
+ * Generate a helper for generating the HTML
+ * Specify if the HTML should be cached in the database
+ * ... all using only one line
+
+== Example
+
+In your model:
+
+  class Post
+    has_markup :content, :syntax => :markdown, :required => true, :cache_html => true
+  end
+  
+Now post will have a 'content_html' method for generating the
+
+So, you can use it in your view:
+
+  <h2><%= h @post.title %></h2>
+  <div>
+    <%= @post.cached_content_html %>
+  </div>
+
+And you can test it easily using Shoulda:
+
+  require 'has_markup/shoulda'
+  class PostTest < Test::Unit::TestCase
+    should_have_markup :content, :syntax => :markdown, :required => true, :cache_html => true
+  end
+
+== License
+
+Copyright (c) 2008 Josh Nichols, released under the MIT license

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'jeweler'
+Jeweler::Tasks.new do |s|
+  s.name = "has_markup"
+  s.summary = "Manage markup close to home... right in the model! Caching, validation, etc"
+  s.email = "josh@technicalpickles.com"
+  s.authors = ["Josh Nichols"]
+  s.homepage = "http://github.com/technicalpickles/has_markup"
+  s.description = "Manage markup close to home... right in the model! Caching, validation, etc"
+  s.version = "0.1.5"
+  s.files.exclude('vendor/**/*')
+end
+Jeweler::GemcutterTasks.new
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc 'Generate documentation for the safety_valve plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasMarkup'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Run the test suite"
+task :default => :test

data/has_markup.gemspec

@@ -0,0 +1,60 @@
+# 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{has_markup}
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Josh Nichols"]
+  s.date = %q{2010-03-07}
+  s.description = %q{Manage markup close to home... right in the model! Caching, validation, etc}
+  s.email = %q{josh@technicalpickles.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "has_markup.gemspec",
+     "init.rb",
+     "lib/has_markup.rb",
+     "lib/has_markup/active_record.rb",
+     "lib/has_markup/markdown.rb",
+     "lib/has_markup/textile.rb",
+     "lib/has_markup/version.rb",
+     "shoulda_macros/has_markup.rb",
+     "tasks/has_markup_tasks.rake",
+     "test/database.yml",
+     "test/post.rb",
+     "test/post_test.rb",
+     "test/schema.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/technicalpickles/has_markup}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Manage markup close to home... right in the model! Caching, validation, etc}
+  s.test_files = [
+    "test/post.rb",
+     "test/post_test.rb",
+     "test/schema.rb",
+     "test/test_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1,5 @@
+require 'has_markup'
+
+if defined? ThoughtBot::Shoulda
+  require 'has_markup/shoulda'
+end

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
+            record.errors.add column, "has #{e}"
+          end
+        end
+      end
+    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
+            record.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/shoulda_macros/has_markup.rb

@@ -0,0 +1,37 @@
+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_validate_presence_of 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
+
+class Test::Unit::TestCase # :nodoc:
+  extend HasMarkup::Shoulda
+end
+

data/tasks/has_markup_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :has_markup do
+#   # Task goes here
+# 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 { @post = Post.new }
+
+    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,30 @@
+$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'
+require File.dirname(__FILE__) + '/../shoulda_macros/has_markup'
+
+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'
+
+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,82 @@
+--- !ruby/object:Gem::Specification 
+name: has_markup
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 5
+  version: 0.1.5
+platform: ruby
+authors: 
+- Josh Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-07 00:00:00 -05: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: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- has_markup.gemspec
+- init.rb
+- lib/has_markup.rb
+- lib/has_markup/active_record.rb
+- lib/has_markup/markdown.rb
+- lib/has_markup/textile.rb
+- lib/has_markup/version.rb
+- shoulda_macros/has_markup.rb
+- tasks/has_markup_tasks.rake
+- test/database.yml
+- test/post.rb
+- test/post_test.rb
+- test/schema.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/technicalpickles/has_markup
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Manage markup close to home... right in the model! Caching, validation, etc
+test_files: 
+- test/post.rb
+- test/post_test.rb
+- test/schema.rb
+- test/test_helper.rb