pdf-inspector 1.0.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+v1.0.0 (13 August 2011)
+* initial release as a standalone gem

data/README

@@ -0,0 +1,39 @@
+PDF::Inspector : A tool for analyzing PDF output
+
+This library provides a number of PDF::Reader[0] based tools for use in testing
+PDF output.  Presently, the primary purpose of this tool is to support the
+tests found in Prawn[1], a pure Ruby PDF generation library.
+
+However, it may be useful to others, so we have made it available as a gem in
+its own right.
+
+= Installation
+
+The recommended installation method is via Rubygems.
+
+  gem install pdf-inspector
+
+= Maintainers
+
+- Brad Ediger
+- Daniel Nelson
+- Jonathan Greenberg
+- James Healy
+
+= Licensing
+
+Matz’s terms for Ruby, GPLv2, or GPLv3. See LICENSING for details. 
+
+= Mailing List
+
+pdf-inspector is maintaiend as a dependency of prawn, the ruby PDF generation
+library.
+
+Any questions or feedback should be sent to the Prawn google group.
+
+http://groups.google.com/group/prawn-ruby
+
+= References
+
+[0] http://github.com/yob/pdf-reader
+[1] http://github.com/sandal/prawn

data/lib/pdf/inspector.rb

@@ -0,0 +1,26 @@
+require "rubygems"
+require "pdf/reader"
+require "pdf/inspector/text" 
+require "pdf/inspector/xobject"
+require "pdf/inspector/extgstate"
+require "pdf/inspector/graphics"
+require "pdf/inspector/page"
+
+module PDF
+  class Inspector
+    def self.analyze(output,*args,&block) 
+      obs = self.new(*args, &block)
+      PDF::Reader.string(output,obs)
+      obs  
+    end         
+    
+    def self.analyze_file(filename,*args,&block)
+      analyze(File.open(filename, "rb") { |f| f.read },*args,&block)
+    end  
+    
+    def self.parse(obj)
+      PDF::Reader::Parser.new(
+        PDF::Reader::Buffer.new(StringIO.new(obj)), nil).parse_token
+    end
+  end
+end

data/lib/pdf/inspector/extgstate.rb

@@ -0,0 +1,18 @@
+module PDF
+  class Inspector
+    class ExtGState < Inspector
+      attr_accessor :extgstates
+
+      def initialize
+        @extgstates = []
+      end
+
+      def resource_extgstate(*params)
+        @extgstates << {
+                        :opacity => params[1][:ca],
+                        :stroke_opacity => params[1][:CA]
+                        }
+      end
+    end
+  end
+end

data/lib/pdf/inspector/graphics.rb

@@ -0,0 +1,168 @@
+module PDF
+  class Inspector 
+    module Graphics                   
+      class Line < Inspector
+        attr_accessor :points, :widths
+
+        def initialize
+          @points = []
+          @widths = [] 
+        end  
+
+        def append_line(*params)
+          @points << params
+        end    
+
+        def begin_new_subpath(*params)
+          @points << params
+        end           
+        
+        def set_line_width(params)
+          @widths << params
+        end
+
+      end 
+      
+      class Rectangle < Inspector
+        attr_reader :rectangles
+
+        def initialize
+          @rectangles = []     
+        end
+
+        def append_rectangle(*params) 
+          @rectangles << { :point  => params[0..1],    
+                           :width  => params[2],
+                           :height => params[3]  }     
+        end
+      end
+      
+      class Curve < Inspector
+
+        attr_reader :coords
+
+        def initialize
+          @coords = []          
+        end   
+
+        def begin_new_subpath(*params)   
+          @coords += params
+        end
+
+        def append_curved_segment(*params)
+          @coords += params
+        end           
+
+      end   
+      
+      class Color < Inspector
+        attr_reader :stroke_color, :fill_color, :stroke_color_count, 
+                    :fill_color_count, :stroke_color_space_count, :color_space
+                    
+        def initialize
+          @stroke_color_count = 0
+          @fill_color_count   = 0
+          @stroke_color_space_count   = {:DeviceCMYK => 0, :DeviceRGB => 0}
+        end
+
+        def set_color_for_stroking_and_special(*params)
+          @stroke_color_count += 1
+          @stroke_color = params
+        end
+
+        def set_color_for_nonstroking_and_special(*params)
+          @fill_color_count += 1
+          @fill_color = params
+        end
+        
+        def set_stroke_color_space(*params)
+          @stroke_color_space_count[params[0]] += 1
+          @color_space = params[0]
+        end
+
+      end 
+      
+      class Dash < Inspector
+        attr_reader :stroke_dash, :stroke_dash_count
+
+        def initialize
+          @stroke_dash_count = 0
+        end
+
+        def set_line_dash(*params)
+          @stroke_dash_count += 1
+          @stroke_dash = params
+        end
+      end
+      
+      class CapStyle < Inspector
+        attr_reader :cap_style, :cap_style_count
+
+        def initialize
+          @cap_style_count = 0
+        end
+
+        def set_line_cap_style(*params)
+          @cap_style_count += 1
+          @cap_style = params[0]
+        end
+      end
+      
+      class JoinStyle < Inspector
+        attr_reader :join_style, :join_style_count
+
+        def initialize
+          @join_style_count = 0
+        end
+
+        def set_line_join_style(*params)
+          @join_style_count += 1
+          @join_style = params[0]
+        end
+      end
+      
+      class Matrix < Inspector
+        attr_reader :matrices
+
+        def initialize
+          @matrices = []
+        end
+
+        def concatenate_matrix(*values)
+          @matrices << values
+        end
+      end
+      
+      class State < Inspector
+        attr_reader :save_graphics_state_count, :restore_graphics_state_count
+
+        def initialize
+          @save_graphics_state_count    = 0
+          @restore_graphics_state_count = 0 
+        end
+        
+        def save_graphics_state(*values)
+          @save_graphics_state_count += 1
+        end
+
+        def restore_graphics_state(*values)
+          @restore_graphics_state_count += 1
+        end
+      end
+
+      class Pattern < Inspector
+        attr_reader :patterns
+
+        def initialize
+          super
+          @patterns = {}
+        end
+
+        def resource_pattern(name, dict)
+          @patterns[name] = dict
+        end
+      end
+      
+    end
+  end
+end

data/lib/pdf/inspector/page.rb

@@ -0,0 +1,25 @@
+module PDF
+  class Inspector
+    class Page < Inspector
+      attr_reader :pages
+      
+      def initialize
+        @pages = []
+      end
+
+      def begin_page(params)
+        @pages << {:size => params[:MediaBox][-2..-1], :strings => []}
+      end                       
+
+      def show_text(*params)
+        @pages.last[:strings] << params[0]
+      end
+
+      def show_text_with_positioning(*params)      
+        # ignore kerning information
+        @pages.last[:strings] << params[0].reject { |e| Numeric === e }.join
+      end
+      
+    end   
+  end
+end

data/lib/pdf/inspector/text.rb

@@ -0,0 +1,51 @@
+module PDF
+  class Inspector
+    class Text < Inspector                    
+      attr_accessor :font_settings, :size, :strings
+      attr_accessor :character_spacing, :word_spacing
+      attr_accessor :kerned, :text_rendering_mode
+
+      def initialize     
+        @font_settings = []
+        @fonts = {}
+        @strings = []
+        @character_spacing = []
+        @word_spacing = []
+        @kerned = []
+        @text_rendering_mode = []
+      end
+
+      def resource_font(*params)
+        @fonts[params[0]] = params[1].basefont
+      end
+
+      def set_text_font_and_size(*params)     
+        @font_settings << { :name => @fonts[params[0]], :size => params[1] }
+      end     
+
+      def show_text(*params)
+        @kerned << false
+        @strings << params[0]
+      end
+
+      def show_text_with_positioning(*params)      
+        @kerned << true
+        # ignore kerning information
+        @strings << params[0].reject { |e| Numeric === e }.join
+      end
+
+      def set_text_rendering_mode(*params)
+        @text_rendering_mode << params[0]
+      end
+
+      def set_character_spacing(*params)
+        @character_spacing << params[0]
+      end
+
+      def set_word_spacing(*params)
+        @word_spacing << params[0]
+      end
+      
+    end                                       
+  end
+end

data/lib/pdf/inspector/xobject.rb

@@ -0,0 +1,25 @@
+module PDF
+  class Inspector
+    class XObject < Inspector
+      attr_accessor :page_xobjects, :xobject_streams
+
+      def initialize
+        @page_xobjects = []
+        @xobject_streams = {}
+      end
+
+      def resource_xobject(*params)
+        @page_xobjects.last << params.first
+        store_streams(params.first, params.last)
+      end
+
+      def begin_page(*params)
+        @page_xobjects << [] 
+      end
+      
+      def store_streams(resource_name, stream)
+        @xobject_streams[resource_name] = stream
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: pdf-inspector
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Gregory Brown
+- Brad Ediger
+- Daniel Nelson
+- Jonathan Greenberg
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-13 00:00:00.000000000 -05:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: &9952680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *9952680
+description: ! 'This library provides a number of PDF::Reader[0] based tools for use
+  in testing
+
+  PDF output.  Presently, the primary purpose of this tool is to support the
+
+  tests found in Prawn[1], a pure Ruby PDF generation library.
+
+
+  However, it may be useful to others, so we have made it available as a gem in
+
+  its own right.
+
+
+  [0] https://github.com/yob/pdf-reader
+
+  [1] https://github.com/sandal/prawn
+
+'
+email:
+- gregory.t.brown@gmail.com
+- brad@bradediger.com
+- dnelson77@gmail.com
+- greenberg@entryway.net
+- jimmy@deefa.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG
+- README
+files:
+- lib/pdf/inspector.rb
+- lib/pdf/inspector/graphics.rb
+- lib/pdf/inspector/extgstate.rb
+- lib/pdf/inspector/page.rb
+- lib/pdf/inspector/text.rb
+- lib/pdf/inspector/xobject.rb
+- CHANGELOG
+- README
+has_rdoc: true
+homepage: https://github.com/sandal/pdf-inspector
+licenses: []
+post_install_message: 
+rdoc_options:
+- --title
+- PDF::Inspector
+- --main
+- README
+- -q
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A tool for analyzing PDF output
+test_files: []