kaiser-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ecdc0cb2c7bfb8c9480d9cd5113835efab137c28b48468ea3b31001c11df8f0
-  data.tar.gz: 3610bc55b430d53ca418a618def266cf31a3520653e1a8f73090d5cbd12ccb0e
+  metadata.gz: 9b5718545e9c7f76ee7424888738a48381168802086130192a15fee4d6c2f11a
+  data.tar.gz: a01209b2869ccbef8a0aa9824bba5b2cee0383e4a5cdb8044db5a0447d1805cf
 SHA512:
-  metadata.gz: de150bc12da3bb9d8ffedf78a150185f967ee3784649b30b053ea13404e50325a0e636009205a5b88004269cdd21522dd19674fb7f92663fa06d8700445a5179
-  data.tar.gz: 6f06bad2235550bcc58a80a6c70f70dd61fbccdc7dfb3c9aa1801713acc7e1f65ba46162bbaf3380c10fffdc0dde9b3aa1e4ea72e559b9423357266d479eff68
+  metadata.gz: 535f03ccac46331c49ef62b7b22f529ad4a7248c35fefacb6d3c3ee77603eb4a85c6cbb50580aa20fe210f3a8dabd4fa8a1cb381a6fb2fb0d97dea728a474a07
+  data.tar.gz: 328d6528bb967ca27e7eea4e69df429f08ad7659b28bd3058e357f28113153933a75de32d0efbdb817a7e7a6afb62d54b2b3379df50cf7d44df77f40da633af2

data/.gitignore

@@ -9,4 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
-.DS_Store
+.DS_Store
+*.gem

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    kaiser-ruby (0.1.0)
-      parslet
+    kaiser-ruby (0.2.0)
+      parslet (~> 1.8)
+      thor (~> 0.20)
 
 GEM
   remote: https://rubygems.org/
@@ -28,6 +29,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    thor (0.20.0)
 
 PLATFORMS
   ruby
@@ -35,7 +37,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   kaiser-ruby!
-  pry
+  pry (~> 0.11)
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/README.md

@@ -1,38 +1,65 @@
-# Kaiser::Ruby
+# KaiserRuby - a Rockstar to Ruby transpiler
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kaiser/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+This tool translates a file containing a program written in the [Rockstar language](https://github.com/dylanbeattie/rockstar) to Ruby code.
 
-TODO: Delete this and the text above, and describe your gem
+This is still a work in progress. For details on that, see the TODO.md file.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the gem by issuing the following command.
+
+    $ gem install kaiser-ruby
+
+## Usage
+
+The most common usage of this gem is to transpile (or transpile and run immediately) Rockstar code into Ruby code.
+
+This gem provides a commandline tool for you to use:
+
+    $ kaiser-ruby
+
+There are a few ways you can use it. First one will just output the result of the transpilation.
 
-```ruby
-gem 'kaiser-ruby'
 ```
+$ kaiser-ruby transpile ./examples/assignment.rock
+tommy = 15
+puts tommy
 
-And then execute:
+```
 
-    $ bundle
+The `--show-source` flag will output the Rockstar code along with the resulting Ruby code like this:
 
-Or install it yourself as:
+This will have a following output:
 
-    $ gem install kaiser-ruby
+```
+$ kaiser-ruby transpile ./examples/assignment.rock --show-source
+Tommy is a rebel
+Shout Tommy
+----------------------------------------
+tommy = 15
+puts tommy
 
-## Usage
+```
 
-TODO: Write usage instructions here
+You can also use the `--save=FILE` option to write the resulting transpiled code as a file instead of outputting it:
 
-## Development
+```
+$ kaiser-ruby transpile ./examples/assignment.rock --save=a.rb
+Saved output in `a.rb`
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Finally, you can also transpile and immediately execute the code, like this:
+
+```
+$ kaiser-ruby execute ./examples/assignment.rock
+15
+
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kaiser-ruby.
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcinruszkiewicz/kaiser-ruby.
 
 ## License
 

data/TODO.md

@@ -0,0 +1,43 @@
+# TODO notes for KaiserRuby transpiler
+
+## Variables
+
+- [ ] Handle pronouns - he, she, it, and others should refer to the last used variable
+
+## Types
+
+- [ ] Handle null type differently - nil in Ruby isn't really comparable to 0
+- [ ] Handle mysterious type - probably this should be nil and what is now nil should be 0 instead
+- [ ] Handle object type
+
+## Comparisons
+
+- [ ] Handle gt, gte, lt, lte comparisons
+- [ ] Handle negation
+
+## Input
+
+- [ ] Handle input from STDIN
+
+## Flow Control
+
+- [ ] While loop
+- [ ] Until loop
+- [ ] Break and continue
+
+## Functions
+
+- [ ] Define functions
+- [ ] Handle function calls
+
+## Examples
+
+- [ ] FizzBuzz example (should also be in tests to check if it runs)
+- [ ] Should be able to run the [Cellular Rockomata](https://github.com/Rifhutch/cellular-rocktomata)
+- [ ] Fibonacci example https://github.com/dylanbeattie/rockstar/issues/94#issuecomment-408217504
+- [ ] Math module https://gist.github.com/wrenoud/6be6f7509c88a3d8f9867ae782fb768f
+
+## Other stuff
+
+- [ ] Test if it handles metal umlauts (Ruby shouldn't care much, but tests should be made)
+- [ ] Ignore comments in parentheses

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "kaiser/ruby"
+require "kaiser_ruby"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/exe/kaiser-ruby

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler/setup"
+require "kaiser_ruby"
+require "kaiser_ruby/cli"
+
+KaiserRuby::CLI.start(ARGV)

data/kaiser-ruby.gemspec

@@ -14,15 +14,16 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(spec|examples)/})
   end
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = ['kaiser-ruby']
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
-  spec.add_dependency "parslet"
+  spec.add_development_dependency "pry", "~> 0.11"
+  spec.add_dependency "parslet", "~> 1.8"
+  spec.add_dependency "thor", "~> 0.20"
 end

data/lib/kaiser_ruby.rb

@@ -1,11 +1,17 @@
 require 'parslet'
 require 'kaiser_ruby/rockstar_parser'
 require 'kaiser_ruby/rockstar_transform'
+require 'pry'
 
 module KaiserRuby
   def self.parse(input)
-    KaiserRuby::RockstarParser.new.parse(input)
+    if input.split("\n").size == 1
+      KaiserRuby::RockstarSingleLineParser.new.parse(input.chomp)
+    else
+      KaiserRuby::RockstarParser.new.parse(input)
+    end
   rescue Parslet::ParseFailed => failure
+    puts input.inspect
     puts failure.parse_failure_cause.ascii_tree
   end
 

data/lib/kaiser_ruby/cli.rb

@@ -0,0 +1,37 @@
+require 'thor'
+
+module KaiserRuby
+  class CLI < Thor
+    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"
+    def transpile(filename)
+      file = File.read filename
+      output = KaiserRuby.transpile(file)
+
+      if options['show-source'.to_sym]
+        puts file
+        puts "-" * 40
+      end
+
+      if options[:save]
+        out = File.new(options[:save], 'w')
+        out.write output
+        out.close
+        puts "Saved output in `#{options[:save]}`"
+      else
+        puts output
+      end
+      puts
+    end
+
+    desc "execute FILE", "transpiles and runs a .rock FILE"
+    def execute(filename)
+      file = File.read filename
+      output = KaiserRuby.transpile(file)
+
+      eval output
+      puts
+    end
+  end
+end

data/lib/kaiser_ruby/rockstar_parser.rb

@@ -1,16 +1,181 @@
 module KaiserRuby
   class RockstarParser < Parslet::Parser
-    root(:poetic_literal)
+    rule(:reserved) do
+      nil_value_keywords | true_value_keywords | false_value_keywords | plus_keywords | minus_keywords | times_keywords | over_keywords |
+      str('Knock') | str('Build') | str('Put') | str('into') | str('says') | poetic_number_keywords | say_keywords
+    end
 
-    # declare spaces to DRY out later definitions
-    rule(:space) { match(' ').repeat(1) }
+    rule(:nil_value_keywords) { str('nothing') | str('nowhere') | str('nobody') | str('empty') | str('gone') }
+    rule(:false_value_keywords) { str('false') | str('wrong') | str('no') | str('lies') }
+    rule(:true_value_keywords) { str('true') | str('right') | str('yes') | str('ok') }
+    rule(:plus_keywords) { str('plus') | str('with') }
+    rule(:minus_keywords) { str('minus') | str('without') }
+    rule(:minus_keywords) { str('minus') | str('without') }
+    rule(:times_keywords) { str('times') | str('of') }
+    rule(:over_keywords) { str('over') }
+    rule(:poetic_number_keywords) { str('is') | str('was') | str('were') }
+    rule(:say_keywords) { str('Say') | str('Shout') | str('Scream') | str('Whisper') }
+    rule(:flow_keywords) { str('If') | str('Else') | str('While') | str('Until') }
 
-    # parts of a variable assignment
-    rule(:proper_variable_name) { (match('[A-Z]') >> match('[a-z]').repeat(1)) }
-    rule(:assignment) { space >> (str('is') | str('was') | str('were')) >> space }
-    rule(:number_literal) { (match['a-z'].repeat(1) >> space.maybe).repeat.as(:number_str) }
+    rule(:proper_word) { reserved.absent? >> match['A-Z'] >> match['A-Za-z'].repeat }
+    rule(:common_word) { reserved.absent? >> match['A-Za-z'].repeat }
+    rule(:common_variable_name) do
+      (
+        str('A ') | str('a ') |
+        str('An ') | str('an ') |
+        str('The ') | str('the ') |
+        str('My ') | str('my ') |
+        str('Your ') | str('your ')
+      ) >> reserved.absent? >> match['a-z'].repeat
+    end
+    rule(:proper_variable_name) do
+      (proper_word >> (space >> proper_word).repeat).repeat(1)
+    end
 
-    rule(:poetic_literal) { poetic_number_literal.as(:var) }
-    rule(:poetic_number_literal) { proper_variable_name.as(:var_name) >> assignment >> number_literal.as(:var_value) }
+    rule(:variable_names) do
+      (common_variable_name | proper_variable_name).as(:variable_name)
+    end
+
+    rule(:nil_value) { nil_value_keywords.as(:nil_value) }
+    rule(:true_value) { true_value_keywords.as(:true_value) }
+    rule(:false_value) { false_value_keywords.as(:false_value) }
+    rule(:string_value) { (str('"') >> match['A-Za-z '].repeat >> str('"')).as(:string_value) }
+    rule(:numeric_value) { match['0-9\.'].repeat.as(:numeric_value) }
+    rule(:unquoted_string) { match['^\n'].repeat.as(:unquoted_string) }
+    rule(:string_as_number) { reserved.absent? >> match['^\n'].repeat.as(:string_as_number) }
+
+    rule(:basic_assignment_expression) do
+      match('Put ').present? >>
+      (
+        str('Put ') >> string_input.as(:right) >> str(' into ') >> variable_names.as(:left)
+      ).as(:assignment)
+    end
+
+    rule(:increment) do
+      (
+        str('Build ') >> variable_names.as(:variable_name) >> str(' up')
+      ).as(:increment)
+    end
+
+    rule(:decrement) do
+      (
+        str('Knock ') >> variable_names.as(:variable_name) >> str(' down')
+      ).as(:decrement)
+    end
+
+    # math operations
+
+    rule(:addition) do
+      (match('.*? plus') | match('.*? with')).present? >>
+      (
+        value_or_variable.as(:left) >> space >> plus_keywords >> space >> value_or_variable.as(:right)
+      ).as(:addition)
+    end
+
+    rule(:subtraction) do
+      (match('.*? minus') | match('.*? without')).present? >>
+      (
+        value_or_variable.as(:left) >> space >> minus_keywords >> space >> value_or_variable.as(:right)
+      ).as(:subtraction)
+    end
+
+    rule(:division) do
+      match('.*? over').present? >>
+      (
+        value_or_variable.as(:left) >> space >> over_keywords >> space >> value_or_variable.as(:right)
+      ).as(:division)
+    end
+
+    rule(:multiplication) do
+      (match('.*? times') | match('.*? of')).present? >>
+      (
+        value_or_variable.as(:left) >> space >> times_keywords >> space >> value_or_variable.as(:right)
+      ).as(:multiplication)
+    end
+
+    # poetic assignments
+
+    rule(:poetic_type_literal) do
+      (flow_keywords.absent?) >>
+      (
+        variable_names.as(:left) >> str(' is ') >> (nil_value | false_value | true_value).as(:right)
+      ).as(:assignment)
+    end
+
+    rule(:poetic_string_literal) do
+      (
+        variable_names.as(:left) >> str(' says ') >> unquoted_string.as(:right)
+      ).as(:assignment)
+    end
+
+    rule(:poetic_number_literal) do
+      (flow_keywords.absent?) >>
+      (
+        variable_names.as(:left) >> space >> poetic_number_keywords >> space >> string_as_number.as(:right)
+      ).as(:assignment)
+    end
+
+    rule(:print_function) do
+      (
+        say_keywords >> space >> value_or_variable.as(:output)
+      ).as(:print)
+    end
+
+    # comparisons
+
+    rule(:equality) do
+      (
+        value_or_variable.as(:left) >> str(' is ') >> (string_as_number | value_or_variable).as(:right)
+      ).as(:equals)
+    end
+
+    # flow control
+
+    rule(:if_block) do
+      (
+        str('If ') >> comparisons.as(:if_condition) >> eol >>
+          scope {
+            inner_block_line.repeat.as(:if_block) >>
+            (eol | eof).as(:endif)
+          }
+      ).as(:if)
+    end
+
+    rule(:if_else_block) do
+      (
+        str('If ') >> comparisons.as(:if_condition) >> eol >>
+          scope {
+            inner_block_line.repeat.as(:if_block)
+          } >>
+        str('Else') >> eol >>
+          scope {
+            inner_block_line.repeat.as(:else_block) >>
+            (eol | eof).as(:endif)
+          }
+      ).as(:if_else)
+    end
+
+    rule(:simple_values) { nil_value | false_value | true_value | string_value | numeric_value }
+    rule(:value_or_variable) { variable_names | simple_values }
+    rule(:expressions) { basic_assignment_expression | increment | decrement | addition | subtraction | multiplication | division }
+    rule(:comparisons) { equality }
+    rule(:flow_control) { if_block | if_else_block }
+    rule(:poetics) { poetic_type_literal | poetic_string_literal | poetic_number_literal }
+    rule(:functions) { print_function }
+    rule(:line_elements) { flow_control | poetics | expressions | functions | eol }
+
+    rule(:string_input) { line_elements | value_or_variable }
+    rule(:line) { (line_elements >> eol.maybe).as(:line) }
+    rule(:inner_block_line) { ( (flow_control | poetics | expressions | functions) >> eol.maybe).as(:line) }
+    rule(:lyrics) { line.repeat.as(:lyrics) }
+    root(:lyrics)
+
+    rule(:eol) { match["\n"] }
+    rule(:eof) { any.absent? }
+    rule(:space) { match[' \t'].repeat(1) }
+  end
+
+  class RockstarSingleLineParser < KaiserRuby::RockstarParser
+    root(:string_input)
   end
 end

data/lib/kaiser_ruby/rockstar_transform.rb

@@ -1,13 +1,56 @@
 module KaiserRuby
   class RockstarTransform < Parslet::Transform
-    rule(:number_str => simple(:str)) { str.to_s.split(/\s+/).map {|e| e.length % 10}.join.to_i }
+    rule(variable_name: simple(:str)) { |c| parameterize(c[:str]) }
 
-    rule(:var => { :var_name => simple(:name), :var_value => simple(:value) }) do |context|
-      "#{parameterize(context[:name])} = #{context[:value]}"
+    rule(nil_value: simple(:_)) { 'nil' }
+    rule(true_value: simple(:_)) { 'true' }
+    rule(false_value: simple(:_)) { 'false' }
+    rule(string_value: simple(:str)) { str }
+    rule(numeric_value: simple(:num)) { num }
+    rule(unquoted_string: simple(:str)) { "\"#{str}\"" }
+    rule(string_as_number: simple(:str)) do |c|
+      if c[:str].to_s.include?('.')
+        c[:str].to_s.gsub(/[^A-Za-z\s\.]/, '').split('.').map do |sub|
+          str_to_num(sub)
+        end.join('.').to_f
+      else
+        str_to_num(c[:str])
+      end
     end
 
+    rule(assignment: { left: simple(:left), right: simple(:right) }) { "#{left} = #{right}" }
+    rule(increment: simple(:str)) { "#{str} += 1" }
+    rule(decrement: simple(:str)) { "#{str} -= 1" }
+    rule(addition: { left: simple(:left), right: simple(:right) }) { "#{left} + #{right}" }
+    rule(subtraction: { left: simple(:left), right: simple(:right) }) { "#{left} - #{right}" }
+    rule(multiplication: { left: simple(:left), right: simple(:right) }) { "#{left} * #{right}" }
+    rule(division: { left: simple(:left), right: simple(:right) }) { "#{left} / #{right}" }
+
+    rule(print: { output: simple(:output) }) { "puts #{output}" }
+
+    rule(equals: { left: simple(:left), right: simple(:right) }) { "#{left} == #{right}" }
+    rule(if: { if_condition: simple(:if_condition), if_block: sequence(:if_block_lines), endif: simple(:_)} ) do
+      "if #{if_condition}\n" +
+      if_block_lines.map { |l| "#{l}\n" }.join +
+      "end"
+    end
+    rule(if_else: { if_condition: simple(:if_condition), if_block: sequence(:if_block_lines), else_block: sequence(:else_block_lines), endif: simple(:_)} ) do
+      "if #{if_condition}\n" +
+      if_block_lines.map { |l| "#{l}\n" }.join +
+      "else\n" +
+      else_block_lines.map { |l| "#{l}\n" }.join +
+      "end"
+    end
+
+    rule(line: simple(:line)) { line == "\n" ? nil : line }
+    rule(lyrics: sequence(:lines)) { lines.join("\n") + "\n" }
+
     def self.parameterize(string)
       string.to_s.downcase.gsub(/\s+/, '_')
     end
+
+    def self.str_to_num(string)
+      string.to_s.split(/\s+/).map { |e| e.length % 10 }.join.to_i
+    end
   end
 end

data/lib/kaiser_ruby/version.rb

@@ -1,3 +1,3 @@
 module KaiserRuby
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaiser-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marcin Ruszkiewicz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,34 +56,49 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.20'
 description: 
 email:
 - marcin.ruszkiewicz@polcode.net
-executables: []
+executables:
+- kaiser-ruby
 extensions: []
 extra_rdoc_files: []
 files:
@@ -95,10 +110,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
+- exe/kaiser-ruby
 - kaiser-ruby.gemspec
 - lib/kaiser_ruby.rb
+- lib/kaiser_ruby/cli.rb
 - lib/kaiser_ruby/rockstar_parser.rb
 - lib/kaiser_ruby/rockstar_transform.rb
 - lib/kaiser_ruby/version.rb