markdown_preview 0.1.2

data/.gitignore

@@ -0,0 +1,48 @@
+config/database.yml
+log/*.log*
+log/*.pid
+log/restart.txt
+tmp/**/*
+tmp
+bin/*
+db/*.sqlite3
+db/schema.rb
+db/access_logs
+*.swp
+*.swo
+*.swn
+coverage
+public/system
+public/dgweb
+public/assets
+public/css
+public/jscripts
+Thumbs.db
+scratch_directory
+mkmf.log
+
+# Other useful tidbit
+.DS_Store
+doc/api
+doc/app
+doc/plugins
+coverage
+*~
+
+.bundle
+
+rerun.txt
+
+db/dumps/**/*
+
+config/settings/locals.rb
+
+# For sphinx.
+db/sphinx/*
+config/*.sphinx.conf
+log/searchd.*.pid
+
+config/initializers/rails_asset_id.rb
+app/views/dgnetwork/logged_in_index.html_bak.erb
+app/views/feeds/_feed_item_grouping.html_bak.erb
+app/views/about_us/contact_us.html copy.erb

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Jeff McFadden
+
+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.md

@@ -0,0 +1,60 @@
+# Markdown Preview for Rails
+
+This gem gives you instant markdown preview for any textarea you want, anywhere in your application.
+
+## Installation
+
+1. Add to your Gemfile:
+
+    `gem 'markdown_preview', :git => 'git://github.com/jeffmcfadden/markdown_preview', :tag => '0.1.1'`
+
+2. Run the Rake task:
+
+    `rake markdown_preview:install`
+
+3. Add helper to any controllers you want to use markdown_preview with:
+
+    ```ruby
+      class MyController < ApplicationController
+      
+       uses_markdown_preview
+    ```
+
+4. Add the helper tag to your base layout:
+
+    ```html
+    <!-- Note, jQuery include *required* above this line. -->
+    <%= include_markdown_preview_if_needed %>
+    ```
+
+5. (Optional) If you want to override the preprocessor then add the following to `config/initializers/markdown_preview.rb`
+
+    ```ruby
+    module MarkdownPreview
+     
+      #Write your own preprocessor here if you want to
+      #the md param is the incoming markdown text, before it has been processed
+      def self.preprocess_markdown( md )
+        md 
+      end
+    
+    end
+    ```
+   
+6. Add the `markdown_preview` class to any textareas you want to be previewable, and you're good to go!
+
+    ```html
+    <textarea class="markdown_preview" id="my_awesome_textarea"></textarea>
+    ``` 
+
+
+## Issues
+
+https://github.com/jeffmcfadden/markdown_preview/issues
+
+## Credits
+
+Jeff McFadden
+
+Desiring God Ministries
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the markdown_preview gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/app/controllers/markdown_preview_controller.rb

@@ -0,0 +1,14 @@
+class MarkdownPreviewController < ApplicationController
+
+  def convert
+    markdown = RDiscount.new( MarkdownPreview.preprocess_markdown( params[:markdown_text] ) )
+
+    html = markdown.to_html
+
+    respond_to do |format|
+      format.json { render :json => { :html => html } }
+    end
+  end
+
+end
+

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do |map|
+  post "markdown_preview/convert" => "markdown_preview#convert"
+end

data/lib/markdown_preview.rb

@@ -0,0 +1,125 @@
+# Require all the necessary files to run MarkdownPreview
+require 'markdown_preview/base'
+require 'markdown_preview/exceptions'
+require 'markdown_preview/configuration'
+require 'markdown_preview/helpers'
+
+module MarkdownPreview
+  def self.initialize
+    return if @intialized
+    raise "ActionController is not available yet." unless defined?(ActionController)
+    ActionController::Base.send(:include, MarkdownPreview::Base)
+    ActionController::Base.send(:helper, MarkdownPreview::Helpers)
+    #MarkdownPreview.install_or_update_markdown_preview
+    @intialized = true
+  end
+
+  #Override this is a config somewhere if you want to preprocess your incoming
+  #markdown string. i.e. add a custom tag or something.
+  def self.preprocess_markdown( markdown )
+    markdown
+  end
+
+  def self.install_or_update_markdown_preview
+    require 'fileutils'
+    orig = File.join(File.dirname(__FILE__), 'markdown_preview', 'assets', 'markdown_preview')
+    dest = File.join(Rails.root.to_s, 'public', 'javascripts', 'markdown_preview')
+    markdown_preview_js = File.join(dest, 'markdown_preview.js')
+
+    unless File.exists?(markdown_preview_js) && FileUtils.identical?(File.join(orig, 'markdown_preview.js'), markdown_preview_js)
+      if File.exists?(markdown_preview_js)
+        # upgrade
+        begin
+          puts "Removing directory #{dest}..."
+          FileUtils.rm_rf dest
+          puts "Creating directory #{dest}..."
+          FileUtils.mkdir_p dest
+          puts "Copying MarkdownPreview to #{dest}..."
+          FileUtils.cp_r "#{orig}/.", dest
+          puts "Successfully updated MarkdownPreview."
+        rescue
+          puts 'ERROR: Problem updating MarkdownPreview. Please manually copy '
+          puts orig
+          puts 'to'
+          puts dest
+        end
+      else
+        # install
+        begin
+          puts "Creating directory #{dest}..."
+          FileUtils.mkdir_p dest
+          puts "Copying MarkdownPreview to #{dest}..."
+          FileUtils.cp_r "#{orig}/.", dest
+          puts "Successfully installed MarkdownPreview."
+        rescue
+          puts "ERROR: Problem installing MarkdownPreview. Please manually copy "
+          puts orig
+          puts "to"
+          puts dest
+        end
+      end
+    end
+
+
+
+    orig = File.join(File.dirname(__FILE__), 'markdown_preview', 'assets', 'markdown_preview')
+    dest = File.join(Rails.root.to_s, 'public', 'stylesheets', 'markdown_preview')
+    markdown_preview_css = File.join(dest, 'markdown_preview.css')
+
+    unless File.exists?(markdown_preview_css) && FileUtils.identical?(File.join(orig, 'markdown_preview.css'), markdown_preview_css)
+      if File.exists?(markdown_preview_css)
+        # upgrade
+        begin
+          puts "Removing directory #{dest}..."
+          FileUtils.rm_rf dest
+          puts "Creating directory #{dest}..."
+          FileUtils.mkdir_p dest
+          puts "Copying MarkdownPreview to #{dest}..."
+          FileUtils.cp_r "#{orig}/.", dest
+          puts "Successfully updated MarkdownPreview."
+        rescue
+          puts 'ERROR: Problem updating MarkdownPreview. Please manually copy '
+          puts orig
+          puts 'to'
+          puts dest
+        end
+      else
+        # install
+        begin
+          puts "Creating directory #{dest}..."
+          FileUtils.mkdir_p dest
+          puts "Copying MarkdownPreview to #{dest}..."
+          FileUtils.cp_r "#{orig}/.", dest
+          puts "Successfully installed MarkdownPreview."
+        rescue
+          puts "ERROR: Problem installing MarkdownPreview. Please manually copy "
+          puts orig
+          puts "to"
+          puts dest
+        end
+      end
+    end
+    
+
+  
+  
+  end
+
+  module Base
+  end
+
+  class Engine < Rails::Engine
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      #Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*.rb")) do |c|
+      # Rails.env.production? ? require(c) : load(c)
+      #end
+
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end
+      
+MarkdownPreview.initialize

data/lib/markdown_preview/assets/markdown_preview/markdown_preview.css

@@ -0,0 +1,69 @@
+    .markdown_wrap{
+      border: 2px solid #CCC;
+      -webkit-border-radius: 3px;
+      -moz-border-radius: 3px;
+      border-radius: 3px;
+    }
+
+    .markdown_wrap textarea{
+      width: 100%;
+    }
+
+    .markdown_wrap_menu{
+      height: 1.5em;
+      background-color: #CCC;
+      margin: 0px;
+      padding: 2px;
+    }
+
+    .markdown_wrap_help{
+      background-color: #AAA;
+      padding: 3px;
+      display: none;
+    }
+
+    .markdown_wrap_content{
+      padding: 2px;
+    }
+
+    .markdown_wrap_menu div{
+      font-size: 80%;
+      color: #222;
+
+      float: left;
+      margin-right: 1em;
+      border: 1px solid #888;
+      padding: 2px;
+      -webkit-border-radius: 2em;
+      -moz-border-radius: 2em;
+      border-radius: 2em;
+      
+      padding-left: 10px;
+      padding-right: 10px;
+      text-align: center;
+
+    }
+
+    .markdown_wrap_menu .markdown_wrap_menu_help{
+      float: right;
+    }
+    
+    .markdown_wrap.editing .markdown_wrap_menu_preview, .markdown_wrap.previewing .markdown_wrap_menu_edit, .markdown_wrap_menu_help{
+      background-color: none;
+      border: 1px solid #888;
+    }
+
+    .markdown_wrap.editing .markdown_wrap_menu_edit, .markdown_wrap.previewing .markdown_wrap_menu_preview, .markdown_wrap.helping .markdown_wrap_menu_help{
+      background-color: #EEE;
+      border-top: 1px solid #444;
+      border-bottom: 1px solid #BBB;
+    }
+    
+    .markdown_wrap_menu_edit, .markdown_wrap_menu_preview, .markdown_wrap_menu_help{
+      cursor: pointer;
+    }
+
+    .markdown_wrap_preview{
+      display: none;
+    }
+

data/lib/markdown_preview/assets/markdown_preview/markdown_preview.js

@@ -0,0 +1,140 @@
+    (function( $ ){
+
+      $.fn.markdownPreview = function( type ) {  
+
+        return this.each(function() {
+
+          var $this = $(this);
+
+          $this.wrap( '<div class="markdown_wrap editing"></div>' );
+
+          $this.before( '<div class="markdown_wrap_menu"><div class="markdown_wrap_menu_help">Help</div><div class="markdown_wrap_menu_edit">Write</div><div class="markdown_wrap_menu_preview">Preview</div></div>' );
+
+          var help_text = [
+'<div class="content cheatsheet">',
+  '<h2>Markdown Cheat Sheet</h2>',
+  '<div class="cheatsheet-content">',
+  '<div class="mod">',
+    '<div class="col">',
+      '<h3>Format Text</h3>',
+      '<p>Headers</p>',
+      '<pre># This is an &lt;h1&gt; tag',
+'## This is an &lt;h2&gt; tag',
+'###### This is an &lt;h6&gt; tag</pre>',
+'    <p>Text styles</p>',
+'    <pre>*This text will be italic*',
+'_This will also be italic_',
+'**This text will be bold**',
+'__This will also be bold__',
+'',
+'*You **can** combine them*',
+'</pre>',
+    '</div>',
+    '<div class="col">',
+      '<h3>Lists</h3>',
+      '<p>Unordered</p>',
+      '<pre>* Item 1',
+'* Item 2',
+'  * Item 2a',
+'  * Item 2b</pre>',
+'     <p>Ordered</p>',
+'     <pre>1. Item 1',
+'2. Item 2',
+'3. Item 3',
+'   * Item 3a',
+'   * Item 3b</pre>',
+    '</div>',
+    '<div class="col">',
+      '<h3>Miscellaneous</h3>',
+      '<p>Images</p>',
+      '<pre>![GitHub Logo](/images/logo.png)',
+'Format: ![Alt Text](url)',
+'</pre>',
+     '<p>Links</p>',
+     '<pre>http://github.com - automatic!',
+'[GitHub](http://github.com)</pre>',
+'<p>Blockquotes</p>',
+     '<pre>As Kanye West said:',
+'&gt; We\'re living the future so',
+'&gt; the present is our past.',
+'</pre>',
+    '</div>',
+  '</div>',
+  '<div class="rule"></div>',
+  '</div>',
+  '</div>' ].join( "\n" );
+          
+          
+          $this.before( '<div class="markdown_wrap_help">' + help_text + '</div>' );
+
+          $this.wrap( '<div class="markdown_wrap_content"></div>' );
+          $this.after( '<div class="markdown_wrap_preview"></div>' );
+          
+          $this.wrap( '<div class="markdown_wrap_editor"></div>' );
+            
+          /*
+          if ( !type || type == 'width' ) {
+            $this.width( $this.width() );
+          }
+
+          if ( !type || type == 'height' ) {
+            $this.height( $this.height() );
+          }*/
+
+        });
+
+      };
+
+      $( '.markdown_wrap_menu_help' ).live( 'click', function(){
+        //console.log( 'Clicked Help' );
+        $( this ).closest( '.markdown_wrap' ).toggleClass( 'helping' );
+        
+        $( this ).closest( '.markdown_wrap' ).find( '.markdown_wrap_help' ).slideToggle( 'fast' );
+      });
+
+      $( '.markdown_wrap_menu_edit' ).live( 'click', function(){
+        //console.log( 'Clicked Edit' );
+        $( this ).closest( '.markdown_wrap' ).removeClass( 'previewing' ).addClass( 'editing' );
+
+        $( this ).closest( '.markdown_wrap' ).find( '.markdown_wrap_preview' ).hide();
+        $( this ).closest( '.markdown_wrap' ).find( '.markdown_wrap_editor' ).show();
+      });
+      
+      $( '.markdown_wrap_menu_preview' ).live( 'click', function(){
+        //console.log( 'Clicked Preview' );
+        $( this ).closest( '.markdown_wrap' ).removeClass( 'editing' ).addClass( 'previewing' );
+
+        var editor  = $( this ).closest( '.markdown_wrap' ).find( '.markdown_wrap_editor' );
+        var preview = $( this ).closest( '.markdown_wrap' ).find( '.markdown_wrap_preview' );
+
+        preview.html( 'Loading...' );
+
+        editor.hide();
+        preview.show();
+
+        var editor_content = editor.find( 'textarea' ).val();
+
+        $.ajax({
+          type: 'POST',
+          url: '/markdown_preview/convert',
+          data: 'format=json&markdown_text=' + editor_content,
+          success: function( data, textStatus, jqXHR ){
+            preview.html( data['html'] );
+          },
+          error: function(jqXHR, textStatus, errorThrown){
+            //console.log( "ERROR" );
+            //console.log( jqXHR );
+            //console.log( textStatus );
+            //console.log( errorThrown );
+          },
+          dataType: 'text json' 
+        });
+        
+      });
+    })( jQuery );
+
+
+    $( document ).ready( function(){
+      $( '.markdown_preview' ).markdownPreview();
+    });
+

data/lib/markdown_preview/base.rb

@@ -0,0 +1,29 @@
+module MarkdownPreview 
+  # The base module we include into ActionController::Base
+  module Base
+    # When this module is included, extend it with the available class methods
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # The controller declaration to enable markdown_preview certain actions.
+      # Takes options hash, raw_options string, and any normal params you
+      # can send to a before_filter (only, except etc)
+      def uses_markdown_preview(options = {})
+        configuration = MarkdownPreview::Configuration.new(options.delete(:options), options.delete(:raw_options))
+        
+        # Set instance vars in the current class
+        proc = Proc.new do |c|
+          configurations = c.instance_variable_get(:@markdown_preview_configurations) || []
+          configurations << configuration
+          c.instance_variable_set(:@markdown_preview_configurations, configurations)
+          c.instance_variable_set(:@uses_markdown_preview, true)
+        end
+
+        # Run the above proc before each page load this method is declared in
+        before_filter(proc, options)
+      end
+    end
+  end
+end

data/lib/markdown_preview/configuration.rb

@@ -0,0 +1,5 @@
+module MarkdownPreview
+  class Configuration
+
+  end
+end

data/lib/markdown_preview/exceptions.rb

@@ -0,0 +1,14 @@
+module MarkdownPreview 
+  # Setup a couple of Exception classes that we use later on
+  class MarkdownPreviewInvalidOption < Exception
+    def self.invalid_option(option)
+      new "Invalid option #{option} passed to MarkdownPreview"
+    end
+  end
+
+  class MarkdownPreviewInvalidOptionType < Exception
+    def self.invalid_type_of(value, parameters={})
+      new "Invalid value of type #{value.class} passed for MarkdownPreview option #{parameters[:for].to_s}"
+    end
+  end
+end

data/lib/markdown_preview/helpers.rb

@@ -0,0 +1,29 @@
+module MarkdownPreview
+  # The helper module we include into ActionController::Base
+  module Helpers
+
+    # Has uses_markdown_preview method been declared in the controller for this page?
+    def using_markdown_preview?
+      !@uses_markdown_preview.blank?
+    end
+
+    # Form a JS include tag for the MarkdownPreview JS src for inclusion in the <head>
+    def include_markdown_preview_js
+      #javascript_include_tag (Rails.env.to_s == 'development' ? "markdown_preview/markdown_preview" : "markdown_preview/markdown_preview.min")
+      javascript_include_tag (Rails.env.to_s == 'development' ? "markdown_preview/markdown_preview" : "markdown_preview/markdown_preview")
+    end
+    
+    # Form a JS include tag for the MarkdownPreview JS src for inclusion in the <head>
+    def include_markdown_preview_css
+      stylesheet_link_tag( "markdown_preview/markdown_preview" )
+    end
+
+    # Form a JS include tag for the MarkdownPreview JS src, and form the raw JS and wrap
+    # in in a <script> tag for inclusion in the <head> for inclusion in the <head>
+    def include_markdown_preview_if_needed(options = {}, raw_options = nil)
+      if using_markdown_preview?
+        include_markdown_preview_js + include_markdown_preview_css 
+      end
+    end
+  end
+end

data/lib/tasks/markdown_preview.rake

@@ -0,0 +1,8 @@
+namespace :markdown_preview do
+
+  desc 'Install or update the Markdown Preview sources'
+  task :install => :environment do
+    MarkdownPreview.install_or_update_markdown_preview
+  end
+
+end

data/markdown_preview.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'markdown_preview'
+  s.version     = '0.1.2'
+  s.authors = ["Jeff McFadden"]
+  s.email = "jeff.mcfadden@gmail.com"
+  s.homepage = "http://github.com/jeffmcfadden/markdown_preview"
+  s.summary = "Markdown Preview of any textarea editor for your rails applications."
+  s.description = "Gem that allows easy preview of your textarea content as markdown."
+  
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency('rdiscount')
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../../test/test_helper")
+
+# Use non-default action names to get around possible authentication
+# filters to ensure the tests work in most cases
+module TinyMCEActions
+  def new_page
+    render :text => 'Hello'
+  end
+  def edit_page
+    render :text => 'Hello'
+  end
+  def show_page
+    render :text => 'Hello'
+  end
+end
+
+class TestController
+  def self.helper(s) s; end
+end
+
+def set_constant(constant, value)
+  if respond_to?(:silence_warnings)
+    silence_warnings do
+      Object.send(:remove_const, constant) if Object.const_defined?(constant)
+      Object.const_set(constant, value)
+    end
+  else
+    Object.send(:remove_const, constant) if Object.const_defined?(constant)
+    Object.const_set(constant, value)
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: markdown_preview
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Jeff McFadden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Gem that allows easy preview of your textarea content as markdown.
+email: jeff.mcfadden@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/markdown_preview_controller.rb
+- config/routes.rb
+- lib/markdown_preview.rb
+- lib/markdown_preview/assets/markdown_preview/markdown_preview.css
+- lib/markdown_preview/assets/markdown_preview/markdown_preview.js
+- lib/markdown_preview/base.rb
+- lib/markdown_preview/configuration.rb
+- lib/markdown_preview/exceptions.rb
+- lib/markdown_preview/helpers.rb
+- lib/tasks/markdown_preview.rake
+- markdown_preview.gemspec
+- test/test_helper.rb
+homepage: http://github.com/jeffmcfadden/markdown_preview
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Markdown Preview of any textarea editor for your rails applications.
+test_files: 
+- test/test_helper.rb