jekyll_and_hyde 0.0.1 → 1.0.0

data/.gitignore

@@ -1,4 +1,7 @@
+.DS_Store
 pkg/*
 *.gem
 .bundle
-Gemfile.lock
+Gemfile.lock
+*.iml
+.idea

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/bin/jh

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require 'jekyll_and_hyde'
+JekyllAndHyde::Runner.start

data/features/presenter_creates_a_skeletal_installation.feature

@@ -0,0 +1,12 @@
+Feature: presenter creates a skeletal installation
+
+  Scenario: creates a skeletal installation
+    Given the jekyll_and_hyde gem installed
+    When I run the "jh new test" command inside folder "/"
+    Then I should have a folder named "test" created
+    And I should have template files/folders "_config.yml, _includes, _layouts, index.html, stylesheets, .git, .gitmodules, slippy" inside folder "test"
+
+  Scenario: creates a skeletal installation with GitHub project page branch setup
+    Given the jekyll_and_hyde gem installed
+    When I run the "jh new test --github" command inside folder "/"
+    Then I should have a git branch named "gh-pages" created in folder "test"

data/features/presenter_creates_slides.feature

@@ -0,0 +1,6 @@
+Feature: presenter creates slides
+
+  Scenario: creates a slide
+    Given I run the "jh new test" command inside folder "/"
+    When I run the "jh generate test-slide" command inside folder "test"
+    Then I should have a file named "test-slide.markdown" prefixed with timestamp created in posts folder "test/_posts"

data/features/step_definitions/jekyll_and_hyde_steps.rb

@@ -0,0 +1,42 @@
+Before do
+  FileUtils.mkdir_p(DESTINATION_ROOT)
+end
+
+After do
+  FileUtils.rm_rf(DESTINATION_ROOT)
+end
+
+Given /^the jekyll_and_hyde gem installed$/ do
+end
+
+When /^I run the "jh ([^"]*)" command inside folder "([^"]*)"$/ do |parameters, folder|
+  parameters = parameters.split.map(&:strip)
+  task = parameters.shift
+  args, opts = Thor::Options.split(parameters)
+
+  @task = JekyllAndHyde::Util.find_task_class(task).new(args, opts)
+  @task.destination_root = File.join(DESTINATION_ROOT, folder)
+  @task.invoke(JekyllAndHyde.to_namespace(task))
+end
+
+Then /^I should have a folder named "([^"]*)" created$/ do |folder_name|
+  File.should be_directory(File.join(DESTINATION_ROOT, folder_name))
+end
+
+And /^I should have template files\/folders "([^"]*)" inside folder "([^"]*)"$/ do |template_files, folder_name|
+  template_files.split(',').map(&:strip).each do |template_file|
+    File.should be_exist(File.join(DESTINATION_ROOT, folder_name, template_file))
+  end
+end
+
+Then /^I should have a git branch named "([^"]*)" created in folder "([^"]*)"$/ do |branch_name, folder_name|
+  output = IO.popen("cd #{File.join(DESTINATION_ROOT, folder_name)} && git branch")
+  output.readlines.first.include?(branch_name)
+end
+
+Then /^I should have a file named "([^"]*)" prefixed with timestamp created in posts folder "([^"]*)"$/ do |file_name, folder_name|
+  posts_folder = Dir[File.join(DESTINATION_ROOT, folder_name, "**", "*.*")]
+  posts_folder.should have(1).file
+  post_file_name = posts_folder.first.scan(/\d\d\d\d-\d\d-\d\d-\d\d-\d\d-\d\d-(.*)/).flatten.first
+  post_file_name.should == file_name
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH << File.expand_path('../../../lib', __FILE__)
+require 'jekyll_and_hyde'
+
+DESTINATION_ROOT = File.expand_path('../../test_target', File.dirname(__FILE__))

data/jekyll_and_hyde.gemspec

@@ -13,10 +13,13 @@ Gem::Specification.new do |s|
   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.rubyforge_project = "jekyll_and_hyde"
-  
+
+  s.add_dependency('thor')
+
   s.add_development_dependency('rspec')
   s.add_development_dependency('cucumber')
-  
+  s.add_development_dependency('fakefs')
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/lib/jekyll_and_hyde/actions.rb

@@ -0,0 +1,20 @@
+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
+    end
+
+    def say_status(status, message, log_status=true)
+      self.shell.say_status(status, message, log_status)
+    end
+
+    def set_color(string, color, bold=false)
+      self.shell.set_color(string, color, bold)
+    end
+  end
+end

data/lib/jekyll_and_hyde/core_ext/string.rb

@@ -0,0 +1,5 @@
+class String
+  def titlecase
+    gsub(/([a-zA-Z]*)/).map { |m| m.capitalize }.join
+  end
+end

data/lib/jekyll_and_hyde/error.rb

@@ -0,0 +1,3 @@
+module JekyllAndHyde
+  class Error < Thor::Error; end
+end

data/lib/jekyll_and_hyde/group.rb

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

data/lib/jekyll_and_hyde/namespace.rb

@@ -0,0 +1,16 @@
+module JekyllAndHyde
+  class << self
+    def namespace
+      Thor::Util.namespace_from_thor_class(self)
+    end
+
+    def to_namespace(str)
+      str = "#{namespace}:#{str}" unless str.include?(':')
+      str
+    end
+
+    def trim_namespace(str)
+      str.gsub("#{namespace}:", "")
+    end
+  end
+end

data/lib/jekyll_and_hyde/runner.rb

@@ -0,0 +1,81 @@
+$thor_runner = true
+
+class JekyllAndHyde::Runner < Thor
+  def help(meth = nil)
+    if meth && !self.respond_to?(meth)
+      klass, task = JekyllAndHyde::Util.find_class_and_task_by_namespace(meth)
+      start_task(klass, task, ["-h", task].compact)
+    else
+      super
+    end
+  end
+
+  desc "list [SEARCH]", "List the available jekyll_and_hyde tasks by an optional [SEARCH] string."
+
+  def list(search="")
+    search = /^.*#{JekyllAndHyde.to_namespace(search)}.*/i
+    klasses = Thor::Base.subclasses.select do |k|
+      k.namespace =~ search
+    end
+
+    display_klasses(klasses)
+  end
+
+  desc "version", "Show jekyll_and_hyde version"
+
+  def version
+    say "JekyllAndHyde #{JekyllAndHyde::VERSION}"
+  end
+
+  private
+
+  def method_missing(meth, *args)
+    klass, task = JekyllAndHyde::Util.find_class_and_task_by_namespace(meth.to_s)
+    args.unshift(task) if task
+    start_task(klass, task, args)
+  end
+
+  def start_task(klass, task, args)
+    if klass.nil?
+      say "Don't know how to build task '#{JekyllAndHyde.trim_namespace(task)}'."
+    else
+      klass.start(args, :shell => self.shell)
+    end
+  end
+
+  def self.banner(task, all = false, subcommand = false)
+    "#{basename} #{task.formatted_usage(self, all, subcommand)}"
+  end
+
+  # 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
+    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) }
+
+    # Get classes which inherit from Thor
+    (klasses - groups).each { |k| list[k.namespace.split(":").first] += k.printable_tasks(false) }
+
+    # Get classes which inherit from Thor::Base
+    groups.map! { |k| k.printable_tasks(false).first }
+
+    list["root"] = groups
+
+    # Order namespaces with default coming first
+    list = list.sort { |a, b| a[0].sub(/^default/, '') <=> b[0].sub(/^default/, '') }
+    list.each { |n, tasks| display_tasks(n, tasks) unless tasks.empty? }
+  end
+
+  def display_tasks(namespace, list) #:nodoc:
+    list.sort! { |a, b| a[0] <=> b[0] }
+
+    say shell.set_color(namespace, :blue, true)
+    say "-" * namespace.size
+
+    print_table(list, :truncate => true)
+    say
+  end
+end

data/lib/jekyll_and_hyde/tasks/generate.rb

@@ -0,0 +1,26 @@
+module JekyllAndHyde
+  class Generate < JekyllAndHyde::Group
+    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")
+    end
+
+    def create_slide
+      format = options[:format]
+      raise Error, "Unsupport format #{format}, --format=#{SUPPORT_FORMATS.join(",")}." unless SUPPORT_FORMATS.include?(format)
+      create_file File.join("_posts", "#{timestamp}-#{title}.#{format}")
+    end
+
+    private
+
+    def timestamp
+      Time.now.strftime("%Y-%m-%d-%H-%M-%S")
+    end
+  end
+end

data/lib/jekyll_and_hyde/tasks/new.rb

@@ -0,0 +1,68 @@
+module JekyllAndHyde
+  class New < JekyllAndHyde::Group
+    JEKYLL_AND_HYDE_TEMPLATE_GIT_REPO = 'git://github.com/jingweno/jekyll_and_hyde_template.git'
+    SLIPPY_GIT_REPO = 'git://github.com/jingweno/slippy.git'
+
+    argument :app_path, :type => :string, :required => true, :desc => "The app path to generate the skeletal installation"
+    class_option :github, :type => :boolean, :desc => "Create branching information for GitHub Project Pages, details in http://pages.github.com/."
+    desc "Generate a skeletal jekyll_and_hyde installation in [APP_PATH]."
+
+    def make_app_path_dir
+      empty_directory app_path
+    end
+
+    # TODO: pass in the url as parameter
+    def git_clone_template
+      inside_app_path do
+        run_command "git clone #{JEKYLL_AND_HYDE_TEMPLATE_GIT_REPO} ."
+        remove_file('.git')
+      end
+    end
+
+    def git_init
+      inside_app_path do
+        run_command "git init"
+      end
+    end
+
+    def add_slippy_git_submodule
+      inside_app_path do
+        run_command "git submodule add #{SLIPPY_GIT_REPO}"
+      end
+    end
+
+    def git_add_all
+      inside_app_path do
+        run_command "git add ."
+      end
+    end
+
+    def create_git_hub_page
+      if options.github?
+        inside_app_path do
+          create_github_page_branch()
+          say
+          print_next_steps()
+          say
+        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/.'
+    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'
+    end
+  end
+end

data/lib/jekyll_and_hyde/thor_ext.rb

@@ -0,0 +1,13 @@
+module JekyllAndHyde
+  module ThorExt
+    def self.included(base)
+      base.extend JekyllAndHyde::ThorExt::ClassMethods
+    end
+
+    module ClassMethods
+      def self_task
+        Thor::DynamicTask.new(self.namespace.split(':').last, class_options)
+      end
+    end
+  end
+end

data/lib/jekyll_and_hyde/util.rb

@@ -0,0 +1,13 @@
+module JekyllAndHyde
+  module Util
+    class << self
+      def find_task_class(task_name)
+        find_class_and_task_by_namespace(task_name).first
+      end
+
+      def find_class_and_task_by_namespace(task_name)
+        Thor::Util.find_class_and_task_by_namespace(JekyllAndHyde.to_namespace(task_name))
+      end
+    end
+  end
+end

data/lib/jekyll_and_hyde/version.rb

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

data/lib/jekyll_and_hyde.rb

@@ -1,3 +1,17 @@
-module JekyllAndHyde
-  # Your code goes here...
-end
+require 'rubygems'
+require 'thor'
+require 'thor/group'
+require 'thor/runner'
+
+require 'jekyll_and_hyde/core_ext/string'
+
+require 'jekyll_and_hyde/version'
+require 'jekyll_and_hyde/namespace'
+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/tasks/new'
+require 'jekyll_and_hyde/tasks/generate'
+require 'jekyll_and_hyde/runner'

data/spec/jekyll_and_hyde/core_ext/string_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe String do
+  describe "#titlecase" do
+    it "should return title case of any string" do
+      ["task_name", "Task-name", "task_Name"].each do |name|
+        name.titlecase.should == "TaskName"
+      end
+    end
+  end
+end

data/spec/jekyll_and_hyde/namespace_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe JekyllAndHyde do
+  describe "#namespace" do
+    it "should return namespace separated by ':'" do
+      JekyllAndHyde.namespace.should == "jekyll_and_hyde"
+    end
+  end
+
+  describe "#to_namespace" do
+    it "should append to namespace when string doesn't contain a colon" do
+      JekyllAndHyde.to_namespace("str").should == "jekyll_and_hyde:str"
+    end
+
+    it "shouldn't append to namespace when string constains a colon" do
+      JekyllAndHyde.to_namespace("test:str").should == "test:str"
+    end
+  end
+end

data/spec/jekyll_and_hyde/tasks/generate_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module JekyllAndHyde
+  describe Generate do
+    before(:each) do
+      @generate_task = JekyllAndHyde::Generate.new(["test_slide"], {}, {})
+    end
+
+    describe "#timestamp" do
+      it "should return timestamp separated by '-'" do
+        @generate_task.send(:timestamp).to_s.scan(/\d\d\d\d-\d\d-\d\d-\d\d-\d\d-\d\d/).should_not be_empty
+      end
+    end
+
+    describe "#create_slide" do
+      it "should create a file" do
+        @generate_task.should_receive(:create_file)
+        @generate_task.create_slide
+      end
+    end
+  end
+end

data/spec/jekyll_and_hyde/tasks/new_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module JekyllAndHyde
+  describe New do
+    before(:each) do
+      @new_task = JekyllAndHyde::New.new(["app_path"], {}, {})
+    end
+
+    describe "#make_app_path_dir" do
+      it "should create the given directory" do
+        @new_task.should_receive(:empty_directory).with("app_path")
+        @new_task.make_app_path_dir
+      end
+    end
+
+    describe "#inside_app_path" do
+      it "should have all other operations execute inside app path" do
+        %W{git_clone_template git_init add_slippy_git_submodule git_add_all}.each do |method|
+          @new_task.should_receive(:inside_app_path)
+          @new_task.send(method)
+        end
+      end
+    end
+  end
+end

data/spec/jekyll_and_hyde/util_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+module JekyllAndHyde
+  describe Util do
+    describe "#find_task_class" do
+      it "should return result for existing task" do
+        class JekyllAndHyde::TestTask < Thor; end
+
+        JekyllAndHyde::Util.find_task_class("test_task").should be
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'jekyll_and_hyde'
+
+RSpec.configure do |config|
+  def destination_root
+    File.expand_path('../test_target', File.dirname(__FILE__))
+  end
+end

metadata

@@ -3,10 +3,10 @@ name: jekyll_and_hyde
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Jingwen Owen Ou
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-10 00:00:00 -08:00
+date: 2011-01-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: thor
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -28,10 +28,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: cucumber
+  name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -43,22 +43,70 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        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).
 email: 
 - owen@owenou.com
-executables: []
-
+executables: 
+- jh
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - Gemfile
 - Rakefile
+- bin/jh
+- features/presenter_creates_a_skeletal_installation.feature
+- features/presenter_creates_slides.feature
+- features/step_definitions/jekyll_and_hyde_steps.rb
+- features/support/env.rb
 - jekyll_and_hyde.gemspec
 - lib/jekyll_and_hyde.rb
+- 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/namespace.rb
+- lib/jekyll_and_hyde/runner.rb
+- lib/jekyll_and_hyde/tasks/generate.rb
+- lib/jekyll_and_hyde/tasks/new.rb
+- lib/jekyll_and_hyde/thor_ext.rb
+- lib/jekyll_and_hyde/util.rb
 - lib/jekyll_and_hyde/version.rb
+- spec/jekyll_and_hyde/core_ext/string_spec.rb
+- spec/jekyll_and_hyde/namespace_spec.rb
+- spec/jekyll_and_hyde/tasks/generate_spec.rb
+- spec/jekyll_and_hyde/tasks/new_spec.rb
+- spec/jekyll_and_hyde/util_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/jingweno/jekyll_and_hyde
 licenses: []
@@ -91,5 +139,14 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A simple HTML presentation generator based on jekyll and slippy.
-test_files: []
-
+test_files: 
+- features/presenter_creates_a_skeletal_installation.feature
+- features/presenter_creates_slides.feature
+- features/step_definitions/jekyll_and_hyde_steps.rb
+- features/support/env.rb
+- spec/jekyll_and_hyde/core_ext/string_spec.rb
+- spec/jekyll_and_hyde/namespace_spec.rb
+- spec/jekyll_and_hyde/tasks/generate_spec.rb
+- spec/jekyll_and_hyde/tasks/new_spec.rb
+- spec/jekyll_and_hyde/util_spec.rb
+- spec/spec_helper.rb