static 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+== 1.0.0 / 2007-04-17
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,32 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/static
+bin/cli.rbml
+lib/static.rb
+lib/collection.rb
+lib/filebase.rb
+lib/page.rb
+lib/site.rb
+lib/static.rb
+lib/xhtml.rb
+lib/generator.rb
+lib/extentions/class.rb
+lib/extentions/string.rb
+templates/page.copy
+templates/site.map
+templates/site.info
+templates/submenu.copy
+templates/disco/attributes
+templates/disco/display
+templates/disco/publish
+templates/disco/link_list
+templates/layouts/default/contents.erbml
+templates/layouts/default/main_navigation.erbml
+templates/layouts/default/page_head.erbml
+templates/layouts/default/submenu.erbml
+templates/layouts/default/structure/default.rbml
+templates/layouts/default/structure/footer.rbml
+templates/layouts/default/stylesheets/default.css
+

data/README.txt

@@ -0,0 +1,254 @@
+static
+    by evan short
+
+== DESCRIPTION:
+  
+static is a command line environment for creating static websites.
+it uses a yaml site map to produce a blueprint with decoupled copy
+and structure.  uses rbml for html processing. static incorporates
+arbitrary collections that can be displayed both within a page and
+paginated over a page. this allows such features as news, faqs,
+blogs and other galleries.
+
+== FEATURES:
+- command line interface
+- multiple site management
+- yaml site map
+- decoupled copy and structure
+  - flexible, sectioned copy
+  - html in block-syntax
+- collections
+  - inner-page, such as news on a home page
+  - paginated, a blog, for instance
+- plain ol' css for style
+
+== PROBLEMS:
+
+- cli needs some work
+  - prompt context
+  - tab completion
+  - termios integration (or otherwise implemented command history)
+  - error messaging
+- documentation
+  - how layouts work
+  - how blueprints work
+- word is out on how well it takes to switching the site map. my
+own guess is not well.
+- there are no specs
+- ready for a re-factor
+
+== SYNOPSIS:
+
+so, first thing's first open up a terminal and run static. the first
+time it is run a folder called +static+ will be created in your ~/.
+in this folder your layouts and projects will be kept, along with a
+few template files in <tt>.templates</tt> that will be used when
+creating a site.
+
+=== site generation
+
+you will see a prompt: <tt>-></tt>
+
+  -> start sample site
+  starting a site map for sample
+
+at this point the footprint of your site (named sample in this example) 
+has been created. a sitemap is generated from the site.map template
+in the static home (~/static). initially this is populated with an
+example map, but can be re-formatted or emptied if you choose.
+
+  -> edit site.map
+
+this will open the previously mentioned site map in vi. there is a
+variable to change editors but, currently, no place to actually do
+it. sue me. i'll get to it soon.
+
+after the site map has been exited the pages are loaded into memory
+and you can then begin to build your site.
+
+  -> build
+
+or
+  
+  -> build copy
+
+will generate the .copy yaml files that will hold the contents of each
+page in your site map. you may then run
+
+  -> edit copy
+
+to edit the contents of those pages. more desireably, perhaps, you may
+zip this folder up and send it off to someone more suited to edit copy.
+
+next you must choose a layout. 
+
+  -> layout
+
+will give you a choice of the possible layouts. by default there is only
+one layout available. you may copy the default layout in the static home
+to create new layouts. there are plans to incorporate some of this into
+the cli. not yet, however.
+
+because there is only one layout available by default, running +layout+
+will choose it for you. if there were more than one you could run +layout+
+with a regex for the layout you would like to choose (or  not) and then
+make a choice from the resulting list. choices in lists may be made by
+regex or number selection. no word on what happens if there are numbers
+in your possible selections.
+
+as an example, because the word 'regex' can be frightening to some, i might
+use <tt>layout def</tt> to find the default layout in a long list of selections.
+
+once a layout is chosen it is possible to make edits to it before building
+the basic structure of the site, called the blueprint. you may run
+
+  -> edit layout
+
+to make changes to the layout you have chosen.
+
+once the layout is satisfactory, running
+
+  -> build blueprint
+
+will put the blueprint folder in place.
+
+  -> edit blueprints
+
+will take you there to edit. 
+
+at this point you may generate your site by running
+
+  -> generate
+
+you may edit your site and generate as many times as you like.
+by default (not easily changable at the moment) your site will be
+generated to ~/Sites/static/name_of_site. 
+
+use
+  
+  -> load site
+
+(which uses the choice module) to load a site or make a different 
+site active. you may simply use +load+ if there is not already an
+active site.
+
+== collection managment
+
+once a site has been started that site will be active. once there is
+an active site you may begin dealing with collections. to start a 
+collection 
+
+  -> start faq collection with question answer
+
+this will start a collection named faq with the attributes question and
+answer.
+
+because there is already an active site, the +collection+ key 
+is assumed and therefore sugar. +with+ is purely sugar.
+
+the faq collection is now active (as it was just started and no other
+collection has been loaded). you may run
+
+  -> edit attributes
+
+to edit the yaml file describing the attributes
+
+  -> edit display
+
+to edit the default way a member of the collection is displayed
+
+and
+
+  -> add
+
+to add an item to the collection. it is worth noting that the attribute
+files are processed by erb before they make it to your editor. so in the
+event you had a +date+ attribute in a collection, using +edit attributes+
+to make <tt>date: <%= Date.today.to_s.inspect %></tt> will start each
+added item with today's date ready for yaml.
+
+to show a collection within a page add a line like
+
+  display 5, :faq
+
+on the blueprint of the desired page. display also responds to :all in place
+of the number.
+
+to paginate a collection over a particular page you must assign the 
+collection to the page. 
+
+  -> assign
+
+will ask you first which collection you would like to choose and then which
+page. because each page is only allowed to be paginated once your choices
+will be limited to those that have not already been paginated. you may use
+-c or --collection to regex for a desired collection.
+likewise with -p and --page.
+
+you may also run +assign paginate+ with the same possible flags to paginate
+the collection automatically after the association.
+
+after associating the collection and the page you may use
+
+  -> paginate
+
+and then
+
+  -> generate
+
+to update the pages. in the future there should probably be a more direct
+way to generate over only paginated pages.
+
+in order to see the paginated items on the desired page simply add the line
+
+  include_partial
+
+where you would like the paginated section of your collection to be included.
+to use the link list generated include the line
+
+  get :page, :collection_name => :links
+
+<tt>:page</tt> is short for 'this page that we are in'. if you would like to
+be moroe explicit (or use the list elsewhere) simply put in the file name of
+the page (which would be the page name you gave it in the site map formatted
+as a lower-case symbol) as such:
+
+  get :page_name, :collection_name => :links
+
+there is much more to say, but a lot of it can be gleaned by looking at the
+stuff that is generated by default. any questions may be directed to
+
+  evan.short @ pleasedontspam. gmail.please
+
+== REQUIREMENTS:
+
+rbml v. 0.0.5.9.4.1
+
+== INSTALL:
+
+sudo gem install static
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007 Evan Short
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/static.rb'
+
+Hoe.new('static', Static::VERSION) do |p|
+  p.rubyforge_name = 'static'
+  # p.summary = 'FIX'
+  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/bin/cli.rbml

@@ -0,0 +1,245 @@
+cli :name=>"static", :prompt=>"-> " do
+  set :help do
+    helpdocs
+  end
+
+  set :unknown_command do |method, args|
+    puts "command not found: #{method} \nwith args: #{args.join(' ')}"
+  end
+  
+  set :start do |args|
+    key(:site){ @active = :site }
+    key(:collection){ @active = :collection }
+    key(:with)
+    flag(:help => 'h'){ puts "helpdocs for 'start' go here" }
+
+    process(args)
+    name = (remaining_argument == '' ? '.' : remaining_argument)
+    @active = ($active_site ? :collection : :site) unless @active
+
+    case @active
+    when :site
+      $active_site = start_site(name)
+      if $active_site
+        puts "starting a site map for #{$active_site.name}"
+      else
+        puts "looks like there is already a site called #{name}"
+      end
+    when :collection
+      if $active_site
+        name = remaining_arguments.shift
+        $active_collection = start_collection(name, remaining_arguments)
+        if $active_collection 
+          puts "#{name} collection is active"
+        else
+          puts "looks like there is already a collection called #{name}"
+        end
+      else
+        puts 'gotta have a site to make a collection'
+      end
+    end
+  end
+  
+  set :assign do |args|
+    flag(:page => 'p'){ |name|
+      @page = choice('please choose a page:', @possible_pages, name.downcase)
+    }
+    flag(:collection => 'c'){ |name|
+      @collection = load_collection(choice('please choose a collection:', items_under($active_site.home+'collections')[:folders], name.downcase))
+    }
+    key(:paginate){@paginate = true}
+
+    if $active_site 
+      ready = exists? :folder, $active_site.home+'blueprint'
+      if ready
+        @possible_pages = []
+        $active_site.pages.each{ |page| @possible_pages << page unless $active_site.info['paginate'] && $active_site.info['paginate'].keys.include?(page.file_name) }
+        process(args)
+          
+        @collection ||= load_collection(choice('please choose a collection:', items_under($active_site.home+'collections')[:folders]))
+        puts "\n  - - - \n" unless @page
+        @page       ||= choice('please choose a page:', @possible_pages)
+        assign_pagination @collection.file_name, @page.file_name
+        paginate @page.file_name if @paginate
+      else
+        puts 'please build a blueprint paginating collections'
+      end
+    else
+      ready ? message : 'please choose a site'
+    end
+  end
+
+  set :paginate do |name|
+    @page = choice('which page did you mean?', $active_site.info['paginate'].keys, name) if name
+    if exists? :folder, $active_site.home+'blueprint'
+      if @page
+        paginate @page 
+      else
+        $active_site.info['paginate'].each { |page, collection| paginate page }
+      end
+    else
+      puts 'please generate your blueprint before paginating'
+    end
+  end
+
+  set :layout do |args|
+    key(:choose) { @active = :choose }
+    key(:save) { @active = :choose }
+    flag(:force => 'f'){ @force = true }
+    process args
+    name = (remaining_argument == '' ? '.' : remaining_argument)
+    @active = :choose unless @active
+    case @active
+    when :choose
+      if $active_site
+        if set_layout choice('please choose a layout:', items_under($ENV['LAYOUT_HOME'])[:folders], name), @force
+          puts "#{$active_site.info['layout']['name']} is now being used" else puts 'no new layout was chosen'
+        end
+      else
+        puts 'there is no active site right now.'
+      end
+    end
+  end
+
+  set :edit do |args|
+    key(:site)
+    key(:attributes){
+      @collection = $active_collection.name unless @collection
+      @edit << :attributes
+    }
+    key(:display){
+      @collection = $active_collection.name unless @collection
+      @edit << :display
+    }
+    key(:all){
+      @collection = $active_collection.name unless @collection
+      @edit = [:attributes, :display]
+    }
+    flag(:collection => 'c'){ |name| @collection = name }
+    
+    @edit = []
+    process args
+    file = remaining_argument
+    file = 'contents' if  file == 'copy'
+
+    if $active_site
+      case
+      when @collection
+        @edit.each { |item|
+          puts "opening #{@collection}'s attributes"
+          edit("#{$active_site.home}collections/#{@collection}/#{item.to_s}")
+        }
+      when exists?(:file, "#{$active_site.home}project_info/#{file}") then
+        puts "opening #{$active_site.name}'s #{file}"
+        edit("#{$active_site.home}project_info/#{file}") 
+        $active_site.load_info(file)
+        $active_site.load_pages if file == 'site.map'
+      when exists?(:any, $active_site.home+file) : edit($active_site.home+file)
+      else
+        puts "no file found: #{$active_site.home}"
+      end
+    else
+      puts 'no active site'
+    end
+  end
+  
+  set :load do |args|
+    key(:site){ @active = :site }
+    key(:collection){ @active = :collection }
+
+    flag(:help => 'h'){ puts "helpdocs for 'load' go here" }
+
+    process(args)
+    name = (remaining_argument == '' ? '.' : remaining_argument)
+    @active = $active_site ? :collection : :site unless @active
+
+    case @active
+    when :site then
+      $active_site = load_site(name)
+      if $active_site 
+        puts "#{$active_site.name} site is active" 
+      else
+        $active_site = load_site(choice('available sites', items_under($ENV['SITE_BANK'])[:folders], name))
+        puts 'sorry bub, nuthin there.' unless $active_site
+      end
+    when :collection then
+      $active_collection = nil
+      if $active_site
+        $active_collection = load_collection(name)
+        if $active_collection
+          puts("#{$active_collection.name} collection is active")
+        else
+          $active_collection = load_collection(choice('available collections', items_under($active_site.home+'collections')[:folders], name))
+          unless $active_collection
+            puts 'can\'t find a collection like that, baby' 
+          else
+            puts("#{$active_collection.name} collection is active")
+          end
+        end
+      else
+        puts 'there must be an active site before starting a collection'
+      end
+    end
+  end
+
+  set :generate do
+    ready = exists? :folder, $active_site.home+'layout'
+    message = 'please choose a layout before generating html' unless ready
+    if ready
+      ready = exists? :folder, $active_site.home+'blueprint'
+      message = 'please build a blueprint before generating html' unless ready
+      if ready
+        ready = exists? :folder, $active_site.home+'contents'
+        message = 'please build the site content before generating html' unless ready
+      end
+    end
+    if $active_site
+      if ready 
+         destroy $active_site.site_loc
+         $active_site.generate 
+      else
+         puts(message)
+      end
+    else
+      puts 'need a site before you can generate one'
+    end
+  end
+
+  set :add do |args|
+    edit $active_collection.add_entry
+    $active_collection.sanitize_listing
+    $active_collection.save_listing
+  end
+
+  set :build do |args|
+    key(:copy){ @active = :contents }
+    key(:contents){ @active = :contents }
+    key(:blueprint){ @active = :blueprint }
+    key(:all){ @active = :all }
+    flag(:force => 'f'){ @force = true }
+    process args
+    @active = :contents unless @active
+    case @active
+    when :contents then
+      destroy $active_site.home+'contents' if @force
+      $active_site.build(:contents)
+    when :blueprint then
+      destroy $active_site.home+'blueprint' if @force
+      $active_site.info['layout'] ? $active_site.build(:blueprint) : puts('need to choosee a layout')
+    when :all then
+      destroy $active_site.home+'blueprint' if @force
+      destroy $active_site.home+'contents' if @force and not make_sure('do you want to destroy the contents?', 'N', 'y')
+      $active_site.build(:contents)
+      $active_site.info['layout'] ? $active_site.build(:blueprint) : set_layout(choice('please choose a layout:', items_under($ENV['LAYOUT_HOME'])[:folders]), false)
+      $active_site.build(:blueprint) unless exists? :folder, $active_site.home+'blueprint'
+    end
+  end
+  
+  set :clear do
+    system 'clear'
+  end
+
+  set :quit do
+    exit
+  end
+end

data/bin/static

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__)+'/../lib/static'
+
+
+$ENV['STATIC_HOME'] = "#{ENV['HOME']}/static/"
+$ENV['STATIC_VIEWING'] = "#{ENV['HOME']}/Sites/static/"
+$ENV['REPO_HOME'] = $ENV['STATIC_HOME']+'/repos/'
+$ENV['SITE_BANK'] = $ENV['STATIC_HOME']+'projects/'
+$ENV['TEMPLATE_HOME'] = $ENV['STATIC_HOME']+'.templates/'
+$ENV['LAYOUT_HOME'] = $ENV['STATIC_HOME']+'layouts/'
+$ENV['SCRIPT_HOME'] = $ENV['STATIC_HOME']+'lib/'
+$ENV['TEMPLATE_BANK'] = File.dirname(__FILE__)+'/../templates'
+
+
+include FileBase
+
+#destroy $ENV['STATIC_HOME']
+#destroy $ENV['STATIC_VIEWING']
+
+mkdir $ENV['STATIC_HOME'] unless exists? :folder, $ENV['STATIC_HOME']
+mkdir $ENV['SITE_BANK'] unless exists? :folder, $ENV['SITE_BANK']
+
+copy File.dirname(__FILE__)+'/../templates',  $ENV['TEMPLATE_HOME'] unless exists? :folder, $ENV['TEMPLATE_HOME']
+move $ENV['TEMPLATE_HOME']+'layouts', $ENV['LAYOUT_HOME'] unless exists? :folder, $ENV['LAYOUT_HOME']
+puts "home: #{$ENV['STATIC_HOME']}"
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))+'/lib/rbml')
+$LOAD_PATH.unshift($ENV['STATIC_HOME'])
+
+module Rbml
+  module Language
+    module Cli
+      module Cli
+        include Static
+
+        def helpdocs
+          puts 'these are the ellhp.'
+        end
+        def edit file
+          system "#{$ENV['EDITOR']} #{file}"
+        end
+      end
+    end
+  end
+end
+
+include Static
+::Rbml::Processor.run(File.dirname(__FILE__)+'/cli.rbml')
+
+__END__
+$active_site = load_site('please')
+paginate :static
+
+$active_site.build :all
+#system "#{$ENV['EDITOR']} #{$active_site.home}"
+paginate :the_copy
+destroy $active_site.site_loc
+$active_site.generate
+
+$active_site = start_site('static')
+$active_site.load_info
+$active_site.load_pages
+$active_site.start_collection 'news', ['date', 'headline', 'entry']
+$active_site.start_collection 'blog', ['date', 'title', 'entry']
+
+$active_site.build(:contents)
+$active_site.info['layout'] = 'default'
+set_layout($active_site.info['layout'], false)
+$active_site.build(:blueprint)
+
+assign_pagination :blog, :the_blueprint
+#$active_collection = load_collection 'faq'
+::Rbml::Processor.run(File.dirname(__FILE__)+'/cli.rbml')
+#system "vi #{$active_collection.add_entry}"
+#$active_collection.save_listing
+#$active_site.build :contents
+#$active_site.set_layout('default', $ENV['LAYOUT_HOME'])
+#$active_site.build :blueprint
+#$active_site.start_collection 'faq', ['question', 'answer']
+destroy $active_site.site_loc
+$active_site.generate