RubyGems - glorify - Versions diffs - 0.1.0 → 0.2.0 - Mend

glorify 0.1.0 → 0.2.0

Files changed (17) hide show

data/README.md +29 -15
data/example.rb +21 -0
data/glorify.gemspec +2 -1
data/lib/glorify.rb +8 -7
data/lib/glorify/extensions.rb +9 -0
data/lib/glorify/template.rb +18 -0
data/lib/glorify/version.rb +1 -1
data/spec/glorify/blocks.md +1 -0
data/spec/glorify/header.md +1 -0
data/spec/glorify/ruby_blocks.md +5 -0
data/spec/glorify/{ruby_blocks.erb → with_helper.erb} +0 -0
data/spec/glorify_spec.rb +26 -3
data/spec/spec_helper.rb +10 -0
metadata +26 -9
data/spec/glorify/blocks.erb +0 -1
data/spec/glorify/header.erb +0 -1
data/spec/glorify/layout.erb +0 -1

data/README.md CHANGED

@@ -2,8 +2,11 @@
 Sinatra helper to parse markdown with syntax highlighting like the pros
-Renders via redcarpet with syntax highlighting thanks to [pygments.rb](https://github.com/tmm1/pygments.rb). Able to use
-fenced code blocks like github, and includes a default pygments stylesheet.
+Renders markdown via redcarpet with syntax highlighting thanks to
+[pygments.rb](https://github.com/tmm1/pygments.rb).
+Able to use fenced code blocks like github, and includes a default pygments
+stylesheet.
 ## install
@@ -19,28 +22,36 @@ gem 'sinatra'
 gem 'glorify'
 ```
-## usage
+## using `Glorify::Template`
+glorify comes with a tilt template for rendering markdown.
+this allows you to override the default markdown renderer and use redcarpet2
+with pygments.rb to highlight any code blocks within your view.
-given the following `markdown` example
+in order to do this, you will need to prefer the template class.
-    # a sip of glory
+```ruby
+Tilt.prefer Sinatra::Glorify::Template
+```
-    providing a sinatra helper, glorify lets you parse markdown with ease.
+then any views that render `markdown` will use Glorify::Template instead.
-    you can even parse code blocks, in any language you'd like. just like you can
-    with github flavored markdown. because glorify uses much of the same technology
-    as github, you can highlight code from nearly any language, without any extra
-    dependencies.
+```ruby
+register Sinatra::Glorify
+get '/' do
+  markdown :a_view_with_code_blocks
+end
+```
-    the snippet below will render a bit of some ruby with syntax highlighting.
+## using the helper
-    ```ruby
-    ['toast', 'cheese', 'wine'].each { |food| print food.capitalize }
-    ```
+if you want to stick with your current renderer and just render some code
+blocks within your view, use the `glorify` helper method.
 ### classical app
-simply `require 'glorify'` to use with a classic style sinatra app.
+simply `require 'glorify'` to use the helper with a classic style sinatra app.
 ```ruby
 require 'sinatra'
@@ -85,6 +96,9 @@ this is just a simple `erb` template, but you get the idea.
 </html>
 ```
+the default pygments stylesheet that comes with glorify is available at the
+`/pygments.css` route
 ### on heroku
 to make this work on heroku you'll have to use python2.6

data/example.rb ADDED

@@ -0,0 +1,21 @@
+$: << File.expand_path(".") + '/lib'
+require 'sinatra'
+require 'glorify'
+require 'erb'
+set :markdown, :layout_engine => :erb
+set :views, File.dirname(__FILE__)
+Tilt.prefer Sinatra::Glorify::Template
+get "/" do
+  markdown :README
+end
+__END__
+@@layout
+<html>
+  <head>
+    <link href="/pygments.css" media="screen" rel="stylesheet" type="text/css">
+  </head>
+  <body><%= yield %></body>
+</html>

data/glorify.gemspec CHANGED

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ["zachary@zacharyscott.net"]
   s.homepage    = "http://github.com/zzak/glorify"
   s.summary     = %q{Sinatra helper to parse markdown with syntax highlighting like the pros}
-  s.description = %q{Renders via redcarpet with syntax highlighting thanks to pygments.rb. Able to use fenced code blocks like github, and includes a default pygments stylesheet.}
+  s.description = %q{Renders markdown via redcarpet with syntax highlighting thanks to pygments.rb. Able to use fenced code blocks like github, and includes a default pygments stylesheet.}
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "minitest"
   s.add_development_dependency "rack-test"
   s.add_development_dependency "rake"
+  s.add_development_dependency "w3c_validators"
 end

data/lib/glorify.rb CHANGED

@@ -1,29 +1,30 @@
 require "sinatra/base"
 require "glorify/css"
+require "glorify/extensions"
 require "glorify/version"
 require "glorify/renderer"
+require "glorify/template"
 module Sinatra
   module Glorify
     module Helpers
       def glorify text
-        rndr = Glorify::Renderer.new
-        Redcarpet::Markdown.new(rndr, settings.glorify_extensions).render(text)
+        Redcarpet::Markdown.new(Glorify::Renderer.new,
+                                Glorify::EXTENSIONS).render(text)
       end
     end
     def self.registered(app)
-      app.set :glorify_extensions, { :filter_html => true,
-                                     :autolink => true,
-                                     :no_intra_emphasis => true,
-                                     :fenced_code_blocks => true
-                                    }
+      app.set :glorify_extensions, Glorify::EXTENSIONS
       app.helpers Glorify::Helpers
       app.get '/pygments.css' do
+        content_type 'text/css'
         glorify_css
       end
     end
   end
+  Tilt.register Glorify::Template, 'markdown', 'mkd', 'md'
   register Glorify
 end

data/lib/glorify/extensions.rb ADDED

@@ -0,0 +1,9 @@
+module Sinatra
+  module Glorify
+    EXTENSIONS = { :filter_html => true,
+                   :autolink => true,
+                   :no_intra_emphasis => true,
+                   :fenced_code_blocks => true
+                 }
+  end
+end

data/lib/glorify/template.rb ADDED

@@ -0,0 +1,18 @@
+require 'redcarpet' unless defined? Redcarpet
+require 'tilt/template'
+module Sinatra
+  module Glorify
+    class Template < Tilt::Template
+      def prepare
+        @engine = Redcarpet::Markdown.new(Glorify::Renderer.new,
+                                          Glorify::EXTENSIONS)
+        @output = nil
+      end
+      def evaluate(scope, locals, &block)
+        @output ||= @engine.render(data)
+      end
+    end
+  end
+end

data/lib/glorify/version.rb CHANGED

@@ -1,5 +1,5 @@
 module Sinatra
   module Glorify
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/glorify/blocks.md ADDED

	@@ -0,0 +1 @@
1	+ ```puts "Hello, world!"```

data/spec/glorify/header.md ADDED

	@@ -0,0 +1 @@
1	+ # a sip of glory

data/spec/glorify/ruby_blocks.md ADDED

@@ -0,0 +1,5 @@
+```ruby
+def in_ruby?
+  return apples.all? { |a| a.to_s == 'ruby' }
+end
+```

data/spec/glorify/{ruby_blocks.erb → with_helper.erb} RENAMED

File without changes

data/spec/glorify_spec.rb CHANGED

@@ -8,7 +8,8 @@ describe Sinatra::Glorify do
   it "should parse a header" do
     mock_app do
-      get('/') { erb :header }
+      Tilt.prefer Sinatra::Glorify::Template
+      get('/') { markdown :header }
     end
     expected = "<h1>a sip of glory</h1>"
     get('/')
@@ -18,7 +19,8 @@ describe Sinatra::Glorify do
   it "should parse code blocks" do
     mock_app do
-      get('/') { erb :blocks }
+      Tilt.prefer Sinatra::Glorify::Template
+      get('/') { markdown :blocks }
     end
     expected = "<p><code>puts &quot;Hello, world!&quot;</code></p>"
     get('/')
@@ -27,17 +29,38 @@ describe Sinatra::Glorify do
   end
   it "should parse ruby blocks" do
+    mock_app do
+      get('/') do
+        Tilt.prefer Sinatra::Glorify::Template
+        markdown :ruby_blocks
+      end
+    end
+    get('/')
+    assert ok?
+    refute_empty Nokogiri::HTML(body).search("//div[@class = 'highlight']/pre")
+  end
+  it "should parse with a helper" do
     mock_app do
       get('/') do
         @some_code = File.open(
           File.expand_path('../glorify/some_code.md', __FILE__),
           "rb"
         ).read
-        erb :ruby_blocks
+        erb :with_helper
       end
     end
     get('/')
     assert ok?
     refute_empty Nokogiri::HTML(body).search("//div[@class = 'highlight']/pre")
   end
+  it "should include a valid css helper for pygments" do
+    mock_app
+    get('/pygments.css')
+    assert ok?
+    assert_match /text\/css/, content_type
+    assert_empty validate_css(body).errors
+  end
 end

data/spec/spec_helper.rb CHANGED

@@ -8,6 +8,7 @@ require 'nokogiri'
 require 'rack/test'
 require 'sinatra/base'
 require 'erb'
+require 'w3c_validators'
 Sinatra::Base.set :environment, :test
 Sinatra::Base.set :views, File.expand_path('../glorify', __FILE__)
@@ -15,6 +16,7 @@ Sinatra::Base.register Sinatra::Glorify
 class MiniTest::Spec
   include Rack::Test::Methods
+  include W3CValidators
   def mock_app(base=Sinatra::Base, &block)
     @app = Sinatra.new(base, &block)
@@ -31,4 +33,12 @@ class MiniTest::Spec
   def ok?
     last_response.ok?
   end
+  def content_type
+    last_response.headers['Content-Type']
+  end
+  def validate_css(css)
+    CSSValidator.new.validate_text css
+  end
 end

metadata CHANGED

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: glorify
 version: !ruby/object:Gem::Version
-  hash: 27
+  hash: 23
   prerelease:
   segments:
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Zachary Scott
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-05-22 00:00:00 Z
+date: 2012-06-15 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -118,7 +118,21 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id007
-description: Renders via redcarpet with syntax highlighting thanks to pygments.rb. Able to use fenced code blocks like github, and includes a default pygments stylesheet.
+- !ruby/object:Gem::Dependency
+  name: w3c_validators
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+description: Renders markdown via redcarpet with syntax highlighting thanks to pygments.rb. Able to use fenced code blocks like github, and includes a default pygments stylesheet.
 email:
 - zachary@zacharyscott.net
 executables: []
@@ -132,16 +146,19 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- example.rb
 - glorify.gemspec
 - lib/glorify.rb
 - lib/glorify/css.rb
+- lib/glorify/extensions.rb
 - lib/glorify/renderer.rb
+- lib/glorify/template.rb
 - lib/glorify/version.rb
-- spec/glorify/blocks.erb
-- spec/glorify/header.erb
-- spec/glorify/layout.erb
-- spec/glorify/ruby_blocks.erb
+- spec/glorify/blocks.md
+- spec/glorify/header.md
+- spec/glorify/ruby_blocks.md
 - spec/glorify/some_code.md
+- spec/glorify/with_helper.erb
 - spec/glorify_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/zzak/glorify

data/spec/glorify/blocks.erb DELETED

	@@ -1 +0,0 @@
1	- <%= glorify('```puts "Hello, world!"```') %>

data/spec/glorify/header.erb DELETED

	@@ -1 +0,0 @@
1	- <%= glorify("#a sip of glory") %>

data/spec/glorify/layout.erb DELETED

	@@ -1 +0,0 @@
1	- <%= yield %>