blog-generator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48df4a50c077eb56d0cb24ea7eef27a430b3ad16
-  data.tar.gz: 1ac90bf92d9bb55f32e51c01b95f431a058935ce
+  metadata.gz: 6f1d0ff16391680e7a1feb4dd62f7249ab4030e0
+  data.tar.gz: 38bae8eb5d26ea606aeea6e0e82766da615b3159
 SHA512:
-  metadata.gz: 34f40f9ab1eeed3994261cd5ed287883ab214825619de8d545ba657721a504588a901f098cb3ff62d64104bb5354e7dce02bc4b249094d3de819fddc469d33b2
-  data.tar.gz: 37113b5c7f50b2ce0fbb4b7e4375343604788c618725dcf4f886f6cc181f2bc4044c38f00a3a0bf050cb05b9afab2298d160ffbc651f193ba5bc2656cdc673f3
+  metadata.gz: 754eafed7232e1c80bb8924e1e33dc3c7c9567231268adca87f501efc05d61b9008ee7fc8eca29d45a583c251c63f1dfbf0cf4fe2dec54ec52380b8586897c49
+  data.tar.gz: 82700d910962e9d63d877d70531788f7d0af2eda225dd043de1dd081e64a0040bae7c778d8ee41a0ead96983769c8ef0ab99c9be9fb61a715e2a3905ecc31128

data/README.md

@@ -0,0 +1,56 @@
+# About
+
+Few years back we used to use all the fancy static site generators for building a blog, so the blog could have layouts, tags, pagination and other features. With the arrival of frontend frameworks such as AngularJS, this is no longer necessary.
+
+We can generate a static JSON API and let AngularJS handle the rest.
+
+# Usage
+
+gem install blog-generator
+gem install redcarpet # If you are going to use markdown.
+mkdir botanicus.me
+cd botanicus.me
+mkdir posts
+blog-generator.rb posts api
+
+# Post structure
+
+```html
+title: 'Hello world!'
+tags: ['Hello world', 'Test']
+---
+
+<div id="excerpt">
+  Excerpt
+</div>
+
+
+<h1>Hello world!</h1>
+<p>
+  Lorem ipsum dolor sit amet, consectetur adipisicing elit. Soluta quibusdam necessitatibus tempore ullam incidunt amet omnis, veritatis dicta quisquam accusamus at provident vel facere corporis sed fugiat cumque. Consequuntur, necessitatibus!
+</p>
+```
+
+## Assumptions
+
+- Metadata `title` and optionally `tags`.
+- Metadata `draft: true` will exclude the post.
+- Any other metadata can be added and will be accessible in the resulting JSON.
+- Body has `#excerpt`.
+- Format `posts/:published_on-:slug.:format`.
+
+# Routes generated
+
+- `slug` and `published_on` added to metadata.
+- `/posts.json`
+- `/posts/:slug.json`
+- `/tags.json`
+- `/tags/:slug.json`
+
+# Status
+
+It works, but it needs polishing. Integration specs are OK, unit tests are broken.
+
+# TODO
+
+- GH markdown including source code support.

data/bin/blog-generator.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+# [Usage]
+#
+# blog-generator.rb [posts dir] [output base path]
+
+require 'blog-generator'
+
+POSTS_DIR, OUTPUT_BASE_PATH = ARGV
+
+unless ARGV.length == 2
+  abort "Usage: #{$0} [posts dir] [output base path]"
+end
+
+unless File.directory?(POSTS_DIR)
+  abort "Posts directory #{POSTS_DIR} doesn't exist."
+end
+
+# Parse the posts.
+generator = BlogGenerator::Generator.parse(POSTS_DIR)
+
+unless File.directory?(OUTPUT_BASE_PATH)
+  puts "~ #{OUTPUT_BASE_PATH} doesn't exist, creating."
+  Dir.mkdir(OUTPUT_BASE_PATH)
+end
+
+# Generate.
+
+Dir.chdir(OUTPUT_BASE_PATH) do
+  # GET /api/posts.json
+  File.open('posts.json', 'w') do |file|
+    # This calls PostList#to_json
+    file.puts(JSON.pretty_generate(generator.posts))
+  end
+
+  # GET /api/posts/hello-world.json
+  Dir.mkdir('posts') unless Dir.exist?('posts')
+  generator.posts.each do |post|
+    File.open("posts/#{post.slug}.json", 'w') do |file|
+      file.puts(JSON.pretty_generate(post))
+    end
+  end
+
+  # GET /api/tags.json
+  File.open('tags.json', 'w') do |file|
+    # [{title: x, slug: y}]
+    tags = generator.tags.map do |tag, _|
+      tag
+    end
+    file.puts(JSON.pretty_generate(tags))
+  end
+
+  # GET /api/tags/doxxu.json
+  Dir.mkdir('tags') unless Dir.exist?('tags')
+  generator.tags.each do |tag, posts|
+    File.open("tags/#{tag[:slug]}.json", 'w') do |file|
+      file.puts(JSON.pretty_generate(posts))
+    end
+  end
+end

data/lib/blog-generator.rb

@@ -0,0 +1,37 @@
+require 'json'
+
+require 'blog-generator/post'
+require 'blog-generator/post_list'
+
+module BlogGenerator
+  class Generator
+    def self.parse(posts_dir)
+      posts = Dir.glob("#{posts_dir}/*.{html,md}").reduce(PostList.new) do |posts, path|
+        post = Post.new(path)
+        puts "~ Parsing #{post.inspect}"
+        posts.push(post)
+      end
+
+      self.new(posts)
+    end
+
+    attr_reader :posts
+    def initialize(posts)
+      @posts = posts
+    end
+
+    def tags
+      @posts.reduce(Hash.new) do |buffer, post|
+        puts; puts
+        p post
+        puts; puts
+        post.tags.each do |tag|
+          buffer[tag] ||= PostList.new
+          buffer[tag] << post
+        end
+
+        buffer
+      end
+    end
+  end
+end

data/lib/blog-generator/post.rb

@@ -0,0 +1,76 @@
+require 'json'
+require 'date'
+require 'yaml'
+require 'nokogiri'
+
+module BlogGenerator
+  class Post
+    REGEXP = /^(\d{4}-\d{2}-\d{2})-(.+)\.(html|md)$/
+
+    attr_reader :metadata
+    def initialize(path)
+      @path = path
+
+      @metadata = YAML.load_file(path).reduce(Hash.new) do |buffer, (key, value)|
+        buffer.merge(key.to_sym => value)
+      end
+
+      published_on, slug, format = parse_path(path)
+
+      @body = convert_markdown(self.body) if format == :md
+      self.body # cache if it wasn't called yet
+
+      @metadata.merge!(slug: slug, published_on: published_on)
+      @metadata.merge!(excerpt: excerpt)
+
+      @metadata[:tags].map! do |tag|
+        {title: tag, slug: generate_slug(tag)}
+      end
+
+      document = Nokogiri::HTML(self.body)
+      document.css('#excerpt').remove
+      @body = document.css('body').inner_html.strip
+    end
+
+    def generate_slug(name)
+      name.downcase.tr(' /', '-').delete('!?')
+    end
+
+    # Maybe rename body -> raw_body and to_html -> body.
+    def body
+      @body ||= File.read(@path).match(/\n---\n(.+)$/m)[1].strip
+    end
+
+    # We're converting it to MD, apparently it's necessary even though we converted the whole text initially, but it seems like MD ignores whatever is in <div id="excerpt">...</div>.
+    def excerpt
+      @excerpt ||= Nokogiri::HTML(convert_markdown(Nokogiri::HTML(self.body).css('#excerpt').inner_html.strip)).css('p').inner_html
+    end
+
+    def as_json
+      @metadata.merge(body: body)
+    end
+
+    def to_json(*args)
+      self.as_json.to_json(*args)
+    end
+
+    private
+    def method_missing(method, *args, &block)
+      return super if (! args.empty?) || block
+      @metadata[method]
+    end
+
+    def parse_path(path)
+      match = File.basename(path).match(REGEXP)
+      [Date.parse(match[1]), match[2], match[3].to_sym]
+    end
+
+    def convert_markdown(markup)
+      require 'redcarpet'
+
+      renderer = Redcarpet::Render::HTML.new(no_links: true, hard_wrap: true)
+      markdown = Redcarpet::Markdown.new(renderer, extensions = {})
+      markdown.render(markup)
+    end
+  end
+end

data/lib/blog-generator/post_list.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'forwardable'
+
+module BlogGenerator
+  class PostList
+    extend Forwardable
+
+    attr_reader :posts
+    def initialize
+      @posts = Array.new
+    end
+
+    def_delegators :@posts, :reduce, :each
+
+    def as_json
+      self.posts.map do |post|
+        post.as_json.tap do |metadata|
+          metadata.delete(:body)
+        end
+      end
+    end
+
+    def to_json(*args)
+      self.as_json.to_json(*args)
+    end
+
+    [:push, :<<].each do |method|
+      define_method(method) do |*args, &block|
+        @posts.send(method, *args, &block)
+        self # Important!
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blog-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - James C Russell
@@ -24,14 +24,21 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-description: 
-email: 
-executables: []
+description: '...'
+email: james@101ideas.cz
+executables:
+- blog-generator.rb
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: 
-licenses: []
+files:
+- README.md
+- bin/blog-generator.rb
+- lib/blog-generator.rb
+- lib/blog-generator/post.rb
+- lib/blog-generator/post_list.rb
+homepage: http://github.com/botanicus/blog-generator
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []