striker 0.0.8.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 564fb4720de771314258930e6d16fa5287d5e907
+  data.tar.gz: fb0676c796a47c0c5e1e9c14f9b33570db364ca7
+SHA512:
+  metadata.gz: 738aa7c261a4e5ab560948fd4e2f74b72c5d8e0528b5ea61e27f086e4d0a3b662eb9bed21a0fceabd27da77360fc7ae3c9693c8f4292b3e7ba3edef418f8a7aa
+  data.tar.gz: 6376d19dd265eaf98eefb2c8352a79d249f403ccd94cea86658c9f6d67357712ea166875feb312f8c012931d90d440b77e36a361ffa04eb2805c62a3bc03399c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in striker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Swaroop SM
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,179 @@
+# Striker
+
+[![Code Climate](https://codeclimate.com/github/swaroopsm/striker.png)](https://codeclimate.com/github/swaroopsm/striker)
+
+A Simple & Fast Static Site Generator. Striker has been released as a pre version as of now, to get reviews and bug reports.
+
+## Installation
+
+<!--
+Add this line to your application's Gemfile:
+
+    gem 'striker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+-->
+
+    $ gem install striker --pre
+
+## Usage
+
+#### Create New Site
+	$ striker new my-awesome-site
+	$ cd my-awesome-site
+
+##### This creates the following directory structure:
+	my-awesome-site/
+		css/
+		js/
+		media/
+			images/
+			sounds/
+			videos/
+		pages/
+		templates/
+		config.yml
+
+
+#### Create New Page
+	$ striker page --new home --title "Home Page" [--no-media | --no-image | --no-sound | --no-video]
+Use the appropriate option if you need images or videos or sound.
+
+This creates a page named `home.md` in `pages/`. The content is written in [markdown](http://daringfireball.net/projects/markdown/).
+#####The front matter of this page looks like the following
+		---
+		title: Home Page
+		author: Swaroop SM
+		date: 2013-10-19
+		template: page
+		---
+
+		### Home Page
+
+You can include any front-matter, but `title`, `date` and `template` are mandatory fields
+
+The value that you specified for the `template` field, tells the gem to look for a file named `page.html` in the `templates/` directory. Here you can specify the markup of your page.
+
+##### Templating
+Striker uses [Liquid Templating](http://liquidmarkup.org).
+To define a new template add a file called `my_template.html` in `templates/` and you can specify this template in your `markdown` pages.
+
+#### Dealing with Images
+Make sure you have [ImageMagick](http://www.imagemagick.org/script/index.php) installed.
+
+##### Add thumbnail to a page.
+If you would like to make an image appear on one of your pages, simply add an image named as `thumbnail.(jpg|png|gif)` to the images directory of your page.
+Eg.: If you would like to add a thumbnail to your home page, place a `thumbnail.jpg` in `images/home/thumbnail.jpg`
+
+Then in your `home.md` you can use the custom liquid tag helper to output the image by doing:
+######
+	{% thumbnail 250w 250h #[image-id] .[image-class] %}
+
+Explanation:
+#####
+	thumbnail - the tag name
+	250w, 250h - The desired width and height that you would like to resize the image
+	#[image-id] - Specify id the the image tag
+	.[image-class] - Specify class to the image tag
+
+You can specify the size of the image using width/height. or you can also scale the image. For Eg.: If you would like to reduce the size of the image to 50% of the original size, you can do the following:
+#####
+	{% thumbnail 0.5s #[image-id] .[image-class] %}
+
+To display non-thumbnail images, drop images into the appropriate page's `images/` directory.
+Then to display images in your template use the following:
+#####
+	{% for image in page.images %}
+		<img src="{{ image.url }}" />
+	{% endfor %}
+
+##### Start the Server
+	$ striker strike
+This starts the server at `localhost` and port `1619`
+
+### Some Goodies:
+##### Adding tags to pages
+In your `config.yml`
+#
+	tagged:
+		style: tagged
+This specifies the page that you want to serve for tags. For Eg.: if you want something like `http://yoursite.com/tags` change it to the following:
+#
+	tagged:
+		style: tags
+
+To create markup for your templates `striker` provides two files:
+
+To provide markup for the main tags page. Eg.: `http://yoursite.com/tagged` add markup in the following template.
+
+* `templates/tags/index.html`
+		
+To provide markup for a specific tag page. Eg.: `http://yoursite.com/tagged/ruby` add markup in the following template
+
+* `templates/tags/tag.html`
+
+##### Site Archive
+Archive of posts is quite commin in blogs. If you would like to add an archive to your site, follow the below steps:
+
+In your `config.yml` add the following if it does not exist:
+#
+	archive:
+		style: archive
+		period: :month
+
+The `style` parameter specifies the path name; the above would create `http://yoursite.com/archive/2013/10`
+
+You can provide two values to the `period` parameter - `:year` or `:month`
+
+The `:year` value would create a path like: `http://yoursite.com/archive/2013`
+
+The `:month` value would create a path like: `http://yoursite.com/archive/2013/10`
+
+*Note:*
+
+For the archive to be fully functional and work as expected you need to provide the `date` in the front-matter of all your pages without which can lead to incorrect results.
+
+The templates for specifying the markup are in `templates/archive/index.html`.
+
+To access all site archives you can use `site.archives` in your templates
+
+To access a specific archive in your archive templates use the following:
+#
+	{% for page in archive.pages %}
+		<a href="{{ page.url }}">{{ page.title }}</a>
+	{% endfor %}
+
+##### Helper Tags Available:
+*Embed YouTube Video*
+#####
+	{% youtube bNAyPK2O4fk 650w 400h %}
+
+*Embed Vimeo Video*
+#####
+	{% vimeo 29897413 650w 400h %}
+
+*Embed SoundCloud Track*
+#####
+	{% soundcloud 3058346 400w 200h %}
+
+#### Build Website
+	$ striker build
+Generate the final website by creating a `public/` directory
+
+<!--
+## Contributing
+
+1. Fork it
+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 new Pull Request
+-->
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/swaroopsm/striker/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/striker

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require_relative '../lib/striker'
+
+program :name, 'striker'
+program :version, Striker::VERSION
+program :description, 'Simple & Lite Static Site Generator'
+ 
+command :new do |c|
+  c.syntax = 'striker new SITE_NAME'
+  c.description = 'Generates a new static site with a specified directory structure'
+
+  c.action do |args, options|
+		Striker::Command::New.process(args, options)
+  end
+end
+
+command :page do |c|
+	c.syntax = 'striker page'
+	c.description = 'Creates a new page'
+
+	c.option '--new [name]', String, 'Create a page with a name'
+	c.option '--title ["title"]', String, 'Give title to the page'
+	c.option '--no-media', String, 'Do not create any media files the page'
+	c.option '--no-image', String, 'Do not create any image files the page'
+	c.option '--no-sound', String, 'Do not create any sound files the page'
+	c.option '--no-video', String, 'Do not create any video files for the page'
+
+	c.action do |args, options|
+		options.default :no_sound => true, :no_video => true
+
+		options = options.__hash__
+		Striker::Command::Page.process(args, options)
+	end
+end
+
+command :build do |c|
+	c.syntax = 'striker build'
+	c.description = 'Build your website'
+
+	c.action do |args, options|
+
+		Striker::Command::Build.process
+	end
+end
+
+command :strike do |c|
+	c.syntax = 'striker serve'
+	c.description = 'Build & Preview website in the browser'
+
+	c.action do |args, options|
+		
+		Striker::Command::Build.process
+		Striker::Command::Strike.run(args, options)
+	end
+end

data/lib/new_site/config.yml

@@ -0,0 +1,17 @@
+name: Your Website Name
+port: 1619
+basename: /
+assets: assets
+public_dir: public
+permalink:
+  style: :name
+  pretty: true
+tagged:
+  style: tagged
+archive:
+  style: archive
+  period: :month
+homepage: index
+include_assets:
+ - css
+ - js

data/lib/new_site/css/style.css

@@ -0,0 +1 @@
+/* Write your css code here... */

data/lib/new_site/js/script.js

@@ -0,0 +1 @@
+// Write your js code here... 

data/lib/new_site/templates/archive/index.html

@@ -0,0 +1 @@
+{{ archive.pages }}

data/lib/new_site/templates/default.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="UTF-8">
+	<title>{{ site.title }}</title>
+</head>
+<body>
+	{{ content }}
+</body>
+</html>

data/lib/new_site/templates/page.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="UTF-8">
+	<title>{{ page.title }}</title>
+</head>
+<body>
+	{{ content }}
+</body>
+</html>

data/lib/new_site/templates/tags/index.html

@@ -0,0 +1 @@
+{{ site.tags }}

data/lib/new_site/templates/tags/tag.html

@@ -0,0 +1,2 @@
+<!-- Template for a single tag page -->
+{{ pages }}

data/lib/striker.rb

@@ -0,0 +1,28 @@
+require 'fileutils'
+require 'yaml'
+require 'mime-types'
+require 'redcarpet'
+require 'liquid'
+require 'date'
+
+require_relative 'striker/version'
+require_relative 'striker/command/new'
+require_relative 'striker/command/page'
+require_relative 'striker/command/build'
+require_relative 'striker/command/strike'
+require_relative 'striker/settings'
+require_relative 'striker/site'
+require_relative 'striker/page'
+require_relative 'striker/template'
+require_relative 'striker/tag'
+require_relative 'striker/archive'
+require_relative 'striker/media/image'
+require_relative 'striker/tags/thumbnail'
+require_relative 'striker/tags/youtube'
+require_relative 'striker/tags/vimeo'
+require_relative 'striker/tags/soundcloud'
+require_relative 'striker/tags/tweet'
+
+module Striker
+
+end

data/lib/striker/archive.rb

@@ -0,0 +1,72 @@
+module Striker
+	class Archive
+		
+		if File.exists? File.join(Settings::SOURCE_DIR, "config.yml")
+			@@dir = Settings::CONFIG['archive']['style'] 
+			@@period = Settings::CONFIG['archive']['period']
+		end
+
+		def self.process(site_meta)
+			@@site_meta = site_meta
+			FileUtils.mkdir_p(File.join(Settings::PUBLIC_DIR, @@dir))
+			process_archive_dir
+			process_files
+		end
+
+		def self.list_full
+			grouped_pages = []
+			pages = []
+			Dir.chdir(Settings::PAGES_DIR)
+			Dir.glob("*[.md|.markdown]").each do |page|
+				grouped_pages << Page.new(page).page_data
+			end
+			if @@period == :year
+				grouped_pages = grouped_pages.group_by{ |page| page['date'].strftime("%Y") }
+			else
+				grouped_pages = grouped_pages.group_by{ |page| [page['date'].strftime("%Y"), page['date'].strftime("%B")] }
+			end
+			grouped_pages.each do |p| 
+				if p[0].class == Array
+					date = Date.new(p[0][0].to_i, Date::MONTHNAMES.index(p[0][1]), 1)
+					url = File.join(Settings::CONFIG['basename'], @@dir, date.year.to_s, date.month.to_s)
+				else
+					date = p[0]
+					url = File.join(Settings::CONFIG['basename'], @@dir, date)
+				end
+				
+				pages << { 'date' => date, 'pages' => p[1], 'url' => url }
+			end
+			pages
+		end
+
+		def self.process_archive_dir
+			list_full.each do |archive|
+				Dir.chdir(File.join(Settings::PUBLIC_DIR, @@dir))
+				if archive['date'].class == Date
+					FileUtils.mkdir_p(File.join(archive['date'].year.to_s, archive['date'].month.to_s))
+				else
+					FileUtils.mkdir_p(archive['date'].to_s)
+				end
+			end
+		end
+
+		def self.process_files
+			@@site_meta['archive'].each do |archive|
+				process_main_template(archive)
+			end
+		end
+
+		def self.process_main_template(archive)
+			Dir.chdir(Settings::TEMPLATES_DIR)
+			template = File.read(File.join("archive", "index.html"))
+			parsed_data = Liquid::Template.parse(template).render('site' => @@site_meta, 'archive' => archive)
+			Dir.chdir(Settings::PUBLIC_DIR)
+			File.open(File.join(Settings::PUBLIC_DIR, archive['url'], "index.html"), "w") do |file|
+				file.write(parsed_data)
+			end
+		end
+
+		private_class_method :process_archive_dir, :process_files, :process_main_template
+
+	end
+end