abstractor 2.0.1 → 2.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjEzMmZmNTcyYjc4MjZkMjQyZjA5MWE5NzQxYWExMDhhYWExNDcwZQ==
+    MWUzYjczYWRlYjNkMzRiNzc2YTRjYjQ3YjIyM2IyZDAwYjE2ZGNkZg==
   data.tar.gz: !binary |-
-    OWNkMzRkZjZiNDU5ZjQ3NDQ5Y2YyMjk0NzhmMGQxNGJmMTA1MGYwNA==
+    MDczMzEzODRiNGE1ZjM5NmYyYmQxM2Q1ODUyOGQ5NGQ2N2Y4MjY4Yw==
 SHA512:
   metadata.gz: !binary |-
-    ZTJkYjRiZDg4ZjA2NzM2MjYzNjU5NWQzMjA5MmQ3MmFlNzI5YjFhZDhlN2I1
-    NGE4NzU4MTA2YTEyNDU0YTk2NDcxZjhlYjhiY2U3ZTFjYzliNDg0OWFlYjNj
-    NzQ3NWU1YTk1NTU4NTc1NTU2ZTZiMDZlZDliOGVmZjg5MDc0N2M=
+    MTRlNzg5ZDFiOTlhMDBmMDc4YmNhZDkyYTY1Nzc0YjU0ZmEzYWJmYmY1YzEz
+    OGRkMGE2MTkwZDUzNTcxODRjZjcwYTI4ODlmN2NlMzExN2U4YjBiNzM0ZTI0
+    MzFlMTkzOWU2NDc4MWZkOTBhYmMzMDJkZmZiYzBhMWI2MTg4OWI=
   data.tar.gz: !binary |-
-    N2FiMTI4YmEwYTlkZTE2NGFmMzU1NDUyODE3NGNjODdiNjA2YjU1NTYyY2Yz
-    MmNkN2ZlODY5MzY1ZTA4ODQ3NzQ1MDM1M2QyNDlhYTE1MmQ0NDUyOGM0M2Ni
-    NjlkN2EyNDA1OWE2YTUzNTMxMTkwMDAxMzU1MGFjY2UyMGY0ZjY=
+    NGY1YTAzNmZiYWU4NWUxZThiOTExZmQxYWMyYjcwYTVkNTVkZTQzZThjMzc1
+    MTAxYmFkNmYzMjQ3ZjUyOGYyMWFhZTgzODAyMWI3OWIwMDJmYWY3ZjE0N2Fi
+    NTZhOWJjNjVmMDgzN2QxYzEyZDA3NmRmZjc4YmE5ODRiMWNjYzI=

data/app/assets/stylesheets/abstractor/abstractor_abstractions.css

@@ -330,4 +330,12 @@ span.tooltip_img {
 
 .indirect_source {
   margin-bottom: 1em;
+}
+
+.abstractor_suggestion_values .custom_explanation {
+  margin-top: .5em;
+}
+
+.abstractor_suggestion_values .custom_explanation label {
+  font-weight: bold !important;
 }

data/app/views/abstractor/abstractor_abstractions/_fields.html.haml

@@ -47,6 +47,12 @@
                             = Abstractor::UserInterface.highlight(simple_format(abstractable_from_column.clone), abstractor_suggestion_source.sentence_match_value.strip)
                           - else
                             = simple_format(abstractable_from_column.clone)
+                    - if abstractor_suggestion_source.custom_explanation
+                      .custom_explanation
+                        %label
+                          Explanation:
+                        .explanation_text
+                          = abstractor_suggestion_source.custom_explanation
             .column-3
               - values = Abstractor::AbstractorSuggestionStatus.all.sort_by(&:name).map{|s| [s.name, s.id] }
               -  values.each do |value|

data/app/views/abstractor/abstractor_abstractions/edit.html.haml

@@ -43,7 +43,7 @@
       = f.label :unknown, 'unknown'
     .column-3
       - abstractor_abstraction = f.object
-      - abstraction_sources = abstractor_abstraction.abstractor_subject.abstractor_abstraction_sources.select { |s| s.abstractor_abstraction_source_type.name == 'nlp suggestion' }
+      - abstraction_sources = abstractor_abstraction.abstractor_subject.abstractor_abstraction_sources.select { |s| s.abstractor_abstraction_source_type.name != 'indirect' }
       - abstraction_sources.each do |abstraction_source|
         - abstraction_source.normalize_from_method_to_sources(abstractor_abstraction.about).each do |source|
           - dom_id = "#{abstraction_source.id}_#{source[:source_type]}_#{source[:source_id]}_#{source[:source_method]}"

data/db/migrate/20140803205149_add_custom_explanation_to_abstractor_suggestion_sources.rb

@@ -0,0 +1,5 @@
+class AddCustomExplanationToAbstractorSuggestionSources < ActiveRecord::Migration
+  def change
+    add_column :abstractor_suggestion_sources, :custom_explanation, :string
+  end
+end

data/lib/abstractor/abstractable.rb

@@ -49,10 +49,28 @@ module Abstractor
         abstractor_abstraction_group
       end
 
-      def abstractor_abstractions_by_abstractor_suggestion_status(abstractor_suggestion_statuses)
-        abstractor_abstractions.map(&:abstractor_suggestions).flatten.select { |as| Array.new(abstractor_suggestion_statuses).any? { |abstractor_suggestion_status| as.abstractor_suggestion_status == abstractor_suggestion_status } }
+      ##
+      # Returns all abstraction for the abstractable entity by abstractor_abstraction_status:
+      #
+      # * 'needs_review': Filter abstractions without a determined value (value, unknown or not_applicable).
+      # * 'reviewed': Filter abstractions having a determined value (value, unknown or not_applicable).
+      #
+      # @param [String] abstractor_abstraction_status Filter abstractions that need review or are reviews.
+      # @return [ActiveRecord::Relation] List of [Abstractor::AbstractorAbstraction].
+      def abstractor_abstractions_by_abstractor_abstraction_status(abstractor_abstraction_status)
+        case abstractor_abstraction_status
+        when 'needs_review'
+          abstractor_abstractions.select { |abstractor_abstraction| abstractor_abstraction.value.blank? && abstractor_abstraction.unknown.blank? && abstractor_abstraction.not_applicable.blank? }
+        when 'reviewed'
+          abstractor_abstractions.select { |abstractor_abstraction| !abstractor_abstraction.value.blank? || !abstractor_abstraction.unknown.blank? || !abstractor_abstraction.not_applicable.blank? }
+        end
       end
 
+      ##
+      # Removes all abstractions, suggestions and indirect sources for the abstractable entity.  Optionally filtred to only 'unreviewd' abstractions.
+      #
+      # @param [Boolean] only_unreviewed Instructs whther to confine removal to only 'unreviewd' abstractions.
+      # @return [void]
       def remove_abstractions(only_unreviewed = true)
         abstractor_abstractions.each do |abstractor_abstraction|
           if !only_unreviewed || (only_unreviewed && abstractor_abstraction.unreviewed?)
@@ -61,6 +79,9 @@ module Abstractor
               abstractor_suggestion.abstractor_suggestion_object_value.destroy if abstractor_suggestion.abstractor_suggestion_object_value
               abstractor_suggestion.destroy
             end
+            abstractor_abstraction.abstractor_indirect_sources.each do |abstractor_indirect_source|
+              abstractor_indirect_source.destroy
+            end
             abstractor_abstraction.destroy
           end
         end
@@ -79,9 +100,9 @@ module Abstractor
       def by_abstractor_abstraction_status(abstractor_abstraction_status)
         case abstractor_abstraction_status
         when 'needs_review'
-          where(["EXISTS (SELECT 1 FROM abstractor_subjects asb JOIN abstractor_abstractions aa ON asb.id = aa.abstractor_subject_id AND asb.subject_type = '#{self.to_s}' WHERE #{self.table_name}.id = aa.about_id AND aa.value IS NULL AND (aa.unknown IS NULL OR aa.unknown = ?) AND (aa.not_applicable IS NULL OR aa.not_applicable = ?))", false, false])
+          where(["EXISTS (SELECT 1 FROM abstractor_abstractions aa WHERE aa.about_type = '#{self.to_s}' AND #{self.table_name}.id = aa.about_id AND (aa.value IS NULL OR aa.value = '') AND (aa.unknown IS NULL OR aa.unknown = ?) AND (aa.not_applicable IS NULL OR aa.not_applicable = ?))", false, false])
         when 'reviewed'
-          where(["EXISTS (SELECT 1 FROM abstractor_subjects asb JOIN abstractor_abstractions aa ON asb.id = aa.abstractor_subject_id AND asb.subject_type = '#{self.to_s}' WHERE #{self.table_name}.id = aa.about_id) AND NOT EXISTS (SELECT 1 FROM abstractor_subjects asb JOIN abstractor_abstractions aa ON asb.id = aa.abstractor_subject_id AND asb.subject_type = '#{self.to_s}'WHERE #{self.table_name}.id = aa.about_id AND aa.value IS NOT NULL AND aa.unknown != ? AND aa.not_applicable != ?)", true, true])
+          where(["EXISTS (SELECT 1 FROM abstractor_abstractions aa WHERE aa.about_type = '#{self.to_s}' AND #{self.table_name}.id = aa.about_id) AND NOT EXISTS (SELECT 1 FROM abstractor_abstractions aa WHERE aa.about_type = '#{self.to_s}' AND #{self.table_name}.id = aa.about_id AND COALESCE(aa.value, '') = '' AND COALESCE(aa.unknown, ?) != ? AND COALESCE(aa.not_applicable, ?) != ?)", false, true, false, true])
         else
           where(nil)
         end

data/lib/abstractor/methods/controllers/abstractor_abstraction_groups_controller.rb

@@ -12,6 +12,10 @@ module Abstractor
           @abstractor_abstraction_group.abstractor_subject_group.abstractor_subjects.each do |abstractor_subject|
             abstraction = abstractor_subject.abstractor_abstractions.build(about_id: params[:about_id], about_type: params[:about_type])
             abstraction.build_abstractor_abstraction_group_member(abstractor_abstraction_group: @abstractor_abstraction_group)
+            abstraction.abstractor_subject.abstractor_abstraction_sources.select { |s| s.abstractor_abstraction_source_type.name == 'indirect' }.each do |abstractor_abstraction_source|
+              source = abstractor_subject.subject_type.constantize.find(params[:about_id]).send(abstractor_abstraction_source.from_method)
+              abstraction.abstractor_indirect_sources.build(abstractor_abstraction_source: abstractor_abstraction_source, source_type: source[:source_type], source_method: source[:source_method])
+            end
             abstraction.save!
           end
 

data/lib/abstractor/methods/models/abstractor_abstraction.rb

@@ -66,9 +66,12 @@ module Abstractor
             end
           end
 
+          ##
+          # Determines if the abstraction has been reviewed.
+          #
+          # @return [Boolean]
           def unreviewed?
-            abstractor_suggestion_status_needs_review = Abstractor::AbstractorSuggestionStatus.where(name: 'Needs review').first
-            abstractor_suggestions.any? { |abstractor_suggestion| abstractor_suggestion.abstractor_suggestion_status == abstractor_suggestion_status_needs_review }
+            (value.blank? && unknown.blank? && not_applicable.blank?)
           end
 
           ##

data/lib/abstractor/methods/models/abstractor_subject.rb

@@ -64,7 +64,7 @@ module Abstractor
           # method on the abstractable enttiy specified in Abstractor::AbstractorAbstractionSource#from_method.
           # The method should return a hash with the following keys populated:
           #
-          # * [Array<ActiveRecord::Base>] :sources An array of active record objects that constitute the list of indirect sources.
+          # * [Array <ActiveRecord::Base>] :sources An array of active record objects that constitute the list of indirect sources.
           # * [Symbol] :source_id A method specifying the primary key of each member in sources.
           # * [Symbol] :source_method A method specifying the source text of each member in sources.
           #
@@ -94,7 +94,6 @@ module Abstractor
           # @param [Abstractor::AbstractorAbstraction] abstractor_abstraction The instance of Abstractor::AbstractorAbstraction to make suggestions against.
           # @param [Abstractor::AbstractorAbstractionSource] abstractor_abstraction_source The instance of the Abstractor::AbstractorAbstractionSource that provides the rule type and from method to make nlp suggestions.
           # @return [void]
-
           def abstract_nlp_suggestion(about, abstractor_abstraction, abstractor_abstraction_source)
             case abstractor_abstraction_source.abstractor_rule_type.name
             when 'name/value'
@@ -107,24 +106,30 @@ module Abstractor
           end
 
           # Creates instances of Abstractor::AbstractorSuggestion and Abstractor::AbstractorSuggestionSource
-          # based on calling the method  configured by the AbstractorAbstractionSource#custom_method attribute.
+          # based on calling the method configured by the AbstractorAbstractionSource#custom_method attribute.
           # The method is called on the abstractable entity passed via the about parameter.
           #
           # Setting up an Abstractor::AbstractorSubject with an AbstractorAbstractionSource
           # with an AbstractorAbstractionSource#abstractor_abstraction_source_type attribute
           # set to 'custom suggestion' obligates the developer to implement an instance
-          # method on the abstractable entitty to make suggestions as
-          # appropriate.  The 'custom suggestion' source type is
-          # intended to faciliate the generation of suggestions in a customizable way.
+          # method on the abstractable entitty to make suggestions as appropriate.
+          # The 'custom suggestion' source type is intended to faciliate the
+          # generation of suggestions in a customizable way.  The method implemented
+          # by the developer should return an array of hashes, each has with 2 keys, like so
+          #
+          # [{ suggestion: 'a suggestion', explanation: 'why i made the suggestion}]
           #
+          # The suggestion will be presented to the user as possible answer for the
+          # abstraction.  The explanation will be displayed to the user to explain
+          # how the sytem arrived at the suggestion.
           # @param [ActiveRecord::Base] about The entity to abstract.  An instance of the class specified in the Abstractor::AbstractorSubject#subject_type attribute.
           # @param [Abstractor::AbstractorAbstraction] abstractor_abstraction The instance of Abstractor::AbstractorAbstraction to make suggestions against.
           # @param [Abstractor::AbstractorAbstractionSource] abstractor_abstraction_source The instance of the Abstractor::AbstractorAbstractionSource that provides the custom method to invoke on the abstractable entity to make custom suggestions.
           # @return [void]
           def abstract_custom_suggestion(about, abstractor_abstraction, abstractor_abstraction_source)
-            suggested_values = about.send(abstractor_abstraction_source.custom_method)
-            suggested_values.each do |suggested_value|
-              suggest(abstractor_abstraction, abstractor_abstraction_source, nil, nil, about.id, about.class.to_s, abstractor_abstraction_source.from_method, suggested_value, nil, nil, abstractor_abstraction_source.custom_method)
+            suggestions = about.send(abstractor_abstraction_source.custom_method)
+            suggestions.each do |suggestion|
+              suggest(abstractor_abstraction, abstractor_abstraction_source, nil, nil, about.id, about.class.to_s, abstractor_abstraction_source.from_method, suggestion[:suggestion], nil, nil, abstractor_abstraction_source.custom_method, suggestion[:explanation])
             end
             create_unknown_abstractor_suggestion(about, abstractor_abstraction, abstractor_abstraction_source)
           end
@@ -179,7 +184,7 @@ module Abstractor
                                   Abstractor::NegationDetection.manual_negated_match_value?(sentence[:sentence], object_variant)
                                 )
                         if !reject
-                          suggest(abstractor_abstraction, abstractor_abstraction_source, object_variant.downcase, sentence[:sentence], source[:source_id], source[:source_type].to_s, source[:source_method], abstractor_object_value, nil, nil, nil)
+                          suggest(abstractor_abstraction, abstractor_abstraction_source, object_variant.downcase, sentence[:sentence], source[:source_id], source[:source_type].to_s, source[:source_method], abstractor_object_value, nil, nil, nil, nil)
                         end
                       end
                     end
@@ -206,13 +211,13 @@ module Abstractor
                     match_value = "#{Regexp.escape(predicate_variant)}:\s*#{Regexp.escape(object_variant)}"
                     matches = parser.scan(match_value, word_boundary: true).uniq
                     matches.each do |match|
-                      suggest(abstractor_abstraction, abstractor_abstraction_source, match, match, source[:source_id], source[:source_type].to_s, source[:source_method], abstractor_object_value, nil, nil, nil)
+                      suggest(abstractor_abstraction, abstractor_abstraction_source, match, match, source[:source_id], source[:source_type].to_s, source[:source_method], abstractor_object_value, nil, nil, nil, nil)
                     end
 
                     match_value = "#{Regexp.escape(predicate_variant)}#{Regexp.escape(object_variant)}"
                     matches = parser.scan(match_value, word_boundary: true).uniq
                     matches.each do |match|
-                      suggest(abstractor_abstraction, abstractor_abstraction_source, match, match, source[:source_id], source[:source_type].to_s, source[:source_method], abstractor_object_value, nil, nil, nil)
+                      suggest(abstractor_abstraction, abstractor_abstraction_source, match, match, source[:source_id], source[:source_type].to_s, source[:source_method], abstractor_object_value, nil, nil, nil, nil)
                     end
                   end
                 end
@@ -242,7 +247,7 @@ module Abstractor
                                        Abstractor::NegationDetection.manual_negated_match_value?(sentence[:sentence], object_variant)
                                      )
                             if !reject
-                              suggest(abstractor_abstraction, abstractor_abstraction_source, sentence[:sentence], sentence[:sentence], source[:source_id], source[:source_type].to_s, source[:source_method], abstractor_object_value, nil, nil, nil)
+                              suggest(abstractor_abstraction, abstractor_abstraction_source, sentence[:sentence], sentence[:sentence], source[:source_id], source[:source_type].to_s, source[:source_method], abstractor_object_value, nil, nil, nil, nil)
                             end
                           end
                         end
@@ -254,7 +259,7 @@ module Abstractor
             end
           end
 
-          def suggest(abstractor_abstraction, abstractor_abstraction_source, match_value, sentence_match_value, source_id, source_type, source_method, suggested_value, unknown, not_applicable, custom_method)
+          def suggest(abstractor_abstraction, abstractor_abstraction_source, match_value, sentence_match_value, source_id, source_type, source_method, suggested_value, unknown, not_applicable, custom_method, custom_explanation)
             match_value.strip! unless match_value.nil?
             sentence_match_value.strip! unless sentence_match_value.nil?
             if abstractor_object_value?(suggested_value)
@@ -285,7 +290,8 @@ module Abstractor
                                                 source_id: source_id,
                                                 source_type: source_type,
                                                 source_method: source_method,
-                                                custom_method: custom_method
+                                                custom_method: custom_method,
+                                                custom_explanation: custom_explanation
                                                )
             end
             abstractor_suggestion
@@ -313,7 +319,7 @@ module Abstractor
                                   Abstractor::NegationDetection.manual_negated_match_value?(sentence[:sentence], predicate_variant)
                                 )
                         if !reject
-                          suggest(abstractor_abstraction, abstractor_abstraction_source, predicate_variant.downcase, sentence[:sentence], source[:source_id], source[:source_type].to_s, source[:source_method], nil, true, nil, nil)
+                          suggest(abstractor_abstraction, abstractor_abstraction_source, predicate_variant.downcase, sentence[:sentence], source[:source_id], source[:source_type].to_s, source[:source_method], nil, true, nil, nil, nil)
                         end
                       end
                     end
@@ -327,7 +333,7 @@ module Abstractor
             #Create an 'unknown' suggestion based on matching nothing only if we have not made a suggstion
             abstractor_abstraction_source.normalize_from_method_to_sources(about).each do |source|
               if abstractor_abstraction.abstractor_suggestions(true).empty?
-                suggest(abstractor_abstraction, abstractor_abstraction_source, nil, nil, source[:source_id], source[:source_type].to_s, source[:source_method], nil, true, nil, nil)
+                suggest(abstractor_abstraction, abstractor_abstraction_source, nil, nil, source[:source_id], source[:source_type].to_s, source[:source_method], nil, true, nil, nil, nil)
               end
             end
           end

data/lib/abstractor/methods/models/abstractor_suggestion_source.rb

@@ -9,7 +9,7 @@ module Abstractor
           base.send :belongs_to, :abstractor_abstraction_source
           base.send :belongs_to, :abstractor_suggestion
 
-          base.send :attr_accessible, :abstractor_abstraction_source, :abstractor_abstraction_source_id, :abstractor_suggestion, :abstractor_suggestion_id, :source_id, :source_type, :source_method, :match_value, :deleted_at, :sentence_match_value, :custom_method
+          base.send :attr_accessible, :abstractor_abstraction_source, :abstractor_abstraction_source_id, :abstractor_suggestion, :abstractor_suggestion_id, :source_id, :source_type, :source_method, :match_value, :deleted_at, :sentence_match_value, :custom_method, :custom_explanation
         end
       end
     end

data/lib/abstractor/version.rb

@@ -1,3 +1,3 @@
 module Abstractor
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstractor
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Michael Gurley, Yulia Bushmanova
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-31 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -487,6 +487,7 @@ files:
 - db/migrate/20140618140828_add_custom_method_to_abstractor_suggestion_sources.rb
 - db/migrate/20140716184049_add_dynamic_list_method_to_abstractor_subjects.rb
 - db/migrate/20140718014952_refactor_abstractor_rule_types.rb
+- db/migrate/20140803205149_add_custom_explanation_to_abstractor_suggestion_sources.rb
 - db/seeds.rb
 - lib/abstractor.rb
 - lib/abstractor/abstractable.rb