prawn_calendar 0.0.1 → 1.0.0

data/README.md

@@ -32,7 +32,7 @@ For the impatient ...
 
 ~~~~ruby
   it "implicit creates a calendar" do
-    Prawn::Document.generate("implicit.pdf") do
+    Prawn::Document.generate("calendar.pdf") do
       calendar=PrawnCalendar::WeeklyCalendar.new(self)
       calendar.mk_calendar([20,700], width:500,height:250) do
                 cal_entry("2013-05-04T08:00:00+01:00", "2013-05-04T19:00:00", "cc 7as ist ein test, der laufen muss")
@@ -40,9 +40,15 @@ For the impatient ...
       end
     end
   end
-
 ~~~~
 
+## History
+
+* 1.0.0 2014-08-14
+
+    Released as 1.0.0 after testing with Prawn 1.2.1
+
+
 ## Limitations
 
 * It does not handle schedules over multiple days

data/lib/prawn_calendar.rb

@@ -4,26 +4,11 @@ require 'time'
 require 'date'
 
 
-module Prawn
-  class Document
-
-    # Defines the grid system for a particular document.  Takes the number of
-    # rows and columns and the width to use for the gutter as the
-    # keys :rows, :columns, :gutter, :row_gutter, :column_gutter
-    #
-    def define_grid(options = {})
-      @grid = Grid.new(self, options)
-      @boxes = nil  # see
-    end
-  end
-end
-
+# this module holds all the stuff for PrawnCalendar
 module PrawnCalendar
 
   #
-  # [ class description]
-  #
-  # @author [author]
+  # This Class represents a weekly calendar
   #
   class WeeklyCalendar
     # the Prawn instance xxx
@@ -38,6 +23,9 @@ module PrawnCalendar
     # the number of divisions in calender columns
     # this is to adjust the proportion of the first and
     # the subsequent columns
+    # 
+    # for example c_col_division = 5 and c_first_col_division = 2
+    # makes the first column width be 2/5 of the calender column width
     attr_accessor :c_col_division
 
     # the end of the interval
@@ -64,6 +52,8 @@ module PrawnCalendar
 
     # the number of divisions in the first column
     # the one showing the time
+    # 
+    # see [c_col_division] for more details.
     attr_accessor :c_firstcol_division
 
     # The font size of the calendar annotations
@@ -97,7 +87,7 @@ module PrawnCalendar
       d = Date.iso8601(day)
       # note that we start the week on monday, therefore d -(d-1).wday
       # note that Date adds days, while Time adds seconds
-      # 
+      #
       # compute the beginning of the week
       @c_date_start = (d -(d-1).wday).to_time
       # set end to the last second of end date
@@ -180,7 +170,7 @@ module PrawnCalendar
     # @param  text [String] The text of calender entry
     # @param  extraargs [Hash] additional arguments
     #         :recurring true/false
-    # 
+    #
     # @return nil
     #
     def cal_entry(starttime, endtime, text, extraargs={})
@@ -292,108 +282,108 @@ module PrawnCalendar
         end
 
         if recurring==true then
-        @pdf.rounded_rectangle([@pdf.bounds.width  - 2, @c_entry_gutter], # startpoint
-                               2 , # width
-                               2 , # height
-                               @c_entry_radius                 # radius
-                               )
-        @pdf.fill_and_stroke
-      end
+          @pdf.rounded_rectangle([@pdf.bounds.width  - 2, @c_entry_gutter], # startpoint
+                                 2 , # width
+                                 2 , # height
+                                 @c_entry_radius                 # radius
+                                 )
+          @pdf.fill_and_stroke
+        end
 
 
 
-      # text is limited to gutter. Therefore gutter needs to be doubled
-      # no limit at right and bottom
-      excess_text = @pdf.text_box text,
-        :at => [@c_entry_gutter +2, @pdf.bounds.height- 2*@c_entry_gutter-1], # need 1 pixel more a the top
-        :width    => @pdf.bounds.width-4*@c_entry_gutter -2*@c_entry_right_gutter,
-        :height   => @pdf.bounds.height-4*@c_entry_gutter,
-        :overflow => :truncate,
-        :kerning  => true,
-        :inline_format => true,
-        :size     => @c_entry_fontsize
+        # text is limited to gutter. Therefore gutter needs to be doubled
+        # no limit at right and bottom
+        excess_text = @pdf.text_box text,
+          :at => [@c_entry_gutter +2, @pdf.bounds.height- 2*@c_entry_gutter-1], # need 1 pixel more a the top
+          :width    => @pdf.bounds.width-4*@c_entry_gutter -2*@c_entry_right_gutter,
+          :height   => @pdf.bounds.height-4*@c_entry_gutter,
+          :overflow => :truncate,
+          :kerning  => true,
+          :inline_format => true,
+          :size     => @c_entry_fontsize
+      end
+      nil
     end
-    nil
-  end
 
 
 
-  #
-  # Creates an empty calendar
-  #
-  # @param  ll [Array] the start point of the calendar
-  #                    values are points, 0,0 is the lower left corner of the calender
-  #                    see Prawn::Document.bounding_box for details
-  # @param  opts [Hash] [the options, keys: :width, :height]
-  # @param  &block [Proc] The statements to fill the calendar.
-  #
-  # @return [type] [description]
-  def mk_calendar(ll, opts, &block)
-    @pdf.bounding_box(ll, width: opts[:width], height: opts[:height]) do
-      @pdf.stroke_bounds
-      rows       = (2 + @c_time_end - @c_time_start +1 + @c_extra_rows) * @c_row_division
-      columns    = @c_firstcol_division + @c_days.count * @c_col_division
+    #
+    # Creates an empty calendar
+    #
+    # @param  ll [Array] the start point of the calendar
+    #                    values are points, 0,0 is the lower left corner of the calender
+    #                    see Prawn::Document.bounding_box for details
+    # @param  opts [Hash] [the options, keys: :width, :height]
+    # @param  &block [Proc] The statements to fill the calendar.
+    #
+    # @return [type] [description]
+    def mk_calendar(ll, opts, &block)
+      @pdf.bounding_box(ll, width: opts[:width], height: opts[:height]) do
+        @pdf.stroke_bounds
+        rows       = (2 + @c_time_end - @c_time_start +1 + @c_extra_rows) * @c_row_division
+        columns    = @c_firstcol_division + @c_days.count * @c_col_division
 
-      @pdf.define_grid(:columns => columns, :rows => rows, :gutter => 0)
+        @pdf.define_grid(:columns => columns, :rows => rows, :gutter => 0)
 
-      # the frames
-      @pdf.line_width 1
-      mk_entry([0,0],
-               [rows - 1, columns-1], "") # outer frame
+        # the frames
+        @pdf.line_width 1
+        mk_entry([0,0],
+                 [rows - 1, columns-1], "") # outer frame
 
-      mk_entry([2 * @c_row_division, @c_firstcol_division],
-               [rows - 1 , columns-1], "") # inner frame
+        mk_entry([2 * @c_row_division, @c_firstcol_division],
+                 [rows - 1 , columns-1], "") # inner frame
 
-      mk_entry([2 * @c_row_division, 0],
-               [rows -1, @c_firstcol_division - 1], "") # left frame
+        mk_entry([2 * @c_row_division, 0],
+                 [rows -1, @c_firstcol_division - 1], "") # left frame
 
-      # the day - line
-      row=0;col=@c_firstcol_division
-      curday=@c_date_start.to_date
+        # the day - line
+        row=0;col=@c_firstcol_division
+        curday=@c_date_start.to_date
 
-      @c_days.each do |i|
+        @c_days.each do |i|
 
-        columnhead="#{i} #{curday.strftime('%d.%m.')}"
-        mk_entry([row,col], [row+@c_row_division-1, col+@c_col_division-1], columnhead)
-        #require 'pry';binding.pry
-        curday=curday+1
-        col += @c_col_division
-      end
+          columnhead="#{i} #{curday.strftime('%d.%m.')}"
+          mk_entry([row,col], [row+@c_row_division-1, col+@c_col_division-1], columnhead)
+          #require 'pry';binding.pry
+          curday=curday+1
+          col += @c_col_division
+        end
 
-      # the day after line
-      row=@c_row_division; col=@c_firstcol_division
-      @pdf.line_width 0.75
-      @c_days.each do |i|
-        mk_entry([row, col], [rows -1, col + @c_col_division - 1], "")
-        col+=@c_col_division
-      end
+        # the day after line
+        row=@c_row_division; col=@c_firstcol_division
+        @pdf.line_width 0.75
+        @c_days.each do |i|
+          mk_entry([row, col], [rows -1, col + @c_col_division - 1], "")
+          col+=@c_col_division
+        end
 
-      #the  calendar fields
-      @pdf.line_width "0.1"
-      col=0;row=@c_row_division
+        #the  calendar fields
+        @pdf.line_width "0.1"
+        col=0;row=@c_row_division
 
-      # the rows
-      rowlabels=Array(@c_time_start .. @c_time_end).map{|i| "0#{i}.00"[-5..5]}
+        # the rows
+        rowlabels=Array(@c_time_start .. @c_time_end).map{|i| "0#{i}.00"[-5..5]}
 
-      a=[" ", rowlabels, [].fill(" ", 0, @c_extra_rows)]
-      a.flatten.each do |i|
+        a=[" ", rowlabels, [].fill(" ", 0, @c_extra_rows)]
+        a.flatten.each do |i|
 
-        # the first column
-        # -1 bcause it denotes tha last filled cell, not the next unfilled one
-        mk_entry([row,col],[row + @c_row_division - 1, col+@c_firstcol_division - 1], "#{i}")
+          # the first column
+          # -1 bcause it denotes tha last filled cell, not the next unfilled one
+          mk_entry([row,col],[row + @c_row_division - 1, col+@c_firstcol_division - 1], "#{i}")
 
-        # the other columns
-        icol=@c_firstcol_division
-        (1..7).each do |i|
-          mk_entry([row, icol], [row + @c_row_division -1, icol + @c_col_division - 1], " ")
-          icol=icol + @c_col_division
+          # the other columns
+          icol=@c_firstcol_division
+          (1..7).each do |i|
+            mk_entry([row, icol], [row + @c_row_division -1, icol + @c_col_division - 1], " ")
+            icol=icol + @c_col_division
+          end
+          row += @c_row_division
         end
-        row += @c_row_division
-      end
 
-      #yield the block
-      instance_eval(&block)
+        #yield the block
+        instance_eval(&block)
+      end
     end
   end
 end
-end

data/lib/prawn_calendar/version.rb

@@ -1,3 +1,3 @@
 module PrawnCalendar
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/prawn_calendar.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "prawn" # "~> 1.0.0.rc2"
+  spec.add_dependency "prawn", "~> 1.2.1"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/spec/output/testcalendar.pdf

@@ -17,7 +17,7 @@ endobj
 >>
 endobj
 4 0 obj
-<< /Length 39762
+<< /Length 39763
 >>
 stream
 q
@@ -3220,7 +3220,7 @@ endobj
 >>
 endobj
 8 0 obj
-<< /Length 34119
+<< /Length 34120
 >>
 stream
 q

data/testresults/test_results.html

@@ -286,16 +286,16 @@ a {
   <dl style="margin-left: 0px;">
   <dt id="example_group_1" class="passed">PrawnCalendar::WeeklyCalendar</dt>
     <script type="text/javascript">moveProgressBar('25.0');</script>
-    <dd class="example passed"><span class="passed_spec_name">connects to a pdf document</span><span class='duration'>0.00026s</span></dd>
+    <dd class="example passed"><span class="passed_spec_name">connects to a pdf document</span><span class='duration'>0.00038s</span></dd>
     <script type="text/javascript">moveProgressBar('50.0');</script>
-    <dd class="example passed"><span class="passed_spec_name">creates a calendar</span><span class='duration'>0.30364s</span></dd>
+    <dd class="example passed"><span class="passed_spec_name">creates a calendar</span><span class='duration'>0.39653s</span></dd>
     <script type="text/javascript">moveProgressBar('75.0');</script>
-    <dd class="example passed"><span class="passed_spec_name">implicit creates a calendar</span><span class='duration'>0.04820s</span></dd>
+    <dd class="example passed"><span class="passed_spec_name">implicit creates a calendar</span><span class='duration'>0.05935s</span></dd>
     <script type="text/javascript">moveProgressBar('100.0');</script>
-    <dd class="example passed"><span class="passed_spec_name">explicit creates a calendar</span><span class='duration'>0.06581s</span></dd>
+    <dd class="example passed"><span class="passed_spec_name">explicit creates a calendar</span><span class='duration'>0.05927s</span></dd>
   </dl>
 </div>
-<script type="text/javascript">document.getElementById('duration').innerHTML = "Finished in <strong>0.41880 seconds</strong>";</script>
+<script type="text/javascript">document.getElementById('duration').innerHTML = "Finished in <strong>0.51654 seconds</strong>";</script>
 <script type="text/javascript">document.getElementById('totals').innerHTML = "4 examples, 0 failures";</script>
 </div>
 </div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn_calendar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-25 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3949576610573311762
+      hash: -965068968699314115
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -165,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3949576610573311762
+      hash: -965068968699314115
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25