middleman-org 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2cda372c2e2651915077bfb548761d0ec832213
+  data.tar.gz: b25e56515d08b6a858414f159225c9c066601182
+SHA512:
+  metadata.gz: cb94d0dc36a263675e6f65a718523fed6ff48e5db5fbb2473ad295393d164671993fb8eb13d7855bb57bac78a441087d05eb16b60d7e30850bd17ea216d3edc8
+  data.tar.gz: e8cbe2ddae85763996df5eca673dafc8bf8cbb29acb110c0d1a58613ef2c51f298d9cc2eff9c058c34331149b086045639b706f79ea94e968f521515e50c809b

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,20 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-org.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+  gem 'pry'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'fivemat'
+  gem 'aruba'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,58 @@
+# middleman-org
+
+
+## What and Why
+
+`middleman-org` is an extention for [middleman](https://middlemanapp.com) to generate static pages from [org file](http://orgmode.org).
+It is highly inspired by the offical blog extention [middleman-blog](https://github.com/middleman/middleman-blog), but it is not another blogging extention.
+
+## Advantages of using `middleman-org`
+
+### Linking
+
+Org mode is powerful as a whole system. You expect connections between files. Or being able to reference some kind of resource files (e.g. input data, image etc.) within org. `middleman-org` preserve the complete structure of your system, so that you will have the whole set exported with no breaking links.
+
+### No more `front mater`
+
+Is it just me or... I found the `yaml front mater` is just annoying in such scenario. You don't want to pollute your org files with it, do you? `middleman-org` uses native org-mode in buffer settings as metadata of your article.
+So instead of
+
+```yaml
+---
+title: my polluted article
+date: 2015-04-09
+tags: polluted, lame
+---
+```
+
+You can use
+
+```org
+#+TITLE: my awesome article
+#+DATE: <2015-04-09 Thu>
+#+KEYWORDS: awesome nice
+```
+
+### Selective Publish
+
+This is implemented by [org-ruby](https://github.com/bdewey/org-ruby), the rendering engine we use in `middleman-org`. Just simply apply [export settings](http://orgmode.org/manual/Export-settings.html) natively in your org file, sections with exclusion tags will not be published.
+
+## Installation
+
+Add `middleman-org` to your `Gemfile` and run `bundle install`.
+## Configuration
+
+And activate it in `config.rb`.
+
+```ruby
+activate :org
+```
+
+With default settings, create a folder `org` inside your `source` folder and dump all your org files into it.
+If you use git to manage your org files, it is highly recommaned to add your org repository as a submodule.
+
+option | default | meaning
+---|---|---
+`layout` | 'layout' | article specific layout
+`root` | 'org' | root folder for org files (relative to `source` folder)
+`prefix` | nil | prefix on root and destination path

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-org')

data/lib/middleman-org/extension.rb

@@ -0,0 +1,52 @@
+require 'middleman-org/org_data'
+require 'middleman-org/org_article'
+require 'middleman-org/helpers'
+
+module Middleman
+  class OrgExtension < ::Middleman::Extension
+    option :layout, 'layout', 'article specific layout'
+    option :root, 'org', 'source folder for org files'
+    option :prefix, nil, 'prefix on destination and root path'
+    # option :resources, 'resources', 'folder name for resources'
+
+    attr_reader :data
+
+    self.defined_helpers = [Middleman::Org::Helpers]
+    def initialize(app, options_hash = {}, &block)
+      # Call super to build options from the options_hash
+      super
+
+      # Require libraries only when activated
+      require 'org-ruby'
+      require 'middleman-org/org_data'
+
+      options.root = File.join(options.prefix, options.root) if options.prefix
+
+      app.after_configuration do
+        template_extensions org: :html
+      end
+
+      # set up your extension
+      # puts options.my_option
+    end
+
+    def after_configuration
+      ::Middleman::Org.controller = self
+
+      # Make sure ActiveSupport's TimeZone stuff has something to work with,
+      # allowing people to set their desired time zone via Time.zone or
+      # set :time_zone
+      Time.zone = app.config[:time_zone] if app.config[:time_zone]
+      time_zone = Time.zone || 'UTC'
+      zone_default = Time.find_zone!(time_zone)
+      unless zone_default
+        raise 'Value assigned to time_zone not recognized.'
+      end
+      Time.zone_default = zone_default
+
+      @data = Org::OrgData.new(@app, self, options)
+      @app.sitemap.register_resource_list_manipulator(:"org_articles", @data, false)
+    end
+
+  end
+end

data/lib/middleman-org/helpers.rb

@@ -0,0 +1,38 @@
+module Middleman
+  module Org
+
+    def self.controller
+      @controller ||= nil
+    end
+
+    def self.controller=(v)
+      @controller = v
+    end
+
+    module Helpers
+      def self.included(base)
+      end
+
+      def org_controller
+        ::Middleman::Org.controller
+      end
+
+      def org_data
+        org_controller.data
+      end
+
+      def current_article
+        article = current_resource
+        if article && article.is_a?(OrgArticle)
+          article
+        else
+          nil
+        end
+      end
+
+      def articles
+        org_data.articles
+      end
+    end
+  end
+end

data/lib/middleman-org/org_article.rb

@@ -0,0 +1,102 @@
+require 'active_support/time_with_zone'
+require 'active_support/core_ext/time/acts_like'
+require 'active_support/core_ext/time/calculations'
+require 'nokogiri'
+
+module Middleman
+  module Org
+
+    module OrgArticle
+      def self.extended(base)
+        base.class.send(:attr_accessor, :org_controller)
+      end
+
+      def org_data
+        org_controller.data
+      end
+
+      def org_options
+        org_controller.options
+      end
+
+      IN_BUFFER_SETTING_REGEXP = /^#\+(\w+):\s*(.*)$/
+
+      def in_buffer_setting
+        return @_in_buffer_setting if @_in_buffer_setting
+
+        @_in_buffer_setting = {}
+        File.open(source_file, 'r') do |f|
+          f.each_line do |line|
+            if line =~ IN_BUFFER_SETTING_REGEXP
+              @_in_buffer_setting[$1] = $2
+            end
+          end
+        end
+        @_in_buffer_setting
+      end
+
+      def render(opts={}, locs={}, &block)
+        unless opts.has_key?(:layout)
+          opts[:layout] = org_options.layout if opts[:layout].nil?
+          # Convert to a string unless it's a boolean
+          opts[:layout] = opts[:layout].to_s if opts[:layout].is_a? Symbol
+        end
+
+        content = super(opts, locs, &block)
+        fix_links(content)
+      end
+
+      def fix_links(content)
+        html = ::Nokogiri::HTML(content)
+        html.xpath("//@src | //@href | //@poster").each do |attribute|
+          attribute.value = attribute.value.gsub(/^(.+)\.org$/, '\1.html')
+        end
+        html.to_s
+      end
+
+      def title
+        in_buffer_setting['TITLE'] || File.basename(source_file, '.*')
+      end
+
+      def tags
+        article_tags = in_buffer_setting['KEYWORDS']
+        return [] unless article_tags
+
+        if article_tags.is_a? String
+          article_tags.split(' ').map(&:strip)
+        else
+          Array(article_tags).map(&:to_s)
+        end
+      end
+
+      def published?
+        true
+      end
+
+      def body
+        render layout: false
+      end
+
+      def date
+        return @_date if @_date
+
+        @_date = in_buffer_setting['DATE']
+
+        # frontmatter_date = data['date']
+
+        # # First get the date from frontmatter
+        # if frontmatter_date.is_a? Time
+        #   @_date = frontmatter_date.in_time_zone
+        # else
+        #   @_date = Time.zone.parse(frontmatter_date.to_s)
+        # end
+
+        @_date
+      end
+
+      def slug
+      end
+
+    end
+  end
+end

data/lib/middleman-org/org_data.rb

@@ -0,0 +1,56 @@
+require 'middleman-core/util'
+
+module Middleman
+  module Org
+
+    class OrgData
+      attr_reader :options
+      attr_reader :controller
+
+      def initialize(app, controller, options)
+        @app = app
+        @options = options
+        @controller = controller
+
+        @_articles = []
+      end
+
+      def articles
+        @_articles
+      end
+
+      def tags
+        []
+      end
+
+      def manipulate_resource_list(resources)
+        @_posts = []
+        resources.each do |resource|
+          next unless resource.path =~ /^#{options.root}/
+
+          resource.destination_path = resource.path.gsub(/^#{options.root}/,
+                                                         options.prefix)
+          if File.extname(resource.source_file) == '.org'
+            article = convert_to_article resource
+            puts article.source_file
+            next unless publishable?(article)
+            @_articles << article
+          end
+
+        end
+      end
+
+      def publishable?(article)
+        @app.environment == :development || article.published?
+      end
+
+      def convert_to_article(resource)
+        return resource if resource.is_a?(OrgArticle)
+        resource.extend OrgArticle
+        resource.org_controller = controller
+        resource
+      end
+
+    end
+  end
+end

data/lib/middleman-org/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Org
+    VERSION = '0.1.0'
+  end
+end

data/lib/middleman-org.rb

@@ -0,0 +1,7 @@
+require 'middleman-core'
+require 'middleman-org/version'
+
+::Middleman::Extensions.register(:org) do
+  require 'middleman-org/extension'
+  ::Middleman::OrgExtension
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-org'

data/middleman-org.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'middleman-org/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-org'
+  s.version     = Middleman::Org::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Xiaoxing Hu']
+  s.email       = ['dawnstar.hu@gmail.com']
+  s.homepage    = 'http://github.com/xiaoxinghu/middleman-org'
+  s.summary     = %q{org-mode extension for middleman}
+  s.description = %q{Middleman extension for publishing org-mode project}
+  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.license = 'MIT'
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency('middleman-core', ['~> 3.3'])
+
+  # Additional dependencies
+  s.add_runtime_dependency('org-ruby', '~> 0.9.12')
+  s.add_runtime_dependency('addressable', '~> 2.3')
+  s.add_runtime_dependency('nokogiri', '~> 1.6')
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: middleman-org
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Xiaoxing Hu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: org-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Middleman extension for publishing org-mode project
+email:
+- dawnstar.hu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-org.rb
+- lib/middleman-org/extension.rb
+- lib/middleman-org/helpers.rb
+- lib/middleman-org/org_article.rb
+- lib/middleman-org/org_data.rb
+- lib/middleman-org/version.rb
+- lib/middleman_extension.rb
+- middleman-org.gemspec
+homepage: http://github.com/xiaoxinghu/middleman-org
+licenses:
+- MIT
+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.4.6
+signing_key: 
+specification_version: 4
+summary: org-mode extension for middleman
+test_files:
+- features/support/env.rb
+has_rdoc: