markitup 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+*~
+/pkg

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in markitup.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Phil Hofmann
+
+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,34 @@
+Markitup
+========
+
+Rack middleware to inject CSS & Javascript to turn text areas into
+rich text editors using  Jay Salvat's *MarkItUp!*.
+
+It effortlessly integrates with Rails.
+
+Setup
+-----
+
+Put this in your Gemfile.
+
+    gem 'markitup'
+
+And run a couple of rake tasks to get the CSS, Javascript & image
+assets in place.
+
+    rake markitup:install:base
+    rake markitup:install:markdown
+
+Configuration
+-------------
+
+There is no additional configuration needed. However a config file is
+created, which can be customized, if you want to have things
+differently. After the first request, you'll find it here:
+
+    config/markitup.yml
+
+Links
+-----
+
+* http://markitup.jaysalvat.com/home/

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+load 'tasks/markitup.rake'
+
+task :environment do
+end

data/lib/markitup/middleware.rb

@@ -0,0 +1,79 @@
+require 'yaml'
+
+module Markitup
+  class Middleware < Struct.new :app, :options
+
+    def call(env)
+      return app.call(env) unless config['enabled']
+
+      # if env["REQUEST_METHOD"] == "POST"
+      #   return render(:markdown, env) if env["PATH_INFO"] =~ /^\/markitup\/markdown/
+      # end
+
+      status, headers, response = app.call(env)
+      return [ status, headers, response ] unless 
+        headers["Content-Type"] =~ /text\/html|application\/xhtml\+xml/
+
+      body = ""
+      response.each { |part| body << part }
+      return [ status, headers, response ] unless
+        body =~ /#{config['keyword']}/
+
+      index = body.rindex "</head>"
+      if index
+        body.insert index, styles + scripts
+        headers["Content-Length"] = body.length.to_s
+        response = [ body ]
+      end
+      [ status, headers, response ]
+    end
+
+    private
+
+    def default_config
+      File.read(File.expand_path('../../../markitup.yml', __FILE__))
+    end
+
+    def config
+      return @config unless @config.nil?
+      conffile = options[:config]
+      ::File.open(conffile, 'w') { |out| out.puts default_config } unless ::File.exist?(conffile)
+      @config = ::File.open(conffile) { |yf| YAML::load(yf) }
+    end
+
+    def styles
+      template = '<link rel="stylesheet" type="text/css" href="/stylesheets/%s" />'
+      config['stylesheets'].inject('') { |result, file| result + template % file + "\n" }
+    end
+
+    def scripts
+      template = '<script type="text/javascript" src="/javascripts/%s"></script>'
+      config['javascripts'].inject('') { |result, file| result + template % file + "\n" } + init
+    end
+
+    def init
+      <<-EOB
+        <script type="text/javascript">
+          $(document).ready(function() {
+            $("textarea.#{ config['keyword'] }").markItUp(#{ settings });
+          });
+        </script>
+      EOB
+    end
+
+    def settings
+      return 'mySettings' if config['settings'].nil? or config['settings'].empty?
+      "mySettings, {" + config['settings'].map { |key, val| "'#{key}':'#{val}'" } * ',' + '}'
+    end
+
+    # def render(format, env)
+    #   case format
+    #   when :markdown
+    #     require 'maruku'
+    #     body = Maruku.new(env['data']).to_html_document
+    #     Rack::Response.new body
+    #   end
+    # end
+
+  end
+end

data/lib/markitup/railtie.rb

@@ -0,0 +1,25 @@
+module Markitup
+  
+  case Rails.version.to_i
+  when 2
+    Rails.configuration.middleware.use Markitup::Middleware,
+      :config => File.expand_path('config/markitup.yml', RAILS_ROOT)
+
+  when 3
+    class Railtie < Rails::Railtie
+      initializer "markitup.insert_middleware" do |app|
+        app.config.middleware.use "Markitup::Middleware",
+        :config => File.expand_path('config/markitup.yml', Rails.root)
+      end
+
+      rake_tasks do
+        load File.expand_path('../../../tasks/markitup.rake', __FILE__)
+      end
+    end
+
+  else
+    raise "Unknown Rails version"
+  end
+
+end
+

data/lib/markitup/version.rb

@@ -0,0 +1,3 @@
+module Markitup
+  VERSION = "0.0.1"
+end

data/lib/markitup.rb

@@ -0,0 +1,3 @@
+require 'markitup/middleware'
+
+require 'markitup/railtie' if defined? Rails

data/markitup.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "markitup/version"
+
+Gem::Specification.new do |s|
+  s.name        = "markitup"
+  s.version     = Markitup::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Phil Hofmann"]
+  s.email       = ["phil@branch14.org"]
+  s.homepage    = "http://branch14.org/markitup"
+  s.summary     = %q{Rack Middleware to turn text areas into rich text editors}
+  s.description = %q{Rack Middleware to turn text areas into rich text editors}
+
+  # s.rubyforge_project = "markitup"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/markitup.yml

@@ -0,0 +1,14 @@
+---
+enabled: true
+keyword: markItUp
+javascripts:
+- markitup/jquery.markitup.js
+- markitup/sets/default/set.js   
+#- markitup/markdown/set.js
+stylesheets:
+- markitup/skins/markitup/style.css
+- markitup/sets/default/style.css
+#- markitup/markdown/style.css
+settings:
+  previewParserPath: /markitup/markdown
+

data/tasks/markitup.rake

@@ -0,0 +1,30 @@
+namespace :markitup do
+  namespace :install do
+    task :setup => :environment do
+      ROOT=(defined?(RAILS_ROOT)) ? RAILS_ROOT : Rails.root
+      PRE=File.join('lib', 'markitup')
+      DST=File.join(ROOT, PRE)
+      directory DST
+    end
+
+    desc "fetches basic assets"
+    task :base => :setup do
+      PKG='latest'
+      SRC="http://markitup.jaysalvat.com/downloads/download.php?id=releases/#{PKG}"
+      sh "wget -O #{DST}/#{PKG}.zip '#{SRC}'"
+      sh "unzip -foq #{DST}/#{PKG}.zip -d #{DST}"
+      sh "ln -sf ../../#{PRE}/#{PKG}/markitup public/javascripts"
+      sh "ln -sf ../../#{PRE}/#{PKG}/markitup public/stylesheets"
+      sh "ln -sf ../../#{PRE}/#{PKG}/markitup public/images"
+    end
+
+    desc "fetches markdown assets"
+    task :markdown => :setup do
+      PKG='markdown'
+      SRC="http://markitup.jaysalvat.com/downloads/download.php?id=markupsets/#{PKG}"
+      sh "wget -O #{DST}/#{PKG}.zip '#{SRC}'"
+      sh "unzip -foq #{DST}/#{PKG}.zip -d #{DST}"
+      sh "ln -sf ../../#{PKG} #{DST}/latest/markitup"
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'markitup'
+
+class Test::Unit::TestCase
+end

data/test/test_markitup.rb

@@ -0,0 +1,87 @@
+require File.expand_path('../helper', __FILE__)
+require 'rack/mock'
+
+class TestMarkitup < Test::Unit::TestCase
+
+  PAYLOAD = 'jquery.markitup.js'
+
+  context "Embedding Markitup" do
+    should "place the payload at the end of the head section of an HTML request" do
+      assert_match EXPECTED_CODE, request.body
+    end
+
+    should "place the payload at the end of the head section of an XHTML request" do
+      response = request(:content_type => 'application/xhtml+xml')
+      assert_match EXPECTED_CODE, response.body
+    end
+
+    should "not place the payload in an HTML request without target" do
+      response = request(:body => [HTML_WITHOUT_TARGET])
+      assert_no_match EXPECTED_CODE, response.body
+    end
+
+    should "not place the konami code in a non HTML request" do
+      response = request(:content_type => 'application/xml', :body => [XML])
+      assert_no_match EXPECTED_CODE, response.body
+    end
+  end
+
+  private
+
+  EXPECTED_CODE = /#{PAYLOAD}/m
+  
+  HTML_WITH_TARGET = <<-EOHTML
+   <html>
+     <head>
+       <title>Sample Page</title>
+     </head>
+     <body>
+       <h2>Markitup::Middleware Test</h2>
+       <p>This is more test html</p>
+       <textarea class='markItUp'></textarea>
+     </body>
+   </html>
+  EOHTML
+
+  HTML_WITHOUT_TARGET = <<-EOHTML
+   <html>
+     <head>
+       <title>Sample Page</title>
+     </head>
+     <body>
+       <h2>Markitup::Middleware Test</h2>
+       <p>This is more test html</p>
+       <textarea></textarea>
+     </body>
+   </html>
+  EOHTML
+
+  XML = <<-EOXML
+   <?xml version="1.0" encoding="ISO-8859-1"?>
+   <user>
+     <name>Some Name</name>
+     <age>Some Age</age>
+   </user>
+  EOXML
+
+  def request(options={}, path='/')
+    @app = app(options)
+    request = Rack::MockRequest.new(@app).get(path)
+    yield(@app, request) if block_given?
+    request
+  end
+
+  def app(options={})
+    options = options.clone
+    options[:content_type] ||= "text/html"
+    options[:body]         ||= [HTML_WITH_TARGET]
+    rack_app = lambda do |env|
+      [ 200,
+        { 'Content-Type' => options.delete(:content_type) },
+        options.delete(:body) ]
+    end
+    Markitup::Middleware.new(rack_app,
+      :config => File.expand_path('../../markitup.yml', __FILE__))
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: markitup
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Phil Hofmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-11 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Rack Middleware to turn text areas into rich text editors
+email: 
+- phil@branch14.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/markitup.rb
+- lib/markitup/middleware.rb
+- lib/markitup/railtie.rb
+- lib/markitup/version.rb
+- markitup.gemspec
+- markitup.yml
+- tasks/markitup.rake
+- test/helper.rb
+- test/test_markitup.rb
+has_rdoc: true
+homepage: http://branch14.org/markitup
+licenses: []
+
+post_install_message: 
+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.4.1
+signing_key: 
+specification_version: 3
+summary: Rack Middleware to turn text areas into rich text editors
+test_files: []
+