blogue 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a505062d8b893b86710be42e7cb204f57ba97875
-  data.tar.gz: 56d0545a6467270da541208b03b045e39b78ec7b
+  metadata.gz: 99a1b18f0e77e2213458bba2e7f20a720d38e9df
+  data.tar.gz: 15188b23ea69249bb5af6069c2c4b9caf7ce4c5d
 SHA512:
-  metadata.gz: 53fd19e403ba6c0cbe77b4c02fc801e8a86e1db055486781277945f302dccaf419f1c93b99524f909a1d06e06763f681d9816f059d50648e6e3fd2d995f5a699
-  data.tar.gz: 27d788f14d0c01486e2488f9fe9bd850d17da1509896f38fd3681aee89df905e3f5f2cc4e60dabc120ce48b35a1c1a392bbeb131cbf07056f7c610a3580c4fd4
+  metadata.gz: 2829448805a1711dfbeaf811d01d746c0ed148e0499706c3cee9cff683b43ddb77a633f7d0a0d79c50b03889d12428b64ffe5dcfcf843f476307d8860aef33c0
+  data.tar.gz: ddc82555f1a6a662e15a4aa66407bc0c68b1024e008271f708a0b9a0ffa8d321ca3f8a6437cd75d9fc921abc617da9a654ef940fb42fd1c39b4999beff9d40ae

data/README.md

@@ -1,6 +1,8 @@
 # Blogue
 
-Blogue is the static page blog that is also a rails engine. It means that you get all of rails, yet your blog is static. Best of both worlds.
+[![Build Status](https://api.travis-ci.org/maxim/blogue.png)](https://travis-ci.org/maxim/blogue)
+
+Blogue is a rails model for static blog posts, wrapped in an engine. It means that you can have blog posts as static files (kind of like views) inside your rails app, and hook up posts like any other resource. The only reason this is an engine and not just a class in a gem is because it also adds an asset path and a handler for .md views.
 
 ## What you get
 
@@ -14,41 +16,46 @@ Blogue is the static page blog that is also a rails engine. It means that you ge
 * Default controllers
 * Default views
 * Generators
+* Comments, tags or pretty much any functionality
 
-You just hook it up by hand any way you want.
+There are thousands of gems that you can pick from to do that stuff.
 
 ## Usage
 
 1. Generate a rails app (or use existing)
-2. Add `gem 'blogue'` to Gemfile and bundle
-3. Create a model `app/models/post.rb` (the name 'Post' is chosen at random)
+2. Add all needed gems to Gemfile and bundle
   ~~~ruby
-  class Post < Blogue::Post
-    # Here you can override inherited methods any way you like.
-    # See app/models/blogue/post.rb to see what you have
-  end
+    gem 'kramdown'
+    gem 'rouge'
+    gem 'blogue'
   ~~~
 
-4. Create a controller `app/controllers/posts_controller.rb`
+3. Create a model `app/models/post.rb` (the name 'Post' is chosen at random)
   ~~~ruby
-  class PostsController < ApplicationController
-    def index
-      @posts = Post.all
+    class Post < Blogue::Post
+      # Here you can override inherited methods any way you like.
+      # See app/models/blogue/post.rb to see what you have
     end
+  ~~~
 
-    def show
-      @post = Post.find(id)
+4. Create a controller `app/controllers/posts_controller.rb`
+  ~~~ruby
+    class PostsController < ApplicationController
+      def index
+        @posts = Post.all
+      end
+
+      def show
+        @post = Post.find(params[:id]) ||
+          raise(ActionController::RoutingError.new('Not Found'))
+      end
     end
-  end
   ~~~
 
 5. Add a route to your `config/routes.rb` like this
   ~~~ruby
-  # If you want an index page
-  root to: 'posts#index'
-
-  # Whitelist of your posts
-  Post.all.each { |post| get "/#{post.id}", to: 'posts#show', id: post.id }
+    root to: 'posts#index' # if you want an index page
+    get '/:id', to: 'posts#show'
   ~~~
 
 6. Add `app/views/posts/index.html.erb` for your index page
@@ -68,32 +75,32 @@ You just hook it up by hand any way you want.
 
 7. Add `app/views/posts/show.html.erb` for your post page
   ~~~erb
-  <%= link_to 'index', root_path %>
+    <%= link_to 'index', root_path %>
 
-  <%=raw render file: @post.path %>
+    <%=raw render file: @post.path %>
 
-  <% if @post.date %>
-  <p>Published on <%= @post.date.to_s(:long) %></p>
-  <% end %>
+    <% if @post.date %>
+    <p>Published on <%= @post.date.to_s(:long) %></p>
+    <% end %>
   ~~~
 
 8. Create a directory `app/posts` (that's default location of posts)
 9. Create a directory `app/posts/assets` (it's added to assets paths by default)
 10. Add a post like `app/posts/my-first-post.md`
-  ~~~markdown
-  # Yay my first post
 
-  This is some text.
+        # Yay my first post
 
-  ![picture](/assets/picture.jpg)
+        This is some text.
 
-  ~~~ruby
-  foo = 'foo' # a codeblock
-  ~~~
+        ![picture](/assets/picture.jpg)
+
+        ~~~ruby
+        foo = 'foo' # a codeblock
+        ~~~
+
+        <!--meta
+          date: 2013-10-21
+          tldr: Awesome
+        -->
 
-  <!--meta
-    date: 2013-10-21
-    tldr: Awesome
-  -->
-  ~~~
 11. Start server and go to http://localhost:3000/my-first-post

data/app/models/blogue/post.rb

@@ -60,6 +60,10 @@ module Blogue
       meta['tldr']
     end
 
+    def author_name
+      meta_author_name || config_author_name || whoami_author_name
+    end
+
     def meta
       YAML.load(
         body.lines.select do |line|
@@ -101,5 +105,17 @@ module Blogue
     def filename_title
       id.split(/[-_]/).join(' ').capitalize
     end
+
+    def meta_author_name
+      meta['author']
+    end
+
+    def config_author_name
+      Blogue.author_name
+    end
+
+    def whoami_author_name
+      `whoami`.strip
+    end
   end
 end

data/lib/blogue/version.rb

@@ -1,3 +1,3 @@
 module Blogue
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/blogue.rb

@@ -5,6 +5,7 @@ module Blogue
   mattr_accessor :assets_path
   mattr_accessor :markdown_format_handler
   mattr_accessor :kramdown_codeblock_handler
+  mattr_accessor :author_name
 
   self.posts_path = 'app/posts'
 

data/test/dummy/log/test.log

@@ -3726,3 +3726,99 @@ Started GET "/header-title" for 127.0.0.1 at 2013-10-21 00:00:25 -0400
 Processing by PostsController#show as HTML
   Parameters: {"id"=>"header-title"}
 Completed 200 OK in 8ms (Views: 6.3ms)
+-----------------------------------------------------
+Blogue::PostTest: test_date_returns_date_part_of_time
+-----------------------------------------------------
+------------------------------------------------------------
+Blogue::PostTest: test_extract_post_id_extracts_id_from_path
+------------------------------------------------------------
+-------------------------------------------------------------------------------------
+Blogue::PostTest: test_extract_post_id_extracts_id_from_path_with_multiple_extensions
+-------------------------------------------------------------------------------------
+---------------------------------------
+Blogue::PostTest: test_finds_post_by_id
+---------------------------------------
+-------------------------------------------------------------
+Blogue::PostTest: test_sort_posts_reverse-sorts_posts_by_time
+-------------------------------------------------------------
+----------------------------------------------------------------
+Blogue::PostTest: test_uses_file_creation_time_when_no_meta_date
+----------------------------------------------------------------
+-----------------------------------------------------------------------
+Blogue::PostTest: test_uses_filename_as_title_when_no_other_alternative
+-----------------------------------------------------------------------
+---------------------------------------------------------------
+Blogue::PostTest: test_uses_markdown_header_as_title_if_present
+---------------------------------------------------------------
+-------------------------------------------------
+Blogue::PostTest: test_uses_meta_title_if_present
+-------------------------------------------------
+-----------------------------------------------------
+Blogue::PostTest: test_uses_time_from_meta_when_given
+-----------------------------------------------------
+---------------------------------------------------------------------
+ConfigurationTest: test_adds_[posts_path]/assets_to_rails_asset_paths
+---------------------------------------------------------------------
+Started GET "/assets/dogue.jpg" for 127.0.0.1 at 2013-10-21 01:09:38 -0400
+-----------------------------------------------------
+ConfigurationTest: test_renders_codeblocks_with_rouge
+-----------------------------------------------------
+Started GET "/code-block" for 127.0.0.1 at 2013-10-21 01:09:38 -0400
+Processing by PostsController#show as HTML
+  Parameters: {"id"=>"code-block"}
+Completed 200 OK in 66ms (Views: 63.3ms)
+------------------------------------------------------
+ConfigurationTest: test_renders_markdown_with_kramdown
+------------------------------------------------------
+Started GET "/header-title" for 127.0.0.1 at 2013-10-21 01:09:38 -0400
+Processing by PostsController#show as HTML
+  Parameters: {"id"=>"header-title"}
+Completed 200 OK in 8ms (Views: 6.3ms)
+-----------------------------------------------------
+Blogue::PostTest: test_date_returns_date_part_of_time
+-----------------------------------------------------
+------------------------------------------------------------
+Blogue::PostTest: test_extract_post_id_extracts_id_from_path
+------------------------------------------------------------
+-------------------------------------------------------------------------------------
+Blogue::PostTest: test_extract_post_id_extracts_id_from_path_with_multiple_extensions
+-------------------------------------------------------------------------------------
+---------------------------------------
+Blogue::PostTest: test_finds_post_by_id
+---------------------------------------
+-------------------------------------------------------------
+Blogue::PostTest: test_sort_posts_reverse-sorts_posts_by_time
+-------------------------------------------------------------
+----------------------------------------------------------------
+Blogue::PostTest: test_uses_file_creation_time_when_no_meta_date
+----------------------------------------------------------------
+-----------------------------------------------------------------------
+Blogue::PostTest: test_uses_filename_as_title_when_no_other_alternative
+-----------------------------------------------------------------------
+---------------------------------------------------------------
+Blogue::PostTest: test_uses_markdown_header_as_title_if_present
+---------------------------------------------------------------
+-------------------------------------------------
+Blogue::PostTest: test_uses_meta_title_if_present
+-------------------------------------------------
+-----------------------------------------------------
+Blogue::PostTest: test_uses_time_from_meta_when_given
+-----------------------------------------------------
+---------------------------------------------------------------------
+ConfigurationTest: test_adds_[posts_path]/assets_to_rails_asset_paths
+---------------------------------------------------------------------
+Started GET "/assets/dogue.jpg" for 127.0.0.1 at 2013-10-21 01:10:00 -0400
+-----------------------------------------------------
+ConfigurationTest: test_renders_codeblocks_with_rouge
+-----------------------------------------------------
+Started GET "/code-block" for 127.0.0.1 at 2013-10-21 01:10:00 -0400
+Processing by PostsController#show as HTML
+  Parameters: {"id"=>"code-block"}
+Completed 200 OK in 48ms (Views: 46.5ms)
+------------------------------------------------------
+ConfigurationTest: test_renders_markdown_with_kramdown
+------------------------------------------------------
+Started GET "/header-title" for 127.0.0.1 at 2013-10-21 01:10:00 -0400
+Processing by PostsController#show as HTML
+  Parameters: {"id"=>"header-title"}
+Completed 200 OK in 7ms (Views: 5.7ms)

data/test/models/blogue/post_test.rb

@@ -36,7 +36,7 @@ module Blogue
     end
 
     test 'uses file creation time when no meta date' do
-      assert_equal '2013-10-19 19:54:41 UTC',
+      assert_equal File.ctime('test/fixtures/posts/minimal-post.md').utc.to_s,
         Post.find('minimal-post').time.utc.to_s
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blogue
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Maxim Chernyak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-21 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -125,7 +125,8 @@ files:
 - test/models/blogue/post_test.rb
 - test/test_helper.rb
 homepage: http://github.com/maxim/blogue
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []