mongoid_markdown_extension 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ec0073ca5dd466ba2075412834342b224ea4c28
+  data.tar.gz: c48aab24084b546fb27fcb448c1abd94790d3777
+SHA512:
+  metadata.gz: 7f505fe915e92f7ba6346995591d57dce320b08e5421e85ce2e1e07f7f29e4d8abaff58e0751fdb2441cb5db2bd083070d79444c7a523ac52f47ad3460d9b74d
+  data.tar.gz: 69cc619d28479508754916cca970f1c1bd1c7053e92521a517b0bfc8f3fa8fd1373f2b6b051f40527aedc724491fac372b3da0f7ddb53f5a184694371333779f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tomas Celizna
+
+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,68 @@
+# Mongoid Markdown Extension
+
+[![Build Status](https://travis-ci.org/tomasc/mongoid_markdown_extension.svg)](https://travis-ci.org/tomasc/mongoid_markdown_extension) [![Coverage Status](https://img.shields.io/coveralls/tomasc/mongoid_markdown_extension.svg)](https://coveralls.io/r/tomasc/mongoid_markdown_extension)
+
+[Mongoid](https://github.com/mongoid/mongoid) field extension that returns an object with `to_html` method returning the content converted from Markdown syntax to html. The Markdown conversion is done using the [Redcarpet](https://github.com/vmg/redcarpet) library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_markdown_extension'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_markdown_extension
+
+## Configuration
+
+The defaults are as follows:
+
+```Ruby
+extensions = {
+    autolink: true
+    footnotes: true
+    highlight: true
+    space_after_headers: true
+    strikethrough: true
+    superscript: true
+}
+
+render_options = {}
+```
+
+These can be overwritten with an initializer, for example `config/initializers/mongoid_markdown.rb`:
+
+```Ruby
+MongoidMarkdownExtension::Markdown.configure do |c|
+    c.extensions = { autolink: true }
+    c.render_options = { filter_html: true }
+end
+```
+
+See [Redcarpet documentation](https://github.com/vmg/redcarpet) for available extensions and render options.
+
+## Usage
+
+Add to a Mongoid model:
+
+    class MyModel
+        include Mongoid::Document
+        field :text, type: MongoidMarkdownExtension::Markdown
+    end
+    
+Use it in a view:
+
+    = my_model.text.to_html
+
+## Contributing
+
+1. Fork it ( https://github.com/tomasc/mongoid_markdown_extension/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*/*_test.rb'
+end
+
+task :default => :test

data/lib/mongoid_markdown_extension.rb

@@ -0,0 +1,2 @@
+require "mongoid_markdown_extension/markdown"
+require "mongoid_markdown_extension/version"

data/lib/mongoid_markdown_extension/markdown.rb

@@ -0,0 +1,88 @@
+require 'redcarpet'
+
+module MongoidMarkdownExtension
+  class Markdown < String
+
+    def initialize str
+      super str.to_s
+      @str = str.to_s
+    end
+
+    def to_s
+      @str
+    end
+
+    def to_html
+      markdown_renderer.render(@str).html_safe
+    end
+
+    def mongoize
+      @str
+    end
+
+    private # =============================================================
+
+    def markdown_renderer
+      Redcarpet::Markdown.new(
+        Redcarpet::Render::HTML.new(self.class.configuration.render_options),
+        self.class.configuration.extensions
+      )
+    end
+
+    # ---------------------------------------------------------------------
+
+    class << self
+
+      attr_accessor :configuration
+
+      def configure
+        @configuration ||= Configuration.new
+        yield @configuration
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def demongoize value
+        Markdown.new(value)
+      end
+
+      def mongoize value
+        case value
+        when Markdown then value.mongoize
+        else value
+        end
+      end
+
+      def evolve value
+        case value
+        when Markdown then value.mongoize
+        else value
+        end
+      end
+
+    end
+  end
+
+  # ---------------------------------------------------------------------
+
+  class Configuration
+    attr_accessor :extensions
+    attr_accessor :render_options
+
+    def initialize
+      @extensions = {
+        autolink: true,
+        footnotes: true,
+        highlight: true,
+        space_after_headers: true,
+        strikethrough: true,
+        superscript: true
+      }
+      @render_options = {}
+    end
+  end
+
+  # ---------------------------------------------------------------------
+end

data/lib/mongoid_markdown_extension/version.rb

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

data/mongoid_markdown_extension.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_markdown_extension/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_markdown_extension"
+  spec.version       = MongoidMarkdownExtension::VERSION
+  spec.authors       = ["Tomas Celizna"]
+  spec.email         = ["tomas.celizna@gmail.com"]
+  spec.description   = %q{Custom field type for Mongoid that handles Markdown conversion via Redcarpet gem.}
+  spec.summary       = %q{Custom field type for Mongoid that handles Markdown conversion via Redcarpet gem.}
+  spec.homepage      = "https://github.com/tomasc/mongoid_markdown_extension"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redcarpet", ">= 3.1.2"
+  spec.add_dependency "mongoid", ">= 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rake"
+end

data/test/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/test/mongoid_markdown_extension/markdown_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+# ---------------------------------------------------------------------
+
+class MongoidMarkdownExtensionTest
+  include Mongoid::Document
+  field :body, type: MongoidMarkdownExtension::Markdown
+end
+
+# ---------------------------------------------------------------------
+
+module MongoidMarkdownExtension
+  describe Markdown do
+
+    let(:string) { 'some text with _italic_' }
+    subject { MongoidMarkdownExtension::Markdown.new(string) }
+
+    describe 'configuration' do
+      describe 'setup block' do
+        it 'yields self' do
+          MongoidMarkdownExtension::Markdown.configure do |config|
+            config.must_be_kind_of Configuration
+          end
+        end
+        it 'returns default values' do
+          MongoidMarkdownExtension::Markdown.configuration.extensions.must_equal({
+            autolink: true,
+            footnotes: true,
+            highlight: true,
+            space_after_headers: true,
+            strikethrough: true,
+            superscript: true
+          })
+          MongoidMarkdownExtension::Markdown.configuration.render_options.must_equal({})
+        end
+      end
+    end
+
+    # ---------------------------------------------------------------------
+
+    describe '#to_s' do
+      it 'returns the original value' do
+        subject.to_s.must_equal string
+      end
+    end
+
+    describe '#to_html' do
+      it 'survives nil' do
+        MongoidMarkdownExtension::Markdown.new(nil).to_html.must_equal ''
+      end
+      it 'converts the string to html' do
+        subject.to_html.must_equal Redcarpet::Markdown.new(Redcarpet::Render::HTML).render(string)
+      end
+    end
+
+    describe '#mongoize' do
+      it 'returns string' do
+        subject.mongoize.must_equal string
+      end
+    end
+
+    # ---------------------------------------------------------------------
+
+    describe '.mongoize' do
+      describe 'when passed a string' do
+        it 'returns it back' do
+          MongoidMarkdownExtension::Markdown.mongoize(string).must_equal string
+        end
+      end
+      describe 'when passed markdown object' do
+        it 'returns its string' do
+          MongoidMarkdownExtension::Markdown.mongoize(subject).must_be_kind_of String
+        end
+      end
+    end
+
+    describe '.demongoize' do
+      it 'does not change the value' do
+        MongoidMarkdownExtension::Markdown.demongoize(string).must_equal string
+      end
+
+      it 'returns markdown object' do
+        MongoidMarkdownExtension::Markdown.demongoize(string).must_be_kind_of MongoidMarkdownExtension::Markdown
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'mongoid'
+require 'mongoid_markdown_extension'
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'coveralls'
+
+Coveralls.wear!

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_markdown_extension
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Custom field type for Mongoid that handles Markdown conversion via Redcarpet
+  gem.
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid_markdown_extension.rb
+- lib/mongoid_markdown_extension/markdown.rb
+- lib/mongoid_markdown_extension/version.rb
+- mongoid_markdown_extension.gemspec
+- test/.coveralls.yml
+- test/mongoid_markdown_extension/markdown_test.rb
+- test/test_helper.rb
+homepage: https://github.com/tomasc/mongoid_markdown_extension
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Custom field type for Mongoid that handles Markdown conversion via Redcarpet
+  gem.
+test_files:
+- test/.coveralls.yml
+- test/mongoid_markdown_extension/markdown_test.rb
+- test/test_helper.rb
+has_rdoc: