elm_sprockets 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49abca6d8aca123e6830ea8e2e2541c4fee8402b
+  data.tar.gz: 9d6130262e1af7421c974acdde9f91cad4a9ad0a
+SHA512:
+  metadata.gz: 201fea29c7a69cda28fd99b8b8a0348c3071a7a7a1cc6ee527cf743d441f866676c8b86c34bcfbb4ef18370fab739ebd9d93dc8cfce3809266b7b2e58c31af98
+  data.tar.gz: 2faa881049d53bb2a70de2f7e9335e2e1d59f12a8f529faf436e6ff6d1a05aa2fbcb3a090e66fbba23d97fed27b05fbe92c83b10aa9770e70a7257ea5da067ee

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,13 @@
+This works with Rails 3.2
+
+This requires some piping together with npm & elm-make that we haven't quite figured out
+process-with. At the very least, you're going to need to:
+
+- copy the `package.json` from this repo in to your rails repo and call `npm install`
+- create an initializer in `config/initializers/elm_sprockets.rb` with the following contents:
+
+```ruby
+ElmSprockets.initialize(Rails.application)
+```
+
+At some point we'll figure out generators, etc. For now: This is it!

data/Rakefile

@@ -0,0 +1,36 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SprocketsElm'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/elm_sprockets.rb

@@ -0,0 +1,15 @@
+require "elm_sprockets/processor"
+
+module ElmSprockets
+  def self.initialize(app)
+    app.assets.register_engine('.elm', ElmSprockets::Processor)
+    app.assets.register_mime_type('text/x-elm', '.elm')
+
+    app.config.assets.precompile.delete_if do |rule|
+      next unless rule.is_a? Proc
+      # delete the rule that doesn't match cs or js but matches elm
+      ['css', 'js'].none? {|ext| rule.call "butts.#{ext}"} && rule.call('butts.elm')
+    end
+    app.config.assets.precompile << Proc.new{ |path| !File.extname(path).in?(['.js', '.css', '.elm']) }
+  end
+end

data/lib/elm_sprockets/compiler.rb

@@ -0,0 +1,28 @@
+require 'open3'
+
+module ElmSprockets
+  module Compiler
+    def self.compile(pathname, output_file, dir_options = {})
+      @cmd ||= "#{`npm bin`.strip}/elm-make"
+      puts @cmd
+      puts output_file.path
+
+      # need to specify LANG or else build will fail on jenkins
+      # with error "elm-make: elm-stuff/build-artifacts/NoRedInk/NoRedInk/1.0.0/Quiz-QuestionStore.elmo: hGetContents: invalid argument (invalid byte sequence)"
+      Open3.popen3(
+          {'LANG' => 'en_US.UTF-8'},
+          @cmd, pathname.to_s,
+          "--yes", "--output",
+          output_file.path, dir_options) do |_stdin, _stdout, stderr, wait_thr|
+        compiler_err = stderr.gets(nil)
+        stderr.close
+
+        process_status = wait_thr.value
+
+        if process_status.exitstatus != 0
+          fail compiler_err
+        end
+      end
+    end
+  end
+end

data/lib/elm_sprockets/processor.rb

@@ -0,0 +1,61 @@
+require 'elm_sprockets/compiler'
+require 'sprockets'
+require 'tempfile'
+
+module ElmSprockets
+  class Processor < Sprockets::Processor
+    def self.default_mime_type
+      'text/x-elm'
+    end
+
+    def evaluate(context, _locals)
+      pathname = context.pathname.to_s
+
+      if pathname =~ /\.js.*\.elm$/
+        add_elm_dependencies pathname, context
+        tempfile = Tempfile.new ['compiled_elm_output', '.js']
+        begin
+          ElmSprockets::Compiler.compile pathname, tempfile, chdir: Rails.root
+          tempfile.read
+        ensure
+          tempfile.close
+        end
+      else
+        ""
+      end
+    end
+
+    private
+
+    # Add all Elm modules imported in the target file as dependencies, then
+    # recursively do the same for each of those dependent modules.
+    def add_elm_dependencies(filepath, context)
+      # Turn e.g. ~/NoRedInk/app/assets/javascripts/Quiz/QuestionStoreAPI.js.elm
+      # into just ~/NoRedInk/app/assets/javascripts/
+      dirname = context.pathname.to_s.gsub Regexp.new(context.logical_path + ".+$"), ""
+
+      File.read(filepath).each_line do |line|
+        # e.g. `import Quiz.QuestionStore exposing (..)`
+        match = line.match(/^import\s+([^\s]+)/)
+
+        next unless match
+
+        # e.g. Quiz.QuestionStore
+        module_name = match.captures[0]
+
+        # e.g. Quiz/QuestionStore
+        dependency_logical_name = module_name.tr(".", "/")
+
+        # e.g. ~/NoRedInk/app/assets/javascripts/Quiz/QuestionStore.elm
+        dependency_filepath = dirname + dependency_logical_name + ".elm"
+
+        # If we don't find the dependency in our filesystem, assume it's because
+        # it comes in through a third-party package rather than our sources.
+        next unless File.file? dependency_filepath
+
+        context.depend_on dependency_logical_name
+        add_elm_dependencies dependency_filepath, context
+      end
+    end
+  end
+end

data/lib/elm_sprockets/version.rb

@@ -0,0 +1,3 @@
+module ElmSprockets
+  VERSION = "0.0.2"
+end

data/test/compiler_test.rb

@@ -0,0 +1,15 @@
+require_relative '../lib/elm_sprockets/compiler'
+require 'tempfile'
+require 'minitest/autorun'
+
+class ElmCompilerTest < Minitest::Test
+  def test_compile
+    dirname = File.dirname(__FILE__)
+
+    Tempfile.create(["elm",".js"]) do |file|
+      puts file.path
+      ElmSprockets::Compiler.compile "#{dirname}/elm/MainTest.js.elm", file
+      assert_match(/Elm/, file.read)
+    end
+  end
+end

data/test/elm/MainTest.js.elm

@@ -0,0 +1,11 @@
+module MainTest where
+
+import TestDependencyA
+import TestDependencyB exposing (..)
+
+--import InvalidDependency exposing (..)
+
+import Html exposing (..)
+
+main =
+  div [] [text "Hello World!"]

data/test/elm/TestDependencyA.elm

@@ -0,0 +1,4 @@
+module TestDependencyA where
+
+something =
+  "foo"

data/test/elm/TestDependencyB.elm

@@ -0,0 +1,4 @@
+module TestDependencyB where
+
+somethingElse =
+  "bar"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: elm_sprockets
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Richard Feldman
+- Joshua Leven
+- Marica Odagaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.22.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.22.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Compiles Elm Modules to Sprockets-friendly JavaScript
+email:
+- richard@noredink.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/elm_sprockets.rb
+- lib/elm_sprockets/compiler.rb
+- lib/elm_sprockets/processor.rb
+- lib/elm_sprockets/version.rb
+- test/compiler_test.rb
+- test/elm/MainTest.js.elm
+- test/elm/TestDependencyA.elm
+- test/elm/TestDependencyB.elm
+homepage: https://github.com/noredink/elm-sprockets
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 4
+summary: Compiles Elm Modules
+test_files:
+- test/compiler_test.rb
+- test/elm/MainTest.js.elm
+- test/elm/TestDependencyA.elm
+- test/elm/TestDependencyB.elm