marti 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78eed6fa6687cbddb1dd7aaceaad5be78431c381
+  data.tar.gz: c468141578ab9710f6146e59cdc220738d69cfc8
+SHA512:
+  metadata.gz: e9d9116d0912053d362e796ca82f095e570091354499a08ef4faa32aa401a46abc32c6572791a4cb5a62662ee732410d5837ecfb70835a8626c37e5e56f06151
+  data.tar.gz: aca1636ade52ffb96c711bfeb8a24a306cb0f0545e63e9766e05f36530f4141799394ad791d1e5935c187659aa7b2928174859f4048cd2c118424b5671166df1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,34 @@
+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    = 'Marti'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+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/assets/stylesheets/markdown_articles/markdown_articles.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/marti/application_controller.rb

@@ -0,0 +1,4 @@
+module Marti
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/marti/marticles_controller.rb

@@ -0,0 +1,27 @@
+module Marti
+  class MarticlesController < ApplicationController
+    rescue_from Marti::Errors::ArticleNotFoundError, &Marti.article_not_found_proc
+    layout Marti.layout
+    def index
+      render :index, locals: { marticles: marticles }
+    end
+
+    def show
+      render :show, locals: { marticle: marticle, marticles: marticles }
+    end
+
+    private
+
+    def marticle
+      @martcile ||= builder.build
+    end
+
+    def builder
+      @builder ||= Marti::MarticleBuilder.new(params[:path])
+    end
+
+    def marticles
+      @marticles ||= Marticle.articles
+    end
+  end
+end

data/app/helpers/marti/application_helper.rb

@@ -0,0 +1,4 @@
+module Marti
+  module ApplicationHelper
+  end
+end

data/app/helpers/marti/marti_helper.rb

@@ -0,0 +1,4 @@
+module Marti
+  module MartiHelper
+  end
+end

data/app/models/marti/marticle.rb

@@ -0,0 +1,15 @@
+module Marti
+  class Marticle
+    attr_reader :content, :path, :last_updated_at, :extract
+
+    def self.articles
+      articles = []
+      Dir[File.join(Marti.article_directory, "*.md")].each do |file|
+        path = file.gsub(/^.*\//, "").gsub(/\.md/, "")
+        articles << Marti::MarticleBuilder.new(path).build
+      end
+      articles.sort_by(&:last_updated_at)
+      articles
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Marti::Engine.routes.draw do
+  root to: "marticles#index"
+  get '/:path' => "marticles#show", as: :marticle
+end

data/lib/marti.rb

@@ -0,0 +1,51 @@
+require 'redcarpet'
+
+module Marti
+  class << self
+    attr_reader :config
+    Config = Struct.new(:article_directory, :cache_store, 
+                        :expires_in, :layout, :article_not_found_proc)
+    def configure
+      @config ||= Config.new
+      yield(config)
+    end
+
+    def article_directory
+      configured_check!
+      config.article_directory || '.'
+    end
+
+    def article_not_found_proc
+      configured_check!
+      config.article_not_found_proc || proc { raise ActionController::RoutingError.new('Article not found') }
+    end
+
+    def layout
+      configured_check!
+      config.layout || "application"
+    end
+
+    def cache_store
+      configured_check!
+      config.cache_store || ActiveSupport::Cache::NullStore.new
+    end
+
+    def expires_in
+      configured_check!
+      config.expires_in || 1.day
+    end
+
+    private
+
+    def configured_check!
+      return unless config.nil?
+      raise Marti::Errors::NotYetConfiguredError.new("Marti has not yet been configured")
+    end
+
+  end
+end
+require "marti/engine"
+require "marti/services/marticle_builder"
+require "marti/services/marticle_parser"
+require "marti/errors/errors"
+require "marti/renderers/html_with_pygments"

data/lib/marti/engine.rb

@@ -0,0 +1,5 @@
+module Marti
+  class Engine < ::Rails::Engine
+    isolate_namespace Marti
+  end
+end

data/lib/marti/errors/errors.rb

@@ -0,0 +1,7 @@
+module Marti
+  module Errors
+    class MartiError < StandardError; end
+    class ArticleNotFoundError < MartiError; end
+    class NotYetConfiguredError < MartiError; end
+  end
+end

data/lib/marti/renderers/html_with_pygments.rb

@@ -0,0 +1,12 @@
+require 'redcarpet'
+require 'pygments'
+module Marti 
+  module Renderers
+    class HTMLWithPygments < ::Redcarpet::Render::HTML
+      def block_code(code, language)
+        Pygments.highlight(code, 
+                           :lexer => language).gsub(/<pre>/, "<pre>\n")
+      end
+    end
+  end
+end

data/lib/marti/services/marticle_builder.rb

@@ -0,0 +1,28 @@
+module Marti
+  class MarticleBuilder
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def build
+      Marti.cache_store.fetch("marticle/"+path, 
+                                         expires_in: Marti.expires_in) do
+        file = file_location(path)
+        unless File.exists?(file)
+          raise ::Marti::Errors::ArticleNotFoundError.new("#{path} not found") 
+        end
+        article = Marti::MarticleParser.new(file).parse
+        article.send(:instance_variable_set, "@path".to_sym, path)
+        article
+      end
+    end
+
+    private
+
+    def file_location(path)
+      File.join(Marti.article_directory, "#{path}.md")
+    end
+  end
+end

data/lib/marti/services/marticle_parser.rb

@@ -0,0 +1,116 @@
+module Marti
+  class MarticleParser
+    attr_reader :file, :article
+    CUT = "--CUT--"
+    def initialize(file)
+      @file = file
+    end
+
+    def parse
+      # clear article
+      @article = Marticle.new
+      set_article_time_from_file!
+
+      content, extract = retrieve_content
+      content = markdown.render(content.join("\n"))
+      extract = markdown.render(extract.join("\n"))
+
+      set('content', content)
+      # Strip last \n from extract
+      set('extract', extract.strip)
+      article
+    end
+
+    private
+
+    def retrieve_content
+      content = []
+      extract = []
+      each_line do |type|
+        type.meta do |line|
+          parse_meta_line(line)
+        end
+
+        type.content do |line|
+          line = clean_line(line)
+          extract = content.dup and next if line == CUT
+          content << line
+        end
+      end
+
+      extract = content[0..3] if extract.empty?
+      [content, extract]
+    end
+
+    def set(key, value)
+      article.send(:instance_variable_set, "@#{key}", value)
+      article.class.send(:attr_reader, key) unless article.respond_to?(key)
+    end
+
+    def clean_line(line)
+      line.gsub(/[\n\r]/, "")
+    end
+
+    def set_article_time_from_file!
+      set('last_updated_at', File.mtime(file).to_datetime)
+    end
+
+    def parse_meta_line(line)
+      key, *value = line.gsub(/^\$/, "").split(":").map(&:strip)
+      value = value.join(':')
+      value = parse_value(value)
+      # Account for manually setting time
+      value = Time.parse(value) if key == 'last_updated_at'
+      set(key, value)
+    end
+
+    def parse_value(value)
+      case value.strip
+      when /^[0-9]+(\.[0-9]+)?$/
+        value =~ /\./ ? value.to_f : value.to_i
+      when /^(?:t|f|y|n|yes|no|true|false)$/i
+        !!(value =~ /^(?:t|y|yes|true)$/)
+      else
+        value
+      end
+    end
+
+    class LineResponse < Struct.new(:type, :line)
+      [:meta, :content].each do |t|
+        define_method(t) do |&b|
+          return unless type == t
+          b.yield(line)
+        end
+      end
+    end
+
+    def each_line(&block)
+      in_meta = true
+      File.open(file, 'r') do |file|
+        file.each_line do |line|
+          if line =~ /^\$/ && in_meta
+            block.call(LineResponse.new(:meta, line))
+          else
+            in_meta = false
+            block.call(LineResponse.new(:content, line))
+          end
+        end
+      end
+    end
+
+    def markdown
+      @markdown ||= ::Redcarpet::Markdown.new(
+        Marti::Renderers::HTMLWithPygments.new(
+          prettify: true,
+        ), 
+        no_intra_emphasis: true,
+        fenced_code_blocks: true,
+        autolink: true,
+        disable_indented_code_blocks: true,
+        strikethrough: true,
+        footnotes: true,
+        highlight: true,
+      )
+    end
+  end
+end

data/lib/marti/version.rb

@@ -0,0 +1,3 @@
+module Marti
+  VERSION = "0.1.0"
+end

data/lib/tasks/marti_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :marti 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/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */