rabbit 2.0.1 → 2.0.2

data/lib/rabbit/command/rabbit.rb

@@ -18,6 +18,7 @@
 require "English"
 
 require "rabbit/gettext"
+require "rabbit/slide-configuration"
 
 module Rabbit
   module Command
@@ -607,7 +608,7 @@ module Rabbit
           gem_name = $PREMATCH
           require "rabbit/gem-finder"
           finder = GemFinder.new(@logger)
-          spec = finder.find(gem_name, "rabbit-slide-")
+          spec = finder.find(gem_name, "#{SlideConfiguration::GEM_NAME_PREFIX}-")
           source = spec.gem_dir if spec
         end
 

data/lib/rabbit/path-manipulatable.rb

@@ -30,9 +30,6 @@ module Rabbit
     end
 
     def create_file(path, &block)
-      unless Pathname(path).absolute?
-        path = File.join(@id, path)
-      end
       @logger.info(_("Creating file:      %s") % path)
       File.open(path, "w", &block)
     end

data/lib/rabbit/readme-parser.rb

@@ -0,0 +1,49 @@
+# Copyright (C) 2012  Kouhei Sutou <kou@cozmixng.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+require "rabbit/gettext"
+require "rabbit/path-manipulatable"
+
+module Rabbit
+  class READMEParser
+    include GetText
+    include PathManipulatable
+
+    attr_accessor :logger
+    attr_reader :title, :description
+    def initialize(logger=nil)
+      @logger = logger || Logger.default
+      @title = nil
+      @description = nil
+    end
+
+    def parse(path=nil)
+      path ||= Dir.glob("README*")[0]
+      raise _("No README found") if path.nil?
+
+      parse_content(File.read(path))
+    end
+
+    private
+    def parse_content(content)
+      blocks = content.split(/(?:\r?\n){2,}/)
+      if blocks[0]
+        @title = blocks[0].gsub(/\A(?:[=*!]+|h\d\.)\s*/, "")
+      end
+      @description = blocks[1]
+    end
+  end
+end

data/lib/rabbit/slide-configuration.rb

@@ -0,0 +1,127 @@
+# Copyright (C) 2012  Kouhei Sutou <kou@cozmixng.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+require "time"
+
+require "yaml"
+
+require "rabbit/gettext"
+require "rabbit/author-configuration"
+require "rabbit/path-manipulatable"
+
+module Rabbit
+  class SlideConfiguration
+    include GetText
+    include PathManipulatable
+
+    GEM_NAME_PREFIX = "rabbit-slide"
+
+    attr_accessor :logger
+    attr_accessor :id, :base_name, :tags, :presentation_date
+    attr_accessor :licenses
+    attr_writer :version
+    attr_accessor :author
+    def initialize(logger=nil)
+      @logger = logger || Logger.default
+      @id = nil
+      @base_name = nil
+      @tags = []
+      @presentation_date = nil
+      @version = nil
+      @licenses = []
+      @author = nil
+    end
+
+    def load
+      return unless File.exist?(path)
+      conf = YAML.load(File.read(path))
+      merge!(conf)
+    rescue
+      format = _("Failed to read slide configuration: %s: %s")
+      @logger.error(format % [path, $!.message])
+    end
+
+    def save(base_dir)
+      config_path = File.join(base_dir, path)
+      create_file(config_path) do |conf_file|
+        conf_file.print(to_yaml)
+      end
+    rescue
+      format = _("Failed to write slide configuration: %s: %s")
+      @logger.error(format % [config_path, $!.message])
+    end
+
+    def merge!(conf)
+      @id                = conf["id"]
+      @base_name         = conf["base_name"]
+      @tags              = conf["tags"]
+      @presentation_date = conf["presentation_date"]
+      @version           = conf["version"]
+      @licenses          = conf["licenses"]
+
+      @author = AuthorConfiguration.new(@logger)
+      @author.merge!(conf["author"] || {})
+    end
+
+    def to_hash
+      config = {
+        "id"                => @id,
+        "base_name"         => @base_name,
+        "tags"              => @tags,
+        "presentation_date" => @presentation_date,
+        "version"           => version,
+        "licenses"          => @licenses,
+      }
+      config["author"] = @author.to_hash if @author
+      config
+    end
+
+    def to_yaml
+      to_hash.to_yaml
+    end
+
+    def version
+      @version || default_version
+    end
+
+    def gem_name
+      "#{GEM_NAME_PREFIX}-#{@author.rubygems_user}-#{@id}"
+    end
+
+    def path
+      "config.yaml"
+    end
+
+    private
+    def parsed_presentation_date
+      return nil if @presentation_date.nil?
+      begin
+        Time.parse(@presentation_date)
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    def default_version
+      date = parsed_presentation_date
+      if date
+        date.strftime("%Y.%m.%d")
+      else
+        "1.0.0"
+      end
+    end
+  end
+end

data/lib/rabbit/source-generator.rb

@@ -0,0 +1,39 @@
+# Copyright (C) 2012  Kouhei Sutou <kou@cozmixng.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+module Rabbit
+  module SourceGenerator
+    class << self
+      def find(markup_language)
+        case markup_language
+        when :rd
+          RD.new
+        when :hiki
+          Hiki.new
+        when :markdown
+          Markdown.new
+        else
+          nil
+        end
+      end
+    end
+  end
+end
+
+require "rabbit/source-generator/rd"
+require "rabbit/source-generator/hiki"
+require "rabbit/source-generator/markdown"
+

data/lib/rabbit/source-generator/hiki.rb

@@ -0,0 +1,63 @@
+# Copyright (C) 2012  Kouhei Sutou <kou@cozmixng.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+require "rabbit/gettext"
+
+module Rabbit
+  module SourceGenerator
+    class Hiki
+      include GetText
+      include PathManipulatable
+
+      attr_accessor :logger
+      def initialize(logger=nil)
+        @logger = logger || Logger.default
+      end
+
+      def heading(level, title)
+        ("!" * level) + " #{title}"
+      end
+
+      def definition_list_item(item, description)
+        ":#{item}:#{description}"
+      end
+
+      def unordered_list_item(item)
+        "* #{item}"
+      end
+
+      def image(source, options={})
+        lines = [
+          "{{image(#{source.dump},",
+          "        {",
+        ]
+        options.each do |key, value|
+          lines << "           #{key.to_s.dump} => #{value.inspect},"
+        end
+        lines << "        })}}"
+        lines.join("\n")
+      end
+
+      def preformatted_line(content)
+        " #{content}"
+      end
+
+      def comment(content)
+        "// #{content}"
+      end
+    end
+  end
+end

data/lib/rabbit/source-generator/markdown.rb

@@ -0,0 +1,61 @@
+# Copyright (C) 2012  Kouhei Sutou <kou@cozmixng.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+require "rabbit/gettext"
+
+module Rabbit
+  module SourceGenerator
+    class Markdown
+      include GetText
+      include PathManipulatable
+
+      attr_accessor :logger
+      def initialize(logger=nil)
+        @logger = logger || Logger.default
+      end
+
+      def heading(level, title)
+        ("#" * level) + " #{title}"
+      end
+
+      def definition_list_item(item, description)
+        [
+          item,
+          "   #{description}",
+        ].join("\n")
+      end
+
+      def unordered_list_item(item)
+        "* #{item}"
+      end
+
+      def image(source, options={})
+        parameters = options.collect do |key, value|
+          "#{key}='#{value}'"
+        end
+        "![](#{source}){:#{parameters.join(' ')}}"
+      end
+
+      def preformatted_line(content)
+        "    #{content}"
+      end
+
+      def comment(content)
+        ""
+      end
+    end
+  end
+end

data/lib/rabbit/source-generator/rd.rb

@@ -0,0 +1,65 @@
+# Copyright (C) 2012  Kouhei Sutou <kou@cozmixng.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+require "rabbit/gettext"
+
+module Rabbit
+  module SourceGenerator
+    class RD
+      include GetText
+      include PathManipulatable
+
+      attr_accessor :logger
+      def initialize(logger=nil)
+        @logger = logger || Logger.default
+      end
+
+      def heading(level, title)
+        ("=" * level) + " #{title}"
+      end
+
+      def definition_list_item(item, description)
+        [
+          ": #{item}",
+          "   #{description}",
+        ].join("\n")
+      end
+
+      def unordered_list_item(item)
+        "  * #{item}"
+      end
+
+      def image(source, options={})
+        lines = [
+          "  # image",
+          "  # src = #{source}",
+        ]
+        options.each do |key, value|
+          lines << "  # #{key} = #{value}"
+        end
+        lines.join("\n")
+      end
+
+      def preformatted_line(content)
+        "  #{content}"
+      end
+
+      def comment(content)
+        "# #{content}"
+      end
+    end
+  end
+end

data/lib/rabbit/task/slide.rb

@@ -19,6 +19,8 @@ require "rake"
 require "rabbit/gettext"
 require "rabbit/logger"
 require "rabbit/command/rabbit"
+require "rabbit/slide-configuration"
+require "rabbit/readme-parser"
 
 module Rabbit
   module Task
@@ -26,26 +28,55 @@ module Rabbit
       include Rake::DSL
       include GetText
 
-      attr_reader :spec
-      attr_accessor :package_dir, :pdf_dir, :pdf_base_path
-      attr_accessor :tags, :presentation_date
-      attr_accessor :rubygems_user, :slideshare_user, :speaker_deck_user
-      def initialize(spec)
+      attr_accessor :package_dir, :pdf_dir, :required_rabbit_version
+      def initialize
         @logger = Logger.default
-        @spec = spec
+        @slide = load_slide_configuration
         @package_dir = "pkg"
         @pdf_dir = "pdf"
-        @pdf_base_path = nil
-        @tags = []
-        @presentation_date = nil
-        @rubygems_user = nil
-        @slideshare_user = nil
-        @speaker_deck_user = nil
+        @required_rabbit_version = ">= 2.0.2"
         yield(self) if block_given?
         define
       end
 
+      def spec
+        @spec ||= create_spec
+      end
+
       private
+      def load_slide_configuration
+        slide_conf = SlideConfiguration.new(@logger)
+        slide_conf.load
+        slide_conf
+      end
+
+      def create_spec
+        readme_parser = READMEParser.new(@logger)
+        readme_parser.parse
+
+        Gem::Specification.new do |spec|
+          spec.name = @slide.gem_name
+          spec.version = @slide.version
+          spec.homepage = homepage
+          spec.authors = [@slide.author.name]
+          spec.email = [@slide.author.email]
+          spec.summary = readme_parser.title || "TODO"
+          spec.description = readme_parser.description || "TODO"
+          spec.licenses = @slide.licenses
+
+          slide_conf_path = @slide.path
+          spec.files = [".rabbit", slide_conf_path, "Rakefile"]
+          spec.files += Dir.glob("{COPYING,GPL,README*}")
+          spec.files += Dir.glob("rabbit/**/*.*")
+          spec.files += Dir.glob("**/*.{svg,png,jpg,jpeg,gif,eps,pdf}")
+          spec.files += Dir.glob("*.{rd,rab,hiki,md,pdf}")
+          spec.files -= Dir.glob("{pkg,pdf}/**/*.*")
+          spec.files += [pdf_path]
+
+          spec.add_runtime_dependency("rabbit", @required_rabbit_version)
+        end
+      end
+
       def define
         task :default => :run
 
@@ -61,10 +92,10 @@ module Rabbit
         end
 
         desc(_("Create gem: %{gem_path}") % {:gem_path => gem_path})
-        task :gem => "gem:validate" do
+        task :gem => ["gem:validate", :pdf] do
           mkdir_p(@package_dir)
-          Gem::Builder.new(@spec).build
-          mv(File.basename(@spec.cache_file), gem_path)
+          Gem::Builder.new(spec).build
+          mv(File.basename(spec.cache_file), gem_path)
         end
 
         namespace :gem do
@@ -75,7 +106,7 @@ module Rabbit
               :where => Dir.glob("README*")[0],
             }
             [:summary, :description].each do |item|
-              content = @spec.send(item)
+              content = spec.send(item)
               if /TODO|FIXME/ =~ content
                 data[:item] = item
                 data[:content] = content
@@ -88,8 +119,7 @@ module Rabbit
           end
         end
 
-        pdf_path = File.join(@pdf_dir, @pdf_base_path || default_pdf_base_path)
-        file pdf_path => [options_file, *@spec.files] do
+        file pdf_path => [options_file, *(spec.files - [pdf_path])] do
           mkdir_p(@pdf_dir)
           rabbit("--print",
                  "--output-filename", pdf_path)
@@ -103,7 +133,7 @@ module Rabbit
 
         publish_tasks = []
         namespace :publish do
-          if @rubygems_user
+          if @slide.author.rubygems_user
             desc(_("Publish the slide to %s" % "RubyGems.org"))
             task :rubygems => :gem do
               ruby("-S", "gem", "push", "--verbose", gem_path)
@@ -111,19 +141,20 @@ module Rabbit
             publish_tasks << :rubygems
           end
 
-          if @slideshare_user
+          slideshare_user = @slide.author.slideshare_user
+          if slideshare_user
             desc(_("Publish the slide to %s" % "SlideShare"))
             task :slideshare => [:pdf, "gem:validate"] do
               require "rabbit/slideshare"
               slideshare = SlideShare.new(@logger)
-              slideshare.user = @slideshare_user
+              slideshare.user = slideshare_user
               slideshare.pdf_path = pdf_path
-              slideshare.title = @spec.summary
-              slideshare.description = @spec.description
+              slideshare.title = spec.summary
+              slideshare.description = spec.description
               slideshare.tags = @tags if @tags
               id = slideshare.upload
               if id
-                url = "http://www.slideshare.net/#{@slideshare_user}/ss-#{id}"
+                url = "http://www.slideshare.net/#{slideshare_user}/ss-#{id}"
                 @logger.info(_("Uploaded successfully!"))
                 @logger.info(_("See %s") % url)
                 Gtk.show_uri(url) if Gtk.respond_to?(:show_uri)
@@ -132,7 +163,7 @@ module Rabbit
             publish_tasks << :slideshare
           end
 
-          if @speaker_deck_user
+          if @slide.author.speaker_deck_user
             desc(_("Publish the slide to %s" % "Spearker Deck"))
             task :speaker_deck => :pdf do
               raise "Not implemented yet."
@@ -144,14 +175,20 @@ module Rabbit
       end
 
       def gem_path
-        File.join(@package_dir, "#{@spec.name}-#{@spec.version}.gem")
+        File.join(@package_dir, "#{spec.name}-#{spec.version}.gem")
+      end
+
+      def pdf_path
+        File.join(@pdf_dir, pdf_base_path)
+      end
+
+      def pdf_base_path
+        "#{@slide.id}.pdf"
       end
 
-      def default_pdf_base_path
-        user_name_and_slide_id = @spec.name.gsub(/\Arabbit-slide-/, "")
-        escaped_user = Regexp.escape(@rubygems_user)
-        slide_id = user_name_and_slide_id.gsub(/\A#{escaped_user}-/, "")
-        "#{slide_id}.pdf"
+      def homepage
+        rubygems_user = @slide.author.rubygems_user
+        "http://slide.rabbit-shockers.org/#{rubygems_user}/\#{@slide.id}/"
       end
 
       def rabbit(*arguments)