gitscribe 0.0.2

data/README.markdown

@@ -0,0 +1,16 @@
+# GitScribe: Create tutorials and articles with Git
+
+## Installing
+
+    # Run the following if you haven't done so before:
+    gem sources -a http://gems.github.com
+    # Install the gem:
+    sudo gem install dima-gitscribe
+    
+## Using
+
+    gitscribe --title 'Working with RestfulX Model Attachments' rx_model_attachments
+
+# License
+
+Copyright (c) 2009 Dima Berastau. Released under MIT License

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 2
+:major: 0

data/bin/gitscribe

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+ 
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'gitscribe'
+ 
+GitScribe.run!(*ARGV)

data/lib/gitscribe.rb

@@ -0,0 +1,51 @@
+require 'git'
+require 'erb'
+require 'gitscribe/options'
+require 'gitscribe/models'
+
+class GitScribe
+  class << self
+    def run!(*arguments)
+      options = GitScribe::Options.new(arguments)
+
+      if options[:show_help]
+        $stderr.puts options.opts
+        return 1
+      end
+
+      unless arguments.size == 1
+        $stderr.puts options.opts
+        return 1
+      end
+      
+      g = Git.open(arguments.first)
+
+      tags = Array.new
+      g.tags.sort_by { |x| g.object(x.objectish).date }.each { |t| tags << t.name }
+
+      chapters = Array.new
+      if tags.empty?
+        chapter = Chapter.new
+        g.log.each { |c| add_section(chapter.sections, c) }
+        chapters << chapter
+      else
+        tags.each_index do |i|
+          chapter = Chapter.new(tags[i])
+          g.log.between(tags[i], tags[i + 1]).each { |c| add_section(chapter.sections, c) } if i + 1 < tags.size
+          chapters << chapter if !chapter.sections.empty?
+        end
+      end
+
+      template = File.read(File.dirname(__FILE__) + "/gitscribe/template.erb")
+
+      f = File.new(options[:output], "w+")
+      f.puts(ERB.new(template).result(binding))
+    end
+    
+    def add_section(target, c)
+      target << GitScribe::Section.new(c.message(), c.parent().diff(c)) if c.parent()
+    end    
+  end
+end
+
+

data/lib/gitscribe/models.rb

@@ -0,0 +1,67 @@
+class GitScribe
+  class Chapter
+    attr_accessor :title, :sections
+  
+    def initialize(title = 'Chapter X', sections = [])
+      @title, @sections = title, sections
+    end
+  end
+
+  class Section
+    attr_reader :message
+  
+    def initialize(message, diff)
+      @message, @diff = message, diff
+    end
+  
+    def diff
+      @diff.select { |f| valid_file(f.path) }.map do |f|
+        type = f.type == "new" ? file_type(f.path) : "diff"
+        code, target_file = parse_diff(f.patch, f.type)
+        "File: #{target_file}\n\n{% highlight #{type} %}\n#{code}\n{% endhighlight %}\n\n" 
+      end.join
+    end
+  
+    private
+    def parse_diff(patch, type)
+      offset = patch.index(/@@ -\d+,\d+ \+\d+,\d+ @@/) - 1
+      header = patch.slice!(0 .. offset)
+      target_file = /diff --git a\/(.*?) b\/(.*?)/.match(header)[1]
+      patch = patch.split("\n").select { |l|!l.include?("No newline at end of file") }.map do |l| 
+        l = l[1..-1] unless l.match(/@@ -\d+,\d+ \+\d+,\d+ @@/)
+        #split(l)
+      end.join("\n") if type == "new"
+      patch = patch.gsub(/\t/m, "  ")
+      [patch, target_file]
+    end
+    
+    # This is pretty doggy, would be nice to have a decent lexical analizer that can
+    # reformat code based on a width parameter
+    def split(line)
+      line.split("\n").map do |l|
+        if l.size > 80
+          offset = l.rindex(/\s/)
+          first_part = l.slice!(0 .. offset)
+          "#{first_part}\n  #{l}"
+        else
+          l
+        end
+      end.join("\n")
+    end
+  
+    # needs to be configurable
+    def valid_file(f)
+      f =~ /\.rb$|\.mxml$|\.as$/
+    end
+  
+    def file_type(f)
+      result = case f
+      when /.rb$/ : "ruby"
+      when /.mxml$/ : "xml"
+      when /.as$/ : "as3"
+      else
+        "unknown"
+      end
+    end
+  end
+end

data/lib/gitscribe/options.rb

@@ -0,0 +1,39 @@
+class GitScribe
+  class Options < Hash
+    attr_reader :opts
+
+    def initialize(args)
+      super()
+
+      self[:title] = "Cool Tutorial"
+      self[:location] = "Vancouver, BC"
+      
+      @opts = OptionParser.new do |o|
+        o.banner = "Usage: #{File.basename($0)} [options] reponame\ne.g. #{File.basename($0)} cool-tutorial"
+
+        o.on('--output [FILE]', 'Output file to generate blog post to') do |output|
+          self[:output] = output
+        end
+
+        o.on('--title [TITLE]', 'Blog post title to use', "Default: #{self[:title]}") do |title|
+          self[:title] = title
+          self[:output] = default_output unless self[:output]
+        end
+
+        o.on('--location [LOCATION]', 'Add geo location to the blog post', "Default: #{self[:location]}") do |location|
+          self[:location] = location
+        end
+
+        o.on_tail('-h', '--help', 'display this help and exit') do
+          self[:show_help] = true
+        end
+      end
+      
+      @opts.parse!(args)
+    end
+    
+    def default_output
+      "#{Date.today.strftime("%Y-%m-%d")}-#{self[:title].gsub(/\s/, '-').downcase}.textile"
+    end
+  end
+end

data/lib/gitscribe/template.erb

@@ -0,0 +1,20 @@
+---
+layout: post
+title: <%= options[:title] %>
+---
+
+h1. {{ page.title }}
+
+p(meta). <%= Date.today.strftime("%d %b %Y") %> - <%= options[:location] %>
+
+<% chapters.each do |chapter| %>
+h2. <%= chapter.title %>
+
+<% chapter.sections.reverse.each do |section| %>
+h3. Section
+
+<%= section.message %>
+
+<%= section.diff %>
+<% end %>
+<% end %>

data/test/gitscribe_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class GitscribeTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gitscribe'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: gitscribe
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Dima Berastau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-22 00:00:00 -08:00
+default_executable: gitscribe
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: schacon-git
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: dima@ruboss.com
+executables: 
+- gitscribe
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- VERSION.yml
+- bin/gitscribe
+- lib/gitscribe
+- lib/gitscribe/models.rb
+- lib/gitscribe/options.rb
+- lib/gitscribe/template.erb
+- lib/gitscribe.rb
+- test/gitscribe_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/dima/gitscribe
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Create code-intensive tutorials and articles with Git
+test_files: []
+