obf 0.9.8.37 → 0.9.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e9c05fbc1eb76aca00e0b2bda343ed7d2309ef8350d494eee7c07b1806013e4
-  data.tar.gz: 0b13491784c9dae969e7cf9344f7c5d171b63ab6251a37d57ce0261ae78106da
+  metadata.gz: 49734c92d9d154f254416ecff17f6a04503b5afc2d340d3ceb7f94ec89b6f82b
+  data.tar.gz: bfff105ec7b48a2eeb746b8d437c3f6d245d75b499bbc4feae142548a2b43f82
 SHA512:
-  metadata.gz: 9459a448663ae43c120ed92d1d223efa5402895665919df8ba2d1ac2c8a52276724f6b4157a71f6c1abe7fafa26029118467a1646f1f0ea2083320dc5c8fcc45
-  data.tar.gz: 8847fd9594814bb7789178f89584811f63c4726982307a1e4ff432cb9537e9a2beff69c684d4218a04d398116128bab6efc7e87eadc07f24a0a6d09f64aedffa
+  metadata.gz: cc6e780f1b371e4c87dbb42e039410605a27c1bc6ee8753a907badb3953a841b26f0c907ac1c530f1c2344dd4186e59d194b76fb179c6ae2bbe8516665bfbbde
+  data.tar.gz: dacb2ff2fdcebabbbb918ff047c241efe6c36d1d35710f0c1cfa2f9c2c16015cb39796fe984a131e7d8320dc7f221492a9b104e7917253392ea5d69f22fbf5ae

data/lib/obf/external.rb

@@ -41,81 +41,85 @@ module OBF::External
     buttons = hash['buttons'] #board.settings['buttons']
     button_count = buttons.length
     
-    buttons.each_with_index do |original_button, idx|
-      button = {
-        'id' => original_button['id'],
-        'label' => original_button['label'],
-        'vocalization' => original_button['vocalization'],
-        'action' => original_button['action'],
-        'actions' => original_button['actions'],
-        'left' => original_button['left'],
-        'top' => original_button['top'],
-        'width' => original_button['width'],
-        'height' => original_button['height'],
-        'border_color' => OBF::Utils.fix_color(original_button['border_color'] || "#aaa", 'rgb'),
-        'background_color' => OBF::Utils.fix_color(original_button['background_color'] || "#fff", 'rgb')
-      }
-      if original_button['load_board']
-        button['load_board'] = {
-          'id' => original_button['load_board']['id'],
-          'url' => original_button['load_board']['url'],
-          'data_url' => original_button['load_board']['data_url']
+    OBF::Utils.as_progress_percent(0.0, 0.3) do
+      buttons.each_with_index do |original_button, idx|
+        button = {
+          'id' => original_button['id'],
+          'label' => original_button['label'],
+          'vocalization' => original_button['vocalization'],
+          'action' => original_button['action'],
+          'actions' => original_button['actions'],
+          'left' => original_button['left'],
+          'top' => original_button['top'],
+          'width' => original_button['width'],
+          'height' => original_button['height'],
+          'border_color' => OBF::Utils.fix_color(original_button['border_color'] || "#aaa", 'rgb'),
+          'background_color' => OBF::Utils.fix_color(original_button['background_color'] || "#fff", 'rgb')
         }
-        if path_hash && path_hash['included_boards'] && path_hash['included_boards'][original_button['load_board']['id']]
-          button['load_board']['path'] = "board_#{original_button['load_board']['id']}.obf"
+        if original_button['load_board']
+          button['load_board'] = {
+            'id' => original_button['load_board']['id'],
+            'url' => original_button['load_board']['url'],
+            'data_url' => original_button['load_board']['data_url']
+          }
+          if path_hash && path_hash['included_boards'] && path_hash['included_boards'][original_button['load_board']['id']]
+            button['load_board']['path'] = "board_#{original_button['load_board']['id']}.obf"
+          end
         end
-      end
-      if original_button['translations']
-        original_button['translations'].each do |loc, hash|
-          next unless hash.is_a?(Hash)
-          button['translations'] ||= {}
-          button['translations'][loc] ||= {}
-          button['translations'][loc]['label'] = hash['label'].to_s if hash['label']
-          button['translations'][loc]['vocalization'] = hash['vocalization'].to_s if hash['vocalization']
-          (hash['inflections'] || {}).each do |key, val|
-            if key.match(/^ext_/)
-              button['translations'][loc]['inflections'] ||= {}
-              button['translations'][loc]['inflections'][key] = val
-            else
-              button['translations'][loc]['inflections'] ||= {}
-              button['translations'][loc]['inflections'][key] = val.to_s
+        if original_button['translations']
+          original_button['translations'].each do |loc, hash|
+            next unless hash.is_a?(Hash)
+            button['translations'] ||= {}
+            button['translations'][loc] ||= {}
+            button['translations'][loc]['label'] = hash['label'].to_s if hash['label']
+            button['translations'][loc]['vocalization'] = hash['vocalization'].to_s if hash['vocalization']
+            (hash['inflections'] || {}).each do |key, val|
+              if key.match(/^ext_/)
+                button['translations'][loc]['inflections'] ||= {}
+                button['translations'][loc]['inflections'][key] = val
+              else
+                button['translations'][loc]['inflections'] ||= {}
+                button['translations'][loc]['inflections'][key] = val.to_s
+              end
+            end
+            hash.keys.each do |key|
+              button['translations'][loc][key] = hash[key] if key.to_s.match(/^ext_/)
             end
-          end
-          hash.keys.each do |key|
-            button['translations'][loc][key] = hash[key] if key.to_s.match(/^ext_/)
           end
         end
-      end
-      if original_button['hidden']
-        button['hidden'] = original_button['hidden']
-      end
-      if original_button['url']
-        button['url'] = original_button['url']
-      end
-      original_button.each do|key, val|
-        if key.match(/^ext_/)
-          button[key] = val
+        if original_button['hidden']
+          button['hidden'] = original_button['hidden']
+        end
+        if original_button['url']
+          button['url'] = original_button['url']
+        end
+        original_button.each do|key, val|
+          if key.match(/^ext_/)
+            button[key] = val
+          end
         end
-      end
 
-      if original_button['image_id'] && hash['images']
-        image = hash['images'].detect{|i| i['id'] == original_button['image_id']}
-        if image
-          images << image
-          button['image_id'] = image['id']
+        if original_button['image_id'] && hash['images']
+          image = hash['images'].detect{|i| i['id'] == original_button['image_id']}
+          if image
+            images << image
+            button['image_id'] = image['id']
+          end
         end
-      end
-      if original_button['sound_id']
-        sound = hash['sounds'].detect{|s| s['id'] == original_button['sound_id']}
-        if sound
-          sounds << sound
-          button['sound_id'] = sound['id']
+        if original_button['sound_id']
+          sound = hash['sounds'].detect{|s| s['id'] == original_button['sound_id']}
+          if sound
+            sounds << sound
+            button['sound_id'] = sound['id']
+          end
         end
+        res['buttons'] << trim_empties(button)
+        OBF::Utils.update_current_progress(idx.to_f / button_count.to_f, "generated button #{button['id']} for #{res['id']}")
       end
-      res['buttons'] << trim_empties(button)
-      OBF::Utils.update_current_progress(idx.to_f / button_count.to_f)
     end
 
+    OBF::Utils.update_current_progress(0.35, "images for board #{res['id']}")
+
     # board_id 1_527892 has some svg's still, not pre-rasterized versions
     # 1_531854 convert-im6.q16: non-conforming drawing primitive definition `Helvetica''' @ error/draw.c/DrawImage/3265.
     if to_include[:images]
@@ -149,6 +153,8 @@ module OBF::External
           'width' => original_image['width'],
           'height' => original_image['height'],
           'license' => OBF::Utils.parse_license(original_image['license']),
+          'protected' => original_image['protected'],
+          'protected_source' => original_image['protected_source'],
           'url' => original_image['url'],
           'data' => original_image['data'],
           'data_url' => original_image['data_url'],
@@ -172,7 +178,7 @@ module OBF::External
             image['height'] ||= path_hash['images'][image['id']]['height']
           else
             image_fetch = OBF::Utils.image_raw(image['data'] || image['url'])
-            if image_fetch
+            if image_fetch && image_fetch['data']
               if !image['content_type'] || !image['width'] || !image['height']
                 attrs = OBF::Utils.image_attrs(image_fetch['data'])
                 image['content_type'] ||= image_fetch['content_type'] || attrs['content_type']
@@ -202,6 +208,8 @@ module OBF::External
           'width' => original_image['width'],
           'height' => original_image['height'],
           'license' => OBF::Utils.parse_license(original_image['license']),
+          'protected' => original_image['protected'],
+          'protected_source' => original_image['protected_source'],
           'url' => original_image['url'],
           'data_url' => original_image['data_url'],
           'content_type' => original_image['content_type']
@@ -211,12 +219,15 @@ module OBF::External
 
     end
     
+    OBF::Utils.update_current_progress(0.75, "sounds for board #{res['id']}")
     if to_include[:sounds]
       sounds.each do |original_sound|
         sound = {
           'id' => original_sound['id'],
           'duration' => original_sound['duration'],
           'license' => OBF::Utils.parse_license(original_sound['license']),
+          'protected' => original_sound['protected'],
+          'protected_source' => original_sound['protected_source'],
           'url' => original_sound['url'],
           'data' => original_sound['data'],
           'data_url' => original_sound['data_url'],
@@ -250,6 +261,8 @@ module OBF::External
           'id' => original_sound['id'],
           'duration' => original_sound['duration'],
           'license' => OBF::Utils.parse_license(original_sound['license']),
+          'protected' => original_sound['protected'],
+          'protected_source' => original_sound['protected_source'],
           'url' => original_sound['url'],
           'data_url' => original_sound['data_url'],
           'content_type' => original_sound['content_type']
@@ -258,6 +271,8 @@ module OBF::External
       end
     end
 
+    OBF::Utils.update_current_progress(0.85, "grid for board #{res['id']}")
+
     res['grid'] = OBF::Utils.parse_grid(hash['grid']) # TODO: more robust parsing here
     if path_hash && path_hash['zip']
       zip_path = "board_#{res['id']}.obf"
@@ -270,6 +285,7 @@ module OBF::External
       File.open(dest_path, 'w') {|f| f.write(JSON.pretty_generate(res)) }
     end
     OBF::Utils.log("  done compressing board #{res['name'] || res['id']}")
+    OBF::Utils.update_current_progress(1.0, "done for board #{res['id']}")
     return dest_path
   end
   
@@ -325,6 +341,8 @@ module OBF::External
     content['images'] ||= boards.map{|b| b['images'] }.flatten.uniq
     content['sounds'] ||= boards.map{|b| b['sounds'] }.flatten.uniq
     root_board = boards[0]
+    incr = 1.0 / boards.length.to_f
+    tally = 0.0
     OBF::Utils.build_zip(dest_path) do |zipper|
       paths['zip'] = zipper
       paths['included_boards'] = {}
@@ -332,12 +350,15 @@ module OBF::External
         paths['included_boards'][b['id']] = b
       end
       boards.each do |b|
-        b = paths['included_boards'][b['id']]
-        if b
-          b['images'] = content['images'] || []
-          b['sounds'] = content['sounds'] || []
-          to_obf(b, nil, paths, opts[:to_include])
+        OBF::Utils.as_progress_percent(tally, tally + incr) do
+          b = paths['included_boards'][b['id']]
+          if b
+            b['images'] = content['images'] || []
+            b['sounds'] = content['sounds'] || []
+            to_obf(b, nil, paths, opts[:to_include])
+          end
         end
+        tally += incr
       end
       manifest = {
         'format' => OBF::OBF::FORMAT,
@@ -416,7 +437,7 @@ module OBF::External
     end
     tmp_path = OBF::Utils.temp_path("stash")
     if opts['packet']
-      OBF::Utils.as_progress_percent(0, 0.3) do
+      OBF::Utils.as_progress_percent(0.1, 0.3) do
         opts[:to_include] = {images: true}
         OBF::External.to_obz(board, tmp_path, opts)  
       end

data/lib/obf/pdf.rb

@@ -63,84 +63,84 @@ module OBF::PDF
   end
   
   def self.build_pdf(obj, dest_path, zipper, opts={})
-    OBF::Utils.as_progress_percent(0, 1.0) do
-      # parse obf, draw as pdf
-      doc_opts = {
-        :page_layout => :landscape, 
-        :page_size => [8.5*72, 11*72],
-        :info => {
-          :Title => obj['name']
-        }
+    # parse obf, draw as pdf
+    doc_opts = {
+      :page_layout => :landscape, 
+      :page_size => [8.5*72, 11*72],
+      :info => {
+        :Title => obj['name']
       }
-      pdf = Prawn::Document.new(doc_opts)
-      default_font = load_fonts(pdf, opts)
-    
-      multi_render_paths = []
-      if obj['boards']
-        multi_render = obj['boards'].length > 20 && `which gs`.length > 0
-        obj['backlinks'] = {}
-        if obj['pages']
-          obj['boards'].each do |board|
-            board['buttons'].each do |button|
-              if button['load_board'] && button['load_board']['id']
-                obj['backlinks'][button['load_board']['id']] ||= []
-                obj['backlinks'][button['load_board']['id']] << obj['pages'][board['id']] if obj['pages'][board['id']]
-              end
+    }
+    pdf = Prawn::Document.new(doc_opts)
+    default_font = load_fonts(pdf, opts)
+  
+    multi_render_paths = []
+    if obj['boards']
+      multi_render = obj['boards'].length > 20 && `which gs`.length > 0
+      obj['backlinks'] = {}
+      if obj['pages']
+        obj['boards'].each do |board|
+          board['buttons'].each do |button|
+            if button['load_board'] && button['load_board']['id']
+              obj['backlinks'][button['load_board']['id']] ||= []
+              obj['backlinks'][button['load_board']['id']] << obj['pages'][board['id']] if obj['pages'][board['id']]
             end
           end
-          OBF::Utils.log "backlinks #{obj['backlinks'].to_json}"
         end
-        obj['boards'].each_with_index do |board, idx|
-          started = Time.now.to_i
-          OBF::Utils.log "starting pdf of board #{idx} #{board['name'] || board['id']} at #{started}"
-          pre = idx.to_f / obj['boards'].length.to_f
-          post = (idx + 1).to_f / obj['boards'].length.to_f
-          OBF::Utils.as_progress_percent(pre, post) do
-            # if more than 20 pages, build each page individually 
-            # and combine them afterwards
-            if multi_render
-              path = OBF::Utils.temp_path("stash-#{idx}.pdf")
-              pdf = Prawn::Document.new(doc_opts)
-              load_fonts(pdf, opts)
-            else
-              pdf.start_new_page unless idx == 0
-            end
-            build_page(pdf, board, {
-              'zipper' => zipper, 
-              'pages' => obj['pages'],
-              'backlinks' => obj['backlinks'][board['id']] || [], 
-              'headerless' => !!opts['headerless'], 
-              'font' => default_font,
-              'links' => false,
-              'text_on_top' => !!opts['text_on_top'], 
-              'transparent_background' => !!opts['transparent_background'],
-              'symbol_background' => opts['symbol_background'],
-              'text_case' => opts['text_case']
-            })
-            if multi_render
-              pdf.render_file(path)
-              multi_render_paths << path
-            end
+        OBF::Utils.log "backlinks #{obj['backlinks'].to_json}"
+      end
+      incr = 1.0 / obj['boards'].length.to_f
+      tally = 0
+      obj['boards'].each_with_index do |board, idx|
+        started = Time.now.to_i
+        OBF::Utils.log "starting pdf of board #{idx} #{board['name'] || board['id']} at #{started}"
+        pre = idx.to_f / obj['boards'].length.to_f
+        post = (idx + 1).to_f / obj['boards'].length.to_f
+        OBF::Utils.as_progress_percent(tally, tally + incr) do
+          # if more than 20 pages, build each page individually 
+          # and combine them afterwards
+          if multi_render
+            path = OBF::Utils.temp_path("stash-#{idx}.pdf")
+            pdf = Prawn::Document.new(doc_opts)
+            load_fonts(pdf, opts)
+          else
+            pdf.start_new_page unless idx == 0
+          end
+          build_page(pdf, board, {
+            'zipper' => zipper, 
+            'pages' => obj['pages'],
+            'backlinks' => obj['backlinks'][board['id']] || [], 
+            'headerless' => !!opts['headerless'], 
+            'font' => default_font,
+            'links' => false,
+            'text_on_top' => !!opts['text_on_top'], 
+            'transparent_background' => !!opts['transparent_background'],
+            'symbol_background' => opts['symbol_background'],
+            'text_case' => opts['text_case']
+          })
+          if multi_render
+            pdf.render_file(path)
+            multi_render_paths << path
           end
-          OBF::Utils.log "  finished pdf of board #{idx}/#{obj['boards'].length} #{Time.now.to_i - started}s"
         end
-      else
-        build_page(pdf, obj, {
-          'headerless' => !!opts['headerless'], 
-          'font' => default_font,
-          'text_on_top' => !!opts['text_on_top'], 
-          'transparent_background' => !!opts['transparent_background'],
-          'symbol_background' => opts['symbol_background'],
-          'text_case' => opts['text_case']
-        })
+        tally += incr
+        OBF::Utils.log "  finished pdf of board #{idx}/#{obj['boards'].length} #{Time.now.to_i - started}s"
       end
-      if multi_render_paths.length > 0
-        # `cp #{multi_render_paths[0]} #{dest_path}`
-        `gs -dBATCH -dNOPAUSE -q -sDEVICE=pdfwrite -dPDFSETTINGS=/prepress -sOutputFile=#{dest_path} #{multi_render_paths.join(' ')}`
-      else
-        pdf.render_file(dest_path)
-      end
-    
+    else
+      build_page(pdf, obj, {
+        'headerless' => !!opts['headerless'], 
+        'font' => default_font,
+        'text_on_top' => !!opts['text_on_top'], 
+        'transparent_background' => !!opts['transparent_background'],
+        'symbol_background' => opts['symbol_background'],
+        'text_case' => opts['text_case']
+      })
+    end
+    if multi_render_paths.length > 0
+      # `cp #{multi_render_paths[0]} #{dest_path}`
+      `gs -dBATCH -dNOPAUSE -q -sDEVICE=pdfwrite -dPDFSETTINGS=/prepress -sOutputFile=#{dest_path} #{multi_render_paths.join(' ')}`
+    else
+      pdf.render_file(dest_path)
     end
   end
   
@@ -433,7 +433,7 @@ module OBF::PDF
               end
             end
             index = col + (row * obj['grid']['columns'])
-            OBF::Utils.update_current_progress(index.to_f / (obj['grid']['rows'] * obj['grid']['columns']).to_f)
+            OBF::Utils.update_current_progress(index.to_f / (obj['grid']['rows'] * obj['grid']['columns']).to_f, "updated button #{button_id}")
           end
         end
       end
@@ -448,6 +448,7 @@ module OBF::PDF
       board['path'] = root
       unvisited_boards = [board]
       visited_boards = []
+      OBF::Utils.update_current_progress(0.2, "prepping for pdf")
       while unvisited_boards.length > 0
         board = unvisited_boards.shift
         visited_boards << board
@@ -474,11 +475,13 @@ module OBF::PDF
         pages[board['id']] = (idx + 1).to_s
       end
       
-      build_pdf({
-        'name' => 'Communication Board Set',
-        'boards' => visited_boards,
-        'pages' => pages
-      }, dest_path, zipper, opts)
+      OBF::Utils.as_progress_percent(0.2, 1.0) do
+          build_pdf({
+          'name' => 'Communication Board Set',
+          'boards' => visited_boards,
+          'pages' => pages
+        }, dest_path, zipper, opts)
+      end
     end
     # parse obz, draw as pdf
 

data/lib/obf/utils.rb

@@ -153,7 +153,7 @@ module OBF::Utils
         image['content_type'] ||= attrs['content_type']
       end
     end
-    return nil unless image
+    return nil unless image && image['data']
     str = "data:" + image['content_type']
     str += ";base64," + Base64.strict_encode64(image['data'])
     str
@@ -377,7 +377,7 @@ module OBF::Utils
   
   def self.image_attrs(path, extension='')
     res = {}
-    if path.match(/^data:/)
+    if path && path.match(/^data:/)
       res['content_type'] = path.split(/;/)[0].split(/:/)[1]
       raw = Base64.strict_decode64(path.split(/\,/, 2)[1])
       file = Tempfile.new(['file', extension])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obf
 version: !ruby/object:Gem::Version
-  version: 0.9.8.37
+  version: 0.9.9.2
 platform: ruby
 authors:
 - Brian Whitmer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -184,8 +184,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.9
 signing_key:
 specification_version: 4
 summary: Open Board Format