elm-compiler 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c3b619b99ad5ff48857c4062bcdea5627896d82
-  data.tar.gz: 02a695886391374ca47cb378f31c99a9ea668565
+  metadata.gz: a22cb64058f5d0317d5eca7e70d53e0eb05819a8
+  data.tar.gz: 66bf2ee4d3349832e6ec155fdbf2fdcf227617b5
 SHA512:
-  metadata.gz: 84fdab3fc8742cad7bef8e73551c512a6a3e577081f1b7bc3c63772ee8afbdd83b0139b2308e924aad96f775bfe2aece41bb30d81f862e5c179ebafcd3b15583
-  data.tar.gz: a5aa22da7f87a4b50eec7ab5d979ed5c4aba7435bd1c0c62b7d036b178eb9df039e5e2efc105fc806dfa4c8a5e1c32adac884fb87f37cf1f93334366d0e2a501
+  metadata.gz: 6cc9ae96a797f4249b066e5bd6976b823ac7129efd18fc884791b5948541d0e60c09cc6715d56cdf1675f656dcb2d2b0adc62f474ffe73a6c3b07bb14431439c
+  data.tar.gz: 07fbb644d45b8571da8202db901ff309d2abc514edafea7c25ba67e3aebc45dfbbae1282539aa31ee9ce9aeaf6f0b66897cc3341e23e7160ae310cfe6c4d71ee

data/.gitignore

@@ -8,6 +8,5 @@
 /spec/reports/
 /tmp/
 /elm-stuff/
-/elm-package.json
 /elm.js
-*.gem
+*.gem

data/.travis.yml

@@ -3,8 +3,9 @@ cache: bundler
 rvm:
   - 2.2.3
 sudo: false
-before_install: gem install bundler -v 1.11.2
+before_install:
+  - gem install bundler -v 1.11.2
 install:
-  - npm install elm
   - bundle install
+  - npm install -g elm@0.17
   - elm-package install --yes

data/README.md

@@ -1,13 +1,17 @@
-# Elm::Compiler
+# elm-compiler
 
 [![Build Status](https://travis-ci.org/fbonetti/ruby-elm-compiler.svg?branch=master)](https://travis-ci.org/fbonetti/ruby-elm-compiler)
 
-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/elm/compiler`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby wrapper for the [Elm language compiler](https://github.com/elm-lang/elm-compiler).
 
-TODO: Delete this and the text above, and describe your gem
+The project is heavily inspired by the [sprockets-elm](https://github.com/NoRedInk/sprockets-elm/blob/0752748904edee0c25f2dd49cc39186c2ef61b08/lib/elm_compiler.rb) repository, written by [rtfeldman](https://github.com/rtfeldman).
 
 ## Installation
 
+Install the Elm platform:
+
+http://elm-lang.org/install
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -24,20 +28,49 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+> NOTE: Make sure [Elm](http://elm-lang.org/install) is installed. If the `elm-make` executable can't be found in the current `PATH` or via the `elm_make_path` option, the exception `Elm::Compiler::ExecutableNotFound` will be thrown.
+
+```ruby
+Elm::Compiler.compile(elm_files, output_path: nil, elm_make_path: nil)
+```
+
+* `elm_files`: Accepts a single file path or an array of file paths.
+* `output_path`: Path to the output file. If left blank, the compiled Javascript will be returned as a string.
+* `elm_make_path`: Path to the `elm-make` executable. If left blank, the executable will be looked up in the current `PATH`.
 
-## 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).
+## Examples
+
+Compile to string of Javascript:
+
+```ruby
+Elm::Compiler.compile("Clock.elm")
+```
+
+Compile multiple files to a string of Javascript:
+
+```ruby
+Elm::Compiler.compile(["Clock.elm", "Counter.elm"])
+```
+
+Compile to file:
+
+```ruby
+Elm::Compiler.compile("Clock.elm", output_path: "elm.js")
+```
+
+Compile multiple files to file:
+
+```ruby
+Elm::Compiler.compile(["Clock.elm", "Counter.elm"], output_path: "elm.js")
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/elm-compiler.
+Bug reports and pull requests are welcome on GitHub at https://github.com/fbonetti/elm-compiler.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/elm-package.json

@@ -0,0 +1,15 @@
+{
+    "version": "1.0.0",
+    "summary": "elm-package.json for rspec test suite",
+    "repository": "https://github.com/user/project.git",
+    "license": "BSD3",
+    "source-directories": [
+        "."
+    ],
+    "exposed-modules": [],
+    "dependencies": {
+        "elm-lang/core": "4.0.0 <= v < 5.0.0",
+        "elm-lang/html": "1.0.0 <= v < 2.0.0"
+    },
+    "elm-version": "0.17.0 <= v < 0.18.0"
+}

data/lib/elm/compiler.rb

@@ -6,35 +6,32 @@ require 'mkmf'
 module Elm
   class Compiler
     class << self
-      def compile(elm_files, output_path = nil)
-        fail ExecutableNotFound unless elm_executable_exists?
+      def compile(elm_files, output_path: nil, elm_make_path: nil)
+        elm_executable = elm_make_path || find_executable0("elm-make")
+        fail ExecutableNotFound unless elm_executable_exists?(elm_executable)
 
         if output_path
-          elm_make(elm_files, output_path)
+          elm_make(elm_executable, elm_files, output_path)
         else
-          compile_to_string(elm_files)
+          compile_to_string(elm_executable, elm_files)
         end
       end
 
       private
 
-      def elm_executable_exists?
-        !find_executable0('elm-make').nil?
+      def elm_executable_exists?(elm_executable)
+        File.executable?(elm_executable)
       end
 
-      def compile_to_string(elm_files)
-        output = ''
-
+      def compile_to_string(elm_executable, elm_files)
         Tempfile.open(['elm', '.js']) do |tempfile|
-          elm_make(elm_files, tempfile.path)
-          output = File.read tempfile.path
+          elm_make(elm_executable, elm_files, tempfile.path)
+          return File.read tempfile.path
         end
-
-        output
       end
 
-      def elm_make(elm_files, output_path)
-        Open3.popen3('elm-make', *elm_files, '--yes', '--output', output_path) do |_stdin, _stdout, stderr, wait_thr|
+      def elm_make(elm_executable, elm_files, output_path)
+        Open3.popen3({"LANG" => "en_US.UTF8" }, elm_executable, *elm_files, '--yes', '--output', output_path) do |_stdin, _stdout, stderr, wait_thr|
           fail CompileError, stderr.gets(nil) if wait_thr.value.exitstatus != 0
         end
       end

data/lib/elm/compiler/version.rb

@@ -1,5 +1,5 @@
 module Elm
   class Compiler
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elm-compiler
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Frank Bonetti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-26 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,7 @@ files:
 - bin/rubocop
 - bin/setup
 - elm-compiler.gemspec
+- elm-package.json
 - lib/elm-compiler.rb
 - lib/elm/compiler.rb
 - lib/elm/compiler/exceptions.rb