blogdown 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d81cd06eac2832629d42bd77ff6a816098d4679
-  data.tar.gz: e5d6a7e75944bcacccd67ede28ac0556778f24be
+  metadata.gz: 885b01ce2126bc63a1cfbd7043146d4882420246
+  data.tar.gz: b1376f914ae814507e524b5d557a3067a694501f
 SHA512:
-  metadata.gz: 335919844cd0d6b76ee39314937f0e6a68ba55c5b40c2869acfb7a1e70199e4bc53499ab0ed1f2afd7c0212976c5a4c5d8f7d3f2ffbdfc7e1ed2863e9f725c00
-  data.tar.gz: 6a114f4c632642d30c36c2c5698ec52255904dd04a819beda5d5da6e5fd85fb10dfd990c377b81f55d3bd0a7dc2be1afbeea9adc999828e7c4536d650e6c58ff
+  metadata.gz: 471ca516d1c92eb37546ae2e9985d9d82aab8aa2fce4ae3dc387758235a2351037e3b6f5f8717b3b173bcbe7e63649851bd18191acbe528c89dcc14f527bd3be
+  data.tar.gz: f5c7ac656ddc99104fcdbe438ad7476341dc6529aaf4ecc50dc141a606edc53c19e3b105e4e2164f6fcafce02f6ef437ae86968ed9ff424b16bcd1a3cf62a46a

data/.gitignore

@@ -1,23 +1,23 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+   - 2.0.0
+
+script: bundle exec rake

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in blogdown.gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blogdown.gemspec
 gemspec

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2014 gernest
-
-MIT License
-
-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.
+Copyright (c) 2014 gernest
+
+MIT License
+
+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.md

@@ -1,54 +1,53 @@
-# Blogdown
-
-## Features
-
-* Generates html from markdown files
-* Syntax highlighting with coderay
-* Built in server
-
-## Installation
-
-Run:
-
-    $ gem install blogdown
-
-## Usage
-
-Create a directory for your project
-
-    $ mkdir blogdown
-
-Inside your freshly created folder create another folder "posts"
-
-    $ cd blogdown
-    $ mkdir posts
-
-Now, put all your markdown files inside this "posts" folder, remember to use the `.md` extension
-eg. `hello.md`
-
-## 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.
-
-    $ blongdown server
-
-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/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`)
-5. Create a new Pull Request
+# Blogdown
+[![Build Status](https://travis-ci.org/gernest/blogdown.svg?branch=master)](https://travis-ci.org/gernest/blogdown)
+
+[![Coverage Status](https://coveralls.io/repos/gernest/blogdown/badge.png)](https://coveralls.io/r/gernest/blogdown)
+
+
+## What this is all about
+Blogdown helps to view your favorite github wiki offline. I created this
+project to help me, have a good source of documentation on my pc,
+since I dont have the privilege of internet access. I go online once in a
+while, and its frusttating when I ineed to go online to view documentation.
+
+
+
+
+## Installation
+
+Run:
+
+    $ gem install blogdown
+
+## Usage
+
+Clone your favorite wiki
+
+    $ git clone [The Wiki URL goes HERE]
+
+Cd into your wiki directory
+
+    $cd mywiki.wiki
+
+
+And, blog it down
+
+    $ blogdown server
+
+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.
+
+## Snapshots
+![blogdown](/1.PNG?raw=true "Blogdown")
+
+![blogdown](/2.PNG?raw=true "Blogdown")
+
+
+
+## Contributing
+
+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`)
+5. Create a new Pull Request

data/Rakefile

@@ -1,2 +1,13 @@
-require "bundler/gem_tasks"
-
+require "bundler/gem_tasks"
+
+
+require 'rspec/core/rake_task'
+
+desc "Run RSpec"
+RSpec::Core::RakeTask.new('spec')
+
+
+desc "Run tests, both RSpec and Cucumber"
+task :test => :spec
+
+task :default => :test

data/blogdown.gemspec

@@ -1,31 +1,33 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'blogdown/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "blogdown"
-  spec.version       = Blogdown::VERSION
-  spec.authors       = ["gernest"]
-  spec.email         = ["geofreyernest@live.com"]
-  spec.summary       = %q{Write in markdown for your web based rich text editor}
-  spec.description = %q{ A Simple Markdown Solution With synntax highlighing}
-  spec.homepage      = "https://github.com/gernest/blogdown"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake","~> 10.3.2"
-  spec.add_development_dependency "rspec","~>3.0.0"
-  spec.add_development_dependency "cucumber","~> 1.3.15"
-
-  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
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blogdown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blogdown"
+  spec.version       = Blogdown::VERSION
+  spec.authors       = ["gernest"]
+  spec.email         = ["geofreyernest@live.com"]
+  spec.summary       = %q{Turning your github wiki to a nice looking offline
+webpage}
+  spec.description = %q{ An offline github wiki viewer}
+  spec.homepage      = "https://github.com/gernest/blogdown"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake","~> 10.3.2"
+  spec.add_development_dependency "rspec","~>3.0.0"
+  spec.add_development_dependency "coveralls"
+
+  spec.add_dependency "redcarpet"
+  spec.add_dependency "github-markdown"
+
+  spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_dependency "sinatra", "~> 1.4.5"
+
+end

data/lib/blogdown.rb

@@ -1,13 +1,13 @@
-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
-end
+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
+end

data/lib/blogdown/app.rb

@@ -1,35 +1,15 @@
 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
+      @wiki_files=self.wiki_files
+      erb :index, :layout => :layout
+    end
+    def wiki_files
+      @sources=ENV['BD']
+      pub=Blogdown::Publisher.new(@sources)
+      pub.compose
     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

@@ -3,23 +3,10 @@ module Blogdown
     # 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
-        rescue Exception=>e
-          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

data/lib/blogdown/file_pipeline.rb

@@ -12,7 +12,8 @@ module Blogdown
 
     # @return [Array]  The files under posts folder
     def load_files
-      base_input=@root+'/posts'
+      puts "loading files from #{@root.to_s}"
+      base_input=@root
 
       base=Pathname.new(base_input)
       unless base.exist?
@@ -20,11 +21,12 @@ module Blogdown
       end
       if base.exist?
         base.each_child do|child|
-          if child.basename.to_s=~/^*.md$/
+            puts "loading #{child.to_s}"
             self.stack<<child
-          end
+            puts "Done"
         end
       end
+      puts "Finished loading #{self.stack.length} files"
     end
 
     # Writes given contents into a file with a name given as a parameter

data/lib/blogdown/publisher.rb

@@ -1,47 +1,48 @@
-require 'coderay'
-require 'kramdown'
+require 'redcarpet'
+require 'github/markdown'
 
 module Blogdown
   class Publisher
+    attr_accessor :renderer,:markdown
     def initialize root
       @pipeline=Blogdown::FilePipeline.new root
       @base=root
+      @output_stack={}
+      @renderer=Redcarpet::Render::HTML.new(render_options)
+      @markdown=Redcarpet::Markdown.new(@renderer, markdown_options)
     end
 
     def compose
-      clean_output
       if @pipeline.stack.empty?
         raise IOError, "No file to compose"
       else
         @pipeline.stack.each do |file|
-          htm=transform(file.read)
-          @pipeline.writer(file.basename,htm)
+          if file.file?
+            puts "processing #{file.to_s}"
+            htm=transform(file.read)
+            @output_stack[valid_id(file)]=htm
+            puts "done"
+          end
+
         end
       end
-
+      @output_stack
     end
 
     def transform(txt)
-      Kramdown::Document.new(txt,kramdown_options).to_html
+      self.markdown.render(GitHub::Markdown.render_gfm(txt))
     end
-
-    def file_stack
-      @pipeline.stack
+    def valid_id(v)
+      value=v.basename.to_s.gsub(/^*.([a-z]|[A-Z]){2,}$/,"")
+      value=value.gsub(" ","-")
     end
 
-    def clean_output
-      base_root=@base+'/output'
-      base_root=Pathname base_root
-      if base_root.exist?
-        base_root.rmtree
-        base_root.mkpath
-      else
-        base_root.mkpath
-      end
+    def render_options
+      {:with_toc_data=>false, :hard_warp=>true, :prettify=>true}
     end
 
-    def kramdown_options
-      {coderay_css: "style", coderay_line_numbers: nil}
+    def markdown_options
+      {:auto_link=>true}
     end
   end
 end