jekyll-cargodoc 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41170f909b267c7d9817db99f9d4f92aada714a4
+  data.tar.gz: b0f7a29a8773e788cec21fa9428b76380b00eded
+SHA512:
+  metadata.gz: 7de536593c54bc193f6871cdda7b6c0700e0cc817fb46e3182cab7c0d10f81d531a0c62564f1d2b4e0d71d8ad91e73f68d5a25244d6d27d5ce8d84e4f4025ad8
+  data.tar.gz: d94698eb275cd6363ed1bdc62e765e9b05063680b2634c5d3ab85dd107f16a44bc9d28b40d65f9deebb738fd711905aa4d44935433c7657ac0fa8038bb0b1723

data/lib/jekyll/cargodoc.rb

@@ -0,0 +1,127 @@
+require 'jekyll'
+
+module Jekyll
+  module Cargodoc
+    class Crate
+      attr_reader :name, :destination_root
+
+      def initialize(config)
+        @name = config['crate'] || ''
+        @version = config['version'] || '*'
+        @destination_root = config['destination_root'] || name
+        @git = config['git']
+      end
+
+      def dependency_section
+        section = "\n[dependencies"
+        section << ".#{name}" unless @git.nil?
+        section << "]\n"
+
+        section
+      end
+
+      def dependency_line
+        if !@git.nil?
+          "git = \"#{@git}\""
+        else
+          "#{@name} = \"#{@version}\"\n"
+        end
+      end
+
+      def doc_files_paths(root)
+        Dir.chdir("#{root}/#{name}") do
+          Dir.glob("**/*").reject { |path| Dir.exist?(path) }
+        end
+      end
+    end
+
+    class CargoRunner
+      DIR = '_cargo'
+      DOTFILE = ".jekyll-cargodoc"
+      DOC_TARGET = "#{DIR}/target/doc"
+
+      def initialize(crates)
+        @crates = crates
+      end
+
+      def run
+        abort_if_invalid
+        create_dir
+        add_dependencies
+        build_docs
+      end
+
+      private
+
+      def abort_if_invalid
+        if File.exist?(DIR) && !File.exist?("#{DIR}/#{DOTFILE}")
+          raise "#{DIR} isn't ours, stopping."
+        end
+      end
+
+      def create_dir
+        system("rm -r #{DIR}") if Dir.exist?(DIR)
+        system("cargo new #{DIR}")
+        system("touch #{DIR}/#{DOTFILE}")
+      end
+
+      def add_dependencies
+        File.open("#{DIR}/Cargo.toml", 'a') do |cargo_toml|
+
+          @crates.group_by(&:dependency_section).each do |section, crates|
+            cargo_toml.write(section)
+            crates.each { |crate| cargo_toml.write(crate.dependency_line) }
+          end
+
+        end
+      end
+
+      def build_docs
+        Dir.chdir("./#{DIR}") do |path|
+          @crates.each { |crate| system("cargo doc -p #{crate.name}") }
+        end
+      end
+    end
+
+    class RustDocFile < Jekyll::StaticFile
+      def initialize(site, base, dir, name, destination_root)
+        @destination_root = destination_root
+        super(site, base, dir, name)
+      end
+
+      def destination(dest)
+        [dest, @destination_root, destination_rel_dir, @name].join('/')
+      end
+    end
+
+    class Generator < Jekyll::Generator
+      def generate(site)
+        # if no crates are specified, there's nothing to do
+        return unless crate_configs = site.config['cargodoc']
+
+        crates = crate_configs.map do |crate_config|
+          Crate.new(crate_config)
+        end
+        CargoRunner.new(crates).run
+
+        files = crates.map { |crate| files_for_crate(site, crate) }.flatten
+        files.each { |page| site.static_files << page }
+      end
+
+      private
+
+      def files_for_crate(site, crate)
+        # paths = crate.doc_files_paths(CargoRunner::DOC_TARGET)
+        paths = Dir.chdir(CargoRunner::DOC_TARGET) do
+          Dir.glob('**/*').reject { |path| Dir.exist?(path) }
+        end
+        files = paths.map do |path|
+          components = path.split('/')
+          path = components.pop
+          dir = components.join('/')
+          RustDocFile.new(site, CargoRunner::DOC_TARGET, dir, path, crate.destination_root)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-cargodoc
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Daniel Light
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-02 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: daniel.sj.light@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll/cargodoc.rb
+homepage: 
+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.5
+signing_key: 
+specification_version: 4
+summary: A plugin to help generate rust docs for a crate into your jekyll site.
+test_files: []