middleman-blog-ymd 0.0.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22ab466f43a9c4c9d062a75c02f5ee57f8865491
-  data.tar.gz: fd29f7c7dd01345c2bb08a603571ca795cb58064
+  metadata.gz: 94a804d71fd425d4b9fbd81138238effe524b21e
+  data.tar.gz: 7e329cdac3c041d5adc381bee25a01fec32a1fb2
 SHA512:
-  metadata.gz: f93ad4966af5ba0fc9cea6e4d1994f535666ae45a3ffabc2839d31d4cd9ba047f68ff85d8385ad899b670b761c26f8854bd72479c4e2337858370e7e49b332d5
-  data.tar.gz: e9a75018c27a4b9d349991eeb0762b4a364be5d1910cae63d21d62061433b1d25c61c0ab7eede799bef6d993e208c9e05d67423bff07d40ab7cb1ac888cfa306
+  metadata.gz: 111a0027b391015916040c68d22cf5a424567dabcb936adaefd01a86601fbece866fc2f6ff08c6d007fd8652a7e4137e077287ebd499c46e039a6a672389722b
+  data.tar.gz: 9ffe86d5c5414f9814089cb3d18f164ef2733145dcade6b25ace13ddb22b75cf3613b4fb4ab7f976a7a05b3e4f8a4f4e93b1935b5cd1452db16deb7c873c4772

data/README.md

@@ -1,6 +1,13 @@
-# Middleman::Blog::Ymd
+# Middleman-Blog-YMD Extension 
+
+This is an extension for Middleman blog.
+
+## Introduction & Motivation
+
+This extension provides helper methods of middleman-blog. These methods enables you to collect years and months data of your blog articles. These years and months data mean only years and months WHICH HAVE ARTICLES. 
+
+The motivation of this gem came from my own blog based on middleman-blog. I couldn't easily get months having articles of specific year. I couldn't get next month which have article. 
 
-TODO: Write a gem description
 
 ## Installation
 
@@ -16,14 +23,53 @@ Or install it yourself as:
 
     $ gem install middleman-blog-ymd
 
+
+## Configuration
+
+In config.rb file, add the next line. This line should come after "activate :blog"
+
+    activate :ymd_extension
+
+
 ## Usage
 
-TODO: Write usage instructions here
+All the helper methods' names  begin with "ymd". This avoids method name confliction. In view of Middleman-blog, "blog" helper  mothod returns BlogData. YMD methods get years and methods data from this BlogData object.
+
+
+* ymd_years_of(blog)
+  + returns years having articles in Array.
+
+* ymd_year_months_hash_of(blog)
+  + returns pairs of year and month"S" having articles in Hash. 
+  + The returned hash is like this,  
+
+~~~ Ruby
+{ 2013 => [1,2,3,4,5,6,7,8,9], 2014 => [1,2,3,4,5,6,7,8,9] } )
+~~~
+
+* ymd_next_month_of(blog, current_year, current_month)
+* ymd_prev_month_of(blog, current_year, current_month)
+  + These methods return next month or previous month WHICH HAVE ARTICLES. Current year and month should be specified in argument by integer.
+
+~~~ Ruby
+# Example
+ymd_next_month_of(blog, 2014, 1 ) # returns next month having articles of 2014 Jan.
+~~~
+
+This returns a month number (e.g. 1, 2, 3, 4, ... 9, 10, 11,12 ).
+If you want to get a two digit value, use ruby method 
+~~~~ Ruby
+"%02d".%( integer )
+~~~~
+
+which converts integer into two digits.
+
+If you want to get short name of the month from the number
+~~~~ Ruby
+Date::MONTHNAMES[ integer ]
+~~~~
+
+## ToDo
 
-## Contributing
+In version 0.5, every time the ymd methods is called, Ymdtree is regenerated. This makes the build process slow. But good for Live Preview. I'd like to change this behavior based on "during build" or "live preview". My idea now is to make an option in this gem and change the option value in Rspec.
 
-1. Fork it ( https://github.com/[my-github-username]/middleman-blog-ymd/fork )
-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 a new Pull Request

data/lib/middleman-blog-ymd/version.rb

@@ -1,3 +1,3 @@
 module MiddlemanBlogYmd
-      VERSION = "0.0.3"
+      VERSION = "0.5.0"
 end

data/lib/middleman-blog-ymd/ymdtree.rb

@@ -1,7 +1,15 @@
 class Ymdtree
 	@hash = Hash.new{|h, k| h[k] = Hash.new(&h.default_proc)	}
-	
+
 	class << self
+		def init(blog_data)
+			blog_data.articles.each{|article|
+					year_value = article.date.gmtime.year
+					month_value =article.date.gmtime.month
+					day_value =article.date.gmtime.day
+					add(year_value, month_value, day_value)
+			}
+		end
 		def hash
 			return @hash
 		end
@@ -17,20 +25,23 @@ class Ymdtree
 		def days_of( y, m )
 			@hash[y][m].keys
 		end
-		def next_month( y , m)
+		def previous_month( y , m)
 			month_array = @hash[y].to_a
+			month_array = month_array.collect{|month|
+				month[0]
+			}
 			m_idx = month_array.index(m)
-			if m_idx == ( m_idx.length - 1 )
+			if m_idx == ( month_array.length - 1 )
 				return false
 			else
 				return month_array[ m_idx + 1 ]
 			end
 		end
-		def previous_month( y , m)
-			p @hash
-			p y
+		def next_month( y , m)
 			month_array = @hash[y].to_a
-			p month_array
+			month_array = month_array.collect{|month|
+				month[0]
+			}
 			m_idx = month_array.index(m)
 			if m_idx == 0
 				return false

data/lib/middleman-blog-ymd.rb

@@ -1,16 +1,6 @@
 require "middleman-blog"
-require "middleman-blog-ymd/version"
-require "middleman-blog-ymd/ymdtree"
-
-def collect_articles_ymds
-	blog.articles.each{|article|
-		if article.path =~ /^(\d+)\/(\d+)\/(\d+)_/
-			year_value = $1
-			month_value = $2
-			day_value = $3.to_s[4..5].to_i
-			Ymdtree.add(year_value, month_value, day_value)
-	}
-end
+require File.expand_path("../middleman-blog-ymd/version", __FILE__)
+require File.expand_path("../middleman-blog-ymd/ymdtree", __FILE__)
 
 class YmdExtension < ::Middleman::Extension
   def initialize(app, options_hash={}, &block)
@@ -18,26 +8,36 @@ class YmdExtension < ::Middleman::Extension
     super
   end
 
-  def manipulate_resource_list(resources)
-		p ::Middleman:BlogExtension.data
-  end
-
   helpers do
-		def ymdtree
-			return YMDTree
+		def ymdtree_of(blog)
+			Ymdtree.init(blog)
+			return Ymdtree
 		end
 
-    def blog_years
-			return YMDTree.years
+    def ymd_years_of(blog)
+			Ymdtree.init(blog)
+			return Ymdtree.years
     end
 
-		def blog_year_month_hash
+		def ymd_year_months_hash_of(blog)
+			Ymdtree.init(blog)
 			ymhash = Hash.new
-			YMDTree.hash.each{ |k, v|
+			Ymdtree.hash.each{ |k, v|
 				ymhash[k] = v.keys
 		  }
 			return ymhash
 		end
+
+		def ymd_next_month_of( blog, year, month)
+			Ymdtree.init(blog)
+			return Ymdtree.next_month(year, month)
+		end
+
+		def ymd_prev_month_of( blog, year, month)
+			Ymdtree.init(blog)
+			return Ymdtree.previous_month(year, month)
+		end
+
   end
 end
 

data/middleman-blog-ymd.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["toshi@niceume.com"]
   spec.summary       = %q{years months days (for middleman-blog).}
   spec.description   = %q{years months days support for middleman-blog.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/niceume/middleman-blog-ymd"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "middleman-blog"
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-blog-ymd
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.5.0
 platform: ruby
 authors:
 - niceume
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-13 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: middleman-blog
+  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: years months days support for middleman-blog.
 email:
 - toshi@niceume.com
@@ -67,9 +81,8 @@ files:
 - lib/middleman-blog-ymd.rb
 - lib/middleman-blog-ymd/version.rb
 - lib/middleman-blog-ymd/ymdtree.rb
-- lib/middleman-extension.rb
 - middleman-blog-ymd.gemspec
-homepage: ''
+homepage: https://github.com/niceume/middleman-blog-ymd
 licenses:
 - MIT
 metadata: {}

data/lib/middleman-extension.rb

@@ -1 +0,0 @@
-require "middleman-blog-ymd"