nscript 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d487c1f30024a94c47f95fe6241322741e10c9df7a96655492bcb5a93e9c9ad
+  data.tar.gz: 522f48639a5bcffbdecc19767c85e4c352b7ca72b722fd8bf915802ea2543b91
+SHA512:
+  metadata.gz: 51625e11380e44d92064ae1f7b8797edc56ccd82d7163cf66e59214a5e98377b127804388862ae18c5027ee7142f245f594191efe6a40bc3505c6d6c29610c9c
+  data.tar.gz: 6f19c41ef4ffa3fad5205e3c6bf03c289163768e0f194c43e7df241b99af658af112b9aea66196bd8cc6fd1e68301a131be020e78958f10ee73e48ed3532b0a6

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at stormburpee@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nscript.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    nscript (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  nscript!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Storm Burpee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Nscript
+
+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/nscript`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nscript'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nscript
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nscript. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Nscript project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nscript/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/nscript

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "#{File.dirname(__FILE__)}/../lib/nscript/command_line.rb"
+
+NScript::CommandLine.new

data/examples/code.ns

@@ -0,0 +1,173 @@
+# Functions:
+square: (x) -> x * x
+
+sum: (x, y) -> x + y
+
+odd: (x) -> x % 2 isnt 0
+
+even: (x) -> x % 2 is 0
+
+run_loop: ->
+  fire_events((e) -> e.stopPropagation())
+  listen()
+  wait()
+
+# Objects:
+dense_object_literal: {one: 1, two: 2, three: 3}
+
+spaced_out_multiline_object: {
+  pi: 3.14159
+  list: [1, 2, 3, 4]
+  regex: /match[ing](every|thing|\/)/gi
+  three: new Idea()
+
+  inner_obj: {
+    freedom: -> _.freedom()
+  }
+}
+
+# Arrays:
+stooges: [{moe: 45}, {curly: 43}, {larry: 46}]
+
+exponents: [(x) -> x, (x) -> x * x, (x) -> x * x * x]
+
+empty: []
+
+multiline: [
+  'line one'
+  'line two'
+]
+
+# Conditionals and ternaries.
+if submarine.shields_up
+  full_speed_ahead()
+  fire_torpedos()
+else if submarine.sinking
+  abandon_ship()
+else
+  run_away()
+
+eldest: if 25 > 21 then liz else marge
+
+decoration: medal_of_honor if war_hero
+
+go_to_sleep() unless coffee
+
+# Returning early:
+race: ->
+  run()
+  walk()
+  crawl()
+  if tired then return sleep()
+  race()
+
+# Conditional assignment:
+good ||= evil
+wine &&= cheese
+
+# Nested property access and calls.
+((moon.turn(360))).shapes[3].move({x: 45, y: 30}).position['top'].offset('x')
+
+a: b: c: 5
+
+# Embedded JavaScript.
+callback(
+  `function(e) { e.stop(); }`
+)
+
+# Try/Catch/Finally/Throw.
+try
+  all_hell_breaks_loose()
+  dogs_and_cats_living_together()
+  throw "up"
+catch error
+  print(error)
+finally
+  clean_up()
+
+try all_hell_breaks_loose() catch error then print(error) finally clean_up()
+
+# While loops, break and continue.
+while demand > supply
+  sell()
+  restock()
+
+while supply > demand then buy()
+
+while true
+  break if broken
+  continue if continuing
+
+# Unary operators.
+!!true
+
+# Lexical scoping.
+v_1: 5
+change_a_and_set_b: ->
+  v_1: 10
+  v_2: 15
+v_2: 20
+
+# Array comprehensions.
+supper: food.capitalize() for food in ['toast', 'cheese', 'wine']
+
+drink(bottle) for bottle, i in ['soda', 'wine', 'lemonade'] when even(i)
+
+# Switch statements ("else" serves as a default).
+activity: switch day
+  when "Tuesday"   then eat_breakfast()
+  when "Sunday"    then go_to_church()
+  when "Saturday"  then go_to_the_park()
+  when "Wednesday"
+    if day is bingo_day
+      go_to_bingo()
+    else
+      eat_breakfast()
+      go_to_work()
+      eat_dinner()
+  else go_to_work()
+
+# Semicolons can optionally be used instead of newlines.
+wednesday: -> eat_breakfast(); go_to_work(); eat_dinner()
+
+# Array slice literals.
+zero_to_nine: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+three_to_six: zero_to_nine[3..6]
+
+# Multiline strings with inner quotes.
+story: "Lorem ipsum dolor \"sit\" amet, consectetuer adipiscing elit,
+sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna
+aliquam erat volutpat. Ut wisi enim ad."
+
+# Inheritance and calling super.
+Animal: ->
+Animal::move: (meters) ->
+  alert(this.name + " moved " + meters + "m.")
+
+Snake: (name) -> this.name: name
+Snake extends Animal
+Snake::move: ->
+  alert('Slithering...')
+  super(5)
+
+Horse: (name) -> this.name: name
+Horse extends Animal
+Horse::move: ->
+  alert('Galloping...')
+  super(45)
+
+sam: new Snake("Sammy the Snake")
+tom: new Horse("Tommy the Horse")
+
+sam.move()
+tom.move()
+
+# Numbers.
+a_googol:   1e100
+hex:        0xff0000
+negative:   -1.0
+infinity:   Infinity
+nan:        NaN
+
+# Deleting.
+delete secret.identity

data/examples/helloworld.ns

@@ -0,0 +1,6 @@
+Hello: ->
+Hello::world: ->
+  console.log("Hello, World!")
+  
+hello: new Hello()
+hello.world()

data/lib/nscript/command_line.rb

@@ -0,0 +1,235 @@
+require 'optparse'
+require 'fileutils'
+require 'open3'
+begin
+  require File.expand_path(File.dirname(__FILE__) + '/../nscript')
+rescue LoadError => e
+  puts(e.message)
+  puts("use \"rake build:parser\" to regenerate parser.rb")
+  exit(1)
+end
+
+module NScript
+
+  # The CommandLine handles all of the functionality of the `nscript`
+  # utility.
+  class CommandLine
+
+    BANNER = <<-EOS
+nscript compiles NScript source files into JavaScript.
+
+Usage:
+  nscript path/to/script.ns
+    EOS
+
+    # Seconds to pause between checks for changed source files.
+    WATCH_INTERVAL = 0.5
+
+    # Path to the root of the NScript install.
+    ROOT = File.expand_path(File.dirname(__FILE__) + '/../..')
+
+    # Commands to execute NScripts.
+    RUNNERS = {
+      :node     => "node #{ROOT}/lib/nscript/runner.js",
+      :narwhal  => "narwhal -p #{ROOT} -e 'require(\"nscript\").run(system.args);'"
+    }
+
+    # Run the CommandLine off the contents of ARGV.
+    def initialize
+      @mtimes = {}
+      parse_options
+      return launch_repl if @options[:interactive]
+      return eval_scriptlet if @options[:eval]
+      check_sources
+      return run_scripts if @options[:run]
+      @sources.each {|source| compile_javascript(source) }
+      watch_nscript_scripts if @options[:watch]
+    end
+
+    # The "--help" usage message.
+    def usage
+      puts "\n#{@option_parser}\n"
+      exit
+    end
+
+
+    private
+
+    # Compiles (or partially compiles) the source NScript file, returning
+    # the desired JS, tokens, or lint results.
+    def compile_javascript(source)
+      script = File.read(source)
+      return tokens(script) if @options[:tokens]
+      js = compile(script, source)
+      return unless js
+      return puts(js) if @options[:print]
+      return lint(js) if @options[:lint]
+      File.open(path_for(source), 'w+') {|f| f.write(js) }
+    end
+
+    # Spins up a watcher thread to keep track of the modification times of the
+    # source files, recompiling them whenever they're saved.
+    def watch_nscript_scripts
+      watch_thread = Thread.start do
+        loop do
+          @sources.each do |source|
+            mtime = File.stat(source).mtime
+            @mtimes[source] ||= mtime
+            if mtime > @mtimes[source]
+              @mtimes[source] = mtime
+              compile_javascript(source)
+            end
+          end
+          sleep WATCH_INTERVAL
+        end
+      end
+      Signal.trap("INT") { watch_thread.kill }
+      watch_thread.join
+    end
+
+    # Ensure that all of the source files exist.
+    def check_sources
+      usage if @sources.empty?
+      missing = @sources.detect {|s| !File.exists?(s) }
+      if missing
+        STDERR.puts("File not found: '#{missing}'")
+        exit(1)
+      end
+    end
+
+    # Pipe compiled JS through JSLint (requires a working 'jsl' command).
+    def lint(js)
+      stdin, stdout, stderr = Open3.popen3('jsl -nologo -stdin')
+      stdin.write(js)
+      stdin.close
+      puts stdout.read.tr("\n", '')
+      errs = stderr.read.chomp
+      puts errs unless errs.empty?
+      stdout.close and stderr.close
+    end
+
+    # Eval a little piece of NScript directly from the command line.
+    def eval_scriptlet
+      script = STDIN.tty? ? @sources.join(' ') : STDIN.read
+      return tokens(script) if @options[:tokens]
+      js = compile(script)
+      return lint(js) if @options[:lint]
+      puts js
+    end
+
+    # Use Node.js or Narwhal to run an interactive NScript session.
+    def launch_repl
+      exec "#{RUNNERS[@options[:runner]]}"
+    rescue Errno::ENOENT
+      puts "Error: #{@options[:runner]} must be installed to use the interactive REPL."
+      exit(1)
+    end
+
+    # Use Node.js or Narwhal to compile and execute NScripts.
+    def run_scripts
+      sources = @sources.join(' ')
+      exec "#{RUNNERS[@options[:runner]]} #{sources}"
+    rescue Errno::ENOENT
+      puts "Error: #{@options[:runner]} must be installed in order to execute scripts."
+      exit(1)
+    end
+
+    # Print the tokens that the lexer generates from a source script.
+    def tokens(script)
+      puts Lexer.new.tokenize(script).inspect
+    end
+
+    # Compile a single source file to JavaScript.
+    def compile(script, source='error')
+      begin
+        options = {}
+        options[:no_wrap] = true if @options[:no_wrap]
+        options[:globals] = true if @options[:globals]
+        NScript.compile(script, options)
+      rescue NScript::ParseError => e
+        STDERR.puts "#{source}: #{e.message}"
+        exit(1) unless @options[:watch]
+        nil
+      end
+    end
+
+    # Write out JavaScript alongside NScript unless an output directory
+    # is specified.
+    def path_for(source)
+      filename = File.basename(source, File.extname(source)) + '.js'
+      dir      = @options[:output] || File.dirname(source)
+      File.join(dir, filename)
+    end
+
+    # Install the NScript TextMate bundle to ~/Library.
+    def install_bundle
+      bundle_dir = File.expand_path('~/Library/Application Support/TextMate/Bundles/')
+      FileUtils.cp_r("#{ROOT}/extras/NScript.tmbundle", bundle_dir)
+    end
+
+    # Use OptionParser for all the options.
+    def parse_options
+      @options = {:runner => :node}
+      @option_parser = OptionParser.new do |opts|
+        opts.on('-i', '--interactive', 'run an interactive NScript REPL') do |i|
+          @options[:interactive] = true
+        end
+        opts.on('-r', '--run', 'compile and run a NScript') do |r|
+          @options[:run] = true
+        end
+        opts.on('-o', '--output [DIR]', 'set the directory for compiled JavaScript') do |d|
+          @options[:output] = d
+          FileUtils.mkdir_p(d) unless File.exists?(d)
+        end
+        opts.on('-w', '--watch', 'watch scripts for changes, and recompile') do |w|
+          @options[:watch] = true
+        end
+        opts.on('-p', '--print', 'print the compiled JavaScript to stdout') do |d|
+          @options[:print] = true
+        end
+        opts.on('-l', '--lint', 'pipe the compiled JavaScript through JSLint') do |l|
+          @options[:lint] = true
+        end
+        opts.on('-e', '--eval', 'compile a cli scriptlet or read from stdin') do |e|
+          @options[:eval] = true
+        end
+        opts.on('-t', '--tokens', 'print the tokens that the lexer produces') do |t|
+          @options[:tokens] = true
+        end
+        opts.on('-v', '--verbose', 'print at every step of code generation') do |v|
+          ENV['VERBOSE'] = 'true'
+        end
+        opts.on('-n', '--no-wrap', 'raw output, no function safety wrapper') do |n|
+          @options[:no_wrap] = true
+        end
+        opts.on('-g', '--globals', 'attach all top-level variable as globals') do |n|
+          @options[:globals] = true
+        end
+        opts.on_tail('--narwhal', 'use Narwhal instead of Node.js') do |n|
+          @options[:runner] = :narwhal
+        end
+        opts.on_tail('--install-bundle', 'install the NScript TextMate bundle') do |i|
+          install_bundle
+          exit
+        end
+        opts.on_tail('--version', 'display NScript version') do
+          puts "NScript version #{NScript::VERSION}"
+          exit
+        end
+        opts.on_tail('-h', '--help', 'display this help message') do
+          usage
+        end
+      end
+      @option_parser.banner = BANNER
+      begin
+        @option_parser.parse!(ARGV)
+      rescue OptionParser::InvalidOption => e
+        puts e.message
+        exit(1)
+      end
+      @sources = ARGV
+    end
+
+  end
+
+end