statikaj 0.0.2 → 0.0.3.yanked

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjNmNGQxNzY1MzY5ZjVhOTU2MTg1OTc0NjM2YTlkZmFlMzJmODA0YQ==
+  data.tar.gz: !binary |-
+    ZmE3MTY2ODNlYzM3YTVhN2YwOGIxODhiNjUxYmUyNTBiZTU4NTcwYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTRlNTVkOTMxM2FlMDQ4NDRlODUyN2M4MGZmNTU2MGRiZWU3Y2NlNjM4OTU3
+    ZDMyZTJhYjlkN2ViNmM2ZTFjNWEyOTIyNTA2OGI2MzQ4MjllNzg0ZTU2YTIx
+    OWQ5MmNmNGE2ZGE4OTUzYzcxM2EwYjM1NmE2M2U5MmU3OTljZjc=
+  data.tar.gz: !binary |-
+    YWZlOTRiY2JhMDEzMDcwMTNiYzMzYzI0NjkxMzVlZDJhMjQzYTg3ZDBhMmQy
+    OGFhNmIwNmU2ZTBiYzkxMjQ4MDUwZTdjZDk3ZWNjYTVlNGJiY2E3NTUxY2Yz
+    ZmJkNjI5MWVlMmMyODRmNjc1NDJlZDU4ZjRiY2EwNzdiOGIwMGQ=

data/CHANGELOG.md

@@ -1,14 +1,23 @@
 # Changelog
 
-## 0.0.2
+## 0.0.3
 
-### Features
+* added summary to article
+* added permalink to article
+* added url params on build
+* added permalink to article
+* added force option to rebuild old articles
+* added atom support
 
-* Article generator
+* now the date of article return a Date object
 
-## 0.0.1
+* fixed cli require bug
+
+## 0.0.2
+
+* article generator
 
-### Features
+## 0.0.1
 
 * blog install command
 * build article

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    statikaj (0.0.3.yanked)
+      builder
+      kramdown
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    kramdown (1.2.0)
+    rake (10.1.0)
+    thor (0.18.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  rake
+  statikaj!

data/README.md

@@ -1,40 +1,62 @@
-# Statikaj <a href='https://gemnasium.com/dukex/statikaj'><img src="https://gemnasium.com/dukex/statikaj.png" alt="Dependency Status" /></a>
+# *Statikaj* <a href='https://gemnasium.com/dukex/statikaj'><img src="https://gemnasium.com/dukex/statikaj.png" alt="Dependency Status" /></a>
 
-Simple static blog tools, 
+Simple static blog-engine based on [cloudhead/toto](https://github.com/cloudhead/toto), perfect for hackers. Like **toto**, *Statikaj* is git-powered
 
 
+## 10 seconds blog
 
-## Installation
+    $ gem install statikaj
+    $ statikaj new myblog
+    $ cd myblog
+    $ statikaj build --url http://myblog.com
+    $ rackup -p 3000 # http://localhost:3000
 
-Add this line to your application's Gemfile:
+## Why?
 
-    gem 'statikaj'
+Why you don't need generate your blog every http request. *Statikaj* **don't use database**, **don't parse ERB/Markdown** on production. Build your blog and send a static version to your server, *Statikaj* will works with any http server, you don't need ruby, java, php, etc, a small nginx or apache process will be OK.
 
-And then execute:
+## Creating and Writing a article
 
-    $ bundle
+Create a article is very easy, first to create a correct file *Statikaj* provides the ```article``` command.
 
-Or install it yourself as:
+    $ statikaj article
 
-    $ gem install statikaj
+*Statikaj* ```article``` will prompt the article title, and will create a file into ```src/articles```, use your preferred markdown editor open the file. When you finished just builds yout blog again.
 
-## Install
+    $ statikaj build --url http://myblog.com
 
-    $ statikaj new myblog
-    $ cd myblog
-    $ statikaj build
-    $ rackup -p 3000
-    
-## Create a article
-TODO
+### The article file
+
+The article file show like it:
+
+<pre>---
+title: My Title
+date: 29/09/2013
+author: User
+category: category
+
+Once upon a time...</pre>
+
+To create a **summary** use ```~~~``` as delimiter, like it:
+
+<pre>---
+title: My Title
+date: 29/09/2013
+author: User
+category: category
+
+Once upon a time, there was a lovely princess.
+
+~~~
 
-## Costum design
-TODO
+But she had an enchantment upon her of a fearful sort, which could only be broken by love's first kiss.
+</pre>
 
-Your static blog is running on http://localhost:3000
+## Works on your blog design
+> TODO, for now see [src/templates](https://github.com/dukex/statikaj/tree/master/templates/src/templates)
 
-## How use?
 
+## Who uses it?
 * [Apartamento131](https://github.com/dukex/apartamento131)
 
 ## Contributing

data/bin/statikaj

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
+statikaj_path = File.join(File.expand_path("../lib", __FILE__))
+$:.unshift(statikaj_path)
+
 require 'statikaj/cli'
 
 Statikaj::CLI.start(ARGV)

data/lib/statikaj/article.rb

@@ -4,9 +4,9 @@ require 'kramdown'
 
 module Statikaj
   class Article < Hash
-    def initialize obj, config = {}
+    def initialize obj, config
       @obj, @config = obj, config
-      self.load #if obj.is_a? Hash
+      self.load
     end
 
     def render(source)
@@ -19,8 +19,7 @@ module Statikaj
 
     def load
       data = if @obj.is_a? String
-        meta, self[:body] = File.read(@obj).split(/\n\n/, 2)
-          # use the date from the filename, or else toto won't find the article
+          meta, self[:body] = File.read(@obj).split(/\n\n/, 2)
           @obj =~ /\/(\d{4}-\d{2}-\d{2})[^\/]*$/
           ($1 ? {:date => $1} : {}).merge(YAML.load(meta))
         elsif @obj.is_a? Hash
@@ -42,48 +41,43 @@ module Statikaj
       self[:slug] || self[:title].slugize
     end
 
-    def summary length = nil
-      #   config = @config[:summary]
-      #   sum = if self[:body] =~ config[:delim]
-      #     self[:body].split(config[:delim]).first
-      #   else
-      #     self[:body].match(/(.{1,#{length || config[:length] || config[:max]}}.*?)(\n|\Z)/m).to_s
-      #   end
-      #   markdown(sum.length == self[:body].length ? sum : sum.strip.sub(/\.\Z/, '&hellip;'))
+    def summary
+      sum = self[:body].split("~~~").first
+      markdown(sum.length == self[:body].length ? sum : sum.strip.sub(/\.\Z/, '&hellip;'))
     end
 
     def url
-      #  "http://#{(@config[:url].sub("http://", '') + self.path).squeeze('/')}"
+      "http://#{(@config[:url].sub("http://", '') + self.path).squeeze('/')}"
     end
-    #alias :permalink url
+    alias :permalink url
 
     def body
-      markdown self[:body]
+      markdown self[:body].sub("~~~", '')
     end
 
     def path
-      # TODO: custom domain
-      #  "/#{@config[:prefix]}#{self[:date].strftime("/%Y/%m/%d/#{slug}/")}".squeeze('/')
-      slug
+      "/#{slug}"
     end
 
-    def title()
+    def title
       self[:title] || "an article"
     end
 
-    def date()
-      # TODO: costum
-      # @config[:date].call(self[:date])
-      self[:date].strftime("%B #{self[:date].day.ordinal} %Y")
+    def date
+      self[:date]
     end
 
-    def author()
+    def author
       self[:author]
     end
 
-    def to_html()
+    def category
+      self[:category]
+    end
+
+    def to_html
       self.load; super(:article, @config)
     end
-    #alias :to_s to_html
+    alias :to_s to_html
   end
 end

data/lib/statikaj/cli.rb

@@ -1,5 +1,4 @@
 require 'thor'
-require 'erb'
 require 'statikaj/article'
 require 'statikaj/render'
 require 'ext/ext'
@@ -8,28 +7,39 @@ module Statikaj
   class CLI < Thor
     include Thor::Actions
 
+    def self.source_root
+      File.expand_path('../../..', __FILE__)
+    end
+
     desc 'new', 'Create a new project'
     def new(name)
-      directory('templates', name)
+      directory('templates', name, verbose: true)
     end
 
-    desc "build [SOURCE] [DESTINATION]", "build the blog from source to destination folder"
+    desc "build", "Build the static blog version on public folder"
+    option :force, :type => :boolean, default: false, aliases: :f, desc: "force rebuild olds articles"
+    option :url, :type => :string, required: true, desc: "base blog url"
+    option :"no-category", :type => :boolean, default: false, desc: "without category support"
     long_desc <<-LONGDESC
-      The SOURCE folder should have `articles` folders
-      DESTINATION default is ./public
-
-      > $ statikaj build
-      > $ statikaj build ./source ~/myblog/public
+      > $ statikaj build --url http://myblog.com
+      > $ statikaj build --no-category --url http://myblog.com
+      > $ statikaj build -f --url http://myblog.com
     LONGDESC
-    def build(source = "./src", destination = "./public")
-      source = Pathname.new source
-      destination   = Pathname.new destination
+    def build
+      source      = Pathname.new "./src"
+      destination = Pathname.new "./public"
+
+      config = {}
+      config[:url] = options[:url].split("/").join("/")
 
       articles_files = Dir[source.join('articles/*.md')].sort_by {|entry| File.basename(entry) }
-      articles = articles_files.map{|f| Article.new(f) }
+      articles = articles_files.map{|f| Article.new(f, config) }
+      categories = {}
 
       articles.each do |article|
-        say "Saving: #{article.slug}", :green
+        categories[article.category] ||= []
+        categories[article.category] << article
+
         article_file = destination.join("#{article.slug}").to_s
 
         render = Render.new(source, article: article)
@@ -38,19 +48,30 @@ module Statikaj
           page.description = article.summary
         end
 
-        #unless File.exists?(article_file)
-        file = File.new(article_file, "w+")
-        file.puts content
-        file.close
-        #end
+        create_file article_file, content, force: options[:force]
       end
 
-      say "Creating index.html", :green
       render = Render.new(source, page: 'index', articles: articles.reverse)
       content = render.page {}
-      file = File.new(destination.join("index.html"), "w+")
-      file.puts content
-      file.close
+      create_file destination.join("index.html"), content, force: true
+
+      render = Render.new(source, page: 'index', articles: articles.reverse, type: :atom)
+      atom_content = render.page do |page|
+        page.url = config[:url]
+      end
+      create_file destination.join("feed.atom"), atom_content, force: true
+
+      unless options[:"no-category"]
+        empty_directory destination.join("category")
+        categories.each do |key, _articles|
+          key = "No Category" if key.nil?
+          slug = key.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
+
+          render = Render.new(source, page: 'category', url: slug, articles: _articles.reverse)
+          content = render.page {}
+          create_file destination.join("category/#{slug}"), content, force: true
+        end
+      end
     end
 
     desc "article", "Create new article"
@@ -58,7 +79,7 @@ module Statikaj
       title = ask('Title: ')
       slug = title.empty?? nil : title.strip.slugize
 
-      article = {'title' => title, 'date' => Time.now.strftime("%d/%m/%Y"), 'author' => 'User'}.to_yaml
+      article = {'title' => title, 'date' => Time.now.strftime("%d/%m/%Y"), 'author' => 'User', 'category' => 'category'}.to_yaml
       article << "\n"
       article << "Once upon a time...\n\n"
       path = "src/articles/#{Time.now.strftime("%Y-%m-%d")}#{'-' + slug if slug}.md"

data/lib/statikaj/render.rb

@@ -1,12 +1,17 @@
+require 'erb'
+require 'builder'
+require 'statikaj/version'
+
 module Statikaj
   class Render
-    attr_accessor :title, :articles, :description
+    attr_accessor :title, :articles, :description, :url
 
     def initialize(source, options)
       @source = source
       @article = options.delete(:article) if options[:article]
       @articles = options.delete(:articles) if options[:articles]
-      if options[:page]
+      @type = options.fetch(:type, :html)
+      if options[:page] && @type == :html
         render_page(options.delete(:page))
       end
     end
@@ -20,9 +25,7 @@ module Statikaj
 
     def page(&blk)
       yield self
-      to_html do
-        @page
-      end
+      send("to_#{@type}"){ @page }
     end
 
     private
@@ -31,6 +34,11 @@ module Statikaj
         ERB.new(layout).result(binding)
       end
 
+      def to_atom
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        instance_eval  File.read(@source.join("templates/index.builder"))
+      end
+
       def render_page(page_name)
         page = File.read(@source.join("templates/pages/#{page_name}.rhtml"))
         @page = ERB.new(page).result(binding)

data/lib/statikaj/version.rb

@@ -1,3 +1,3 @@
 module Statikaj
-  VERSION = "0.0.2"
+  VERSION = "0.0.3.yanked"
 end

data/statikaj.gemspec

@@ -20,8 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
   spec.add_dependency "kramdown"
   spec.add_dependency "thor"
-  spec.add_dependency "rack"
+  spec.add_dependency "builder"
 end

data/templates/src/articles/1992-06-02-the-first-post.md

@@ -2,9 +2,14 @@
 title: The first post!
 date: 02/06/1992
 author: Duke
+category: fun
 
 
-Pitchfork viral kale chips Neutra. Irony Echo Park ennui asymmetrical. Literally Intelligentsia asymmetrical PBR, hashtag actually photo booth hella shabby chic. Mustache narwhal tattooed Terry Richardson Marfa chia Vice ugh. Food truck fanny pack try-hard Echo Park. Fingerstache banh mi aesthetic deep v, iPhone squid Banksy locavore. Fingerstache pour-over forage chillwave, pork belly shabby chic put a bird on it fashion axe before they sold out irony.
+Pitchfork viral kale chips Neutra. Irony Echo Park ennui asymmetrical. Literally Intelligentsia asymmetrical PBR, hashtag actually photo booth hella shabby chic.
+
+~~~
+
+Mustache narwhal tattooed Terry Richardson Marfa chia Vice ugh. Food truck fanny pack try-hard Echo Park. Fingerstache banh mi aesthetic deep v, iPhone squid Banksy locavore. Fingerstache pour-over forage chillwave, pork belly shabby chic put a bird on it fashion axe before they sold out irony.
 
 Beard keffiyeh food truck, skateboard messenger bag put a bird on it wolf hoodie gluten-free Godard Portland. Freegan Bushwick Schlitz, distillery vegan keytar sustainable 90's stumptown fixie cardigan Terry Richardson squid chillwave kogi. Kogi shabby chic salvia Brooklyn. PBR&B quinoa meggings, gluten-free +1 disrupt salvia Blue Bottle next level Tumblr mumblecore kale chips hoodie YOLO. Helvetica scenester Neutra PBR, Banksy readymade pug drinking vinegar slow-carb semiotics kale chips Truffaut swag pop-up. Odd Future polaroid wayfarers, scenester ethnic Helvetica pug street art Etsy Carles four loko stumptown synth post-ironic. American Apparel forage kitsch, try-hard you probably haven't heard of them cornhole Brooklyn.
 

data/templates/src/templates/index.builder

@@ -1,15 +1,18 @@
 xml.instruct!
 xml.feed "xmlns" => "http://www.w3.org/2005/Atom" do
-  xml.title @config[:title]
-  xml.id @config[:url]
+  xml.title title
+  xml.id "urn:md5:#{Digest::MD5.hexdigest(url)}"
   xml.updated articles.first[:date].iso8601 unless articles.empty?
-  xml.author { xml.name @config[:author] }
+  xml.author { xml.name "A" }
+  xml.link "rel" => "self", "href" => "#{url}/feed.atom", "type" => "application/atom+xml"
+  xml.link "rel" => "alternate", "href" => url, "type" => "text/html"
+  xml.generator "Statikaj", "uri" => "https://github.com/dukex/statikaj", "version" => Statikaj::VERSION
 
   articles.reverse[0...10].each do |article|
     xml.entry do
       xml.title article.title
       xml.link "rel" => "alternate", "href" => article.url
-      xml.id article.url
+      xml.id "urn:md5:#{Digest::MD5.hexdigest(article.url)}"
       xml.published article[:date].iso8601
       xml.updated article[:date].iso8601
       xml.author { xml.name article[:author] }
@@ -18,4 +21,3 @@ xml.feed "xmlns" => "http://www.w3.org/2005/Atom" do
     end
   end
 end
-

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: statikaj
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3.yanked
 platform: ruby
 authors:
 - Duke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2013-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,23 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,15 +62,13 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: builder
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,6 +91,7 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -140,32 +114,25 @@ files:
 homepage: https://github.com/dukex/statikaj
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1496453532116018902
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -1496453532116018902
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Statikaj is simple tool to create statikaj blogs.
 test_files: []