summary_judgement 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andy Rossmeissl
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,7 @@
+= summary_judgement
+
+Constructs adaptive summaries of object hierarchies based on ActiveRecord associations and other simple relationship structures.
+
+== Copyright
+
+Copyright (c) 2009 Andy Rossmeissl. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "summary_judgement"
+    gem.summary = %Q{Dynamic summaries of rich object hierarchies}
+    gem.description = %Q{Constructs adaptive summaries of object hierarchies based on ActiveRecord associations and other simple relationship structures}
+    gem.email = "andy@rossmeissl.net"
+    gem.homepage = "http://github.com/rossmeissl/summary_judgement"
+    gem.authors = ["Andy Rossmeissl"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "summary_judgement #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/summary_judgement/core_extensions.rb

@@ -0,0 +1,13 @@
+class String
+  def indefinite_article
+    %w(a e i o u).include?(first.downcase) ? 'an' : 'a'
+  end
+
+  def with_indefinite_article(upcase = false)
+    "#{upcase ? indefinite_article.humanize : indefinite_article}#{ ' ' unless self.blank? }#{self}"
+  end
+  
+  def pluralize_on(qty)
+    qty.is_a?(Numeric) and qty > 1 ? pluralize : self
+  end
+end

data/lib/summary_judgement/descriptor.rb

@@ -0,0 +1,10 @@
+module SummaryJudgement
+  class Descriptor
+    attr_reader :phrase, :condition
+    
+    def initialize(phrase, options = {})
+      @phrase = phrase
+      @condition = options[:if]
+    end
+  end
+end

data/lib/summary_judgement/instance_methods.rb

@@ -0,0 +1,71 @@
+module SummaryJudgement
+  module InstanceMethods
+    def summary(options = {})
+      if children
+        summarize_as_branch(options)
+      elsif term
+        summarize_as_leaf(options)
+      end
+    end
+    
+    def term
+      self.class.summary.class.render self.class.summary.term, self
+    end
+    
+    def adjectives
+      self.class.summary.adjectives.select { |a| a.condition.nil? or self.class.summary.class.render(a.condition, self) }.map { |a| self.class.summary.class.render a.phrase, self}
+    end
+    
+    def modifiers
+      self.class.summary.modifiers.select { |m| m.condition.nil? or self.class.summary.class.render(m.condition, self) }.map { |m| self.class.summary.class.render m.phrase, self}
+    end
+    
+    def children
+      self.class.summary.class.render self.class.summary.subordinates, self
+    end
+    
+    def canopy
+      branches, leaves = children.flatten.partition(&:children)
+      (leaves + branches.collect(&:canopy)).flatten.uniq
+    end
+    
+    private
+    
+    def summarize_as_leaf(options = {})
+      options.reverse_merge! :capitalize_indefinite_article => true
+      "#{adjectives.join(' ').strip.with_indefinite_article(options[:capitalize_indefinite_article])} #{term} #{modifiers.join(' ')}".strip
+    end
+    
+    def summarize_as_branch(options = {})
+      result = ''
+      if conjugation = options.delete(:conjugate)
+        options.reverse_merge! :tense => :present, :plurality => :singular
+        case conjugation
+        when String
+          options[:person] ||= :third
+          options[:subject] ||= conjugation
+        when Symbol
+          options[:person] ||= conjugation
+        when TrueClass
+          options[:person] ||= :third
+        end
+        result << Verbs::Conjugator.conjugate(self.class.summary.predicate, options.slice(:person, :subject, :tense, :plurality)).to_s.humanize
+        result << ' '
+      end
+      
+      verbosity = options.delete(:verbose)
+      verbosity = send(verbosity) if verbosity.is_a?(Symbol)
+      
+      if verbosity
+        leaves = canopy
+        first_leaf = leaves.shift
+        result << leaves.map { |leaf| leaf.summary :capitalize_indefinite_article => false }.unshift(first_leaf.summary(:capitalize_indefinite_article => !conjugation)).to_sentence
+      else
+        result << canopy.map {|c| c.class}.uniq.map do |k|
+          siblings = canopy.select {|c| c.is_a? k}
+          siblings.length.to_s + ' ' + k.to_s.underscore.humanize.downcase.pluralize_on(siblings.length)
+        end.to_sentence
+      end
+    end
+  end
+end

data/lib/summary_judgement/summary.rb

@@ -0,0 +1,58 @@
+module SummaryJudgement
+  class Summary
+    attr_reader :term, :adjectives, :modifiers, :subordinates, :base
+    
+    def initialize(base, &blk)
+      @base = base
+      @term = base.to_s
+      @adjectives = []
+      @modifiers = []
+      @subordinates = []
+      yield self
+    end
+    
+    def identity(t)
+      @term = t
+    end
+    
+    def adjective(a, options = {})
+      @adjectives << SummaryJudgement::Descriptor.new(a, options)
+    end
+    
+    def modifier(m, options = {})
+      @modifiers << SummaryJudgement::Descriptor.new(m, options)
+    end
+    
+    def children(collection_or_symbol)
+      case collection_or_symbol
+      when Symbol
+        @subordinates << lambda { |parent| parent.send collection_or_symbol }
+      else
+        @subordinates << collection_or_symbol
+      end
+    end
+    
+    def verb(infinitive)
+      @verb = infinitive
+    end
+    
+    def predicate
+      @verb
+    end
+    
+    class << self
+      def render(obj, context)
+        case obj
+        when Array
+          obj.empty? ? nil : obj.map {|o| render o, context}
+        when String
+          obj
+        when Symbol
+          context.send obj
+        when Proc
+          obj.call context
+        end
+      end
+    end
+  end
+end

data/lib/summary_judgement.rb

@@ -0,0 +1,18 @@
+require 'active_support'
+require 'verbs'
+
+module SummaryJudgement
+  def summarize(&blk)
+    @summary = Summary.new(self, &blk)
+    send :include, InstanceMethods
+  end
+  
+  def summary
+    @summary
+  end
+end
+
+require 'summary_judgement/summary'
+require 'summary_judgement/descriptor'
+require 'summary_judgement/instance_methods'
+require 'summary_judgement/core_extensions'

data/test/helper.rb

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'summary_judgement'
+
+class Test::Unit::TestCase
+end
+
+class Book
+  attr_reader :book_type, :author, :color, :length_in_pages, :pictures
+  def initialize(options = {})
+    @book_type = options[:book_type]
+    @author = options[:author]
+    @color = options[:color]
+    @length_in_pages = options[:length_in_pages]
+    @pictures = options[:pictures]
+  end
+  
+  extend SummaryJudgement
+  summarize do |has|
+    has.adjective :color
+    has.adjective 'illustrated', :if => :pictures
+    has.adjective lambda { |book| "#{book.length_in_pages}pp" }, :if => :length_in_pages
+    has.identity lambda { |book| book.book_type }
+    has.modifier lambda { |book| "by #{book.author}" }, :if => :author
+  end
+end
+
+class Magazine
+  attr_reader :length_in_pages, :year, :month
+  def initialize(options = {})
+    @length_in_pages = options[:length_in_pages]
+    @year = options[:year]
+    @month = options[:month]
+  end
+  
+  def date
+    "#{month} #{year}".strip
+  end
+  
+  extend SummaryJudgement
+  summarize do |has|
+    has.adjective lambda { |magazine| "#{magazine.length_in_pages}pp" }, :if => :length_in_pages
+    has.identity 'magazine issue'
+    has.modifier lambda { |magazine| "from #{magazine.date}" }, :if => :date
+  end
+end
+
+class Library
+  attr_reader :books, :magazines
+  def initialize(*volumes)
+    @books = volumes.select {|v| v.is_a? Book}
+    @magazines = volumes.select {|v| v.is_a? Magazine}
+  end
+  
+  def small?
+    @books.length + @magazines.length < 2
+  end
+  
+  extend SummaryJudgement
+  summarize do |has|
+    has.children :books
+    has.children :magazines
+    has.verb :have
+  end
+end
+
+class Catalog
+  attr_reader :libraries
+  def initialize(*libraries)
+    @libraries = libraries
+  end
+  
+  extend SummaryJudgement
+  summarize do |has|
+    has.children :libraries
+    has.verb :contain
+  end
+end

data/test/test_summary_judgement.rb

@@ -0,0 +1,73 @@
+require 'helper'
+
+class TestSummaryJudgement < Test::Unit::TestCase
+  def setup
+    @neuromancer = Book.new :book_type => 'novel', :author => 'William Gibson'
+    @where_the_wild_things_are = Book.new :book_type => 'childrens book', :author => 'Maurice Sendak', :pictures => true
+    @current_economist = Magazine.new :year => 2009, :month => "December"
+    @bookshelf = Library.new @neuromancer, @where_the_wild_things_are
+    @toilet = Library.new @neuromancer, @current_economist
+    @bedstand = Library.new @neuromancer
+    @catalog = Catalog.new @bookshelf, @toilet
+  end
+  
+  def test_setup
+    assert_equal Book, @neuromancer.class
+    assert_equal Library, @bookshelf.class
+    assert_equal 2, @bookshelf.books.length
+    assert_equal :accept, Verbs::Conjugator.conjugate(:accept, :tense => :present, :person => :first, :plurality => :singular) 
+  end
+  
+  def test_summary_definition
+    assert_equal SummaryJudgement::Summary, Book.summary.class
+    assert_equal Proc, Book.summary.term.class
+    assert_equal [SummaryJudgement::Descriptor], Book.summary.adjectives.collect { |a| a.class }.uniq
+    assert_equal :have, Library.summary.predicate
+  end
+  
+  def test_foliage
+    assert_equal 3, @catalog.canopy.length
+  end
+  
+  def test_leaf_summary_rendering
+    assert_equal 'novel', @neuromancer.term
+    assert @where_the_wild_things_are.adjectives.include?('illustrated')
+  end
+  
+  def test_association
+    assert_equal 2, @bookshelf.children.length
+  end
+  
+  def test_summary
+    assert_equal 'An illustrated childrens book by Maurice Sendak', @where_the_wild_things_are.summary
+    assert_equal '2 books', @bookshelf.summary
+    assert_equal '1 book and 1 magazine', @toilet.summary
+    assert_equal '2 books and 1 magazine', @catalog.summary
+    assert_equal 'A novel by William Gibson', @neuromancer.summary
+  end
+  
+  def test_conjugated_summary
+    assert_equal 'Has 2 books', @bookshelf.summary(:conjugate => true, :subject => false)
+    assert_equal 'You have 2 books', @bookshelf.summary(:conjugate => :second, :subject => true)
+    assert_equal 'The catalog contains 2 books and 1 magazine', @catalog.summary(:conjugate => :third, :subject => 'The catalog')
+  end
+  
+  def test_verbose_summaries
+    assert_equal 'A novel by William Gibson and an illustrated childrens book by Maurice Sendak', @bookshelf.summary(:verbose => true)
+  end
+  
+  def test_conjugated_verbose_summaries
+    assert_equal 'I have a novel by William Gibson and an illustrated childrens book by Maurice Sendak', @bookshelf.summary(:verbose => true, :conjugate => :first, :subject => true)
+  end
+  
+  def test_summaries_with_adaptive_verbosity
+    assert_equal '2 books', @bookshelf.summary(:verbose => :small?)
+    assert_equal 'A novel by William Gibson', @bedstand.summary(:verbose => :small?)
+  end
+  
+  def test_conjugated_summaries_with_adaptive_verbosity
+    assert_equal 'They have 2 books', @bookshelf.summary(:verbose => :small?, :conjugate => :third, :plurality => :plural, :subject => true)
+    assert_equal 'They have a novel by William Gibson', @bedstand.summary(:verbose => :small?, :conjugate => :third, :plurality => :plural, :subject => true)
+  end
+  
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: summary_judgement
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andy Rossmeissl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-03 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Constructs adaptive summaries of object hierarchies based on ActiveRecord associations and other simple relationship structures
+email: andy@rossmeissl.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/summary_judgement.rb
+- lib/summary_judgement/core_extensions.rb
+- lib/summary_judgement/descriptor.rb
+- lib/summary_judgement/instance_methods.rb
+- lib/summary_judgement/summary.rb
+- test/helper.rb
+- test/test_summary_judgement.rb
+has_rdoc: true
+homepage: http://github.com/rossmeissl/summary_judgement
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Dynamic summaries of rich object hierarchies
+test_files: 
+- test/helper.rb
+- test/test_summary_judgement.rb