yard-sitemap 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b92af64ab9f128f2f75abd2bf85e9a763b4f0fed
+  data.tar.gz: 294ce6af6423e0cfc84347602398e39711209df5
+SHA512:
+  metadata.gz: 9747c64f8ae5d7f93061313e02579115a64184024ac0d72325204029edfad3e50fdce43cd11aba68ca32494a408a90e95055a6a62aa5c4d6eb1152e5c42b3f02
+  data.tar.gz: 79d9725c4bacf9a3db6ae5aa7161fd2d936995d4f5937b054a998d94dc231eb194c13fa021a2bbe1bf5145ddd0f2edeb7a7d5b45efedca8a3f7f27461fe28b99

data/.gitignore

@@ -0,0 +1,3 @@
+.yardoc
+doc
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Loren Segal
+
+MIT License
+
+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,25 @@
+# YARD Sitemap
+
+A [YARD][1] plugin to build a sitemap.xml for generated HTML documentation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yard-sitemap'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install yard-sitemap
+
+## Usage
+
+Simply activate the plugin when running YARD:
+
+    yard doc --plugin sitemap
+
+[1]: http://yardoc.org

data/lib/yard-sitemap.rb

@@ -0,0 +1,51 @@
+require 'time'
+
+module YARD
+  module SitemapGenerator
+    module_function
+
+    # Generates a sitemap at +basedir+
+    # @param basedir [String] the location where the sitemap should be generated
+    def generate_sitemap(basedir)
+      sitemap_file = File.join(basedir, 'sitemap.xml')
+      File.open(sitemap_file, 'w') do |file|
+        file.write(sitemap_contents(basedir))
+      end
+    end
+
+    # @param basedir [String] the location where the sitemap should be generated
+    # @return [String] the sitemap.xml contents
+    def sitemap_contents(basedir)
+      data = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
+      data << "<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\"\n"
+      data << "    xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n"
+
+      Dir.glob(basedir + '/**/*.html').each do |file|
+        next unless File.file?(file)
+        mtime = File.mtime(file)
+        fname = file.sub(/^#{Regexp.quote basedir}\//, '')
+        data << "  <url>\n"
+        data << "    <loc>#{fname}</loc>\n"
+        data << "    <lastmod>#{mtime.iso8601}</lastmod>\n"
+        data << "  </url>\n"
+      end
+
+      data << "</urlset>\n"
+      data
+    end
+  end
+
+  module CLI
+    class Yardoc
+      include SitemapGenerator
+
+      def run_generate_with_sitemap(*args)
+        run_generate_without_sitemap(*args)
+        generate_sitemap(options.serializer.basepath)
+      end
+
+      alias run_generate_without_sitemap run_generate
+      alias run_generate run_generate_with_sitemap
+    end
+  end
+end

data/yard-sitemap.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |spec|
+  spec.name          = "yard-sitemap"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Loren Segal"]
+  spec.email         = ["lsegal@soen.ca"]
+  spec.summary       = "YARD plugin to build a sitemap.xml for generated HTML documentation."
+  spec.homepage      = "http://github.com/lsegal/yard-sitemap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: yard-sitemap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Loren Segal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-14 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- lsegal@soen.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/yard-sitemap.rb
+- yard-sitemap.gemspec
+homepage: http://github.com/lsegal/yard-sitemap
+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.0.3
+signing_key: 
+specification_version: 4
+summary: YARD plugin to build a sitemap.xml for generated HTML documentation.
+test_files: []
+has_rdoc: