Blux 0.0.3

data/lib/blux_config_reader.rb

@@ -0,0 +1,83 @@
+#
+# Copyright 2010 Louis-Philippe Salin de l'Etoile, aka Louis Salin
+# email: louis.phil@gmail.com
+#
+# This file is part of Blux.
+#
+# Blux is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Blux is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Blux.  If not, see <http://www.gnu.org/licenses/>.
+class BluxConfigurationReader
+	attr_reader :launch_editor_cmd, :html_converter_cmd
+	attr_reader :blog, :author_name, :user_name, :password
+
+	def load_config(blux_rc, verbose = false)
+		unless File.exists? blux_rc
+			puts "creating #{blux_rc}\n" if verbose
+			system "touch #{blux_rc}" 
+		end
+
+		line = `grep editor: #{blux_rc}`
+		match = line =~ /^editor:\s(.+)$/
+		@launch_editor_cmd = $1
+
+		line = `grep html_converter: #{blux_rc}`
+		match = line =~ /^html_converter:\s(.+)$/
+		@html_converter_cmd = $1
+
+		line = `grep blog: #{blux_rc}`
+		match = line =~ /^blog:\s(.+)$/
+		@blog = $1
+
+		line = `grep author_name: #{blux_rc}`
+		match = line =~ /^author_name:\s(.+)$/
+		@author_name = $1
+
+		line = `grep user_name: #{blux_rc}`
+		match = line =~ /^user_name:\s(.+)$/
+		@user_name = $1
+
+		line = `grep password: #{blux_rc}`
+		match = line =~ /^password:\s(.+)$/
+		@password = $1
+
+		puts "editor command: #{@launch_editor_cmd}\n" if verbose
+		validate
+	end
+
+private
+	def validate
+		if (@launch_editor_cmd == nil)
+			STDERR.puts "please specify an editor in .bluxrc: editor: [your editor of choice]\n"
+		end
+
+		if (@html_converter_cmd == nil)
+			STDERR.puts "please specify an html converter in .bluxrc: html_converter: [your converter command of choice]\n"
+		end
+
+		if (@blog == nil)
+			STDERR.puts "please specify your wordpress blog name in .bluxrc: blog: [your blog]\n"
+		end
+
+		if (@author_name == nil)
+			STDERR.puts "please specify an author name in .bluxrc: author_name: [your name]\n"
+		end
+
+		if (@user_name == nil)
+			STDERR.puts "please specify your wordpress user name in .bluxrc: user_name: [your user name]\n"
+		end
+
+		if (@password == nil)
+			STDERR.puts "please specify your wordpress password in .bluxrc: password: [your password]\n"
+		end
+	end
+end

data/lib/blux_option_parser.rb

@@ -0,0 +1,104 @@
+#
+# Copyright 2010 Louis-Philippe Salin de l'Etoile, aka Louis Salin
+# email: louis.phil@gmail.com
+#
+# This file is part of Blux.
+#
+# Blux is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Blux is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Blux.  If not, see <http://www.gnu.org/licenses/>.
+require 'optparse'
+require 'ostruct'
+
+class BluxOptionParser
+	def self.parse(args)
+		options = OpenStruct.new
+		options.verbose = false
+		options.list_preview = false
+		options.list_details = false
+
+		opts = OptionParser.new do |opts|
+			opts.banner = "Usage: blux <command> [options] [attributes]"
+
+			opts.on("-n", "--new", "create a new draft") do 
+				options.command = :new
+			end
+
+			opts.on("-e", "--edit", "edit a draft") do
+				options.command = :edit
+			end
+
+			opts.on("-l", "--list", "list drafts") do
+				options.command = :list
+			end
+
+			opts.on("-s", "--set", "set an attribute on a draft") do
+				options.command = :set
+			end
+
+			opts.on("-c", "--convert", "convert a draft to html") do
+				options.command = :convert
+			end
+
+			opts.on("-o", "--out", "dump the content of a draft to stdout") do
+				options.command = :out
+			end
+
+			opts.on("-p", "--publish", "publish a draft") do
+				options.command = :publish
+			end
+
+			opts.on("-u", "--update", "update a draft") do
+				options.command = :update
+			end
+
+			opts.on("--latest", "work on the latest draft") do
+				options.use_latest = true
+			end
+
+			opts.on("--title TITLE", "work on a draft with title") do |title|
+				options.use_title = true
+				options.title = title
+			end
+
+			opts.on("-f", "--file FILENAME", "work on a specific draft file") do |filename|
+				options.filename = filename
+			end
+
+			opts.on("--set_edit_url", "sets the edit url, given after publishing") do
+				options.command = :set_edit_url
+			end
+
+			opts.on("--with-preview", "show a preview of each draft while listing") do
+				options.list_preview = true
+			end
+
+			opts.on("--details", "show all attributes when listing") do
+				options.list_details = true
+			end
+
+			opts.on("--verbose", "verbose mode") do
+				options.verbose = true
+			end
+
+			opts.on_tail("-h", "--help", "show this message") do
+				puts opts
+				exit
+			end
+		end
+
+		opts.parse!(args)
+
+		options.attributes = args
+		options
+	end
+end

data/lib/draft_manager.rb

@@ -0,0 +1,131 @@
+#
+# Copyright 2010 Louis-Philippe Salin de l'Etoile, aka Louis Salin
+# email: louis.phil@gmail.com
+#
+# This file is part of Blux.
+#
+# Blux is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Blux is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Blux.  If not, see <http://www.gnu.org/licenses/>.
+require 'tempfile'
+require 'json'
+require 'time'
+
+require "#{File.dirname(__FILE__)}/indexer"
+
+class DraftManager
+	attr_reader :launch_editor_cmd
+	attr_reader :temp_dir, :draft_dir
+	attr_reader :index
+
+	include BluxIndexer
+
+	def setup(editor_cmd, temp_dir, draft_dir, options = {})
+		@verbose = options[:verbose] ||= false
+
+		@launch_editor_cmd = editor_cmd
+		@temp_dir = temp_dir
+		@draft_dir = draft_dir
+		@index_file = "#{@draft_dir}/.draft_index"
+
+		system "touch #{@index_file}" unless File.exists? @index_file
+
+		load_index
+	end
+
+	def create_draft
+		temp_file = Tempfile.new('draft', @temp_dir)
+		temp_file.close
+
+		puts "created temp file #{temp_file.path}\nlaunching editor\n" if @verbose
+
+		system "#{@launch_editor_cmd} #{temp_file.path}"
+
+		puts "editor closed. File size: #{temp_file.size}\n" if @verbose
+		if temp_file.size > 0
+			system "mv #{temp_file.path} #{@draft_dir}"
+
+			index_key = File.basename(temp_file.path)
+			puts "adding #{index_key} to draft index\n" if @verbose
+			@index[index_key] = {:creation_time => Time.now.to_s}
+			save_index
+		end
+	end
+
+	def edit_draft(filename)
+		puts "editing draft #{filename}" if @verbose
+
+		check_filename(filename) do  |draft_filename|
+			puts "editing: #{@launch_editor_cmd} #{draft_filename}" if @verbose
+
+			system "#{@launch_editor_cmd} #{draft_filename}"
+			set_attribute(filename, "edited_time", Time.now.to_s)
+		end
+	end
+
+	def list
+		Dir.entries(@draft_dir).reject {|i| i[0] == '.'}
+	end
+
+	def show_info(filename)
+		check_index(filename) do |index|
+			index.to_json
+		end
+	end
+
+	def show_preview(filename)
+		check_filename(filename) do |draft_filename|
+			File.open(draft_filename, 'r') do |f|
+				if f.eof?
+					''
+				else
+					line = f.readline.gsub("\n", '')
+					line.length > 76 ? line[0..75] + '...' : line
+				end
+			end
+		end
+	end
+
+	def output(filename)
+		check_filename(filename) do |draft_filename|
+			File.open(draft_filename, 'r') do |f|
+				if f.eof?
+					''
+				else
+					text = ''
+					f.each do |l|
+						text += l
+					end
+
+					text
+				end
+			end
+		end
+	end
+
+	def get_latest_created_draft
+		check_count do
+			@index.sort do |a,b| 
+				Time.parse(a[1]["creation_time"]) <=> Time.parse(b[1]["creation_time"])
+			end[-1][0]
+		end
+	end
+
+	def get_draft_by_title(title)
+		check_count do
+			@index.keys.each do |key|
+				draft_title = @index[key]["title"]
+				return key if draft_title == title
+			end
+		end
+	end
+end

data/lib/indexer.rb

@@ -0,0 +1,98 @@
+#
+# Copyright 2010 Louis-Philippe Salin de l'Etoile, aka Louis Salin
+# email: louis.phil@gmail.com
+#
+# This file is part of Blux.
+#
+# Blux is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Blux is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Blux.  If not, see <http://www.gnu.org/licenses/>.
+module BluxIndexer
+	def check_index(filename)
+		check_filename(filename) do
+			@index[filename] ||= {}
+			yield @index[filename]
+		end
+	end
+
+	def check_filename(filename)
+		draft_filename = "#{@draft_dir}/#{filename}"
+
+		if (File.exists?(draft_filename))
+			yield draft_filename
+		else
+			STDERR.puts "draft filename #{filename} does not exist\n"
+		end
+	end
+
+	def check_title(filename, attr_key, attr_val)
+		return true unless attr_key.to_s == "title"
+		
+		unique_title = true
+		@index.keys.reject{|k| k == filename}.each do |key|
+			unique_title = false if (@index[key][attr_key.to_s] == attr_val)
+		end
+		
+		STDERR.puts "title '#{attr_val}' is not unique\n" unless unique_title 
+		unique_title
+	end
+
+	def set_attribute(filename, key, val)
+		check_index(filename) do |index|
+			if check_title(filename, key, val)
+				puts "setting attribute #{key} to #{val} in index #{@index_file}" if @verbose
+				index[key.to_s] = val 
+				save_index
+			end
+		end
+	end
+
+	def delete_attribute(filename, attr_name)
+		check_index(filename) do |index|
+			index.delete(attr_name.to_s)
+			save_index
+		end
+	end
+
+	def get_attribute(filename, attribute)
+		check_index(filename) do |index|
+			index[attribute]
+		end
+	end
+
+	def check_count
+		if @index.keys.length > 0
+			yield
+		else
+			STDERR.puts "there is currently no saved index\n"
+		end
+	end
+
+	def load_index
+		puts "creating #{@index_file}\n" if @verbose
+		system "touch #{@index_file}" unless File.exists? @index_file
+
+		str = ''
+		File.open(@index_file, 'r') do |f| 
+			f.each_line {|l| str += l}
+		end
+			
+		@index = str.length > 0 ? JSON.parse(str) : {}
+	end
+
+	def save_index
+		puts "saving index: #{@index.to_json}\n" if @verbose
+		File.open(@index_file, 'w') do |f| 
+			f.write(@index.to_json) if @index
+		end
+	end
+end

data/spec/blog_manager_spec.rb

@@ -0,0 +1,150 @@
+require 'blog_manager.rb'
+
+describe BlogManager do
+	before :each do
+		ENV['HOME'] = File.dirname(__FILE__)
+		@blux_rc = "#{File.dirname(__FILE__)}/.bluxrc"
+		@blux = "#{File.dirname(__FILE__)}/.blux"
+		@blux_dir = "#{File.dirname(__FILE__)}/.blux"
+		@draft_dir = "#{@blux_dir}/draft"
+
+		Dir.mkdir(@blux) unless Dir.exists?(@blux)
+
+		def STDERR.puts(str) end
+
+		@draft_mgr = DraftManager.new
+		@draft_mgr.stub!(:editor_cmd).and_return('gedit')
+		@draft_mgr.stub!(:setup)
+
+		@manager = BlogManager.new(@draft_mgr)
+	end
+
+	after :each do
+		system "rm -Rf #{@blux}"
+		system "rm #{@blux_rc}" if File.exists? @blux_rc
+	end
+
+	context "loading with no config file" do
+		before :each do
+			@manager.load_config
+		end
+
+		it "should create an empty config file it doesn't exist" do
+			File.exists?(@blux_rc).should == true
+		end
+	end
+
+	context "starting the blog manager" do
+		before :each do
+			@manager.start
+		end
+
+		it "should read the HOME variable from the environment" do
+			@manager.home.should == File.dirname(__FILE__)
+		end
+		
+		it "should compute the blux dir" do
+			@manager.blux_dir.should == @blux
+		end
+
+		it "should compute the bluxrc file" do
+			@manager.blux_rc.should == @blux_rc
+		end
+
+		it "should create a .blux folder in the home dir if it doesn't exist" do
+			File.exists?(@blux).should == true
+		end
+
+		it "should create a .tmp folder in the .blux dir if it doesn't exist" do
+			File.exists?("#{@blux}/tmp").should == true
+		end
+
+		it "should create a draft folder in the .blux dir if it doesn't exist" do
+			File.exists?("#{@blux}/draft").should == true
+		end
+
+		it "should create a published post file in the .blux dir if it doesn't exist" do
+			File.exists?("#{@blux}/.published").should == true
+		end
+	end
+
+	context "when using the blog manager" do
+		before :each do
+			File.open("#{@blux}/.published", 'w') do |f|
+				f.write('{"draft1.23":{}}')
+			end
+
+			@manager.start
+		end
+
+		it "should load the published post file" do
+			@manager.index.key?("draft1.23").should == true
+		end
+	end
+
+	context "loading the config and setting up the draft manager" do
+		before :each do
+			create_config
+			@manager.start
+		end
+
+		it "should pass the right configuration to the draft manager" do
+			@draft_mgr.should_receive(:setup).with('gedit', @manager.blux_tmp_dir, @manager.draft_dir, {:verbose => false})
+
+			@manager.load_config
+		end
+	end
+
+	context "when publishing" do
+		before :each do
+			create_config
+
+			File.open(@manager.index_file, 'w') do |f|
+				f.write('{"draft5.67":{"a":1,"b":2}}')
+			end
+
+			@manager.load_config
+			@manager.start
+			@manager.stub!(:system).and_return(nil)
+
+			system "touch #{@manager.draft_dir}/draft5.67"
+		end
+
+		it "should send the proper command" do
+			@manager.should_receive(:system).with("blux --convert -f draft5.67 | blux_wp_publish -t no title --config #{@blux_rc} | blux --set_edit_url -f draft5.67")
+			@manager.publish 'draft5.67'
+		end
+
+		it "should send the command with the title included if it exists" do
+			@draft_mgr.stub!(:get_attribute).and_return('bla')
+
+			@manager.should_receive(:system).with("blux --convert -f draft5.67 | blux_wp_publish -t bla --config #{@blux_rc} | blux --set_edit_url -f draft5.67")
+			@manager.publish 'draft5.67'
+		end
+
+		it "should save the record of published drafts to disk" do
+			@manager.publish 'draft5.67'
+
+			lines = ''
+			File.open(@manager.index_file, 'r') do |f| 
+				f.each_line {|l| lines += l}
+			end
+
+			JSON.parse(lines).key?('draft5.67').should == true
+		end
+
+		it "should add the published time to the attributes of that post" do
+			time = Time.now.to_s
+
+			@manager.publish 'draft5.67'
+			@manager.index["draft5.67"]["published_time"].to_s.should == time
+		end
+	end
+
+	def create_config
+		File.open(@blux_rc, 'w') do |f|
+			f.puts "editor: gedit"
+			f.puts "html_converter: blux_textile_to_html"
+		end
+	end
+end