teaching_printables 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e8cc77020eb961d443b4a55b7ee55957a595ccd
-  data.tar.gz: 45e54de39a3445a49b6f3cd8b7143e088fa27ee6
+  metadata.gz: 917c84946f09309acdaf431d40d42794be9b5c29
+  data.tar.gz: 66cf3313c463a6cce11c5e19724e9664e398b154
 SHA512:
-  metadata.gz: 97d554c065d4b76fbe75cc71127e79204111a4e986aa7032cf34395af2d8bc39cafda5874b665fe300076b7a62ba937f9a0e9f80f66b9198f6f078f5228930c2
-  data.tar.gz: c6931e02bafd8a5bec5ca7feef2946a63cf35ace1608aba85257e3be15425e756c059f4b95fd3fe4e9b63fe2ff5a7bc66b7c93cb4c1cd91060591ef854cadb6b
+  metadata.gz: ed06053e013045c4b764d037c4b4a316130bf4ff2d69c29b7427617c6644629ce90d588e5681c40cd2c285aa2589975c80644ed6903a1ffcf26df5412f79b474
+  data.tar.gz: 54b68331bbd9945395de256ed6d7e2559a0195061abc6f7ae386f70e4cc5a8fae7101e4d524571648bcb715a8ba493d14f4bb50edcbf7a052417b20553389c46

data/Rakefile

@@ -1,8 +1,10 @@
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-desc "Run tests"
 task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "teaching_printables"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/flashcards_AVERY5371

@@ -3,4 +3,4 @@
 #Usage: ./bin/flashcards_AVERY5371 rug mug slug but cut tub sub hub mud up
 require 'teaching_printables'
 
-TeachingPrintables::grid_sheet_with_content(ARGV)
+TeachingPrintables::Factory.avery5371_with_array_content(ARGV, "output.pdf")

data/bin/quad_ruled_paper

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+#Usage: ./bin/quad_ruled_paper <number_of_pages> <rule_size> <rule_unit>
+#eg:    ./bin/quad_ruled_paper 2 1 cm
+#       ./bin/quad_ruled_paper 2 18 
+# => rule_unit defaults to points
+
+require 'teaching_printables'
+require 'optparse'
+require 'ostruct'
+
+class Parser
+  
+  def self.parse(args)
+    
+    options = OpenStruct.new
+    options.rule_unit = ''
+  
+    optparser = OptionParser.new do |opts|
+      opts.banner = "Usage: quad_ruled_paper  <number_of_pages> <rule> <output_file> [options]"
+
+      opts.on("-uRULEUNIT", "--unit=RULEUNIT", "Rule Unit") do |r|
+        options.rule_unit = r
+      end
+      
+    end
+    optparser.parse!(args)
+    options
+  end
+
+end # class Parser
+
+
+options = Parser.parse(ARGV)
+
+TeachingPrintables::Factory.quad_ruled_paper(ARGV[0],ARGV[1],options.rule_unit,ARGV[3])

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/teaching_printables/factory.rb

@@ -0,0 +1,71 @@
+#require_relative "./templatable"
+
+module TeachingPrintables
+  # Rubber stamps common worksheets
+  module Factory
+    def Factory.avery5371_with_array_content(content_array,output_file_name="output.pdf")
+      doc = TeachingPrintables::TPDocument.new
+      class << doc
+        include TeachingPrintables::Templatable
+      end
+      doc.create_page_with_template(:avery5371)
+      doc.add_grid_content(content_array)
+      doc.save_as(output_file_name)
+      puts "Sheet saved as #{output_file_name}."
+    end
+    
+    def Factory.centimeter_paper
+      doc = TeachingPrintables::TPDocument.new
+      class << doc
+        include QuadRulable
+      end
+      2.times do |i|
+        doc.create_quad_rule(start_new_page: true)
+      end
+      doc.save_as(output_file_name)
+    end
+    
+    def Factory.quad_ruled_paper(npages,rule_value,rule_unit='',filename='output.pdf')
+      npages = npages.to_i
+      rule = rule_unit.empty? ? rule_value.to_f : rule_value.to_f.send(rule_unit)
+      
+      if !filename || filename.empty?
+        filename = 'output.pdf'
+      end
+      
+      doc = TeachingPrintables::TPDocument.new
+      class << doc
+        include QuadRulable
+      end
+      npages.times do |i|
+        doc.create_quad_rule(rule_unit: rule, start_new_page: true)
+      end
+      doc.save_as(filename)
+    end
+    
+    
+    def Factory.hundreds_grid(output_file_name="output.pdf")
+      qr=TeachingPrintables::TPDocument.new
+      class << qr
+        include QuadRulable
+      end
+      2.times do |i| 
+        qr.create_quad_rule(start_new_page: true)
+        qr.line_width = 4
+        qr.stroke_rectangle [1.cm,11.cm], 10.cm, 10.cm
+        qr.stroke_line [6.cm,11.cm], [6.cm,21.cm]
+        qr.stroke_rectangle [1.cm,22.cm], 10.cm, 10.cm
+        qr.stroke_line [6.cm,21.cm], [6.cm,31.cm]
+      end
+      qr.save_as(output_file_name)
+    end
+    
+   
+    #
+    # def place_contents_in_gridbox(picture_filename)
+    #   image picture_filename, fit: [@column_width,@row_height]
+    # end
+
+    
+  end
+end

data/lib/teaching_printables/gridable.rb

@@ -0,0 +1,73 @@
+
+require_relative "./utilities"
+
+module TeachingPrintables
+  # Creates grid layouts for flashcards or math sheets.  Delegates Prawn methods to Prawn::Document.
+
+    module Gridable
+    
+   
+      
+      attr_writer :grid_rows, :grid_columns, :grid_gutter, :grid_column_width, :grid_row_height
+      
+      def grid_rows
+        @grid_rows ||= 2
+      end
+      def grid_columns
+        @grid_coluns ||= 2
+      end
+      def grid_gutter
+        @grid_gutter ||= 0
+      end
+      def grid_column_width
+        @grid_column_width ||= 100
+      end
+      def grid_row_height
+        @grid_row_height ||= 100
+      end
+      
+    
+      def update_grid_options(options)
+        options.each do |k,v|
+          instance_variable_set("@grid_#{k}", options[k]) unless options[k].nil?
+        end
+      end
+  
+      def add_grid_content(content_array, options={})
+        
+        font_size = options[:font_size] || 60
+        
+        if (page_number ==0) || (options[:start_new_page] == true)
+          start_new_page
+        end
+      
+        
+        @document.define_grid(grid_options)
+        content_array.each_with_index {|obj,ind|
+          
+          if ind%(grid_rows*grid_columns)==0 && ind > 0
+            @document.start_new_page
+          end
+        
+          subs = ind2sub([grid_rows,grid_columns],ind%(grid_rows*grid_columns))
+          @document.grid(subs[0],subs[1]).bounding_box do
+            #place_contents_in_gridbox(obj)
+            @document.text_box obj.to_s, align: :center, valign: :center, size: font_size, overflow: :shrink_to_fit
+          end
+        }
+      end
+
+  
+  
+      def place_contents_in_gridbox(obj)
+        text obj.to_s, fit: [grid_column_width,grid_row_height]
+      end
+
+      private
+      def grid_options
+        keys = %W[rows columns gutter column_width row_height]
+        Hash[keys.map { |key| [key.to_sym, self.send("grid_#{key}")] } ]
+      end
+    
+  end
+end

data/lib/teaching_printables/quad_rulable.rb

@@ -0,0 +1,50 @@
+require_relative "svg/svg_components"
+require "prawn-svg"
+module TeachingPrintables
+  # Creates quadrille rulings on paper.  Delegates Prawn methods to Prawn::Document.
+
+  module QuadRulable
+    # Make quadrille rules 
+    
+    attr_accessor :rule_unit
+    
+    def rule_unit
+      @rule_unit ||= 1.cm
+    end
+    def rule_height
+      bounds.top - bounds.bottom
+    end
+    def rule_width 
+      bounds.right - bounds.left
+    end
+  
+    def create_quad_rule(options={})
+      parse_options(options)
+      puts rule_unit
+      ncols = (rule_width.to_f/rule_unit).ceil
+      nrows = (rule_height.to_f/rule_unit).ceil
+      
+     
+      #Create svg grid with 10pxX10px unit square.  
+      #str = SVGComponents::header(@width,@height)
+      str = SVGComponents::quad_ruled_grid(nrows,ncols)  
+      #str << SVGComponents::footer
+    
+      if (page_number ==0) || (options[:start_new_page] == true)
+        start_new_page
+      end
+      
+      svg(str,width: ncols*rule_unit, height: nrows*rule_unit, at:[0,rule_height+1]) #position: :center, vposition: :center)
+      
+    end
+    
+    private
+    def parse_options(options)
+      allowed_parameters = [:rule_unit]
+      options.each do |k,v|
+        puts "@#{k.to_s}"
+        instance_variable_set("@#{k.to_s}",v) if allowed_parameters.include?(k)
+      end
+    end
+  end
+end

data/lib/teaching_printables/svg/svg_components.rb

@@ -0,0 +1,140 @@
+class SVGComponents
+  
+  SVG_VERSION = "1.1"
+
+  class << self
+    def header(width,height)
+      "<svg version=\"#{SVG_VERSION}\"
+      baseProfile=\"full\"
+      width=\"#{width.to_s}\" height=\"#{height.to_s}\"
+      xmlns=\"http://www.w3.org/2000/svg\">".gsub("\n",'')
+    end
+
+    # def line(x1,x2,y1,y2,stroke="black",stroke_width=1)
+#       "<line x1=\"#{x1.to_s}\" x2=\"#{x2.to_s}\" y1=\"#{y1.to_s}\" y2=\"#{y2.to_s}\" stroke=\"#{stroke}\" stroke-width=\"#{stroke_width.to_s}\"/>"
+#     end
+    DEFAULT_LINE = {
+      x1: 0,
+      x2: 100,
+      y1: 0,
+      y2: 100,
+      stroke: "black",
+      stroke_width: 1,
+      stroke_dasharray: "none"
+    }
+    
+    def line(options={})
+      options = DEFAULT_LINE.merge(options)
+      "<line x1=\"#{options[:x1].to_s}\" x2=\"#{options[:x2].to_s}\" y1=\"#{options[:y1].to_s}\" y2=\"#{options[:y2].to_s}\" stroke=\"#{options[:stroke]}\" stroke-width=\"#{options[:stroke_width].to_s}\" stroke-dasharray=\"#{options[:stroke_dasharray]}\"/>"
+    end
+    
+    DEFAULT_ARROW = {
+      xpos: 0,
+      ypos: 0,
+      base: 10,
+      height: 10,
+      fill: "black",
+      stroke: "black",
+      stroke_width: 1,
+    }
+    
+    # Create left arrowhead with apex at xpos,ypos and specified base and height
+    def left_arrowhead(options={})
+      options = DEFAULT_ARROW.merge(options)
+      "<polygon points=\"#{options[:xpos]+options[:height]},#{options[:ypos]+options[:height]/2} #{options[:xpos]+options[:height]},#{options[:ypos]-options[:height]/2} #{options[:xpos]},#{options[:ypos]}\" style=\"fill:#{options[:fill]};stroke:#{options[:stroke]};stroke-width:#{options[:stroke_width].to_s}\"/>"
+    end
+
+    def right_arrowhead(options={})
+      options = DEFAULT_ARROW.merge(options)
+      "<polygon points=\"#{options[:xpos]-options[:height]},#{options[:ypos]+options[:height]/2} #{options[:xpos]-options[:height]},#{options[:ypos]-options[:height]/2} #{options[:xpos]},#{options[:ypos]}\" style=\"fill:#{options[:fill]};stroke:#{options[:stroke]};stroke-width:#{options[:stroke_width].to_s}\"/>"
+    end
+    
+    DEFAULT_CIRCLE = {
+      xpos: 0,
+      ypos: 0,
+      radius: 2,
+      fill: "black",
+      stroke: "black",
+      stroke_width: 1,
+    }
+    def circle(options={})
+      options = DEFAULT_CIRCLE.merge(options)
+      "<circle cx=\"#{options[:xpos].to_s}\" cy=\"#{options[:ypos].to_s}\" r=\"#{options[:radius].to_s}\" stroke=\"#{options[:stroke]}\" stroke-width=\"#{options[:stroke_width].to_s}\" fill=\"#{options[:fill]}\" />"
+    end
+
+    DEFAULT_LABEL = {
+      xpos: 0,
+      ypos: 0,
+      text: "Label Text",
+      font_size: 12,
+      text_anchor: "middle",
+      fill: "black"
+    }
+    def label(options={})
+      "<text x=\"#{options[:xpos].to_s}\" y=\"#{options[:ypos].to_s}\" font-size=\"#{options[:font_size].to_s}\" text-anchor=\"#{options[:text_anchor]}\" fill=\"#{options[:fill]}\">#{options[:text]}</text>"
+    end
+
+    DEFAULT_RECTANGLE = {
+      xpos: 0,
+      ypos: 0,
+      width: 100,
+      height: 100,
+      stroke: "black",
+      fill: "transparent",
+      stroke_width: 2
+    }
+    def rectangle(options={})
+      "<rect x=\"#{options[:xpos].to_s}\" y=\"#{options[:ypos].to_s}\" width=\"#{options[:width].to_s}\" height=\"#{options[:height].to_s}\" stroke=\"#{options[:stroke]}\" fill=\"#{options[:fill]}\" stroke-width=\"#{options[:stroke_width].to_s}\"/>"
+    end
+
+    def footer
+      "</svg>"
+    end
+
+    def quad_ruled_grid(m_rows,n_columns)
+
+      points_per_box = 40
+      
+      width = n_columns * points_per_box;
+      height = m_rows * points_per_box;
+  
+      str = header(n_columns*points_per_box,m_rows*points_per_box)
+      
+      
+      # make vertical lines
+      for n in (0..n_columns)
+        verticle_line_opts = {
+          x1: n*points_per_box,
+          x2: n*points_per_box,
+          y1: 0,
+          y2: height,
+          stroke: "gray",
+          stroke_width: 0.5,
+          stroke_dasharray: "none"
+        }
+        str << line(verticle_line_opts)
+      end
+  
+      # make horizontal lines
+      for m in (0..m_rows)
+        horizontal_line_opts = {
+          x1: 0,
+          x2: width,
+          y1: m*points_per_box,
+          y2: m*points_per_box,
+          stroke: "gray",
+          stroke_width: 0.5,
+          stroke_dasharray: "none"
+        }
+        str << line(horizontal_line_opts)
+      end
+      
+      str<<footer
+
+  
+    end
+    
+  
+  end
+  
+end

data/lib/teaching_printables/svg/svg_creator.rb

@@ -0,0 +1,33 @@
+require_relative 'svg_components'
+
+class SVGCreator
+  # Use SVGCreator to add svg components to an array
+  # Method 'svg' concatenates the array elements, adds header and footer, and returns svg string
+  
+  def initialize(width,height)
+    @width = width
+    @height = height
+    @components = []
+  end
+  
+  def svg
+    @components.insert(0,SVGComponents::header(@width,@height))
+    @components << SVGComponents::footer
+    return @components.join
+  end
+  
+  
+  SVGComponents.methods(false).each do |name|
+    define_method("add_#{name}") do |options = {}|
+      if options
+        if SVGComponents.respond_to?(name)
+          @components << SVGComponents.send(name,options)
+        else
+          false
+        end
+      end
+    end
+  end
+  
+end
+

data/lib/teaching_printables/svg/svg_helpers.rb

@@ -0,0 +1,7 @@
+def svg_width(svg)
+  /(?<=width=\")\d+(?=\"\s)/.match(svg)[0].to_i
+end
+
+def svg_height(svg)
+  /(?<=height=\")\d+(?=\"\s)/.match(svg)[0].to_i
+end

data/lib/teaching_printables/templatable.rb

@@ -0,0 +1,42 @@
+require_relative "./utilities"
+require_relative "./gridable"
+
+module TeachingPrintables
+  # Creates grid layouts for flashcards or math sheets.  Delegates Prawn methods to Prawn::Document.
+
+  module Templatable
+    include Gridable
+   
+    PRINT_TEMPLATES = {
+      compulabel: {
+        :page_layout => :portrait, 
+        :page_size => "LETTER",
+        :top_margin => 0.25.in,
+        :bottom_margin => 0.25.in,
+        :right_margin => 0.in,
+        :left_margin => 0.in,
+        :columns => 3,
+        :rows => 7,
+        :gutter => 10
+      },
+
+      avery5371: {
+        :page_layout => :portrait, 
+        :page_size => "LETTER",
+        :top_margin => 0.5.in,
+        :bottom_margin => 0.5.in,
+        :right_margin => 0.75.in,
+        :left_margin => 0.75.in,
+        :columns => 2,
+        :rows => 5,
+        :gutter => 0
+      }
+    }
+    
+    def create_page_with_template(template)
+      start_new_page(PRINT_TEMPLATES[template])
+      update_grid_options(PRINT_TEMPLATES[template])
+    end
+  end
+end
+    

data/lib/teaching_printables/tp_document.rb

@@ -0,0 +1,54 @@
+module TeachingPrintables
+  # Creates quadrille rulings on paper.  Delegates Prawn methods to Prawn::Document.
+  class TPDocument
+    # Make quadrille rules on pdf page(s)
+    #
+    include Prawn::View
+    
+    DOC_OPTIONS_DEFAULT = {
+      :page_layout => :portrait,
+      :margin => 0
+    }
+    
+    def initialize(args={})
+      args = DOC_OPTIONS_DEFAULT.merge(args).merge({skip_page_creation: true})
+      @document = Prawn::Document.new(args)
+    end
+  
+    def page_width
+      if page_layout == :portrait
+        width = PDF::Core::PageGeometry::SIZES[page_size][0]
+      else
+        width = PDF::Core::PageGeometry::SIZES[page_size][1]
+      end
+    end
+    
+    def page_height
+      if page_layout == :portrait
+        height = PDF::Core::PageGeometry::SIZES[page_size][1]
+      else
+        height = PDF::Core::PageGeometry::SIZES[page_size][0]
+      end
+    end
+    
+    def method_missing(m, *args)
+      method = m.to_s
+      if document.class.public_method_defined?(method)
+        document.send(method,*args)
+      elsif method.start_with?("page_")
+        page_method = method[5..-1]
+        if state.page.class.public_method_defined?(page_method)
+          state.page.send(page_method,*args)
+        else 
+          raise NoMethodError.new("Can't find method",page_method)
+        end
+      else
+        super
+      end
+    end
+
+  end
+end
+
+    
+ 

data/lib/teaching_printables/version.rb

@@ -0,0 +1,3 @@
+module TeachingPrintables
+  VERSION = "0.0.4"
+end

data/lib/teaching_printables.rb

@@ -2,8 +2,12 @@ require 'prawn'
 require 'prawn/measurement_extensions'
 
 
-require_relative "teaching_printables/grid_sheet/grid_sheet"
-require_relative "teaching_printables/print_templates"
+require_relative "teaching_printables/quad_rulable"
+require_relative "teaching_printables/templatable"
+require_relative "teaching_printables/gridable"
+require_relative "teaching_printables/factory"
+require_relative "teaching_printables/tp_document"
+require_relative "teaching_printables/version"
 
 module TeachingPrintables
   extend self
@@ -21,23 +25,6 @@ module TeachingPrintables
     !filename.start_with?(".") && GRAPHIC_EXTENSIONS.include?(File.extname(filename))
   end
   
-  
-  class PictureGridSheet < GridSheet
-    def place_contents_in_gridbox(picture_filename)
-      image picture_filename, fit: [@column_width,@row_height]
-    end
-  end  
-
-
-  
-  
-  def grid_sheet_with_content(content_array)
-    gs = GridSheet.new(TeachingPrintables::Printing::Templates::AVERY5371)
-    gs.make_grid(content_array)
-    gs.save_as("mygrid.pdf")
-    puts "Sheet saved as mygrid.pdf"
-  end
-  
 end
 
 

data/teaching_printables.gemspec

@@ -1,9 +1,17 @@
+basedir = File.expand_path(File.dirname(__FILE__))
+require "#{basedir}/lib/teaching_printables/version"
+
 Gem::Specification.new do |s|
   s.name        = 'teaching_printables'
-  s.version     = '0.0.3'
+  s.version     = TeachingPrintables::VERSION
   s.executables << 'flashcards_AVERY5371'
+  
   s.add_runtime_dependency 'prawn', '~> 2'
   s.add_runtime_dependency 'prawn-svg', '~> 0'
+  
+  s.add_development_dependency 'minitest', '~> 5.0'
+  s.add_development_dependency 'minitest-reporters', '1.0'
+  
   s.date        = '2016-11-18'
   s.summary     = "Create Printable Sheets for Teaching"
   s.description = "A gem to create printable sheets for teaching"

data/test/factory_test.rb

@@ -0,0 +1,38 @@
+require_relative './test_helper.rb'
+
+require 'tmpdir'
+require 'teaching_printables'
+
+
+class FactoryTest < MiniTest::Test
+  def test_avery5371_with_array_content
+    content = (1..10).to_a.map{|i| i.to_s}
+    Dir.mktmpdir do |dir|
+      output_file_name = File.join(dir,"output.pdf")
+      TeachingPrintables::Factory::avery5371_with_array_content(content,output_file_name)
+      assert File.exist?(output_file_name)
+    end
+  end
+  def test_hundreds_grid
+    Dir.mktmpdir do |dir|
+      output_file_name = File.join(dir,"output.pdf")
+      TeachingPrintables::Factory::hundreds_grid(output_file_name)
+      assert File.exist?(output_file_name)
+    end
+  end
+  def test_quad_ruled_paper_with_1_cm_rule
+    Dir.mktmpdir do |dir|
+      output_file_name = File.join(dir,"output.pdf")
+      TeachingPrintables::Factory::quad_ruled_paper("2","1","cm",output_file_name)
+      assert File.exist?(output_file_name)
+    end
+  end
+  def test_quad_ruled_paper_with_quarter_inch_rule
+    Dir.mktmpdir do |dir|
+      output_file_name = File.join(dir,"output.pdf")
+      TeachingPrintables::Factory::quad_ruled_paper("2",".25","in",output_file_name)
+      assert File.exist?(output_file_name)
+    end
+  end
+
+end

data/test/gridable_test.rb

@@ -0,0 +1,33 @@
+require_relative './test_helper.rb'
+
+
+
+class GridableTest < Minitest::Test
+  def setup
+    @doc = TeachingPrintables::TPDocument.new
+    class << @doc
+      include TeachingPrintables::Gridable
+    end
+    @content = (1..20).to_a.map{|i| i.to_s}
+  end
+  
+  def test_default_options
+    @doc.add_grid_content(@content)
+    assert_equal 2, @doc.grid_rows
+    assert_equal 2, @doc.grid_columns
+  end
+ 
+  def test_updates_print_template 
+    @doc.update_grid_options(columns: 2, rows: 5, gutter: 10 )
+    @doc.add_grid_content(@content)
+    assert_equal 5, @doc.grid.rows
+    assert_equal 2, @doc.grid.columns
+    assert_equal 10, @doc.grid.gutter
+  end
+  
+  def test_adds_content
+    @doc.add_grid_content(@content)
+    assert_equal 5, @doc.page_number
+  end
+  
+end

data/test/quad_rulable_test.rb

@@ -0,0 +1,22 @@
+require_relative './test_helper.rb'
+
+
+
+class QuadRulableTest < Minitest::Test
+  def setup
+    @doc = TeachingPrintables::TPDocument.new
+    class << @doc
+      include TeachingPrintables::QuadRulable
+    end
+    
+  end
+  
+  def test_default_options
+    assert_equal 1.cm, @doc.rule_unit
+  end
+
+  def test_default_options
+    @doc.create_quad_rule({rule_unit: 0.25.in})
+    assert_equal(0.25.in, @doc.rule_unit)
+  end
+end

data/test/teaching_printables_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class TeachingPrintablesTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::TeachingPrintables::VERSION
+  end
+
+end

data/test/templatable_test.rb

@@ -0,0 +1,26 @@
+require_relative './test_helper.rb'
+
+class TemplatableTest < Minitest::Test
+  def setup
+    @doc = TeachingPrintables::TPDocument.new
+    class << @doc
+      include TeachingPrintables::Templatable
+    end
+  end
+  
+  def test_creates_page_with_correct_template
+    @doc.create_page_with_template(:avery5371)
+    @doc.add_grid_content(%W[a b c d e f g h i j])
+    assert_equal({:left=>54.0, :right=>54.0, :top=>36.0, :bottom=>36.0},@doc.page.margins)
+    assert_equal(2, @doc.grid.columns)
+    assert_equal(5, @doc.grid.rows)
+    assert_equal(144, @doc.grid.row_height)
+    assert_equal(252, @doc.grid.column_width)
+    assert_equal(0.0,@doc.grid.gutter)
+  end
+  
+  def test_is_gridable
+    assert (class << @doc; self; end).included_modules.include?(TeachingPrintables::Gridable)
+  end
+   
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(:color => true)]
+
+require 'teaching_printables'

data/test/tp_document_test.rb

@@ -0,0 +1,18 @@
+require_relative './test_helper.rb'
+
+require 'tmpdir'
+require 'teaching_printables'
+
+
+describe TeachingPrintables::TPDocument do
+  # before do
+#     @tp = TeachingPrintables::TPDocument.new
+#   end
+  
+  describe "the class" do
+    it "contains Prawn::View module" do
+      assert TeachingPrintables::TPDocument < Prawn::View
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teaching_printables
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jen Dobson
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: A gem to create printable sheets for teaching
 email: jendobson@gmail.com
 executables:
@@ -46,13 +74,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
+- bin/console
 - bin/flashcards_AVERY5371
+- bin/quad_ruled_paper
+- bin/setup
 - lib/teaching_printables.rb
-- lib/teaching_printables/grid_sheet/grid_sheet.rb
-- lib/teaching_printables/print_templates.rb
+- lib/teaching_printables/factory.rb
+- lib/teaching_printables/gridable.rb
+- lib/teaching_printables/quad_rulable.rb
+- lib/teaching_printables/svg/svg_components.rb
+- lib/teaching_printables/svg/svg_creator.rb
+- lib/teaching_printables/svg/svg_helpers.rb
+- lib/teaching_printables/templatable.rb
+- lib/teaching_printables/tp_document.rb
 - lib/teaching_printables/utilities.rb
+- lib/teaching_printables/version.rb
 - teaching_printables.gemspec
-- test/test_grid_sheet.rb
+- test/factory_test.rb
+- test/gridable_test.rb
+- test/quad_rulable_test.rb
+- test/teaching_printables_test.rb
+- test/templatable_test.rb
+- test/test_helper.rb
+- test/tp_document_test.rb
 homepage: https://rubygems.org/gems/teaching_printables
 licenses:
 - MIT
@@ -73,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Create Printable Sheets for Teaching

data/lib/teaching_printables/grid_sheet/grid_sheet.rb

@@ -1,79 +0,0 @@
-require "forwardable"
-
-require_relative "../utilities"
-
-module TeachingPrintables
-  # Creates grid layouts for flashcards or math sheets.  Delegates Prawn methods to Prawn::Document.
-  class GridSheet
-    # Make grid-based pdf page(s)
-    #
-    # Example:
-    #   >> gs = TeachingPrintables.GridSheet.new
-    #   >> content = (1..20).to_a.map{|i| i.to_s}
-    #   >> gs.add_content(content)
-    #   >> gs.page_number
-    #   >> gs.save_as("mypdf.pdf") 
-    extend Forwardable
-    include Prawn::View
-    
-    attr_reader :rows, :columns, :gutter, :column_width, :row_height
-    
-    
-    GRID_OPTIONS_DEFAULT = {
-      columns: 2,
-      rows: 2,
-      gutter: 0,
-      column_width: 100,
-      row_height: 100
-    }
-    
-    def initialize(args={},doc=nil)
-      if !doc
-        @document = Prawn::Document.new(args.merge({skip_page_creation: true }))
-      elsif doc.kind_of?(Prawn::Document)
-        @document = doc
-      else
-        raise ArgumentError, "Expecting Prawn::Document", caller
-      end
-      @font_size = 60
-      update_grid_options(GRID_OPTIONS_DEFAULT.merge(args))
-    end
-  
-    def_delegators :@document, :font_size, :page_number, :y, :grid
-  
-    def update_grid_options(options)
-      options.each do |k,v|
-        instance_variable_set("@#{k}", options[k]) unless options[k].nil?
-      end
-    end
-  
-    def add_content(content_array)
-      @document.define_grid(grid_options)
-      content_array.each_with_index {|obj,ind|
-      
-        if ind%(@rows*@columns)==0
-          @document.start_new_page
-        end
-        
-        subs = ind2sub([@rows,@columns],ind%(@rows*@columns))
-        @document.grid(subs[0],subs[1]).bounding_box do
-          #place_contents_in_gridbox(obj)
-          @document.text_box obj.to_s, align: :center, valign: :center, size: @font_size, overflow: :shrink_to_fit
-        end
-      }
-    end
-
-  
-  
-    def place_contents_in_gridbox(obj)
-      text obj.to_s, fit: [@column_width,@row_height]
-    end
-
-    private
-    def grid_options
-      keys = GRID_OPTIONS_DEFAULT.keys
-      Hash[keys.map { |key| [key.to_sym, instance_variable_get("@#{key}")] } ]
-    end
-    
-  end
-end

data/lib/teaching_printables/print_templates.rb

@@ -1,33 +0,0 @@
-module TeachingPrintables
-  module PrintTemplates
-    
-    COMPULABEL = {
-      :page_layout => :portrait, 
-      :page_size => "LETTER",
-      :top_margin => 0.25.in,
-      :bottom_margin => 0.25.in,
-      :right_margin => 0.in,
-      :left_margin => 0.in,
-      :columns => 3,
-      :rows => 7,
-      :gutter => 10,
-      :column_width => 2.81.in,
-      :row_height => 1.5.in 
-    }
-
-    AVERY5371 = {
-      :page_layout => :portrait, 
-      :page_size => "LETTER",
-      :top_margin => 0.5.in,
-      :bottom_margin => 0.5.in,
-      :right_margin => 0.75.in,
-      :left_margin => 0.75.in,
-      :columns => 2,
-      :rows => 5,
-      :gutter => 0,
-      :column_width => 3.5.in,
-      :row_height => 2.in 
-    }
-  end
-end
-

data/test/test_grid_sheet.rb

@@ -1,36 +0,0 @@
-require 'minitest/autorun'
-require 'minitest/pride'
-
-require 'tmpdir'
-require 'teaching_printables'
-
-
-describe TeachingPrintables::GridSheet do
-  before do
-    @gs = TeachingPrintables::GridSheet.new
-    @content = (1..20).to_a.map{|i| i.to_s}
-
-  end
-  
-  describe "after creating a new grid sheet" do
-    it "has the default grid options" do
-      assert_equal 2, @gs.rows
-      assert_equal 2, @gs.columns
-    end
-    
-    it "can update the print template" do
-      @gs.update_grid_options(TeachingPrintables::PrintTemplates::AVERY5371)
-      assert_equal 5, @gs.rows
-      assert_equal 2, @gs.columns
-    end
-    it "can add content" do
-      @gs.add_content(@content)
-      assert_equal 5, @gs.page_number
-    end
-  
-    it "saves as a pdf" do
-      @gs.save_as("mygrid.pdf")
-      assert File.exist?("mygrid.pdf")
-    end
-  end
-end