shaun 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6e1e67d80575fc1d34735200b6388269d939c3f
-  data.tar.gz: 4b321f883efb357cd4685e0642178c6d35c90076
+  metadata.gz: 3488c6165d5e961e63a1009586c268a1749d6dd3
+  data.tar.gz: 75b5def6f77b85f748262c9e6336e10cc1921e3d
 SHA512:
-  metadata.gz: c06eaf873d54732a48cb1d2eefc376617be485f1acc379678c457fdd454f59b4bd632925c8d12eb40e5f571c0ff900bd33b92e574eb36aac5afd517d3d13c07b
-  data.tar.gz: 8f27fd9d632f87fe720dab76fd1358733688275acaa16388bc9bc54e3d6955da25d76fa923dfc7114368fb41243cd90f7d2b1ccc43812f710ff8ab4cce03cd81
+  metadata.gz: 1ac1179a6baaf9e2137249d28c53ba92ec18a5390227715591ea5a72eab9a732194b76d14cf262533d7242481b14f2b1bce771dfec6b359f3b9339b65943a2b6
+  data.tar.gz: cfd4db81f5ce2bc67190d802092b0b16947c4c8ac271db3348afb094f5a253b48317695e1cc0eb808f43b9751a3e5ea37f35cf5a51873e1598face72a398c02c

data/lib/prettyprinter.rb

@@ -0,0 +1,78 @@
+module Shaun
+  # The SHAUN pretty printer. It prints a SHAUN value so that it is easy to read
+  class PrettyPrinter
+    # Create a pretty printer with the tabulation string (2 spaces by default)
+    def initialize(tabchar = '  ')
+      @tab = tabchar
+      @indent_level = 0
+    end
+
+    # Add a level of indentation
+    def indent
+      @indent_level = @indent_level + 1
+    end
+
+    # remove a level of indentation
+    def dedent
+      @indent_level = @indent_level - 1
+    end
+
+    # Get the indentation string
+    def indent_string
+      @tab * @indent_level
+    end
+
+    # Pretty print a number
+    def print_number(sn_num)
+      sn_num.to_s
+    end
+
+    # Pretty print a boolean
+    def print_bool(b)
+      b.to_s
+    end
+
+    # Pretty print a string
+    def print_string(s)
+      "\"#{s}\""
+    end
+
+    # Pretty print a null value
+    def print_nil
+      "null"
+    end
+
+    # Pretty print a list
+    def print_list(ary)
+      indent
+      contents = ary.map { |e| print_list_element e }.join "\n"
+      dedent
+      "[\n" + contents + "\n" + indent_string + "]"
+    end
+
+    # Pretty print an object
+    def print_object(obj)
+      indent
+
+      attributes = obj.instance_variables.map do |name|
+        value = obj.instance_variable_get name
+        attr_name = name.to_s.sub /@/, ''
+        print_object_attribute attr_name, value
+      end
+
+      contents = attributes.join "\n"
+      dedent
+      "{\n" + contents + "\n" + indent_string + "}"
+    end
+
+    private
+      def print_object_attribute(name, value)
+        contents = "#{name}: #{value.pretty_print(self)}"
+        indent_string + contents
+      end
+
+      def print_list_element(elem)
+        indent_string + elem.pretty_print(self)
+      end
+  end
+end

data/lib/shaun.rb

@@ -1,3 +1,5 @@
+require_relative 'prettyprinter.rb'
+
 # The main module that holds every SHAUN related classes and some helper functions
 module Shaun
   # Helper module for classes that are tranparent SHAUN values (String, Boolean, Object)
@@ -18,7 +20,7 @@ module Shaun
     # Object values are stored as instance attributes
     #
     # === Example
-    # obj = Sn::Object.new({ greetings: 'hello' })
+    # obj = Shaun::Object.new({ greetings: 'hello' })
     # greetings = obj.greetings
     # obj.greetings = 'New hello!'
     def initialize(hash = {})
@@ -44,6 +46,11 @@ module Shaun
       end
     end
 
+    # Pretty print the SHAUN value
+    def pretty_print(pp)
+      pp.print_object self
+    end
+
     private
       # Get the object's metaclass
       def metaclass
@@ -93,6 +100,11 @@ module Shaun
           "#{@value.to_s}"
       end
     end
+
+    # Pretty print the SHAUN value
+    def pretty_print(pp)
+      pp.print_number self
+    end
   end
 
   # Helper method to create a SHAUN object
@@ -113,14 +125,14 @@ end
 
 class Hash
   def to_sn
-    Sn::Object.new self
+    Shaun::Object.new self
   end
 end
 
 class Numeric
   # Cast to a SHAUN number
   def to_sn
-    Sn::Number.new self
+    Shaun::Number.new self
   end
 
   # Patched method #method_missing in order to generate a SHAUN number
@@ -129,7 +141,7 @@ class Numeric
     res = m.match /([a-zA-Z_][a-zA-Z0-9_]*)/
     if res and params.empty?
       unit = res[1].to_s
-      Sn::Number.new self, unit
+      Shaun::Number.new self, unit
     else
       super m, *params
     end
@@ -137,19 +149,39 @@ class Numeric
 end
 
 class String
-  include Sn::ShaunValue
+  include Shaun::ShaunValue
+
+  # Pretty print the SHAUN value
+  def pretty_print(pp)
+    pp.print_string self
+  end
 end
 
 class TrueClass
-  include Sn::ShaunValue
+  include Shaun::ShaunValue
+
+  # Pretty print the SHAUN value
+  def pretty_print(pp)
+    pp.print_bool self
+  end
 end
 
 class FalseClass
-  include Sn::ShaunValue
+  include Shaun::ShaunValue
+
+  # Pretty print the SHAUN value
+  def pretty_print(pp)
+    pp.print_bool self
+  end
 end
 
 class NilClass
-  include Sn::ShaunValue
+  include Shaun::ShaunValue
+
+  # Pretty print the SHAUN value
+  def pretty_print(pp)
+    pp.print_nil
+  end
 end
 
 class Array
@@ -158,4 +190,9 @@ class Array
   def to_sn
     map { |e| e.to_sn }
   end
+
+  # Pretty print the SHAUN value
+  def pretty_print(pp)
+    pp.print_list self
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shaun
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Kévin Le Bon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-30 00:00:00.000000000 Z
+date: 2018-01-06 00:00:00.000000000 Z
 dependencies: []
 description: |2
       This gem is an Ruby implementation of the SHAUN data-notation language.
@@ -18,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/prettyprinter.rb
 - lib/shaun.rb
 homepage: 
 licenses: