village 2.1.2

data/Gemfile

@@ -0,0 +1,29 @@
+source 'http://rubygems.org'
+
+# Specify any dependencies in the gemspec
+gemspec
+
+## PLEASE UNBLOCK ME IF YOU WANT TO RUN TEST
+## WITH SPORK AND GUARD
+# group :development, :test do
+#   gem 'rails', '3.0.10'
+#   # load
+#   require 'rails'
+#   require 'action_view'
+#   require 'action_controller/vendor/html-scanner/html/sanitizer'
+#   
+#   # test gems
+#   gem 'rspec-rails', '~> 2.5'
+#   gem 'guard-rspec'
+#   gem 'capybara', '~> 1.0.0.beta'
+#   gem 'delorean', '>= 0.2'
+#   gem 'rb-fsevent', :require => false
+#   gem 'growl'
+#   
+#   # other
+#   gem 'haml-rails'
+#   gem 'sqlite3'
+#   gem 'kaminari'
+#   gem 'redcarpet'
+#   gem 'rdoc'
+# end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :all_after_pass => false do
+  watch(%r{^app/.+\.(rb|erb|haml|builder)$})       { "spec" }
+  watch(%r{^spec/.+\.(rb|erb|haml|markdown|md|mkd|rdoc|yml|builder)$})  { "spec" }
+  watch(%r{^lib/.+\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')             { "spec" }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Fajri Fachriansyah
+
+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,255 @@
+# Village
+
+A simple static content pages and blog engine for Rails 3.x
+
+Village are inspired by [high_voltage](https://github.com/thoughtbot/high_voltage) and [postmarkdown](https://github.com/ennova/postmarkdown) gems, for creating static content page and
+mini blog engine inside your Rails 3 application. 
+
+So Village are the combination of it, combination of all unnecessary files, nasty that you definitely don't want 
+to be stored into the database, rather than just read from the disk and just use `http_caching`, `memcached`
+or whatever caching mechanism you wish to use in your production mode.
+
+Village is compatible with Rails 3 only and the gem is hosted on [RubyGems.org](https://rubygems.org/gems/village).
+
+## Features
+
+* Using various template engines such as markdown, textile, erb, etc. (whatever that `tilt` support)
+* No database and administering page (update your content using git only)
+* RSS Feed / Atom
+* Customizable Routes
+* HTML5 support
+* Rails engine (so you can override views, controllers, etc)
+* Easily customized
+* Commenting via discuss
+* Google analytics
+* Support for tags / categories for articles
+* Paginated article using `kaminari`
+* Gravatar support using `gravtastic`
+* `add-this` button support
+
+## Installation
+
+Simply add Village to your Gemfile and bundle it up:
+
+    gem 'village'
+
+Static pages and blog engine are managed under the named `village:pages` and `village:articles` respectively.
+To setup both, run the generator to setup Village for your application:
+
+    $ rails generate village:setup
+
+The above command will setup all necessary files and folders, routes, views directory required by `village:pages` and `village:articles`,
+you can pass `--skip` optional parameter if want to skip some of the functionality.
+(e.g you don't want to install `village:pages` then pass `--skip-pages`)
+
+By default Village are using `tilt` to render every contents, so it is required you to install some of the template
+engine you wish to use with Village, for example `redcarpet` for markdown then add `gem 'redcarpet'` in your `Gemfile`
+or `RedCloth` for textile, etc.
+
+all the configuration settings are managed in YAML file `config/village_config.yml`, you can customize it later depending your needs.
+
+## Village:Pages
+
+Your static content pages are lived under `app/views/pages` directory, you can have many nested folder with pages in here!
+
+you can access your static pages using route helper method `village_page_path`, for example:
+
+    <%= link_to "My Page", village_page_path('to/my/page') %>
+
+if you setup `village:pages` properly, you will have some example page `app/views/pages/example-page.markdown`
+to tested it, open `http://localhost:3000/example-page` in your browser and you should be able to navigate to your static page. 
+
+## Village:Articles
+
+This is a mini blog engine for your Rails app, all the articles are managed under `app/views/articles` directory 
+and the views files after you run the setup are copied into `app/views/village/articles` directory.
+
+### Generate a new Article
+
+Here's an example of how to generate a new article using a slug and publish date:
+
+    $ rails generate village:articles test-post.md --date=2011-01-01
+
+The above command will create the file `app/articles/2011-01-01-test-post.md`, which you can edit and add content to.
+
+### View the Articles
+
+Open `http://localhost:3000/articles` in your browser and you should be able to navigate to your index articles page. 
+The URL for your new article is `http://localhost:3000/articles/2011/01/01/test-post`.
+
+### Article metadata
+
+Metadata are stored inside the generated article using YAML front-matter `---`
+
+	---
+	title: My First Article
+	author:
+	  name: Fajri Fachriansyah
+	  uri: https://github.com/fajrif
+	  email: fajri82@gmail.com
+	summary: This is another article with custom metadata & summary.
+	tags: ["Ruby","Rails"]
+	---
+
+Village are implementing `method_missing`, so you are able to add any others metadata attributes 
+inside this kind of block and use it inside your views. For example :
+
+	---
+	title: My First Article
+	summary: This is another article with custom metadata & summary.
+	sub_summary: this is the sub-summary i want to use in my views.
+	---
+
+notice that `sub_summary` are not required by `village:articles`, but you still able to add it
+and use it inside your views like this line:
+
+	article.sub_summary if article.sub_summary?
+
+### RSS Feed
+
+Village:Articles comes prepared with a fully functional RSS feed / Atom.
+
+You can take advantage of the built-in feed by adding the feed link to your HTML head tag. For example, simply add the following to your default layout:
+
+    <head>
+      <!-- include your stylesheets and javascript here... -->
+      <%= yield :head %>
+    </head>
+
+To link to the feed in your app, simply use the route helper: `<%= link_to 'RSS Feed', village_articles_path(:rss) %>`
+or if you like to use Atom: `village_articles_path(:atom)`
+
+## Customizing Routes
+
+By default Village will setup all article routes to go through the `/articles/*` path 
+while static pages go through root path (/)
+
+For example:
+
+    http://localhost:3000/articles                      # lists all articles
+    http://localhost:3000/articles/2011                 # lists all articles from 2011
+    http://localhost:3000/articles/2011/01              # lists all articles from January 2011
+    http://localhost:3000/articles/2011/01/01           # lists all articles from the 1st of January 2011
+    http://localhost:3000/articles/tags/ruby            # lists all articles tagged with ruby
+    http://localhost:3000/articles/2011/01/01/test-post # show the specified article
+    http://localhost:3000/pages/home                    # show the specified static page
+
+You can change the default route path by modifying the 'village' line in `routes.rb`. For example:
+
+    village :articles, :as => :blog
+    village :pages, :as => :content
+
+This will produce the following routes:
+
+    http://localhost:3000/blog                      # lists all articles
+    http://localhost:3000/blog/2011                 # lists all articles from 2011
+    http://localhost:3000/blog/2011/01              # lists all articles from January 2011
+    http://localhost:3000/blog/2011/01/01           # lists all articles from the 1st of January 2011
+    http://localhost:3000/blog/tags/ruby            # lists all articles tagged with ruby
+    http://localhost:3000/blog/2011/01/01/test-post # show the specified article
+    http://localhost:3000/content/home              # show the specified static page
+
+You can also customize the `articles#show` route for `village:articles` via the `:permalink_format` option:
+
+    village :articles, :as => :blog, :permalink_format => :day   # URL: http://localhost:3000/blog/2011/01/01/test-post
+    village :articles, :as => :blog, :permalink_format => :month # URL: http://localhost:3000/blog/2011/01/test-post
+    village :articles, :as => :blog, :permalink_format => :year  # URL: http://localhost:3000/blog/2011/test-post
+    village :articles, :as => :blog, :permalink_format => :slug  # URL: http://localhost:3000/blog/test-post
+
+What about mapping `village:articles` / `village:pages` to root? We got you covered:
+
+    village :articles
+    root :to => 'village/articles#index'
+
+or redirect root_path to some static pages in this case `home.erb`:
+
+	village :pages
+	root :to => 'village/pages#show', :id => 'home'
+
+## Default Directory Structure
+
+    ├── app
+    │   ├── controllers
+    │   ├── helpers
+    │   ├── mailers
+    │   ├── models
+    │   └── views
+    │       └── village (overrideable views)
+    │       	└── articles (customizable)
+    │           	├── _article.html.haml
+    │           	├── _sidebar.html.haml
+    │           	├── ...
+    │           	└── show.html.haml
+    │   	├── articles (where your article files live)
+    │   	│   ├── 2011-04-01-example-1.markdown
+    │   	│   ├── ...
+    │   	│   ├── 2011-04-04-example-4.markdown
+    │       └── pages (where your static page files live)
+    │           ├── home.haml
+    │           ├── FAQ_FOLDERS
+    │               └── how-to.markdown
+    │           ├── ...
+    │           └── user_guides.rdoc
+
+## Override Village Controller
+
+Most common reasons to override?
+
+* You need authentication around the pages or articles to make sure a user is signed in.
+* Or you need to skip authentication for some pages if you defined authentication filter on `ApplicationController`
+* You need to render different layouts for different pages.
+
+In this case I will show you how to override `village:pages` to add skip authentication generated by `Devise`,
+let's assume that you have `before_filter: authenticate_user!` in your `ApplicationController`.
+
+You have to create a PagesController of your own:
+
+    $ rails generate controller pages
+
+Then modify your new `PagesController` it to inherit from Village::PagesController, adding whatever you need:
+
+    class PagesController < Village::PagesController
+      before_filter: authenticate_user!
+    end
+
+And then change the default `village:pages` route to route to your new controller:
+
+    # in config/routes.rb
+    village :pages, :controller => "pages"
+
+## Supported Template Engine
+
+According from [tilt](https://github.com/rtomayko/tilt) Village will support for these template engines:
+
+    ENGINE                     FILE EXTENSIONS         REQUIRED LIBRARIES
+    -------------------------- ----------------------- ----------------------------
+    ERB                        .erb, .rhtml            none (included ruby stdlib)
+    Erubis                     .erb, .rhtml, .erubis   erubis
+    Haml                       .haml                   haml
+    Builder                    .builder                builder
+    Liquid                     .liquid                 liquid
+    RDiscount                  .markdown, .mkd, .md    rdiscount
+    Redcarpet                  .markdown, .mkd, .md    redcarpet
+    BlueCloth                  .markdown, .mkd, .md    bluecloth
+    Kramdown                   .markdown, .mkd, .md    kramdown
+    Maruku                     .markdown, .mkd, .md    maruku
+    RedCloth                   .textile                redcloth
+    RDoc                       .rdoc                   rdoc
+    Radius                     .radius                 radius
+    Markaby                    .mab                    markaby
+    Creole (Wiki markup)       .wiki, .creole          creole
+    WikiCloth (Wiki markup)    .wiki, .mediawiki, .mw  wikicloth
+    Yajl                       .yajl                   yajl-ruby
+
+
+this handlers are configurable inside generated `config/initializers/init_village.rb` file after you run the `village:setup`,
+you are able to edit this file, if you wish not to use all these handlers!
+
+## FOUND A BUG
+
+don't hesitate to post your issues in [here](https://github.com/fajrif/village/issues)
+
+## LICENSE
+
+Village is Copyright (c) 2011 [Fajri Fachriansyah](https://github.com/fajrif) and
+distributed under the MIT license.

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler.require(:default, :test)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rdoc/task'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ContactForm'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/village/articles_controller.rb

@@ -0,0 +1,27 @@
+module Village
+  class ArticlesController < ApplicationController
+
+    def index
+      render :layout => Village::Config.layout
+    end
+
+    def show
+      resource
+      render :layout => Village::Config.layout
+    end
+
+  protected
+
+    def resource
+      @resource ||= Article.find(params[:id])
+    end
+    helper_method :resource
+
+    def collection
+      @collection ||= Article.where(params.slice(:year, :month, :day, :tag, :category))
+      Kaminari.paginate_array(@collection).page(params[:page]).per(Village::Config.page_size)
+    end
+    helper_method :collection
+
+  end
+end

data/app/controllers/village/pages_controller.rb

@@ -0,0 +1,16 @@
+module Village
+  class PagesController < ApplicationController
+    rescue_from ActionView::MissingTemplate do |exception|
+      if exception.message =~ %r{Missing template "#{params[:id]}"}
+        raise ActionController::RoutingError, "No such page: #{params[:id]}"
+      else
+        raise exception
+      end
+    end
+
+    def show
+      @resource = Page.find(params[:id])
+      render :layout => Village::Config.layout
+    end
+  end
+end

data/app/views/layouts/village.html.haml

@@ -0,0 +1,22 @@
+!!! 5
+%html
+  %head
+    %title= Village::Config.title
+    = stylesheet_link_tag 'village'
+    = yield :head
+  %body
+    %header#header
+      %h1= link_to Village::Config.title, '/'
+      %p
+        = Village::Config.subtitle
+    %section#content
+      = yield
+    %footer
+      %small
+        - if Village::Config.author?
+          A #{link_to 'village',  Village::Config.author[:url]} blog
+          = "by #{Village::Config.author[:name]}"
+        = "Copyright © #{Date.today.year}".html_safe
+        = link_to 'rss', village_articles_path(:rss)
+        |
+        = link_to 'atom', village_articles_path(:atom)

data/app/views/village/articles/_addthis.html.haml

@@ -0,0 +1,8 @@
+/ AddThis Button BEGIN
+.addthis_toolbox.addthis_default_style
+  %a.addthis_button_facebook_like{"fb:like:layout" => "button_count"}
+  %a.addthis_button_tweet
+  %a.addthis_button_google_plusone{"g:plusone:size" => "medium"}
+  %a.addthis_counter.addthis_pill_style
+%script{:src => "http://s7.addthis.com/js/250/addthis_widget.js#pubid=ra-4eade9351b25746b", :type => "text/javascript"}
+/ AddThis Button END

data/app/views/village/articles/_analytics.html.haml

@@ -0,0 +1,13 @@
+- content_for :head do
+  - if Village::Config.google_analytics_code?
+    :plain
+      <script type="text/javascript">
+        var _gaq = _gaq || [];
+        _gaq.push(['_setAccount', '#{Village::Config.google_analytics_code}']);
+        _gaq.push(['_trackPageview']);
+        (function() {
+          var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+          ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+          var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+        })();
+      </script>

data/app/views/village/articles/_article.html.haml

@@ -0,0 +1,25 @@
+= content_tag_for :article, article do
+  %header
+    %h1= link_to article.title, article
+    = image_tag article.gravatar_url(:size => 32, :default => 'identicon'), :height => 32, :width => 32
+    .meta
+      %time{:pubdate => 'true', :datetime => article.timestamp.iso8601}
+        Posted on #{article.date.strftime '%e %B %Y'}
+      %span
+        by
+        = article.author[:name]
+        %p
+          - if article.categories?
+            Categories on:
+            - article.categories.each do |category|
+              = link_to category, village_articles_path(:category => category)
+        %p
+          - if article.tags?
+            Tags on:
+            - article.tags.each do |tag|
+              = link_to tag, village_articles_path(:tag => tag)
+  - if summary
+    = article.summary_html
+    %p.more= link_to 'Read more…'.html_safe, article
+  - else
+    ~ article.content_html