middleman-plaintext 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8b489cb329dbdc6de7f164dbe87a5b1a2ad6116
+  data.tar.gz: 2416e0bedfe5afa5ef7bd4357fb9b2e96ed9c443
+SHA512:
+  metadata.gz: e73f75c621490a830ffef49a08bd65df0ca0d53d807339e5996630bbe1c14b186dce7cffb8008fce1a78d21eabf391df7372e816ffb613ba0a269524883b56cc
+  data.tar.gz: 488663d17561d3376b644f7144b6fdc2fc51c1b0ab1bb748d5aa4fd2745cf1013c25f536fb112feefbaf96e16a1de3cd370520de01cf892e2975c17f16765819

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Caius Durling
+
+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,35 @@
+# middleman-plaintext
+
+Generate plaintext versions of resources. Inspired heavily by John Gruber at [daring fireball][], displaying the raw markdown used to generate a post by appending `.text` to the URL. (eg, <http://daringfireball.net/2010/07/improved_regex_for_matching_urls.text>)
+
+## Usage
+
+Out of the box the extension expects `layout/layout.text.erb` to be the layout for plaintext rendering of resources, and it also will ignore all resources.
+
+You'll want to tell it which resources to generate a plaintext version of using the `handle_file` option, which expects a ruby block.
+
+This basic example, will render all resources with `layout/layout.text.erb`, by putting the following in `config.rb`:
+
+    activate :plaintext do |c|
+      c.handle_file = -> (resource) { true }
+    end
+
+A slightly more real-world example overrides the template name, and only "plaintexts" HTML files in the post/ directory:
+
+    activate :plaintext do |c|
+      c.layout = "blog_post.text"
+      c.handle_file = lambda do |resource|
+        resource.path.start_with?("posts/") && resource.path.end_with?(".html")
+      end
+    end
+
+## Helpful things to know
+
+* Current resource is `current_page` in the layout as usual
+* Link to the current page
+
+        URI.join(app.config.site_url, current_page.path.sub("index.text", ""))
+
+* Render the source file completely raw, without the frontmatter
+
+        Middleman::FileRenderer.new(@app, current_page.file_descriptor[:full_path].to_s).template_data_for_file

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/middleman-plaintext/extension.rb

@@ -0,0 +1,40 @@
+require "middleman-plaintext/version"
+require "middleman-core"
+
+module Middleman
+  class PlaintextExtension < Extension
+
+    option :layout, "layout.text", "Layout to use for text file"
+    option :handle_file, -> (resource) { false }, "block to decide whether to plaintext a resource"
+
+    # This should run after most other sitemap manipulators so that it
+    # gets a chance to modify any new resources that get added.
+    self.resource_list_manipulator_priority = Float::INFINITY
+
+    # A Sitemap Manipulator
+    def manipulate_resource_list(resources)
+      resources | resources.select(&method(:handled_by_us?)).map(&method(:textify))
+    end
+
+    private
+
+    def handled_by_us?(resource)
+      options[:handle_file].call(resource)
+    end
+
+    def textify(resource)
+      to = resource.destination_path.sub("/index.html", "/index.text")
+      source = resource.file_descriptor[:full_path].to_s
+
+      ::Middleman::Sitemap::Resource.new(app.sitemap, to, source).tap do |r|
+        r.options.merge!(resource.options.merge(
+          :directory_index => false,
+          :layout => options[:layout]
+        ))
+        r.add_metadata resource.metadata
+        r.extend Middleman::Blog::BlogArticle
+        r.blog_controller = app.extensions[:blog]["instance_0"]
+      end
+    end
+  end
+end

data/lib/middleman-plaintext/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Plaintext
+    VERSION = "0.8.0"
+  end
+end

data/lib/middleman-plaintext.rb

@@ -0,0 +1,4 @@
+require "middleman-core"
+require "middleman-plaintext/extension"
+
+Middleman::Extensions.register(:plaintext) { Middleman::PlaintextExtension }

data/middleman-plaintext.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "middleman-plaintext/version"
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-plaintext"
+  s.version     = Middleman::Plaintext::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Caius Durling"]
+  s.email       = %w(dev@caius.name)
+  s.summary     = %{Generate plaintext versions of resources}
+  s.description = %{Generate raw un-rendered versions of selected resources. Shout out to John Gruber for the original idea - eg: http://daringfireball.net/2010/07/improved_regex_for_matching_urls.text}
+
+  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_runtime_dependency "middleman-core", "~> 4.1"
+
+  s.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: middleman-plaintext
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Caius Durling
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Generate raw un-rendered versions of selected resources. Shout out to
+  John Gruber for the original idea - eg: http://daringfireball.net/2010/07/improved_regex_for_matching_urls.text'
+email:
+- dev@caius.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/middleman-plaintext.rb
+- lib/middleman-plaintext/extension.rb
+- lib/middleman-plaintext/version.rb
+- middleman-plaintext.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Generate plaintext versions of resources
+test_files: []