marky 0.0.1 → 0.1.0

data/README

@@ -1,62 +1,62 @@
--- RMU SESSION 2 | PROBLEM 2
-
-If in doubt about how to submit, see SUBMISSION_GUIDELINES file.
-
-For this exercise, we'll be working with design patterns originally 
-described in the much-acclaimed "Gang of Four" book.  While this book is over 15
-years old, many of the ideas within it are still relevant to modern object 
-oriented design.  The tricky thing is that sometimes they are mis-applied, and
-often they are described with rather anemic examples that don't quite show their
-true power.
-
-Our goal will be to come up with some good Ruby examples that demonstrate how a
-given pattern can be applied in real code, while sticking to Ruby idioms.  Follow 
-the guidelines below to complete the exercise.
-
-== GUIDELINES
-
-1. Spend some time reviewing some of the classic patterns, reading at least a
-few of them before deciding to focus on any one of them.  There is a decent
-resource at: http://sourcemaking.com/design_patterns and tons of information on
-Wikipedia as well.  You can use any of the patterns that are listed at that URL,
-except for Command pattern, since we covered that in the entrance exam.
-
-2. When you find a pattern that sounds interesting to you, try to think of a
-scenario in which you could apply it in real code.  If you can come up with one,
-announce that you'll be working on this pattern on the mailing list, along with
-the scenario you plan to explore. 
-
-3. Write up some example code that demonstrates the pattern in action.  You do
-not need to build a complete application, but the example you show should have
-enough context to look and feel 'real', rather than being some contrived foo/bar
-example.  Download the PDF of my book (http://rubybestpractices.com) if you want
-some examples of how to present ideas using real or realistic code.
-
-4. Even if you're not building a complete application, stub out enough things to
-create a runnable simulation that demonstrates how your code would be used.
-Bonus points of course would be given to those who build a real app that uses
-the pattern in action.
-
-5. Feel free to help each other as much as needed to come up with the best
-possible examples.  You are encouraged to review each other's work and offer
-suggestions.
-
-== RESTRICTIONS:
-
-* I don't want more than three students to cover the same problem, so be sure to keep
-  an eye on who's working on what
-
-* Not every pattern that exists is relevant to Ruby.  Try your best to
-  choose one that is, and if you're not reasonably sure, ask your fellow 
-  students and/or me to comment on your choice.
-
-* Do not submit a Command pattern demonstration.
-
-* Do not intentionally copy a scenario you've found online. It's not a problem
-  if the example you pick happens to have been covered somewhere online before,
-  but you should not just port some example from another language into Ruby, try
-  to come up with your own use case.
-
-== QUESTIONS?
-
-Hit up the mailing list or IRC.
+-- RMU SESSION 2 | PROBLEM 2
+
+If in doubt about how to submit, see SUBMISSION_GUIDELINES file.
+
+For this exercise, we'll be working with design patterns originally 
+described in the much-acclaimed "Gang of Four" book.  While this book is over 15
+years old, many of the ideas within it are still relevant to modern object 
+oriented design.  The tricky thing is that sometimes they are mis-applied, and
+often they are described with rather anemic examples that don't quite show their
+true power.
+
+Our goal will be to come up with some good Ruby examples that demonstrate how a
+given pattern can be applied in real code, while sticking to Ruby idioms.  Follow 
+the guidelines below to complete the exercise.
+
+== GUIDELINES
+
+1. Spend some time reviewing some of the classic patterns, reading at least a
+few of them before deciding to focus on any one of them.  There is a decent
+resource at: http://sourcemaking.com/design_patterns and tons of information on
+Wikipedia as well.  You can use any of the patterns that are listed at that URL,
+except for Command pattern, since we covered that in the entrance exam.
+
+2. When you find a pattern that sounds interesting to you, try to think of a
+scenario in which you could apply it in real code.  If you can come up with one,
+announce that you'll be working on this pattern on the mailing list, along with
+the scenario you plan to explore. 
+
+3. Write up some example code that demonstrates the pattern in action.  You do
+not need to build a complete application, but the example you show should have
+enough context to look and feel 'real', rather than being some contrived foo/bar
+example.  Download the PDF of my book (http://rubybestpractices.com) if you want
+some examples of how to present ideas using real or realistic code.
+
+4. Even if you're not building a complete application, stub out enough things to
+create a runnable simulation that demonstrates how your code would be used.
+Bonus points of course would be given to those who build a real app that uses
+the pattern in action.
+
+5. Feel free to help each other as much as needed to come up with the best
+possible examples.  You are encouraged to review each other's work and offer
+suggestions.
+
+== RESTRICTIONS:
+
+* I don't want more than three students to cover the same problem, so be sure to keep
+  an eye on who's working on what
+
+* Not every pattern that exists is relevant to Ruby.  Try your best to
+  choose one that is, and if you're not reasonably sure, ask your fellow 
+  students and/or me to comment on your choice.
+
+* Do not submit a Command pattern demonstration.
+
+* Do not intentionally copy a scenario you've found online. It's not a problem
+  if the example you pick happens to have been covered somewhere online before,
+  but you should not just port some example from another language into Ruby, try
+  to come up with your own use case.
+
+== QUESTIONS?
+
+Hit up the mailing list or IRC.

data/README.md

@@ -1,54 +1,59 @@
-Marky
-=====
-
-Marky is simple wrapper for converting strings/text to html using different markdown processors. It's the solution to assingment #2 of October RMU. Based on intirdea's multi_json gem.
-
-Installation
-============
-  [sudo] gem install marky
-
-By default, installing Marky will install also RDiscount, Maruku and BlueCloth if necessary. 
-
-Usage
-=====
-
-    require 'marky'
-    Marky.adapter = :maruku
-    Marky.to_html("Hello, Marky")
-    => "<p>Hello, Marky</p>"
-
-Adapters
-========
-
-Right now, the available adapters are RDiscout, BlueCloth and Maruku. If you want to add another, just create a module into adapters dirrectory who implements to_html method.
-
-Meta
-====
-
-* Author  : Mitko Kostov
-* Email   : mitko.kostov@gmail.com
-* Website : [http://mitkokostov.info](http://mitkokostov.info)
-* Twitter : [http://twitter.com/mytrile](http://twitter.com/mytrile)
- 
-License
-=======	
-
-Copyright (c) 2010 Mitko Kostov
-
-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.
+Marky
+=====
+
+Marky is simple wrapper for converting strings/text to html using different markdown processors. It's the solution to assingment #2 of octobers Ruby Mendicant University. Based on intirdea's multi_json gem.
+
+Installation
+============
+  [sudo] gem install marky
+
+By default, installing Marky will install also RDiscount, Maruku and BlueCloth if necessary. 
+
+Usage
+=====
+
+    require 'marky'
+    Marky.adapter = :maruku
+    Marky.to_html("Hello, Marky")
+    => "<p>Hello, Marky</p>"
+
+Adapters
+========
+
+* [RDiscount](https://github.com/rtomayko/rdiscount)
+* [BlueCloth](http://deveiate.org/projects/BlueCloth)
+* [Maruku](https://github.com/nex3/maruku)
+* [Kramdown](https://github.com/gettalong/kramdown)
+
+If you want to add another, just create a module into adapters dirrectory who implements to_html method.
+
+Meta
+====
+
+* Author  : Mitko Kostov
+* Email   : mitko.kostov@gmail.com
+* Website : [http://mitkokostov.info](http://mitkokostov.info)
+* Twitter : [http://twitter.com/mytrile](http://twitter.com/mytrile)
+ 
+License
+=======
+
+Copyright (c) 2010 Mitko Kostov
+
+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/SUBMISSION_GUIDELINES

@@ -1,13 +1,13 @@
-Fork this repository and hack away!  When you are ready for a review, log into
-the RMU web app and request a review for the appropriate exercise(*).
-
-Do not share your solution or the problem description with anyone else without
-talking to me about it first.  Likewise, your submission won't be shared with
-anyone else by me unless I talk to you first.
-
-NOTE: No work done after 10/25 will be evaluated, be sure to request a review
-before then!
-
-(*) As of the time of writing this feature is not in place, but will be before
-10/11.  Should you wish to submit a problem for review before then, please just
-email me.
+Fork this repository and hack away!  When you are ready for a review, log into
+the RMU web app and request a review for the appropriate exercise(*).
+
+Do not share your solution or the problem description with anyone else without
+talking to me about it first.  Likewise, your submission won't be shared with
+anyone else by me unless I talk to you first.
+
+NOTE: No work done after 10/25 will be evaluated, be sure to request a review
+before then!
+
+(*) As of the time of writing this feature is not in place, but will be before
+10/11.  Should you wish to submit a problem for review before then, please just
+email me.

data/lib/adapters/bluecloth.rb

@@ -1,15 +1,15 @@
-begin
-  require 'bluecloth' unless defined?(::BlueCloth)
-rescue LoadError
-  puts "BlueCloth is not installed. Please, do $ [sudo] gem install bluecloth"
-end
-module Marky
-  module Adapters
-    module Bluecloth
-      extend self
-      def to_html(string)
-        ::BlueCloth.new(string).to_html
-      end
-    end
-  end
+begin
+  require 'bluecloth' unless defined?(::BlueCloth)
+rescue LoadError
+  puts "BlueCloth is not installed. Please, do $ [sudo] gem install bluecloth"
+end
+module Marky
+  module Adapters
+    module Bluecloth
+      extend self
+      def to_html(string)
+        ::BlueCloth.new(string).to_html
+      end
+    end
+  end
 end

data/lib/adapters/kramdown.rb

@@ -0,0 +1,16 @@
+begin
+  require 'kramdown' unless defined?(::Kremdown)
+rescue LoadError
+  puts "Kramdown is not installed. Please, do $ [sudo] gem install kramdown"
+end
+
+module Marky
+  module Adapters
+    module Kramdown
+      extend self
+      def to_html(string)
+        ::Kramdown::Document.new(string).to_html
+      end
+    end
+  end
+end

data/lib/adapters/maruku.rb

@@ -1,16 +1,16 @@
-begin
-  require 'maruku' unless defined?(::Maruku)
-rescue LoadError
-  puts "Maruku is not installed. Please, do $ [sudo] gem install bluecloth"
-end
-
-module Marky
-  module Adapters
-    module Maruku
-      extend self
-      def to_html(string)
-        ::Maruku.new(string).to_html
-      end
-    end
-  end
+begin
+  require 'maruku' unless defined?(::Maruku)
+rescue LoadError
+  puts "Maruku is not installed. Please, do $ [sudo] gem install bluecloth"
+end
+
+module Marky
+  module Adapters
+    module Maruku
+      extend self
+      def to_html(string)
+        ::Maruku.new(string).to_html
+      end
+    end
+  end
 end

data/lib/adapters/rdiscount.rb

@@ -1,16 +1,16 @@
-begin
-  require 'rdiscount' unless defined?(::RDiscount)
-rescue LoadError
-  puts "RDiscount is not installed. Please, do $ [sudo] gem install rdiscount"
-end
-
-module Marky
-  module Adapters
-    module Rdiscount
-      extend self
-      def to_html(string)
-        ::RDiscount.new(string).to_html
-      end
-    end
-  end
-end
+begin
+  require 'rdiscount' unless defined?(::RDiscount)
+rescue LoadError
+  puts "RDiscount is not installed. Please, do $ [sudo] gem install rdiscount"
+end
+
+module Marky
+  module Adapters
+    module Rdiscount
+      extend self
+      def to_html(string)
+        ::RDiscount.new(string).to_html
+      end
+    end
+  end
+end

data/lib/marky.rb

@@ -1,31 +1,31 @@
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'adapters') 
-# Marky is simple wrapper for converting strings/text to html using different markdown processors.
-module Marky
-  extend self
-
-  # Gets the default adapter. Sets it to RDiscount if adapter is not specified
-  def adapter
-    return @adapter if @adapter
-    self.adapter = :rdiscount
-    @adapter
-  end
-   
-  # Sets the markdown processor and requires the adapter. 
-  # @param [String, Symbol] name of the adapter 
-  def adapter=(adapter_name)
-    case adapter_name
-    when Symbol, String
-      require "adapters/#{adapter_name}"
-      @adapter = Marky::Adapters.const_get("#{adapter_name.to_s.capitalize}")
-    else
-      raise "Missing adapter #{adapter_name}"
-    end
-  end
-
-  # Compiles the string into HTML. 
-  # @param [String] the string which will be compiles 
-  def to_html(string)
-    adapter.to_html(string)
-  end
-
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'adapters') 
+# Marky is simple wrapper for converting strings/text to html using different markdown processors.
+module Marky
+  extend self
+
+  # Gets the default adapter. Sets it to RDiscount if adapter is not specified
+  def adapter
+    return @adapter if @adapter
+    self.adapter = :rdiscount
+    @adapter
+  end
+   
+  # Sets the markdown processor and requires the adapter. 
+  # @param [String, Symbol] name of the adapter 
+  def adapter=(adapter_name)
+    case adapter_name
+    when Symbol, String
+      require "adapters/#{adapter_name}"
+      @adapter = Marky::Adapters.const_get("#{adapter_name.to_s.capitalize}")
+    else
+      raise "Missing adapter #{adapter_name}"
+    end
+  end
+
+  # Compiles the string into HTML. 
+  # @param [String] the string which will be compiles 
+  def to_html(string)
+    adapter.to_html(string)
+  end
+
 end

data/marky.gemspec

@@ -1,14 +1,14 @@
-Gem::Specification.new do |s|
-  s.name = "marky"
-  s.version = "0.0.1"
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Mitko Kostov"]
-  s.description = %q{Marky is a simple wrapper for converting strings/text to html using different markdown processors.}
-  s.summary = %q{A gem to provide swappable markdown processors.}
-  s.email = ["mitko.kostov@gmail.com"]
-  s.homepage = "http://github.com/mytrile/marky"
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files -- {test}/*`.split("\n")
-  s.require_paths = ["lib"]
-end
-
+Gem::Specification.new do |s|
+  s.name = "marky"
+  s.version = "0.1.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mitko Kostov"]
+  s.description = %q{Marky is a simple wrapper for converting strings/text to html using different markdown processors.}
+  s.summary = %q{A gem to provide swappable markdown processors.}
+  s.email = ["mitko.kostov@gmail.com"]
+  s.homepage = "http://github.com/mytrile/marky"
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test}/*`.split("\n")
+  s.require_paths = ["lib"]
+end
+

data/test/marky_test.rb

@@ -1,37 +1,42 @@
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib') 
-
-require 'minitest/spec'
-require 'marky'
-
-MiniTest::Unit.autorun
-
-describe Marky do
-  before do
-    Marky.adapter
-  end
- 
-  describe "when I don't specify adapter" do
-    it "the default adapter should be rdiscount" do
-      Marky.adapter.must_equal Marky::Adapters::Rdiscount
-    end
-  end
-
-  describe "when I use different when I don't specify adapter" do
-
-    it "returns proper html when using RDiscount" do
-      Marky.adapter = :rdiscount
-      Marky.to_html("Hello, Marky").must_equal "<p>Hello, Marky</p>\n"
-    end
-
-    it "returns proper html when using Maruku" do
-      Marky.adapter = :maruku
-      Marky.to_html("Hello, Marky").must_equal "<p>Hello, Marky</p>"
-    end
-
-    it "returns proper html when using BlueCloth" do
-      Marky.adapter = :bluecloth
-      Marky.to_html("Hello, Marky").must_equal "<p>Hello, Marky</p>"
-    end
-
-  end
-end
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib') 
+
+require 'minitest/spec'
+require 'marky'
+
+MiniTest::Unit.autorun
+
+describe Marky do
+  before do
+    Marky.adapter
+  end
+ 
+  describe "when I don't specify adapter" do
+    it "the default adapter should be rdiscount" do
+      Marky.adapter.must_equal Marky::Adapters::Rdiscount
+    end
+  end
+
+  describe "when I use different when I don't specify adapter" do
+
+    it "returns proper html when using RDiscount" do
+      Marky.adapter = :rdiscount
+      Marky.to_html("Hello, Marky").must_equal "<p>Hello, Marky</p>\n"
+    end
+
+    it "returns proper html when using Maruku" do
+      Marky.adapter = :maruku
+      Marky.to_html("Hello, Marky").must_equal "<p>Hello, Marky</p>"
+    end
+
+    it "returns proper html when using BlueCloth" do
+      Marky.adapter = :bluecloth
+      Marky.to_html("Hello, Marky").must_equal "<p>Hello, Marky</p>"
+    end
+
+    it "returns proper html when using Kramdown" do
+      Marky.adapter = :kramdown
+      Marky.to_html("Hello, Marky").must_equal "<p>Hello, Marky</p>\n"
+    end
+
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: marky
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Mitko Kostov
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-10 00:00:00 +02:00
+date: 2010-12-17 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -33,6 +32,7 @@ files:
 - README.md
 - SUBMISSION_GUIDELINES
 - lib/adapters/bluecloth.rb
+- lib/adapters/kramdown.rb
 - lib/adapters/maruku.rb
 - lib/adapters/rdiscount.rb
 - lib/marky.rb
@@ -52,7 +52,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -61,7 +60,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
       segments: 
       - 1
       - 3