nairda-ines 0.2.0

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2008 Adrian Pacała
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README

@@ -0,0 +1,37 @@
+= INES - Inline Narrated Expressions Syntax
+
+INES is a quasi-markup language designed to indicate various human
+expressions with plain ASCII characters.
+
+It was originally intended to use in my browser-based RPG, so if you ask
+yourself "WTF is this?" - that's ok :)
+
+== Quick intro
+
+You can embed any text in a pair of tags to mark it as expression. Instead,
+you can prefix the text with that tags, but in this case any leading
+expressions will be ignored.
+
+Note that any whitespace surrounding content of every expression is trimmed
+(thus it's an _inline_ markup). Additionaly, every part of the text not
+indicating any expression will be converted to the default one.
+
+== Tags
+
+By default following tags are available:
+
+* ` - statement (default)
+* $ - shout
+* _ - whisper
+* # - thought
+* * - action
+
+== Examples
+
+  *Ines looked happy today.* `I'm alive at last!` *she said.*
+
+  $Oh hai!$ ** kitteh smiled.
+
+  __Nobody loves me...
+
+  *   Squirrel took a nap in the box.   *

data/TODO

@@ -0,0 +1 @@
+* TODO: Write XML, YAML, and JSON engines.

data/lib/ines/collection.rb

@@ -0,0 +1,57 @@
+module INES
+  # Class representing INES::Element group in a stack fashion.
+  class Collection
+    # Creates new INES::Collection object. Any number of +elements+ will be
+    # appended to the Collection.
+    def initialize(*elements)
+      @stack = []
+      elements.each { |element| @stack << element if element.is_a?(Element) }
+    end
+
+    # Returns length of the Collection stack.
+    def length; @stack.length end
+
+    # Appends given +element+ to the Collection. Raises ArgumentError if the
+    # +element+ is not an Element instance. Returns the Collection itself.
+    def add(element)
+      raise ArgumentError, 'Argument must be an INES::Element object.' unless element.is_a?(Element)
+      @stack << element
+      self
+    end
+
+    alias_method :<<, :add
+
+    # Removes last Element from the stack and returns it.
+    def pop; @stack.pop end
+
+    alias_method :size, :length
+
+    # Connects any adjacent elements of the same expression type. Returns
+    # current Collection.
+    def squeeze!
+      altered = false
+
+      @stack.each_index do |i|
+        following = @stack[i + 1]
+
+        if !following.nil? && @stack[i].expression == following.expression
+          @stack[i].content << " #{following.content}"
+          @stack.delete(following)
+          altered = true
+        end
+      end
+
+      # If some elements were changed run this method again.
+      altered ? squeeze! : self
+    end
+
+    # Returns current stack. Additionally every Element will be yielded if any
+    # +block+ is given.
+    def stack(&block) #:yields: element
+      @stack.each { |e| yield e } if block_given?
+      @stack
+    end
+
+    alias_method :each, :stack
+  end
+end

data/lib/ines/element.rb

@@ -0,0 +1,34 @@
+module INES
+  # Class representing an expression Element.
+  class Element
+    # List of available expressions.
+    EXPRESSIONS = [:statement, :shout, :whisper, :thought, :action]
+
+    # Type of the Element.
+    attr_reader :expression
+
+    # Content (text) of the Element.
+    attr_reader :content
+
+    # Creates new INES::Element object. Optionally takes +exp+ as initial
+    #
+    # * +con+ - initial content of the Element
+    # * +exp+ - expression type of the Element (optional)
+    def initialize(con, exp = nil)
+      self.content    = con
+      self.expression = exp || EXPRESSIONS.first
+    end
+
+    # Sets +exp+ as the expression of current Element. If +e+ is not an
+    # existing expression type, no changes will be made.
+    def expression=(exp)
+       @expression = exp unless EXPRESSIONS.index(exp).nil?
+    end
+
+    # Sets +con+ as the content of current Element. Any leading or trailing
+    # whitespace will be removed from the content.
+    def content=(con)
+      @content = con.to_s.strip
+    end
+  end
+end

data/lib/ines/version.rb

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

data/lib/ines.rb

@@ -0,0 +1,11 @@
+require 'pathname'
+
+INES_ROOT = Pathname(__FILE__).dirname.expand_path + 'ines'
+
+require INES_ROOT + 'collection'
+require INES_ROOT + 'element'
+require INES_ROOT + 'engine'
+require INES_ROOT + 'version'
+
+module INES #:nodoc:
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'pathname'
+require 'rubygems'
+require 'spec'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/ines'

data/spec/unit/collection_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+include INES
+
+describe Collection do
+  before(:each) do
+    @collection = Collection.new
+  end
+
+  it 'should create an empty collection' do
+    @collection.should be_instance_of(Collection)
+  end
+
+  it 'should create an empty collection when invalid parameters are passed' do
+    Collection.new(:foo, :bar).length.should equal(0)
+  end
+
+  it 'should properly count stacked elements' do
+    @collection.length.should equal(0)
+  end
+
+  it 'should add and remove new elements from the collection' do
+    e = Element.new('Hai!', :statement)
+    @collection.add(e).should be_instance_of(Collection)
+    @collection.stack.length.should equal(1)
+    @collection.pop.should equal(e)
+  end
+
+  it 'should raise error when adding invalid argument' do
+    lambda { @collection.add('Nasty!') }.should raise_error(ArgumentError)
+  end
+
+  it 'should squeeze the collection' do
+    3.times { @collection << Element.new('Hai!', :statement) }
+    @collection.squeeze!.should be_instance_of(Collection)
+    @collection.should have(1).items
+    @collection.stack.first.content.should eql('Hai! Hai! Hai!')
+  end
+
+  it 'should return the stack when no block is given' do
+    @collection.stack.should have(0).items
+  end
+
+  it 'should yield every stack element when a block is given' do
+    e = Element.new 'Im in ur specs, yieldin ur elements.'
+    @collection << e << e << e
+    @collection.length.should equal(3)
+
+    # Compare each element.
+    @collection.stack do |element|
+      element.should equal(e)
+    end
+  end
+end

data/spec/unit/element_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+include INES
+
+describe Element do
+  before(:each) do
+    @element = Element.new('Hai!', :statement)
+  end
+
+  it 'should add and remove new expression type' do
+    Element::EXPRESSIONS.push(:foo).should equal(Element::EXPRESSIONS)
+    Element::EXPRESSIONS.delete(:foo).should equal(:foo)
+  end
+
+  it 'should create an element' do
+    @element.should be_instance_of(Element)
+  end
+
+  it 'should create an element with given parameters' do
+    e = Element.new('Oh hai!', :statement)
+    e.should be_instance_of(Element)
+    e.expression.should equal(:statement)
+    e.content.should eql('Oh hai!')
+  end
+
+  it 'should set expression type of the element' do
+    @element.expression = :action
+    @element.expression.should equal(:action)
+  end
+
+  it 'should not invalid expression type of the element' do
+    @element.expression = :foo
+    @element.expression.should equal(:statement)
+  end
+
+  it 'should set new content of the element' do
+    @element.content = 'Nom! Nom! Nom!'
+    @element.content.should eql('Nom! Nom! Nom!')
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: nairda-ines
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- "Adrian Paca\xC5\x82a"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: adrian@zenbe.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- TODO
+- LICENSE
+files: 
+- README
+- LICENSE
+- lib/ines/collection.rb
+- lib/ines/element.rb
+- lib/ines/version.rb
+- lib/ines.rb
+- spec/unit/collection_spec.rb
+- spec/unit/element_spec.rb
+- spec/spec_helper.rb
+- TODO
+has_rdoc: true
+homepage: http://github.com/nairda/ines
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- - --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.0.1
+signing_key: 
+specification_version: 2
+summary: Inline Narrated Expressions Syntax
+test_files: []
+