faqmarkdown 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e97e7d37b6ca257059b481870e27fbaff846542f
+  data.tar.gz: b18e95c7f427c492b80d6e3722321c2a20c92dc3
+SHA512:
+  metadata.gz: 715e48611684b253eb7f7a2373a3581e8d7f566532ce33a9b6e8f792044b3b8ba791997167ffa79b3c7e0b9b67800d3419db01dbf2878f6b770bf4bbc84e317e
+  data.tar.gz: d368e527772a7fac12bd77fd065754db16b21468259cc5fe9d2db3277178a785b39fed624b488faefe4eb9cde77818a99f69feedc5cac3b1b88506b7dc1ecc84

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle
+Gemfile.lock
+gemfiles/*.gemfile.lock
+db/*.sqlite3
+log/*.log
+tmp/
+pkg/

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--colour

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create 2.0.0@faqmarkdown

data/Appraisals

@@ -0,0 +1,13 @@
+appraise 'rails3_0' do
+  gem 'rails', '~> 3.0.0'
+end
+
+appraise 'rails3_1' do
+  gem 'rails', '~> 3.1.0'
+  gem 'combustion', '~> 0.3.1'
+end
+
+appraise 'rails3_2' do
+  gem 'rails', '~> 3.2.0'
+  gem 'combustion', '~> 0.3.1'
+end

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'stringex'
+gem 'pry', require: false
+gem 'fuubar', '~> 1.1', require: false
+gem 'timecop', require: false
+gem 'generator_spec', require: false
+gem 'debugger'

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'appraisal'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default do
+  exec 'rake appraisal spec'
+end

data/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/app/controllers/faqs_controller.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+class FaqsController < ApplicationController
+  layout :choose_layout
+
+  def index
+    collection
+    respond_to { |format| format.html }
+  end
+
+  def show
+    resource
+    respond_to { |format| format.html }
+  end
+
+  def faq_per_category
+    collection
+    respond_to do |format|
+      format.html { render :index }
+    end
+  end
+
+  def feed
+    max_age = 4.hours
+    response.headers['Cache-Control'] = 'public, max-age=' + max_age.to_i.to_s
+    response.headers['Expires'] = max_age.from_now.httpdate
+    response.content_type = 'application/atom+xml'
+    fresh_when :last_modified => Faq.feed_last_modified
+  end
+
+  protected
+
+  def resource
+    @action = 'show'
+    @resource ||= Faq.find(params[:id])
+  end
+  # helper_method :resource
+
+  def collection
+    @action = 'index'
+    @collection ||= begin
+      faqs = if params.include?(:category)
+                Faq.find_by_category(params[:category])
+              else
+                Faq.where(params.slice(:year, :month, :day))
+              end
+      faqs = Kaminari.paginate_array(faqs).page(params[:page]).per(faqs_per_page)
+      faqs
+    end
+  end
+  # helper_method :collection
+
+  private
+
+  def faqs_per_page
+    params[:count] || Faqmarkdown::Config.options[:faqs_per_page]
+  end
+
+  def choose_layout
+    if Faqmarkdown::Config.options[:use_theme]
+      ActiveSupport::Deprecation.warn "`Faqmarkdown::Config.options[:use_theme]` is deprecated. Use `Faqmarkdown::Config.options[:layout] = 'faqmarkdown'` instead."
+      'faqmarkdown'
+    else
+      Faqmarkdown::Config.options[:layout]
+    end
+  end
+end

data/app/helpers/faq_helper.rb

@@ -0,0 +1,23 @@
+module FaqHelper
+  class Sanitizer < HTML::WhiteListSanitizer
+    self.allowed_tags.merge(%w(img a))
+  end
+
+  def faq_summary_html(faq)
+    if faq.summary.present?
+      content_tag :p, faq.summary
+    else
+      reg = /<!--more-->/
+      html_text = faq_content_html(faq)
+
+      html = !((html_text =~ reg).nil?) ? html_text[0..(html_text =~ reg)-1] : html_text
+      doc = Nokogiri::HTML.fragment(html)
+      doc = doc.search('p').detect { |p| p.text.present? } if (html_text =~ reg).nil?
+      doc.try(:to_html).try(:html_safe)
+    end
+  end
+
+  def faq_content_html(faq)
+    RDiscount.new(render(:inline => faq.content)).to_html.html_safe
+  end
+end

data/app/models/faq.rb

@@ -0,0 +1,170 @@
+require 'active_record/errors'
+require 'stringex'
+
+class Faq
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+
+  include Gravtastic
+  is_gravtastic
+
+  attr_reader :slug
+
+  TIME_FORMAT = /-\d{6}/
+  DATE_FORMAT = /\d{4}-\d{2}-\d{2}(#{TIME_FORMAT})?/
+  SLUG_FORMAT = /[A-Za-z0-9_\-]+/
+  EXTENSION_FORMAT = /\.[^.]+/
+
+  FILENAME_FORMAT = /^(#{DATE_FORMAT})-(#{SLUG_FORMAT})(#{EXTENSION_FORMAT})$/
+
+  def initialize(path)
+    @path = path
+    @date_str, _, @slug = File.basename(path).match(FILENAME_FORMAT).captures
+  end
+
+  def to_param
+    case permalink_format
+    when :day   then "%04d/%02d/%02d/%s" % [year, month, day, slug]
+    when :month then "%04d/%02d/%s" % [year, month, slug]
+    when :year  then "%04d/%s" % [year, slug]
+    when :slug  then slug
+    end
+  end
+
+  def permalink_format
+    Faqmarkdown::Config.options[:permalink_format]
+  end
+
+  def to_key
+    [slug]
+  end
+
+  def metadata
+    load_content
+    @metadata
+  end
+
+  def content
+    load_content
+    @content
+  end
+
+  def title
+    metadata[:title] || slug.titleize
+  end
+
+  def summary
+    metadata[:summary]
+  end
+
+  def author
+    metadata[:author]
+  end
+
+  def email
+    metadata[:email]
+  end
+
+  def categories
+    metadata[:categories]
+  end
+
+  def categories_to_url
+    categories = []
+    self.categories.each {|x| categories << x.to_url}
+    categories
+  end
+
+  def date
+    @date ||= Time.zone.parse(metadata[:date] || @date_str).to_date
+  end
+
+  delegate :year, :month, :day, :to => :date
+
+  def timestamp
+    date.to_time_in_current_zone
+  end
+  alias_method :last_modified, :timestamp
+
+  def visible?
+    timestamp <= Time.zone.now
+  end
+
+  def to_s
+    "#{title.inspect} (#{slug})"
+  end
+
+  class << self
+    def all
+      file_extensions = Faqmarkdown::Config.options[:markdown_file_extensions].join(',')
+      @@faqs ||= Dir.glob("#{directory}/*.{#{file_extensions}}").map do |filename|
+        Faq.new filename
+      end.select(&:visible?).sort_by(&:date).reverse
+    end
+
+    def find_by_category(category=nil)
+      faqs = []
+      all.select do |faq|
+        faqs << faq if !faq.categories.nil? and faq.categories_to_url.include?(category)
+      end
+    end
+
+    def categories_all
+      categories = []
+      all.select do |faq|
+        faq.categories.each {|x| categories << x} unless faq.categories.nil?
+      end
+      categories.uniq
+    end
+
+    def directory
+      Rails.root.join('app', 'faqs')
+    end
+
+    def where(conditions = {})
+      conditions = conditions.symbolize_keys
+      conditions.assert_valid_keys :year, :month, :day, :slug, :to_param
+      [:year, :month, :day].each do |key|
+        conditions[key] = conditions[key].to_i if conditions[key].present?
+      end
+      all.select do |faq|
+        conditions.all? { |key, value| faq.send(key) == value }
+      end
+    end
+
+    def find(id)
+      where(:to_param => id).first or raise ActiveRecord::RecordNotFound, "Could not find faq with ID #{id.inspect}"
+    end
+
+    def first
+      all.first
+    end
+
+    def last
+      all.last
+    end
+
+    def feed
+      all.first(10)
+    end
+
+    def feed_last_modified
+      feed.first.try(:last_modified) || Time.now.utc
+    end
+
+    def reset!
+      @@faqs = nil
+    end
+  end
+
+  protected
+
+  def load_content
+    @content = File.read(@path)
+    if @content =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
+      @content = @content[($1.size + $2.size)..-1]
+      @metadata = YAML.load($1)
+    end
+    @metadata = (@metadata || {}).with_indifferent_access
+  end
+end

data/app/views/faqs/_faq.html.haml

@@ -0,0 +1,16 @@
+= content_tag_for :article, faq do
+  %header
+    %h1= link_to faq.title, faq
+    = image_tag faq.gravatar_url(:size => 32, :default => 'identicon'), :height => 32, :width => 32
+    .meta
+      Posted on
+      %time{:pubdate => 'true', :datetime => faq.timestamp.iso8601}
+        = faq.date.strftime '%e %B %Y'
+      %span
+        by
+        = faq.author
+  - if summary
+    = faq_summary_html faq
+    %p.more= link_to 'Read more…'.html_safe, faq
+  - else
+    ~ faq_content_html faq

data/app/views/faqs/_feed_link.html.haml

@@ -0,0 +1,2 @@
+- content_for :head do
+  %link{:href => faqs_feed_path, :type => 'application/atom+xml', :rel => :alternate, :title => Faqmarkdown::Config.options[:feed_title]}

data/app/views/faqs/feed.xml.builder

@@ -0,0 +1,29 @@
+xml.instruct!
+xml.feed :xmlns => 'http://www.w3.org/2005/Atom' do
+  xml.title Faqmarkdown::Config.options[:feed_title]
+  xml.link :href => faqs_feed_url, :rel => :self, :type => 'application/atom+xml'
+  xml.link :href => faqs_url, :rel => :alternate, :type => 'text/html'
+  xml.id faqs_url
+  xml.updated Faq.feed_last_modified.xmlschema
+
+  Faq.feed.each do |faq|
+    xml.entry do
+      xml.title faq.title, :type => :text
+      xml.link :href => faq_url(faq), :rel => :alternate, :type => 'text/html'
+      xml.published faq.timestamp.xmlschema
+      xml.updated faq.last_modified.xmlschema
+
+      if faq.author.present?
+        xml.author do
+          xml.name faq.author
+          xml.email faq.email if faq.email.present?
+        end
+      end
+
+      xml.id faq_url(faq)
+      xml.content :type => :html, 'xml:base' => faq_url(faq) do
+        xml.cdata! faq_content_html(faq)
+      end
+    end
+  end
+end

data/app/views/faqs/index.html.haml

@@ -0,0 +1,8 @@
+= render 'feed_link'
+
+%section#faqs
+  - if @collection.present?
+    = render @collection, :summary => true
+    = paginate @collection
+  - else
+    No faqs found.

data/app/views/faqs/show.html.haml

@@ -0,0 +1,3 @@
+= render 'feed_link'
+
+= render @resource, :summary => false

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

@@ -0,0 +1,16 @@
+!!! 5
+%html
+  %head
+    %title= Faqmarkdown::Util.app_name
+    = stylesheet_link_tag 'faqmarkdown/faqmarkdown'
+    = yield :head
+  %body
+    %header#header
+      %h1= link_to Faqmarkdown::Util.app_name, '/'
+      %p
+        A #{link_to 'faqmarkdown', 'https://github.com/rrmartins/faqmarkdown'} faq
+        - if Faq.last.try(:author)
+          = "by #{Faq.last.author}"
+    %section#content= yield
+    %footer
+      %small= "Copyright © #{Date.today.year}".html_safe

data/config.ru

@@ -0,0 +1,8 @@
+ENV['BUNDLE_GEMFILE'] = 'gemfiles/rails3_1.gemfile'
+# require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/faqmarkdown.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'faqmarkdown/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'faqmarkdown'
+  s.version     = Faqmarkdown::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Rodrigo Martins']
+  s.email       = ['rodrigo@rrmartins.com']
+  s.licenses    = ['MIT']
+
+  s.homepage    = ''
+  s.summary     = %q{A simple Rails FAQ engine powered by markdown.}
+  s.description = s.summary
+
+  s.rubyforge_project = 'faqmarkdown'
+
+  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', 'public']
+
+  s.add_dependency 'rails', '~> 3.0'
+  s.add_dependency 'haml', '~> 3.1'
+  s.add_dependency 'gravtastic'
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'rdiscount'
+  s.add_dependency 'kaminari'
+
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'rspec-rails', '~> 2.8'
+  s.add_development_dependency 'capybara', '~> 1.0.0.beta'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'delorean', '>= 0.2'
+  s.add_development_dependency 'combustion', '~> 0.3.1'
+end

data/gemfiles/rails3_0.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "stringex"
+gem "pry", :require=>false
+gem "fuubar", "~> 1.1", :require=>false
+gem "timecop", :require=>false
+gem "generator_spec", :require=>false
+gem "debugger"
+gem "rails", "~> 3.0.0"
+
+gemspec :path=>"../"

data/gemfiles/rails3_1.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "stringex"
+gem "pry", :require=>false
+gem "fuubar", "~> 1.1", :require=>false
+gem "timecop", :require=>false
+gem "generator_spec", :require=>false
+gem "debugger"
+gem "rails", "~> 3.1.0"
+gem "combustion", "~> 0.3.1"
+
+gemspec :path=>"../"

data/gemfiles/rails3_2.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "stringex"
+gem "pry", :require=>false
+gem "fuubar", "~> 1.1", :require=>false
+gem "timecop", :require=>false
+gem "generator_spec", :require=>false
+gem "debugger"
+gem "rails", "~> 3.2.0"
+gem "combustion", "~> 0.3.1"
+
+gemspec :path=>"../"

data/lib/faqmarkdown/config.rb

@@ -0,0 +1,24 @@
+module Faqmarkdown
+  module Config
+    extend self
+
+    @options = {}
+    attr_accessor :options
+  end
+end
+
+Faqmarkdown::Config.options[:feed_title] = nil
+
+Faqmarkdown::Config.options[:permalink_format] = :day
+
+Faqmarkdown::Config.options[:faqs_per_page] = 5
+
+Faqmarkdown::Config.options[:layout] = 'application'
+
+Faqmarkdown::Config.options[:permalink_regex] = {}
+Faqmarkdown::Config.options[:permalink_regex][:day]   = %r[\d{4}/\d{2}/\d{2}/[^/]+]
+Faqmarkdown::Config.options[:permalink_regex][:month] = %r[\d{4}/\d{2}/[^/]+]
+Faqmarkdown::Config.options[:permalink_regex][:year]  = %r[\d{4}/[^/]+]
+Faqmarkdown::Config.options[:permalink_regex][:slug]  = %r[[^/]+]
+
+Faqmarkdown::Config.options[:markdown_file_extensions] = %w(md mkd mdown markdown)

data/lib/faqmarkdown/engine.rb

@@ -0,0 +1,12 @@
+module Faqmarkdown
+  require 'faqmarkdown'
+  require 'rails'
+  require 'gravtastic'
+  require 'rdiscount'
+  require 'nokogiri'
+  require 'haml'
+  require 'kaminari'
+
+  class Engine < Rails::Engine
+  end
+end

data/lib/faqmarkdown/railtie.rb

@@ -0,0 +1,20 @@
+module Faqmarkdown
+  class Railtie < Rails::Railtie
+    initializer :before_initialize do
+      unless Rails.application.config.respond_to?(:assets) && Rails.application.config.assets.enabled
+        require 'rack'
+        Rails.configuration.middleware.insert_before('Rack::Sendfile', 'Rack::Static',
+          :urls => ['/stylesheets/faqmarkdown'],
+          :root => "#{faqmarkdown_root}/vendor/assets"
+        )
+      end
+      ActionController::Base.append_view_path("#{faqmarkdown_root}/app/views")
+    end
+
+    private
+
+    def faqmarkdown_root
+      File.expand_path(File.dirname(__FILE__) + '/../..')
+    end
+  end
+end

data/lib/faqmarkdown/routes.rb

@@ -0,0 +1,30 @@
+class ActionDispatch::Routing::Mapper
+  require 'faqmarkdown/util'
+
+  def faqmarkdown(options = {})
+    options.reverse_merge!({ :as => :faqs, :permalink_format => :day })
+
+    get "/#{options[:as]}(/:year(/:month(/:day)))" => 'faqs#index', as: :faqs, :constraints => { :year => /\d{4}/, :month => /\d{2}/, :day => /\d{2}/}
+    get "/#{options[:as]}/feed" => 'faqs#feed', as: :faqs_feed, :format => :xml
+    get "/#{options[:as]}/*id" => 'faqs#show', as: :faq, :constraints => { :id => faqmarkdown_permalink_regex(options) }
+    get "/#{options[:as]}/categoria/:category" => 'faqs#faq_per_category', as: :faqs_category
+
+    faqmarkdown_feed_title(options[:as])
+  end
+
+  private
+
+  def faqmarkdown_permalink_regex(options)
+    Faqmarkdown::Config.options[:permalink_format] = options[:permalink_format]
+    Faqmarkdown::Config.options[:permalink_regex].try(:[], options[:permalink_format]) or raise_faqmarkdown_permalink_error
+  end
+
+  def faqmarkdown_feed_title(path)
+    Faqmarkdown::Config.options[:feed_title] ||= "#{Faqmarkdown::Util.app_name} #{path.to_s.tr('/', '_').humanize.titleize}"
+  end
+
+  def raise_faqmarkdown_permalink_error
+    possible_options = Faqmarkdown::Config.options[:permalink_regex].map { |k,v| k.inspect }.join(', ')
+    raise "Faqmarkdown Routing Error: Invalid :permalink_format option #{Faqmarkdown::Config.options[:permalink_format].inspect} - must be one of the following: #{possible_options}"
+  end
+end

data/lib/faqmarkdown/util.rb

@@ -0,0 +1,12 @@
+module Faqmarkdown
+  module Util
+    def self.app_name
+      Rails.application.class.name.split('::')[0..-2].join.titleize
+    end
+
+    def self.git_config(name)
+      value = `git config --get #{name}`.chomp
+      value if $?.success?
+    end
+  end
+end

data/lib/faqmarkdown/version.rb

@@ -0,0 +1,3 @@
+module Faqmarkdown
+  VERSION = '0.0.1'
+end

data/lib/faqmarkdown.rb

@@ -0,0 +1,5 @@
+require 'faqmarkdown/engine'
+require 'faqmarkdown/config'
+require 'faqmarkdown/routes'
+require 'faqmarkdown/railtie'
+require 'faqmarkdown/util'

data/lib/generators/faqmarkdown/faq_generator.rb

@@ -0,0 +1,42 @@
+module Faqmarkdown
+  class FaqGenerator < Rails::Generators::Base
+    desc File.read(File.expand_path('../usage/faq.txt', __FILE__)).gsub('{{CURRENT_DATE}}', Time.zone.now.strftime('%Y-%m-%d'))
+    source_root File.expand_path('../templates', __FILE__)
+    argument :slug, :type => :string, :required => true
+    class_option :date, :type => :string, :group => :runtime, :desc => 'Publish date for the faq'
+
+    def check_slug
+      unless slug =~ /^#{Faq::SLUG_FORMAT}$/
+        puts 'Invalid slug - valid characters include letters, digits and dashes.'
+        exit
+      end
+    end
+
+    def check_date
+      if options.date && options.date !~ /^#{Faq::DATE_FORMAT}$/
+        puts 'Invalid date - please use the following format: YYYY-MM-DD, eg. 2011-01-01.'
+        exit
+      end
+    end
+
+    def generate_faq
+      template 'example-faq.markdown', "app/faqs/#{publish_date}-#{slug.downcase}.markdown"
+    end
+
+    private
+
+    def publish_date
+      format = '%Y-%m-%d-%H%M%S'
+
+      if options.date.present?
+        date_string = options.date
+        date_string += '-000000' unless options.date.match(/(#{Faq::TIME_FORMAT}$)/)
+        date = Time.strptime(date_string, format)
+      else
+        date = Time.zone.now
+      end
+
+      date.strftime(format)
+    end
+  end
+end