sqed 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a06556fe8ccfebadb944693c4c8675f2ae95e019
-  data.tar.gz: 72aa2b8778bfb884b9cb524db4287c18d3641ccb
+  metadata.gz: a75cdb9451a36a8aec4846d4fc9af3809ae8b6a6
+  data.tar.gz: 8a02cda6c7e44a7942b7ab5cefaf045c38ca6b99
 SHA512:
-  metadata.gz: b6df4ecaa35e16585fcc03c2fe05bfcd610b25ae92c5dfb3715d4f9cc4f9d930af3fe4f0f18d61318a683d30629a70f459cc233c4860b3c5e91d3b59825c871b
-  data.tar.gz: ad2d4dd2f09a43994ae6add3f5c45d72004ac8d141b820d32909cf1a72b13fbedc8628aa178311516c39bb099c3c690bd3c248c06e8697294f4136e40496dd3d
+  metadata.gz: e3194e5fc9e13f1c04e652df9aeb614315da25106a8173e602ac88df8fe23516d5ab38ebbfdf151ef9f43a6d29ff97b249b01c87b40d962ff0c13a7f9bf1d33e
+  data.tar.gz: d7e34abf58f07cf8e19c5175ade4eecf2528675180350fc9a7b1ad2d3c01bf9d828c2124397efb3409d8e2396347cd25ebad3484112bb47da0015e5e778fe215

data/lib/sqed.rb

@@ -5,9 +5,9 @@ raise "IMPORTANT: sqed gem requires ruby >= 2.1.1" unless recent_ruby
 
 require "rmagick"
 
-# Instants take the following
+# Instances take the following
 # 1) A base image @image
-# 2) A target extraction pattern
+# 2) A target extraction pattern, or individually specified attributes
 #
 # Return a Sqed::Result
 #    
@@ -23,7 +23,10 @@ class Sqed
   # initial image which is an instance of ImageMagick::Image, containing background and stage, or just stage
   attr_accessor :image
 
-  # pointer to a combined boundary_finder, layout, and metadata_map pattern, a symbol taken from SqedConfig::EXTRACTION_PATTERNS
+  # !optional! A lookup macro that if provided sets boundary_finder, layout, and metadata_map.  These can be individually overwritten.
+  # Legal values are symbols taken from SqedConfig::EXTRACTION_PATTERNS.
+  # DO NOT pass pattern outside of a sqed instance!
+  # 
   attr_accessor :pattern
 
   # Provide a specific layout, overrides layout metadata taken from pattern
@@ -53,7 +56,7 @@ class Sqed
   # Provide a boundary_finder, overrides metadata taken from pattern
   attr_accessor :boundary_finder 
    
-  def initialize(target_image: nil, target_pattern: :cross, target_layout: nil, has_border: true, boundary_color: :green, use_thumbnail: true, boundary_finder: nil, metadata_map: nil)
+  def initialize(target_image: nil, target_pattern: nil, target_layout: nil, has_border: true, boundary_color: :green, use_thumbnail: true, boundary_finder: nil, metadata_map: nil)
     raise 'extraction pattern not defined' if target_pattern && !SqedConfig::EXTRACTION_PATTERNS.keys.include?(target_pattern) 
 
     # data, and stubs for results
@@ -62,11 +65,13 @@ class Sqed
     @stage_boundary = Sqed::Boundaries.new(:internal_box) 
 
     # extraction metadata
-    @pattern = (target_pattern || :cross)
+    @pattern = target_pattern  # not required if target_layout, metadata_map, and boundary_finder are provided
 
     @has_border = has_border
     @boundary_finder = boundary_finder.constantize if boundary_finder
-    @layout = target_layout || SqedConfig::EXTRACTION_PATTERNS[pattern][:layout]
+    @layout = target_layout 
+    @layout ||= SqedConfig::EXTRACTION_PATTERNS[pattern][:layout] if pattern
+
     @metadata_map = metadata_map
     @boundary_color = boundary_color
     @use_thumbnail = use_thumbnail
@@ -77,13 +82,16 @@ class Sqed
   # @return [Hash]
   #   federate extraction options and apply user provided over-rides
   def extraction_metadata
-    data = SqedConfig::EXTRACTION_PATTERNS[pattern]
-    
-    data[:boundary_color] = boundary_color 
+    data = {}
+    data = SqedConfig::EXTRACTION_PATTERNS[pattern] if pattern
+
+    # if pattern is not provided, these must be
     data[:boundary_finder]  = @boundary_finder if boundary_finder
-    data[:has_border] = has_border 
     data[:target_layout] = layout if layout 
     data[:target_metadata_map] = metadata_map if metadata_map
+
+    data[:boundary_color] = boundary_color 
+    data[:has_border] = has_border 
     data[:use_thumbnail] = use_thumbnail 
     data
   end
@@ -134,8 +142,8 @@ class Sqed
   end
 
   def result
-    # pattern.nil? is no longer true -> must have values for all extraction_metadata keys
-    return false if image.nil? || pattern.nil? 
+    return false if image.nil? 
+    return false if pattern.nil? && (metadata_map.nil? && layout.nil? && boundary_finder.nil?) 
 
     extractor = Sqed::Extractor.new(
       target_boundaries: boundaries,

data/lib/sqed/extractor.rb

@@ -1,6 +1,6 @@
 require 'rmagick'
 
-# An Extractor takes Boundries object and a metadata_map pattern and returns a Sqed::Result
+# An Extractor takes Boundries object and a metadata_map and returns a Sqed::Result
 # 
 class Sqed::Extractor
 

data/lib/sqed/version.rb

@@ -1,3 +1,3 @@
 class Sqed
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/lib/sqed_spec.rb

@@ -35,8 +35,8 @@ describe Sqed do
   end
 
   context 'initialization' do 
-    specify 'without providing a pattern assigns :cross' do
-      expect(s.pattern).to eq(:cross)
+    specify 'without providing a pattern assigns nil' do
+      expect(s.pattern).to eq(nil)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sqed
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Matt Yoder