broadway 0.0.3.5 → 0.1.0

data/README.markdown

@@ -0,0 +1,155 @@
+<h1>
+  <span>Broadway</span>
+  <span><img src="http://viatropos.github.com/broadway/favicon.png"/></span>
+</h1>
+
+Pluggable, portable, framework-friendly static site generator.  Setting the Stage for the Ruby CMS.
+
+## Usage
+
+### Install
+
+    sudo gem install broadway
+
+#### Test
+
+    rake test
+
+### Structure
+
+Everything uses relative paths from the site root.
+
+    .
+    |-- _config.yml
+    |-- _layouts
+    |-- _posts (generated output)
+    |-- _site (github's place)
+    |-- _source (sinatra application for development)
+    |   |-- files (blog files to-be published)
+    |   |-- posts (blog files)
+    |   |-- lib (sinatra helpers)
+    |   `-- public (sinatra public directory)
+    |-- shared (javascripts, css, media, etc.)
+    |-- index.html
+    |-- robots.txt (what google should ignore)
+    `-- sitemap.xml (google's sitemap from jekyll)
+
+### Run
+
+If you want to use this entirely as a web server, run this at your source root:
+
+    broadway
+    
+If you want to use it inside of Sinatra or Rails, create the site manually:
+
+    site = Broadway.build!
+
+### Models
+
+Broadway uses Site, Post, Asset, File, Link, Slug, and Configuration to solve pretty much everything for creating a fully featured site using just Textmate.
+
+#### The Site
+
+The `Site` is basically the static database.
+
+- It holds a reference to all of your other models.
+- It reads a `_config.yml` file from a directory.
+- Creates `File` objects out of the directory tree.
+- Converts `Files` into `Posts` with slugs, tags, categories, and dates if they fit the profile.
+- Finds `Assets` from within `Posts`.
+- And uses a DSL to build menus out of `Links`.
+
+##### Api
+
+    site = Broadway::Site.new
+    # dynamic finders
+    site.(models) #=> array of all models
+    site.find_(model)_by_(property)(value) #=> first model matching property value
+    site.find_(models)_by_(property)(value) #=> all models matching property value
+    site.find_(model)(attributes) #=> first model matching attributes
+    site.find_(models)(attributes) #=> all models matching attributes
+    site.(model)_roots #=> all hierarchical models without a parent
+
+#### The Post
+
+The `Post` works just like the other static site generators, it is the content input.
+
+- It has `metadata` (YAML header) which defines (nested) key-value attributes.
+- It has a `Slug` based on the folder structure, title, date, and is customizable.
+- It has `tags` defined by `metadata`, which can be scoped (e.g tags by "skill" vs. "favorite")
+- It has `categories` based on the folder structure.
+- It has a `kind`, specifying how the post should be treated (currently `post` or `page`).
+- It has `children` if it is a `page`.
+- It has `Assets` defined by `metadata`, if desired.
+- It has a `date` if a) its title was formatted like `yyyy-mm-dd-title.extension`, or b) metadata has defined a `date` attribute.
+
+##### Api
+
+    post = site.posts.first #=> e.g...
+    post.tags #=> ["ruby", "sinatra", "rails"]
+    post.categories #=> ["path", "to", "post"]
+    post.assets #=> array of Asset objects, if defined
+    post.file #=> associate file object, where all calculations are based
+    post.slug #=> slug calculation object
+    post.path #=> "/path/to/post"
+    post.url #=> "http://site.com/path/to/post"
+    post.kind #=> "page" or "post" (or whatever you define)
+    post.children #=> array of Post objects, if it's a "page"
+    post.title
+    post.data #=> access to everything in the yaml header
+
+### The Configuration
+
+The `Configuration` object is defined from `_config.yml` in the Broadway Site root.
+
+- Nested YAML properties
+- Can be used to store arbitrary data, such as site seo stuff, author, etc.
+- Accessed in views via `c("path.to.attribute")`.
+
+## Context
+
+There are plenty of static site generators out there: [Jekyll](http://github.com/mojombo/jekyll), [Webby](http://github.com/TwP/webby), [Nanoc](http://github.com/ddfreyne/nanoc), [StaticMatic](http://github.com/staticmatic/staticmatic), [Middleman](http://github.com/tdreyno/middleman), [Mercury](http://github.com/jackhq/mercury), [Frank](http://github.com/blahed/frank), [DynamicMatic](http://github.com/nex3/dynamicmatic), [WebGen](http://github.com/gettalong/webgen), [Pekky](http://github.com/lukesutton/pekky), [Awestruct](http://github.com/bobmcwhirter/awestruct), [Massimo](http://github.com/petebrowne/massimo)...  The problem with them is that they are completely separate frameworks from Sinatra and Rails.  They're not meant to be used with either of those.  It's a lot of work to integrate them.
+
+Broadway makes Rails and Sinatra static-compatible.
+
+Why integrate static sites with Rails and Sinatra?
+
+1. So you can write posts in Textmate.
+2. So you can organize your documents and still write complex app code around them.
+3. So you can use all the helpers the frameworks have built in.
+4. So you can use Haml and Sass.
+5. So you can make pretty blogs and still think like a programmer.
+6. So you can host it on Github Pages if you want.
+
+## Tools
+
+- [SeeSaw](http://meetseesaw.com): Convert HTML to HAML, Textile/Markdown to HTML, and lots of other conversions.  Useful for converting html you find on sites to Haml for learning.
+- [Sinatra, HAML, JQuery, Textile (cool blog)](http://blog.peepcode.com/tutorials/2010/about-this-blog).  Random site I thought was cool.
+- [Tilt](http://github.com/rtomayko/tilt)
+
+## Sinatra on Broadway
+
+Here is a [Sinatra + Broadway Example App](http://github.com/viatropos/broadway).
+
+Below is a description on how you might setup a Sinatra app to be themeable and run via markdown files.  TODO.
+
+### Themes
+
+Create a folder called shared/themes/my-theme-name.  In there, create folders for html, touch, and flash.  In the html folder, you need the following
+
+    .
+    |-- index.haml # home page (layout.haml is somewhere else entirely)
+    |-- about
+    |-- blog
+    |-- features
+    |-- demos
+    |-- download
+    |-- support
+    |-- community
+    |-- shared
+    |   |-- stylesheets
+    |   |-- javascripts
+    |   |-- images
+    |   `-- partials
+    |   	|-- _head.haml
+    |   	`-- _header.haml

data/lib/broadway.rb

@@ -1,6 +1,66 @@
-libdir = File.dirname(__FILE__)
-$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+require "rubygems"
+require "active_support"
+require "active_support/core_ext"
+require "fileutils"
+require "time"
+require "yaml"
+require "cgi"
 
-require 'broadway/base'
+# settings
+# require 'cockpit'
+this = File.dirname(__FILE__) + "/broadway"
+require "#{this}/ext"
+requirements = %w(builders processors mixins resources).map { |dir| Dir["#{this}/#{dir}/*"] }
 
-# http://en.wikipedia.org/wiki/Lists_of_musicals
+if defined?(::Sinatra)
+  requirements << Dir["#{this}/sinatra/**/*"]
+end
+
+requirements.flatten.each { |file| require file if File.extname(file) == ".rb" }
+
+module Broadway
+  class << self
+    attr_accessor :site, :generator
+    
+    def build(options = {})
+      process(:build, options)
+    end
+
+    def generator(&block)
+      @generator = block if block_given?
+      @generator
+    end
+    
+    def generate(options = {}, &block)
+      block = generator unless block_given?
+      process(:generate, options, &block)
+    end
+    
+    def process(method, options = {}, &block)
+      self.site ||= Broadway::Site.new(options)
+      self.site.send(method, &block)
+      self.site
+    end
+    
+    def menu!(site, name, &block)
+      Broadway::Processor::Link.menu!(site, name, &block)
+    end
+    
+    # path to views
+    def views
+      site.views_path
+    end
+    
+    def public
+      site.public_path
+    end
+    
+    def index
+      site.index_path
+    end
+  end
+end
+
+def Broadway(*args, &block)
+  Broadway.define!(*args, &block)
+end

data/lib/broadway/{core_ext.rb → ext.rb}

@@ -1,27 +1,45 @@
 class Hash
-  def recursive_symbolize_keys!
+  def recursively_symbolize_keys!
     self.symbolize_keys!
     self.values.each do |v|
       if v.is_a? Hash
-        v.recursive_symbolize_keys!
+        v.recursively_symbolize_keys!
       elsif v.is_a? Array
-        v.recursive_symbolize_keys!
+        v.recursively_symbolize_keys!
       end
     end
     self
   end
 end
 
+class String
+  def taggify(separator = "-", quoted = false)
+    result = self.dup.downcase.strip.gsub(/[^a-z0-9\.]/, separator).squeeze(separator)
+    result = "\"#{result}\"" if quoted && !(result =~ /\s+/).nil?
+    result
+  end
+end
+
 class Array
-  def recursive_symbolize_keys!
+  def recursively_symbolize_keys!
     self.each do |item|
       if item.is_a? Hash
-        item.recursive_symbolize_keys!
+        item.recursively_symbolize_keys!
       elsif item.is_a? Array
-        item.recursive_symbolize_keys!
+        item.recursively_symbolize_keys!
       end
     end
   end
+
+  # separator = ", ",
+  # max = 10_000
+  # quote = true|false
+  def taggify(space = " ", separator = ", ", max = 10_000)
+    quoted = !(separator =~ /\s+/).nil?
+    chop(separator, max) do |word|
+      word.taggify(space, quoted)
+    end.join(separator)
+  end
   
   # http://snippets.dzone.com/posts/show/3486
   def chunk(pieces)
@@ -39,6 +57,22 @@ class Array
   end
 end
 
+class String
+  def nested_parameterize(sep = '-')
+    parameterized_string = self.dup
+    # Turn unwanted chars into the seperator
+    parameterized_string = parameterized_string.gsub(/'/, "").gsub(/[^a-z0-9\-_\+\/]+/i, sep)
+    unless sep.blank?
+      re_sep = Regexp.escape(sep)
+      # No more than one of the separator in a row.
+      parameterized_string.gsub!(/#{re_sep}{2,}/, sep)
+      # Remove leading/trailing separator.
+      parameterized_string.gsub!(/^#{re_sep}|#{re_sep}$/i, '')
+    end
+    parameterized_string.downcase
+  end
+end
+
 class Hash
   # Merges self with another hash, recursively.
   #

data/lib/broadway/filters/erb.rb

@@ -0,0 +1,10 @@
+module Broadway
+  class Erb
+    
+    class << self
+      def transform(content)
+      end
+    end
+    
+  end
+end

data/lib/broadway/filters/haml.rb

@@ -0,0 +1,10 @@
+module Broadway
+  class Haml
+    
+    class << self
+      def transform(content)
+      end
+    end
+    
+  end
+end

data/lib/broadway/filters/liquid.rb

@@ -0,0 +1,14 @@
+module Broadway
+  class Liquid
+    
+    class << self
+      def transform(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.output = Liquid::Template.parse(self.content).render(payload, info)
+      end
+    end
+    
+  end
+end

data/lib/broadway/filters/markdown.rb

@@ -0,0 +1,10 @@
+module Broadway
+  class Markdown
+    
+    class << self
+      def transform(content)
+      end
+    end
+    
+  end
+end

data/lib/broadway/filters/textile.rb

@@ -0,0 +1,11 @@
+module Broadway
+  module Filter
+    class Textile
+      
+      def transform(content)
+        RedCloth.new(content).to_html
+      end
+      
+    end
+  end
+end

data/lib/broadway/migrators/blogger.rb

@@ -0,0 +1,7 @@
+module Broadway
+  module Converter
+    class Blogger
+      
+    end
+  end
+end

data/lib/broadway/migrators/wordpress.rb

@@ -0,0 +1,7 @@
+module Broadway
+  module Converter
+    class Wordpress
+      
+    end
+  end
+end

data/lib/broadway/mixins/assetable.rb

@@ -0,0 +1,48 @@
+module Broadway
+  module Assetable
+    def self.included(base)
+      base.send :include, InstanceMethods
+    end
+    
+    module InstanceMethods
+      def asset_types
+        %w(image video audio asset)
+      end
+      
+      def assets
+        unless @assets
+          @assets = []
+          if self.data.has_key?("asset")
+            @assets << ::Broadway::Asset.new(self, "asset", data["asset"])
+          elsif self.data.has_key?("assets")
+            self.data["assets"].each do |name, asset|
+              @assets << ::Broadway::Asset.new(self, name, asset)
+            end
+          end
+        end
+        
+        @assets
+      end
+      
+      def asset
+        assets.first
+      end
+      
+      def num_assets
+        assets.length
+      end
+      
+      def find_asset_by_name(name)
+        assets.detect { |asset| asset.name == name }
+      end
+      
+      def method_missing(meth, *args, &block)
+        if asset_types.detect { |type| meth.to_s =~ /(\w+)_#{type}/ }
+          find_asset_by_name($1.to_s)
+        else
+          super(meth, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/broadway/mixins/configurable.rb

@@ -0,0 +1,32 @@
+module Broadway
+  module Configurable
+    def self.included(base)
+      base.send :include, InstanceMethods
+    end
+    
+    module InstanceMethods
+      attr_accessor :data
+      
+      # should only read the beginning of the file
+      def configure
+        self.content = file.read
+        
+        if self.content =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
+          self.content = self.content[($1.size + $2.size)..-1]
+          
+          self.data.merge!(YAML.load($1))
+        end
+        
+        self.data ||= {}
+      end
+      
+      def method_missing(meth, *args, &block)
+        if self.data && self.data.has_key?(meth.to_s)
+          self.data[meth.to_s]
+        else
+          super(meth, *args, &block)
+        end
+      end
+    end
+  end
+end