jekyll_and_hyde 1.0.0 → 1.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Jingwen Owen Ou
+
+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/README.markdown

@@ -0,0 +1,45 @@
+# JekyllAndHyde
+
+JekyllAndHyde is a HTML presentation generator that generates a basic [Jekyll][1] scaffold with [Slippy][2] hooking up.
+
+# Jekyll
+
+Jekyll is a blog aware static site generator that powers [GitHub Pages][3]. It takes a template directory (representing the raw form of a website), runs it through Textile or Markdown and Liquid converters, and spits out a complete, static website suitable for serving with Apache or your favorite web server. GitHub Pages is set up in a way that whenever you push markup files into its Git repository, Jekyll will automatically render them and generate a static website.
+
+# Slippy
+
+Slippy is HTML presentation library written with jQuery that takes a HTML file in and plays the presentation in any browser.
+
+# Why?
+
+Combining Jekyll and Slippy can provide a powerful yet simple solution to create presentations: you use the jekyll_and_hyde gem to generate a Jekyll scaffold with Slippy properly hooking up; you write your slides using Makrdown or Textile; then you publish your slides by pushing it to a Git repository.
+
+# How?
+
+## Installation:
+
+	> gem install jekyll_and_hyde
+
+## Generation:
+
+	> jh new my_slides --github
+	> cd my_slides
+	> jh generate my-first-slide
+
+The "--github" optional flag in "jh new" means setting up branching information for GitHub Pages.
+
+## Other tasks:
+
+	> jh github
+	> jh list [SEARCH]
+	> jh help [TASK]
+
+The "github" task is to set up branching information for GitHub Pages. The "list" task is to list the available tasks by giving it an optional SEARCH terms. The "help" is to display the usage for a specific task.
+
+# License
+
+MIT License. Details see LICENSE.
+
+[1]: https://github.com/mojombo/jekyll
+[2]: https://github.com/Seldaek/slippy
+[3]: http://pages.github.com/

data/jekyll_and_hyde.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["owen@owenou.com"]
   s.homepage    = "http://github.com/jingweno/jekyll_and_hyde"
   s.summary     = %q{A simple HTML presentation generator based on jekyll and slippy.}
-  s.description = %q{jekyll_and_hyde is a simple HTML presentation generator based on jekyll(https://github.com/mojombo/jekyll) and slippy(https://github.com/Seldaek/slippy).}
+  s.description = %q{JekyllAndHyde is a HTML presentation generator that generates a basic Jekyll scaffold with Slippy hooking up.}
 
   s.rubyforge_project = "jekyll_and_hyde"
 

data/lib/jekyll_and_hyde/actions.rb

@@ -1,12 +1,9 @@
 module JekyllAndHyde
   module Actions
-    def inside_app_path(config = {}, &block)
-      inside app_path, config, &block
-    end
-
     def run_command(command, config={})
       result = run(command, config)
       raise Error, "Errors occured when running command \"#{command}\"." unless result
+      result
     end
 
     def say_status(status, message, log_status=true)
@@ -16,5 +13,10 @@ module JekyllAndHyde
     def set_color(string, color, bold=false)
       self.shell.set_color(string, color, bold)
     end
+
+    def validate_installation
+      self.class.source_root(destination_root)
+      find_in_source_paths("_config.yml")
+    end
   end
 end

data/lib/jekyll_and_hyde/group_task.rb

@@ -0,0 +1,10 @@
+module JekyllAndHyde
+  class GroupTask < Thor::Group
+    include Thor::Actions
+    include JekyllAndHyde::Actions
+
+    def self.self_task
+      Thor::DynamicTask.new(self.namespace.split(':').last, class_options)
+    end
+  end
+end

data/lib/jekyll_and_hyde/runner.rb

@@ -37,7 +37,7 @@ class JekyllAndHyde::Runner < Thor
 
   def start_task(klass, task, args)
     if klass.nil?
-      say "Don't know how to build task '#{JekyllAndHyde.trim_namespace(task)}'."
+      say "Don't know how to run task '#{JekyllAndHyde.trim_namespace(task)}'."
     else
       klass.start(args, :shell => self.shell)
     end
@@ -50,11 +50,11 @@ class JekyllAndHyde::Runner < Thor
   # Display information about the given klasses. If with_module is given,
   # it shows a table with information extracted from the yaml file.
   def display_klasses(klasses=Thor::Base.subclasses)
-    klasses -= JekyllAndHyde::Group.ancestors
+    klasses -= JekyllAndHyde::GroupTask.ancestors
     raise Error, "No JekyllAndHyde tasks available" if klasses.empty?
 
     list = Hash.new { |h, k| h[k] = [] }
-    groups = klasses.select { |k| k.ancestors.include?(Thor::Group) }
+    groups = klasses.select { |k| k.ancestors.include?(JekyllAndHyde::GroupTask) }
 
     # Get classes which inherit from Thor
     (klasses - groups).each { |k| list[k.namespace.split(":").first] += k.printable_tasks(false) }

data/lib/jekyll_and_hyde/tasks/generate.rb

@@ -1,14 +1,13 @@
 module JekyllAndHyde
-  class Generate < JekyllAndHyde::Group
+  class Generate < JekyllAndHyde::GroupTask
     argument :title, :type => :string, :required => true, :desc => "The title of the slide."
     class_option :format, :type => :string, :default => 'markdown', :desc => 'The format of the slide. It supports markdown and textile.'
     desc "Generate a slide using the defined template."
 
     SUPPORT_FORMATS = %W{markdown md textile}
 
-    def validate_current_folder
-      self.class.source_root(destination_root)
-      find_in_source_paths("_config.yml")
+    def validate_current_installation
+      validate_installation
     end
 
     def create_slide

data/lib/jekyll_and_hyde/tasks/github.rb

@@ -0,0 +1,30 @@
+module JekyllAndHyde
+  class Github < JekyllAndHyde::GroupTask
+    desc "Create branching information for GitHub Project Pages, details in http://pages.github.com/."
+
+    def validate_current_installation
+      validate_installation
+    end
+
+    def check_uncommited_files
+      output = run_command 'git status', :capture => true
+      raise Error, "There are uncommited changes. Please commit them first." unless output.include?("nothing to commit")
+    end
+
+    def create_github_page_branch
+      run_command 'git checkout -b gh-pages'
+      run_command 'git branch -d master'
+      say_status :create, 'branch "gh-pages" for GitHub project page, details in http://pages.github.com/.'
+      say
+    end
+
+    def print_next_steps
+      next_step_string = "Next steps:"
+      say set_color(next_step_string, :blue, true)
+      say "-" * next_step_string.size
+      say 'git remote add origin git@github.com:your_github_username/your_git_repo.git'
+      say 'git push origin gh-pages'
+      say
+    end
+  end
+end

data/lib/jekyll_and_hyde/tasks/new.rb

@@ -1,5 +1,5 @@
 module JekyllAndHyde
-  class New < JekyllAndHyde::Group
+  class New < JekyllAndHyde::GroupTask
     JEKYLL_AND_HYDE_TEMPLATE_GIT_REPO = 'git://github.com/jingweno/jekyll_and_hyde_template.git'
     SLIPPY_GIT_REPO = 'git://github.com/jingweno/slippy.git'
 
@@ -40,29 +40,22 @@ module JekyllAndHyde
     def create_git_hub_page
       if options.github?
         inside_app_path do
-          create_github_page_branch()
-          say
-          print_next_steps()
-          say
+          # Commit all changes
+          run_command 'git commit -am "Template files generated by jekyll_and_hyde."'
+          invoke_github_task
         end
       end
     end
 
     private
 
-    def create_github_page_branch
-      run_command 'git commit -am "Template files generated by jekyll_and_hyde."'
-      run_command 'git checkout -b gh-pages'
-      run_command 'git branch -d master'
-      say_status :create, 'branch "gh-pages" for GitHub project page, details in http://pages.github.com/.'
+    def inside_app_path(config = {}, &block)
+      inside app_path, config, &block
     end
 
-    def print_next_steps
-      next_step_string = "Next steps:"
-      say set_color(next_step_string, :blue, true)
-      say "-" * next_step_string.size
-      say 'git remote add origin git@github.com:your_github_username/your_git_repo.git'
-      say 'git push origin gh-pages'
+    def invoke_github_task
+      klass = JekyllAndHyde::Util.find_class_and_task_by_namespace("github").first
+      klass.start([], :shell => self.shell)
     end
   end
 end

data/lib/jekyll_and_hyde/version.rb

@@ -1,3 +1,3 @@
 module JekyllAndHyde
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/jekyll_and_hyde.rb

@@ -11,7 +11,8 @@ require 'jekyll_and_hyde/thor_ext'
 require 'jekyll_and_hyde/actions'
 require 'jekyll_and_hyde/error'
 require 'jekyll_and_hyde/util'
-require 'jekyll_and_hyde/group'
+require 'jekyll_and_hyde/group_task'
 require 'jekyll_and_hyde/tasks/new'
 require 'jekyll_and_hyde/tasks/generate'
+require 'jekyll_and_hyde/tasks/github'
 require 'jekyll_and_hyde/runner'

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Jingwen Owen Ou
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 -08:00
+date: 2011-01-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,7 +69,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
-description: jekyll_and_hyde is a simple HTML presentation generator based on jekyll(https://github.com/mojombo/jekyll) and slippy(https://github.com/Seldaek/slippy).
+description: JekyllAndHyde is a HTML presentation generator that generates a basic Jekyll scaffold with Slippy hooking up.
 email: 
 - owen@owenou.com
 executables: 
@@ -82,6 +82,8 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
+- LICENSE
+- README.markdown
 - Rakefile
 - bin/jh
 - features/presenter_creates_a_skeletal_installation.feature
@@ -93,10 +95,11 @@ files:
 - lib/jekyll_and_hyde/actions.rb
 - lib/jekyll_and_hyde/core_ext/string.rb
 - lib/jekyll_and_hyde/error.rb
-- lib/jekyll_and_hyde/group.rb
+- lib/jekyll_and_hyde/group_task.rb
 - lib/jekyll_and_hyde/namespace.rb
 - lib/jekyll_and_hyde/runner.rb
 - lib/jekyll_and_hyde/tasks/generate.rb
+- lib/jekyll_and_hyde/tasks/github.rb
 - lib/jekyll_and_hyde/tasks/new.rb
 - lib/jekyll_and_hyde/thor_ext.rb
 - lib/jekyll_and_hyde/util.rb

data/lib/jekyll_and_hyde/group.rb

@@ -1,7 +0,0 @@
-module JekyllAndHyde
-  class Group < Thor::Group
-    include JekyllAndHyde::ThorExt
-    include Thor::Actions
-    include JekyllAndHyde::Actions
-  end
-end