active_copy 1.0.0.pre

data/lib/active_copy/markdown.rb

@@ -0,0 +1,34 @@
+require 'redcarpet'
+require 'active_copy/renderer'
+
+# Compiles a Markdown file using the +Redcarpet+ template engine. Used
+# by +ActionView+ in +config/initializers/markdown.rb+ to initiate
+# Markdown template compilation for files that are not already
+# precompiled.
+module ActiveCopy
+  class Markdown
+    # Create a new session with the compiler.
+    def initialize
+      @renderer = ActiveCopy::Renderer.new
+      @options = {
+        autolink: true,
+        no_intra_emphasis: true,
+        fenced_code_blocks: true,
+        lax_html_blocks: true,
+        strikethrough: true,
+        superscript: true
+      }
+    end
+
+    # Return an HTML String containing the rendered output of the Markdown
+    # source.
+    def render markdown_source
+      markdown.render "#{markdown_source}"
+    end
+
+  private
+    def markdown
+      @client ||= Redcarpet::Markdown.new @renderer, @options
+    end
+  end
+end

data/lib/active_copy/paths.rb

@@ -0,0 +1,54 @@
+module ActiveCopy
+  module Paths
+    # Return absolute path to public HTML file.
+    def index_path
+      "#{path}/index.html"
+    end
+
+    # Return absolute path to public cached copy.
+    def path
+      @public_path ||= if Rails.env.test?
+                         "#{Rails.root}/tmp/site/#{relative_path}"
+                       else
+                         "#{Rails.root}/public/#{relative_path}"
+                       end
+    end
+
+    # Return the collection_path in the instance.
+    def collection_path
+      self.class.collection_path
+    end
+
+    # Return relative path with the Rails.root/public part out.
+    def relative_path
+      @rel_path ||= begin 
+        date_array = id.split("-")[0..2]
+        date_path = date_array.join("/")
+        article_id = begin
+          str = id.gsub date_array.join("-"), ''
+          if str[0] == "-"
+            str[1..-1] 
+          else
+            str
+          end
+        end
+        "#{category}/#{date_path}/#{article_id}"
+      end
+    end
+
+    # Return absolute path to Markdown file on this machine.
+    def source_path options={}
+      @source_path ||= if options[:relative]
+        File.join collection_path, "#{self.id}.md"
+      else
+        File.join root_path, collection_path, "#{self.id}.md"
+      end
+    end
+
+    private
+    def root_path
+      return Rails.root if defined? Rails
+      File.expand_path "../../", __FILE__
+    end
+  end
+end

data/lib/active_copy/renderer.rb

@@ -0,0 +1,13 @@
+require 'pygments'
+require 'redcarpet'
+
+module ActiveCopy
+  class Renderer < Redcarpet::Render::HTML
+    def block_code(raw_code, language)
+      code = "\n#{raw_code.strip}"
+      #Rails.logger.info "Rendered highlighted #{language} code block"
+      #Pygments.highlight code, lexer: language
+      "<pre>#{code}\n</pre>"
+    end
+  end
+end

data/lib/active_copy/source.rb

@@ -0,0 +1,24 @@
+
+# Methods for extracting the source of the Markdown document.
+
+module ActiveCopy
+  module Source
+    # Test if the source file is present on this machine.
+    def present?
+      File.exists? source_path
+    end
+
+    # Return the raw String source of the Markdown document, including
+    # the YAML front matter.
+    def raw_source
+      @raw ||= File.read source_path
+    end
+
+    # Return the String source of the Markdown document without the YAML
+    # front matter. This is what is passed into ActionView to render the
+    # Markdown from this file.
+    def source
+      @source ||= raw_source.split("---\n")[2]
+    end
+  end
+end

data/lib/active_copy/template.rb

@@ -0,0 +1,20 @@
+# The ActionView template handler that parses Markdown files into HTML
+# using our custom Markdown handler. Also checks for YAML front matter
+# and parses it out before rendering the Markdown source into HTML.
+module ActiveCopy
+  module Template
+    def self.call template
+      source = if template.respond_to? :split
+        template.split("---\n")[2]
+      else
+        template.source.split("---\n")[2]
+      end
+
+      <<-RUBY
+        markdown = ActiveCopy::Markdown.new
+        markdown.render %(#{source})
+      RUBY
+    end
+  end
+end
+

data/lib/active_copy/version.rb

@@ -0,0 +1,3 @@
+module ActiveCopy
+  VERSION = "1.0.0.pre"
+end

data/lib/active_copy/view_helper.rb

@@ -0,0 +1,17 @@
+module ActiveCopy
+  module ViewHelper
+    # Render a given relative content path to Markdown.
+    def render_copy from_source_path
+      source_path = "#{ActiveCopy.content_path}/#{from_source_path}.md"
+
+      if File.exists? source_path
+        raw_source = IO.read source_path
+        source = raw_source.split("---\n")[2]
+        template = ActiveCopy::Markdown.new
+        template.render(source).html_safe
+      else
+        raise ArgumentError.new "#{source_path} does not exist."
+      end
+    end
+  end
+end

data/lib/generators/copy/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Generates a new ActiveCopy model for use in this project. Specify
+    attributes that the model will use in the arguments following the
+    first.
+
+Example:
+    rails generate copy article name title tags category date
+
+    This will create:
+        app/models/article.rb
+        spec/models/article_spec.rb
+        lib/generators/article/article_generator.rb
+        lib/generators/article/templates/view.md.erb
+        lib/generators/article/USAGE

data/lib/generators/copy/copy_generator.rb

@@ -0,0 +1,34 @@
+class CopyGenerator < ::Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+  desc "Creates a new ActiveCopy model"
+  class_option :datestamp, \
+    desc: "Add a date stamp to the beginnings of file names.",
+    default: false
+
+  def model_class
+    template "app/models/#{file_name}.rb", 'model.rb.erb'
+  end
+
+  def test_file
+    template "spec/models/#{file_name}_spec.rb", 'test.rb.erb'
+  end
+
+  def model_generator
+    template "#{generator_dir}/#{file_name}_generator.rb", 'generator.rb.erb'
+    template "#{generator_dir}/templates/view.md.erb", 'view.md.erb'
+    template "#{generator_dir}/USAGE", "USAGE.erb"
+  end
+
+  private
+  def file_name
+    human_name.parameterize
+  end
+
+  def table_name
+    human_name.tableize
+  end
+
+  def generator_dir
+    "lib/generators/#{file_name}"
+  end
+end

data/lib/generators/copy/templates/USAGE.erb

@@ -0,0 +1,13 @@
+Description:
+    Add a description for your ActiveCopy model generator here.
+
+Example:
+    rails generate copy <%= file_name %>
+
+<% if datestamped? %>
+    This will create:
+        app/views/<%= table_name %>/content/2000-01-01-name.md
+<% else %>
+    This will create:
+        app/views/<%= table_name %>/content/name.md
+<% end %>

data/lib/generators/copy/templates/generator.rb.erb

@@ -0,0 +1,39 @@
+class <%= model_name %>Generator < ::Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+  desc "Creates a new <%= model_name %>"
+
+  def generate_view
+    template "app/views/#{directory}/content/#{file_name}.md", 'view.md.erb'
+  end
+
+  private
+  def date
+    @date_string ||= Time.now.strftime '%Y-%m-%d'
+  end
+
+  def title
+    @title ||= param_name.titleize.downcase
+  end
+
+  def table_name
+    human_name.tableize
+  end
+
+  def param_name
+    human_name.parameterize
+  end
+
+  def file_name
+  <% if datestamped? %>
+    "#{date}-#{param_name}"
+  <% else %>
+    param_name
+  <% end %>
+  end
+
+  def attributes_yaml
+    attributes.reduce "" do |yaml, key|
+      yaml << "#{key}: \n"
+    end
+  end
+nd

data/lib/generators/copy/templates/model.rb.erb

@@ -0,0 +1,3 @@
+class <%= human_name %> < ActiveCopy::Base
+  attr_accessible <%= attributes %>
+end

data/lib/generators/copy/templates/test.rb.erb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe <%= model_name %> do
+  pending "add more tests or remove this file"
+end

data/lib/generators/copy/templates/view.md.erb

@@ -0,0 +1,8 @@
+---
+layout: <%= layout %>
+title: <%= title %>
+<%= attributes_yaml %>
+<%= "date: #{date}" if datestamp? %>
+---
+
+Write the article here.

data/lib/tasks/active_copy_tasks.rake

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

data/spec/active_copy/base_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module ActiveCopy
+  describe Base do
+    let(:page) { BasicPage.new id: "about" }
+
+    it "finds the page by its id" do
+      expect(page).to be_present, "Page was not found"
+    end
+
+    it "finds the right folder to read source files from" do
+      expect(page.collection_path).to eq("spec/fixtures/basic_pages/content")
+    end
+
+    it "reads the yaml front matter as a hash" do
+      expect(page.title).to eq('About Us')
+    end
+
+    it "reads the article body" do
+      expect(page.source).to match(/We are a very serious company/)
+    end
+
+    it "returns the correct partial path" do
+      expect(page.to_partial_path).to eq("basic_pages/basic_page")
+    end
+
+    it "finds the basic_page that we just made" do
+      expect(BasicPage.all.map(&:id)).to include(page.id)
+    end
+  end
+end

data/spec/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/spec/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/spec/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/spec/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 .
+ */

data/spec/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/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/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>