git-blog 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0da108037aabdf36d1106d540a662add7ce9c5b8
+  data.tar.gz: bfea49390b39b50ac3606bd9666c481afce92fb9
+SHA512:
+  metadata.gz: 760a757078402be5a5fab798853246843280b6e7e1de19d8270c44f1edc6b67c48d02f7d9be384471725f15b43869278115efcbf62c55d2453fa681aebaf9a26
+  data.tar.gz: 8877dc258cefe82769e77beab5dd06ddba88010926d4320853d8f8950f92222fd0278e126e05a8d26ff23207c5d649eb96271acb519ab6f7e7e901106b429955

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Void Main
+
+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.md

@@ -0,0 +1,22 @@
+# git-blog
+Turn git commit message into blog article.
+
+## They say programmers love DRY
+There are tons of books yelling about how you shouldn't repeat yourself, how you should keep it DRY(Don't Repeat Yourself). Well, we tried hard to keep the code clean, but when it comes to blog we wrote, we seems quite ignorante to the DRY principle. 
+
+During the whole developement process, there will always be some interesting points you want to record, so git gurus told us to write proper git commit messages for further reference or so. And yes, I followed, and I spent quite a time writing about the problem I encountered, how I found the solution, and what should might be useful in the future. That's nice, right?
+
+But I've also got a blog to write! Wait, I don't want to REPEAT MYSELF. And that leads to a barely touch [blog site](http://blog.voidmain.me). And I want to change this.
+
+## How this works
+`git-blog` is a simple to use command line tool, which leverage the familiar `git commit` command. Basically, during the commit process, `git-blog` inserts two git hooks, namely `prepare-commit-msg` and `commit-msg`. The `prepare-commit-msg` provides you a self-defined blog template you can use, and the `commit-msg` does the heavy-lifting by turn the commit message into a real blog article. Quite simple and straightforward.
+
+## Spec
+- Basic git hooks for message preparation and commit message interception ★
+- Support local file system (for jekyll) ★
+- Support Github issue reference ★
+- User authentication for Github ★
+- Support wordpress and other blog services (if they provide API) ★★
+- User authentication for the above blog services (if they provide API) ★★
+- Support other code hosting services like Bitbucket or Gitcafe ★★
+- Maybe a website for template sharing or blog service integration ★★★

data/bin/git-blog

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/git-blog/storage'
+require_relative '../lib/git-blog/configuration'
+require_relative '../lib/git-blog/workflow'
+
+workflow = GitBlog::Workflow.new
+if ARGV.length == 1 && ARGV[0] == "setup"
+	workflow.setup
+else
+	workflow.start_blogging ARGV
+end
+
+# workflow = GitBlog::Workflow.new
+# workflow.setup

data/git-blog.gemspec

@@ -0,0 +1,29 @@
+require './lib/git-blog/version'
+
+Gem::Specification.new do |s|
+  s.name = 'git-blog'
+  s.version = GitBlog::VERSION
+  s.author = 'Peng Sun'
+  s.email = 'voidmain1313113@gmail.com'
+
+  s.summary = 'Turn git commit message into blog article.'
+  s.description = "There are tons of books yelling about how you shouldn't repeat yourself, how you should keep it DRY(Don't Repeat Yourself). 
+Well, we tried hard to keep the code clean, but when it comes to blog we wrote, we seems quite ignorante to the DRY principle. 
+During the whole developement process, there will always be some interesting points you want to record, so git gurus told us to write proper git commit messages for further reference or so. 
+And yes, I followed, and I spent quite a time writing about the problem I encountered, how I found the solution, and what should might be useful in the future. That's nice, right?
+But I've also got a blog to write! Wait, I don't want to REPEAT MYSELF. And that leads to a barely touched blog site. And git-blog is here to help."
+  s.homepage = 'https://github.com/void-main/git-blog'
+  s.license = 'The MIT License (MIT)'
+
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = %w[lib]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = Dir['spec/**/*.rb']
+  s.executables = ['git-blog']
+
+  s.add_development_dependency 'rake',    '~> 0.9.0'
+  s.add_development_dependency 'rspec',   '~> 2.6.0'
+
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
+  s.rdoc_options = ['--line-numbers', '--inline-source', '--title', 'git-blog', '--main', 'README.md']
+end

data/lib/git-blog/configuration.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require_relative "./storage"
+
+module GitBlog
+	class Configuration
+		attr_accessor :blog_path
+		attr_accessor :template_content
+
+		def read
+			dict = Storage::config_dict
+			@blog_path = dict["blog-path"]
+		end
+
+		def write
+			dict = { "blog-path" => @blog_path }
+			Storage::save_config_dict dict
+		end
+	end
+end
+
+# blog = GitBlog::Configuration.new
+# blog.read
+# puts blog.blog_path

data/lib/git-blog/hooks/commit-msg

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'date'
+require 'git-blog/configuration'
+
+$msg_path = ARGV[0]
+content = File.read($msg_path)
+
+conf = GitBlog::Configuration.new
+conf.read
+
+# Create a new blog file
+time = DateTime.now.strftime("%F")
+title = [time, "blogging-with-git-blog.markdown"].join("-")
+path = File.join conf.blog_path, title
+
+File.open(path, "w") do |file|
+	file.write content
+end

data/lib/git-blog/hooks/prepare-commit-msg

@@ -0,0 +1,8 @@
+---
+layout: post
+title:  [Your Title Here]
+date:   [Current Date and Time]
+categories: [Your category here]
+---
+
+# Fill the content here!

data/lib/git-blog/storage.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'json'
+require 'FileUtils'
+
+module GitBlog
+	class Storage
+		BASE_PATH = "~/.git-blog"
+
+		def self.storage_base_path
+			File.expand_path BASE_PATH
+		end
+
+		def self.config_path
+			File.join storage_base_path, "config.json"
+		end
+
+		def self.prepare_commit_msg_template_path
+			File.join storage_base_path, "prepare-commit-msg"
+		end
+
+		def self.commit_msg_script_path
+			File.join storage_base_path, "commit-msg"
+		end
+
+		def self.config_dict
+			dict = nil
+			
+			path = Storage::config_path
+			if File.exists? path
+				dict = JSON.parse(File.read(path))
+			end
+
+			dict
+		end
+
+		def self.save_config_dict dict
+			FileUtils.mkdir_p Storage::storage_base_path
+			path = Storage::config_path
+			File.open(path, "w") { |file| file.write dict.to_json }
+		end
+	end
+end

data/lib/git-blog/version.rb

@@ -0,0 +1,3 @@
+module GitBlog
+	VERSION = '0.1'
+end

data/lib/git-blog/workflow.rb

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+require_relative './storage'
+require_relative './configuration'
+require 'FileUtils'
+
+# Test if a (String) path is a repo
+class String
+	def repo?
+		ret = false
+
+		# Use git rev-parse command to test if a directory is a repo
+		full_path = File.expand_path self
+		if File.directory? full_path
+			Dir.chdir full_path do
+				system "git rev-parse --show-toplevel > /dev/null 2>&1"
+				ret = $?.exitstatus == 0
+			end
+		end
+
+		ret
+	end
+end
+
+module GitBlog
+	class Workflow
+
+		# Setup basic configuration
+		def setup
+			conf = GitBlog::Configuration.new
+			print "Path to blog: "
+			$stdin.flush
+			conf.blog_path = File.expand_path $stdin.gets.chomp
+			conf.write
+
+			# Also, create the hook files
+			current_path = File.expand_path(File.dirname(__FILE__))
+			hook_path = File.join current_path, "hooks"
+			source_template_path = File.join hook_path, "prepare-commit-msg"
+			target_template_path = GitBlog::Storage.prepare_commit_msg_template_path
+			if !File.file? target_template_path
+				FileUtils.cp source_template_path, target_template_path
+				FileUtils.chmod 0755, target_template_path
+			end
+
+			source_commit_script_path = File.join hook_path, "commit-msg"
+			target_commit_script_path = GitBlog::Storage.commit_msg_script_path
+			if !File.file? target_commit_script_path
+				FileUtils.cp source_commit_script_path, target_commit_script_path
+				FileUtils.chmod 0755, target_commit_script_path
+			end
+		end
+
+		# Test if config is setup
+		def need_setup?
+			!File.file?(GitBlog::Storage.config_path) ||
+			!File.file?(GitBlog::Storage.prepare_commit_msg_template_path) ||
+			!File.file?(GitBlog::Storage.commit_msg_script_path)
+		end
+
+		# Do the job
+		def start_blogging cli_params
+			current_path = Dir.pwd
+
+			if !current_path.repo?
+				puts "Error: please run git-blog inside a git repo."
+				return
+			end
+
+			if need_setup?
+				puts "Haven't setup git-repo, setting up now"
+				setup
+			end
+
+			git_root_path = %x(git rev-parse --show-toplevel).strip
+			hooks_path = File.join git_root_path, ".git", "hooks"
+			source_template_path = GitBlog::Storage.prepare_commit_msg_template_path
+
+			script = <<EOF
+#!/usr/bin/env ruby
+
+$commit_file_path = ARGV[0]
+
+content = <<EOC
+#{File.read(source_template_path)}
+EOC
+
+File.write($commit_file_path, content)
+EOF
+
+			target_template_path = File.join hooks_path, "prepare-commit-msg"
+			File.open(target_template_path, "w") { |file| file.write script }
+			FileUtils.chmod 0755, target_template_path
+
+			source_commit_script_path = GitBlog::Storage.commit_msg_script_path
+			target_commit_script_path = File.join hooks_path, "commit-msg"
+			FileUtils.cp source_commit_script_path, target_commit_script_path
+			FileUtils.chmod 0755, target_commit_script_path
+
+			# Pass to git commit
+			system("git commit #{cli_params.join(" ")}")
+
+			# Clean up
+			FileUtils.rm target_template_path
+			FileUtils.rm target_commit_script_path
+		end
+	end
+end
+
+
+# Test it!
+# puts ".".repo?
+# puts "~".repo?
+# puts "/DoesNotExists".repo?
+# puts "~/Workspace/Projects/OctoEvent".repo?
+#
+# workflow = GitBlog::Workflow.new
+# workflow.setup

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: git-blog
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Peng Sun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+description: "There are tons of books yelling about how you shouldn't repeat yourself,
+  how you should keep it DRY(Don't Repeat Yourself). \nWell, we tried hard to keep
+  the code clean, but when it comes to blog we wrote, we seems quite ignorante to
+  the DRY principle. \nDuring the whole developement process, there will always be
+  some interesting points you want to record, so git gurus told us to write proper
+  git commit messages for further reference or so. \nAnd yes, I followed, and I spent
+  quite a time writing about the problem I encountered, how I found the solution,
+  and what should might be useful in the future. That's nice, right?\nBut I've also
+  got a blog to write! Wait, I don't want to REPEAT MYSELF. And that leads to a barely
+  touched blog site. And git-blog is here to help."
+email: voidmain1313113@gmail.com
+executables:
+- git-blog
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- .gitignore
+- LICENSE
+- README.md
+- bin/git-blog
+- git-blog.gemspec
+- lib/git-blog/configuration.rb
+- lib/git-blog/hooks/commit-msg
+- lib/git-blog/hooks/prepare-commit-msg
+- lib/git-blog/storage.rb
+- lib/git-blog/version.rb
+- lib/git-blog/workflow.rb
+homepage: https://github.com/void-main/git-blog
+licenses:
+- The MIT License (MIT)
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- git-blog
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Turn git commit message into blog article.
+test_files: []