prawn_commander 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+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.rdoc

@@ -0,0 +1,17 @@
+= Prawn Commander
+
+Command center for prawn commands that enable logging commands before or without executing them.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+# require 'rubygems'
+# require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "prawn_commander"
+    gem.summary = %Q{Command center for prawn commands that enable logging}
+    gem.description = %Q{Command center for prawn commands that enable logging commands before or without executing them}
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/prawn_commander"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta13"
+    gem.add_dependency "prawn", ">= 0.8.4"    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+# require 'spec/rake/spectask'
+# Spec::Rake::SpecTask.new(:spec) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.spec_files = FileList['spec/**/*_spec.rb']
+# end
+# 
+# Spec::Rake::SpecTask.new(:rcov) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
+# 
+# task :spec => :check_dependencies
+# 
+# task :default => :spec
+# 
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# 
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "prawn_commander #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/prawn_commander.rb

@@ -0,0 +1,60 @@
+module Howrah
+  module Prawn
+    class Commander      
+      attr_accessor :prawn_document, :prawn_commands, :options
+    
+      def initialize(prawn_document, options = {:dry_run => true})
+        @prawn_document = prawn_document
+        @prawn_commands = []
+        @options = options
+      end
+      
+      def raw_prawn_commands
+        raw_commands = []
+        prawn_commands.each do |command|
+          args = command[:args].size == 1 ? command[:args][0] : command[:args]          
+          # arg_str = args
+          arg_str = case args 
+            when Array
+              args.map{|a| a.inspect}.join(',')
+            else
+              args
+          end
+          raw_commands << "#{command[:method]} #{arg_str}"
+        end
+        raw_commands
+      end
+
+      def print_raw_prawn_commands
+        puts raw_prawn_commands.join("\n")
+      end
+    
+      def prawn_command(method, *args, &block)
+        raise "#{method} is not a valid prawn command on a prawn document" if !valid_prawn_command?(method) 
+        add_command(method, args.dup, block != nil)
+
+        # make clone of command to ensure the original is not in any way modified internally by prawn  
+        cmd = Marshal.load( Marshal.dump(prawn_commands.last) )        
+        prawn_document.send cmd[:method], *cmd[:args] if !options[:dry_run]              
+      end
+
+      protected
+      
+      def valid_prawn_command?(method)
+        prawn_document.respond_to? method      
+      end
+          
+      def add_command(method, args, has_block)
+        cmd = command(method, args, has_block)
+        prawn_commands << cmd.dup
+      end            
+      
+      def command(method, args, has_block)
+        cmd = {:method => method}
+        cmd.merge! :block => has_block if has_block
+        cmd.merge! :args => args if !args.flatten.empty?
+        cmd 
+      end
+    end
+  end
+end

data/spec/matcher/command_matcher.rb

@@ -0,0 +1,27 @@
+module Matchers  
+  class PrawnCommand
+    def initialize(method, args)
+      @expected = {:method => method, :args => args}
+    end
+
+    def matches?(actual)
+      @actual = actual
+      @actual == @expected
+    end
+
+    def failure_message
+      "expected command #{@expected.inspect} but got command '#{@actual.inspect}'"
+    end
+
+    def negative_failure_message
+      "expected command '#{@expected..inspect}' but found command '#{@actual.inspect}'"
+    end
+  end
+
+  def be_command(method, args)    
+    args = [args] if !args.kind_of? Array    
+    args = [args] if method == :formatted_text_box && !args[0].kind_of?(Array)
+    PrawnCommand.new(method, args)  
+  end
+end
+

data/spec/prawn_commander_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
+
+describe Howrah::Prawn::Commander do                 
+  let (:doc)       { Prawn::Document.new(:page_size => "A4") }  
+
+  before(:each) do
+    @commander = Howrah::Prawn::Commander.new doc
+  end
+
+  context "clean commander" do    
+    it "should have a prawn document" do
+      @commander.prawn_document.should == doc
+    end      
+
+    context "issue 'move_down' prawn command" do
+      it "should add 'move_down' to command stack" do        
+        @commander.prawn_command(:move_down, 10)
+        @commander.prawn_commands.first.should be_command(:move_down, 10)
+      end          
+    end
+
+    context "issue 'go_down' prawn command" do
+      it "should raise error and NOT add command to prawn command stack" do
+        lambda { @commander.prawn_command(:go_down, 10) }.should raise_error                
+        @commander.prawn_commands.first.should_not be_command(:go_down, 10)
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'rspec/autorun'   
+require 'prawn'
+require 'prawn_commander'
+require 'matcher/command_matcher'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.include(Matchers)    
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: prawn_commander
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-25 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta13
+        version: 2.0.0.beta13
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 4
+        version: 0.8.4
+  type: :runtime
+  version_requirements: *id002
+description: Command center for prawn commands that enable logging commands before or without executing them
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/prawn_commander.rb
+- spec/matcher/command_matcher.rb
+- spec/prawn_commander_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/prawn_commander
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Command center for prawn commands that enable logging
+test_files: 
+- spec/matcher/command_matcher.rb
+- spec/prawn_commander_spec.rb
+- spec/spec_helper.rb