nairda-ines 0.2.0 → 0.2.1

data/lib/ines/engine.rb

@@ -0,0 +1,6 @@
+require INES_ROOT + 'engine/text'
+
+module INES #:nodoc: all
+  module Engine
+  end
+end

data/lib/ines/engine/text.rb

@@ -0,0 +1,110 @@
+require 'strscan'
+
+module INES
+  module Engine
+    # Basic engine using INES notation.
+    module Text
+      # Chars indicating each element in the text.
+      TAGS = {
+        '`' => :statement,
+        '$' => :shout,
+        '_' => :whisper,
+        '#' => :thought,
+        '*' => :action
+      }
+
+      class << self
+        # Parses given +text+ into Element Collection.
+        def load(text)
+          # Regular expression matching all available tags.
+          tag_regexp = Regexp.union(*TAGS.keys)
+
+          # Thankfully there's alternative to regular expressions.
+          scanner    = StringScanner.new(text.to_s.strip)
+
+          # Initialize needed variables.
+          collection = Collection.new
+          position   = 0
+          buffer     = ''
+
+          # Try to extract all expressions marked by their tags. Additionally
+          # every not matched text will be added as Element of default type. In
+          # order of appearance, of course.
+          #
+          # FIXME: Most likely there are many ways to optimize and KISS this
+          # code, but currently it's enough to work fine :)
+          until scanner.eos?
+            if scanner.scan_until(tag_regexp)
+              # Add any not matched text to the buffer.
+              buffer << scanner.pre_match[position, scanner.pointer].strip
+
+              # Remember current position for later use.
+              position = scanner.pointer
+
+              # Remember found tag and make a regexp for it.
+              found = scanner[0]
+              match = Regexp.new(Regexp.escape(found))
+
+              if scanner.scan(match)
+                # Add any not matched text.
+                collection.add(Element.new(buffer)) unless buffer == ''
+
+                # Add everything after found tags as new Element.
+                content = scanner.post_match
+                collection.add(Element.new(content, TAGS[found]))
+
+                # End the scanning process.
+                scanner.terminate
+              elsif scanner.scan_until(match)
+                # Add any not matched text.
+                collection.add(Element.new(buffer)) unless buffer == ''
+
+                # Add everything between found tags as new Element.
+                content = scanner.pre_match[position, scanner.pointer]
+                collection.add(Element.new(content, TAGS[found]))
+
+                # Update remembered scanner position.
+                position = scanner.pointer
+              else
+                # Add any not matched text.
+                collection.add(Element.new(buffer + found))
+              end
+
+              # Clear the buffer.
+              buffer = ''
+            else
+              # No expressions left. Add rest of the text as default Element.
+              exp = scanner.scan_until(/\Z/)
+              collection.add(Element.new(exp))
+            end
+          end
+
+          # Return the collection, squeezing it first.
+          collection.squeeze!
+        end
+
+        # Converts given +collection+ to text notation. Raises ArgumentError
+        # if passed argument is not a Collection object.
+        def dump(collection)
+          raise ArgumentError, 'Argument must be an INES::Collection object.' unless collection.is_a?(Collection)
+
+          # Initialize the container.
+          text = ''
+
+          collection.squeeze!.stack.each do |e|
+            next unless TAGS.has_value?(e.expression)
+            tag = TAGS.invert[e.expression]
+            text << tag + e.content + tag + ' '
+          end
+
+          text.strip
+        end
+      end
+    end
+  end
+
+  class Collection
+    # Cute alias for dumping Collection into string.
+    def to_s; Engine::Text.dump(self) end
+  end
+end

data/lib/ines/version.rb

@@ -1,3 +1,3 @@
 module INES
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

data/spec/unit/engine/text_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+include INES
+include Engine
+
+describe Text, 'loading' do
+  it 'should add and remove new tag' do
+    length = Text::TAGS.length
+    Text::TAGS['kitteh'] = :kitteh
+    Text::TAGS.length.should equal(length + 1)
+    Text::TAGS['kitteh'].should equal(:kitteh)
+    Text::TAGS.delete('kitteh')
+    Text::TAGS.length.should equal(length)
+  end
+
+  it 'should parse simple text' do
+    c = Text.load('`Oh Hai!` *sez kitteh*')
+    c.should have(2).items
+    c.stack.first.content.should eql('Oh Hai!')
+    c.stack.last.content.should eql('sez kitteh')
+  end
+
+  it 'should parse text with line ending tag' do
+    c = Text.load('`Oh Hai!` **sez kitteh')
+    c.stack.should have(2).items
+    c.stack.first.content.should eql('Oh Hai!')
+    c.stack.last.content.should eql('sez kitteh')
+  end
+
+  it 'should parse not tagged text' do
+    # Plain text only.
+    c = Text.load('Her kitteh kitteh kitteh!')
+    c.stack.should have(1).item
+    c.stack.first.content.should eql('Her kitteh kitteh kitteh!')
+
+    # Mixed with tagged text.
+    c = Text.load('Oh Hai! *sez kitteh*')
+    c.stack.should have(2).items
+    c.stack.first.content.should eql('Oh Hai!')
+    c.stack.last.content.should eql('sez kitteh')
+  end
+
+  it 'should remove whitespace surrounding expressions only' do
+    # Spanned tags.
+    c = Text.load('!   Oh Hai    *   sez   kitteh   *   ')
+    c.stack.should have(2).items
+    c.stack.first.content.should eql('!   Oh Hai')
+    c.stack.last.content.should eql('sez   kitteh')
+
+    # Line ending tags.
+    c = Text.load('   Oh hai    thar  ! ** sez  ` lil `  ** kitteh !   ')
+    c.stack.should have(2).items
+    c.stack.first.content.should eql('Oh hai    thar  !')
+    c.stack.last.content.should eql('sez  ` lil `  ** kitteh !')
+  end
+
+  it 'should not parse embedded tags' do
+    # Spanned tags.
+    c = Text.load('`*Hai!*` *kitteh `was` very happy*')
+    c.stack.should have(2).items
+    c.stack.first.content.should eql('*Hai!*')
+    c.stack.last.content.should eql('kitteh `was` very happy')
+
+    # Line ending tags.
+    c = Text.load('Hai! ** kitteh *was* `very` ``happy')
+    c.stack.should have(2).items
+    c.stack.first.content.should eql('Hai!')
+    c.stack.last.content.should eql('kitteh *was* `very` ``happy')
+  end
+end
+
+describe Text, 'dumping' do
+  before(:each) do
+    @collection = Collection.new
+  end
+
+  it 'should dump collection' do
+    @collection << Element.new('Hai', :statement)
+    @collection << Element.new('thar!', :statement)
+    Text.dump(@collection).should eql(@collection.to_s)
+    Text.dump(@collection).should eql('`Hai thar!`')
+  end
+
+  it 'it should dump collection with elements containing whitespace' do
+    @collection << Element.new('   Hai   thar!   ', :statement)
+    @collection << Element.new('   sez   lil   kitteh   ', :action)
+    Text.dump(@collection).should eql('`Hai   thar!` *sez   lil   kitteh*')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nairda-ines
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - "Adrian Paca\xC5\x82a"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-20 00:00:00 -07:00
+date: 2008-05-21 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -26,11 +26,14 @@ extra_rdoc_files:
 files: 
 - README
 - LICENSE
+- lib/ines/engine/text.rb
 - lib/ines/collection.rb
+- lib/ines/engine.rb
 - lib/ines/element.rb
 - lib/ines/version.rb
 - lib/ines.rb
 - spec/unit/collection_spec.rb
+- spec/unit/engine/text_spec.rb
 - spec/unit/element_spec.rb
 - spec/spec_helper.rb
 - TODO