mint 0.5.1 → 0.7.1

data/lib/mint/helpers.rb

@@ -1,12 +1,12 @@
-require 'pathname'
-require 'tempfile'
-require 'yaml'
-require 'active_support/core_ext/string/inflections'
+require "pathname"
+require "tempfile"
+require "yaml"
+require "active_support/core_ext/string/inflections"
 
 module Mint
   module Helpers    
     def self.underscore(obj, opts={})
-      namespaces = obj.to_s.split('::').map do |namespace|
+      namespaces = obj.to_s.split("::").map do |namespace|
         if opts[:ignore_prefix]
           namespace[0..1].downcase + namespace[2..-1]
         else
@@ -14,7 +14,7 @@ module Mint
         end
       end
 
-      string = opts[:namespaces] ? namespaces.join('::') : namespaces.last
+      string = opts[:namespaces] ? namespaces.join("::") : namespaces.last
       string.underscore
     end
 
@@ -25,10 +25,10 @@ module Mint
     # @return [String] a URL-ready slug
     def self.slugize(obj)
       obj.to_s.downcase.
-        gsub(/&/, 'and').
-        gsub(/[\s-]+/, '-').
-        gsub(/[^a-z0-9-]/, '').
-        gsub(/[-]+/, '-')
+        gsub(/&/, "and").
+        gsub(/[\s-]+/, "-").
+        gsub(/[^a-z0-9-]/, "").
+        gsub(/[-]+/, "-")
     end
 
     # Transforms a potentially hyphenated String into a symbol name.
@@ -36,7 +36,7 @@ module Mint
     # @param [String, #to_s] obj an object to be turned into a symbol name
     # @return [Symbol] a symbol representation of obj
     def self.symbolize(obj)
-      slugize(obj).gsub(/-/, '_').to_sym
+      slugize(obj).gsub(/-/, "_").to_sym
     end
   
     # Transforms a String or Pathname into a fully expanded Pathname.
@@ -73,9 +73,9 @@ module Mint
 
     def self.listify(list)
       if list.length > 2
-        list[0..-2].join(', ') + ' & ' + list.last
+        list[0..-2].join(", ") + " & " + list.last
       else
-        list.join(' & ')
+        list.join(" & ")
       end
     end
 
@@ -103,6 +103,10 @@ module Mint
       end
     end
 
+    def self.hashify(list1, list2)
+      Hash[*list1.zip(list2).flatten]
+    end
+
     # Returns the relative path to to_directory from from_directory. 
     # If to_directory and from_directory have no parents in common besides 
     # /, returns the absolute directory of to_directory. Assumes no symlinks.
@@ -126,11 +130,11 @@ module Mint
     # @param [Hash, #[]] new_opts a set of options to add to the Yaml file
     # @param [Pathname, #exist] file a file to read from and write to
     # @return [void] 
-    def self.update_yaml!(new_opts, file)
-      curr_opts = file.exist? ? YAML.load_file(file) : {}
+    def self.update_yaml!(file, opts={})
+      curr_opts = File.exist?(file) ? YAML.load_file(file) : {}
 
-      File.open file, 'w' do |f|
-        YAML.dump(curr_opts.merge(new_opts), f)
+      File.open file, "w" do |f|
+        YAML.dump(curr_opts.merge(opts), f)
       end
     end
 

data/lib/mint/layout.rb

@@ -1,4 +1,4 @@
-require 'mint/resource'
+require "mint/resource"
 
 module Mint
   class Layout < Resource

data/lib/mint/mint.rb

@@ -1,9 +1,21 @@
-require 'pathname'
-require 'fileutils'
-require 'yaml'
-require 'tilt'
+require "pathname"
+require "fileutils"
+require "yaml"
+require "tilt"
+
+require "active_support/core_ext/hash/slice"
 
 module Mint
+  ROOT = (Pathname.new(__FILE__).realpath.dirname + "../..").to_s 
+
+  SCOPES = {
+    local:  Pathname.new(".mint"),
+    user:   Pathname.new("~/.mint").expand_path,
+    global: Pathname.new("#{ROOT}/config").expand_path
+  }
+
+  SCOPE_NAMES = SCOPES.keys
+
   # Assume that someone using an Html template has formatted it
   # in Erb and that a Css stylesheet will pass untouched through
   # a Scss parser.
@@ -12,21 +24,17 @@ module Mint
 
   # @return [String] the Mint root path name
   def self.root
-    (Pathname.new(__FILE__).realpath.dirname + '../..').to_s
+    ROOT
   end
 
-  # Returns an array with the Mint template path. Will first look
-  # for MINT_PATH environment variable. Otherwise will use smart defaults.
-  # Either way, earlier/higher paths take precedence. And is considered to
-  # be the directory for "local" config options, templates, etc.
+  # Returns an array with the Mint template path for the named scope
+  # or scopes. This path is used to lookup templates and configuration options.
   #
-  # @param [Boolean] as_path if as_path is true, will return Pathname objects
-  # @return [String] the Mint path as a String or Pathname
-  def self.path(as_path=false)
-    mint_path = ENV['MINT_PATH'] || 
-      "#{Dir.getwd}/.mint:~/.mint:#{Mint.root}"
-    paths = mint_path.split(':')
-    as_path ? paths.map {|p| Pathname.new(p).expand_path } : paths
+  # @param [Hash] opts a list of options, including :scopes
+  # @return [Array] the Mint path as an Array of Pathnames
+  def self.path(opts={})
+    opts = { scopes: SCOPE_NAMES }.merge(opts)
+    SCOPES.slice(*opts[:scopes]).values
   end
 
   # Returns the part of Mint.path relevant to scope.
@@ -43,9 +51,9 @@ module Mint
     case Mint.path
     when Array
       index = { local: 0, user: 1, global: 2 }[scope]
-      Mint.path(as_path)[index]
+      Mint.path[index]
     when Hash
-      Mint.path(as_path)[scope]
+      Mint.path[scope]
     else
       nil
     end
@@ -54,16 +62,15 @@ module Mint
   # @return [Hash] key Mint directories
   def self.directories
     { 
-      templates: 'templates',
-      config: 'config'
+      templates: "templates"
     }
   end
 
   # @return [Hash] key Mint files
   def self.files
     { 
-      syntax: directories[:config] + '/syntax.yaml',
-      config: directories[:config] + '/config.yaml'
+      syntax: "syntax.yaml",
+      defaults: "defaults.yaml"
     }
   end
 
@@ -72,8 +79,8 @@ module Mint
     {
       # Do not set default `template`--will override style and
       # layout when already specified -- causes tricky bugs
-      layout: 'default',     # default layout
-      style: 'default',      # default style
+      layout: "default",     # default layout
+      style: "default",      # default style
       destination: nil,      # do not create a subdirectory
       style_destination: nil # do not copy style to root
     }
@@ -87,18 +94,51 @@ module Mint
   # @return [Array] CSS formats, for source -> destination
   #   name guessing/conversion only.
   def self.css_formats
-    ['css', 'sass', 'scss', 'less']
+    ["css", "sass", "scss", "less"]
   end
 
-  # @return [Array] the full path for each known template in the Mint path
-  def self.templates
-    templates_dir = Mint.directories[:templates]
+  # Returns a hash of all active options specified by file (for all scopes).
+  # That is, if you specify file as "defaults.yaml", this will return the aggregate
+  # of all defaults.yaml-specified options in the Mint path, where more local
+  # members of the path take precedence over more global ones.
+  #
+  # @param [String] file a filename pointing to a Mint configuration file
+  # @return [Hash] a structured set of configuration options
+  def self.configuration(opts={})
+    opts = { scopes: SCOPE_NAMES }.merge(opts)
+
+    # Merge config options from all config files on the Mint path,
+    # where more local options take precedence over more global
+    # options
+    configuration = Mint.path(:scopes => opts[:scopes]).
+      map {|p| p + Mint.files[:defaults] }.
+      select(&:exist?).
+      map {|p| YAML.load_file p }.
+      reverse.
+      reduce(Mint.default_options) {|r,p| r.merge p }
+
+    Helpers.symbolize_keys configuration
+  end
 
-    Mint.path(true).
+  # Returns all configuration options (as specified by the aggregate
+  # of all config files), along with opts, where opts take precedence.
+  #
+  # @param [Hash] additional options to add to the current configuration
+  # @return [Hash] a structured set of configuration options with opts
+  #   overriding any options from config files
+  def self.configuration_with(opts)
+    configuration.merge opts
+  end
+
+  # @return [Array] the full path for each known template in the Mint path
+  def self.templates(opts={})
+    opts = { scopes: SCOPE_NAMES }.merge(opts)
+    Mint.path(:scopes => opts[:scopes]).
       map {|p| p + directories[:templates] }.
       select(&:exist?).
       map {|p| p.children.select(&:directory?).map(&:to_s) }.
-      flatten
+      flatten.
+      sort
   end
 
   # Decides whether the template specified by `name_or_file` is a real
@@ -139,14 +179,30 @@ module Mint
 
     file_name  = lambda {|x| x + templates_dir + name + type.to_s }
     find_files = lambda {|x| Pathname.glob "#{x.to_s}.*" }
-    acceptable = lambda {|x| x.to_s =~ /#{Mint.formats.join '|'}/ }
+    acceptable = lambda {|x| x.to_s =~ /#{Mint.formats.join "|"}/ }
 
-    Mint.path(true).map(&file_name).map(&find_files).flatten.
+    Mint.path.map(&file_name).map(&find_files).flatten.
       select(&acceptable).select(&:exist?).first.tap do |template|
       raise TemplateNotFoundException unless template
     end.to_s
   end
 
+  def self.template_path(name, type, opts={})
+    defaults = { 
+      scope: :local,
+      ext: { layout: "haml", style: "sass" }[type]
+    }
+    opts = defaults.merge(opts)
+    path = Mint.path_for_scope(opts[:scope])
+
+    case type
+    when :layout, :style
+      "#{path}/templates/#{name}/#{type}.#{opts[:ext]}"
+    when :all
+      "#{path}/templates/#{name}"
+    end
+  end
+
   # Checks (non-rigorously) to see if the file is somewhere on the
   # MINT_PATH
   #
@@ -156,7 +212,7 @@ module Mint
     paths = Mint.path.map {|f| File.expand_path f }
     file_path = Pathname.new(file)
     file_path.exist? and 
-      file_path.dirname.expand_path.to_s =~ /#{paths.join('|')}/
+      file_path.dirname.expand_path.to_s =~ /#{paths.map(&:to_s).join("|")}/
   end
 
   # Guesses an appropriate name for the resource output file based on
@@ -166,10 +222,10 @@ module Mint
   # @return [String] probably output file name
   def self.guess_name_from(name)
     name = Pathname(name).basename if name
-    css = Mint.css_formats.join '|'
+    css = Mint.css_formats.join "|"
     name.to_s.
-      gsub(/\.(#{css})$/, '.css').
-      gsub(/(\.[^css]+)$/, '.html')
+      gsub(/\.(#{css})$/, ".css").
+      gsub(/(\.[^css]+)$/, ".html")
   end
 
   # Transforms a path into a template that will render the file specified

data/lib/mint/plugin.rb

@@ -1,5 +1,5 @@
-require 'mint/document'
-require 'set'
+require "mint/document"
+require "set"
 
 module Mint
   def self.plugins
@@ -28,15 +28,15 @@ module Mint
   end
 
   def self.template_directory(plugin)
-    Mint.root + '/plugins/templates/' + plugin.underscore
+    Mint.root + "/plugins/templates/" + plugin.underscore
   end
 
   def self.config_directory(plugin)
-    Mint.root + '/plugins/config/' + plugin.underscore
+    Mint.root + "/plugins/config/" + plugin.underscore
   end
 
   def self.commandline_options_file(plugin)
-    plugin.config_directory + '/syntax.yml'
+    plugin.config_directory + "/syntax.yml"
   end
 
   def self.commandline_name(plugin)

data/lib/mint/plugins/epub.rb

@@ -1,24 +1,24 @@
-require 'nokogiri'
-require 'hashie'
-require 'zip/zip'
-require 'zip/zipfilesystem'
-require 'active_support/core_ext/hash/deep_merge'
-require 'active_support/core_ext/hash/keys'
+require "nokogiri"
+require "hashie"
+require "zip/zip"
+require "zip/zipfilesystem"
+require "active_support/core_ext/hash/deep_merge"
+require "active_support/core_ext/hash/keys"
 
 # Note: This code is not as clean as I want it to be. It is an example
 # plugin with which I'm developing the Mint plugin system. Code cleanup
 # to follow.
 
 module Mint
-  META_DIR = 'META-INF'
-  CONTENT_DIR = 'OPS'
+  META_DIR = "META-INF"
+  CONTENT_DIR = "OPS"
 
   # Add chapters to document -- this is probably not a sustainable pattern
   # for all plugins, but it's useful here.
   class Document
     def chapters
       html_document = Nokogiri::HTML::Document.parse render
-      EPub.split_on(html_document, 'h2').map &:to_s
+      EPub.split_on(html_document, "h2").map &:to_s
     end
   end
 
@@ -26,7 +26,7 @@ module Mint
 
   class EPub < Plugin
     def self.after_publish(document)
-      # This check doesn't currently follow simlinks
+      # This check doesn't currently follow symlinks
       if document.destination_directory == Dir.getwd
         raise InvalidDocumentError 
       end
@@ -40,22 +40,22 @@ module Mint
         create_chapters! chapters, :locals => metadata
 
         create! do |container|
-          container.type = 'container'
+          container.type = "container"
           container.locals = locals
         end
 
         create! do |content|
-          content.type = 'content'
+          content.type = "content"
           content.locals = locals
         end
 
         create! do |toc|
-          toc.type = 'toc'
+          toc.type = "toc"
           toc.locals = locals
         end
 
         create! do |title|
-          title.type = 'title'
+          title.type = "title"
           title.locals = locals
         end
       end
@@ -63,8 +63,8 @@ module Mint
       FileUtils.rm document.destination_file
 
       self.zip! document.destination_directory, 
-                :mimetype => 'application/epub+zip',
-                :extension => 'epub'
+                :mimetype => "application/epub+zip",
+                :extension => "epub"
 
       FileUtils.rm_r document.destination_directory
     end
@@ -72,7 +72,7 @@ module Mint
     protected
     
     def self.split_on(document, tag_name, opts={})
-      container_node = opts[:container] || '#container'
+      container_node = opts[:container] || "#container"
 
       new_document = document.dup.tap do |node|
         container = node.at container_node
@@ -86,22 +86,22 @@ module Mint
         div = nil
         container.element_children.each do |elem|
           if elem.name == tag_name
-            div = node.create_element 'div'
-            # div.add_class 'chapter'
+            div = node.create_element "div"
+            # div.add_class "chapter"
             elem.replace div
           end
           div << elem if div
         end
       end
 
-      new_document.search('div div')
+      new_document.search("div div")
     end
 
     # This is an opinionated version of ZIP, specifically
     # tailored to ePub creation
     def self.zip!(directory, opts={})
       default_opts = {
-        extension: 'zip',
+        extension: "zip",
         mimetype: nil
       }
 
@@ -112,7 +112,7 @@ module Mint
 
       Zip::ZipOutputStream.open "#{directory}.#{extension}" do |zos|
         if opts[:mimetype]
-          zos.put_next_entry('mimetype', nil, nil, Zip::ZipEntry::STORED)
+          zos.put_next_entry("mimetype", nil, nil, Zip::ZipEntry::STORED)
           zos << opts[:mimetype]
         end
 
@@ -136,7 +136,7 @@ module Mint
       yield options if block_given?
       options = options.to_hash.symbolize_keys
 
-      type = options[:type] || 'container'
+      type = options[:type] || "container"
       default_options = 
         case type.to_sym
         when :container
@@ -156,7 +156,7 @@ module Mint
 
     def self.create_chapters!(chapters, opts={})
       opts = chapter_defaults.deep_merge(opts)
-      template_file = EPub.template_directory + '/layouts/layout.haml'
+      template_file = EPub.template_directory + "/layouts/layout.haml"
       renderer = Tilt.new template_file, :ugly => true
       chapters.map do |chapter|
         renderer.render Object.new, opts[:locals].merge(:content => chapter)
@@ -172,7 +172,7 @@ module Mint
       renderer = Tilt.new template_file, :ugly => true
       content = renderer.render Object.new, opts[:locals]
 
-      File.open(opts[:to], 'w') do |f|
+      File.open(opts[:to], "w") do |f|
         f << content
       end
     end
@@ -215,13 +215,13 @@ module Mint
     # def self.chapters_from(document)
       # html_text = File.read document.destination_file
       # html_document = Nokogiri::HTML::Document.parse html_text
-      # chapter_contents = self.split_on(html_document, 'h2')
+      # chapter_contents = self.split_on(html_document, "h2")
       # chapter_ids = (1..chapters.length).map {|x| "chapter-#{x}" }
       # chapters = Hash[chapter_ids.zip chapter_contents]
     # end
 
     def self.create_chapter!(id, text)
-      File.open chapter_filename(id), 'w' do |file|
+      File.open chapter_filename(id), "w" do |file|
         file << text
       end
     end
@@ -229,64 +229,64 @@ module Mint
     def self.chapter_defaults
       {
         locals: {
-          title: 'Untitled'
+          title: "Untitled"
         }
       }
     end
 
     def self.container_defaults
       defaults = {
-        from: 'container.haml',
+        from: "container.haml",
         to: "#{META_DIR}/container.xml",
         locals: {
-          opf_file: 'OPS/content.opf'
+          opf_file: "OPS/content.opf"
         }
       }
     end
 
     def self.content_defaults
       defaults = {
-        from: 'content.haml',
+        from: "content.haml",
         to: "#{CONTENT_DIR}/content.opf",
         locals: {
-          title: 'Untitled',
-          language: 'English',
-          short_title: '',
-          uuid: 'Unspecified',
-          description: 'No description',
+          title: "Untitled",
+          language: "English",
+          short_title: "",
+          uuid: "Unspecified",
+          description: "No description",
           date: Date.today,
-          creators: ['Anonymous'],
+          creators: ["Anonymous"],
           contributors: [],
-          publisher: 'Self published',
-          genre: 'Non-fiction',
-          rights: 'All Rights Reserved',
-          ncx_file: 'toc.ncx',
-          stylesheet: 'style.css',
-          title_file: 'title.html',
+          publisher: "Self published",
+          genre: "Non-fiction",
+          rights: "All Rights Reserved",
+          ncx_file: "toc.ncx",
+          stylesheet: "style.css",
+          title_file: "title.html",
         }
       }
     end
 
     def self.toc_defaults
       defaults = {
-        from: 'toc.haml',
+        from: "toc.haml",
         to: "#{CONTENT_DIR}/toc.ncx",
         locals: {
-          uuid: 'Unspecified',
-          title: 'Untitled',
-          title_file: 'title.html',
+          uuid: "Unspecified",
+          title: "Untitled",
+          title_file: "title.html",
         }
       }
     end
 
     def self.title_defaults
       defaults = {
-        from: 'title.haml',
+        from: "title.haml",
         to: "#{CONTENT_DIR}/title.html",
         locals: {
-          title: 'Untitled',
-          creators: ['Anonymous'],
-          stylesheet: 'style.css'
+          title: "Untitled",
+          creators: ["Anonymous"],
+          stylesheet: "style.css"
         }
       }
     end