prism_qa 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dcb60824b2943940984a80d43a63148f8fe0781
-  data.tar.gz: 0c46c450d603844bdfc5cbd3c281205318633bd6
+  metadata.gz: 2f7ffb6cb149a2d8fc072403214e82b01c780aff
+  data.tar.gz: 9d602daab9d1d4325609ba94da5d59de95468a92
 SHA512:
-  metadata.gz: 43150f503b5d783f03b67da2d5130f9b3263a96a7544655e29eab7e78cac53056cf0f57250dc8a2031a4ecb8c8bb1a05e9f7d332c0f63dd03cc22d07362fa02d
-  data.tar.gz: 496ef1eec25e54a454dd17730caaad40cb51ecbeba04f90820109e96c7d885dc2c0e0e239293b0648f09b7a5e4beda6c9c4c7812465b8aaca2be51ebd1d32e60
+  metadata.gz: 9913c2894bd81a6c2dab7010a94acdffb962d56176fe4a5e4633ab6e76c88fe9f0f13cfb0d6b033ce1238b72534e1912feafbfd1f7649e65b696be182e66094e
+  data.tar.gz: 882a08b879975b83544fd4f72ed76a0bb6caf651cf619da90fccfa009748a62911c74643b12b595db62845b1d58bfc7e6c8c7646b75e09a158dc2139b90dcbc0

data/gem/lib/prism_qa.rb

@@ -8,13 +8,21 @@ require 'prism_qa/spectrum'
 require 'prism_qa/report'
 require 'prism_qa/reportset'
 
-
+# The top-level prism module
 module PrismQA
 
+  # Create a prism report
+  #
+  # design_spectrum:        a DesignSpectrum object
+  # app_spectra:            an array of AppSpectrum objects
+  # title_for_attribute_fn: a function taking a string attribute (or nil) and returning a string title
+  # path_for_attribute_fn:  a function taking a string attribute (or nil) and returning the path for the saved report
+  # web_document_root:      a path relative to which images within the report should be referenced
+  # img_width_px:           an integer width for images in the report
   def self.report(design_spectrum, app_spectra, title_for_attribute_fn, path_for_attribute_fn, web_document_root, img_width_px)
     # load source images
     design_spectrum.load
-    app_spectra.each { |app_spectrum| app_spectrum.load }
+    app_spectra.each(&:load)
 
     rs = PrismQA::ReportSet.new
     rs.design_spectrum        = design_spectrum

data/gem/lib/prism_qa/filesystem.rb

@@ -6,7 +6,7 @@ require_relative 'exceptions'
 def ancestor?(base, other_path)
   base_parts = File.expand_path(base).split('/')
   path_parts = File.expand_path(other_path).split('/')
-  path_parts[0..base_parts.size-1] == base_parts
+  path_parts[0..(base_parts.size - 1)] == base_parts
 end
 
 # return the relative path from a document in a web root to a media element, given full paths to each
@@ -14,9 +14,9 @@ def web_relative_path(web_root, base_document, child_element)
   c = File.expand_path(child_element)
   r = File.expand_path(web_root)
   unless ancestor?(r, c)
-    raise PrismQA::OperationalError, "Child element '#{c}' is not an ancestor of the web root '#{r}'"
+    fail PrismQA::OperationalError, "Child element '#{c}' is not an ancestor of the web root '#{r}'"
   end
-  base = Pathname.new (File.dirname(File.expand_path(base_document)))
+  base = Pathname.new(File.dirname(File.expand_path(base_document)))
   elem = Pathname.new c
   (elem.relative_path_from base).to_s
 end

data/gem/lib/prism_qa/image.rb

@@ -8,7 +8,6 @@ module PrismQA
     attr_accessor :description  # a friendly description
   end
 
-
   # Design images may optionally specify an attribute
   class DesignImage < Image
     attr_accessor :attribute

data/gem/lib/prism_qa/imageset.rb

@@ -12,8 +12,8 @@ module PrismQA
     end
 
     # Safe way to add images to the container
-    def add image
-      self.allow image
+    def add(image)
+      allow image
       # fix relative paths
       image.path = File.expand_path(image.path)
       @images << image
@@ -22,28 +22,28 @@ module PrismQA
     end
 
     # Raise an error if the image is not appropriate for this type of set
-    def allow image
+    def allow(_image)
       puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
     end
-  end
 
+  end
 
   # Design image sets need to be able to report on the images they contain
   class DesignImageSet < ImageSet
 
-    def allow image
+    def allow(image)
       # Ensure that image objects have an "attribute" field, among other things
-      raise IncompatibilityError, "Tried to add a non- DesignImage object to a DesignImageSet" unless image.is_a? DesignImage
+      fail IncompatibilityError, 'Tried to add a non- DesignImage object to a DesignImageSet' unless image.is_a? DesignImage
 
       # no duplicates allowed
-      if (@images.map { |i| [i.id, i.attribute] }).include? [image.id, image.attribute]
-        raise OperationalError, "Tried to add an image with duplicate ID '#{image.id}' and attribute '#{image.attribute}'"
+      if @images.map { |i| [i.id, i.attribute] }.include? [image.id, image.attribute]
+        fail OperationalError, "Tried to add an image with duplicate ID '#{image.id}' and attribute '#{image.attribute}'"
       end
     end
 
     # Get the list of unique attributes contained by the images within
     def contained_attributes
-      (@images.map { |i| i.attribute}).uniq
+      @images.map(&:attribute).uniq
     end
 
     # cache the image attributes
@@ -55,7 +55,7 @@ module PrismQA
       @attributes_by_id = {}
       @images.each do |img|
         proper_key = img.id.to_s
-        @attributes_by_id[proper_key] = [] unless @attributes_by_id.has_key? proper_key
+        @attributes_by_id[proper_key] = [] unless @attributes_by_id.key? proper_key
         @attributes_by_id[proper_key] << img.attribute
       end
 
@@ -63,8 +63,8 @@ module PrismQA
     end
 
     # get the list of images that are valid for a particular attribute
-    def images_for_attribute attribute
-      self.cache_image_attributes
+    def images_for_attribute(attribute)
+      cache_image_attributes
 
       # return the pared-down list
       @images.select do |img|
@@ -81,20 +81,19 @@ module PrismQA
 
   end
 
-
   # App image sets are tied to a target
   class AppImageSet < ImageSet
 
     attr_accessor :target
 
-    def allow image
+    def allow(image)
       # no duplicates
-      if (@images.map { |i| i.id}).include? image.id
-        raise OperationalError, "Tried to add an image with duplicate ID '#{image.id}'"
+      if @images.map(&:id).include? image.id
+        fail OperationalError, "Tried to add an image with duplicate ID '#{image.id}'"
       end
 
       # App image sets don't need to worry about specific fields, but we keep it clean and symmetric.
-      raise IncompatibilityError, "Tried to add a DesignImage object to a non- DesignImageSet" if image.is_a? DesignImage
+      fail IncompatibilityError, 'Tried to add a DesignImage object to a non- DesignImageSet' if image.is_a? DesignImage
     end
 
     def cache_image_lookups
@@ -109,11 +108,10 @@ module PrismQA
     end
 
     def best_image_for(id)
-      self.cache_image_lookups
+      cache_image_lookups
       @image_lookup.fetch(id.to_s, nil)
     end
 
   end
 
-
 end

data/gem/lib/prism_qa/report.rb

@@ -3,7 +3,9 @@ require_relative 'filesystem'
 
 module PrismQA
 
+  # A Prism report is an object whose to_s method returns HTML for the full report.
   class Report
+
     attr_accessor :title
     attr_accessor :attribute
     attr_accessor :design_spectrum
@@ -13,7 +15,7 @@ module PrismQA
     attr_accessor :img_width_px
 
     def css
-      width_string = ""
+      width_string = ''
       width_string = "width: #{@img_width_px}px;" unless img_width_px.nil?
       %(
         body {color:white; background-color:#333;}
@@ -26,21 +28,41 @@ module PrismQA
     end
 
     # if necessary, modify the path to be relative (for web-based reports)
-    def path_transform element_path
+    def path_transform(element_path)
       unless @web_document_root.nil?
         element_path = web_relative_path(@web_document_root, @destination_path, element_path)
       end
       element_path
     end
 
-    # render the report
-    def to_s
-      # initial calculations - get the app spectra that support the attribute we are reporting on
-      candidates = @app_spectra.select do |app_spectrum|
+    def candidates_for_attribute
+      @app_spectra.select do |app_spectrum|
         next true if @attribute.nil? # unless there is nothing in this candidate???? might be expensive to check.
-
         app_spectrum.image_set.target.attribute == @attribute
       end
+    end
+
+    # make a list of problems found
+    def test_input
+      problems = []
+      @app_spectra.each do |app_spectrum|
+        problems << 'App spectrum has a nil target defined in its image set' if app_spectrum.image_set.target.nil?
+      end
+      problems
+    end
+
+    # raise an error if any problems are found
+    def validate_input
+      problems = test_input
+      fail OperationalError, "Found the following problems: #{problems}" unless problems.empty?
+    end
+
+    # render the report
+    def to_s
+      validate_input
+
+      # initial calculations - get the app spectra that support the attribute we are reporting on
+      candidates = candidates_for_attribute
       design_images = @design_spectrum.image_set.images_for_attribute(@attribute)
       columns = candidates.length + 1
 
@@ -52,7 +74,7 @@ module PrismQA
 
         head do
           title "#{me.title} | Prism QA"
-          style :type => "text/css" do
+          style type: 'text/css' do
             me.css
           end
         end
@@ -60,12 +82,12 @@ module PrismQA
         body do
           h1 me.title
           if design_images.empty?
-            p "No input images were found."
+            p 'No input images were found.'
           else
             table.comparison do
               # print out the first row of the table -- the target names
               tr do
-                td "Design"
+                td 'Design'
                 candidates.each do |c|
                   td c.image_set.target.name
                 end
@@ -75,8 +97,8 @@ module PrismQA
               design_images.each do |design_image|
                 # title
                 tr do
-                  th :colspan => columns do
-                    a :name => design_image.description do
+                  th colspan: columns do
+                    a name: design_image.description do
                       design_image.description
                     end
                   end
@@ -84,10 +106,10 @@ module PrismQA
 
                 # images
                 tr do
-                  td :align => "right", :valign => "top" do
+                  td align: 'right', valign: 'top' do
                     src = me.path_transform(design_image.path)
-                    a :href => src do
-                      img.masterimg :src => src, :alt => design_image.description
+                    a href: src do
+                      img.masterimg src: src, alt: design_image.description
                     end
                   end
 
@@ -96,11 +118,11 @@ module PrismQA
                     if app_image.nil?
                       td { div.missing "#{design_image.description} on #{candidate.image_set.target.name}" }
                     else
-                      td :align => "left", :valign => "top" do
+                      td align: 'left', valign: 'top' do
                         div.holder do
                           src = me.path_transform(app_image.path)
-                          a :href => src do
-                            img.appimg :src => src, :alt => app_image.description
+                          a href: src do
+                            img.appimg src: src, alt: app_image.description
                           end
                         end
                       end
@@ -112,9 +134,9 @@ module PrismQA
           end
         end
       end
-      return mab.to_s
+      mab.to_s
     end
 
-  end #Report
+  end
 
 end

data/gem/lib/prism_qa/reportset.rb

@@ -2,6 +2,7 @@ require_relative 'filesystem'
 
 module PrismQA
 
+  # A prism ReportSet produces a set of reports, one for each attribute (plus one for the nil attribute)
   class ReportSet
     attr_accessor :design_spectrum
     attr_accessor :app_spectra
@@ -11,35 +12,36 @@ module PrismQA
     attr_accessor :img_width_px
 
     # Check whether the path is correct, particularly if we are making a web-based report
-    def allow_path path
+    def allow_path(path)
       unless @web_document_root.nil?
         unless ancestor?(@web_document_root, path)
-          raise OperationalError, "Report #{path} is not an ancestor of the web root #{@web_document_root}"
+          fail OperationalError, "Report #{path} is not an ancestor of the web root #{@web_document_root}"
         end
       end
     end
 
+    def _configured_report(attribute, output_path)
+      r = Report.new
+      r.title             = @title_for_attribute_fn.call(attribute)
+      r.attribute         = attribute
+      r.design_spectrum   = @design_spectrum
+      r.app_spectra       = @app_spectra
+      r.web_document_root = @web_document_root
+      r.destination_path  = output_path
+      r.img_width_px      = @img_width_px
+      r
+    end
+
     def write
       @design_spectrum.image_set.contained_attributes.map do |attr|
 
         # first check whether the destination is ok
         path = @path_for_attribute_fn.call(attr)
-        self.allow_path path
-
-        r = Report.new
-        r.title             = @title_for_attribute_fn.call(attr)
-        r.attribute         = attr
-        r.design_spectrum   = @design_spectrum
-        r.app_spectra       = @app_spectra
-        r.web_document_root = @web_document_root
-        r.destination_path  = path
-        r.img_width_px      = @img_width_px
+        allow_path path
 
-        File.open(path, 'w') {|f| f.write(r.to_s) }
+        rpt = _configured_report(attr, path)
+        File.open(path, 'w') { |f| f.write(rpt.to_s) }
       end
     end
-
   end
-
-
 end

data/gem/lib/prism_qa/spectrum.rb

@@ -1,4 +1,6 @@
 
+# A Spectrum in Prism defines a set of images that can be loaded on demand
+# It is not exposed in the PrismQA module
 class Spectrum
 
   attr_reader :image_set
@@ -8,8 +10,8 @@ class Spectrum
   end
 
   def load
-    image_set = self.fetch_image_set
-    self.allow_image_set image_set
+    image_set = fetch_image_set
+    allow_image_set image_set
     @image_set = image_set
   end
 
@@ -19,39 +21,42 @@ class Spectrum
   end
 
   # implementation-specific: verify that an ImageSet is appropriate
-  def allow_image_set image_set
+  def allow_image_set(_image_set)
     puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
   end
 
 end
 
+# Extensions of Spectrum are exposed in the module
 
 module PrismQA
 
+  # A DesignSpectrum defines an order on a set of images used to represent the design
   class DesignSpectrum < Spectrum
 
     def initialize
       super
-      @order = []      # will hold the sorted indexes into the image set array
+      @order = []  # will hold the sorted indexes into the image set array
     end
 
-    def allow_image_set image_set
-      raise ImplementationError, "Got a nil DesignImageSet object; was #{self.class.name} properly extended?" if image_set.nil?
+    def allow_image_set(image_set)
+      fail ImplementationError, "Got a nil DesignImageSet object; was #{self.class.name} properly extended?" if image_set.nil?
 
       # Ensure that we are only looking at design images
-      raise IncompatibilityError, "Tried to add a non- DesignImageSet object to DesignSpectrum" unless image_set.is_a? DesignImageSet
+      unless image_set.is_a? DesignImageSet
+        fail IncompatibilityError, 'Tried to add a non- DesignImageSet object to DesignSpectrum'
+      end
     end
-
   end
 
-
+  # An AppSpectrum defines a set of images used to represent the actual app
   class AppSpectrum < Spectrum
 
-    def allow_image_set image_set
-      raise ImplementationError, "Got a nil DesignImageSet object; was #{self.class.name} properly extended?" if image_set.nil?
+    def allow_image_set(image_set)
+      fail ImplementationError, "Got a nil DesignImageSet object; was #{self.class.name} properly extended?" if image_set.nil?
 
       # Ensure that we are only looking at implementation images
-      raise IncompatibiltyError, "Tried to add a DesignImageSet object to AppSpectrum" if image_set.is_a? DesignImageSet
+      fail IncompatibilityError, 'Tried to add a DesignImageSet object to AppSpectrum' if image_set.is_a? DesignImageSet
     end
 
   end

data/gem/lib/prism_qa/target.rb

@@ -1,9 +1,8 @@
 
 module PrismQA
-
+  # A target defines a platform on which an app can be run
   class Target
     attr_accessor :name       # the friendly name of this target
     attr_accessor :attribute  # the attribute that this target can have
   end
-
 end

data/gem/lib/prism_qa/version.rb

@@ -1,3 +1,5 @@
+
+# The top-level prism module
 module PrismQA
-  VERSION = "0.2.0"
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prism_qa
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,6 +44,80 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.31'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.31'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.31.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: markaby
   requirement: !ruby/object:Gem::Requirement