prism_qa 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f7ffb6cb149a2d8fc072403214e82b01c780aff
-  data.tar.gz: 9d602daab9d1d4325609ba94da5d59de95468a92
+SHA256:
+  metadata.gz: 0fc3c503a5363f6fdab686018d957f2312f2b1172e2eb2287aa16c571d9a3fcf
+  data.tar.gz: e219b6610098b686c1db1029e8a0279ccf86353e12b5b5f8805638363dfcccda
 SHA512:
-  metadata.gz: 9913c2894bd81a6c2dab7010a94acdffb962d56176fe4a5e4633ab6e76c88fe9f0f13cfb0d6b033ce1238b72534e1912feafbfd1f7649e65b696be182e66094e
-  data.tar.gz: 882a08b879975b83544fd4f72ed76a0bb6caf651cf619da90fccfa009748a62911c74643b12b595db62845b1d58bfc7e6c8c7646b75e09a158dc2139b90dcbc0
+  metadata.gz: 05a3bdcbe63b248a9705dcd780378e1e35a53ce6f508cc6139d587ac01b49589a232ee65796d28ab6b0e8773713aefee5f1bf947070f1b9e33a9944a7c820b85
+  data.tar.gz: 10010fe3559c0d7cd16ddc69e1b6f89327d966d6e821a14a322954a11fdcf5ff547160bc9ff8fb36dd7fe6ad4e801b30dff81f16e26d54ffcf9d32408ae2bed1

data/gem/lib/prism_qa/exceptions.rb

@@ -7,7 +7,7 @@ module PrismQA
   class IncompatibilityError < TypeError; end
 
   # For reporting improper extension of the PrismQA base classes (developer error)
-  class ImplementationError < NotImplementedError; end
+  class ImplementationError < RuntimeError; end
 
   # For reporting assertions that fail at runtime (logic errors in extender's code)
   class OperationalError < RuntimeError; end

data/gem/lib/prism_qa/filesystem.rb

@@ -14,7 +14,7 @@ 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)
-    fail PrismQA::OperationalError, "Child element '#{c}' is not an ancestor of the web root '#{r}'"
+    raise 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)))
   elem = Pathname.new c

data/gem/lib/prism_qa/image.rb

@@ -1,18 +1,34 @@
 
 module PrismQA
 
-  # A simple container for image information
+  # A simple container for image information.
+  # Image objects represent a path on disk, with an additional
+  # ID field (for cross-referencing design and app images) and
+  # an optional user-friendly description
   class Image
-    attr_accessor :path         # the location on disk
-    attr_accessor :id           # an application-specific unique identifier
-    attr_accessor :description  # a friendly description
+    # The image's location on disk
+    # @return [String]
+    attr_accessor :path
+
+    # an application-specific unique identifier
+    # @return [String]
+    attr_accessor :id
+
+    # a friendly description
+    # @return [String]
+    attr_accessor :description
   end
 
-  # Design images may optionally specify an attribute
+  # Design images extend Images by optionally specifying an attribute.
+  # This enables different design variants to be labeled, such as
+  # for a modified screen size.
   class DesignImage < Image
+    # A design attribute of the image
+    # @return [String]
     attr_accessor :attribute
   end
 
-  # App images are the same as images, but create this alias for symmetry / clarity
+  # App images are no different than the base class they use.
+  # THis class is essentially an alias for symmetry / clarity
   class AppImage < Image; end
 end

data/gem/lib/prism_qa/imageset.rb

@@ -1,17 +1,20 @@
 
 module PrismQA
 
-  # Container class for sets of images
+  # A container for sets of images, with basic sanity checking
   class ImageSet
 
-    attr_reader :images  # the container for all the images in the set
+    # The container for all the images in the set
+    # @return [Array] of PrismQA::Image objects
+    attr_reader :images
 
     def initialize
       @images = []
       @cache_valid = false  # cache invalidation is so easy
     end
 
-    # Safe way to add images to the container
+    # Safely add images to the container
+    # @param [PrismQA::Image] The image to be added
     def add(image)
       allow image
       # fix relative paths
@@ -22,6 +25,8 @@ module PrismQA
     end
 
     # Raise an error if the image is not appropriate for this type of set
+    # @param [PrismQA::Image] The image to be added
+    # @throws
     def allow(_image)
       puts "  +++ If you're seeing this, #{self.class.name}.#{__method__} was not overridden"
     end
@@ -33,11 +38,11 @@ module PrismQA
 
     def allow(image)
       # Ensure that image objects have an "attribute" field, among other things
-      fail IncompatibilityError, 'Tried to add a non- DesignImage object to a DesignImageSet' unless image.is_a? DesignImage
+      raise 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]
-        fail OperationalError, "Tried to add an image with duplicate ID '#{image.id}' and attribute '#{image.attribute}'"
+        raise OperationalError, "Tried to add an image with duplicate ID '#{image.id}' and attribute '#{image.attribute}'"
       end
     end
 
@@ -73,7 +78,7 @@ module PrismQA
 
         # if there is no attribute for this image, it should be pulled in
         #        ... unless there's an exact match elsewhere in the set.
-        next true if img.attribute.nil? unless @attributes_by_id[img.id.to_s].include? attribute
+        next true if img.attribute.nil? && !(@attributes_by_id[img.id.to_s].include? attribute)
 
         false
       end
@@ -89,11 +94,11 @@ module PrismQA
     def allow(image)
       # no duplicates
       if @images.map(&:id).include? image.id
-        fail OperationalError, "Tried to add an image with duplicate ID '#{image.id}'"
+        raise 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.
-      fail IncompatibilityError, 'Tried to add a DesignImage object to a non- DesignImageSet' if image.is_a? DesignImage
+      raise IncompatibilityError, 'Tried to add a DesignImage object to a non- DesignImageSet' if image.is_a? DesignImage
     end
 
     def cache_image_lookups

data/gem/lib/prism_qa/report.rb

@@ -54,7 +54,7 @@ module PrismQA
     # raise an error if any problems are found
     def validate_input
       problems = test_input
-      fail OperationalError, "Found the following problems: #{problems}" unless problems.empty?
+      raise OperationalError, "Found the following problems: #{problems}" unless problems.empty?
     end
 
     # render the report

data/gem/lib/prism_qa/reportset.rb

@@ -15,7 +15,7 @@ module PrismQA
     def allow_path(path)
       unless @web_document_root.nil?
         unless ancestor?(@web_document_root, path)
-          fail OperationalError, "Report #{path} is not an ancestor of the web root #{@web_document_root}"
+          raise OperationalError, "Report #{path} is not an ancestor of the web root #{@web_document_root}"
         end
       end
     end

data/gem/lib/prism_qa/spectrum.rb

@@ -40,11 +40,11 @@ module PrismQA
     end
 
     def allow_image_set(image_set)
-      fail ImplementationError, "Got a nil DesignImageSet object; was #{self.class.name} properly extended?" if image_set.nil?
+      raise 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
       unless image_set.is_a? DesignImageSet
-        fail IncompatibilityError, 'Tried to add a non- DesignImageSet object to DesignSpectrum'
+        raise IncompatibilityError, 'Tried to add a non- DesignImageSet object to DesignSpectrum'
       end
     end
   end
@@ -53,10 +53,10 @@ module PrismQA
   class AppSpectrum < Spectrum
 
     def allow_image_set(image_set)
-      fail ImplementationError, "Got a nil DesignImageSet object; was #{self.class.name} properly extended?" if image_set.nil?
+      raise 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
-      fail IncompatibilityError, 'Tried to add a DesignImageSet object to AppSpectrum' if image_set.is_a? DesignImageSet
+      raise IncompatibilityError, 'Tried to add a DesignImageSet object to AppSpectrum' if image_set.is_a? DesignImageSet
     end
 
   end

data/gem/lib/prism_qa/version.rb

@@ -1,5 +1,5 @@
 
 # The top-level prism module
 module PrismQA
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,148 +1,168 @@
 --- !ruby/object:Gem::Specification
 name: prism_qa
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2018-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !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'
-    - - '>='
+        version: '0.37'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 0.37.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.31'
-    - - '>='
+        version: '0.37'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 0.37.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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: markaby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.0
 description: Prism helps you split your apps and your design document into visible
   components.  Its purpose is to enable designers to be an effective part of a QA
   / Continuous Integration process.
 email:
-- ifreecarve@gmail.com
+- ianfixes@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -157,7 +177,7 @@ files:
 - gem/lib/prism_qa/spectrum.rb
 - gem/lib/prism_qa/target.rb
 - gem/lib/prism_qa/version.rb
-homepage: http://github.com/ifreecarve/prism_qa
+homepage: http://github.com/ianfixes/prism_qa
 licenses:
 - Apache 2.0
 metadata: {}
@@ -167,17 +187,17 @@ require_paths:
 - gem/lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Design QA tool