weskit 0.0.2 → 0.1.0

data/.gitignore

@@ -1,5 +1,6 @@
 .bundle
+.redcar
+.yardoc
 *.gem
-.redcar/
-Gemfile.lock
-pkg/*
+*.lock
+pkg

data/.rspec

@@ -0,0 +1 @@
+-c -fd

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.8.7

data/Gemfile

@@ -1,2 +1,2 @@
-source "http://rubygems.org"
-gemspec
+source 'http://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/README.md

@@ -0,0 +1,135 @@
+# Weskit [![Build Status](https://secure.travis-ci.org/f6p/weskit.png?branch=master)](http://travis-ci.org/f6p/weskit)
+
+Weskit gem consists of tools for interaction with Wesnoth Markup Langage and Wesnoth infrastructure.
+Amog this tools Ruby classes representing WML objects and WML parser are most important as understanding
+them is the key to understaning any other stuff bundled. This README gives quick albeit incomplete
+overview of Weskit WML capabilities. For more information you have to check source code and
+[generated documentation](http://www.rubydoc.info/github/f6p/weskit/frames).
+
+## WML Containers
+
+Elements in WML document dosn't have one parent. Instead of using arrays to store multiple WML objects
+create instance of Weskit::WML::Root. It will let you to call advanced features avaiable for other
+WML objects (like formatting, modification or searching for nodes) and it is enumerable as well.
+
+```ruby
+require 'weskit'
+include Weskit::WML
+
+root = Root.new
+```
+
+While root object can store any type of WML item there are also containers for specific item types, for
+example to store attributes you want to use instance of Weskit::WML::Attributes. All WML containers
+include Weskit::WML::Mixins::Container module and some of them are subclasses of Weskit::WML::Items.
+
+## Altering objects
+
+While you can push instances of WML objects to elements or containers and change identifiers or values
+manually there is a better way of doing that. Each container has build method that comes in handy.
+
+For example:
+
+```ruby
+root.build do
+  side {
+    id 1
+    name 'First Side', :translatable => true
+    unit {
+      name :John
+    }
+  }
+end
+```
+
+becomes:
+
+```
+[side]
+  id=1
+  name=_"First Side"
+  [unit]
+    name=John
+  [/unit]
+[/side]
+```
+
+Basically Builder takes advantage of method_missing and creates attributes or elements depending of method
+call parameters. If there is no block suppiled new attribute is created otherwise new element is added
+and contents of the block are evaluated in its context. Some of the calls may interfere with existing
+methods of Ruby objects and to solve that issue Builder provides attribute and element methods.
+
+In such case instead of calling:
+
+```ruby
+  object_id 1
+  object_id {
+    name 'foo'
+  }
+```
+
+you can do this:
+
+```ruby
+  attribute(:object_id, 1)
+  element(:object_id) {}
+```
+
+id is a helper method (as it interfers with Object#id) that is equivalent to:
+
+```ruby
+  attribute :id, value
+```
+
+## Searching for objects
+
+You can search WML elements and containers for nodes of specific type. For
+example lets say there is a object tree representing such WML structure:
+
+```
+[a]
+  [b]
+    [c]
+      name=foo
+    [/c]
+  [/b]
+  [b]
+    name=bar
+    [c]
+    [/c]
+  [/b]
+[/a]
+```
+
+To get Weskit::WML::Elements container with references to all b elements you can do this:
+
+```ruby
+  root.a.b
+```
+
+This code takes advantage of method_missing and if you can't do that
+(because of method name conflicts) equivalent code can be used:
+
+```ruby
+  root.find(:a).find(:b)
+```
+
+as missing calls are delegated to find method. There is also find_recursively
+method that lets you to find elements using object criteria specified in block.
+
+## Object representation
+
+Weskit::WML objects dosn't have any representation code coupled. Special class of objects called Formatters is
+used to handle their display. Most commonly you will use plain text representation (default formatter)
+or terminal friendly colorful version of it (color formatter). Most of WML objects provide formatter
+seter to replace formatter associated with them but you can as well change default formatter globally
+by calling Formatter.default= setter method.
+
+Whatever representation you need (JSON, XML, YAML) creating new formaters shouldn't
+be hard. Take look at Weskit::WML::Formatters module for further reference on that matter.
+
+## WML Parser
+
+Parser dosn't support preprocessor (at least yet). It provides two methods: string - for parsing strings and uri - for
+parsing files. uri method can load remote files as well as it transparently handles archive extraction. Parsing
+results in return of WML object tree with one Weskit::WML::Root as the top-most element.

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new 'spec'
+task :default => :spec

data/lib/weskit/mp/adapter.rb

@@ -0,0 +1,81 @@
+require 'term/ansicolor'
+
+module Weskit::MP
+  class Adapter
+    attr_accessor :buffer, :socket
+
+    def initialize connection, debug = false
+      @connection = connection
+      @debug      = debug
+    end
+
+    def message container, hash
+      msg = {container => hash}
+      write msg
+    end
+
+    def read
+      size = @connection.socket.read(4).unpack('N').first
+      data = StringIO.new @connection.socket.read(size)
+
+      read_nodes data
+    end
+
+    def write object
+      case object
+        when Hash   then write_hash object
+        when String then write_string object
+      end
+    end
+
+    private
+
+    def compress data
+      gzw = Zlib::GzipWriter.new StringIO.new
+      gzw.write "#{data}"
+      gzw.close
+    end
+
+    def debug node
+      node = node.dup
+      node.formatter = ::Weskit::WML::Formatter.color
+
+      node
+    end
+
+    def debug_header type
+      header = case type
+        when :read  then Term::ANSIColor.red "server:"
+        when :write then Term::ANSIColor.magenta "client:"
+      end
+
+      [$/, header]
+    end
+
+    def read_nodes data
+      @buffer = nil
+
+      puts debug_header(:read) if @debug
+      @buffer = ::Weskit::WML::Parser.string Zlib::GzipReader.new(data).read
+      puts debug(@buffer) if @debug
+
+      @buffer
+    end
+
+    def write_hash hsh
+      write_wml ::Weskit::WML::Builder.convert(hsh)
+    end
+
+    def write_string str
+      zstr = compress str
+      size = [zstr.size].pack 'N'
+      @connection.socket.send "#{size}#{zstr.string}", 0
+    end
+
+    def write_wml node
+      puts debug_header(:write) if @debug
+      write_string "#{node}"
+      puts debug(node) if @debug
+    end
+  end
+end

data/lib/weskit/mp/connection.rb

@@ -0,0 +1,74 @@
+require 'forwardable'
+require 'socket'
+require 'stringio'
+require 'zlib'
+
+module Weskit::MP
+  class Connection
+    extend Forwardable
+
+    attr_reader :adapter, :options, :socket
+    def_delegators :adapter, :buffer, :message, :read, :write
+
+    def close
+      @socket.close
+    end
+
+    def defaults
+      {
+        :debug   => false,
+        :host    => 'server.wesnoth.org',
+        :port    => 15000,
+        :version => '1.10.0'
+      }
+    end
+
+    def initialize worker, options = {}
+      @options = defaults.merge options
+
+      @adapter = Adapter.new self, @options[:debug]
+      @worker  = worker
+    end
+
+    def open
+      @socket = socket_for destination_socket
+      @worker.login
+      
+      if block_given?
+        result = yield
+        close ; result
+      end
+    end
+
+    private
+
+    def destination_socket
+      @socket  = socket_for @options
+      redirect = read.redirect
+
+      @socket.close
+      redirect
+    end
+
+    def socket_for hash
+      @socket = TCPSocket.new hash[:host], hash[:port]
+
+      socket_handshake
+      socket_init
+
+      @socket
+    end
+
+    def socket_handshake
+      @socket.send "\x00" * 4, 0
+      @socket.read 4
+    end
+
+    def socket_init
+      read
+
+      @worker.verify_response :version
+      message 'version', {:version => @options[:version]}
+    end
+  end
+end

data/lib/weskit/mp/errors/error.rb

@@ -0,0 +1,3 @@
+module Weskit::MP::Errors
+  class Error < StandardError ; end
+end

data/lib/weskit/mp/errors/response_error.rb

@@ -0,0 +1,3 @@
+module Weskit::MP::Errors
+  class ResponseError < ::Weskit::MP::Errors::Error ; end
+end