yuzu 0.2.1.pre → 0.2.1

data/ChangeLog.md

@@ -1,5 +1,15 @@
 # ChangeLog
 
+2013-02-12     William Martin <william.martin@anomalus.com>
+
+The initial release of the gem was faulted and failed critically. This change includes many fixes and additions to the project creation mechanism.
+
+* Version bump to 0.2.1.pre
+* Improved sample project handling
+* Resolved missing requires
+* Bug fixes
+
+
 2013-02-09     William Martin <william.martin@anomalus.com>
 
 Major refactoring work to update the project. It's a shame that I didn't keep this change under more fine-grained source control, but it was such a drastic re-architecting that it seemed ok to get the infrastructure in place then add features and bugfixes later.

data/README.md

@@ -2,6 +2,18 @@ Yuzu is a blog-aware, static-website generator and publisher that builds an HTML
 
 For an example of a site rendered with Yuzu, see [Spatial Pixel](http://spatialpixel.com).
 
+
+## Quick Start (Mac)
+
+1. `mkdir ~/Documents/yuzu-project`
+2. `cd ~/Documents/yuzu-project`
+3. `yuzu create`
+4. `yuzu preview`
+5. Go go file:///Users/username/Sites/yuzu-project/index.html
+
+For Linux, change `/Users` to `/home`
+
+
 ## Current Features
 
 * Website generation from a folder of text files (Markdown, plain text, HAML, and more) with minimal additional configuration.
@@ -11,8 +23,8 @@ For an example of a site rendered with Yuzu, see [Spatial Pixel](http://spatialp
 * Catalogs: A list of files can be gathered, rendered, and paginated on any page.
 * Widget-like components like photo galleries and breadcrumbs.
 * Uses Compass and Less for SASS (or SCSS) to CSS.
-* A blog folder for more blog-like content, supporting categories, recent posts, RSS feeds.
-* Automatic index.html file generation for folders.
+* A blog folder for periodical content, supporting categories, recent posts, RSS feeds.
+* Automatic index.html file generation for folders containing a rendered catalog of the folder's contents.
 * On Mac: image thumbnail generation.
 
 
@@ -32,11 +44,11 @@ Yuzu first came about from the need to publish lecture material for online cours
 
 ## Sample Workflow (Mac)
 
-1. Edit your Markdown content files
+1. Edit your Markdown content files in your favorite text editor
 2. Open a terminal
-3. `cd ~/Documents/yuzu-projects/project-folder`
+3. `cd ~/Documents/yuzu-project`
 4. `yuzu preview`
-5. View in a web browser: `http://localhost/~username/project-folder`
+5. View in a web browser (with Web Sharing enabled): `http://localhost/~username/project-folder`
 6. Publish to the web: `yuzu publish`
 
 

data/docs/GettingStarted.md

@@ -15,6 +15,12 @@ Using yuzu requires some familiarity with using a terminal application. On a Mac
 
     yuzu create
 
+5. Render the site
+
+    yuzu preview
+
+This last step renders the site and copies it to the default location, which in this case would be `~/Sites/my-yuzu-project`. To change this location, edit `config/yuzu.yml`.
+
 
 ## Edit yuzu.yml
 

data/lib/uploader/filesystem_service.rb

@@ -37,6 +37,7 @@ module Uploader
 
     def copy_contents_to_file_system(remote_path, contents, binary=true)
       destination = Path.new(@config.destination) + remote_path.relative
+
       if @config.verbose?
         $stderr.puts %Q{Copying #{GREEN}#{remote_path}#{ENDC} to the file system
       --> #{destination}} 
@@ -48,8 +49,8 @@ module Uploader
         f = File.open(destination.absolute, "w+")
 
       rescue => detail
-        $stderr.puts detail.message
-        $stderr.puts "Attempting to create the path."
+        $stderr.puts detail.message if @config.verbose?
+        $stderr.puts "Attempting to create the path." if @config.verbose?
 
         # Assume the directories leading to the file don't exist. Create them.
         FileUtils::mkdir_p(destination.dirname)

data/lib/yuzu/content/sample_project.rb

@@ -83,6 +83,7 @@ module Yuzu::Content
 
         config_contents.gsub!("HOME", user_home_folder)
         config_contents.gsub!("USERNAME", username)
+        config_contents.gsub!("PROJECTFOLDER", SampleProject.project_folder_name)
 
         File.open(destination_config, "w") do |config|
           config.puts(config_contents)
@@ -122,6 +123,10 @@ module Yuzu::Content
       Dir.pwd
     end
 
+    def self.project_folder_name
+      File.basename(destination_folder)
+    end
+
     def self.exists?(sample_project_name)
       registered_projects.has_key?(sample_project_name)
     end

data/lib/yuzu/core/website_base.rb

@@ -109,7 +109,7 @@ module Yuzu::Core
     end
 
     def get_link_url
-      folder? ? currentpath.full : (currentpath + output_filename).full
+      folder? ? (currentpath + "index.html") : (currentpath + output_filename).full
     end
 
     def remote_path

data/lib/yuzu/generators/index.rb

@@ -69,7 +69,11 @@ module Yuzu::Generators
 
     def get_raw_contents
       # Only becomes @raw_contents if it is still nil when raw_contents is first called.
-      Yuzu::Generators.default_index_template(@path.dirname)
+      if @parent.is_blog?
+        Yuzu::Generators.default_blog_index_template(@parent.path.relative)
+      else
+        Yuzu::Generators.default_index_template(@parent.path.relative)
+      end
     end
 
     def created_at
@@ -97,6 +101,13 @@ INSERTCATALOG(path:#{relative_contents_path}, page:1, per_page:10, per_col:1, te
   end
   module_function :default_index_template
 
+  def default_blog_index_template(relative_contents_path)
+      "TEMPLATE(blog.haml)
+
+INSERTCATALOG(path:#{relative_contents_path}, page:1, per_page:10, per_col:1, template:_blog.haml)"
+  end
+  module_function :default_blog_index_template
+
   def category_index_template(relative_contents_path, category_name)
       "TEMPLATE(blog.haml)
 

data/lib/yuzu/version.rb

@@ -4,7 +4,7 @@ module Yuzu
     MAJOR = 0
     MINOR = 2
     PATCH = 1
-    BUILD = "pre"
+    BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join(".")
   end

data/resources/config/yuzu.yml

@@ -43,8 +43,10 @@ services:
   #
   # e.g. yuzu preview:all
   preview:
-    destination: HOME/Sites/yuzu-preview
-    link_root: file://HOME/Sites/yuzu-preview
+    # The folder into which the rendered site will be copied.
+    destination: HOME/Sites/PROJECTFOLDER
+    # The value LINKROOT and linkroot become in content and HAML templates, respectively.
+    link_root: file://HOME/Sites/PROJECTFOLDER
 
   # The stage is used to produce a copy of the actual site on the file system
   # for manual FTP-ing to a web server. This gives you the opportunity to get

data/resources/sample_content/introduction/about.md

@@ -1,6 +1,15 @@
 # About Yuzu
 
-Yuzu is a blog-aware, static-website generator and publisher that builds an HTML5 website from a folder of text files and images.
+Yuzu is a blog-aware, extensible, static-website generator and publisher that builds an HTML5 website from a folder of text files and images.
 
-This is one of the sample websites that comes with Yuzu.
+This is one of the sample websites that comes with Yuzu. If you're new to using Yuzu, I recommend that you browse this site in parallel with the site's source. Although Yuzu behaves like many other static website generators, it has some unique features that are revealed in the docs and this site.
 
+
+## Development
+
+Yuzu is under development, so naturally some features may not work the way they're intended. If you find a bug, have an idea for a feature, or would like to contribute to development, please get in touch with me at the project's [Github page](http://github.com/awmartin/yuzu).
+
+
+## Getting Started
+
+See the post on [Getting Started](LINKROOT/getting-started.html) for instructions on creating a Yuzu project.

data/resources/sample_content/introduction/advanced-posts.md

@@ -6,8 +6,12 @@ Notice how the post is dated February 11, 2013. This is set by using the `DATE`
 
 Here we will insert some contents from a different file:
 
+---
+
     INSERTCONTENTS(_snippets/about_insert_contents.md)
 
+---
+
 If you look at the source, the directive is indented. I only do this because Markdown highlighters treat underscores as markup to italicize text. Indenting treats it as code with no markup applied.
 
 SIDEBAR{

data/resources/sample_content/introduction/blog/autogenerated-index-files.md

@@ -0,0 +1,6 @@
+# Autogenerated index.html files
+
+CATEGORY(features)
+
+You'll notice that the blog folder doesn't have an `index.md` file. That's Yuzu creates one automatically for all folders without a file named `index`. This consists of a single `INSERTCATALOG` directive that grabs all the content files in the folder and renders then with the `_block.haml` folder by default.
+

data/resources/sample_content/introduction/getting-started.md

@@ -8,7 +8,20 @@ If you're reading this, you've successfully created your yuzu project, and you'r
 The front page is `index.md`, found in the folder you ran `yuzu create` in. If you look in it, you'll see a directive called `INSERTCATALOG`. Directives such as these are the mechanism that enables you to give Yuzu various instructions or information to aid in rendering your site.
 
 
+## Creating Your First Yuzu Project
+
+The fastest way to get started is to generate the sample project. Create a folder first and `cd` into it.
+
+1. `mkdir ~/Documents/yuzu-sample`
+2. `cd ~/Documents/yuzu-sample`
+3. `yuzu create`
+4. `yuzu preview`
+    
+Then point your browser to `file:///your/home/folder/Sites/yuzu-sample/index.html`.
+
+
 ## Configuration
 
-You shoud edit `config/yuzu.yml` to update the path found under `preview` called `destination`. If you're on a Mac, simply run change `username` to your username.
+You should edit `config/yuzu.yml` to update the path found under `preview` called `destination`. If you're on a Mac, simply run change `username` to your username.
 
+If you have an local Apache server running, or a Mac with Web Sharing enabled, you can reset the `services: preview: link_root:` flag in `yuzu.yml` to the project folder's url. e.g. `http://localhost/~yourusername/yuzu-sample`

data/resources/themes/minimal/_sass/screen.sass

@@ -77,5 +77,13 @@ blockquote
   
 // Other
 hr
-  display: none
+  clear: both
+  height: 0px
+  outline: none
+  border-top: 1px solid lightgray
+  border-left: none
+  border-right: none
+  border-bottom: none
+  margin: 1em 0
+
   

data/resources/themes/minimal/_templates/_footer.haml

@@ -1,2 +1,2 @@
 %p= config.site_name
-%p by William Martin
+%p Generated with [Yuzu](http://github.com/awmartin/yuzu), by [William Martin](http://spatialpixel.com)

data/resources/themes/minimal/css/screen.css

@@ -129,5 +129,12 @@ blockquote {
 
 /* line 79, ../_sass/screen.sass */
 hr {
-  display: none;
+  clear: both;
+  height: 0px;
+  outline: none;
+  border-top: 1px solid lightgray;
+  border-left: none;
+  border-right: none;
+  border-bottom: none;
+  margin: 1em 0;
 }

data/yuzu.gemspec

@@ -5,9 +5,9 @@
 
 Gem::Specification.new do |s|
   s.name = %q{yuzu}
-  s.version = "0.2.1.pre"
+  s.version = "0.2.1"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["William Martin"]
   s.date = %q{2013-02-12}
   s.default_executable = %q{yuzu}
@@ -110,6 +110,7 @@ Gem::Specification.new do |s|
     "resources/sample_content/introduction/_snippets/about_insert_contents.md",
     "resources/sample_content/introduction/about.md",
     "resources/sample_content/introduction/advanced-posts.md",
+    "resources/sample_content/introduction/blog/autogenerated-index-files.md",
     "resources/sample_content/introduction/blog/blog-folder-is-special.md",
     "resources/sample_content/introduction/getting-started.md",
     "resources/sample_content/introduction/index.md",

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: yuzu
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 0
   - 2
   - 1
-  - pre
-  version: 0.2.1.pre
+  version: 0.2.1
 platform: ruby
 authors: 
 - William Martin
@@ -241,6 +240,7 @@ files:
 - resources/sample_content/introduction/_snippets/about_insert_contents.md
 - resources/sample_content/introduction/about.md
 - resources/sample_content/introduction/advanced-posts.md
+- resources/sample_content/introduction/blog/autogenerated-index-files.md
 - resources/sample_content/introduction/blog/blog-folder-is-special.md
 - resources/sample_content/introduction/getting-started.md
 - resources/sample_content/introduction/index.md
@@ -284,13 +284,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: