blogue 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a505062d8b893b86710be42e7cb204f57ba97875
+  data.tar.gz: 56d0545a6467270da541208b03b045e39b78ec7b
+SHA512:
+  metadata.gz: 53fd19e403ba6c0cbe77b4c02fc801e8a86e1db055486781277945f302dccaf419f1c93b99524f909a1d06e06763f681d9816f059d50648e6e3fd2d995f5a699
+  data.tar.gz: 27d788f14d0c01486e2488f9fe9bd850d17da1509896f38fd3681aee89df905e3f5f2cc4e60dabc120ce48b35a1c1a392bbeb131cbf07056f7c610a3580c4fd4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Maxim Chernyak
+
+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,99 @@
+# Blogue
+
+Blogue is the static page blog that is also a rails engine. It means that you get all of rails, yet your blog is static. Best of both worlds.
+
+## What you get
+
+* A `Blogue::Post` model
+* Handler for ".md" views ([kramdown](https://github.com/gettalong/kramdown/) by default)
+* Syntax highlighting for code blocks ([rouge](https://github.com/jayferd/rouge) by default)
+
+## What you don't get
+
+* Mountable endpoint
+* Default controllers
+* Default views
+* Generators
+
+You just hook it up by hand any way you want.
+
+## Usage
+
+1. Generate a rails app (or use existing)
+2. Add `gem 'blogue'` to Gemfile and bundle
+3. Create a model `app/models/post.rb` (the name 'Post' is chosen at random)
+  ~~~ruby
+  class Post < Blogue::Post
+    # Here you can override inherited methods any way you like.
+    # See app/models/blogue/post.rb to see what you have
+  end
+  ~~~
+
+4. Create a controller `app/controllers/posts_controller.rb`
+  ~~~ruby
+  class PostsController < ApplicationController
+    def index
+      @posts = Post.all
+    end
+
+    def show
+      @post = Post.find(id)
+    end
+  end
+  ~~~
+
+5. Add a route to your `config/routes.rb` like this
+  ~~~ruby
+  # If you want an index page
+  root to: 'posts#index'
+
+  # Whitelist of your posts
+  Post.all.each { |post| get "/#{post.id}", to: 'posts#show', id: post.id }
+  ~~~
+
+6. Add `app/views/posts/index.html.erb` for your index page
+  ~~~erb
+    <% @posts.each do |post| %>
+    <p>
+      <%= link_to post.title, post.id %>
+
+      <% if post.tldr %>
+      <blockquote>
+        <%= post.tldr %>
+      </blockquote>
+      <% end %>
+    </p>
+    <% end %>
+  ~~~
+
+7. Add `app/views/posts/show.html.erb` for your post page
+  ~~~erb
+  <%= link_to 'index', root_path %>
+
+  <%=raw render file: @post.path %>
+
+  <% if @post.date %>
+  <p>Published on <%= @post.date.to_s(:long) %></p>
+  <% end %>
+  ~~~
+
+8. Create a directory `app/posts` (that's default location of posts)
+9. Create a directory `app/posts/assets` (it's added to assets paths by default)
+10. Add a post like `app/posts/my-first-post.md`
+  ~~~markdown
+  # Yay my first post
+
+  This is some text.
+
+  ![picture](/assets/picture.jpg)
+
+  ~~~ruby
+  foo = 'foo' # a codeblock
+  ~~~
+
+  <!--meta
+    date: 2013-10-21
+    tldr: Awesome
+  -->
+  ~~~
+11. Start server and go to http://localhost:3000/my-first-post

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Blogue'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/models/blogue/post.rb

@@ -0,0 +1,105 @@
+module Blogue
+  class Post
+    class << self
+      def find(id)
+        all.find{ |p| p.id == id }
+      end
+
+      def all
+        all_post_paths.map(&method(:new)).sort(&method(:sort_posts))
+      end
+
+      def all_post_paths
+        all_paths_in_posts_dir.select(&method(:post_file?))
+      end
+
+      def all_paths_in_posts_dir
+        Dir["#{Blogue.posts_path}/*"]
+      end
+
+      def post_file?(path)
+        File.file?(path) && !File.basename(path).starts_with?('.')
+      end
+
+      def extract_post_id(path)
+        File.basename(path)[/[^\.]+/]
+      end
+
+      def sort_posts(post_a, post_b)
+        post_b.time <=> post_a.time
+      end
+    end
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def id
+      self.class.extract_post_id(path)
+    end
+
+    def date
+      time.try(:to_date)
+    end
+
+    def time
+      meta_time || file_ctime
+    end
+
+    def title
+      meta_title || parsed_title || filename_title
+    end
+
+    def body
+      File.read(path)
+    end
+
+    def tldr
+      meta['tldr']
+    end
+
+    def meta
+      YAML.load(
+        body.lines.select do |line|
+          !!(line[/^<!--\s*meta/]..line[/--!>$/])
+        end[1..-2].try(:join, "\n") || ''
+      ) || {}
+    end
+
+    def to_partial_path
+      'posts/post'
+    end
+
+    def to_helper_name
+      id.underscore
+    end
+
+    private
+
+    def meta_time
+      Time.parse(meta['date'])
+    rescue TypeError
+      nil
+    end
+
+    def file_ctime
+      File.ctime(path)
+    end
+
+    def meta_title
+      meta['title']
+    end
+
+    def parsed_title
+      if body.lines.first =~ /^\s*#\s+(.+)$/
+        $1
+      end
+    end
+
+    def filename_title
+      id.split(/[-_]/).join(' ').capitalize
+    end
+  end
+end

data/lib/blogue/engine.rb

@@ -0,0 +1,18 @@
+module Blogue
+  class Engine < ::Rails::Engine
+    isolate_namespace Blogue
+
+    initializer 'blogue.append_asset_path' do |app|
+      app.config.assets.paths << (
+        Blogue.assets_path || "#{Blogue.posts_path}/assets"
+      )
+    end
+
+    config.after_initialize do
+      if defined?(Kramdown)
+        Blogue.setup_kramdown_for_handling_md_files
+        Blogue.use_rouge_codeblock_handler if defined?(Rouge)
+      end
+    end
+  end
+end

data/lib/blogue/version.rb

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

data/lib/blogue.rb

@@ -0,0 +1,34 @@
+require "blogue/engine"
+
+module Blogue
+  mattr_accessor :posts_path
+  mattr_accessor :assets_path
+  mattr_accessor :markdown_format_handler
+  mattr_accessor :kramdown_codeblock_handler
+
+  self.posts_path = 'app/posts'
+
+  def self.setup_kramdown_for_handling_md_files
+    require 'kramdown/converter/blogue'
+
+    self.markdown_format_handler ||= -> template {
+      mdown = ActionView::Template.registered_template_handler(:erb).(template)
+      "Kramdown::Document.new(begin;#{mdown};end).to_blogue"
+    }
+
+    ActionView::Template.register_template_handler :md, markdown_format_handler
+  end
+
+  def self.use_rouge_codeblock_handler
+    self.kramdown_codeblock_handler ||= -> el, indent {
+      attr = el.attr.dup
+      lang = extract_code_language!(attr)
+
+      begin
+        Rouge.highlight(el.value, lang || 'text', 'html')
+      rescue RuntimeError
+        Rouge.highlight(el.value, 'text', 'html')
+      end
+    }
+  end
+end

data/lib/kramdown/converter/blogue.rb

@@ -0,0 +1,13 @@
+module Kramdown
+  module Converter
+    class Blogue < Html
+      def convert_codeblock(*args, &blk)
+        if ::Blogue.kramdown_codeblock_handler
+          instance_exec(*args, &::Blogue.kramdown_codeblock_handler)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/tasks/blogue_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :blogue do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,9 @@
+class PostsController < ApplicationController
+  def index
+    @posts = Post.all
+  end
+
+  def show
+    @post = Post.find(params[:id])
+  end
+end

data/test/dummy/app/models/post.rb

@@ -0,0 +1,2 @@
+class Post < Blogue::Post
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/posts/show.html.erb

@@ -0,0 +1,9 @@
+<%= link_to 'index', root_path %>
+
+<%=raw render file: @post.path %>
+
+<% if @post.date %>
+<p>
+Published on <%= @post.date.to_s(:long) %>
+</p>
+<% end %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+
+require "kramdown"
+require "rouge"
+require "blogue"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,27 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/blogue.rb

@@ -0,0 +1 @@
+Blogue.posts_path = File.expand_path('../../../../fixtures/posts', __FILE__)

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end