sxp 0.0.14 → 0.1.0

data/AUTHORS

@@ -1 +1 @@
-* Arto Bendiken <arto.bendiken@gmail.com>
+* Arto Bendiken <arto@bendiken.net>

data/README

@@ -1,21 +1,18 @@
-SXP.rb: S-Expressions for Ruby
-==============================
+#SXP.rb: S-Expressions for Ruby
 
 This is a Ruby implementation of a universal [S-expression][] parser.
 
 * <http://sxp.rubyforge.org/>
 * <http://github.com/bendiken/sxp-ruby>
 
-Features
---------
+##Features
 
 * Parses S-expressions in universal, [Scheme][], [Common Lisp][], or
   [SPARQL][] syntax.
 * Adds a `#to_sxp` method to Ruby objects.
 * Compatible with Ruby 1.8.7+, Ruby 1.9.x, and JRuby 1.4/1.5.
 
-Examples
---------
+##Examples
 
     require 'sxp'
 
@@ -49,8 +46,11 @@ Examples
 
     SXP::Reader::SPARQL.read %q((base <http://ar.to/>))  #=> [:base, RDF::URI('http://ar.to/')]
 
-Documentation
--------------
+### Writing an SXP with formatting
+
+    SXP::Generator.print([:and, true, false])   #=> (and #t #f)
+  
+##Documentation
 
 * <http://sxp.rubyforge.org/>
 

data/VERSION

@@ -1 +1 @@
-0.0.14
+0.1.0

data/lib/sxp.rb

@@ -39,8 +39,13 @@ module SXP
   ##
   # Reads all S-expressions from the given input files.
   #
-  # @param  [Enumerable<String>]     filenames
-  # @param  [Hash{Symbol => Object}] options
+  # @overload read_files(*filenames)
+  #   @param  [Enumerable<String>]     filenames
+  #
+  # @overload read_files(*filenames, options)
+  #   @param  [Enumerable<String>]     filenames
+  #   @param  [Hash{Symbol => Object}] options
+  #
   # @return [Enumerable<Object>]
   def self.read_files(*filenames)
     Reader::Scheme.read_files(*filenames)
@@ -75,6 +80,15 @@ module SXP
   def self.read(input, options = {})
     Reader::Scheme.read(input, options)
   end
+  
+  ##
+  # Write an internal S-Expression as a formatted SXP
+  #
+  # @param[Array<Object>] sxp
+  # @param[#write] output
+  def self.write(sxp, output = STDOUT)
+    Generator.write(output, sxp)
+  end
 
   class << self
     alias_method :parse,       :read

data/lib/sxp/generator.rb

@@ -1,16 +1,102 @@
 module SXP
   ##
   # An S-expression generator.
+  #
+  # Takes an object and pretty-prints it using reasonable indentation rules
   class Generator
     ##
+    # A basic block containing constituent
+    # objects, either blocks or strings.
+    class Block
+      BLOCK_MIN_LENGTH = 40
+
+      # @attr [Integer] amount of indent applied to this block
+      attr_reader :indent
+
+      ##
+      # @param [Object] obj
+      def initialize(obj, indent)
+        @indent = indent
+        @elements = []
+        if obj.is_a?(Array)
+          obj.compact.each {|o| @elements << Block.new(o, indent + 1)}
+        else
+          @elements = obj
+        end
+      end
+      
+      ##
+      # Agregate length over each element accounting for spaces
+      #
+      # @return [Integer]
+      #   If indent is not not nil, returns zero
+      def length
+        if @elements.is_a?(Array)
+          @elements.map(&:length).inject(:+).to_i + @elements.length - 1
+        else
+          @elements.to_sxp.length
+        end
+      end
+      
+      ##
+      # Turn block into a string in S-expression form
+      # This should only be called on a block when
+      # no indentation is to be applied
+      # @return [String]
+      def to_sxp
+        @elements.to_sxp
+      end
+      
+      ##
+      # Determins if this block is an SXP, or not
+      # @return [Boolean]
+      def sxp?
+        @elements.is_a?(Array)
+      end
+
+      ##
+      # Output block applying indent recursively
+      # @param [#write] io
+      def write(io)
+        # Output individual block elements on separate lines
+        if sxp? && length > BLOCK_MIN_LENGTH
+          io.write(do_indent + '(')
+          first, *elems = @elements
+          unless first.sxp?
+            # It's atomic, write out after paren
+            io.puts(first.to_sxp)
+          else
+            io.write("\n")
+            elems.unshift(first)
+          end
+          elems.each do |e|
+            e.write(io)
+          end
+          io.puts(do_indent + ")\n")
+        else
+          io.puts(do_indent + @elements.to_sxp)
+        end
+      end
+      
+      private
+      def do_indent(offset = 0); ' ' * (indent + offset); end
+    end
+
+    ##
+    # Format S-expressions to a String
+    #
     # @param  [Array]  sxps
     # @return [Object]
     def self.string(*sxps)
       require 'stringio' unless defined?(StringIO)
-      write(StringIO.new, *sxps).instance_variable_get('@buffer').string
+      buf = StringIO.new
+      write(buf, *sxps)
+      buf.string
     end
 
     ##
+    # Format S-expressions to STDOUT
+    #
     # @param  [Array]  sxps
     # @return [Object]
     def self.print(*sxps)
@@ -18,73 +104,46 @@ module SXP
     end
 
     ##
+    # Write formatted S-expressions to an IO like object
+    #
     # @param  [Object] out
     # @param  [Array]  sxps
     # @return [Object]
     def self.write(out, *sxps)
       generator = self.new(out)
       sxps.each do |sxp|
-        generator.send((op = sxp.shift).to_sym, *sxp)
+        generator.render(sxp)
       end
       generator
     end
 
     ##
-    # @param  [Object] buffer
+    # Initialize output with a stack of IO buffers
+    #
+    # @param  [#write] buffer
     def initialize(buffer)
-      @output = [@buffer = buffer]
-      @indent = 0
-    end
-
-    protected
-
-    ##
-    # @param  [String]                 text
-    # @param  [Hash{Symbol => Object}] options
-    # @return [void]
-    def emit(text, options = {})
-      if out = @output.last
-        out.print(' ' * (indent * 2)) if options[:indent]
-        out.print(text)
-      end
-    end
-
-    ##
-    # @yield
-    # @return [String]
-    def captured(&block)
-      require 'stringio' unless defined?(StringIO)
-      begin
-        @output.push(buffer = StringIO.new)
-        block.call
-      ensure
-        @output.pop
-      end
-      buffer.string
+      @output = buffer
     end
 
     ##
-    # @yield
-    # @return [Object]
-    def indented(&block)
-      begin
-        increase_indent!
-        block.call
-      ensure
-        decrease_indent!
+    # Render an element.
+    # For Array, this recursively renders each constituent into blocks.
+    # If the agregate length of a block is less than MIN_BLOCK characters,
+    # combine each constituent block into a single line.
+    #
+    # Rendering does not perform final formatting, but returns a recursive
+    # array of blocks which are each ultimattely formattted onto their
+    # own line with leading whitespace.
+    #
+    # @param [Object] sexp
+    # @return [Block]
+    def render(sexp)
+      block = Block.new(sexp, 0)
+      if block.length > 40
+        block.write(@output)
+      else
+        @output.puts(block.to_sxp)
       end
     end
-
-    ##
-    # @return [void]
-    def increase_indent!
-      @indent += 1
-    end
-
-    ##
-    # @return [void]
-    def decrease_indent!
-      @indent -= 1
-    end
   end # Generator
 end # SXP

data/lib/sxp/reader.rb

@@ -22,16 +22,21 @@ module SXP
     # @return [Enumerable<Object>]
     def self.read_url(url, options = {})
       require 'open-uri'
-      open(url.to_s, 'rb', nil, options) { |io| read_all(io, options) }
+      open(url.to_s, 'rb', nil, options) { |io| read_all(io, options).first }
     end
 
     ##
     # Reads all S-expressions from the given input files.
     #
-    # @param  [Enumerable<String>]     filenames
-    # @param  [Hash{Symbol => Object}] options
+    # @overload read_files(*filenames)
+    #   @param  [Enumerable<String>]     filenames
+    #
+    # @overload read_files(*filenames, options)
+    #   @param  [Enumerable<String>]     filenames
+    #   @param  [Hash{Symbol => Object}] options
+    #
     # @return [Enumerable<Object>]
-    def self.read_files(*filenames)
+    def read_files(*filenames)
       options = filenames.last.is_a?(Hash) ? filenames.pop : {}
       filenames.map { |filename| read_file(filename, options) }.inject { |sxps, sxp| sxps + sxp }
     end
@@ -43,7 +48,7 @@ module SXP
     # @param  [Hash{Symbol => Object}] options
     # @return [Enumerable<Object>]
     def self.read_file(filename, options = {})
-      File.open(filename.to_s, 'rb') { |io| read_all(io, options) }
+      File.open(filename.to_s, 'rb') { |io| read_all(io, options).first }
     end
 
     ##

data/lib/sxp/reader/sparql.rb

@@ -55,13 +55,8 @@ module SXP; class Reader
     # @example Returning a URI prefix
     #   parser.prefix(:dc)    #=> RDF::URI('http://purl.org/dc/terms/')
     #
-    # @overload prefix(name, uri)
-    #   @param  [Symbol, #to_s]   name
-    #   @param  [RDF::URI, #to_s] uri
-    #
-    # @overload prefix(name)
-    #   @param  [Symbol, #to_s]   name
-    #
+    # @param  [Symbol, #to_s]   name
+    # @param  [RDF::URI, #to_s] uri
     # @return [RDF::URI]
     def prefix(name, uri = nil)
       name = name.to_s.empty? ? nil : (name.respond_to?(:to_sym) ? name.to_sym : name.to_s.to_sym)

data/lib/sxp/version.rb

@@ -1,9 +1,7 @@
 module SXP
   module VERSION
-    MAJOR = 0
-    MINOR = 0
-    TINY  = 14
-    EXTRA = nil
+    VERSION_FILE = File.expand_path("../../../VERSION", __FILE__)
+    MAJOR, MINOR, TINY, EXTRA = File.read(VERSION_FILE).chop.split(".")
 
     STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.')
 

metadata

@@ -1,79 +1,74 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sxp
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 14
-  version: 0.0.14
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Arto Bendiken
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-04 00:00:00 +02:00
-default_executable: sxp2rdf
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 4
-        version: 0.6.4
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 5
-        - 0
-        version: 2.5.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.3
 description: A pure-Ruby implementation of a universal S-expression parser.
-email: arto.bendiken@gmail.com
-executables: 
+email: arto@bendiken.net
+executables:
 - sxp2rdf
 - sxp2json
 - sxp2xml
 - sxp2yaml
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - AUTHORS
 - CREDITS
 - README
@@ -96,39 +91,30 @@ files:
 - bin/sxp2json
 - bin/sxp2xml
 - bin/sxp2yaml
-has_rdoc: false
 homepage: http://sxp.rubyforge.org/
-licenses: 
+licenses:
 - Public Domain
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 1
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.1
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: sxp
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A pure-Ruby implementation of a universal S-expression parser.
 test_files: []
-
+has_rdoc: false