kaiser-ruby 0.5.1 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fc112c05db3c0d35fd18ff7002728b5870dd5d51cf75c97b1e70e281b4ee808
-  data.tar.gz: 18bdbed256f36c972a54d61f9531694e6f178bc4cd3172fbab1b8a1787dd4c6f
+  metadata.gz: ed13667ff5f7efa6ac48fda708e248bf329466e999604dc3896eccc5b3b47cbe
+  data.tar.gz: be140e748235e62bab3e24d86a55aaea75b2a33521220355e9e9274dfdd58324
 SHA512:
-  metadata.gz: 184a6cbcc1b4e67c82464c33aecdeea74ad1acd0a9e6b12de7e00497ba0f39245b1b3df46b3d08393bdeddecd09ec86d75fcb2e5e6049591e811ac2cde406135
-  data.tar.gz: f635f13bbc469431462190f2e2bf9ebfdc7d6b99314f0f367cf2f04c0e31c45ecd22e489ce54e72e0bfebfe2d22ed0523468f4d8f1b73990fe3cbe42eb4f994c
+  metadata.gz: c16d9fb8793f6f81cd7bdddad78c14efc749a7d9ac47b9d25d6565c78443372dbbd57a77ac65de9531d168101a40f6825ec75e8c30d802df936799c3827468ec
+  data.tar.gz: 5a3fd840db588ca27ee1ceed35a651fa9ff019ea40cbf67f1ea6258a6808016b232bf2679a0ee683af50ae71268eef7b37f00cd58bd37ef078e95bb3f4c57447

data/CHANGELOG.md

@@ -1,35 +1,52 @@
-# 0.1
+# 0.7
 
-- [x] Initial implementation of the Rockstar Language based using `Parslet::Parser`
+Language Implementation
 
-# 0.2
+- [x] Full language implementation according to the spec
 
-- [x] Rewrote the Parser and Transform classes from scratch
-- [x] basic CLI and REPL
-- [x] Metal umlauts
-- [x] Most variable types, assignmnents, output, conditionals are working.
+- [x] Added forgotten `break` and `continue` keywords
+- [x] STDIN input now converts to Float or Integer as expected
+- [x] Fixed indenting of nested blocks, deep nesting works too
+- [x] Variables are scoped properly if you declare them before a function
+- [x] Handle ',' and 'and' in function calls together with precedence of &&
+- [x] Function calls should work with `, `, `, and`, `'n'` and `&` as argument separators. `and` without the comma is deprecated.
+- [x] Poetic assignment works with string and number literals
+- [x] All numbers are represented as floats
+- [x] Implement refinements to make math operations and comparisons work properly
+- [x] Handle NOT operator
+- [x] Handle NOR operation
+- [x] Handle equality
+- [x] `Listen` should just wait for user input and do nothing with it
+- [x] Multiple increments/decrements with `build X up, up up` and `knock Y down, down, down`
+- [x] Handle global variables if they're declared after function definition that uses them
 
-# 0.3
+Other
 
-Language Implementation:
+- [x] Replaced parsing with Parslet with a hand-written parser in plain Ruby
+- [x] Implemented reference tests
+- [x] Handle testing STDIN in RSpec tests
+- [x] CLI command reports which version it is
+- [x] Updated README with new examples and info
+- [x] Automatically adds require and using line to saved ruby file output
 
-- [x] Handle null type differently - nil in Ruby isn't really comparable to 0
-- [x] Handle mysterious type - probably this should be nil and what is now nil should be 0 instead
-- [x] Handle gt, gte, lt, lte comparisons
-- [x] Handle inequality
-- [x] While loop
-- [x] Until loop
-- [x] Break and continue
-- [x] And/Or keywords for conditionals
-- [x] Define functions
-- [x] Handle function calls
-- [x] Return can return math operations directly
+# 0.6 - unreleased
 
-Other stuff:
+- [x] Fixed error in input from STDIN
+- [x] The transpiler now throws a SyntaxError instead of Parslet exception
 
-- [x] FizzBuzz example is working
-- [x] Fibonacci example is working
-- [x] Added comments to resulting ruby code flow control statements, so it's easier to see where what ends. This should help making the code more readable (and easier to figure out if it's actually correct), at least while the indentation feature is not fully working yet.
+Test Suite
+
+- [x] Refactored the test suite to make more sense
+- [x] Added a ton of new negative and positive tests
+
+# 0.5
+
+- [x] Fixed converting decimals so "Conversion is lovestruck. lovestruck and essential seasick" results in "conversion = 0.0397" as one would expect.
+
+Other stuff
+
+- [x] Updated the REPL to work on Ruby versions earlier than 2.5 (2.3 is the minimum supported version)
+- [x] Travis CI tests on all supported Ruby versions
 
 # 0.4
 
@@ -51,11 +68,35 @@ Other stuff:
 - [x] Move nesting indentation from main module to transformer
 - [x] Celsius to Fahrenheit example
 
-# 0.5
+# 0.3
 
-- [x] Fixed converting decimals so "Conversion is lovestruck. lovestruck and essential seasick" results in "conversion = 0.0397" as one would expect.
+Language Implementation:
 
-Other stuff
+- [x] Handle null type differently - nil in Ruby isn't really comparable to 0
+- [x] Handle mysterious type - probably this should be nil and what is now nil should be 0 instead
+- [x] Handle gt, gte, lt, lte comparisons
+- [x] Handle inequality
+- [x] While loop
+- [x] Until loop
+- [x] Break and continue
+- [x] And/Or keywords for conditionals
+- [x] Define functions
+- [x] Handle function calls
+- [x] Return can return math operations directly
 
-- [x] Updated the REPL to work on Ruby versions earlier than 2.5 (2.3 is the minimum supported version)
-- [x] Travis CI tests on all supported Ruby versions
+Other stuff:
+
+- [x] FizzBuzz example is working
+- [x] Fibonacci example is working
+- [x] Added comments to resulting ruby code flow control statements, so it's easier to see where what ends. This should help making the code more readable (and easier to figure out if it's actually correct), at least while the indentation feature is not fully working yet.
+
+# 0.2
+
+- [x] Rewrote the Parser and Transform classes from scratch
+- [x] basic CLI and REPL
+- [x] Metal umlauts
+- [x] Most variable types, assignmnents, output, conditionals are working.
+
+# 0.1
+
+- [x] Initial implementation of the Rockstar Language based using `Parslet::Parser`

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    kaiser-ruby (0.5.1)
-      parslet (~> 1.8)
+    kaiser-ruby (0.7)
+      hashie
       thor (~> 0.20)
 
 GEM
@@ -10,8 +10,8 @@ GEM
   specs:
     coderay (1.1.2)
     diff-lcs (1.3)
+    hashie (3.6.0)
     method_source (0.9.0)
-    parslet (1.8.2)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)

data/README.md

@@ -5,7 +5,9 @@
 
 This tool translates a file containing a program written in the [Rockstar language](https://github.com/dylanbeattie/rockstar) to Ruby code.
 
-This is still a work in progress, however most of the language implementation is already finished and working (as are the fibonacci sequence and fizzbuzz examples in the repository). For details on what is done, see the TODO.md and CHANGELOG.md files.
+As of version 0.7, Kaiser-Ruby implements all of the Rockstar language spec and further versions will keep up with new language features as they are added.
+
+For details on what is done and what I'm still working on, see the TODO.md and CHANGELOG.md files.
 
 ## Installation
 
@@ -17,7 +19,7 @@ $ gem install kaiser-ruby
 
 This gem works best on a current Ruby version and requires Ruby 2.3 at minimum. Running it on 2.3 has the downside of metal umlauts not being entirely correct as that Ruby version doesn't know how to `.downcase` a capital umlaut letter, which was fixed in 2.4.
 
-If you're not using the umlauts, all should be fine otherwise.
+If you're not using the umlauts (or at least are careful to only replace lowercase letters with them), all should be fine otherwise.
 
 ## Usage
 
@@ -32,29 +34,48 @@ $ kaiser-ruby
 There are a few ways you can use it. First one will just output the result of the transpilation.
 
 ```
-$ kaiser-ruby transpile ./examples/assignment.rock
-tommy = 15
-puts tommy
+$ kaiser-ruby transpile ./examples/simple.rock
+@tommy = 15.0
+puts @tommy
+
+if "".to_bool
+  puts "empty strings are false"
+end
 
 ```
 
 The `--show-source` flag will output the Rockstar code along with the resulting Ruby code like this:
 
 ```
-$ kaiser-ruby transpile ./examples/assignment.rock --show-source
+$ kaiser-ruby transpile ./examples/simple.rock --show-source
 Tommy is a rebel
 Shout Tommy
+
+if ""
+Shout "empty strings are false"
 ----------------------------------------
-tommy = 15
-puts tommy
+@tommy = 15.0
+puts @tommy
+
+if "".to_bool
+  puts "empty strings are false"
+end
+
+```
+
+You can also use the `--save=FILE` option to write the resulting transpiled code as a file instead of outputting it. 
+
+```
+$ kaiser-ruby transpile ./examples/simple.rock --save=simple.rb
+Saved output in `simple.rb`
 
 ```
 
-You can also use the `--save=FILE` option to write the resulting transpiled code as a file instead of outputting it:
+The saved output will have a few additional lines at the start that include the language changes necessary for Rockstar to work correctly. You need the gem installed to run this file:
 
 ```
-$ kaiser-ruby transpile ./examples/assignment.rock --save=a.rb
-Saved output in `a.rb`
+$ ruby simple.rb 
+15.0
 
 ```
 
@@ -64,10 +85,10 @@ Another option is to run an interactive console (REPL):
 $ kaiser-ruby rock --debug
 Type 'exit' to exit the console. Otherwise, rock on!
 \m/> Put "Hello San Francisco" into the message
-\m/> the_message = "Hello San Francisco"
+\m/> @the_message = "Hello San Francisco"
   => Hello San Francisco
 \m/> Scream the message
-\m/> puts the_message
+\m/> puts @the_message
 Hello San Francisco
   => nil
 \m/> exit
@@ -77,7 +98,7 @@ $
 Finally, you can also transpile and immediately execute the code, like this:
 
 ```
-$ kaiser-ruby execute ./examples/assignment.rock
+$ kaiser-ruby execute ./examples/simple.rock
 15
 
 ```
@@ -86,37 +107,37 @@ Or even better, this:
 
 ```
 $ kaiser-ruby execute ./examples/fibonacci.rock
-1
-1
-2
-3
-5
-8
-13
-21
-34
-55
-89
-144
-233
-377
-610
-987
-1597
-2584
-4181
-6765
-10946
-17711
-28657
-46368
+1.0
+1.0
+2.0
+3.0
+5.0
+8.0
+13.0
+21.0
+34.0
+55.0
+89.0
+144.0
+233.0
+377.0
+610.0
+987.0
+1597.0
+2584.0
+4181.0
+6765.0
+10946.0
+17711.0
+28657.0
+46368.0
 
 $
 ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/marcinruszkiewicz/kaiser-ruby.
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcinruszkiewicz/kaiser-ruby. I'm also available for questions at the [Rockstar Developers Discord Group](https://discord.gg/kEUe5bM)
 
 ## License
 

data/TODO.md

@@ -2,22 +2,14 @@
 
 ## Language Implementation
 
-- [ ] Function calls can be used as expressions in flow statements
-- [ ] Handle ',' instead of 'and' in function calls
-
-- [ ] Somehow handle function variable scope
-- [ ] Handle object type
-
 ## Examples
 
 - [ ] Should be able to run the [Cellular Rockomata](https://github.com/Rifhutch/cellular-rocktomata)
 - [ ] Math module https://gist.github.com/wrenoud/6be6f7509c88a3d8f9867ae782fb768f
 - [ ] Primality checker https://www.reddit.com/r/RockstarDevs/comments/92i6sm/primality_checker_in_rockstar/
-- [ ] Make a demo command in the CLI that runs all examples (would that even work as a gem? it should be doable somehow)
 
 ## Other stuff
 
-- [ ] Fix indenting of nested blocks that doesn't really work well (this should also help deeper nesting)
 - [ ] Add code history to the REPL
 - [ ] Make REPL work with multiline input also, not only singular lines
 - [ ] Make a demo visitor that evals the code and waits a bit between commands, so it's more music video-ish. Maybe should change the console colors while at it?

data/exe/kaiser-ruby

@@ -3,5 +3,6 @@ require "rubygems"
 require "bundler/setup"
 require "kaiser_ruby"
 require "kaiser_ruby/cli"
+require "kaiser_ruby/refinements"
 
 KaiserRuby::CLI.start(ARGV)

data/kaiser-ruby.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.11"
-  spec.add_dependency "parslet", "~> 1.8"
   spec.add_dependency "thor", "~> 0.20"
+  spec.add_dependency "hashie"
 end

data/lib/kaiser_ruby.rb

@@ -1,31 +1,42 @@
-require 'parslet'
-require 'kaiser_ruby/rockstar_parser'
-require 'kaiser_ruby/rockstar_transform'
+require 'hashie'
+require 'kaiser_ruby/parser'
+require 'kaiser_ruby/transformer'
+require 'kaiser_ruby/refinements'
+require 'pry'
 
 module KaiserRuby
+  class RockstarSyntaxError < SyntaxError
+  end
+
   def self.parse(input)
     # eat comments since we don't care about them
-    input = input.gsub(/\(.*?\)/, '')
+    input = input.gsub(/\n *\(.*?\) *\n/m, "\n\n")
+    input = input.gsub(/\(.*?\)\s*\n/m, "\n").gsub(/ +/, ' ')
+    parser = KaiserRuby::Parser.new(input)
+    parser.parse
+  end
+
+  def self.transpile(input)
+    tree = parse(input)
+    KaiserRuby::Transformer.new(tree).transform
+  end
 
-    # expand contractions
-    input = input.gsub(/'s\W+/, ' is ')
+  using KaiserRuby::Refinements
 
-    # strings without a line ending (or single lines) should be fed into the alternative parser
-    if input.split("\n").size == 1
-      KaiserRuby::RockstarSingleLineParser.new.parse(input.chomp, reporter: Parslet::ErrorReporter::Deepest.new)
-    else
-      KaiserRuby::RockstarParser.new.parse(input, reporter: Parslet::ErrorReporter::Deepest.new)
+  def self.execute(input)
+    with_captured_stdout do
+      instance_eval transpile(input)
     end
-  rescue Parslet::ParseFailed => failure
-    puts input.inspect
-    puts failure.parse_failure_cause.ascii_tree
   end
 
-  def self.transform(tree)
-    KaiserRuby::RockstarTransform.new.apply(tree)
-  end
+  private
 
-  def self.transpile(input)
-    transform(parse(input))
+  def self.with_captured_stdout
+    old_stdout = $stdout
+    $stdout = StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = old_stdout
   end
 end

data/lib/kaiser_ruby/cli.rb

@@ -2,6 +2,8 @@ require 'thor'
 
 module KaiserRuby
   class CLI < Thor
+    package_name "Kaiser-Ruby v#{KaiserRuby::VERSION}"
+    
     desc "transpile FILE", "transpile a .rock FILE and output the result"
     option 'show-source'.to_sym, type: :boolean, desc: "prints out the source file along with the transpiled output"
     option :save, desc: "saves the transpiled output in SAVE"
@@ -16,6 +18,11 @@ module KaiserRuby
 
       if options[:save]
         out = File.new(options[:save], 'w')
+        out.write <<~REQ
+          require 'kaiser_ruby/refinements'
+          using KaiserRuby::Refinements
+          
+        REQ
         out.write output
         out.close
         say "Saved output in `#{options[:save]}`", :green
@@ -25,11 +32,12 @@ module KaiserRuby
       say
     end
 
+    using KaiserRuby::Refinements
+
     desc "execute FILE", "transpiles and runs a .rock FILE"
     def execute(filename)
       file = File.read filename
       output = KaiserRuby.transpile(file)
-
       instance_eval output
       say
     end
@@ -53,8 +61,8 @@ module KaiserRuby
           output = b.eval(code)
           output = 'nil' if output.nil?
           say "  => #{output}\n"
-        rescue
-          say "THE STAGE IS ON FIRE!"
+        rescue Exception => e
+          say "THE STAGE IS ON FIRE! #{e}: #{e.message}"
         end
       end
     end