mongoid-markdown 0.1.0 → 0.1.1

data/Gemfile

@@ -1,6 +1,8 @@
 source "http://rubygems.org"
 
 gem 'rdiscount'
+gem 'moped'
+gem 'mongoid', '>= 2.0'
 
 group :development do
   gem "rspec",    ">= 2.8.0"

data/Gemfile.lock

@@ -1,14 +1,30 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
     diff-lcs (1.1.3)
     git (1.2.5)
+    i18n (0.6.1)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
     json (1.7.5)
+    mongoid (3.0.5)
+      activemodel (~> 3.1)
+      moped (~> 1.1)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.2.1)
+    multi_json (1.3.6)
+    origin (1.0.7)
     rake (0.9.2.2)
     rdiscount (1.6.8)
     rdoc (3.12)
@@ -21,6 +37,7 @@ GEM
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.2)
+    tzinfo (0.3.33)
 
 PLATFORMS
   ruby
@@ -28,6 +45,8 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 1.0.0)
   jeweler (>= 1.8.4)
+  mongoid (>= 2.0)
+  moped
   rdiscount
   rdoc (>= 3.12)
   rspec (>= 2.8.0)

data/{README.rdoc → README.md}

@@ -1,6 +1,6 @@
-= mongoid-markdown
+# Mongoid Markdown
 
-Add Markdown functionality for any Mongoid object.
+Add Markdown functionality to any Mongoid object.
 
 ```ruby
 
@@ -11,23 +11,34 @@ class Message
   field :body, :markdown => true
 end
 
+message = Message.new :body => "## Hello world"
 
-message = Message.new :body => my_markdown_text
+message.marked_down? # => false
 
-message.body.markdown!
+message.markdown!
 
-message.body = some_other_markedup_txt
+message.marked_down? # => true
 
-message.body.reload
+puts message.body # => "<h2>Hello world</h2>"
 
-message.body.marked_down?
+message.body = "## Goodbye cruel world..."
+
+message.reload # not sure about this!
+
+message.marked_down? # => true
 ```
 
 Enjoy!
 
 Extracted from: https://github.com/baphled/chat-engine/blob/master/lib/mongoid/markdown.rb
 
-== Contributing to mongoid-markdown
+See specs for more usage examples
+
+Should work on both Mongoid pre 2.4 and later, including 3.x. 
+
+Please help fix any bugs or come with suggestions to improvements.
+
+## 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.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/mongoid-markdown.rb

@@ -1,110 +1,7 @@
 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
+if Mongoid::VERSION < '2.4.0' 
+  require 'mongoid-markdown/mongoid_old'
+else
+  require 'mongoid-markdown/mongoid_new'
 end

data/lib/mongoid-markdown/mongoid_new.rb

@@ -0,0 +1,133 @@
+require 'rdiscount'
+
+Mongoid::Fields.option :markdown do |model,field,options|
+  options = {} unless options.kind_of?(Hash)
+
+  attribute = field.name.to_sym
+
+  model.class_eval do
+    (self.markdown_attributes ||= []) << attribute
+
+    define_method(attribute) do |*type|
+      type = type.first
+      value = read_attribute(attribute)
+
+      if type.nil? && value
+        marked_down[attribute] ||= 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  
+end
+
+module Mongoid
+  module Markdown
+    extend ActiveSupport::Concern
+
+    included do
+      # attr_accessor :geo
+      cattr_accessor :markdown_attributes
+      @@markdown_attributes = []
+
+      self.send :include, InstanceMethods
+    end
+
+    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
+
+    module InstanceMethods
+      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
+        [[ '&#8217;', "'" ], 
+         [ '&#8216;', "'" ],
+         [ '&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    
+    
+    module ClassMethods
+      def markdown(*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
+    end
+  end
+end

data/lib/mongoid-markdown/mongoid_old.rb

@@ -0,0 +1,109 @@
+require 'rdiscount'
+
+module Mongoid
+  module Markdown
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      # For mongoid < 2.4 only
+      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
+        [[ '&#8217;', "'" ], 
+         [ '&#8216;', "'" ],
+         [ '&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/mongoid-markdown.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "mongoid-markdown"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = "2012-09-14"
+  s.description = "Easily use markdown with mongoid texts"
+  s.email = "kmandrup@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/mongoid-markdown.rb",
+    "lib/mongoid-markdown/mongoid_new.rb",
+    "lib/mongoid-markdown/mongoid_old.rb",
+    "mongoid-markdown.gemspec",
+    "spec/mongoid-markdown_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/kristianmandrup/mongoid-markdown"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Add markdown functionality to any mongoid text field"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rdiscount>, [">= 0"])
+      s.add_runtime_dependency(%q<moped>, [">= 0"])
+      s.add_runtime_dependency(%q<mongoid>, [">= 2.0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.4"])
+    else
+      s.add_dependency(%q<rdiscount>, [">= 0"])
+      s.add_dependency(%q<moped>, [">= 0"])
+      s.add_dependency(%q<mongoid>, [">= 2.0"])
+      s.add_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<rdiscount>, [">= 0"])
+    s.add_dependency(%q<moped>, [">= 0"])
+    s.add_dependency(%q<mongoid>, [">= 2.0"])
+    s.add_dependency(%q<rspec>, [">= 2.8.0"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.4"])
+  end
+end
+

data/spec/mongoid-markdown_spec.rb

@@ -1,7 +1,26 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
+
+class Message
+  include Mongoid::Document
+  include Mongoid::Markdown
+
+  field :body, :markdown => true
+end
 
 describe "MongoidMarkdown" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  subject { Message.new :body => markdown_text }
+
+  let(:markdown_text) { '## Hello world '}  
+
+  describe '.markdown!' do
+    before :each do
+      subject.markdown!
+    end
+
+    it "should markup text" do
+      subject.marked_down?.should be_true
+      puts subject.body
+      subject.body.should_not == markdown_text
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,12 +1,15 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
+require 'moped'
+require 'mongoid'
+
 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}
+Mongoid.configure do |config|
+  config.connect_to('mongoid_markdown-test')
+end
 
-RSpec.configure do |config|
-  
+RSpec.configure do |config|  
+  config.before(:each) do
+    Mongoid.purge!
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: moped
+  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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -97,17 +129,20 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/mongoid-markdown.rb
+- lib/mongoid-markdown/mongoid_new.rb
+- lib/mongoid-markdown/mongoid_old.rb
+- mongoid-markdown.gemspec
 - spec/mongoid-markdown_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/kristianmandrup/mongoid-markdown
@@ -125,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4336708852903825094
+      hash: -68746546745012311
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: