fancy_writer 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTIxMzllODc0MzhhMzM0M2Y0YWI0ZDFiYzAzMmQyZWI5NjhlMDQ1Ng==
+  data.tar.gz: !binary |-
+    YmM5NjZjMWNhY2ZhMzJhNWQxZjQwMjI4OTkwZjg0ZmQ0ZGZjZGY5YQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZGZiMTM3NDk4MzkxMTYzNGQyOTBmMzkzMzkwODcyNGFlMmM0OTY4ZTc4MWFl
+    NmMzY2VhZjQ5NjVhYjEyNjg1ZmYxYmM3Yjk2YzE2OGQ1NzVmNWM3ZTc5NmEx
+    ZGE3MWJjYzk4YjI4YmFjZjVjMDUzYTA2NjRjYzIzNTA1Mzg5MWI=
+  data.tar.gz: !binary |-
+    YjU1MjIzNjE0ZTgwYjM5ZjAxMGIyODM5MjRjNmQzMGNhYmNiYjQ0Yzg2NmUy
+    OTI3MjQyMjMyOGVlNjg3MWE1OWZlOGU3MDY5MTM1OTkzY2MyYzUxYzg5ODRl
+    ODllN2Q4NDEwMjBkNTIxMjg5NTFhMzJkMTA3MWZlZmJlYTg4MTA=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fancy_writer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser 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
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,306 @@
+# FancyWriter
+
+FancyWriter is a wrapper around an IO object that allows you to augment text
+blocks with whitespace indentation and comment symbols, and to format simple
+CSV data series. It uses a simple DSL for defining indentations, comment
+sections, and rules for symbol-separated value lists out of Enumerables.
+
+This gem originated from the need to create files in a simple plain-text
+format in which indentation is important: The TextGrid file format of Praat,
+a software used for linguistic and phonetic analyses
+(see [http://www.fon.hum.uva.nl/praat/](http://www.fon.hum.uva.nl/praat/)).
+
+After creating the code for indentation, I added the other methods, since
+they could easily benefit from the code that was already produced.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fancy_writer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fancy_writer
+
+## Usage
+
+### Basic usage and writing lines
+
+Given an IO object that is suitable for writing (such as a file or stdout),
+FancyWriter can use this IO object for creating formatted output:
+
+```` Ruby
+io = File.open('/foo/bar', 'w') # or any other writable IO
+FancyWriter::FancyIO.new(io) do
+  w 'Hello World!'
+end
+````
+
+produces
+
+````
+Hello World!
+````
+
+The methods `write`, `w`, and `line` can be used to your liking to create
+plain output. You can also pass multiple lines at once to such a method.
+Newlines are added automatically between each line. So,
+
+```` Ruby
+FancyWriter::FancyIO.new(io) do
+  w 'one', 'two', 'three'
+end
+````
+
+produces
+
+````
+one
+two
+three
+````
+
+### Ading commented sections
+
+You can mark a section of your document with comment symbols by wrapping the
+section in a block given to the `comment` method (short version: `c`):
+
+```` Ruby
+FancyWriter::FancyIO.new(io) do
+  comment do
+    w 'This line is commented out.', 'This one, too.'
+  end
+end
+````
+
+````
+# This line is commented out.
+# This one, too.
+````
+
+As you can see, Ruby-style comments are used by default (including a single
+trailing space to keep thind readable). To use another comment symbol, simply
+pass it as a parameter to the method:
+
+```` Ruby
+FancyWriter::FancyIO.new(io) do
+  comment('//') do
+    w 'This is a C style comment.'
+  end
+  comment('%') do
+    w 'This is a LaTeX style comment.'
+  end
+end
+````
+
+````
+// This is a C style comment.
+% This is a LaTeX style comment.
+````
+
+You can suppress the space separator by passing `false` as a second parameter.
+In this case, you must specify the comment symbol parameter in any case.
+
+```` Ruby
+FancyWriter::FancyIO.new(io) do
+  comment('#', false) do
+    w 'This line is commented out.'
+  end
+end
+````
+
+````
+#This line is commented out.
+````
+
+### Indentation
+
+Similar to comment blocks you can mark sections that should be indented by a
+certain amount of spaces (for tabs see below) with the `indent` method
+(short version: `i`):
+
+```` Ruby
+FancyWriter::FancyIO.new(io) do
+  w 'one'
+  indent do
+    w 'two'
+    indent do
+      w 'three'
+    end
+  end
+end
+````
+
+````
+one
+  two
+    three
+````
+
+You can see in this example that indentation (and also commenting) can be
+nested. Multiple indentations will be added / concatenated.
+By default, indentation uses two spaces. You can specify another amount
+of spaces by giving a number as a parameter.
+If you prefer tabs, you can use the method `tab_indent` (short version: `t`)
+– it works similar, but uses tabs instead of spaces and defaults to *one*
+tab symbol instead of *two* spaces.
+
+```` Ruby
+FancyWriter::FancyIO.new(io) do
+  w 'one'
+  tab_indent do
+    w 'I'm indented with one tab symbol.'
+    indent(8) do
+      w 'Additionally, eight spaces.'
+    end
+  end
+end
+````
+
+````
+  I'm indented with one tab symbol.
+          Additionally, eight spaces.
+````
+
+### Symbol-separated values
+
+If you pass an Enumerable to `write_enum` (short version: `e`), the underlying
+collection will be formatted as a symbol-separated list. By default, a comma
+will be used to separate values, and the values themselves will be used as-is:
+
+```` Ruby
+FancyWriter::FancyIO.new(io) do
+  write_enum [1,2,3,4]
+end
+````
+
+````
+1,2,3,4
+````
+
+You can specify another separator and a symbol used for quoting the single values
+by passing them to the writer object during initialization. So, in order to use
+a semicolon and single quotes, you can write:
+
+```` Ruby
+FancyWriter::FancyIO.new(io, {enum_quote: "'", enum_separator: ";"}) do
+  write_enum [1,2,3,4]
+end
+````
+
+````
+'1';'2';'3';'4'
+````
+
+Note that also for this method, surrounding `comment` or indentation methods
+are evaluated, meaning that also formatted number sequences will be indented
+or commented out.
+
+## An exhaustive example
+
+This is a somewhat artifical example, but it contains most of the methods
+in action.
+
+```` Ruby
+FancyWriter::FancyIO.new(io) do
+  comment '#' do
+    line 'This is an example file.'
+    line 'These comments explain the contents.'
+  end
+  line 'config:'
+  indent 4 do
+    line 'setting:'
+    indent 4 do
+      line 'some_key: some_value.'
+      comment do
+        line 'This is an inside comment.'
+      end
+    end
+    line 'data:'
+    indent 4 do
+      write_enum %w(1,2,3,4)
+      write_enum %w(5,6,7,8)
+    end
+  end
+end
+````
+
+````
+# This is an example file.
+# These comments explain the contents.
+config:
+    setting:
+        some_key: some_value.
+        # This is an inside comment.
+    data:
+        1,2,3,4
+        5,6,7,8
+````
+
+
+## Issues
+
+### Context and scope
+
+It is not possible at the moment to access member variables
+inside a `FancyIO.new` block. This is due to the way
+`instance_eval` works (which is used internally to evaluate
+the formatting blocks). If you need access to the context
+of the calling object,
+
+1. use accessor methods instead of variables,
+2. add `caller: self` to the options passed during creation
+of the fancy writer object:
+
+```` Ruby
+FancyWriter::FancyIO.new(io, {..., caller: self}) do
+  ...
+end
+````
+
+Then, the writer will know about the context of the object.
+Internally, it will try to send method calls to the origin
+object whenever `method_missing` reports a method call for
+which the writer does not have a counterpart.
+
+Found another problem? Is something not working? Contact me,
+ideally by creating an issue on Github.
+
+[https://github.com/pmenke/fancy_writer/issues](https://github.com/pmenke/fancy_writer/issues)
+
+Please browse existing issues first, to avoid double postings.
+
+## Contributing
+
+Any ideas are welcome!  Either
+
+1. Fork it ( http://github.com/<my-github-username>/fancy_writer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+or create an issue on github:
+
+[https://github.com/pmenke/fancy_writer/issues](https://github.com/pmenke/fancy_writer/issues)
+
+Please browse existing issues first, to avoid double postings.
+
+## Copyright and License
+
+FancyWriter is free software: you can redistribute it and/or modify
+it under the terms of the **GNU Lesser General Public License** as
+published by the Free Software Foundation, either version 3 of
+the License, or (at your option) any later version.
+
+FancyWriter 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 Lesser General Public License for more details.
+
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fancy_writer.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fancy_writer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fancy_writer"
+  spec.version       = FancyWriter::VERSION
+  spec.authors       = ["Peter Menke"]
+  spec.email         = ["pmenke@googlemail.com"]
+  spec.summary       = %q{A simple IO wrapper for easier comment blocks, indentation and CSV output.}
+  spec.description   = %q{FancyWriter is a wrapper around an IO object that allows you to augment text blocks with whitespace indentation and comment symbols, and to format simple CSV data series. }
+  spec.homepage      = "https://github.com/pmenke/fancy_writer"
+  spec.license       = "GNU LGPL 3"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/fancy_writer.rb

@@ -0,0 +1,198 @@
+# encoding: utf-8
+# This file is part of the fancy_writer gem.
+# Copyright (c) 2014 Peter Menke.
+# http://www.petermenke.de
+#
+# fancy_writer is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# fancy_writer 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with fancy_writer. If not, see
+# <http://www.gnu.org/licenses/>.
+
+require "fancy_writer/version"
+
+module FancyWriter
+
+  # FancyIO is the main class used for creating formatted writers.
+  # See README.md for an exhaustive usage description.
+  class FancyIO
+
+    # This hash holds some default options that are used when
+    # no other options are passed to the constructor.
+    DEFAULT_OPTIONS = {
+      enum_separator: ',',
+      enum_quote: ''
+    }
+
+    # The internal stream (IO) to write formatted output to.
+    attr_reader :stream
+
+    # The stack for strings to be prepended to each line.
+    attr_reader :prefix_stack
+
+    # The separator string to use for printing enumerables.
+    attr_reader :enum_separator
+
+    # The quote symbol to use for printing enumerables.
+    attr_reader :enum_quote
+
+    # An attribute holding the caller object.
+    attr_reader :caller
+
+
+    # Initializes a new fancy writer instance that wraps
+    # around the given io object +p_stream+.
+    # The block contains the code for writing to that
+    # stream.
+    # @param p_stream [IO]    The stream to write into.
+    # @option opts [String] :enum_separator The symbol to
+    #                                       be used to separate
+    #                                       values in enums.
+    # @option opts [String] :enum_quote The symbol for quoting
+    #                                   values in enums.
+    # @option opts [Object] :caller The calling object, useful
+    #                               when a method of it must
+    #                               be called inside FancyWriter's
+    #                               blocks.
+    # @param @block   [Block] A block containing the
+    #                         fancy writer code.
+    def initialize(p_stream, opts={}, &block)
+      @stream = p_stream
+      @prefix_stack = []
+      effective_opts = DEFAULT_OPTIONS.merge(opts)
+      @enum_separator = effective_opts[:enum_separator]
+      @enum_quote = effective_opts[:enum_quote]
+      @caller = effective_opts[:caller]
+      if block_given?
+        instance_eval &block
+      end
+    end
+
+    # Adds a new string to the prepend stack. These strings
+    # will be added to each output line until the end of the
+    # block is reached.
+    # @param prepend_string [String] The string to be prepended
+    #                                to each line in the given
+    #                                block
+    def prepend(prepend_string=' ', &block)
+      @prefix_stack << prepend_string
+      yield # &block
+      @prefix_stack.pop
+    end
+
+    # Prepends each line in the given block with Ruby-style
+    # comments ("# "). Another comment character can be passed
+    # as a parameter.
+    # @param comment_string [String] The comment character(s) to
+    #                                be prepended to each line in
+    #                                the given block.
+    def comment(comment_string='#', space_sep=true, &block)
+      if block_given?
+        if space_sep
+          prepend("#{comment_string} ", &block)
+        else
+          prepend("#{comment_string}", &block)
+        end
+      end
+    end
+
+    # Indents each line in the given block with spaces. The default
+    # amount is 2, another number of spaces can be given as a
+    # parameter.
+    # @param number [Integer] The number of spaces to be used for
+    #                         indentation in the given block.
+    def indent(number=2, &block)
+      prepend(' '*number, &block)
+    end
+
+    # Indents each line in the given block with tabs. The default
+    # amount is 1, another number of tabs can be given as a
+    # parameter.
+    # @param number [Integer] The number of tabs to be used for
+    #                         indentation in the given block.
+    def tab_indent(number=1, &block)
+      prepend("\t"*number, &block)
+    end
+
+    # Writes one or more lines to the output object, taking into
+    # account all strings on the prefix stack (such as comment
+    # symbols or indentations).
+    # @param line [Object] The object(s) to be formatted and written
+    #                      to the underlying writer.
+    def write(*line)
+      lines = lines==[] ? [''] : line
+      lines.each do |l|
+        write_line(l)
+      end
+    end
+
+    # This is a helper method for writing a single enumerable.
+    # @param p_enum [Enumerable] the enumerable to format and write.
+    def write_enum(p_enum)
+      write_line(p_enum)
+    end
+
+    # Adds an alias +w+ for the +write+ method.
+    alias :w    :write
+
+    # Adds an alias +line+ for the +write+ method.
+    alias :line :write
+
+    # Adds an alias +c+ for the +comment+ method.
+    alias :c :comment
+
+    # Adds an alias +i+ for the +indent+ method.
+    alias :i :indent
+
+    # Adds an alias +t+ for the +tab_indent+ method.
+    alias :t :tab_indent
+
+    # Adds an alias +e+ for the +write_enum+ method.
+    alias :e :write_enum
+
+
+    private
+
+    # This method redirects failed message calls to the
+    # caller object, if present, in order to provide the
+    # user with method calls inside FancyWriter's blocks.
+    def method_missing(meth, *args, &block)
+      if caller.respond_to?(meth)
+        caller.send(meth, *args, &block)
+      else
+        super
+      end
+    end
+
+    # Internal method that performs the actual writing.
+    # @param line [Object] the line to be written.
+    def write_line(line)
+      if line.kind_of? String
+        formatted_line = line
+      elsif line.kind_of? Enumerable
+        formatted_line = join_enumerable(line)
+      else
+        formatted_line = line.to_s
+      end
+      stream << "%s%s%s" %[@prefix_stack.join(''),formatted_line,"\n"]
+    end
+
+    # Joins together an enumerable, using configuration options
+    # +enum_quote+ to quote the single values, and +enum_separator+ to
+    # glue them together.
+    # @param enum [Enumerable] the enumerable to format.
+    def join_enumerable(enum)
+      enum.collect{|e| "#{@enum_quote}#{e}#{@enum_quote}"}.join(@enum_separator)
+    end
+
+  end
+
+end

data/lib/fancy_writer/version.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+# This file is part of the fancy_writer gem.
+# Copyright (c) 2014 Peter Menke.
+# http://www.petermenke.de
+#
+# fancy_writer is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# fancy_writer 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with fancy_writer. If not, see
+# <http://www.gnu.org/licenses/>.
+
+# The FancyWriter module contains a single class at the moment,
+# which is used for creating formatted output.
+# See README.md for usage details.
+module FancyWriter
+  # The current version of the library.
+  VERSION = "1.0.0"
+end

data/spec/fancy_writer/fancy_writer_spec.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+# This file is part of the fancy_writer gem.
+# Copyright (c) 2014 Peter Menke.
+# http://www.petermenke.de
+#
+# fancy_writer is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# fancy_writer 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with fancy_writer. If not, see
+# <http://www.gnu.org/licenses/>.
+require 'spec_helper'
+
+include FancyWriter
+
+describe FancyWriter::FancyIO do
+
+  # set up an initial corpus representation from the example file
+  before(:each) do
+    @string = String.new
+    @enum = [1,2,3,4]
+  end
+
+  context 'FancyWriter' do
+
+    context 'Basics' do
+      it 'writes lines without method as they are' do
+        @writer = FancyIO.new(@string) do
+          w "Foo"
+        end
+        @string.should eq "Foo\n"
+      end
+
+      it 'also works with the aliases of write' do
+        @writer = FancyIO.new(@string) do
+          w "a"
+          write "b"
+          line "c"
+        end
+        @string.should eq "a\nb\nc\n"
+      end
+    end
+
+    context 'Comments' do
+      it "should write comments without options as '#'" do
+        @writer = FancyIO.new(@string) do
+          comment do
+            w "Foo"
+          end
+        end
+        @string.should eq "# Foo\n"
+      end
+      it 'should write comments with options correctly' do
+        @writer = FancyIO.new(@string) do
+          comment '//' do
+            w "Foo"
+          end
+        end
+        @string.should eq "// Foo\n"
+      end
+      it 'should write comments without indentation correctly' do
+        @writer = FancyIO.new(@string) do
+          comment '#', false do
+            w "Foo"
+          end
+        end
+        @string.should eq "#Foo\n"
+      end
+    end
+
+    context 'Enumerables' do
+
+      it 'produces the correct output for default enum config' do
+        test_enum = @enum
+        @writer = FancyIO.new(@string) do
+          write_enum(test_enum)
+        end
+        @string.should eq "1,2,3,4\n"
+      end
+
+      it 'produces the correct output for a custom separator' do
+        test_enum = @enum
+        separator = ';'
+        @writer = FancyIO.new(@string, enum_separator: separator) do
+          write_enum(test_enum)
+        end
+        @string.should eq "1;2;3;4\n"
+      end
+
+      it 'produces the correct output for a custom quote symbol' do
+        test_enum = @enum
+        quote = "'"
+        @writer = FancyIO.new(@string, enum_quote: quote) do
+          write_enum(test_enum)
+        end
+        @string.should eq "'1','2','3','4'\n"
+      end
+
+      it 'produces the correct output for custom quote symbol and separator' do
+        test_enum = @enum
+        quote = "'"
+        separator = ';'
+        @writer = FancyIO.new(@string, enum_quote: quote, enum_separator: separator) do
+          write_enum(test_enum)
+        end
+        @string.should eq "'1';'2';'3';'4'\n"
+      end
+
+    end
+
+
+    it 'exports a complex example correctly' do
+      @writer = FancyIO.new(@string) do
+        comment '# ' do
+          line 'This is an example file.'
+          line 'These comments explain the contents.'
+        end
+        line 'config:'
+        indent 4 do
+          line 'setting:'
+          indent 4 do
+            line 'some_key: some_value.'
+            comment do
+              line 'This is an inside comment.'
+            end
+          end
+          line 'data:'
+          indent 4 do
+            write_enum %w(1,2,3,4)
+            write_enum %w(5,6,7,8)
+          end
+        end
+      end
+      puts @string
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+# This file is part of the fancy_writer gem.
+# Copyright (c) 2014 Peter Menke.
+# http://www.petermenke.de
+#
+# fancy_writer is free software: you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# fancy_writer 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 Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with fancy_writer. If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'fancy_writer' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: fancy_writer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter Menke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'FancyWriter is a wrapper around an IO object that allows you to augment
+  text blocks with whitespace indentation and comment symbols, and to format simple
+  CSV data series. '
+email:
+- pmenke@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fancy_writer.gemspec
+- lib/fancy_writer.rb
+- lib/fancy_writer/version.rb
+- spec/fancy_writer/fancy_writer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pmenke/fancy_writer
+licenses:
+- GNU LGPL 3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple IO wrapper for easier comment blocks, indentation and CSV output.
+test_files:
+- spec/fancy_writer/fancy_writer_spec.rb
+- spec/spec_helper.rb