mongoid_markdown 0.1.1

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec' do
+
+  # Run spec if spec changes
+  watch(%r{^spec/.+_spec\.rb$})
+
+  # Run all specs if anything changes
+  watch(%r{^lib/(.+)\.rb$}) { 'spec' }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lasse Skindstad Ebert
+
+MIT License
+
+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,55 @@
+# mongoid_markdown
+
+Makes it easy to handle a field in a mongoid document that contains markdown.
+
+Creates an extra method `parsed_field_name` which will return the HTML markup of the markdown.
+
+## Installation
+
+**Note: This is not published to RubyGems yet - waiting for their recovery**
+
+**In the meantime use `gem 'mongoid_markdown', git: 'https://github.com/lasseebert/mongoid_markdown.git'`**
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_markdown'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_markdown
+
+## Usage
+
+* Include `MongoidMarkdown::Parser`
+* Add field with `markdown` instead of the normal `field`
+* Enjoy the `parsed_field_name` method
+
+Example:
+```ruby
+class Article
+  include Mongoid::Document
+  include MongoidMarkdown::Parser
+
+  field :header, type: String
+  markdown :content
+end
+
+article = Article.new header: 'Check out mongoid_markdown', content: "Wow\n\n* list\n* *items*"
+article.parsed_content # => "<p>Wow</p>\n\n<ul>\n<li>list</li>\n<li><em>items</em></li>\n</ul>\n"
+```
+
+## Alternatives
+
+[mongoid-markdown](https://github.com/kristianmandrup/mongoid-markdown), which takes a slightly different approach.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mongoid_markdown.rb

@@ -0,0 +1,33 @@
+require 'mongoid_markdown/version'
+require 'redcarpet'
+
+module MongoidMarkdown
+  module Parser
+
+    def self.included(base)
+      base.class_eval do |klass|
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def markdown(field_name)
+        field field_name, type: String
+        define_method("parsed_#{field_name.to_s}") do
+          self.class.parse_markdown self.send(field_name)
+        end
+      end
+
+      def parse_markdown(markdown)
+        return nil if markdown.nil?
+        @@markdown_parser ||= Redcarpet::Markdown.new(
+          Redcarpet::Render::HTML,
+          autolink: true
+        )
+        @@markdown_parser.render(markdown).html_safe
+      end
+    end
+
+  end
+end
+

data/lib/mongoid_markdown/version.rb

@@ -0,0 +1,3 @@
+module MongoidMarkdown
+  VERSION = "0.1.1"
+end

data/mongoid_markdown.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_markdown/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mongoid_markdown"
+  gem.version       = MongoidMarkdown::VERSION
+  gem.authors       = ["Lasse Skindstad Ebert"]
+  gem.email         = ["lasseebert@gmail.com"]
+  gem.description   = %q{Makes it easy to use markdown with mongoid}
+  gem.summary       = %q{Makes it easy to use markdown with mongoid}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'redcarpet', '~> 2.2'
+  gem.add_dependency 'mongoid'
+
+  gem.add_development_dependency 'rspec', '~> 2.12'
+  gem.add_development_dependency 'guard-rspec', '~> 2.4'
+  gem.add_development_dependency 'rb-inotify', '~> 0.8.8'
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'mongoid_markdown'
+require 'mongoid'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

data/spec/unit/markdown_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+class Article
+  include Mongoid::Document
+  include MongoidMarkdown::Parser
+
+  field :header, type: String
+  markdown :content
+end
+
+describe 'markdown' do
+  it 'can call parsed_ method' do
+    article = Article.new content: 'foo'
+    article.parsed_content.should == "<p>foo</p>\n"
+  end
+
+  describe 'parse_markdown' do
+    it 'passes markdown' do
+      markdown = <<-EOF.strip_heredoc
+        #This is a header
+
+        A paragraph with a small amount of text
+
+        * List with
+        * Three
+        * Items
+      EOF
+
+      expected = <<-EOF.strip_heredoc.html_safe
+        <h1>This is a header</h1>
+
+        <p>A paragraph with a small amount of text</p>
+
+        <ul>
+        <li>List with</li>
+        <li>Three</li>
+        <li>Items</li>
+        </ul>
+      EOF
+      html = Article.parse_markdown markdown
+      html.should == expected
+    end
+
+    it 'returns nil in nil input' do
+      Article.parse_markdown(nil).should be_nil
+    end
+  end
+end
+

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Lasse Skindstad Ebert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+description: Makes it easy to use markdown with mongoid
+email:
+- lasseebert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid_markdown.rb
+- lib/mongoid_markdown/version.rb
+- mongoid_markdown.gemspec
+- spec/spec_helper.rb
+- spec/unit/markdown_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2325908448554059919
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2325908448554059919
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Makes it easy to use markdown with mongoid
+test_files:
+- spec/spec_helper.rb
+- spec/unit/markdown_spec.rb