yuzu 0.2.1.pre

data/lib/yuzu/commands/base.rb

@@ -0,0 +1,150 @@
+require 'fileutils'
+
+require 'uploader/base'
+
+require 'core/updater'
+require 'core/config'
+
+require 'helpers/string'
+require 'helpers/object'
+
+module Yuzu::Command
+
+  # The Base class for all commands provides methods for coordinating the Updater, which manages the
+  # files to be updated and the actual update commands, and the Uploader, which takes care of
+  # turning update operations into service calls via FTP, S3, etc.
+  class Base
+    include Uploader
+
+    attr_reader :args
+
+    def initialize(args, config)
+      @args = args
+      @config = config
+    end
+
+    def self.shell(cmd)
+      FileUtils.cd(Dir.pwd) {|d| return `#{cmd}`}
+    end
+
+    def updater
+      @updater ||= Yuzu::Core::Updater.new(uploader, @config)
+    end
+
+    def uploader
+      @uploader ||= UploadManager.new(uploader_config, self.class.service_override)
+    end
+
+    def uploader_config
+      options = {
+        :connection => @config.connection,
+        :verbose? => @config.verbose?
+      }
+      config_hash = @config.services.merge(options)
+      UploaderConfig.new(config_hash)
+    end
+
+    # This method enables a command to override the configuration's selected publication service.
+    # Some commands work only locally, such as preview, or don't have a publication method involved.
+    def self.service_override
+      nil
+    end
+
+    def self.help(method)
+    end
+
+    def self.requires_config?
+      true
+    end
+  end
+
+
+  class ConfiglessCommand
+    def initialize(args)
+      @args = args
+    end
+
+    def self.help(method)
+    end
+
+    def self.requires_config?
+      false
+    end
+  end
+
+
+  # The base class for all commands regarding publishing contents, e.g. preview, stage, publish.
+  class PublicationCommand < Base
+    include Uploader
+
+    def index
+      updater.update_these(@args)
+      updater.done
+    end
+
+    def all
+      updater.update_all
+      updater.done
+    end
+
+    def text
+      updater.update_text
+      updater.done
+    end
+
+    def resources
+      $stderr.puts `compass compile` if @config.has_compass?
+      updater.upload_all_resources
+      updater.done
+    end
+
+    def css
+      $stderr.puts `compass compile` if @config.has_compass?
+      updater.upload_all_css
+      updater.done
+    end
+
+    def images
+      images = updater.upload_all_images
+
+      catalog = File.open("_images.yml","w")
+      catalog.puts(images.join("\n"))
+      catalog.close
+
+      updater.done
+    end
+
+    def assets
+      updater.upload_all_assets
+      updater.done
+    end
+
+    def changed
+    #  git_diff_output = `git diff --name-only --diff-filter=AMRX`
+    #  changed_files = git_diff_output.split("\n")
+    #  updatable_files = changed_files.reject {|f| File.extname(f).includes_one_of?( @config['extension_blacklist'] )}
+
+    #  puts "Found changes to these files:\n" + updatable_files.join("\n").to_s
+    #  puts
+
+    #  updater.update_these(updatable_files)
+
+    #  puts "Looking for new images to upload..."
+
+    #  # Traverse images and upload if new.
+    #  catalog = File.open("images-preview.yml","a+") rescue nil
+
+    #  unless catalog.nil?
+    #    catalog.rewind
+    #    image_paths = catalog.readlines
+    #    known_images = image_paths.collect {|img| img.strip}
+    #    new_images = updater.upload_new_images known_images
+    #    catalog.puts(new_images.join("\n"))
+    #    catalog.close
+    #  end
+
+    #  updater.done
+    end
+  end
+
+end

data/lib/yuzu/commands/create.rb

@@ -0,0 +1,68 @@
+require 'content/sample_project'
+require 'content/blog_post'
+
+module Yuzu::Command
+
+  # Create produces a new content such as a new yuzu website project or new blog post.
+  class Create < ConfiglessCommand
+    include Yuzu::Content
+
+    def initialize(args)
+      @args = args
+    end
+
+    def index
+      sample_project = nil
+      sample_project_name = @args.length > 0 ? @args[0] : "default"
+
+      $stderr.puts "Creating a new Yuzu '#{sample_project_name}' project in this directory..."
+
+      if SampleProject.exists?(sample_project_name)
+        sample_project = SampleProject.new(sample_project_name)
+        sample_project.deliver!
+      else
+        raise RuntimeError, "Sample project called #{sample_project_name} was not found."
+      end
+
+      $stderr.puts "Done!"
+      $stderr.puts
+      $stderr.puts "Now try:"
+      $stderr.puts
+      $stderr.puts "   yuzu preview"
+      $stderr.puts
+
+      preview_url = sample_project.new_config['services']['preview']['link_root'] + '/index.html'
+      $stderr.puts "And point your web browser to #{preview_url}"
+
+      $stderr.puts "to see your new Yuzu site."
+      $stderr.puts
+      $stderr.puts "Remember to edit yuzu.yml to set your site settings, preview path, and remote host."
+    end
+
+    # Produces a new blog post with the name given on the command line.
+    def post
+      # TODO re-enable blog post creation. Requires a config file.
+      #if @args.length > 0
+      #  new_post = BlogPost.new(@args.first, @config)
+      #else
+      #  @stderr.puts 'create:post requires a filename. Try yuzu create:post "Post Title Here"'
+      #end
+    end
+
+    def self.help method
+      case method
+      when :index
+%Q{Create a new website project in the current directory.}
+
+      when :post
+%Q{Creates a new blog post with the date prepended to the file name.
+Pass a quoted string, capitalized, for the title of the post.}
+
+      else
+        "No help available for #{method}."
+
+      end
+    end
+  end
+
+end

data/lib/yuzu/commands/generate.rb

@@ -0,0 +1,95 @@
+require 'fileutils'
+
+module Yuzu::Command
+
+  # Generate handles some cross-media production (e.g. pdf) and handling of the creation of files
+  # (e.g. thumbnails).
+  class Generate < ConfiglessCommand
+    def index
+    end
+
+    # TODO Resurrect PDF rendering.
+    #def pdf
+    #  f = File.open(@args.first, "r")
+    #  unless f.nil?
+    #    contents = f.readlines.join
+    #    updater.render_pdf contents, @args.first
+    #    updater.done
+    #  else
+    #    puts "File load error."
+    #  end
+    #end
+
+    # TODO: Put this in its own class, update it, and integrate with the rest of the app.
+    def thumbnails
+      path = args.first
+      web_image_types = [".png", ".jpg", ".gif"]
+      thumbnail_types = @config.thumbnails.keys
+
+      thumbnail_endings = []
+      thumbnail_types.each do |type|
+        web_image_types.each do |ext|
+          thumbnail_endings += ["-#{type}#{ext}"]
+        end
+      end
+
+      if File.directory?(path)
+        # Get all the original images requested.
+        all_files = Dir[File.join(path, "**/*")]
+
+        images = all_files.select { |f|
+                    web_image_types.include?(File.extname(f))
+                  }.reject { |f|
+                    f[0].chr == "_" or 
+                    f.include?("#{File::SEPARATOR}_") or
+                    f.includes_one_of?(thumbnail_endings)
+                  }
+      else
+        # A single image.
+        images = [path]
+      end
+
+      images.each do |image_path|
+        ext = File.extname(image_path)
+
+        # Loop through the configured thumbnail types ("small", "medium", etc.)
+        thumbnail_types.each do |thumbnail_type|
+          thumbnail_path = image_path.gsub(ext, "-#{thumbnail_type}#{ext}")
+          thumbnail_size = @config.thumbnails[thumbnail_type]
+
+          $stderr.puts `cp #{image_path} #{thumbnail_path}; sips --resampleWidth #{thumbnail_size} #{thumbnail_path}`
+        end
+      end
+    end
+
+    def config
+      if not File.exists?("yuzu.yml") and not File.exists?("config/yuzu.yml")
+        # TODO Update to use Path objects.
+        FileUtils.copy(
+          "#{File.dirname(__FILE__)}/../templates/yuzu.yml",
+          "#{Dir.pwd}/config/yuzu.yml"
+        )
+
+        $stderr.puts %Q{Copied a sample config file into the current folder. \
+Update it with your remote server information.}
+
+      else
+        $stderr.puts %Q{Config file yuzu.yml already exists. Please rename or \
+erase it to generate a new one.}
+      end
+    end
+
+    def self.help method
+      case method
+      when :thumbnails
+        %Q{Generates small, medium, and large thumbnail images from a given path.
+Uses the Mac 'sips' command-line tool.}
+
+      else
+        "No help available for #{method}."
+
+      end
+    end
+
+  end
+end

data/lib/yuzu/commands/help.rb

@@ -0,0 +1,20 @@
+module Yuzu::Command
+
+  class Help < ConfiglessCommand
+    def initialize(args)
+      @args = args
+    end
+
+    def index
+      if @args.first.nil?
+        puts ArgParser.parse(["--help"])
+      else
+        command_class, method = Yuzu::Command.parse(@args.first)
+        puts command_class.help(method)
+      end
+    end
+  end
+
+end
+
+

data/lib/yuzu/commands/preview.rb

@@ -0,0 +1,58 @@
+
+module Yuzu::Command
+
+  # Preview enables a publication endpoint that always publishes to the local filesystem such as a
+  # web server folder.
+  class Preview < PublicationCommand
+
+    def usage
+    end
+
+    def help
+    end
+
+    def self.service_override
+      "preview"
+    end
+
+    def self.help(method)
+      case method
+      when :index
+%Q{Updates files in the preview folder.
+
+preview                           # Alias for preview:all below.
+preview [filenames]               # Update the preview with the files listed.
+preview:all                       # Update all the files in the preview.
+preview:text                      # Only update the processable content files.
+preview:css                       # Regenerates the css files and copies them
+                                    to the preview.
+preview:images                    # Copy all the images into the preview folder.
+preview:images [files]            # Copy the images listed into the preview folder.
+preview:resources                 # Copy all the resources, like CSS and JS
+                                    files, into the preview folder.
+preview:assets                    # Copy all images and other assets (like PDFs and
+                                    other downloadables) into the preview folder.
+}
+
+      when :all
+        "Updates all files in the preview folder."
+
+      when :resources
+        "Copy all the resources, like CSS and JS files, into the preview folder."
+
+      when :images
+        "Copy all images into the preview folder."
+
+      when :assets
+        %Q{Copy all images and other assets, usually PDF files and other archives, 
+into the preview folder.}
+
+      else
+        "No help available for #{method}."
+
+      end
+    end
+  end
+
+end
+

data/lib/yuzu/commands/publish.rb

@@ -0,0 +1,43 @@
+
+module Yuzu::Command
+  
+  # Publish is the primary mechanism to upload files to a remote server such as via FTP or S3.
+  class Publish < PublicationCommand
+
+    def self.help method
+      case method
+      when :index
+%Q{Updates files and publishes to the current remote service.
+
+Can be used in the following forms:
+
+publish                           # Alias for publish:all below.
+publish [filenames]               # Publish just the files listed to the remote server.
+publish:all                       # Publish and upload all files.
+publish:text                      # Only update the processable content files.
+publish:css                       # Regenerates the css files and publishes them.
+publish:images                    # Upload all the images.
+publish:images [files]            # Upload the images given.
+publish:resources                 # Upload all resources like CSS and Javascript files.
+publish:assets                    # Upload all assets (like PDFs and other downloadables). 
+}
+
+      when :all
+        "Publishes and uploads all files to the remote server."
+
+      when :resources
+        "Publish all resources like CSS and Javascript files."
+
+      when :images
+        "Upload all the images or the ones given after the command."
+
+      when :assets
+        "Upload all file assets (usually PDF files and other download archives.)"
+
+      else
+        "No help available for #{method}."
+
+      end
+    end
+  end
+end

data/lib/yuzu/commands/stage.rb

@@ -0,0 +1,62 @@
+
+module Yuzu::Command
+
+  # Stage is used as a third mechanism to render the webpage under production settings, but still to
+  # a local file system. The scenario may be that the website must be published with a different
+  # mechanism than what is automated, so this enables someone to render with the appropriate
+  # linkroot for the final production destination.
+  class Stage < PublicationCommand
+
+    def usage
+    end
+
+    def help
+    end
+
+    def self.service_override
+      "stage"
+    end
+
+    def self.help method
+      case method
+      when :index
+%Q{Updates files in the staging folder.
+
+Can be used in the following forms:
+
+stage                           # Alias for stage:all below.
+stage [filenames]               # Update the local staging folder with the files listed.
+stage:all                       # Update all the files in the staging folder.
+stage:text                      # Only update the processable content files.
+stage:css                       # Regenerates the CSS files and copies them
+                                  to the staging folder.
+stage:images                    # Copy all the images into the staging folder.
+stage:images [files]            # Copy the images listed into the staging folder.
+stage:resources                 # Copy all the resources, like CSS and JS
+                                  files, into the staging folder.
+stage:assets                    # Copy all images and other assets (like PDFs and
+                                  other downloadables) into the staging folder.
+}
+
+      when :all
+        "Updates all files in the staging folder."
+
+      when :resources
+        "Copy all the resources, like CSS and JS files, into the staging folder."
+
+      when :images
+        "Copy all images into the preview folder."
+
+      when :assets
+        %Q{Copy all images and other assets, usually PDF files and other archives, 
+into the staging folder.}
+
+      else
+        "No help available for #{method}."
+
+      end
+    end
+  end
+
+end
+