monad 0.0.1

data/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+Contribute
+==========
+
+So you've got an awesome idea to throw into Jekyll. Great! Please keep the
+following in mind:
+
+* **Contributions will not be accepted without tests.**
+* If you're creating a small fix or patch to an existing feature, just a simple
+  test will do. Please stay in the confines of the current test suite and use
+  [Shoulda](http://github.com/thoughtbot/shoulda/tree/master) and
+  [RR](http://github.com/btakita/rr/tree/master).
+* If it's a brand new feature, make sure to create a new
+  [Cucumber](https://github.com/cucumber/cucumber/) feature and reuse steps
+  where appropriate. Also, whipping up some documentation in your fork's wiki
+  would be appreciated, and once merged it will be transferred over to the main
+  wiki.
+* If your contribution changes any Jekyll behavior, make sure to update the
+  documentation. It lives in `site/_posts`. If the docs are missing information,
+  please feel free to add it in. Great docs make a great project!
+* Please follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby)
+  when modifying Ruby code.
+
+Test Dependencies
+-----------------
+
+To run the test suite and build the gem you'll need to install Jekyll's
+dependencies. Jekyll uses Bundler, so a quick run of the bundle command and
+you're all set!
+
+    $ bundle
+
+Before you start, run the tests and make sure that they pass (to confirm your
+environment is configured properly):
+
+    $ rake test
+    $ rake features
+
+Workflow
+--------
+
+Here's the most direct way to get your work merged into the project:
+
+* Fork the project.
+* Clone down your fork ( `git clone git@github.com:<username>/jekyll.git` ).
+* Create a topic branch to contain your change ( `git checkout -b my_awesome_feature` ).
+* Hack away, add tests. Not necessarily in that order.
+* Make sure everything still passes by running `rake`.
+* If necessary, rebase your commits into logical chunks, without errors.
+* Push the branch up ( `git push origin my_awesome_feature` ).
+* Create a pull request against mojombo/jekyll and describe what your change
+  does and the why you think it should be merged.
+
+Gotchas
+-------
+
+* If you want to bump the gem version, please put that in a separate commit.
+  This way, the maintainers can control when the gem gets released.
+* Try to keep your patch(es) based from the latest commit on mojombo/jekyll.
+  The easier it is to apply your work, the less work the maintainers have to do,
+  which is always a good thing.
+* Please don't tag your GitHub issue with [fix], [feature], etc. The maintainers
+  actively read the issues and will label it once they come across it.
+
+Finally...
+----------
+
+Thanks! Hacking on Jekyll should be fun. If you find any of this hard to figure
+out, let us know so we can improve our process or documentation!

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2008 Tom Preston-Werner
+
+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,88 @@
+## Monad
+
+Monad is a simple, blog aware, static site generator based on and 100% compatible with [Jekyll](https://github.com/mojombo/jekyll).
+
+The main feature it adds is as follows:
+
+- Support data sources
+- Support virtual posts from external sources(TBD)
+
+## Data Sources
+
+Data Source enables you to load data from external sources, such as web, file system,
+databases and then use them inside views.
+
+Jekyll supports two built-in data sources:
+
+- `YAML` from local file system
+- `JSON` from web
+
+And it's easy to roll your own data source driver.
+
+### JSON
+
+In ordre to use json from web in your site, set following in `_config.yml` file:
+
+``` yaml
+data_sources:
+  - name: albums # will be used as site.albums to access data, no spaces allowed
+    type: json
+    url: http://www.example.com/albums.json # must be http or https
+```
+
+Then, inside html you can access the data as following:
+
+    {% for album in site.albums %}
+    ...
+    {% endfor %}
+
+### YAML
+
+To define a yaml data source, set following in `_config.yml` file:
+
+``` yaml
+data_sources:
+  - name: products # will be used as site.products to access data, no spaces allowed
+    type: yaml
+    path: _data/products.yml # must be on local file system
+```
+
+Then, inside html you can access the data as following:
+
+    {% for product in site.products %}
+    ...
+    {% endfor %}
+
+### Custom drivers
+
+The skeleton of your driver should be as follows:
+
+``` ruby
+module Monad
+  module Drivers
+    class XxxDriver
+      # source options are passed in as an Hash
+      def initialize(options)
+      end
+
+      # return the loaded data as Array or Hash or a nested structure of Array and Hash
+      def load
+      end
+    end
+  end
+end
+```
+
+After you've implemented the code, put the source file inside `_plugins` directory.
+
+Then in `_config.yml`, you can use the driver as follows:
+
+``` yaml
+data_sources:
+  - name: students
+    type: xxx
+```
+
+If the type is `xxx`, Jekyll assumes the corresponding driver is `Monad::Drivers::XxxDriver`. If the type is `xxx_yyy`, the driver should be `Monad::Drivers::XxxYyyDriver`, and so on.
+
+Beside the obligatory `name` and `type` options, you can define any more options to be used inside the driver.

data/Rakefile

@@ -0,0 +1,136 @@
+require 'rubygems'
+require 'rake'
+require 'rdoc'
+require 'date'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => [:test, :features]
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.profile = "travis"
+  end
+  Cucumber::Rake::Task.new(:"features:html", "Run Cucumber features and produce HTML output") do |t|
+    t.profile = "html_report"
+  end
+rescue LoadError
+  desc 'Cucumber rake task not available'
+  task :features do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg|coverage)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end

data/bin/monad

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+STDOUT.sync = true
+
+$:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib })
+
+require 'commander/import'
+require 'monad'
+
+Monad::Deprecator.process(ARGV)
+
+program :name, 'monad'
+program :version, Monad::VERSION
+program :description, 'Monad is a blog-aware, static site generator in Ruby based on jekyll'
+
+default_command :help
+
+global_option '-s', '--source [DIR]', 'Source directory (defaults to ./)'
+global_option '-d', '--destination [DIR]', 'Destination directory (defaults to ./_site)'
+global_option '--safe', 'Safe mode (defaults to false)'
+global_option '--plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]', Array, 'Plugins directory (defaults to ./_plugins)'
+global_option '--layouts', 'Layouts directory (defaults to ./_layouts)'
+
+# Option names don't always directly match the configuration value we'd like.
+# This method will rename options to match what Monad configuration expects.
+#
+# options - The Hash of options from Commander.
+#
+# Returns the normalized Hash.
+def normalize_options(options)
+  if drafts_state = options.delete(:drafts)
+    options[:show_drafts] = drafts_state
+  end
+  options
+end
+
+command :new do |c|
+  c.syntax = 'monad new PATH'
+  c.description = 'Creates a new Monad site scaffold in PATH'
+
+  c.action do |args, options|
+    Monad::Commands::New.process(args)
+  end
+end
+
+command :build do |c|
+  c.syntax = 'monad build [options]'
+  c.description = 'Build your site'
+
+  c.option '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
+  c.option '--future', 'Publishes posts with a future date'
+  c.option '--limit_posts MAX_POSTS', Integer, 'Limits the number of posts to parse and publish'
+  c.option '-w', '--watch', 'Watch for changes and rebuild'
+  c.option '--lsi', 'Use LSI for improved related posts'
+  c.option '--drafts', 'Render posts in the _drafts folder'
+
+  c.action do |args, options|
+    options = normalize_options(options.__hash__)
+    options = Monad.configuration(options)
+    Monad::Commands::Build.process(options)
+  end
+end
+
+command :serve do |c|
+  c.syntax = 'monad serve [options]'
+  c.description = 'Serve your site locally'
+
+  c.option '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
+  c.option '--future', 'Publishes posts with a future date'
+  c.option '--limit_posts MAX_POSTS', Integer, 'Limits the number of posts to parse and publish'
+  c.option '-w', '--watch', 'Watch for changes and rebuild'
+  c.option '--lsi', 'Use LSI for improved related posts'
+  c.option '--drafts', 'Render posts in the _drafts folder'
+
+  c.option '-p', '--port [PORT]', 'Port to listen on'
+  c.option '-h', '--host [HOST]', 'Host to bind to'
+  c.option '-b', '--baseurl [URL]', 'Base URL'
+
+  c.action do |args, options|
+    options.default :serving => true
+
+    options = normalize_options(options.__hash__)
+    options = Monad.configuration(options)
+    Monad::Commands::Build.process(options)
+    Monad::Commands::Serve.process(options)
+  end
+end
+alias_command :server, :serve
+
+command :doctor do |c|
+  c.syntax = 'monad doctor'
+  c.description = 'Search site and print specific deprecation warnings'
+
+  c.option '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
+
+  c.action do |args, options|
+    options = normalize_options(options.__hash__)
+    options = Monad.configuration(options)
+    Monad::Commands::Doctor.process(options)
+  end
+end
+alias_command :hyde, :doctor
+

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: --format pretty
+travis: --format progress
+html_report: --format progress --format html --out=features_report.html

data/features/create_sites.feature

@@ -0,0 +1,112 @@
+Feature: Create sites
+  As a hacker who likes to blog
+  I want to be able to make a static site
+  In order to share my awesome ideas with the interwebs
+
+  Scenario: Basic site
+    Given I have an "index.html" file that contains "Basic Site"
+    When I run monad
+    Then the _site directory should exist
+    And I should see "Basic Site" in "_site/index.html"
+
+  Scenario: Basic site with a post
+    Given I have a _posts directory
+    And I have the following post:
+      | title   | date      | content          |
+      | Hackers | 3/27/2009 | My First Exploit |
+    When I run monad
+    Then the _site directory should exist
+    And I should see "My First Exploit" in "_site/2009/03/27/hackers.html"
+
+  Scenario: Basic site with layout and a page
+    Given I have a _layouts directory
+    And I have an "index.html" page with layout "default" that contains "Basic Site with Layout"
+    And I have a default layout that contains "Page Layout: {{ content }}"
+    When I run monad
+    Then the _site directory should exist
+    And I should see "Page Layout: Basic Site with Layout" in "_site/index.html"
+
+  Scenario: Basic site with layout and a post
+    Given I have a _layouts directory
+    And I have a _posts directory
+    And I have the following posts:
+      | title    | date      | layout  | content                               |
+      | Wargames | 3/27/2009 | default | The only winning move is not to play. |
+    And I have a default layout that contains "Post Layout: {{ content }}"
+    When I run monad
+    Then the _site directory should exist
+    And I should see "Post Layout: <p>The only winning move is not to play.</p>" in "_site/2009/03/27/wargames.html"
+
+  Scenario: Basic site with layouts, pages, posts and files
+    Given I have a _layouts directory
+    And I have a page layout that contains "Page {{ page.title }}: {{ content }}"
+    And I have a post layout that contains "Post {{ page.title }}: {{ content }}"
+    And I have an "index.html" page with layout "page" that contains "Site contains {{ site.pages.size }} pages and {{ site.posts.size }} posts"
+    And I have a blog directory
+    And I have a "blog/index.html" page with layout "page" that contains "blog category index page"
+    And I have an "about.html" file that contains "No replacement {{ site.posts.size }}"
+    And I have an "another_file" file that contains ""
+    And I have a _posts directory
+    And I have the following posts:
+      | title     | date      | layout  | content                                |
+      | entry1    | 3/27/2009 | post    | content for entry1.                    |
+      | entry2    | 4/27/2009 | post    | content for entry2.                    |
+    And I have a category/_posts directory
+    And I have the following posts in "category":
+      | title     | date      | layout  | content                                |
+      | entry3    | 5/27/2009 | post    | content for entry3.                    |
+      | entry4    | 6/27/2009 | post    | content for entry4.                    |
+    When I run monad
+    Then the _site directory should exist
+    And I should see "Page : Site contains 2 pages and 4 posts" in "_site/index.html"
+    And I should see "No replacement \{\{ site.posts.size \}\}" in "_site/about.html"
+    And I should see "" in "_site/another_file"
+    And I should see "Page : blog category index page" in "_site/blog/index.html"
+    And I should see "Post entry1: <p>content for entry1.</p>" in "_site/2009/03/27/entry1.html"
+    And I should see "Post entry2: <p>content for entry2.</p>" in "_site/2009/04/27/entry2.html"
+    And I should see "Post entry3: <p>content for entry3.</p>" in "_site/category/2009/05/27/entry3.html"
+    And I should see "Post entry4: <p>content for entry4.</p>" in "_site/category/2009/06/27/entry4.html"
+
+  Scenario: Basic site with include tag
+    Given I have a _includes directory
+    And I have an "index.html" page that contains "Basic Site with include tag: {% include about.textile %}"
+    And I have an "_includes/about.textile" file that contains "Generated by Monad"
+    When I run monad
+    Then the _site directory should exist
+    And I should see "Basic Site with include tag: Generated by Monad" in "_site/index.html"
+
+  Scenario: Basic site with subdir include tag
+    Given I have a _includes directory
+    And I have an "_includes/about.textile" file that contains "Generated by Monad"
+    And I have an info directory
+    And I have an "info/index.html" page that contains "Basic Site with subdir include tag: {% include about.textile %}"
+    When I run monad
+    Then the _site directory should exist
+    And I should see "Basic Site with subdir include tag: Generated by Monad" in "_site/info/index.html"
+
+  Scenario: Basic site with nested include tag
+    Given I have a _includes directory
+    And I have an "_includes/about.textile" file that contains "Generated by {% include monad.textile %}"
+    And I have an "_includes/monad.textile" file that contains "Monad"
+    And I have an "index.html" page that contains "Basic Site with include tag: {% include about.textile %}"
+    When I run monad
+    Then the _site directory should exist
+    And I should see "Basic Site with include tag: Generated by Monad" in "_site/index.html"
+
+  Scenario: Basic site with internal post linking
+    Given I have an "index.html" page that contains "URL: {% post_url 2020-01-31-entry2 %}"
+    And I have a configuration file with "permalink" set to "pretty"
+    And I have a _posts directory
+    And I have the following posts:
+      | title     | date       | layout  | content                                |
+      | entry1    | 12/31/2007 | post    | content for entry1.                    |
+      | entry2    | 01/31/2020 | post    | content for entry2.                    |
+    When I run monad
+    Then the _site directory should exist
+    And I should see "URL: /2020/01/31/entry2/" in "_site/index.html"
+
+  Scenario: Basic site with whitelisted dotfile
+    Given I have an ".htaccess" file that contains "SomeDirective"
+    When I run monad
+    Then the _site directory should exist
+    And I should see "SomeDirective" in "_site/.htaccess"