ghwikitools 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+gems
+html

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Keita Yamaguchi
+
+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,76 @@
+# ghwikitools
+
+ghwikitools is a set of GitHub wiki management tools.
+
+## Functions
+
+- Snippets
+- Internationalization
+
+## Installation
+
+    gem install ghwikitools
+
+## Snippets
+
+Snippets are re-usage texts. For example, there is a page("Test.md") with metadata that is formed as two Markdown comments.
+
+    <!-- >>> Header -->
+    
+    <!-- <<< Header -->
+    
+    This is a page.
+
+This page embeds "Header" snippet. The snippet is written as ERB file at "snippet/Header.md" in the GitHub wiki cloned repository.
+
+    This is a header of [[<%= @page.wikiname %>]].
+
+ghwikitools updates the page as follows:
+
+    <!-- >>> Header -->
+    
+    This is a header of [[Test]].
+    
+    <!-- <<< Header -->
+    
+    This is a page.
+
+There are header and footer snippets as default. You can make snippets as you like.
+
+### Internationalization
+
+GitHub wiki doesn't support internationalization directly, but you can use ghwikitools as internationalization system. This can do with the following convenstion:
+
+- wikiname with language code like "Test.ja" is Japanese version of "Test" page
+- make Header snippet as language links
+- you update wiki pages with ghwikitools when new pages are appended
+
+Header file is written like this:
+
+    Languages: [[English|<%= @page.wikiname %>]] | [[日本語|<%= @page.wikiname(:ja) %>]]
+
+## Usage
+
+### List
+
+   ghwikitools list
+
+This command shows all ghwikitools commands.
+
+### Update
+
+    ghwikitools update
+
+This command inserts header and footer metadata, and updates all snippets.
+
+## Licence
+
+ghwikitools is free software distributed under MIT licence.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+
+desc 'Test specs'
+task 'test' do
+  sh "bundle exec bacon -a -r ghwikitools"
+end
+
+desc 'Generate API document'
+task 'html' do
+  sh "bundle exec yard doc -o html --hide-void-return --no-api"
+end
+
+desc 'Show undocumented function list'
+task 'html:undoc' do
+  sh "bundle exec yard stats --list-undoc --no-api --compact"
+end

data/bin/ghwikitools.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'ghwikitools'
+
+Version = GHWikiTools::VERSION
+GHWikiTools::Command.get(ARGV).run
+

data/ghwikitools.gemspec

@@ -0,0 +1,27 @@
+# -*- ruby -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ghwikitools/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ghwikitools"
+  spec.version       = GHWikiTools::VERSION
+  spec.authors       = ["Keita Yamaguchi"]
+  spec.email         = ["keita.yamaguchi@gmail.com"]
+  spec.description   = "GitHub wiki management tools."
+  spec.summary       = "GitHub wiki management tools."
+  spec.homepage      = "https://github.com/keita/ghwikitools"
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "bacon"
+end

data/lib/ghwikitools.rb

@@ -0,0 +1,42 @@
+require "pathname"
+require "erb"
+require 'optparse'
+
+require "ghwikitools/version"
+require "ghwikitools/page"
+require "ghwikitools/snippet"
+require "ghwikitools/command"
+
+# GHWikiTools is a name space for ghwikitools library.
+module GHWikiTools
+  # available extensions in GitHub wiki
+  EXTENSIONS = [
+    :asciidoc , # ASCIIDoc
+    :creole   , # Creole
+    :md       , # Markdown
+    :org      , # Org Mode
+    :pod      , # Pod
+    :rdoc     , # RDoc
+    :rest     , # ReStructuredText
+    :textile  , # Textile
+    :mediawiki  # MediaWiki
+  ]
+
+  class << self
+    # @return [Pathname]
+    #   path of GitHub wiki directory
+    attr_reader :dir
+
+    # Set GitHub wiki cloned directory.
+    #
+    # @param path [String,Pathname]
+    #   path of GitHub wiki cloned directory
+    # @return [void]
+    def dir=(path)
+      @dir = Pathname.new(path)
+    end
+  end
+
+  # default path
+  @dir = Pathname.new(".")
+end

data/lib/ghwikitools/command.rb

@@ -0,0 +1,100 @@
+module GHWikiTools
+  # Command is a class for making sub commands of ghwikitools.
+  class Command
+    @table = Hash.new {|hash, key| abort("unknown command %s" % key)}
+
+    @toplevel_options = OptionParser.new.tap do |opt|
+      opt.on("--help") do
+        @table[:list].new([]).run
+        exit
+      end
+    end
+
+    class << self
+      # @api private
+      attr_reader :table
+
+      # @return [String]
+      #   description of the command
+      attr_reader :description
+
+      # Declare the command name.
+      #
+      # @param name [Symbol]
+      #   command name
+      # @return [void]
+      def command(name)
+        Command.table[name] = self
+      end
+
+      # Describe the aim of the command.
+      #
+      # @param msg [String]
+      #   message
+      # @return [void]
+      def describe(msg)
+        @description = msg
+      end
+
+      # Get subcommand.
+      #
+      # @param argv [Array<String>]
+      #   command arguments
+      # @return [Command]
+      #   subcommand
+      def get(argv)
+        @toplevel_options.order!(argv).tap do |_argv|
+          name, _argv = _argv
+          if name
+            return Command.table[name.to_sym].new(_argv)
+          else
+            @table[:list].new([]).run
+            exit
+          end
+        end
+      rescue => e
+        abort(e.message)
+      end
+    end
+
+    # @param argv [Array<String>]
+    #   command arguments
+    def initialize(argv)
+      @argv = argv
+    end
+
+    # Run the command.
+    #
+    # @return [void]
+    def run
+      raise NotImplementedError
+    end
+  end
+
+  # CommandList provides the definition of "ghwikitools list".
+  class CommandList < Command
+    command :list
+    describe "print all commands"
+
+    def run
+      puts "commands:"
+      Command.table.keys.each do |key|
+        puts "  %-10s %s" % [key, Command.table[key].description]
+      end
+    end
+  end
+
+  # CommandUpdate provides the definition of "ghwikitools update".
+  class CommandUpdate < Command
+    command :update
+    describe "update header, footer, and other snippets"
+
+    def run
+      GHWikiTools::Page.all.each do |page|
+        page.insert_header
+        page.insert_footer
+        page.update_snippets
+      end
+    end
+  end
+end

data/lib/ghwikitools/page.rb

@@ -0,0 +1,178 @@
+module GHWikiTools
+  # Page is a class for wiki pages.
+  class Page
+    class << self
+      # Return pages directory.
+      def dir
+        GHWikiTools.dir
+      end
+
+      # Return all pages in the wiki.
+      #
+      # @return [Array<Page>]
+      #   all pages
+      def all
+        Pathname.new(dir).entries.map do |entry|
+          by_filename(entry.to_s)
+        end.select {|page| page.valid?}
+      end
+
+      # Create a page by the filename.
+      #
+      # @param filename [String]
+      #   the filename
+      # @return [Page]
+      #   the page
+      def by_filename(filename)
+        path = dir + filename
+        basename, lang, ext = parse_filename(filename)
+        new(path, basename, lang, ext)
+      end
+
+      private
+
+      # Parse the filename.
+      #
+      # @param filename [String]
+      #   the filename
+      # @return [Array]
+      #   basename(String), language name(Symbol), and extensiton(Symbol)
+      def parse_filename(filename)
+        filename.split(".").tap do |array|
+          basename = array[0]
+          lang = array[1].to_sym if array.size == 3
+          ext = lang ? array[2] : array[1]
+          ext = ext.to_sym if ext
+          return basename, lang, ext
+        end
+      end
+    end
+
+    # @param [Pathname]
+    #   path of the page
+    attr_reader :path
+
+    # @param [String]
+    #   name of the page
+    attr_reader :name
+
+    # @param [String]
+    #   language name of the page
+    attr_reader :lang
+
+    # @param [String]
+    #   extension of the page
+    attr_reader :ext
+
+    # @param path [Pathname]
+    #   page file path
+    # @param name [String]
+    #   name
+    # @param lang [Symbol]
+    #   language name
+    # @param ext [Symbol]
+    #   extension name
+    def initialize(path, name, lang, ext)
+      @path = path
+      @name = name
+      @lang = lang
+      @ext = ext
+    end
+
+    # Return true if the page is valid in the meaning of this tools.
+    #
+    # @return [Boolean]
+    #   true if the page is valid
+    def valid?
+      return false unless EXTENSIONS.include?(@ext) and @path.file? and @path.exist?
+      return true
+    end
+
+    # Return the wikiname of the page with lang
+    def wikiname(lang=nil)
+      lang ? "%s.%s" % [@name, lang] : @name
+    end
+
+    # Insert a header snippet metadata.
+    #
+    # @return [void]
+    def insert_header
+      return if @name[0] == "_"
+      unless find_snippet_metadata.include?("Header")
+        content = @path.read
+        header = "<!-- >>> Header -->\n\n<!-- <<< Header -->\n\n"
+        @path.open("w+") do |f|
+          f.write(header + content)
+        end
+      end
+    end
+
+    # Insert a footer snippet metadata.
+    #
+    # @return [void]
+    def insert_footer
+      unless find_snippet_metadata.include?("Footer")
+        content = @path.read
+        footer = "\n\n<!-- >>> Footer -->\n\n<!-- <<< Footer -->"
+        @path.open("w+") do |f|
+          f.write(content + footer)
+        end
+      end
+    end
+
+    # Insert a footer snippet metadata.
+    #
+    # @return [void]
+    def update_snippets
+      if content = render_snippets
+        unless content == @path.read
+          @path.open("w+") {|f| f.write(content)}
+        end
+      end
+    end
+
+    # Return the result of rendering snippets.
+    #
+    # @return [String]
+    #   result of rendering snippets
+    def render_snippets
+      find_snippets.inject(@path.read) do |content, snippet|
+        if snippet.valid?
+          content.gsub(snippet_regexp(snippet.name)) do
+            "%s\n\n%s\n\n%s" % [$1, snippet.render(self), $3]
+          end
+        end
+      end
+    end
+
+    private
+
+    # Return a regexp of the named snippet.
+    #
+    # @param name [String]
+    #   snippet's name
+    # @return [Regexp]
+    #   regexp that matches snippet metadata
+    def snippet_regexp(name)
+      /(<!--\s*>>>\s*#{name}\s*-->)(.*?)(<!--\s*<<<\s*#{name}\s*-->)/m
+    end
+
+    # Return snippets in the page.
+    #
+    # @return [Array<Snippet>]
+    #   snippets in the page
+    def find_snippet_metadata
+      @path.read.scan(/<!--\s*>>>\s*(.+?)\s*-->/).flatten.uniq
+    end
+
+    # Return snippets in the page.
+    #
+    # @return [Array<Snippet>]
+    #   snippets in the page
+    def find_snippets
+      @path.read.scan(/<!--\s*>>>\s*(.+?)\s*-->/).flatten.uniq.map do |name|
+        Snippet.by_filename("%s.%s" % [name, @ext])
+      end
+    end
+  end
+end

data/lib/ghwikitools/snippet.rb

@@ -0,0 +1,48 @@
+module GHWikiTools
+  # Snippet is a small block text of wiki page.
+  class Snippet < Page
+    class << self
+      # Return snippetss directory.
+      def dir
+        GHWikiTools.dir + "snippet"
+      end
+    end
+
+    # Render the snippet with the page.
+    #
+    # @param page [Page]
+    #   the page that the snippet embeds in it
+    def render(page)
+      ERB.new(@path.read, nil, 2).result(SnippetContext.create(page))
+    end
+  end
+
+  # SnippetContext provides snippet rendering informations.
+  class SnippetContext
+    class << self
+      # Return the context as binding object.
+      #
+      # @param page [Page]
+      #   the page that the snippet embeds in it
+      # @return [Binding]
+      #   snippet context as binding object
+      def create(page)
+        new(page).binding
+      end
+    end
+
+    # @param page [Page]
+    #   the page that the snippet embeds in it
+    def initialize(page)
+      @page = page
+    end
+
+    # Return the environment binding object.
+    #
+    # @return [Binding]
+    #   the environment binding object
+    def binding
+      Kernel.binding
+    end
+  end
+end

data/lib/ghwikitools/version.rb

@@ -0,0 +1,4 @@
+module GHWikiTools
+  # version of ghwikitools
+  VERSION = "0.0.1"
+end

data/test/ghwiki/Page-markdown-1.ja.md

@@ -0,0 +1,4 @@
+<!-- <<< header <<< -->
+<!-- <<< header <<< -->
+
+これはPage1です。

data/test/ghwiki/Page-markdown-1.md

@@ -0,0 +1,4 @@
+<!-- >>> Header -->
+<!-- <<< Header -->
+
+This is Page1.

data/test/ghwiki/Page-markdown-2.md

@@ -0,0 +1,3 @@
+<!-- >>> Header -->ABC<!-- <<< Header -->
+
+This is Page2.

data/test/ghwiki/Page-markdown-3.md

@@ -0,0 +1,3 @@
+<!-- no header -->
+
+This is Page-markdown3.md.

data/test/ghwiki/not-page.txt

@@ -0,0 +1 @@
+This is not a GitHub wiki page.

data/test/ghwiki/snippet/Header.md

@@ -0,0 +1 @@
+Languages: [[English|<%= @page.wikiname %>]] | [[日本語|<%= @page.wikiname(:ja) %>]]

data/test/spec_ghwikitools.rb

@@ -0,0 +1,8 @@
+GHWikiTools.dir = File.join(File.dirname(__FILE__), "ghwiki")
+
+describe "GHWikiTools" do
+  it "should get GitHub wiki directory" do
+    GHWikiTools.dir.should.kind_of Pathname
+    GHWikiTools.dir.should == Pathname.new(File.join(File.dirname(__FILE__), "ghwiki"))
+  end
+end

data/test/spec_page.rb

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+
+GHWikiTools.dir = File.join(File.dirname(__FILE__), "ghwiki")
+
+include GHWikiTools
+
+describe "GHWikiTools::Page" do
+  it "should get all pages" do
+    Page.all.tap do |pages|
+      pages.size.should == 4
+      wikinames = pages.map{|page| page.wikiname}.uniq
+      wikinames.should.include "Page-markdown-1"
+      wikinames.should.include "Page-markdown-2"
+      wikinames.should.include "Page-markdown-3"
+      wikinames.should.not.include "not-page"
+    end
+  end
+
+  it "should get a page by the filename" do
+    page = Page.by_filename("Page-markdown-1.md")
+    page.should.kind_of Page
+    page.wikiname.should == "Page-markdown-1"
+    page.lang.should.nil
+    page.ext.should == :md
+    page.should.valid
+  end
+
+  it "should get a Japanese page by the filename" do
+    page = Page.by_filename("Page-markdown-1.ja.md")
+    page.should.kind_of Page
+    page.wikiname.should == "Page-markdown-1"
+    page.lang.should == :ja
+    page.ext.should == :md
+    page.should.valid
+  end
+
+  it "should get wikiname of the language" do
+    page = Page.by_filename("Page-markdown-1.md")
+    page.wikiname(:ja).should == "Page-markdown-1.ja"
+  end
+
+  it 'should get the page content with inserting the header' do
+    page = Page.by_filename("Page-markdown-1.md")
+    page.render_snippets.should == <<TXT
+<!-- >>> Header -->
+
+Languages: [[English|Page-markdown-1]] | [[日本語|Page-markdown-1.ja]]
+
+<!-- <<< Header -->
+
+This is Page1.
+TXT
+  end
+
+  it 'should get the page content with updating the header' do
+    page = Page.by_filename("Page-markdown-2.md")
+    page.render_snippets.should == <<TXT
+<!-- >>> Header -->
+
+Languages: [[English|Page-markdown-2]] | [[日本語|Page-markdown-2.ja]]
+
+<!-- <<< Header -->
+
+This is Page2.
+TXT
+  end
+end

data/test/spec_snippet.rb

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+
+GHWikiTools.dir = File.join(File.dirname(__FILE__), "ghwiki")
+
+include GHWikiTools
+
+describe "GHWikiTools::Snippet" do
+  it "should get all snippets" do
+    Snippet.all.tap do |snippets|
+      snippets.size.should == 1
+      names = snippets.map{|snippet| snippet.name}.uniq
+      names.should.include "Header"
+    end
+  end
+
+  it "should render the snippet content with page informations" do
+    page = Page.by_filename("Page-markdown-1.md")
+    snippet = Snippet.by_filename("Header.md")
+    snippet.render(page).should ==
+      "Languages: [[English|Page-markdown-1]] | [[日本語|Page-markdown-1.ja]]"
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: ghwikitools
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Keita Yamaguchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: GitHub wiki management tools.
+email:
+- keita.yamaguchi@gmail.com
+executables:
+- ghwikitools.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ghwikitools.rb
+- ghwikitools.gemspec
+- lib/ghwikitools.rb
+- lib/ghwikitools/command.rb
+- lib/ghwikitools/page.rb
+- lib/ghwikitools/snippet.rb
+- lib/ghwikitools/version.rb
+- test/ghwiki/Page-markdown-1.ja.md
+- test/ghwiki/Page-markdown-1.md
+- test/ghwiki/Page-markdown-2.md
+- test/ghwiki/Page-markdown-3.md
+- test/ghwiki/not-page.txt
+- test/ghwiki/snippet/Header.md
+- test/spec_ghwikitools.rb
+- test/spec_page.rb
+- test/spec_snippet.rb
+homepage: https://github.com/keita/ghwikitools
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: GitHub wiki management tools.
+test_files:
+- test/ghwiki/Page-markdown-1.ja.md
+- test/ghwiki/Page-markdown-1.md
+- test/ghwiki/Page-markdown-2.md
+- test/ghwiki/Page-markdown-3.md
+- test/ghwiki/not-page.txt
+- test/ghwiki/snippet/Header.md
+- test/spec_ghwikitools.rb
+- test/spec_page.rb
+- test/spec_snippet.rb
+has_rdoc: