blogish 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Edwards
+
+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

@@ -0,0 +1,98 @@
+# Blogish
+
+Blogish is a tiny and powerful blogging engine, wrapped up in a Rubygem. It supports markdown-based entries, RSS feeds and syntax highlighting.
+
+It aims to provide the functions you need to create and display entries, but without dictating site layout or design. That makes it well suited for situations where you want to incorporate a simple blog into an pre-existing site.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blogish'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blogish
+
+## Usage
+
+```
+require 'blogish'
+```
+
+### Creating new posts
+
+Blogish reads entries stored in flat [markdown](http://daringfireball.net/projects/markdown/) files in a `views/blog` directory.
+
+It relies on certain conventions to work. Each entry should be named using the date of the entry and the URL slug, separated by an underscore and with the `.mkd` extension.
+
+```
+<date>_<slug>.mkd
+```
+
+The first line of the each entry should contain its title, then three dashes to separate it from the main body of the entry. Putting it all together:
+
+```
+$ cat views/blog/2013-02-07_hello-world.mkd
+Hello World!
+---
+This is the first paragraph.
+
+This is the second paragraph. Lorem ipsum dolor sit amet, consectetur adipisicing elit. Hic porro quae ea amet 
+dolores quibusdam magni illum harum unde tempore nisi totam adipisci quisquam aliquid quis ab necessitatibus? 
+Mollitia explicabo aperiam asperiores doloremque officiis ipsam. Animi distinctio a dolor consequuntur.
+```
+
+### Displaying a post
+
+You can display a single post based on it's slug using the `fetch` method. For example:
+
+```
+Blogish.fetch('hello-world')
+```
+
+If a matching entry is found, then a Hash with the contents of the post is returned. This Hash can then be passed to your view file, or wherever else you need to use the information.
+
+```
+{
+  :title => 'Hello World',
+  :date => #<Date: 2013-02-07 ((2456088j,0s,0n),+0s,2299161j)>,
+  :slug => 'hello-world',
+  :intro => '<p>This is the first paragraph</p>',
+  :body => '<p>This is the first paragraph</p><p>This is the second paragraph. Lorem ipsum ...</p>'
+}
+```
+
+If no entry with a matching slug is found, the method returns `nil`. 
+
+### Displaying multiple posts
+
+You can also display all entries using the `fetch_all` method. This returns an Array of all entries in the directory, sorted with the most recently dated first.
+
+```
+Blogish.fetch_all
+```
+
+This Array can then be passed to your view file, or wherever else you need to use it.
+
+### Using Syntax Highlighting
+
+Syntax highlighting is supported out of the box thanks to [Rouge](https://github.com/jayferd/rouge). A list of supported languages is [here](http://rouge.jayferd.us/demo). Simply wrap any code in your markdown files in fenced blocks, github style.
+
+<pre><code>```ruby
+# This is a comment
+@foo = bar
+```
+</code></pre>
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/blogish.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blogish/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "blogish"
+  gem.version       = Blogish::VERSION
+  gem.authors       = ["Alex Edwards"]
+  gem.email         = ["ajmedwards@gmail.com"]
+  gem.description   = %q{A tiny and powerful blogging engine, wrapped up in a Rubygem. Supports markdown-based posts, syntax highlighting, and RSS feeds.}
+  gem.summary       = %q{Markdown-based blog engine}
+  gem.homepage      = "https://github.com/alexedwards/blogish"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "redcarpet"
+  gem.add_dependency "rouge"
+
+  gem.add_development_dependency "rspec"
+end

data/lib/blogish/rouge_html.rb

@@ -0,0 +1,6 @@
+require 'rouge'
+require 'rouge/plugins/redcarpet'
+
+class RougeHTML < Redcarpet::Render::HTML
+  include Rouge::Plugins::Redcarpet
+end

data/lib/blogish/version.rb

@@ -0,0 +1,3 @@
+module Blogish
+  VERSION = "0.0.1"
+end

data/lib/blogish.rb

@@ -0,0 +1,77 @@
+require "redcarpet"
+require "blogish/version"
+require "blogish/rouge_html"
+
+module Blogish
+  extend self
+
+  # Fetch and parse a single blog entry based on its slug.
+  #
+  # * @params slug [String]
+  # * @return [nil] if no matching slug is found
+  # * @return [Hash] representing the blog entry if a matching slug is found.
+  #
+  # == Example:
+  #
+  # If we have a file named
+  #     views/blog/2013-02-07_hello-world.mkd
+  # then running
+  #     Blogish.fetch('hello-world')
+  # will find the file and return a hash containing the following keys:
+  #
+  # * :title [String]
+  # * :date [Date]
+  # * :slug [String]
+  # * :intro [String]
+  # * :body [String]
+
+  def fetch(slug)
+    path = entries.detect { |file| file =~ /_#{Regexp.quote(slug)}.mkd$/ }
+    path ? open(path) : nil
+  end
+
+  # Fetch and parse all blog entries in the `views/blog` directory, sorted
+  # by date with the most recent entry first.
+  #
+  # * @params none
+  # * @return [Array] of hashes representing each blog entry.
+  #
+  # == Example:
+  #
+  # If we have files named
+  #     views/blog/2013-02-07_hello-world.mkd
+  # and
+  #     views/blog/2013-02-05_foo-post.mkd
+  # then running
+  #     Blogish.fetch
+  # will return an Array containing both entries:
+  #     [{:title => 'Foo Post', ...}, {:title => 'Hello World', ...}]
+
+  def fetch_all
+    entries.sort.reverse.map { |entry| open(entry) }
+  end
+
+  private
+
+  def entries
+    Dir.chdir("views/blog") { glob("*.mkd") }
+  end
+
+  def open(path)
+    date, slug = path.chomp('.mkd').split('_', 2)
+    title, body = File.read(path).split(/^---+$/, 2)
+    date = Date.parse(date)
+    title.strip!
+    body = convert_to_html(body).strip
+    intro = convert_to_html(body.lines.map.first).strip
+    {date: date, title: title, slug: slug, body: body, intro: intro}
+  end
+
+  def convert_to_html(markdown)
+    renderer = RougeHTML
+    extensions = {fenced_code_blocks: true}
+    redcarpet = Redcarpet::Markdown.new(renderer, extensions)
+    redcarpet.render markdown
+  end
+
+end

data/spec/blogish_spec.rb

@@ -0,0 +1,66 @@
+require 'date'
+require_relative "../lib/blogish"
+
+describe Blogish do
+
+  before :each do
+    Blogish.stub!(:entries).and_return(['2013-02-03_hello-world.mkd', '2013-02-05_an-example-post.mkd', '2013-02-04_another-example-post.mkd'])
+    File.stub!(:read).with('2013-02-03_hello-world.mkd').and_return("Hello World\n---\nThis is an introduction.\n\nLorem ipsum dolor et sans.")
+    File.stub!(:read).with('2013-02-05_an-example-post.mkd').and_return("An Example Post\n---\nLorem ipsum dolor et sans.")
+    File.stub!(:read).with('2013-02-04_another-example-post.mkd').and_return("Another Example Post\n---\nLorem ipsum dolor et sans.")
+  end
+
+  describe "#fetch" do
+
+    context "when the slug is invalid" do
+
+      it "should return nil" do
+        Blogish.fetch('an-invalid-slug').should be nil
+      end
+
+    end
+
+    context "when the slug is valid" do
+
+      it "should return a hash of post information" do
+        Blogish.fetch('hello-world').should be_a_kind_of Hash
+      end
+
+      it "should contain the title" do
+        Blogish.fetch('hello-world')[:title].should eql 'Hello World'
+      end
+
+      it "should contain the date" do
+        Blogish.fetch('hello-world')[:date].to_s.should eql '2013-02-03'
+      end
+
+      it "should contain the slug" do
+        Blogish.fetch('hello-world')[:slug].should eql 'hello-world'
+      end
+
+      it "should contain the body as html" do
+        Blogish.fetch('hello-world')[:body].should eql "<p>This is an introduction.</p>\n\n<p>Lorem ipsum dolor et sans.</p>"
+      end
+
+      it "should contain the introductory paragraph as html" do
+        Blogish.fetch('hello-world')[:intro].should eql "<p>This is an introduction.</p>"
+      end
+
+    end
+
+  end
+
+  describe "#fetch_all" do
+
+    it "should return all entries" do
+      Blogish.fetch_all.size.should eql 3
+    end
+
+    it "should order the entries most recent first" do
+      dates = Blogish.fetch_all.map {|x| x[:date].to_s }
+      dates.should eql ["2013-02-05", "2013-02-04", "2013-02-03"]
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: blogish
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alex Edwards
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &19413020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19413020
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: &19412520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19412520
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &19411840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19411840
+description: A tiny and powerful blogging engine, wrapped up in a Rubygem. Supports
+  markdown-based posts, syntax highlighting, and RSS feeds.
+email:
+- ajmedwards@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blogish.gemspec
+- lib/blogish.rb
+- lib/blogish/rouge_html.rb
+- lib/blogish/version.rb
+- spec/blogish_spec.rb
+homepage: https://github.com/alexedwards/blogish
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Markdown-based blog engine
+test_files:
+- spec/blogish_spec.rb