rollin 0.0.16 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ade074bbfd7d18abfa9bca1ef589d5f3b56a099
-  data.tar.gz: c336bc00ea0c729578e6a448a2074b3843f88a57
+  metadata.gz: eec28f29a0e5d44ec5f898ec1cc57a5e2ceb7309
+  data.tar.gz: 747351059a59ee276bb140861d2b742fc4c976b2
 SHA512:
-  metadata.gz: ddd4e082b2aa1628ae152ca37e0f31eca19f0dd3aef2dceac5e7e7918e180097bd4e2e47732b9958484a8c1576e05438a90999e1f69dcc183d99f89d33adb400
-  data.tar.gz: 68b8e9837ae7cb3fbd36d32cd4498c8529019069ca2a4bb2fd274be552114d8688c4250cc75f4f0002787c2e4034f0b505a1eab804374e610676a1f66506adc2
+  metadata.gz: cb937284f72d047aba71e4cda7a0e1ba18ef88b66a842c784ff7a97c916f3233da72ae190169752981e5fdf9a1ffdb63aee7ee6a9f3080a328e02bea71c4ad9d
+  data.tar.gz: 1cc3d83c410c5febc1df9cc58257c614db44748d97e71e1bf4942ff65c0b8cb15dd03e24b656c2c0d43dc577c9b9edac463f6461bd8f92828af8128b7a4b7a5c

data/README.md

@@ -1,10 +1,10 @@
-# Rollin
+# rollin
 
 A Ruby minimalistic filesystem based blog engine made for developers.
 
-Different from other blog engines Rollin only does what matters, and leave the rest to you.
+Different from other blog engines, rollin only does what matters, and leave the rest to you.
 
-Rollin currently only supports Markdown format and uses the Github's awesome redcarpet.
+It currently supports Markdown format and uses the Github's awesome redcarpet.
 
 ## Installation
 
@@ -18,41 +18,39 @@ Add the dependency to your Gemfile:
 
 First you will need to have the following structure in your filesystem.
 
-    ├── my_posts
+    ├── posts
         └── 2013_05_01_My_first_post.mk
 
 ### Articles
-
-In your code.
     
-    blog = Rollin::Blog.new({article_folder: "my_posts"}) # Defaults to "articles"
+    blog = Rollin::Blog.new({articles_folder: "posts"}) # Defaults to "articles"
     
-    anArticle = blog.articles.first
+    first_post = blog.articles.first
 
-    anArticle.id     # => "2013_05_01_My_first_post"
-    anArticle.title  # => "My first post"
-    anArticle.body   # => "<h3>My first post!</h3>\n<p>blah blah blah</p>"
+    first_post.id     # => "2013_05_01_My_first_post"
+    first_post.title  # => "My first post"
+    first_post.body   # => "<h3>My first post!</h3>\n<p>blah blah blah</p>"
 
-    anArticle.date   # => #<Date: 2013-05-01 ((2456414j,0s,0n),+0s,2299161j)>
-    anArticle.year   # => 2013
-    anArticle.month  # => 05
-    anArticle.day    # => 01
+    first_post.date   # => #<Date: 2013-05-01 ((2456414j,0s,0n),+0s,2299161j)>
+    first_post.year   # => 2013
+    first_post.month  # => 05
+    first_post.day    # => 01
 
 ### Monthly archive
 
-    a_monthly_archive = blog.monthly_archive.first
+    may_archive = blog.monthly_archive.first
 
-    a_monthly_archive.year      # => 2013
-    a_monthly_archive.month     # => 5
-    a_monthly_archive.articles  # => [ Rollin::Article(:title => "My first post" ...) ]
+    may_archive.year      # => 2013
+    may_archive.month     # => 5
+    may_archive.articles  # => [ Rollin::Article(:title => "My first post" ...) ]
 
 ### Annual archive
 
-    an_annual_archive = blog.annual_archive.first
+    twenty_thirteen_archive = blog.annual_archive.first
 
-    an_annual_archive.year                 # => 2013
-    an_annual_archive.articles             # => [ Rollin::Article(:title => "My first post" ...) ]
-    an_annual_archive.monthly_archive      # => [ Rollin::MonthArchive(:year => 2013, :month => 5 ...) ]
+    twenty_thirteen_archive.year                 # => 2013
+    twenty_thirteen_archive.articles             # => [ Rollin::Article(:title => "My first post" ...) ]
+    twenty_thirteen_archive.monthly_archive      # => [ Rollin::MonthArchive(:year => 2013, :month => 5 ...) ]
 
 ### Finding an article
 

data/VERSION

@@ -1 +1 @@
-0.0.16
+0.1.0

data/lib/rollin/article.rb

@@ -1,16 +1,63 @@
 class Rollin::Article
-  attr_reader :id, :title, :year, :month, :day
+  attr_reader :id, :year, :month, :day
 
   def initialize(source_file)
     @source_file = source_file
     filename = File.basename(@source_file)
     @id = filename[0, filename.length - 3]
-    @title = filename[11, filename.length - 11 - 3].gsub('_', ' ')
+    @title_from_filename = filename[11, filename.length - 11 - 3].gsub('_', ' ')
     @year = filename[0, 4].to_i
     @month = filename[5, 2].to_i
     @day = filename[8, 2].to_i
   end
 
+  def title
+    metatags[:title] || @title_from_filename
+  end
+
+  def matches?(search)
+    search = search.clone
+
+    return true if @id == search
+
+    if search.has_key?(:year)
+      return false if search.delete(:year) != @year
+      if search.has_key?(:month)
+        return false if search.delete(:month) != @month
+        if search.has_key?(:day)
+          return false if search.delete(:day) != @day
+        end
+      end
+    end
+
+    if search.keys.empty?
+      return true
+    else
+      search.each do |key, value|
+        return true if metatags[key] != nil && (metatags[key] == value || metatags[key].include?(value))
+      end
+      return false
+    end
+  end
+
+  def metatags
+    # Stolen from Jekyll
+    begin
+      content = File.read(@source_file)
+
+      if content =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+        content = $POSTMATCH
+        return YAML.safe_load($1).inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      end
+    rescue SyntaxError => e
+      puts "YAML Exception reading #{File.join(@source_file)}: #{e.message}"
+    rescue Exception => e
+      puts "Error reading file #{File.join(@source_file)}: #{e.message}"
+    end
+
+    return {}
+  end
+
   def date
     Date.new(@year, @month, @day)
   end

data/lib/rollin/blog.rb

@@ -3,13 +3,15 @@ class Rollin::Blog
     @articles_folder = options[:articles_folder] || 'articles'
   end
 
-  def find_article_by_id(article_id)
-    articles.find { |article| article.id == article_id }
+  def article(search)
+    read_articles.find { |article| article.matches?(search) }
   end
 
-  def articles
-    Dir["#{@articles_folder}/**/*.mk"].sort.map do |article_source|
-      Rollin::Article.new(article_source)
+  def articles(search=nil)
+    if search.nil?
+      read_articles
+    else
+      read_articles.select { |article| article.matches?(search) }
     end
   end
 
@@ -27,4 +29,12 @@ class Rollin::Blog
       Rollin::MonthArchive.new(year, month, articles_for_month)
     end
   end
+
+  private
+
+  def read_articles
+    Dir["#{@articles_folder}/**/*.mk"].sort.map do |article_source|
+      Rollin::Article.new(article_source)
+    end
+  end
 end

data/lib/rollin.rb

@@ -1,5 +1,6 @@
 require "redcarpet"
 require "date"
+require "safe_yaml"
 
 require "rollin/version"
 require "rollin/blog"

data/rollin.gemspec

@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "version"
 
   spec.add_dependency "redcarpet"
+  spec.add_dependency "safe_yaml"
 end

data/spec/fixtures/{articles/2013_05_02_My_second_post.mk → 2013_05_02_My_second_post.mk}

@@ -1,3 +1,7 @@
+---
+title: This is a super post!
+---
+
 ## This is my second post
 
 Really awesome!!

data/spec/fixtures/2013_06_01_My_third_post.mk

@@ -0,0 +1,11 @@
+---
+tags:
+  - manero
+  - massa
+  - bacana
+published: false
+---
+
+## This is my second post
+
+Really awesome!!

data/spec/rollin_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+# Fixtures
+#
+# 2013_05_01_My_first_post.mk
+# 2013_05_02_My_second_post.mk
+# 2013_06_01_My_third_post.mk
+# 2014_01_01_My_fourth_post.mk
+
+describe 'how rollin works' do
+
+  subject (:blog) { Rollin::Blog.new(articles_folder: 'spec/fixtures') }
+
+  context 'article content' do
+    let (:article) { blog.articles.first }
+    let (:article_with_title_metatag) { blog.articles[1] }
+    let (:article_with_custom_metatags) { blog.articles[2] }
+
+    it 'exposes article information and content' do
+      article.id.should == '2013_05_01_My_first_post'
+      article.title.should == 'My first post'
+      article.year.should == 2013
+      article.month.should == 5
+      article.day.should == 1
+      article.date.should == Date.new(2013, 5, 1)
+      article.body.should == "<h2>This is my first post</h2>\n\n<p>And here we go!</p>\n"
+      article.metatags.should be_empty
+    end
+
+    it 'allows article title definition with metatag' do
+      article_with_title_metatag.title.should == 'This is a super post!'
+    end
+
+    it 'exposes the list of defined metatags' do
+      article_with_custom_metatags.metatags.should == { tags: ['manero', 'massa', 'bacana'], published: false }
+    end
+  end
+
+  context 'searching for articles' do
+    let (:first_article) { blog.articles.first }
+    let (:second_article) { blog.articles[1] }
+    let (:third_article) { blog.articles[2] }
+    let (:article_with_custom_metatags) { blog.articles[2] }
+
+    it 'searches by article id' do
+      blog.article('2013_05_01_My_first_post').should == first_article
+    end
+
+    it 'searches by metatags' do
+      blog.article(tags: 'manero').should == article_with_custom_metatags
+      blog.articles(tags: 'manero').should == [ article_with_custom_metatags ]
+
+      blog.article(published: false).should == article_with_custom_metatags
+      blog.articles(published: false).should == [ article_with_custom_metatags ]
+    end
+
+    it 'searches by date' do
+      blog.articles(year: 2013).should include(first_article, second_article, third_article)
+      blog.articles(year: 2013, month: 5).should include(first_article, second_article)
+      blog.articles(year: 2013, month: 5, day: 1).should include(first_article)
+    end
+
+    it 'narrows search by date when searching for metatags' do
+      blog.articles(year: 2013, :tags => 'manero').should { article_with_custom_metatags }
+      blog.articles(year: 2014, :tags => 'manero').should be_empty
+    end
+  end
+
+  context 'listing articles' do
+    let (:first_article) { TestArticle.new(id: '2013_05_01_My_first_post', title: 'My first post', date: Date.new(2013, 5, 1)) }
+    let (:second_article) { TestArticle.new(id: '2013_05_02_My_second_post', title: 'This is a super post!', date: Date.new(2013, 5, 2)) }
+    let (:third_article) { TestArticle.new(id: '2013_06_01_My_third_post', title: 'My third post', date: Date.new(2013, 6, 1)) }
+    let (:fourth_article) { TestArticle.new(id: '2014_01_01_My_fourth_post', title: 'My fourth post', date: Date.new(2014, 1, 1)) }
+
+    it 'lists all articles' do
+      blog.should have(4).articles
+
+      blog.articles[0].should == first_article
+      blog.articles[1].should == second_article
+      blog.articles[2].should == third_article
+      blog.articles[3].should == fourth_article
+    end
+
+    it 'provides monthly archive' do
+      blog.monthly_archive.should have(3).articles
+
+      blog.monthly_archive[0].year.should == 2013
+      blog.monthly_archive[0].month.should == 5
+      blog.monthly_archive[0].should have(2).articles
+      blog.monthly_archive[0].articles.should include(first_article, second_article)
+
+      blog.monthly_archive[1].year.should == 2013
+      blog.monthly_archive[1].month.should == 6
+      blog.monthly_archive[1].should have(1).articles
+      blog.monthly_archive[1].articles.should include(third_article)
+
+      blog.monthly_archive[2].year.should == 2014
+      blog.monthly_archive[2].month.should == 1
+      blog.monthly_archive[2].should have(1).articles
+      blog.monthly_archive[2].articles.should include(fourth_article)
+    end
+
+    it 'provides annual archive' do
+      blog.should have(2).annual_archive
+
+      blog.annual_archive[0].year.should == 2013
+      blog.annual_archive[0].should have(2).monthly_archive
+      blog.annual_archive[0].monthly_archive[0].year.should == 2013
+      blog.annual_archive[0].monthly_archive[0].month.should == 5
+      blog.annual_archive[0].monthly_archive[0].should have(2).articles
+      blog.annual_archive[0].monthly_archive[0].articles.should include(first_article, second_article)
+      blog.annual_archive[0].monthly_archive[1].year.should == 2013
+      blog.annual_archive[0].monthly_archive[1].month.should == 6
+      blog.annual_archive[0].monthly_archive[1].should have(1).articles
+      blog.annual_archive[0].monthly_archive[1].articles.should include(third_article)
+      blog.annual_archive[0].should have(3).articles
+      blog.annual_archive[0].articles.should include(first_article, second_article, third_article)
+
+      blog.annual_archive[1].year.should == 2014
+      blog.annual_archive[1].should have(1).monthly_archive
+      blog.annual_archive[1].monthly_archive[0].year.should == 2014
+      blog.annual_archive[1].monthly_archive[0].month.should == 1
+      blog.annual_archive[1].monthly_archive[0].should have(1).articles
+      blog.annual_archive[1].monthly_archive[0].articles.should include(fourth_article)
+      blog.annual_archive[1].should have(1).articles
+      blog.annual_archive[1].articles.should include(fourth_article)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,3 +3,19 @@ require 'bundler/setup'
 Bundler.require :development
 
 require './lib/rollin'
+
+class Rollin::Article
+  def ==(other)
+    id == other.id && title == other.title && date == other.date
+  end
+end
+
+class TestArticle
+  attr_reader :id, :title, :date
+
+  def initialize(properties)
+    @id = properties[:id]
+    @title = properties[:title]
+    @date = properties[:date]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollin
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.1.0
 platform: ruby
 authors:
 - marano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: version
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - thiagomarano@gmail.com
@@ -102,14 +130,11 @@ files:
 - lib/rollin/version.rb
 - lib/rollin/year_archive.rb
 - rollin.gemspec
-- spec/annual_archive_spec.rb
-- spec/article_spec.rb
-- spec/blog_spec.rb
-- spec/fixtures/articles/2013_05_01_My_first_post.mk
-- spec/fixtures/articles/2013_05_02_My_second_post.mk
-- spec/fixtures/articles/2013_06_01_My_third_post.mk
-- spec/fixtures/articles/2014_01_01_My_fourth_post.mk
-- spec/month_archive_spec.rb
+- spec/fixtures/2013_05_01_My_first_post.mk
+- spec/fixtures/2013_05_02_My_second_post.mk
+- spec/fixtures/2013_06_01_My_third_post.mk
+- spec/fixtures/2014_01_01_My_fourth_post.mk
+- spec/rollin_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/marano/rollin
 licenses:
@@ -136,12 +161,9 @@ signing_key:
 specification_version: 4
 summary: A Ruby minimalistic blog engine ... WATTT!!?!??
 test_files:
-- spec/annual_archive_spec.rb
-- spec/article_spec.rb
-- spec/blog_spec.rb
-- spec/fixtures/articles/2013_05_01_My_first_post.mk
-- spec/fixtures/articles/2013_05_02_My_second_post.mk
-- spec/fixtures/articles/2013_06_01_My_third_post.mk
-- spec/fixtures/articles/2014_01_01_My_fourth_post.mk
-- spec/month_archive_spec.rb
+- spec/fixtures/2013_05_01_My_first_post.mk
+- spec/fixtures/2013_05_02_My_second_post.mk
+- spec/fixtures/2013_06_01_My_third_post.mk
+- spec/fixtures/2014_01_01_My_fourth_post.mk
+- spec/rollin_spec.rb
 - spec/spec_helper.rb

data/spec/annual_archive_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-
-describe Rollin::YearArchive do
-  let (:article) { Rollin::Article.new('spec/fixtures/2013_05_01_My_first_post.mk') }
-  subject (:month_archive) { Rollin::MonthArchive.new(2013, 05, [ article ]) }
-  subject (:year_archive) { Rollin::YearArchive.new(2013, [ month_archive ]) }
-
-  it 'tells the year' do
-    year_archive.year.should == 2013
-  end
-
-  it 'has monthly archives' do
-    year_archive.monthly_archive.size.should == 1
-    year_archive.monthly_archive.first.should == month_archive
-  end
-
-  it 'has a list of articles' do
-    year_archive.articles.first.should == article
-  end
-end

data/spec/article_spec.rb

@@ -1,33 +0,0 @@
-require './spec/spec_helper'
-
-describe Rollin::Article do
-  subject (:article) { Rollin::Article.new('spec/fixtures/articles/2013_05_01_My_first_post.mk') }
-
-  it 'tells article id' do
-    article.id.should == '2013_05_01_My_first_post'
-  end
-
-  it 'tells article title' do
-    article.title.should == 'My first post'
-  end
-  
-  it 'compiles article body to html' do
-    article.body.should == "<h2>This is my first post</h2>\n\n<p>And here we go!</p>\n"
-  end
-
-  it 'tells article year' do
-    article.year.should == 2013
-  end
-
-  it 'tells article month' do
-    article.month.should == 5
-  end
-
-  it 'tells article day' do
-    article.day.should == 1
-  end
-
-  it 'tells article date' do
-    article.date.should == Date.new(2013, 5, 1)
-  end
-end

data/spec/blog_spec.rb

@@ -1,29 +0,0 @@
-require './spec/spec_helper'
-
-describe Rollin::Blog do
-  context 'reading articles from articles folder' do
-    subject (:blog) { Rollin::Blog.new(articles_folder: 'spec/fixtures/articles') }
-
-    it 'has the right amount of articles' do
-      blog.articles.size.should == 4
-    end
-
-    it 'has monthly archives' do
-      blog.monthly_archive.size.should == 3
-      blog.monthly_archive.first.class.should == Rollin::MonthArchive
-    end
-
-    it 'has annual archives' do
-      blog.annual_archive.size.should == 2
-      blog.annual_archive.first.class.should == Rollin::YearArchive
-      blog.annual_archive.first.monthly_archive.size.should == 2
-      blog.annual_archive.first.monthly_archive.first.class.should == Rollin::MonthArchive
-      blog.annual_archive.first.monthly_archive.first.articles.size.should == 2
-      blog.annual_archive.first.monthly_archive.first.articles.first.class.should == Rollin::Article
-    end
-
-    it 'finds article by its id' do
-      blog.find_article_by_id('2013_05_01_My_first_post').title.should == 'My first post'
-    end
-  end
-end

data/spec/fixtures/articles/2013_06_01_My_third_post.mk

@@ -1,3 +0,0 @@
-## This is my second post
-
-Really awesome!!

data/spec/month_archive_spec.rb

@@ -1,16 +0,0 @@
-describe Rollin::MonthArchive do
-  let (:article) { Rollin::Article.new('spec/fixtures/2013_05_01_My_first_post.mk') }
-  subject (:month_archive) { Rollin::MonthArchive.new(2013, 05, [ article ]) }
-
-  it 'tells the year' do
-    month_archive.year.should == 2013
-  end
-
-  it 'tells the month' do
-    month_archive.month.should == 5
-  end
-
-  it 'has a list of articles' do
-    month_archive.articles.first.should == article
-  end
-end