ore 0.10.0 → 0.11.0

data/lib/ore/options.rb

@@ -1,13 +1,16 @@
-require 'ore/config'
-require 'ore/template'
+require 'yaml'
 
 module Ore
   #
-  # @api semipublic
+  # Value object to contain `~/.ore/options.yml` data.
   #
-  # @since 0.9.0
+  # @since 0.11.0
   #
-  module Options
+  class Options
+
+    # Default markup
+    DEFAULT_MARKUP = 'markdown'
+
     # Default version
     DEFAULT_VERSION = '0.1.0'
 
@@ -17,47 +20,75 @@ module Ore
     # Default description
     DEFAULT_DESCRIPTION = %q{TODO: Description}
 
-    # Default License
-    DEFAULT_LICENSE = 'MIT'
+    # Default templates
+    DEFAULT_TEMPLATES = [
+      :git,
+      :mit,
+      :bundler,
+      :rubygems_tasks,
+      :rdoc,
+      :rspec
+    ]
 
-    def self.included(base)
-      base.extend ClassMethods
-    end
+    # Default options
+    DEFAULTS = {
+      markup:      DEFAULT_MARKUP,
+      version:     DEFAULT_VERSION,
+      summary:     DEFAULT_SUMMARY,
+      description: DEFAULT_DESCRIPTION
+    }
+    DEFAULT_TEMPLATES.each { |name| DEFAULTS[name] = true }
 
     #
-    # Default options for the generator.
-    #
-    # @return [Hash{Symbol => Object}]
-    #   The option names and default values.
-    #
-    def self.defaults
-      @@defaults ||= {
-        :templates      => [],
-        :version        => DEFAULT_VERSION,
-        :summary        => DEFAULT_SUMMARY,
-        :description    => DEFAULT_DESCRIPTION,
-        :license        => DEFAULT_LICENSE,
-        :gemspec        => true,
-        :rubygems_tasks => true,
-        :rdoc           => true,
-        :rspec          => true,
-        :git            => true
-      }.merge(Config.options)
+    # Initializes the options.
+    #
+    # @param [Hash{Symbol => Object}] options
+    #   The options hash.
+    #
+    def initialize(options={})
+      @options = DEFAULTS.merge(options)
     end
 
-    module ClassMethods
-      #
-      # Defines a generator option.
-      #
-      # @param [Symbol] name
-      #   The name of the option.
-      #
-      # @param [Hash{Symbol => Object}] options
-      #   The Thor options of the option.
-      #
-      def generator_option(name,options={})
-        class_option(name,options.merge(:default => Options.defaults[name]))
+    #
+    # Loads the options from a YAML file.
+    #
+    # @param [String] path
+    #   Path to the options file.
+    #
+    # @return [Options]
+    #   The loaded options.
+    #
+    # @raise [RuntimeError]
+    #   The file contained malformed YAML.
+    #
+    def self.load(path)
+      data = YAML.load_file(path)
+
+      unless data.kind_of?(Hash)
+        raise("#{path} must contain a YAML encoded Hash")
       end
+
+      options = {}
+
+      data.each do |key,value|
+        options[key.to_sym] = value
+      end
+
+      return new(options)
     end
+
+    #
+    # Accesses an option.
+    #
+    # @param [Symbol] key
+    #   The option name.
+    #
+    # @return [Object]
+    #   The option value.
+    #
+    def [](key)
+      @options[key]
+    end
+
   end
 end

data/lib/ore/template/directory.rb

@@ -1,4 +1,5 @@
 require 'ore/template/exceptions/invalid_template'
+require 'ore/template/markup'
 
 require 'yaml'
 require 'find'
@@ -17,13 +18,6 @@ module Ore
       # Files or directory names to ignore
       IGNORE = ['.git', CONFIG_FILE]
 
-      # The known markup languages and file extensions
-      MARKUPS = {
-        :markdown => %w[.md .markdown],
-        :textile  => %w[.tt .textile],
-        :rdoc     => %w[.rdoc]
-      }
-
       # The path of the template directory
       attr_reader :path
 
@@ -247,7 +241,7 @@ module Ore
       #   Specifies whether the file is formatting.
       #
       def formatted?(path)
-        MARKUPS.values.any? { |exts| exts.include?(File.extname(path)) }
+        Markup::EXTS.values.any? { |exts| exts.include?(File.extname(path)) }
       end
 
       #
@@ -263,7 +257,7 @@ module Ore
       #   Specifies whether the file contains the given formatting.
       #
       def formatted_like?(path,markup)
-        MARKUPS[markup].include?(File.extname(path))
+        Markup::EXTS[markup].include?(File.extname(path))
       end
 
     end

data/lib/ore/template/helpers.rb

@@ -1,10 +1,19 @@
+require 'ore/template/helpers/markdown'
+require 'ore/template/helpers/textile'
+require 'ore/template/helpers/rdoc'
+
 module Ore
   module Template
     #
     # Helper methods that can be used within ERb templates.
     #
     module Helpers
-      protected
+      # Markup helpers
+      MARKUP = {
+        markdown: Markdown,
+        textile:  Textile,
+        rdoc:     RDoc
+      }
 
       #
       # Renders all include files with the given name.
@@ -219,11 +228,26 @@ module Ore
       # @param [Integer] spaces
       #   The number of spaces to indent by.
       #
+      # @yield []
+      #   The given block will be used as the text.
+      #
       # @return [String]
       #   The indentation string.
       #
       def indent(n,spaces=2)
-        (' ' * spaces) * n
+        @indent ||= 0
+        @indent += (spaces * n)
+
+        margin = ' ' * @indent
+
+        text = if block_given?
+                 yield.each_line.map { |line| margin + line }.join
+               else
+                 margin
+               end
+
+        @indent -= (spaces * n)
+        return text
       end
 
       #

data/lib/ore/template/helpers/markdown.rb

@@ -0,0 +1,96 @@
+module Ore
+  module Template
+    module Helpers
+      #
+      # @api semipublic
+      #
+      # @since 0.10.0
+      #
+      module Markdown
+        #
+        # Emits a markdown link.
+        #
+        # @param [String, nil] text
+        #
+        # @param [String] url
+        #
+        # @return [String]
+        #
+        def link_to(text,url)
+          "[#{text}](#{url})"
+        end
+
+        #
+        # Emits a markdown image.
+        #
+        # @param [String] url
+        #
+        # @param [String, nil] alt
+        #
+        # @return [String]
+        #
+        def image(url,alt=nil)
+          "![#{alt}](#{url})"
+        end
+
+        #
+        # Emits a markdown h1 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h1(title)
+          "# #{title}"
+        end
+
+        #
+        # Emits a markdown h2 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h2(title)
+          "## #{title}"
+        end
+
+        #
+        # Emits a markdown h3 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h3(title)
+          "### #{title}"
+        end
+
+        #
+        # Emits a markdown h4 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h4(title)
+          "#### #{title}"
+        end
+
+        #
+        # Emits a markdown code block.
+        #
+        # @param [String] code
+        #
+        # @yield []
+        #   The return value of the given block will be used as the code.
+        #
+        # @return [String]
+        #
+        def pre(code)
+          code.each_line.map { |line| "    #{line}" }.join
+        end
+      end
+    end
+  end
+end

data/lib/ore/template/helpers/rdoc.rb

@@ -0,0 +1,96 @@
+module Ore
+  module Template
+    module Helpers
+      #
+      # @api semipublic
+      #
+      # @since 0.10.0
+      #
+      module RDoc
+        #
+        # Emits a RDoc link.
+        #
+        # @param [String, nil] text
+        #
+        # @param [String] url
+        #
+        # @return [String]
+        #
+        def link_to(text,url)
+          "{#{text}}[#{url}]"
+        end
+
+        #
+        # Emits a RDoc image.
+        #
+        # @param [String] url
+        #
+        # @param [String, nil] alt
+        #
+        # @return [String]
+        #
+        def image(url,alt=nil)
+          "{#{alt}}[rdoc-image:#{url}]"
+        end
+
+        #
+        # Emits a RDoc h1 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h1(title)
+          "= #{title}"
+        end
+
+        #
+        # Emits a RDoc h2 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h2(title)
+          "== #{title}"
+        end
+
+        #
+        # Emits a RDoc h3 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h3(title)
+          "=== #{title}"
+        end
+
+        #
+        # Emits a RDoc h4 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h4(title)
+          "==== #{title}"
+        end
+
+        #
+        # Emits a RDoc code block.
+        #
+        # @param [String] code
+        #
+        # @yield []
+        #   The return value of the given block will be used as the code.
+        #
+        # @return [String]
+        #
+        def pre(code)
+          code.each_line.map { |line| "  #{line}" }.join
+        end
+      end
+    end
+  end
+end

data/lib/ore/template/helpers/textile.rb

@@ -0,0 +1,106 @@
+module Ore
+  module Template
+    module Helpers
+      #
+      # @api semipublic
+      #
+      # @since 0.10.0
+      #
+      module Textile
+        #
+        # Emits a Textile link.
+        #
+        # @param [String, nil] text
+        #
+        # @param [String] url
+        #
+        # @return [String]
+        #
+        def link_to(text,url)
+          if text
+            "#{text.dump}:#{url}"
+          else
+            url
+          end
+        end
+
+        #
+        # Emits a Textile image tag.
+        #
+        # @param [String] url
+        #
+        # @param [String, nil] alt
+        #
+        # @return [String]
+        #
+        def image(url,alt=nil)
+          if alt then "!#{url}(#{alt})!"
+          else        "!#{url}!"
+          end
+        end
+
+        #
+        # Emits a Textile h1 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h1(title)
+          "h1. #{title}"
+        end
+
+        #
+        # Emits a Textile h2 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h2(title)
+          "h2. #{title}"
+        end
+
+        #
+        # Emits a Textile h3 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h3(title)
+          "h3. #{title}"
+        end
+
+        #
+        # Emits a Textile h4 heading.
+        #
+        # @param [String] title
+        #
+        # @return [String]
+        #
+        def h4(title)
+          "h4. #{title}"
+        end
+
+        #
+        # Emits a Textile code block.
+        #
+        # @param [String] code
+        #
+        # @yield []
+        #   The return value of the given block will be used as the code.
+        #
+        # @return [String]
+        #
+        def pre(code)
+          if code =~ /#{$/}\s*#{$/}/
+            "bc.. #{code}"
+          else
+            "bc. #{code}"
+          end
+        end
+      end
+    end
+  end
+end