semi_static 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.log

data/Gemfile

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

data/README.md

@@ -0,0 +1,3 @@
+# SemiStatic: A simple text-file based CMS for Rails
+
+In our internal projects, such as [請求書.jp](https://www.seikyusho.jp/) and [Doorkeeper](http://www.doorkeeper.jp/), we have had the need to generate lots of text content, such as news entries or FAQ pages. SemiStatic provides you with an easy way to manage such content.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+task :default => :spec
+RSpec::Core::RakeTask.new

data/app/controllers/semi_static/news_controller.rb

@@ -0,0 +1,9 @@
+class SemiStatic::NewsController < SemiStatic::PageController
+  def index
+    super
+    respond_to do |f|
+      f.html 
+      f.atom { render :layout => false }
+    end
+  end
+end

data/app/controllers/semi_static/page_controller.rb

@@ -0,0 +1,14 @@
+class SemiStatic::PageController < ApplicationController
+  def index
+    @articles = resource.all
+  end
+
+  def show
+    @article = resource.find(params[:id])
+    raise ActionController::RoutingError.new(url_for(:id => params[:id], :only_path => true)) unless @article
+  end
+
+  def resource
+    env["semi_static.mapping"]
+  end
+end

data/app/views/semi_static/news/index.atom.builder

@@ -0,0 +1,10 @@
+atom_feed do |feed|
+  feed.title controller.resource.feed_title
+  feed.updated @articles.first.published_at
+  @articles.each do |article|
+    feed.entry(article) do |entry|
+      entry.title(article.title)
+      entry.content(article.body.render(self).html_safe, :type => "html")
+    end
+  end
+end

data/app/views/semi_static/news/index.html.erb

@@ -0,0 +1,7 @@
+<% @articles.each do |article| %>
+  <article>
+    <h1><%= link_to article, article %></h1>
+    <date><%= l(article.published_at, :format => :long) %></date>
+    <section><%= article.body.render(self).html_safe %></section>
+  </article>
+<% end %>

data/app/views/semi_static/news/show.html.erb

@@ -0,0 +1,5 @@
+<article>
+  <h1><%= @article.title %></h1>
+  <date><%= l(@article.published_at, :format => :long) %></date>
+  <section><%= @article.body.render(self).html_safe %></section>
+</article>

data/app/views/semi_static/page/index.html.erb

@@ -0,0 +1,6 @@
+<% @articles.each do |article| %>
+  <article>
+    <h1><%= link_to article, article %></h1>
+    <section><%= article.body.render(self).html_safe %></section>
+  </article>
+<% end %>

data/app/views/semi_static/page/show.html.erb

@@ -0,0 +1,4 @@
+<article>
+  <h1><%= @article.title %></h1>
+  <section><%= @article.body.render(self).html_safe %></section>
+</article>

data/lib/semi_static.rb

@@ -0,0 +1,26 @@
+require 'active_model/naming'
+require 'active_support/core_ext/module/delegation.rb'
+require 'active_support/core_ext/string/output_safety'
+require 'babosa'
+require 'rails'
+require 'rdiscount'
+require 'tilt'
+require 'yaml'
+
+require "semi_static/version"
+
+module SemiStatic
+  autoload :News, "semi_static/news"
+  autoload :Article, "semi_static/article"
+  autoload :Page, "semi_static/page"
+  autoload :Backend, "semi_static/backend"
+
+  class << self
+    attr_writer :backend
+    def backend
+      @backend ||= Backend.new(Rails.root.join("semi_static_pages"))
+    end
+  end
+end
+
+require "semi_static/rails"

data/lib/semi_static/backend.rb

@@ -0,0 +1,20 @@
+class SemiStatic::Backend < SemiStatic::Page
+
+  def initialize(root)
+    @root = root
+    @cache = {}
+  end
+
+  def all(page_type)
+    unless @cache.key?(page_type)
+      path = File.join(@root,ActiveModel::Naming.plural(page_type), "*")
+      @cache[page_type] = Dir.glob(path).map do |f|
+        yaml, body = File.read(f).split("\n...\n", 2)
+        h = YAML.load(yaml)
+        template = Tilt.new(f) {|template| body }
+        page_type.new(template, h)
+      end
+    end
+    @cache[page_type]
+  end
+end

data/lib/semi_static/news.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+class SemiStatic::News < SemiStatic::Page
+  attr_accessor :published_at
+  delegate :year, :month, :day, :to => :published_at
+
+  def self.all
+    super.sort_by(&:published_at).reverse
+  end
+
+  # used for atom feed
+  def id
+    Digest::MD5.hexdigest to_param
+  end
+
+  def to_param
+    "#{year}/#{month}/#{day}/#{super}"
+  end
+end

data/lib/semi_static/page.rb

@@ -0,0 +1,34 @@
+class SemiStatic::Page
+  autoload :WithLocale, "semi_static/page/with_locale"
+
+  extend ActiveModel::Naming
+  attr_accessor :title, :body
+
+  def self.all
+    SemiStatic.backend.all(self)
+  end
+
+  def self.first
+    all.first
+  end
+
+  def self.find(param)
+    all.find {|a| a.to_param == param }
+  end
+
+  def initialize(body, args)
+    @body = body
+    args.each_pair do |k,v|
+      send("#{k}=", v)
+    end
+  end
+
+  def to_param
+    title.to_slug.normalize.to_s
+  end
+
+  def to_s
+    title.to_s
+  end
+
+end

data/lib/semi_static/page/with_locale.rb

@@ -0,0 +1,12 @@
+module SemiStatic::Page::WithLocale
+  def self.included(klass)
+    klass.send :attr_accessor, :locale
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    def all
+      super.find_all {|a| a.locale.to_sym == I18n.locale }
+    end
+  end
+end

data/lib/semi_static/rails.rb

@@ -0,0 +1,6 @@
+require 'semi_static/rails/routes'
+
+module SemiStatic
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/semi_static/rails/routes.rb

@@ -0,0 +1,16 @@
+module ActionDispatch::Routing
+  class Mapper
+    def semi_static_for(resource, args = {})
+      resource_as_class = resource.to_s.classify.constantize
+      c = lambda {|r| r.env["semi_static.mapping"] = resource_as_class ; true }
+      defaults = { :only => [ :index, :show ]}
+      if resource_as_class < SemiStatic::News
+        defaults[:id] = /([0-9]+\/){3}.+/
+        defaults[:controller] = "semi_static/news"
+      else
+        defaults[:controller] = "semi_static/page"
+      end
+      constraints(c) { resources(resource, defaults.merge(args)) }
+    end
+  end
+end

data/lib/semi_static/version.rb

@@ -0,0 +1,3 @@
+module SemiStatic
+  VERSION = "0.0.1"
+end

data/semi_static.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "semi_static/version"
+
+Gem::Specification.new do |s|
+  s.name        = "semi_static"
+  s.version     = SemiStatic::VERSION
+  s.authors     = ["Paul McMahon"]
+  s.email       = ["paul@mobalean.com"]
+  s.homepage    = "http://www.mobalean.com"
+  s.summary     = %q{Text file based CMS for Rails}
+  s.description = %q{Easily create content for your Rails apps using just textfiles}
+
+  s.rubyforge_project = "semi_static"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rails', '~> 3.0'
+  s.add_dependency 'rdiscount'
+  s.add_dependency 'babosa'
+  s.add_dependency 'tilt'
+
+  s.add_development_dependency 'rspec', '~> 2.5.0'
+  s.add_development_dependency 'steak'
+end

data/spec/acceptance/acceptance_helper.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+require File.expand_path(File.dirname(__FILE__) + "/fake/app")
+require "steak"
+require 'capybara/rspec'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+require 'rspec/rails'

data/spec/acceptance/fake/app.rb

@@ -0,0 +1,17 @@
+require 'rails'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+# config
+app = Class.new(Rails::Application)
+app.config.root = File.dirname(__FILE__)
+app.config.secret_token = "3b7cd727ee24e8444053437c36cc66c4"
+app.config.session_store :cookie_store, :key => "_myapp_session"
+app.config.active_support.deprecation = :log
+app.initialize!
+
+app.routes.draw do
+  semi_static_for :news
+  semi_static_for :event_planning_tips
+end
+class ApplicationController < ActionController::Base; end

data/spec/acceptance/fake/app/models/event_planning_tip.rb

@@ -0,0 +1,3 @@
+# encoding: UTF-8
+class EventPlanningTip < SemiStatic::Page
+end

data/spec/acceptance/fake/app/models/news.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+class News < SemiStatic::News
+  def self.feed_title
+    "請求書.jp"
+  end
+end

data/spec/acceptance/fake/app/views/application.html.erb

@@ -0,0 +1,10 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE html PUBLIC "-//WAPFORUM//DTD XHTML Mobile 1.2//EN" "http://www.openmobilealliance.org/tech/DTD/xhtml-mobile12.dtd">
+<html>
+  <head>
+    <meta content='application/xhtml+xml;charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/acceptance/fake/semi_static_pages/event_planning_tips/manner.md

@@ -0,0 +1,18 @@
+title: イベント時に気をつけたいマナー
+...
+## 1. 無断に写真や動画の撮影、公開しない
+
+写真や動画の撮影、Ustreamなどを用いた生放送等により、本人の知らない間にインターネット上で公開され問題になるケースがあります。そのようなことを避けるためにも事前に撮影の許可、どこかに掲載する場合には、掲載しても問題がないかの許可を取るべきです。イベントの申込時やチケットの購入時の条件に撮影許可等について記載しておくのがいいかもしれません。
+
+## 2. 飲食やゴミの分別の注意喚起
+
+イベントを開催する場所によっては、飲食の禁止や制限があり、ゴミは各自で持ち帰っていただくこともあれば、専用のゴミ箱を使用してもいい場合もあります。開催場所の利用規約をきちんと把握し、参加者に伝え、それを徹底させることが大切です。特に配布資料等がある場合は、ゴミ箱を利用せず、会場や路上での放置があるかもしれまんせので、気をつけましょう。
+
+## 3. 騒音問題
+
+イベントが盛り上がってくると、次第に大声で話したり、高笑いをするようなことが見受けられます。ある程度は致し方ないことかもしれませんが、近隣の住人の方々には迷惑をかけないよう心がけましょう。
+
+## Doorkeeperでマナーあるイベントを！
+### 注意事項の告知や急な仕様変更も、参加者へのメール一斉送信ができますので、簡単に通知できます。Doorkeeperは、メール通知等で、メンバー間のコミュニケーションや情報の共有をサポートします。
+
+#### [Doorkeeperでマナーあるイベント開催を♪まずはご登録を！](http://manage.doorkeeper.jp/locale?locale=ja&return_to=%2Fadmins%2Fsign_up)

data/spec/acceptance/fake/semi_static_pages/news/2011-07-26-replaced-download.md

@@ -0,0 +1,8 @@
+title: 請求書のダウンロードが可能になりました
+published_at: 2011-07-26
+...
+
+<p>各請求書のページに「ダウンロード」ボタンを設置し、作成した請求書をPDFファイルとしてダウンロードできるようになりました。</p>
+<p>これにより、今まで「印刷」ボタンから印刷していた際に発生していた、ブラウザ間の動作の違いを意識することなく、簡単に印刷できるかと思います。</p>
+<br>
+<p>※ 今回の変更に伴い、「印刷」ボタンが「ダウンロード」ボタンに変更になりました。</p>

data/spec/acceptance/news_spec.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/acceptance_helper')
+
+feature 'news' do
+  scenario "index" do
+    visit news_index_path
+    page.find("h1 a").text.should == "請求書のダウンロードが可能になりました"
+    page.find("date").text.should == "July 26, 2011"
+    page.find("p").text.should == "各請求書のページに「ダウンロード」ボタンを設置し、作成した請求書をPDFファイルとしてダウンロードできるようになりました。"
+  end
+
+  scenario 'show markdown page' do
+    visit "/news/2011/7/26/#{CGI.escape("請求書のダウンロードが可能になりました")}"
+    page.find("h1").text.should == "請求書のダウンロードが可能になりました"
+    page.find("date").text.should == "July 26, 2011"
+    page.find("p").text.should == "各請求書のページに「ダウンロード」ボタンを設置し、作成した請求書をPDFファイルとしてダウンロードできるようになりました。"
+  end
+
+  scenario 'show non-existant page' do
+    visit "/news/1999/1/23/foo"
+    page.find("h1").text.should == "Routing Error"
+    page.find("pre").text.should == "/news/1999/1/23/foo"
+  end
+end

data/spec/acceptance/page_spec.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+require File.expand_path(File.dirname(__FILE__) + '/acceptance_helper')
+
+feature 'page' do
+  scenario "index" do
+    visit '/event_planning_tips'
+    page.find("h1 a").text.should == "イベント時に気をつけたいマナー"
+    page.find("section h2").text.should == "1. 無断に写真や動画の撮影、公開しない"
+  end
+
+  scenario 'show markdown page' do
+    visit "/event_planning_tips/#{CGI.escape("イベント時に気をつけたいマナー")}"
+    page.find("h1").text.should == "イベント時に気をつけたいマナー"
+    page.find("section h2").text.should == "1. 無断に写真や動画の撮影、公開しない"
+  end
+
+end

data/spec/backend_spec.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+class News < SemiStatic::News
+end
+
+describe SemiStatic::Backend do
+  before do
+    root = File.join(File.dirname(__FILE__), 'semi_static_pages')
+    @backend = described_class.new(root)
+  end
+
+  context "all" do
+    before { @all = @backend.all(News) }
+    it { @all.size.should == 1 }
+
+    context "item" do
+      before { @item = @all.first }
+      it { @item.title.should == "請求書のダウンロードが可能になりました" }
+      it { @item.published_at.should == Date.parse("2011-07-26") }
+      it { @item.body.should be_instance_of Tilt::RDiscountTemplate }
+    end
+  end
+end

data/spec/news_spec.rb

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe SemiStatic::News do
+  before do
+    @page = described_class.new("body", :title => "ほげ", :published_at => Date.parse("2001-01-31"))
+    SemiStatic.backend = mock(:all => [ @page ])
+  end
+
+  it { @page.to_param.should == "2001/1/31/ほげ" }
+  it { News.find("2001/1/31/ほげ").should == @page }
+end

data/spec/page_spec.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe SemiStatic::Page do
+  before do
+    @japanese_page = described_class.new("body", :title => "ほげ")
+    @english_page = described_class.new("body", :title => "foo bar") 
+    SemiStatic.backend = mock(:all => [ @japanese_page, @english_page ])
+  end
+
+  it { @japanese_page.to_param.should == "ほげ" }
+  it { @japanese_page.to_s.should == "ほげ" }
+  it { @english_page.to_param.should == "foo-bar" }
+  it { @english_page.to_s.should == "foo bar" }
+  it { described_class.new(nil, {}).to_s.should == "" }
+  it { SemiStatic::Page.find("foo-bar").should == @english_page }
+end

data/spec/semi_static_pages/news/2011-07-26-replaced-download.md

@@ -0,0 +1,8 @@
+title: 請求書のダウンロードが可能になりました
+published_at: 2011-07-26
+...
+
+<p>各請求書のページに「ダウンロード」ボタンを設置し、作成した請求書をPDFファイルとしてダウンロードできるようになりました。</p>
+<p>これにより、今まで「印刷」ボタンから印刷していた際に発生していた、ブラウザ間の動作の違いを意識することなく、簡単に印刷できるかと思います。</p>
+<br>
+<p>※ 今回の変更に伴い、「印刷」ボタンが「ダウンロード」ボタンに変更になりました。</p>

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'semi_static'

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: semi_static
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul McMahon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2155975900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2155975900
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &2155975480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2155975480
+- !ruby/object:Gem::Dependency
+  name: babosa
+  requirement: &2155975020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2155975020
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &2155974600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2155974600
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2155974100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *2155974100
+- !ruby/object:Gem::Dependency
+  name: steak
+  requirement: &2155973680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2155973680
+description: Easily create content for your Rails apps using just textfiles
+email:
+- paul@mobalean.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/semi_static/news_controller.rb
+- app/controllers/semi_static/page_controller.rb
+- app/views/semi_static/news/index.atom.builder
+- app/views/semi_static/news/index.html.erb
+- app/views/semi_static/news/show.html.erb
+- app/views/semi_static/page/index.html.erb
+- app/views/semi_static/page/show.html.erb
+- lib/semi_static.rb
+- lib/semi_static/backend.rb
+- lib/semi_static/news.rb
+- lib/semi_static/page.rb
+- lib/semi_static/page/with_locale.rb
+- lib/semi_static/rails.rb
+- lib/semi_static/rails/routes.rb
+- lib/semi_static/version.rb
+- semi_static.gemspec
+- spec/acceptance/acceptance_helper.rb
+- spec/acceptance/fake/app.rb
+- spec/acceptance/fake/app/models/event_planning_tip.rb
+- spec/acceptance/fake/app/models/news.rb
+- spec/acceptance/fake/app/views/application.html.erb
+- spec/acceptance/fake/semi_static_pages/event_planning_tips/manner.md
+- spec/acceptance/fake/semi_static_pages/news/2011-07-26-replaced-download.md
+- spec/acceptance/news_spec.rb
+- spec/acceptance/page_spec.rb
+- spec/backend_spec.rb
+- spec/news_spec.rb
+- spec/page_spec.rb
+- spec/semi_static_pages/news/2011-07-26-replaced-download.md
+- spec/spec_helper.rb
+homepage: http://www.mobalean.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: semi_static
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Text file based CMS for Rails
+test_files:
+- spec/acceptance/acceptance_helper.rb
+- spec/acceptance/fake/app.rb
+- spec/acceptance/fake/app/models/event_planning_tip.rb
+- spec/acceptance/fake/app/models/news.rb
+- spec/acceptance/fake/app/views/application.html.erb
+- spec/acceptance/fake/semi_static_pages/event_planning_tips/manner.md
+- spec/acceptance/fake/semi_static_pages/news/2011-07-26-replaced-download.md
+- spec/acceptance/news_spec.rb
+- spec/acceptance/page_spec.rb
+- spec/backend_spec.rb
+- spec/news_spec.rb
+- spec/page_spec.rb
+- spec/semi_static_pages/news/2011-07-26-replaced-download.md
+- spec/spec_helper.rb