radiant-markdown_filter-extension 1.0.0

data/README

@@ -0,0 +1 @@
+Adds support for Markdown!

data/Rakefile

@@ -0,0 +1,120 @@
+# I think this is the one that should be moved to the extension Rakefile template
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+# require 'spec/translator'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the <%= file_name %> extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = '<%= class_name %>'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the <%= file_name %> extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/lib/markdown_filter.rb

@@ -0,0 +1,6 @@
+class MarkdownFilter < TextFilter
+  description_file File.dirname(__FILE__) + "/../markdown.html"
+  def filter(text)
+    BlueCloth.new(text, :smartypants => true).to_html
+  end
+end

data/lib/markdown_tags.rb

@@ -0,0 +1,18 @@
+module MarkdownTags
+  include Radiant::Taggable
+
+  desc %{
+    Filters its contents with the Markdown filter.
+
+    *Usage:*
+
+    <pre><code><r:markdown>** bold text **</r:markdown></code></pre>
+
+    produces
+
+    <pre><code><strong> bold text </strong></code></pre>
+  }
+  tag 'markdown' do |tag|
+    MarkdownFilter.filter(tag.expand)
+  end
+end

data/lib/radiant-markdown_filter-extension/version.rb

@@ -0,0 +1,4 @@
+module RadiantMarkdownFilterExtension
+  VERSION = "1.0.0"
+end
+  

data/lib/radiant-markdown_filter-extension.rb

@@ -0,0 +1,3 @@
+module RadiantMarkdownFilterExtension
+end
+  

data/lib/tasks/markdown_filter_extension_tasks.rake

@@ -0,0 +1,28 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :markdown_filter do
+      
+      desc "Runs the migration of the Markdown Filter extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          MarkdownFilterExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          MarkdownFilterExtension.migrator.migrate
+        end
+      end
+      
+      desc "Copies public assets of the Markdown Filter to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        Dir[MarkdownFilterExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(MarkdownFilterExtension.root, '')
+          directory = File.dirname(path)
+          puts "Copying #{path}..."
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end  
+    end
+  end
+end

data/markdown.html

@@ -0,0 +1,123 @@
+<p>Many people prefer <a href="http://daringfireball.net/projects/markdown/" target="_blank">Markdown</a>
+  over standard HTML because it is less verbose. Unlike Textile, Markdown
+  doesn&#8217;t try to replicate all of the features implemented by regular
+  HTML, instead it encourages the use of inline HTML. Markdown is very similar
+  to the formatting used in a standard plain-text e-mail. This filter also uses
+  <a href="http://daringfireball.net/projects/smartypants/" target="_blank">SmartyPants</a>
+  to curl quotes and insert correct punctuation.</p>
+  
+<table id="filter-reference-table">
+  <thead>
+    <tr>
+      <th>To see this:</th>
+      <th>Type this:</th>
+    <tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><strong>bold</strong></td>
+      <td><pre>**bold**</pre></td>
+    </tr>
+    <tr>
+      <td><em>italics</em></td>
+      <td><pre>_italics_</pre></td>
+    </tr>
+    <tr>
+      <td><del>strikethrough</del></td>
+      <td><pre>&lt;del&gt;strikethrough&lt;/del&gt;</pre></td>
+    </tr>
+    <tr>
+      <td>x<sup>superscript</sup></td>
+      <td><pre>x&lt;sup&gt;superscript&lt;/sup&gt;</pre></td>
+    </tr>
+    <tr>
+      <td>a<sub>subscript</sub></td>
+      <td><pre>a&lt;sub&gt;subscript&lt;/sub&gt;</pre></td>
+    </tr>
+    <tr>
+      <td><code>code phrase</code></td>
+      <td><pre>`code phrase`</pre></td>
+    </tr>
+    <tr>
+      <td>link to <a href="http://radiantcms.org">Radiant CMS</a></td>
+      <td><pre>link to [Radiant CMS](http://radiantcms.org)</pre></td>
+    </tr>
+    <tr>
+      <td><acronym title="Just Another Acronym">JAA</acronym></td>
+      <td><pre>&lt;acronym title="Just Another Acronym"&gt;JAA&lt;/acronym&gt;</td>
+    </tr>
+    <tr>
+      <td><span style="color:red">Red Text</span></td>
+      <td><pre>&lt;span style="color:red"&gt;Red Text&lt;/span&gt;</pre></td>
+    </tr>
+    <tr>
+      <td>
+        <p>A bulleted list:</p>
+        <ul>
+          <li>item one</li>
+          <li>item two</li>
+          <li>item three</li>
+        </ul>
+      </td>
+      <td>
+<pre>A bulleted list:
+* item one
+* item two
+* item three</pre>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p>A numbered list:</p>
+        <ol>
+          <li>item one</li>
+          <li>item two</li>
+          <li>item three</li>
+        </ol>
+      </td>
+      <td>
+<pre>A numbered list:
+1. item one
+2. item two
+3. item three</pre>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <h1>Heading 1</h1>
+        <h2>Heading 2</h2>
+        <h3>Heading 3</h3>
+        <h4>Heading 4</h4>
+      </td>
+      <td>
+<pre>Heading 1
+---------
+
+Heading 2
+=========
+
+### Heading 3
+
+#### Heading 4</pre>
+      </td>
+    </tr>
+    <tr>
+      <td><blockquote>Roses are red, violets are blue, Markdown is nice, and so are you!</blockquote></td>
+      <td>
+<pre>&gt; Roses are red,
+&gt; violets are blue,
+&gt; Markdown is nice,
+&gt; and so are you!</pre>
+    </tr>
+    <tr>
+      <td><img src="/../images/radiant/radiant-badge-color.png" alt="" /></td>
+      <td><pre>![alt text](/images/radiant/radiant-badge-color.png)</pre></td>
+    </tr>
+  </tbody>
+</table>
+
+<p>Advanced users may want to play around with the
+  <a href="http://daringfireball.net/projects/markdown/dingus/" target="_blank">Markdown
+  Dingus</a> or review the
+  <a href="http://daringfireball.net/projects/markdown/syntax/" target="_blank">official Markdown
+  Reference</a>.</p>

data/markdown_filter_extension.rb

@@ -0,0 +1,12 @@
+require "bluecloth"
+
+class MarkdownFilterExtension < Radiant::Extension
+  version "1.0.0"
+  description "Allows you to compose page parts or snippets using the Markdown text filter."
+  url "http://daringfireball.net/projects/markdown/"
+
+  def activate
+    MarkdownFilter
+    Page.send :include, MarkdownTags
+  end
+end

data/radiant-markdown_filter-extension.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-markdown_filter-extension/version"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-markdown_filter-extension"
+  s.version     = RadiantMarkdownFilterExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Radiant CMS Dev Team"]
+  s.email       = ["radiant@radiantcms.org"]
+  s.homepage    = "http://radiantcms.org/"
+  s.summary     = %q{Markdown Filter for Radiant CMS}
+  s.description = %q{Allows you to compose page parts or snippets using the Markdown text filter.}
+
+  ignores = if File.exist?(".gitignore")
+    File.read(".gitignore").split("\n").inject([]) {|a,p| a + Dir[p] }
+  else
+    []
+  end
+  s.files         = Dir["**/*"] - ignores
+  s.test_files    = Dir["test/**/*","spec/**/*","features/**/*"] - ignores
+  s.require_paths = ["lib"]
+
+  s.add_dependency "bluecloth", "~> 2.1.0"
+
+  s.post_install_message = %{
+  Add this to your radiant project with:
+    config.gem "radiant-markdown_filter-extension", :version => "~> #{RadiantMarkdownFilterExtension::VERSION}"
+  }
+end

data/spec/models/markdown_filter_spec.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe MarkdownFilter do
+  it "should be named Markdown" do
+    MarkdownFilter.filter_name.should == "Markdown"
+  end
+
+  it "should filter text according to Markdown rules" do
+    MarkdownFilter.filter('**strong**').should =~ %r{<p><strong>strong</strong></p>}
+  end
+
+  it "should filter text with quotes into smart quotes" do
+    MarkdownFilter.filter("# Radiant's \"filters\" rock!").should =~ %r{<h1>Radiant&(#8217|rsquo);s &(#8220|ldquo);filters&(#8221|rdquo); rock!</h1>}
+  end
+end
+
+describe "<r:markdown>" do
+  dataset :pages
+  it "should filter its contents with Markdown" do
+    pages(:home).should render("<r:markdown>* item</r:markdown>").matching(%r{<ul>\n(\s+)?<li>item<\/li>\n<\/ul>\n(\n)?})
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'test/unit'
+# Load the environment
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/test/test_helper"
+
+class Test::Unit::TestCase
+  self.use_transactional_fixtures = true
+  self.use_instantiated_fixtures = false
+end

data/test/unit/markdown_filter_test.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class MarkdownFilterTest < Test::Unit::TestCase
+
+  def test_filter_name
+    assert_equal 'Markdown', MarkdownFilter.filter_name
+  end
+
+  def test_filter
+    assert_equal '<p><strong>strong</strong></p>', MarkdownFilter.filter('**strong**')
+  end
+  
+  def test_filter_with_quotes
+    assert_equal "<h1>Radiant&#8217;s &#8220;filters&#8221; rock!</h1>", 
+      MarkdownFilter.filter("# Radiant's \"filters\" rock!")
+  end
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-markdown_filter-extension
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Radiant CMS Dev Team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  version_requirements: *id001
+description: Allows you to compose page parts or snippets using the Markdown text filter.
+email: 
+- radiant@radiantcms.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/markdown_filter.rb
+- lib/markdown_tags.rb
+- lib/radiant-markdown_filter-extension/version.rb
+- lib/radiant-markdown_filter-extension.rb
+- lib/tasks/markdown_filter_extension_tasks.rake
+- markdown.html
+- markdown_filter_extension.rb
+- radiant-markdown_filter-extension.gemspec
+- Rakefile
+- README
+- spec/models/markdown_filter_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- test/test_helper.rb
+- test/unit/markdown_filter_test.rb
+has_rdoc: true
+homepage: http://radiantcms.org/
+licenses: []
+
+post_install_message: "\n  Add this to your radiant project with:\n    config.gem \"radiant-markdown_filter-extension\", :version => \"~> 1.0.0\"\n  "
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Markdown Filter for Radiant CMS
+test_files: 
+- test/test_helper.rb
+- test/unit/markdown_filter_test.rb
+- spec/models/markdown_filter_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb