markitup-rails 1.0.0 → 1.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+.DS_Store
+Gemfile.lock
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+coverage/
+.rbx/

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3@markitup-rails

data/Gemfile

@@ -0,0 +1,18 @@
+source "https://rubygems.org"
+
+gemspec
+
+
+platforms :jruby do
+  gem "activerecord-jdbc-adapter", require: false
+end
+
+group :test do
+  platforms :ruby do
+    gem "sqlite3"
+  end
+
+  platforms :jruby do
+    gem "activerecord-jdbcsqlite3-adapter", require: false
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright © 2013 Phil Cohen <github@phlippers.net>
+
+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,199 @@
+# markitup-rails
+
+## Description
+
+The [markItUp!](http://markitup.jaysalvat.com/home/) universal markup editor, bundled for Rails 3.1+ Asset Pipeline.
+
+markItUp! is a JavaScript plug-in built on the jQuery library. It allows you to turn any textarea into a markup editor. HTML, Textile, Wiki Syntax, Markdown, BBcode or even your own Markup system can be easily implemented.
+
+`markitup-rails` ships with several markup "sets" and editor "skins" including:
+
+### Markup Sets
+
+* `bbcode`
+* `css`
+* `default`
+* `dotclear`
+* `html`
+* `markdown`
+* `markmin`
+* `rest`
+* `textile`
+* `texy`
+* `txt2tags`
+* `wiki`
+* `xbbcode`
+
+### Editor Skins
+
+* `markitup`
+* `simple`
+
+
+## Requirements
+
+This gem requires Rails 3.1+ and has been tested on the following versions:
+
+* 3.1
+* 3.2
+
+This gem requires Ruby 1.9+ and has been tested against the following Ruby versions:
+
+* 1.9.2
+* 1.9.3
+* JRuby
+* Rubinius
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "markitup-rails"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install markitup-rails
+```
+
+
+## Configuration
+
+The `Markitup::Rails` module accepts a `configure` block with options to customize the engine behavior.
+
+Place any custom configuration in a file such as `config/initializers/markitup_rails.rb`.
+
+
+### Layout
+
+Set the `layout` option to customize the layout used by the AJAX live preview:
+
+```ruby
+Markitup::Rails.configure do |config|
+  config.layout = "other"  # default is `markitup`
+end
+```
+
+You may also override the default locally by creating a new layout file at `app/views/layouts/markitup.html.erb`.
+
+### Formatter
+
+Set the `formatter` option to customize the renderer for the preview. This can be any object that responds to `call` and which takes a single argument with the markup to render:
+
+```ruby
+Markitup::Rails.configure do |config|
+  config.formatter = -> markup { BBCodeParser.parse(markup) }
+end
+```
+
+### Route
+
+`markitup-rails` provides a URL endpoint that be mounted to support a live server-side preview of markItUp! content.
+
+To enable, mount the engine in your `config/routes.rb` file:
+
+```ruby
+mount Markitup::Rails::Engine, at: "markitup", as: "markitup"
+```
+
+This will create a URL helper for `markitup.preview_url` which will route to `/markitup/preview`.
+
+The preview URL will render the editor content using the `config.formatter` and display the content within the `config.layout`.
+
+
+## Usage
+
+For Rails 3.1 and greater, the files will be added to the asset pipeline and available for you to use.
+
+To enable the markItUp! editor in your application, you will need to include the appropriate JavaScript and Stylesheet files for the Set and Skin you wish to use.
+
+Example:
+
+* Add the following line to the file `app/assets/javascripts/application.js` (or other [sprockets](https://github.com/sstephenson/sprockets) manifest):
+
+```javascript
+//= require markitup
+//= require markitup/sets/xbbcode/set
+```
+
+* Add the following line to the file `app/assets/stylesheets/application.css`:
+
+```css
+*= require markitup/skins/markitup/style
+*= require markitup/sets/xbbcode/style
+```
+
+You may also include the styles in your SCSS file directly:
+
+```scss
+@import "markitup/skins/markitup/style";
+@import "markitup/sets/xbbcode/style";
+```
+
+
+### Using markItUp!
+
+Example:
+
+```coffee
+jQuery ->
+
+  # Target all text areas
+  $("textarea").markItUp mySettings
+
+  # Target a specific ID
+  $("#my_id").markItUp mySettings
+
+  # Target a specific class
+  $("textarea.markitup").markItUp mySettings
+```
+
+See the [markItUp! documentation](http://markitup.jaysalvat.com/documentation/) for more information.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a Pull Request
+
+
+## Contributors
+
+Many thanks go to the following who have contributed to making this gem even better:
+
+* **[@ugorelik](https://github.com/ugorelik)**
+    * initial version
+* **[@phlipper](https://github.com/phlipper)**
+    * complete rewrite as an engine for Rails 3.1+
+    * add AJAX live preview support
+    * add support for Sets and Skins, add many defaults to choose from
+
+
+## License
+
+**markitup-rails**
+
+* Freely distributable and licensed under the [MIT license](http://phlipper.mit-license.org/2013/license.html).
+* Copyright (c) 2013 Phil Cohen (github@phlippers.net) [![endorse](http://api.coderwall.com/phlipper/endorsecount.png)](http://coderwall.com/phlipper)
+* http://phlippers.net/
+
+**markItUp!**
+
+* Author: [Jay Salvat](http://www.jaysalvat.com/)
+* Licence: MIT/GPL
+* http://markitup.jaysalvat.com/
+
+markItUp! is released under both the MIT and GPL Open Source licenses.
+In short, this means that markItUp! is totally Free, and you can do whatever you want with it. You are only obligated to keep the credits in place.

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/markitup/rails/preview_controller.rb

@@ -0,0 +1,13 @@
+module Markitup::Rails
+
+  # Public: Provide server-side preview of editor markup
+  #
+  class PreviewController < ApplicationController
+    layout Markitup::Rails.configuration.layout
+
+    def preview
+      @content = Markitup::Rails.configuration.formatter.call(params[:data])
+    end
+  end
+
+end

data/app/views/layouts/markitup.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>markItUp! preview template</title>
+<style type="text/css">
+/* preview style examples */
+body {
+  background-color: #efefef;
+  font: 70% Verdana, Arial, Helvetica, sans-serif;
+}
+</style>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>

data/app/views/markitup/rails/preview/preview.html.erb

@@ -0,0 +1,2 @@
+<!-- rendered content -->
+<%= @content.html_safe %>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Markitup::Rails::Engine.routes.draw do
+  post "preview", to: "preview#preview", as: "preview"
+end

data/lib/markitup/rails/configuration.rb

@@ -0,0 +1,22 @@
+module Markitup
+  module Rails
+    class << self
+      attr_accessor :configuration
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield configuration if block_given?
+    end
+
+    # Public: Configuration options for the Markitup::Rails module
+    class Configuration
+      attr_accessor :layout, :formatter
+
+      def initialize
+        @layout = "markitup"
+        @formatter = -> markup { markup }
+      end
+    end
+  end
+end

data/lib/markitup/rails/engine.rb

@@ -0,0 +1,15 @@
+require "rails"
+
+module Markitup
+  module Rails
+    # Public: Initialize the Rails engine
+    class Engine < ::Rails::Engine
+      isolate_namespace Markitup::Rails
+
+      initializer "markitup.rails.configuration" do
+        # initialize a default configuration
+        Markitup::Rails.configuration ||= Markitup::Rails::Configuration.new
+      end
+    end
+  end
+end

data/lib/markitup/rails/version.rb

@@ -0,0 +1,5 @@
+module Markitup
+  module Rails
+    VERSION = "1.0.1"
+  end
+end

data/markitup-rails.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "markitup/rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "markitup-rails"
+  s.version     = Markitup::Rails::VERSION
+  s.summary     = "The markItUp! universal markup editor, bundled for Rails 3.1+ Asset Pipeline."
+  s.description = "The markItUp! universal markup editor, bundled for Rails 3.1+ Asset Pipeline."
+  s.authors     = ["Uri Gorelik", "Phil Cohen"]
+  s.email       = ["uri@ndstorefront.com", "github@phlippers.net"]
+  s.homepage    = "https://github.com/HealthyWeb/markitup-rails"
+
+  s.files	= `git ls-files`.split("\n")
+
+  s.add_dependency "rails", ">= 3.1"
+
+  s.add_development_dependency "bundler", ">= 1.2.0"
+  s.add_development_dependency "cane", "~> 2.5.0"
+  s.add_development_dependency "minitest", "~> 4.3.0"
+  s.add_development_dependency "minitest-rails", "~> 0.3.0"
+  s.add_development_dependency "rake", ">= 10.0.0"
+  s.add_development_dependency "simplecov", "~> 0.7.1"
+end

data/test/configuration_test.rb

@@ -0,0 +1,52 @@
+require "minitest_helper"
+
+describe Markitup::Rails::Configuration do
+  subject { Markitup::Rails.configuration }
+
+  describe "layout" do
+    it { subject.layout.must_equal "markitup" }
+
+    describe "with a custom layout" do
+      before do
+        @old_layout = subject.layout
+
+        Markitup::Rails.configure do |config|
+          config.layout = "other"
+        end
+      end
+
+      after { Markitup::Rails.configuration.layout = @old_layout }
+
+      it { Markitup::Rails.configuration.layout.must_equal "other" }
+    end
+  end
+
+  describe "formatter" do
+    it { subject.must_respond_to(:formatter, :call) }
+    it { subject.formatter.call("text").must_equal "text" }
+
+    describe "with a custom formatter" do
+      before do
+        class Frobnicate
+          def self.call(markup)
+            "Frobnicate: #{markup}"
+          end
+        end
+
+        @old_formatter = subject.formatter
+
+        Markitup::Rails.configure do |config|
+          config.formatter = Frobnicate
+        end
+      end
+
+      after { Markitup::Rails.configuration.formatter = @old_formatter }
+
+      it "frobnicates" do
+        expected = "Frobnicate: foo"
+        Markitup::Rails.configuration.formatter.call("foo").must_equal expected
+      end
+    end
+  end
+
+end

data/test/controllers/markitup/rails/preview_controller_test.rb

@@ -0,0 +1,12 @@
+require "minitest_helper"
+
+module Markitup::Rails
+  describe PreviewController do
+    describe "POST preview" do
+      before { post :preview, data: "foo" }
+
+      it { assert_response :success }
+      it { assigns[:content].must_equal "foo" }
+    end
+  end
+end