broadway 0.0.3 → 0.0.3.2

data/Rakefile

@@ -14,7 +14,7 @@ RAILS_ROOT = File.dirname(__FILE__)
 spec = Gem::Specification.new do |s|
   s.name              = "broadway"
   s.author            = "Lance Pollard"
-  s.version           = "0.0.3"
+  s.version           = "0.0.3.2"
   s.date              = "Mon Mar 22 20:12:47 -0700 2010"
   s.summary           = "Write Posts in Textile and Markdown, built it into a Rails or Sinatra Blog"
   s.homepage          = "http://github.com/viatropos/broadway"

data/lib/broadway/base.rb

@@ -29,6 +29,7 @@ require "redcloth"
 $:.push(File.dirname(__FILE__))
 require "core_ext"
 require "convertible"
+require "resource"
 require "site"
 require "asset"
 require "page"

data/lib/broadway/convertible.rb

@@ -24,10 +24,9 @@ module Broadway
         end
         self.content = self.content[($1.size + $2.size)..-1]
       end
-      self.render(site.layouts, site.site_payload)
-      output = self.output
+      result = self.render(site.layouts, site.site_payload)
       self.content = self.output = nil
-      output
+      result
     end
     
     # Read the YAML frontmatter
@@ -45,6 +44,8 @@ module Broadway
       
         self.data.merge!(YAML.load($1))
       end
+      
+      self.data ||= {}
     end
     
     # Transform the contents based on the file extension.
@@ -82,16 +83,9 @@ module Broadway
     # Returns nothing
     def do_layout(payload, layouts)
       info = { :filters => [], :registers => { :site => self.site } }
-      
       # render and transform content (this becomes the final content of the object)
       payload["content_type"] = self.content_type
-      self.content = Liquid::Template.parse(self.content).render(payload, info)
-      
-      # TODO FIX
-#      self.transform
-
-      # output keeps track of what will finally be written
-      self.output = self.content
+      self.output = Liquid::Template.parse(self.content).render(payload, info)
     end
   end
 end

data/lib/broadway/page.rb

@@ -1,11 +1,9 @@
 module Broadway
 
   class Page
+    include Comparable
     include Convertible
-
-    attr_accessor :site, :position # order
-    attr_accessor :name, :ext, :basename, :dir, :path, :slug
-    attr_accessor :data, :content, :output, :categories, :tags, :children
+    include Resource
     
     # Initialize a new Page.
     #   +site+ is the Site
@@ -19,66 +17,16 @@ module Broadway
       self.path = options[:path] if options.has_key?(:path)
       self.data = {}
       self.dir = path =~ /\// ? File.dirname(path.gsub(/#{site.config[:source]}\/?/, "")).gsub(/^\//, "") : path
-      base = self.dir == "." ? "" : File.basename(self.dir)
-      self.name = base
+      self.slug = self.dir == "." ? "" : File.basename(self.dir)
       self.ext = File.extname(path)
       self.basename = File.basename(path).split('.')[0..-2].first
 
       self.categories ||= []
-      self.categories.concat base.split('/').reject { |x| x.empty? }
+      self.categories.concat self.slug.split('/').reject { |x| x.empty? }
       self.children ||= []
       process(options) unless options.has_key?(:process) and options[:process] == false
     end
     
-    def children
-      @children = site.find_pages_by_category(self.categories.last) + site.find_posts_by_category(self.categories.last)
-      @children.delete_if {|i| i.url == self.url}
-    end
-    
-    # The UID for this post (useful in feeds)
-    # e.g. /2008/11/05/my-awesome-post
-    #
-    # Returns <String>
-    def id
-      File.join(self.dir, self.name)
-    end
-    
-    def menu_title
-      self.data && self.data['menu_title']
-    end
-    
-    def tooltip
-      self.data && self.data["tooltip"]
-    end
-    
-    def permalink
-      self.data && self.data['permalink']
-    end
-    
-    def show_children?
-      return true if self.data.nil?
-      if self.data.has_key?("show_children")
-        return self.data["show_children"] == "true" || self.data["show_children"] == true
-      end
-      return true
-    end
-    
-    def title
-      self.data && (self.data['title'] || self.name)
-    end
-    
-    def excerpt
-      self.data && self.data['excerpt']
-    end
-    
-    def parent
-      url ? site.find_page_by_url(url[1..-1].split("/").first) : nil
-    end
-    
-    def layout
-      self.data and self.data.has_key?("layout") ? self.data["layout"] : self.categories.first
-    end
-    
     # The generated relative url of this page
     # e.g. /about
     #
@@ -86,7 +34,7 @@ module Broadway
     def url
       return permalink if permalink
       @url ||= {
-        "name"      => CGI.escape(name),
+        "slug"      => CGI.escape(slug),
         "categories" => categories[0..-2].join('/')
       }.inject(template) { |result, token|
         result.gsub(/:#{token.first}/, token.last)
@@ -95,60 +43,28 @@ module Broadway
     
     def template
       if self.site.permalink_style == :pretty
-        "/:categories/:name"
+        "/:categories/:slug"
       else
-        "/:categories/:name.html"
+        "/:categories/:slug.html"
       end
     end
     
     def <=>(other)
       return self.position <=> other.position
     end
-    
-    # Extract information from the page filename
-    #   +name+ is the String filename of the page file
-    #
-    # Returns nothing
-    def process(options = {})
-      self.read_yaml(path)
-      
-      self.tags = self.data.pluralized_array("tag", "tags")
-    end
 
     # Add any necessary layouts to this post
-    #   +layouts+ is a Hash of {"name" => "layout"}
+    #   +layouts+ is a Hash of {"slug" => "layout"}
     #   +site_payload+ is the site payload hash
     #
     # Returns nothing
     def render(layouts, site_payload)
-      payload = {"page" => self.data}.deep_merge(site_payload)
+      payload = {"page" => self.data, "site" => {}}.deep_merge(site_payload)
       do_layout(payload, layouts)
     end
 
-    # Write the generated page file to the destination directory.
-    #   +dest_prefix+ is the String path to the destination dir
-    #   +dest_suffix+ is a suffix path to the destination dir
-    #
-    # Returns nothing
-    def write(dest_prefix, dest_suffix = nil)
-      dest = File.join(dest_prefix, @dir)
-      dest = File.join(dest, dest_suffix) if dest_suffix
-      FileUtils.mkdir_p(dest)
-
-      # The url needs to be unescaped in order to preserve the correct filename
-      path = File.join(dest, CGI.unescape(self.url))
-      if self.ext == '.html' && self.url[/\.html$/].nil?
-        FileUtils.mkdir_p(path)
-        path = File.join(path, "index.html")
-      end
-
-      File.open(path, 'w') do |f|
-        f.write(self.output)
-      end
-    end
-
     def inspect
-      "#<Broadway:Page @url=#{self.url.inspect} @name=#{self.name.inspect} @categories=#{self.categories.inspect} @tags=#{self.tags.inspect} @data=#{self.data.inspect}>"
+      "#<Broadway:Page @url=#{self.url.inspect} @slug=#{self.slug.inspect} @categories=#{self.categories.inspect} @tags=#{self.tags.inspect} @data=#{self.data.inspect}>"
     end
   end
 

data/lib/broadway/post.rb

@@ -3,10 +3,11 @@ module Broadway
   class Post
     include Comparable
     include Convertible
+    include Resource
     
     SRC_MATCHER = /^(.+\/)*(?:(\d+-\d+-\d+)-)?(.*)(\.[^.]+)$/
     URL_MATCHER = /^(.+\/)*(.*)$/
-
+    
     # Post name validator. Post filenames must be like:
     #   2008-11-05-my-awesome-post.textile
     #
@@ -15,12 +16,6 @@ module Broadway
       site.config[:posts_include].include?(File.extname(name))
     end
     
-    attr_accessor :site
-    # where the file is
-    attr_accessor :path, :dir, :name, :basename, :ext
-    attr_accessor :data, :content, :output, :position # order
-    attr_accessor :date, :slug, :published, :tags, :categories, :asset
-    
     # Initialize this Post instance.
     #   +site+ is the Site
     #   +base+ is the String path to the dir containing the post file
@@ -40,38 +35,11 @@ module Broadway
       self.ext = ext
       self.dir = options.has_key?(:dir) ? options[:dir] : File.dirname(path.gsub(/#{site.config[:source]}\/?/, ""))
       base = self.dir == "." ? "" : File.basename(self.dir)
-      self.name = base
       self.categories = base.split('/').reject { |x| x.empty? }
 
-      process(options) unless options.has_key?(:process) and options[:process] == false
+      process(options)
     end
     
-    # Extract information from the post filename
-    #   +name+ is the String filename of the post file
-    #
-    # Returns nothing
-    def process(options = {})
-      self.read_yaml(path)
-      
-      # If we've added a date and time to the yaml, use that instead of the filename date
-      # Means we'll sort correctly.
-      self.date = Time.parse(self.data["date"].to_s) if self.data.has_key?('date')
-      
-      if self.data.has_key?('published') && self.data['published'] == false
-        self.published = false
-      else
-        self.published = true
-      end
-      
-      if self.data.has_key?("asset")
-        data["asset"]["title"] ||= self.title
-        self.asset = Asset.new(data["asset"])
-      end
-      
-      self.tags = self.data.pluralized_array("tag", "tags")
-      self.tags ||= []
-    end
-
     # Spaceship is based on Post#date, slug
     #
     # Returns -1, 0, 1
@@ -83,39 +51,6 @@ module Broadway
       end
     end
     
-    # The UID for this post (useful in feeds)
-    # e.g. /2008/11/05/my-awesome-post
-    #
-    # Returns <String>
-    def id
-      File.join(self.dir, self.slug)
-    end
-    
-    def parent
-      url ? site.find_page_by_url(url[1..-1].split("/").first) : nil
-    end
-    
-    def layout
-      self.data and self.data.has_key?("layout") ? self.data["layout"] : self.categories.first
-    end
-    
-    # The full path and filename of the post.
-    # Defined in the YAML of the post body
-    # (Optional)
-    #
-    # Returns <String>
-    def permalink
-      self.data && self.data['permalink']
-    end
-    
-    def title
-      self.data && (self.data['title'] || self.slug)
-    end
-    
-    def excerpt
-      self.data && self.data["excerpt"]
-    end
-    
     def template
       case self.site.permalink_style
       when :pretty
@@ -152,42 +87,15 @@ module Broadway
     #
     # Returns nothing
     def render(layouts, site_payload)
-      # construct payload
-      payload =
-      {
-        "site" => {},
-        "page" => self.to_liquid
-      }
-      payload = payload.deep_merge(site_payload)
-
+      payload = {"site" => {}, "page" => self.to_liquid}.deep_merge(site_payload)
       do_layout(payload, layouts)
     end
 
-    # Write the generated post file to the destination directory.
-    #   +dest+ is the String path to the destination dir
-    #
-    # Returns nothing
-    def write(dest)
-      FileUtils.mkdir_p(File.join(dest, dir))
-
-      # The url needs to be unescaped in order to preserve the correct filename
-      path = File.join(dest, CGI.unescape(self.url))
-
-      if template[/\.html$/].nil?
-        FileUtils.mkdir_p(path)
-        path = File.join(path, "index.html")
-      end
-
-      File.open(path, 'w') do |f|
-        f.write(self.output)
-      end
-    end
-
     # Convert this post into a Hash for use in Liquid templates.
     #
     # Returns <Hash>
     def to_liquid
-      { "title"      => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
+      { "title"      => self.title || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
         "url"        => self.url,
         "date"       => self.date,
         "id"         => self.id,

data/lib/broadway/resource.rb

@@ -0,0 +1,121 @@
+module Broadway::Resource
+  
+  def self.included(base)
+    base.class_eval do
+      include InstanceMethods
+    end
+  end
+  
+  module InstanceMethods
+    attr_accessor :site, :position # order
+    # where the file is
+    attr_accessor :path, :dir, :basename, :ext, :title
+    attr_accessor :data, :content, :output
+    attr_accessor :date, :slug, :published, :categories, :asset
+    
+    # Extract information from the post filename
+    #   +name+ is the String filename of the post file
+    #
+    # Returns nothing
+    def process(options = {})
+      return if options.has_key?(:process) and options[:process] == false
+      
+      self.read_yaml(path)
+      
+      self.title = data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' ')
+      
+      # If we've added a date and time to the yaml, use that instead of the filename date
+      # Means we'll sort correctly.
+      self.date = Time.parse(self.data["date"].to_s) if self.data.has_key?('date')
+      
+      if self.data.has_key?('published') && self.data['published'] == false
+        self.published = false
+      else
+        self.published = true
+      end
+      
+      if self.data.has_key?("asset")
+        data["asset"]["title"] ||= self.title
+        self.asset = ::Broadway::Asset.new(data["asset"])
+      end
+      
+      self.tags = self.data["tags"]
+      self.tags ||= []
+    end
+    
+    def children
+      @children = site.find_pages_by_category(self.categories.last) + site.find_posts_by_category(self.categories.last)
+      @children.delete_if {|i| i.url == self.url}
+    end
+    
+    # The UID for this post (useful in feeds)
+    # e.g. /2008/11/05/my-awesome-post
+    #
+    # Returns <String>
+    def id
+      File.join(self.dir, self.slug)
+    end
+    
+    def menu_title
+      self.data['menu_title'] || self.title
+    end
+    
+    def tooltip
+      self.data["tooltip"]
+    end
+    
+    def permalink
+      self.data['permalink']
+    end
+    
+    def excerpt
+      self.data['excerpt']
+    end
+    
+    def show_children?
+      return true if self.data.nil?
+      if self.data.has_key?("show_children")
+        return self.data["show_children"] == "true" || self.data["show_children"] == true
+      end
+      return true
+    end
+    
+    def parent
+      url ? site.find_page_by_url(url[1..-1].split("/").first) : nil
+    end
+    
+    def layout
+      self.data and self.data.has_key?("layout") ? self.data["layout"] : self.categories.first
+    end
+    
+    def tags=(value)
+      @tags = case value
+      when Hash
+        value = value.each { |k, v| value[k] = tag_array(v) }
+      else
+        {"tags" => tag_array(value)}
+      end
+    end
+    
+    # tags can be stored under multiple contexts
+    # default is "tags" (use "categories" or whatever else you want)
+    def tags(context = "tags")
+      @tags[context.to_s]
+    end
+    
+    private
+    
+      # helper method to convert tags to arrays
+      def tag_array(value)
+        result = case value
+        when String
+          value.split(",\s+")
+        when Array
+          value
+        end
+        result
+      end
+    
+  end
+  
+end

metadata

@@ -6,7 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 0
   - 3
-  version: 0.0.3
+  - 2
+  version: 0.0.3.2
 platform: ruby
 authors: 
 - Lance Pollard
@@ -76,6 +77,7 @@ files:
 - lib/broadway/page.rb
 - lib/broadway/post.rb
 - lib/broadway/rails.rb
+- lib/broadway/resource.rb
 - lib/broadway/runner.rb
 - lib/broadway/sinatra/base.rb
 - lib/broadway/sinatra/helpers/collection_helper.rb