mongoid-markdown 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem 'rdiscount'
+
+group :development do
+  gem "rspec",    ">= 2.8.0"
+  gem "rdoc",     ">= 3.12"
+  gem "bundler",  ">= 1.0.0"
+  gem "jeweler",  ">= 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    rake (0.9.2.2)
+    rdiscount (1.6.8)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  jeweler (>= 1.8.4)
+  rdiscount
+  rdoc (>= 3.12)
+  rspec (>= 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kristian Mandrup
+
+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.rdoc

@@ -0,0 +1,44 @@
+= mongoid-markdown
+
+Add Markdown functionality for any Mongoid object.
+
+```ruby
+
+class Message
+  include Mongoid::Document
+  include Mongoid::Markdown
+
+  field :body, :markdown => true
+end
+
+
+message = Message.new :body => my_markdown_text
+
+message.body.markdown!
+
+message.body = some_other_markedup_txt
+
+message.body.reload
+
+message.body.marked_down?
+```
+
+Enjoy!
+
+Extracted from: https://github.com/baphled/chat-engine/blob/master/lib/mongoid/markdown.rb
+
+== Contributing to mongoid-markdown
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Kristian Mandrup. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mongoid-markdown"
+  gem.homepage = "http://github.com/kristianmandrup/mongoid-markdown"
+  gem.license = "MIT"
+  gem.summary = %Q{Add markdown functionality to any mongoid text field}
+  gem.description = %Q{Easily use markdown with mongoid texts}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongoid-markdown #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongoid-markdown.rb

@@ -0,0 +1,110 @@
+require 'rdiscount'
+
+module Mongoid
+  module Markdown
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def markdown(*attributes)
+        write_inheritable_attribute(:markdown_attributes, markdown_attributes + Array(attributes))
+        @markdown_unicode = String.new.respond_to? :chars
+
+        type_options = %w( plain source )
+
+        attributes.each do |attribute|
+          define_method(attribute) do |*type|
+            type = type.first
+            value = read_attribute(attribute)
+
+            if type.nil? && value
+              marked_down[attribute.to_sym] ||= RDiscount.new(value).to_html.html_safe
+            elsif type.nil? && value.nil?
+              nil
+            elsif type_options.include?(type.to_s)
+              send("#{attribute}_#{type}")
+            else
+              raise "I don't understand the `#{type}' option.  Try #{type_options.join(' or ')}."
+            end
+          end
+
+          define_method("#{attribute}_plain",  proc { strip_markdown_html(__send__(attribute)) if __send__(attribute) } )
+          define_method("#{attribute}_source", proc { read_attribute(attribute) } )
+        end
+
+        include InstanceMethods
+      end
+
+      def markdown_attributes
+        read_inheritable_attribute(:markdown_attributes) ||
+        write_inheritable_attribute(:markdown_attributes, [])
+      end
+      
+      def field(name, options = {})
+        returning super(name, options.reject { |k, v| k == :markdown }) do
+          markdown name if options[:markdown]
+        end
+      end
+    end
+
+    module InstanceMethods
+      def marked_down
+        marked_down? ? (@marked_down ||= {}) : @attributes.dup
+      end
+
+      def marked_down?
+        @is_marked_down != false
+      end
+
+      def marked_down=(value)
+        @is_marked_down = !!value
+      end
+
+      def markdown!
+        self.class.markdown_attributes.each { |attr| __send__(attr) }
+      end
+
+      def reload
+        marked_down.clear
+        super
+      end
+
+      def write_attribute(attr_name, value)
+        marked_down[attr_name.to_s] = nil
+        super
+      end
+
+    private
+      def strip_markdown_html(html)
+        returning html.dup.gsub(html_regexp, '') do |h|
+          markdown_glyphs.each do |(entity, char)|
+            sub = [ :gsub!, entity, char ]
+            @textiled_unicode ? h.chars.send(*sub) : h.send(*sub)
+          end
+        end
+      end
+
+      def markdown_glyphs
+        [[ '’', "'" ], 
+         [ '‘', "'" ],
+         [ '&lt;', '<' ], 
+         [ '&gt;', '>' ], 
+         [ '&#8221;', '"' ],
+         [ '&#8220;', '"' ],            
+         [ '&#8230;', '...' ],
+         [ '\1&#8212;', '--' ], 
+         [ ' &rarr; ', '->' ], 
+         [ ' &#8211; ', '-' ], 
+         [ '&#215;', 'x' ], 
+         [ '&#8482;', '(TM)' ], 
+         [ '&#174;', '(R)' ],
+         [ '&#169;', '(C)' ]]
+      end
+
+      def html_regexp
+        %r{<(?:[^>"']+|"(?:\\.|[^\\"]+)*"|'(?:\\.|[^\\']+)*')*>}xm
+      end
+    end
+  end
+end

data/spec/mongoid-markdown_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "MongoidMarkdown" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'mongoid-markdown'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  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.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Easily use markdown with mongoid texts
+email: kmandrup@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mongoid-markdown.rb
+- spec/mongoid-markdown_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kristianmandrup/mongoid-markdown
+licenses:
+- MIT
+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: 4336708852903825094
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Add markdown functionality to any mongoid text field
+test_files: []