rollin 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eec28f29a0e5d44ec5f898ec1cc57a5e2ceb7309
-  data.tar.gz: 747351059a59ee276bb140861d2b742fc4c976b2
+  metadata.gz: a2c32191bfacf8a3806320873f8616bcd527ac8c
+  data.tar.gz: f00eddf1f6e960db06dbb6c854a46fbb9be0e3f7
 SHA512:
-  metadata.gz: cb937284f72d047aba71e4cda7a0e1ba18ef88b66a842c784ff7a97c916f3233da72ae190169752981e5fdf9a1ffdb63aee7ee6a9f3080a328e02bea71c4ad9d
-  data.tar.gz: 1cc3d83c410c5febc1df9cc58257c614db44748d97e71e1bf4942ff65c0b8cb15dd03e24b656c2c0d43dc577c9b9edac463f6461bd8f92828af8128b7a4b7a5c
+  metadata.gz: 6585b788143321aa37e98ad8d80530fc3733464439c0f0134fdab205d05798c1dc17dc11b5b0f7eb4e2536cf96ea48951931df1792a97d2c3632f75f4983ea51
+  data.tar.gz: 17803515ff2bf385fb0740b1bdbce0531c62df2a412a585f5f2e487ca56b5b7b5e114c0cf56ca686b56b0c2b59c5f5839611b11ed7d9be13c4d5abd91fe241b2

data/README.md

@@ -25,18 +25,72 @@ First you will need to have the following structure in your filesystem.
     
     blog = Rollin::Blog.new({articles_folder: "posts"}) # Defaults to "articles"
     
-    first_post = blog.articles.first
+    article = blog.articles.first
 
-    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>"
+    article.id        # => "2013_05_01_My_first_post"
+    article.title     # => "My first post"
+    article.body      # => "<h3>My first post!</h3>\n<p>blah blah blah</p>"
 
-    first_post.date   # => #<Date: 2013-05-01 ((2456414j,0s,0n),+0s,2299161j)>
-    first_post.year   # => 2013
-    first_post.month  # => 05
-    first_post.day    # => 01
+    article.date      # => #<Date: 2013-05-01 ((2456414j,0s,0n),+0s,2299161j)>
+    article.year      # => 2013
+    article.month     # => 05
+    article.day       # => 01
 
-### Monthly archive
+### Metatags
+
+You may define articles metatags at the begging of your article with the format:
+
+    ---
+    author: Zé
+    title: My new awesome blog!
+    tags: development, fun
+    ---
+
+This is how you access the tag information.
+
+    article.metatags  # => { 'title' => 'My new awesome blog!',
+                             'author' => 'Zé',
+                             'tags' => [ 'development', 'fun' ] }
+
+
+It is YAML snippet and follows a similar format to Jekyll's [yaml front matter](https://github.com/mojombo/jekyll/wiki/yaml-front-matter). Except that our special variables are different:
+
+| Metatag | Description |
+|:------- |:----------- |
+| title   | The article title. It overrides the on extracted from the file name. |
+
+### Inquiring metatags
+
+    blog.metatags  # => A list of metatag objects
+
+    author_metatag = blog.metatags.first
+
+    author_metatag.label           # => "tags"
+    author_metatag.values          # => A list of metatag value objects
+
+    author_metatag_value = metatag.values.fist
+    author_metatag_value.content   # => "Zé"
+    author_metatag_value.articles  # => A list of articles containing that metatag value
+
+### Finding a articles
+
+#### By article id
+
+    blog.article('2013_05_01_My_first_post')  # => #Rollin::Article(:title => "My first post" ...)
+
+#### By tag
+
+    blog.articles(:tags => "development")  # => A list of articles tagged with development
+
+#### By date
+
+    blog.articles(:year => 2013)                          # => A list of articles for that year
+    blog.articles(:year => 2013, :month => 5)             # => A list of articles for that month
+    blog.articles(:year => 2013, :month => 5, :day => 1)  # => A list of articles for that day
+
+### Archive
+
+#### Monthly
 
     may_archive = blog.monthly_archive.first
 
@@ -44,7 +98,7 @@ First you will need to have the following structure in your filesystem.
     may_archive.month     # => 5
     may_archive.articles  # => [ Rollin::Article(:title => "My first post" ...) ]
 
-### Annual archive
+#### Annual
 
     twenty_thirteen_archive = blog.annual_archive.first
 
@@ -52,9 +106,9 @@ First you will need to have the following structure in your filesystem.
     twenty_thirteen_archive.articles             # => [ Rollin::Article(:title => "My first post" ...) ]
     twenty_thirteen_archive.monthly_archive      # => [ Rollin::MonthArchive(:year => 2013, :month => 5 ...) ]
 
-### Finding an article
+### More datailed documentation
 
-    blog.find_article_by_id('2013_05_01_My_first_post')  # => #Rollin::Article(:title => "My first post" ...)
+You can find a more detailed documentation at the [rollin_spec.rb](https://github.com/marano/rollin/blob/master/spec/rollin_spec.rb) file.
 
 ## Build status
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/rollin/article.rb

@@ -12,13 +12,14 @@ class Rollin::Article
   end
 
   def title
-    metatags[:title] || @title_from_filename
+    metatags['title'] || @title_from_filename
   end
 
   def matches?(search)
-    search = search.clone
-
     return true if @id == search
+    return false if @searh.is_a? String
+
+    search = search.clone
 
     if search.has_key?(:year)
       return false if search.delete(:year) != @year
@@ -30,6 +31,8 @@ class Rollin::Article
       end
     end
 
+    search = search.inject({}) { |memo, (k,v)| memo[k.to_s] = v; memo }
+
     if search.keys.empty?
       return true
     else
@@ -41,20 +44,15 @@ class Rollin::Article
   end
 
   def metatags
-    # Stolen from Jekyll
+    file = read_from_file
+    return {} unless file.has_front_matter?
     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
+      return YAML.safe_load(file.yaml_front_matter)
     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
 
@@ -67,6 +65,35 @@ class Rollin::Article
                             autolink: true,
                             space_after_headers: true,
                             hard_wrap: true)
-    redcarpet.render(File.read(@source_file))
+    redcarpet.render(read_from_file.content)
+  end
+
+  private
+
+  def read_from_file
+    raw = File.read(@source_file)
+
+    # Stolen from Jekyll
+    if raw =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+      content = $POSTMATCH
+      yaml_front_matter = $1
+      content = raw[yaml_front_matter.size + 3, raw.size - 1]
+      FileContent.new(yaml_front_matter, content)
+    else
+      FileContent.new(nil, raw)
+    end
+  end
+end
+
+class FileContent
+  attr_reader :yaml_front_matter, :content
+
+  def initialize(yaml_front_matter, content)
+    @yaml_front_matter = yaml_front_matter
+    @content = content
+  end
+
+  def has_front_matter?
+    !yaml_front_matter.nil?
   end
 end

data/lib/rollin/blog.rb

@@ -15,6 +15,21 @@ class Rollin::Blog
     end
   end
 
+  def metatags
+    metatag_labels = articles.map do |article|
+      article.metatags.keys
+    end.flatten.uniq
+
+    metatag_labels.map do |metatag_label|
+      values = articles.select { |article| article.metatags.has_key?(metatag_label) }.map do |article|
+        article.metatags[metatag_label]
+      end.flatten.uniq.map do |metatag_content|
+        Rollin::MetatagValue.new(metatag_content, articles(metatag_label => metatag_content))
+      end
+      Rollin::MetatagKey.new(metatag_label, values)
+    end
+  end
+
   def annual_archive
     monthly_archive.map { |month_archive| month_archive.year }.uniq.map do |year|
       Rollin::YearArchive.new(year, monthly_archive.select { |aMonth| aMonth.year == year })

data/lib/rollin/metatag_key.rb

@@ -0,0 +1,7 @@
+class Rollin::MetatagKey
+  attr_reader :label, :values
+
+  def initialize(label, values)
+    @label, @values = label, values
+  end
+end

data/lib/rollin/metatag_value.rb

@@ -0,0 +1,7 @@
+class Rollin::MetatagValue
+  attr_reader :content, :articles
+
+  def initialize(content, articles)
+    @content, @articles = content, articles
+  end
+end

data/lib/rollin.rb

@@ -7,6 +7,8 @@ require "rollin/blog"
 require "rollin/article"
 require "rollin/month_archive"
 require "rollin/year_archive"
+require "rollin/metatag_key"
+require "rollin/metatag_value"
 
 module Rollin
 end

data/spec/fixtures/2013_05_01_My_first_post.mk

@@ -1,3 +1,8 @@
+---
+tags:
+  - manero
+---
+
 ## This is my first post
 
 And here we go!

data/spec/fixtures/2013_06_01_My_third_post.mk

@@ -3,7 +3,6 @@ tags:
   - manero
   - massa
   - bacana
-published: false
 ---
 
 ## This is my second post

data/spec/fixtures/2014_01_01_My_fourth_post.mk

@@ -1 +1,7 @@
- 
+---
+published: false
+---
+
+## This is my fourth post
+
+Really awesome!!

data/spec/rollin_spec.rb

@@ -11,10 +11,18 @@ describe 'how rollin works' do
 
   subject (:blog) { Rollin::Blog.new(articles_folder: 'spec/fixtures') }
 
+  let (:first_article) { blog.articles.first }
+  let (:second_article) { blog.articles[1] }
+  let (:third_article) { blog.articles[2] }
+  let (:fourth_article) { blog.articles[3] }
+
+  let (:article_with_single_tag_metatag) { blog.articles[0] }
+  let (:article_with_title_metatag) { blog.articles[1] }
+  let (:article_with_multiple_tag_metatag) { blog.articles[2] }
+  let (:article_with_published_metatag) { blog.articles[3] }
+
   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'
@@ -24,7 +32,7 @@ describe 'how rollin works' do
       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
+      article.metatags.should == { 'tags' => [ 'manero' ] }
     end
 
     it 'allows article title definition with metatag' do
@@ -32,32 +40,34 @@ describe 'how rollin works' do
     end
 
     it 'exposes the list of defined metatags' do
-      article_with_custom_metatags.metatags.should == { tags: ['manero', 'massa', 'bacana'], published: false }
+      article_with_multiple_tag_metatag.metatags.should == { 'tags' => ['manero', 'massa', 'bacana'] }
+      article_with_published_metatag.metatags.should == { '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(:tags => 'manero').should == article_with_single_tag_metatag
+      blog.article('tags' => 'manero').should == article_with_single_tag_metatag
+
+      blog.articles(:tags => 'manero').should == [ article_with_single_tag_metatag, article_with_multiple_tag_metatag ]
+      blog.articles('tags' => 'manero').should == [ article_with_single_tag_metatag, article_with_multiple_tag_metatag ]
+
+      blog.article(:published => false).should == article_with_published_metatag
+      blog.article('published' => false).should == article_with_published_metatag
 
-      blog.article(published: false).should == article_with_custom_metatags
-      blog.articles(published: false).should == [ article_with_custom_metatags ]
+      blog.articles(:published => false).should == [ article_with_published_metatag ]
+      blog.articles('published' => false).should == [ article_with_published_metatag ]
     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)
+      blog.articles(year: 2013).should == [ first_article, second_article, third_article ]
+      blog.articles(year: 2013, month: 5).should == [first_article, second_article ]
+      blog.articles(year: 2013, month: 5, day: 1).should  == [ first_article ]
     end
 
     it 'narrows search by date when searching for metatags' do
@@ -66,6 +76,31 @@ describe 'how rollin works' do
     end
   end
 
+  context 'inquiring metatags' do
+    it 'shows a list of existent metatags' do
+      blog.should have(3).metatags
+
+      blog.metatags[0].label.should == 'tags'
+      blog.metatags[0].should have(3).values
+      blog.metatags[0].values[0].content.should == 'manero'
+      blog.metatags[0].values[0].articles.should == [ article_with_single_tag_metatag, article_with_multiple_tag_metatag ]
+      blog.metatags[0].values[1].content.should == 'massa'
+      blog.metatags[0].values[1].articles.should == [ article_with_multiple_tag_metatag ]
+      blog.metatags[0].values[2].content.should == 'bacana'
+      blog.metatags[0].values[2].articles.should == [ article_with_multiple_tag_metatag ]
+
+      blog.metatags[1].label.should == 'title'
+      blog.metatags[1].should have(1).values
+      blog.metatags[1].values[0].content.should == 'This is a super post!'
+      blog.metatags[1].values[0].articles.should == [ article_with_title_metatag ]
+
+      blog.metatags[2].label.should == 'published'
+      blog.metatags[2].should have(1).values
+      blog.metatags[2].values[0].content.should == false
+      blog.metatags[2].values[0].articles.should == [ article_with_published_metatag ]
+    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)) }
@@ -80,50 +115,44 @@ describe 'how rollin works' do
       blog.articles[2].should == third_article
       blog.articles[3].should == fourth_article
     end
+  end
 
+  context 'archive' do
     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[0].articles.should == [ 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[1].articles.should == [ 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)
+      blog.monthly_archive[2].articles.should == [ 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].articles.should == [ first_article, second_article, third_article ]
       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[0].articles.should == [ 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[0].monthly_archive[1].articles.should == [ third_article ]
 
       blog.annual_archive[1].year.should == 2014
+      blog.annual_archive[1].articles.should == [ fourth_article ]
       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)
+      blog.annual_archive[1].monthly_archive[0].articles.should == [ fourth_article ]
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - marano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-03 00:00:00.000000000 Z
+date: 2013-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,6 +126,8 @@ files:
 - lib/rollin.rb
 - lib/rollin/article.rb
 - lib/rollin/blog.rb
+- lib/rollin/metatag_key.rb
+- lib/rollin/metatag_value.rb
 - lib/rollin/month_archive.rb
 - lib/rollin/version.rb
 - lib/rollin/year_archive.rb