podoff 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01c13867339ca5cedc0ff2682a70a94686aa04a1fc642fa9479d491accdc93fc
-  data.tar.gz: e340f680e7c5c76d783b09abdb1872707a6fca4b4ba972ccb882aed1b82ff2a8
+  metadata.gz: d1ef5ecc8cb922c5bd2725af0c936c9eb3291a353a05b2e927e103147e0da499
+  data.tar.gz: e800a9be42f5c3c9ba12097d8c4edfad1a6e8722ae56887710c7939e65616095
 SHA512:
-  metadata.gz: 8445ecd4ba92939e54662f32144cfedb3796b21c197db2a4efdf5f36925851c02a82eaa76a502f5b135ddc016a2f98559bd361a96f196fd531957b812d9406b0
-  data.tar.gz: 5c19354e0060eacbcf9402972ed3e7d3eeaf3db264d87c894484fb8105128212495a7283c2e675032db99db04e389cbba526fc775670a1934519a662bddb0809
+  metadata.gz: 2f9ab0d2349c2059c7c8d43695d4db10452cd0b4c2e86628852c5f858e8e6da918e93f3a57f200a9d0f88118ad328bf540d4233d1dff07a5407e4c9afc1ab17a
+  data.tar.gz: 31ce324bce4473a96d8aa07737c1d1938df45af31987f05504f9809b248cbb517e37cdc6f3e7cec8dd4d7164aaafa734a6798ec1f2d915bb5551a552d7f609cb

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 # CHANGELOG.md
 
 
+## podoff 1.3.0  released 2020-03-30
+
+* Introduce Podoff::Stream#line
+* Introduce Podoff::Stream#rectangle
+
+
 ## podoff 1.2.4  released 2019-03-12
 
 * Let Stream#bt/#text accept a nil string

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2015-2019, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2015-2020, John Mettraux, jmettraux@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -237,7 +237,7 @@ class Podoff::Obj
 
 ### Podoff::Stream
 
-TODO
+Here are the methods used to write to streams.
 
 ```ruby
 class Podoff::Stream
@@ -245,18 +245,44 @@ class Podoff::Stream
   # set the current font and font size for the stream
   #
   def tf(font_name, font_size)
-  alias :font :tf
+  alias font tf
 
   # set the current color for the stream
   #
   def rg(red, green, blue)
-  alias :rgb :rg
-  alias :color :rg
+  def rg(string) # like '#fffff' or 'white'
+  alias rgb rg
+  alias color rg
 
   # write a piece of text at a given position
   #
   def bt(x, y, text)
-  alias :text :bt
+  def bt(x, y, text, rgb: 'blue')
+  alias text bt
+
+  # draw a rectangle
+  #
+  def re(x, y, *a)
+  alias rect re
+  alias rectangle re
+    #
+  st.re(10, 20, 30, 40, rgb: [ 0.0, 0.0, 0.0 ])
+  st.rect(11, 21, w: 31, h: 41, rgb: [ 0.1, 0.1, 0.1 ])
+  st.rectangle(12, 22, 32, 42, rgb: [ 0.2, 0.2, 0.2 ])
+  # ...
+
+  # draw a line
+  #
+  def line(x0, y0, x1, y1, *a)
+    #
+  st.line(1, 1, 2, 2)
+  st.line(1, 1, 2, 2, 3, 3)
+  st.line([ 1, 1 ], [ 2, 2 ], [ 3, 3 ])
+  st.line([ 1, 1 ], [ 2, 2 ], [ 3, 3 ], rgb: [ 0.5, 0.5, 0.5 ])
+  st.line(1, 1, 2, 2, rgb: [ 0.7, 0.7, 0.7 ])
+  # ...
+  st.line(1, 1, 2, 2, rgb: [ 0.7, 0.7, 0.7 ], width: 0.3)
+  # ...
 ```
 
 

data/lib/podoff.rb

@@ -6,7 +6,7 @@ require 'stringio'
 
 module Podoff
 
-  VERSION = '1.2.4'
+  VERSION = '1.3.0'
 
   def self.load(path, encoding)
 
@@ -437,7 +437,7 @@ module Podoff
 
       add_to_attribute(:contents, re)
     end
-    alias :insert_content :insert_contents
+    alias insert_content insert_contents
 
     def to_s
 
@@ -509,33 +509,81 @@ module Podoff
 
       @font = "/#{n} #{font_size} Tf "
     end
-    alias :font :tf
+    alias font tf
 
-    def rg(red, green, blue)
+    def rg(*a)
 
-      @color = "#{red} #{green} #{blue} rg "
+      @color = to_rg(a)
     end
-    alias :color :rg
-    alias :rgb :rg
+    alias color rg
+    alias rgb rg
 
-    def bt(x, y, text)
+    def bt(x, y, text, opts={})
 
       return unless text
 
-      @content.write "\n" if @content.size > 0
-      @content.write "BT "
-      @content.write @font if @font
-      @content.write @color if @color
-      @content.write "#{x} #{y} Td (#{escape(text)}) Tj"
-      @content.write " ET"
+      rgb = opts[:rgb]
+
+      @content << "\n" if @content.size > 0
+      @content << 'BT '
+      @content << @font if @font
+      if rgb
+        @content << to_rg(rgb)
+      elsif @color
+        @content << @color
+      end
+      @content << "#{x} #{y} Td (#{escape(text)}) Tj"
+      @content << ' ET'
     end
-    alias :text :bt
+    alias text bt
 
     def write(text)
 
       @content.write(text)
     end
 
+      #def re(x, y, w, h, opts={})
+      #def re([ x, y ], [ w, h ], opts={})
+      #def re([ x, y ], opts)
+      #
+    def re(x, *a)
+
+      a = [ x, a ].flatten
+      opts = a.last.is_a?(Hash) ? a.pop : {}
+      x = a.shift; y = a.shift
+
+      rgb = opts[:rgb]
+      w = opts[:width] || opts[:w] || a[0]
+      h = opts[:height] || opts[:h] || a[1]
+
+      @content << "\n" if @content.size > 0
+      @content << to_rg(rgb) if rgb
+      @content << lineup(x, y, w, h) << ' re f'
+    end
+    alias rect re
+    alias rectangle re
+
+      #def line(x0, y0, x1, y1, x2, y2, ..., opts={})
+      #def line([ x0, y0 ], [ x1, y1 ], [ x2, y2 ], ..., opts={})
+      #
+    def line(x0, y0, *a)
+
+      a = [ x0, y0, a ].flatten
+      opts = a.last.is_a?(Hash) ? a.pop : {}
+      x0, y0, *xys = a
+
+      rgb = opts[:rgb] || opts[:rg]
+      w = opts[:width] || opts[:w]
+
+      @content << "\n" if @content.size > 0
+      @content << w.to_s << ' w ' if w
+      @content << to_rg(rgb) if rgb
+      @content << lineup(x0, y0) << ' m '
+      xys.each_slice(2) { |x, y|
+        @content << lineup(x, y, 'l ') }
+      @content << 'h S'
+    end
+
     def to_s
 
       s = @content.string
@@ -552,9 +600,40 @@ module Podoff
 
     protected
 
-    def escape(s)
+    def escape(s); s.gsub(/\(/, '\(').gsub(/\)/, '\)'); end
+    def lineup(*a); a.flatten.collect(&:to_s).join(' '); end
+
+    COLORS = {
+      'black' => [ 0.0, 0.0, 0.0 ],
+      'white' => [ 1.0, 1.0, 1.0 ],
+      'red' => [ 1.0, 0.0, 0.0 ],
+      'green' => [ 0.0, 1.0, 0.0 ],
+      'blue' => [ 0.0, 0.0, 1.0 ] }
+
+    def to_rg(a)
+
+      a = a[0].to_s if a.length == 1
+
+      lineup(
+        if a.is_a?(Array) && a.length == 3
+          a
+        elsif a.is_a?(String) && a.match(/^#?([0-9a-z]{3}|[0-9a-z]{6})$/i)
+          hex_to_rgb(a)
+        else
+          COLORS[a] || COLORS['red'] # else, stand out in RED
+        end,
+        'rg ')
+    end
+
+    def hex_to_rgb(s)
+
+      s = s[1..-1] if s[0, 1] == '#'
 
-      s.gsub(/\(/, '\(').gsub(/\)/, '\)')
+      s.chars
+        .each_slice(
+          s.length == 6 ? 2 : 1)
+        .collect { |x|
+          sprintf('%0.4f', (x.join.to_i(16) / 255.0)).gsub(/0+$/, '0') }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: podoff
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-12 00:00:00.000000000 Z
+date: 2020-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -56,8 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: a tool to deface PDF documents