Drop support for specifying paths as plain strings

mhaylock · mhaylock · commit 262acf41d296 · 2015-02-11T00:44:21.000+13:00
This simplifies the implementation code and removes any confusion between single line content and a file path.
diff --git a/README.md b/README.md
@@ -118,11 +118,10 @@ There are two section types you can use to construct a playground in Ruby:
 
 #### `DocumentationSection`
 
-These contain HTML that is rendered within the playground. You can construct a `DocumentationSection` with either a path to an HTML file or the raw HTML content itself (either as a String or an IO object):
+These contain HTML that is rendered within the playground. You can construct a `DocumentationSection` with either an IO object or a string representing the contents of the HTML file:
 
 ```ruby
 # All of the following are valid values for content:
-content = '/path/to/file.html'
 content = Pathname.new('/path/to/file.html')
 content = File.open('/path/to/file.html')
 content = <<-HTML
@@ -145,11 +144,10 @@ The content you provide _must_ be an HTML fragment - if a `<html>`, `<head>` or
 
 #### `CodeSection`
 
-These contain the executable swift code, and each playground must contain at least one of these sections. Constructing these sections is the same as `DocumentationSection` - you can use either a path to a swift file, or the raw swift code itself (either as a String or an IO object):
+These contain the executable swift code, and each playground must contain at least one of these sections. Constructing these sections is the same as `DocumentationSection` - you can use either an IO object or a string representing the contents of the swift file:
 
 ```ruby
 # All of the following are valid values for content:
-content = '/path/to/file.swift'
 content = Pathname.new('/path/to/file.swift')
 content = File.open('/path/to/file.swift')
 content = <<-SWIFT
diff --git a/lib/swift/playground/asset.rb b/lib/swift/playground/asset.rb
@@ -5,7 +5,7 @@ class Playground
     autoload :Javascript, assets_path.join('javascript')
 
     class Asset
-      include Util::PathOrContent
+      include Util::SourceIO
 
       class << self
         protected
@@ -19,7 +19,7 @@ def default_filename(filename = nil)
       attr_accessor :content
 
       def initialize(content, options = {})
-        pathname_or_content = path_or_content_as_io(content)
+        pathname_or_content = source_as_io(content)
         self.content = pathname_or_content.read
 
         filename = options[:filename] || derived_filename(pathname_or_content)
diff --git a/lib/swift/playground/generator.rb b/lib/swift/playground/generator.rb
@@ -4,10 +4,10 @@ module Swift
   class Playground
     class Generator
       class << self
-        include Util::PathOrContent
+        include Util::SourceIO
 
         def generate(markdown, options={})
-          markdown_file = path_or_content_as_io(markdown)
+          markdown_file = source_as_io(markdown)
 
           playground = Playground.new
 
diff --git a/lib/swift/playground/section.rb b/lib/swift/playground/section.rb
@@ -7,7 +7,7 @@ class Playground
     autoload :CodeSection,          sections_path.join('code_section')
 
     class Section
-      include Util::PathOrContent
+      include Util::SourceIO
 
       class TemplateContext
         attr_accessor :content, :number
@@ -68,7 +68,7 @@ def xcplayground(options = nil)
       end
 
       def initialize(content)
-        @content = path_or_content_as_io(content).read
+        @content = source_as_io(content).read
         @content.freeze
       end
 
diff --git a/lib/swift/playground/util.rb b/lib/swift/playground/util.rb
@@ -1,3 +1,3 @@
 require_relative 'util/syntax_highlighting'
 require_relative 'util/pipeline'
-require_relative 'util/path_or_content'
+require_relative 'util/source_io'
diff --git a/lib/swift/playground/util/path_or_content.rb b/lib/swift/playground/util/path_or_content.rb
diff --git a/lib/swift/playground/util/source_io.rb b/lib/swift/playground/util/source_io.rb
@@ -0,0 +1,24 @@
+require 'pathname'
+
+module Swift::Playground::Util
+  module SourceIO
+    def source_as_io(source)
+      # Return path_or_content if it is an IO-like object
+      return source if source.respond_to?(:read)
+
+      unless source.is_a?(String)
+        raise "You must provide either a String or an IO object when constructing a #{self.class.name}."
+      end
+
+      StringIO.new(source)
+    end
+
+    def derived_filename(source)
+      if source.respond_to?(:basename)
+        source.basename.to_s
+      elsif source.respond_to?(:path)
+        File.basename(source.path)
+      end
+    end
+  end
+end
