blogdown 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9eba8d10ef0fb358e045c00490ded930e13cbba0
-  data.tar.gz: 3f5508967a15fbae4a3bfa7d7089432947e94a47
+  metadata.gz: e19d427da983e276121f038c43dd14e56bc3dd4d
+  data.tar.gz: c7e73cf46279b3227f78c05542695252c314a204
 SHA512:
-  metadata.gz: 9d6cfe69b98cecc9e6af56223a000b137aefa1837cf1591f021914ef8a48066d4c78c27e5a612348f5f88cc952d0af64e50ce888c89e6c3a852b19b2c1a07d8a
-  data.tar.gz: 8bd6b80c4b8d9ad3823893e3fce3abfddc685c23abd80a534196311996abb521afbe330bdbdb17c44847b15840449d9a5fb8142c984b5065621920b7bfa945d9
+  metadata.gz: c979718291944fbd040060d4c9547ab4c6d77caab593399f6665ae84065fc953fb68e2b50d2ea64021f6074c01c57f5226d38375866a28035c991dcc88dd2e1d
+  data.tar.gz: 3c119d2dc2bfa8a78ae686820f979d3717e6e737d50f25c8a000ffdb1b47d3cbc82e00ce18a8d7fbeed60c7460ff5e3e4890b5840a6c78ebdd43c5138a31d635

data/README.md

@@ -1,53 +1,54 @@
 # Blogdown
 
 ## Features
-* syntax highlighting
-* easy to use
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'blogdown'
-
-And then execute:
+* Generates html from markdown files
+* Syntax highlighting with coderay
+* Built in server
+* Simple and beautiful UI
 
-    $ bundle
+## Installation
 
-Or install it yourself as:
+Run:
 
     $ gem install blogdown
 
-
-## What it does
-
-This gem converts markdown files to html files
-
-
 ## Usage
 
 Create a directory for your project
 
-    mkdir blogdown
+    $ mkdir blogdown
 
 Inside your freshly created folder create another folder "posts"
 
-    cd blogdown
-    mkdir posts
+    $ cd blogdown
+    $ mkdir posts
 
-Now, put all your markdown files inside this "posts" folder, remember to use the `.md` extendion
+Now, put all your markdown files inside this "posts" folder, remember to use the `.md` extension
 eg. `hello.md`
 
-If you are done, and wish to build your html, for your rich text editor,
-navigate to your project root directory (our case 1blogdown`), And Run
+## Building html
+
+If you are only interested in getting html files, navigate to the project root directory and run the following command.
+
+    $ blogdown build
+
+This will create `output` directory and dump all html files there. The naming convention is simple.
+`hello.md` will produce `hello.md.html`.
+
+## Serving the files
+
+In some cases you might be interested to see what they might be like in a browser. There is a feature for you.
+Just navigate to the project root and run.
 
-    blogdown build
+    $ blongdown server
 
-A new directory "output" will be created and the respective output files(html) will be inside the folder
+Behing the scene, the command will build the project first, and run a webserver which will be available at `http://localhost:4567`
+copy `http://localhost:4567` and paste into your browser to see the files and view them with much more options.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/blogdown/fork )
+1. Fork it ( https://github.com/gernest/blogdown/fork )
 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`)

data/blogdown.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "kramdown", "~> 1.4.0"
   spec.add_dependency "coderay", "~> 1.1.0"
   spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_dependency "sinatra", "~> 1.4.5"
+
 end

data/features/server.feature

@@ -0,0 +1,8 @@
+Feature: Serving The Files
+  I need to preview my posts in the browser
+
+  Scenario: The index page
+    When I run command "server"
+    When I visit "/"
+    Then I should see an Index Page
+

data/features/step_definitions/blogdown_steps.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+When(/^I run command "(.*?)"$/) do |cmd|
+  args=Array.new
+  args<<cmd
+  Blogdown::Cli::CommandLine.start args
+end
+
+
+When(/^I visit "(.*?)"$/) do |arg1|
+end
+
+Then(/^I should see an Index Page$/) do
+  pending # express the regexp above with the code you wish you had
+end

data/lib/blogdown/app.rb

@@ -0,0 +1,35 @@
+module Blogdown
+  class PreviewApp<Sinatra::Application
+
+    helpers do
+      def built_files
+        @output=ENV['BD']+'/output'
+        @files =[]
+        out    =Pathname(@output)
+        out.each_child do |child|
+          if child.extname==".html"
+            @files<<child
+          end
+        end
+        @files
+      end
+    end
+    get '/' do
+      erb :home, :layout => :base
+    end
+
+
+    # Serves generated files found in the ouput folder
+    # It does so, by reading the files, and dumping the string to be rendered with `erb`
+    get '/post/:name' do |file_name|
+      @source_dir=ENV['BD']+'/output/'+file_name.gsub('-', '_')+'.md.html'
+      @path      =Pathname(@source_dir)
+      if @path.file?
+        @title=@path.basename.to_s.gsub('.html', '')
+        erb @path.read, :layout => :post
+      else
+        halt 404
+      end
+  end
+  end
+end

data/lib/blogdown/cli.rb

@@ -1,12 +1,12 @@
-require 'thor'
-
-
 module Blogdown
   module Cli
+    # Commandline app for blogdown
     class CommandLine<Thor
 
       desc "build", "builds the html files"
       def build
+        # Builds html files from markdown files, located in output
+        # and posts folders respectively
         begin
           publisher=Blogdown::Publisher.new(Dir.pwd)
           publisher.compose
@@ -14,6 +14,14 @@ module Blogdown
           puts e.message
         end
       end
+
+      desc "server", "serves the project for preview"
+      def server
+        # Runs Sinatra built in server on the project root drectory
+        ENV['BD']=Dir.pwd
+        build
+        Blogdown::PreviewApp.run!
+      end
     end
   end
 end

data/lib/blogdown/exceptions.rb

@@ -1,7 +1,6 @@
 module Blogdown
   module Exceptions
     class DirectoryNotFound<Exception
-
     end
   end
 end

data/lib/blogdown/file_pipeline.rb

@@ -1,5 +1,7 @@
 module Blogdown
   class FilePipeline
+    # THis keeps track of files being processed
+
     attr_accessor :stack
     def initialize(root)
       @root=root
@@ -8,6 +10,7 @@ module Blogdown
       load_files
     end
 
+    # @return [Array]  The files under posts folder
     def load_files
       base_input=@root+'/posts'
 
@@ -24,11 +27,19 @@ module Blogdown
       end
     end
 
+    # Writes given contents into a file with a name given as a parameter
+    # @param name [String] The name of the file to be written
+    # @param contents [String] The contents to be written on the file
     def writer(name,contents)
       file=@base.to_s+"/output/#{name}.html"
-      file=File.new(file.to_s,"w")
-      file.write(contents)
-      file.close
+
+      begin
+        file=File.new(file.to_s,"w")
+        file.write(contents)
+        file.close
+      rescue Exception=>e
+        raise e
+      end
     end
   end
 end

data/lib/blogdown/version.rb

@@ -1,3 +1,3 @@
-module Blogdown
-  VERSION = "0.0.2"
-end
+module Blogdown
+  VERSION = "0.1.0"
+end

data/lib/blogdown.rb

@@ -1,8 +1,12 @@
 require 'pathname'
+require 'sinatra'
+require 'thor'
+
 require "blogdown/version"
 require 'blogdown/exceptions'
 require 'blogdown/file_pipeline'
 require 'blogdown/publisher'
+require 'blogdown/app'
 require 'blogdown/cli'
 
 module Blogdown

data/lib/public/stylesheets/print.css

@@ -0,0 +1,226 @@
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed, 
+figure, figcaption, footer, header, hgroup, 
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  font-size: 100%;
+  font: inherit;
+  vertical-align: baseline;
+}
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure, 
+footer, header, hgroup, menu, nav, section {
+  display: block;
+}
+body {
+  line-height: 1;
+}
+ol, ul {
+  list-style: none;
+}
+blockquote, q {
+  quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+  content: '';
+  content: none;
+}
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+body {
+  font-size: 13px;
+  line-height: 1.5; 
+  font-family: 'Helvetica Neue', Helvetica, Arial, serif;
+  color: #000;
+}
+
+a {
+  color: #d5000d;
+  font-weight: bold;
+}
+
+header {
+  padding-top: 35px;
+  padding-bottom: 10px;
+}
+
+header h1 {
+  font-weight: bold;
+  letter-spacing: -1px;
+  font-size: 48px;
+  color: #303030;
+  line-height: 1.2;
+}
+
+header h2 {
+  letter-spacing: -1px;
+  font-size: 24px;
+  color: #aaa;
+  font-weight: normal;
+  line-height: 1.3;
+}
+#downloads {
+  display: none;
+}
+#main_content {
+  padding-top: 20px;
+}
+
+code, pre {
+  font-family: Monaco, "Bitstream Vera Sans Mono", "Lucida Console", Terminal;
+  color: #222;
+  margin-bottom: 30px;
+  font-size: 12px;
+}
+
+code {
+  padding: 0 3px;
+}
+
+pre {
+  border: solid 1px #ddd;
+  padding: 20px;
+  overflow: auto;
+}
+pre code {
+  padding: 0;
+}
+
+ul, ol, dl {
+  margin-bottom: 20px;
+}
+
+
+/* COMMON STYLES */
+
+table {
+  width: 100%;
+  border: 1px solid #ebebeb;
+}
+
+th {
+  font-weight: 500;
+}
+
+td {
+  border: 1px solid #ebebeb;
+  text-align: center; 
+  font-weight: 300;
+}
+
+form {
+  background: #f2f2f2;
+  padding: 20px;
+  
+}
+
+
+/* GENERAL ELEMENT TYPE STYLES */
+
+h1 {
+  font-size: 2.8em;
+} 
+
+h2 {
+  font-size: 22px;
+  font-weight: bold;
+  color: #303030;
+  margin-bottom: 8px;
+} 
+
+h3 {
+  color: #d5000d;
+  font-size: 18px;
+  font-weight: bold;
+  margin-bottom: 8px;
+} 
+ 
+h4 {
+  font-size: 16px;
+  color: #303030;
+  font-weight: bold;
+} 
+
+h5 {
+  font-size: 1em;
+  color: #303030;
+} 
+
+h6 {
+  font-size: .8em;
+  color: #303030;
+} 
+
+p {
+  font-weight: 300;
+  margin-bottom: 20px;
+}
+ 
+a {
+  text-decoration: none;
+}
+
+p a {
+  font-weight: 400;
+}
+
+blockquote {
+  font-size: 1.6em;
+  border-left: 10px solid #e9e9e9;
+  margin-bottom: 20px;
+  padding: 0 0 0 30px;
+}
+
+ul li {
+  list-style: disc inside;
+  padding-left: 20px;
+}
+
+ol li {
+  list-style: decimal inside;
+  padding-left: 3px;
+}
+
+dl dd {
+  font-style: italic;
+  font-weight: 100;
+}
+
+footer {
+  margin-top: 40px;
+  padding-top: 20px;
+  padding-bottom: 30px;
+  font-size: 13px;
+  color: #aaa;
+}
+
+footer a {
+  color: #666;
+}
+
+/* MISC */
+.clearfix:after {
+  clear: both;
+  content: '.';
+  display: block;
+  visibility: hidden;
+  height: 0;
+}
+
+.clearfix {display: inline-block;}
+* html .clearfix {height: 1%;}
+.clearfix {display: block;}

data/lib/public/stylesheets/pygment_trac.css

@@ -0,0 +1,69 @@
+.highlight  { background: #ffffff; }
+.highlight .c { color: #999988; font-style: italic } /* Comment */
+.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.highlight .k { font-weight: bold } /* Keyword */
+.highlight .o { font-weight: bold } /* Operator */
+.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
+.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #999999 } /* Generic.Heading */
+.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #555555 } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold; } /* Generic.Subheading */
+.highlight .gt { color: #aa0000 } /* Generic.Traceback */
+.highlight .kc { font-weight: bold } /* Keyword.Constant */
+.highlight .kd { font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.highlight .m { color: #009999 } /* Literal.Number */
+.highlight .s { color: #d14 } /* Literal.String */
+.highlight .na { color: #008080 } /* Name.Attribute */
+.highlight .nb { color: #0086B3 } /* Name.Builtin */
+.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .ni { color: #800080 } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nn { color: #555555 } /* Name.Namespace */
+.highlight .nt { color: #000080 } /* Name.Tag */
+.highlight .nv { color: #008080 } /* Name.Variable */
+.highlight .ow { font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sb { color: #d14 } /* Literal.String.Backtick */
+.highlight .sc { color: #d14 } /* Literal.String.Char */
+.highlight .sd { color: #d14 } /* Literal.String.Doc */
+.highlight .s2 { color: #d14 } /* Literal.String.Double */
+.highlight .se { color: #d14 } /* Literal.String.Escape */
+.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
+.highlight .si { color: #d14 } /* Literal.String.Interpol */
+.highlight .sx { color: #d14 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #d14 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #008080 } /* Name.Variable.Class */
+.highlight .vg { color: #008080 } /* Name.Variable.Global */
+.highlight .vi { color: #008080 } /* Name.Variable.Instance */
+.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
+
+.type-csharp .highlight .k { color: #0000FF }
+.type-csharp .highlight .kt { color: #0000FF }
+.type-csharp .highlight .nf { color: #000000; font-weight: normal }
+.type-csharp .highlight .nc { color: #2B91AF }
+.type-csharp .highlight .nn { color: #000000 }
+.type-csharp .highlight .s { color: #A31515 }
+.type-csharp .highlight .sc { color: #A31515 }