graffle 0.1.0 → 0.1.7

data/lib/graffle/stereotypes.rb

@@ -223,8 +223,16 @@ module Graffle
     
     
     
-    # The Text within the object (or nil if there isn't any).
-    def content; self['Text']; end
+    # The Text within the object. If there is no text, the return 
+    # value is a null object that responds to as_lines with an empty
+    # array.
+    def content
+      if has_key?('Text')
+        self['Text']
+      else
+        Text::Null.new
+      end
+    end
     alias_method :contents, :content
     
     def with_text(string)  # :nodoc:
@@ -288,6 +296,17 @@ module Graffle
       Point.new(self['Points'][0])
     end
     
+    # A quick way to get the lines from a text's label (as plain text).
+    # If the line doesn't have a label, label_lines returns the empty array.
+    def label_lines
+      if label
+        label.content.as_lines
+      else
+        label || []
+      end
+    end
+      
+    
     private
     def points_at(*points)
       self['Points'] = points.collect { |p| "{#{p[0]}, #{p[1]}}" }
@@ -422,25 +441,19 @@ module Graffle
     # Strip all the styling from the RTF string and return it as
     # humble ASCII.
     def as_plain_text
-      StyledTextReader.new(self.as_rtf).as_lines.join("\n")
+      as_lines.join("\n")
     end
     
-    # Return an array of arrays. Each of the inner arrays represents
-    # a line in the original. At the moment, the inner array is what 
-    # you get when you split the line at double-quote boundaries. For
-    # example, given this string:
-    #
-    #     He visits the "login" page.
-    #     His login is "peter", his password is "paul"
-    #
-    # the method returns:
-    #
-    #     [ ['He visits the', 'login', 'page.']
-    #       ['His login is', 'peter', 'his password is', 'paul']]
-    #
-    # There's more to come here.
-    def as_tokens_within_lines
-      StyledTextReader.new(self.as_rtf).as_tokens_within_lines
+    # Return an array of lines, each line as_plain_text.
+    def as_lines
+      StyledTextReader.new(self.as_rtf).as_lines
+    end
+    
+    class Null  # Null object for text
+      def as_lines; []; end
     end
+    
   end
+  
+  
 end

data/lib/graffle/styled-text-reader.rb

@@ -41,11 +41,6 @@ module Graffle
       end
     end
     
-    def as_tokens_within_lines
-      self.as_lines.collect do |line|
-        line.split(/",?/).collect { |tok| tok.strip }
-      end      
-    end
   end
   
   

data/lib/graffle/version.rb

@@ -4,5 +4,5 @@
 #  Copyright (c) 2007. All rights reserved.
 
 module Graffle
-  Version = '0.1.0'
+  Version = '0.1.7'
 end

data/lib/grail_test.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-07-10.
+#  Copyright (c) 2007. All rights reserved.
+
+
+
+require 'graffle'
+require 'grail_test/command-interpreters'
+
+# See README.txt[link:files/README_txt.html]
+module GrailTest
+  
+end
+
+GrailTests=GrailTest   # Be tolerant of typos

data/lib/grail_test/command-interpreters.rb

@@ -0,0 +1,78 @@
+require 'enumerator'
+
+module GrailTest
+  
+  class GraphicInterpreter
+    
+    def initialize(graphics, hash = {})
+      @graphics = graphics
+      @line_label_strategy = 
+          hash['interpret line labels as'] || DoNothingCommands
+      @shaped_graphic_text_strategy = 
+          hash['interpret shaped graphic text as'] || DoNothingCommands
+    end
+    
+    def run_against(target)
+      @target = target
+      @graphics.each do |g|
+        case g.stereotype.basename
+        when "ShapedGraphic"
+          process_commands(@shaped_graphic_text_strategy.new,
+                           g.content.as_lines)
+        when "LineGraphic"
+          process_commands(@line_label_strategy.new,
+                           g.label_lines)
+        end
+      end
+    end
+    
+    private
+    
+    def process_commands(command_maker, command_lines)
+      command_lines.each do |line|
+        info = command_maker.produce_method_call(line)
+        @target.send(*info)
+      end    
+    end
+  end
+  
+    
+  class CommandsWithQuotedArgs
+    
+    def produce_method_call(string)
+      quote_marker = '%<<<==-'
+      
+      string = string.gsub(/(\w)'(\w)/, "#{quote_marker}\\1\\2#{quote_marker}")
+      tokens = string.split(/['"],?/, allow_trailing_null_fields = -1)
+      message = tokens[0].strip
+      args = tokens[1..-1]
+      
+      
+      message.gsub!(/#{quote_marker}(.)(.)#{quote_marker}/, "\\1\\2")
+      message.gsub!(/\s+/,'_')
+      message.gsub!(/-/, '_')
+      message.gsub!(/\W/, '')
+      
+      
+      args = args.enum_slice(2).collect { |e| e[0] } 
+      args = args.collect do | arg | 
+        arg.gsub(/#{quote_marker}(.)(.)#{quote_marker}/, "\\1'\\2")
+      end
+      
+      [message] + args
+    end
+  end
+  
+  class Destinations
+    def produce_method_call(string)
+      ['assert_on_page', string.downcase]
+    end
+  end
+  
+  class DoNothingCommands
+    def produce_method_call(string)
+      [:object_id] # no_op
+    end
+  end
+end
+

data/test/grails-tests/commands-from-quoted-args-tests.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-07-06.
+#  Copyright (c) 2007. All rights reserved.
+
+require "../set-standalone-test-paths.rb" unless $started_from_rakefile
+require 'test/grails-tests/translation-testcase'
+
+class TestCommandsFromQuotedArgs < TranslationTestCase
+
+  
+  # TODO: put this somewhere right.
+  PLAIN = ['John follows "sign up" link',
+           'he logs in with "john", password "fred", and auth key "foo".',
+           'plain command with trailing period',
+           'Plain command - (upper case and special chars)'
+         ]
+
+  # TODO: put this somewhere right.
+  RTF = %Q{
+     | {\\rtf1\\mac\\ansicpg10000\\cocoartf824\\cocoasubrtf420
+     | {\\fonttbl\\f0\\fswiss\\fcharset77 Helvetica;}
+     | {\\colortbl;\\red255\\green255\\blue255;}
+     | \\pard\\tx560\\tx1120\\tx1680\\tx2240\\tx2800\\tx3360\\tx3920\\tx4480\\tx5040\\tx5600\\tx6160\\tx6720\\qc\\pardirnatural
+     |
+     | \\f0\\fs24 \\cf0 #{PLAIN[0]}\\
+     | #{PLAIN[1]}\\
+     | #{PLAIN[2]}\\
+     | #{PLAIN[3]}}}.trim('|')
+
+
+  def setup
+    @interpreter = CommandsWithQuotedArgs.new
+  end
+  
+  def test_translation
+    # Underscoring
+    assert_translation(['token'], "token")
+    assert_translation(['underscore_separated_tokens'],
+                       'underscore separated tokens'
+    )
+    assert_translation(['whitespace_is_handled_intelligently'],
+                       " whitespace\tis   handled intelligently  "
+    )
+    assert_translation(['here_is_an', 'argument'],
+                       'here is an "argument"'
+    )
+    assert_translation(['single_spaces_are_args', 'too '],
+                       " single spaces are args 'too ' "
+    )
+    assert_translation(['multiple', 'arguments', "work"],
+                       %q{multiple 'arguments' "work"}
+    )
+    assert_translation(['only_the', 'prefix', "command"],
+                       %q{only the 'prefix' is included in the 'command'}
+    )
+    
+    assert_translation(['arguments_can', 'be', 'comma', "separated"],
+                       %q{arguments can 'be', 'comma', and 'separated'}
+    )
+    
+    assert_translation(['stuff_after_the', 'last', 'argument'],
+                       %q{stuff after the 'last' 'argument' is ignored.}
+    )
+    
+    assert_translation(['even_if_it_is_just', 'a period'],
+                       %q{even if it is just 'a period'.}
+    )
+    
+    assert_translation(['the_method_ignores_punctuation'],
+                       %q{the method (ignores) punctuation.}
+    )
+    
+    assert_translation(['except_that_dashes_become_underscore'],
+                       %q{except that dashes become-underscore}
+    )
+    
+    assert_translation(["its_possible_to_have_quotes_within_words"],
+                       %q{it's possible to have quotes within words}
+    )
+    
+    assert_translation(["while_a_messages_quotes_are_stripped", "an argument's are retained"],
+                       %q{while a message's quotes are stripped, "an argument's are retained"}
+    )
+  end
+end 

data/test/grails-tests/destinations-tests.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-07-06.
+#  Copyright (c) 2007. All rights reserved.
+
+require "../set-standalone-test-paths.rb" unless $started_from_rakefile
+require 'test/grails-tests/translation-testcase'
+
+class TestDestinationCheckCreation < TranslationTestCase
+
+  def setup
+    @interpreter = Destinations.new
+  end
+  
+  def test_translation
+    assert_translation(['assert_on_page', "markup"],
+                       "MARKUP")
+  end
+end

data/test/grails-tests/do-nothing-commands-tests.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-07-06.
+#  Copyright (c) 2007. All rights reserved.
+
+require "../set-standalone-test-paths.rb" unless $started_from_rakefile
+require 'test/grails-tests/translation-testcase'
+
+class TestCommandsThatDoNothing < TranslationTestCase
+
+  def setup
+    @interpreter = DoNothingCommands.new
+  end
+  
+  def test_translation
+    assert_translation([:object_id], "MARKUP")
+  end
+end

data/test/grails-tests/graphic-interpreter-tests.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-07-10.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'test/unit'
+require 's4t-utils'
+include S4tUtils
+
+require "../set-standalone-test-paths.rb" unless $started_from_rakefile
+require 'test/grails-tests/translation-testcase'
+
+require 'extensions/string'
+require 'grail_test'
+
+
+class GraphicInterpreterTest < Test::Unit::TestCase
+  include Graffle::Builders
+  include GrailTest
+  
+  class CommandRecorder
+    attr_reader :record
+    def initialize
+      @record = []
+    end
+    
+    def method_missing(message, *args)
+      @record << "#{message}(" + args.collect { | a | a.inspect }.join(", ") + ')'
+    end
+  end
+  
+  def two_graphics
+    s = sheet {
+      with line_label {  
+        for_line 1
+        with_text 'produce "argument"'
+      }
+      with line_graphic {
+        graffle_id_is 1
+      }
+      with shaped_graphic {
+        graffle_id_is 2
+        with_text "SIGNUP"
+      }
+    }
+    
+    [s.find_by_id(1), s.find_by_id(2)]
+  end
+  
+  def assert_commands_produced(expected, interpreter)
+    recorder = CommandRecorder.new
+    interpreter.run_against(recorder)
+    assert_equal(expected, recorder.record)
+  end
+    
+  
+  def test_interpreter_applies_strategies
+    interpreter = GraphicInterpreter.new(two_graphics,
+                    'interpret line labels as' => CommandsWithQuotedArgs,
+                    'interpret shaped graphic text as' => Destinations)
+    assert_commands_produced(['produce("argument")', 'assert_on_page("signup")'],
+                             interpreter)                
+  end
+  
+  
+  def test_interpreter_can_omit_strategies
+    interpreter = GraphicInterpreter.new(two_graphics)
+    assert_commands_produced([], interpreter)
+  end
+end

data/test/grails-tests/translation-testcase.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-07-10.
+#  Copyright (c) 2007. All rights reserved.
+
+
+require 'test/unit'
+require 's4t-utils'
+include S4tUtils
+
+require 'extensions/string'
+require 'grail_test'
+
+
+class TranslationTestCase < Test::Unit::TestCase
+  include GrailTests
+  
+  def test_default; "quiet, test/unit!"; end
+  
+  def assert_translation(expected, original)
+    actual = @interpreter.produce_method_call(original)
+    assert_equal(expected, actual)
+  end
+  
+end

data/test/line-graphic-tests.rb

@@ -151,5 +151,15 @@ class TestLineGraphics < Test::Unit::TestCase
     assert_equal("the line has a label", line.label_rtf.as_plain_text)
   end
   
+  def test_a_quick_way_to_get_to_label_text_as_lines
+    line = line_label_sheet.find_by_id(1)
+    assert_equal(["the line has a label"], line.label_lines)
+  end
+  
+  def test_missing_labels_can_be_asked_for_their_nonexistent_lines
+    line = sheet { with line_graphic }.graphics.first
+    assert_equal([], line.label_lines)
+  end
+  
   
 end

data/test/set-standalone-test-paths.rb

@@ -1,5 +1,8 @@
 require 'pathname'
+require 's4t-utils'
+
 
 PACKAGE_ROOT = Pathname.new(__FILE__).parent.parent.to_s
 $:.unshift("#{PACKAGE_ROOT}/lib")
-require 'graffle/third-party/s4t-utils/load-path-auto-adjuster'
+$:.unshift(PACKAGE_ROOT)
+