From 55cf126f934b975eacbc36dbedc12da64a967758 Mon Sep 17 00:00:00 2001 From: Jason Dew Date: Mon, 25 Apr 2016 19:07:53 -0400 Subject: [PATCH] Initial commit --- .gitignore | 9 +++++++ .rspec | 2 ++ .travis.yml | 4 ++++ CODE_OF_CONDUCT.md | 49 +++++++++++++++++++++++++++++++++++++++ Gemfile | 4 ++++ LICENSE.txt | 21 +++++++++++++++++ README.md | 37 +++++++++++++++++++++++++++++ Rakefile | 6 +++++ bin/console | 14 +++++++++++ bin/setup | 8 +++++++ elm-rails.gemspec | 37 +++++++++++++++++++++++++++++ lib/elm/rails.rb | 8 +++++++ lib/elm/rails/compiler.rb | 44 +++++++++++++++++++++++++++++++++++ lib/elm/rails/railtie.rb | 12 ++++++++++ lib/elm/rails/version.rb | 5 ++++ spec/elm/rails_spec.rb | 11 +++++++++ spec/spec_helper.rb | 2 ++ 17 files changed, 273 insertions(+) create mode 100644 .gitignore create mode 100644 .rspec create mode 100644 .travis.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 Gemfile create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 Rakefile create mode 100755 bin/console create mode 100755 bin/setup create mode 100644 elm-rails.gemspec create mode 100644 lib/elm/rails.rb create mode 100644 lib/elm/rails/compiler.rb create mode 100644 lib/elm/rails/railtie.rb create mode 100644 lib/elm/rails/version.rb create mode 100644 spec/elm/rails_spec.rb create mode 100644 spec/spec_helper.rb diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0cb6eeb --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +/.bundle/ +/.yardoc +/Gemfile.lock +/_yardoc/ +/coverage/ +/doc/ +/pkg/ +/spec/reports/ +/tmp/ diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..8c18f1a --- /dev/null +++ b/.rspec @@ -0,0 +1,2 @@ +--format documentation +--color diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..bed6e27 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,4 @@ +language: ruby +rvm: + - 2.3.0 +before_install: gem install bundler -v 1.11.2 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..a7f2148 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,49 @@ +# Contributor Code of Conduct + +As contributors and maintainers of this project, and in the interest of +fostering an open and welcoming community, we pledge to respect all people who +contribute through reporting issues, posting feature requests, updating +documentation, submitting pull requests or patches, and other activities. + +We are committed to making participation in this project a harassment-free +experience for everyone, regardless of level of experience, gender, gender +identity and expression, sexual orientation, disability, personal appearance, +body size, race, ethnicity, age, religion, or nationality. + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery +* Personal attacks +* Trolling or insulting/derogatory comments +* Public or private harassment +* Publishing other's private information, such as physical or electronic + addresses, without explicit permission +* Other unethical or unprofessional conduct + +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. + +By adopting this Code of Conduct, project maintainers commit themselves to +fairly and consistently applying these principles to every aspect of managing +this project. Project maintainers who do not follow or enforce the Code of +Conduct may be permanently removed from the project team. + +This code of conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting a project maintainer at jason.dew@gmail.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. Maintainers are +obligated to maintain confidentiality with regard to the reporter of an +incident. + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.3.0, available at +[http://contributor-covenant.org/version/1/3/0/][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/3/0/ \ No newline at end of file diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..ecab12c --- /dev/null +++ b/Gemfile @@ -0,0 +1,4 @@ +source 'https://rubygems.org' + +# Specify your gem's dependencies in elm-rails.gemspec +gemspec diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..a888847 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2016 Jason Dew + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..134f261 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Elm on Rails + +This gem adds support for compiling Elm source files via Sprockets. /ht @rtfeldman for the initial version (found [here](https://gist.github.com/rtfeldman/db7b121100b6c6ff435b)) + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'elm-rails' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install elm-rails + +## 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/jasondew/elm-rails. 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](http://opensource.org/licenses/MIT). diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..b7e9ed5 --- /dev/null +++ b/Rakefile @@ -0,0 +1,6 @@ +require "bundler/gem_tasks" +require "rspec/core/rake_task" + +RSpec::Core::RakeTask.new(:spec) + +task :default => :spec diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..3973f5d --- /dev/null +++ b/bin/console @@ -0,0 +1,14 @@ +#!/usr/bin/env ruby + +require "bundler/setup" +require "elm/rails" + +# 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. + +# (If you use this, don't forget to add pry to your Gemfile!) +# require "pry" +# Pry.start + +require "irb" +IRB.start diff --git a/bin/setup b/bin/setup new file mode 100755 index 0000000..dce67d8 --- /dev/null +++ b/bin/setup @@ -0,0 +1,8 @@ +#!/usr/bin/env bash +set -euo pipefail +IFS=$'\n\t' +set -vx + +bundle install + +# Do any other automated setup that you need to do here diff --git a/elm-rails.gemspec b/elm-rails.gemspec new file mode 100644 index 0000000..2fcecde --- /dev/null +++ b/elm-rails.gemspec @@ -0,0 +1,37 @@ +# coding: utf-8 +lib = File.expand_path('../lib', __FILE__) +$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib) +require 'elm/rails/version' + +Gem::Specification.new do |spec| + spec.name = "elm-rails" + spec.version = Elm::Rails::VERSION + spec.authors = ["Jason Dew", "Richard Feldman"] + spec.email = ["jason.dew@gmail.com", "richard.t.feldman@gmail.com"] + + spec.summary = %q{Compile Elm into JavaScript via Sprockets.} + spec.description = %q{Compile Elm into JavaScript via Sprockets.} + spec.homepage = "https://github.com/jasondew/elm-rails" + spec.license = "MIT" + + # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or + # delete this section to allow pushing this gem to any host. + if spec.respond_to?(:metadata) + spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'" + else + raise "RubyGems 2.0 or newer is required to protect against public gem pushes." + end + + spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } + spec.bindir = "exe" + spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) } + spec.require_paths = ["lib"] + + spec.add_dependency "railties", ">= 4.0.0", "< 5.0" + spec.add_dependency "sprockets-rails", "~> 3.0" + spec.add_dependency "sprockets", "~> 3.0" + + spec.add_development_dependency "bundler", "~> 1.11" + spec.add_development_dependency "rake", "~> 10.0" + spec.add_development_dependency "rspec", "~> 3.0" +end diff --git a/lib/elm/rails.rb b/lib/elm/rails.rb new file mode 100644 index 0000000..f7e693d --- /dev/null +++ b/lib/elm/rails.rb @@ -0,0 +1,8 @@ +module Elm + module Rails + end +end + +require "elm/rails/version" +require "elm/rails/compiler" +require "elm/rails/railtie" diff --git a/lib/elm/rails/compiler.rb b/lib/elm/rails/compiler.rb new file mode 100644 index 0000000..c5bdca8 --- /dev/null +++ b/lib/elm/rails/compiler.rb @@ -0,0 +1,44 @@ +require "open3" +require "tempfile" + +module Elm + module Rails + class Compiler + def self.call(input) + new.call input + end + + def call(input) + { data: compile(input[:filename]) } + end + + private + + def compile(input_filename) + input_directory = Pathname.new(input_filename).dirname + output_file = Tempfile.new %w{compiled_elm_output .js} + + begin + output, status = Open3.capture2e( + {"LANG" => "en_US.UTF-8"}, + elm_make, + input_filename, + "--yes", + "--output", output_file.path, + chdir: input_directory + ) + + raise output unless status.success? + + output_file.read + ensure + output_file.unlink + end + end + + def elm_make + `which elm-make`.chomp + end + end + end +end diff --git a/lib/elm/rails/railtie.rb b/lib/elm/rails/railtie.rb new file mode 100644 index 0000000..81fd547 --- /dev/null +++ b/lib/elm/rails/railtie.rb @@ -0,0 +1,12 @@ +require "sprockets/railtie" + +module Elm + module Rails + class Railtie < ::Rails::Railtie + initializer :setup_elm_rails, group: :all do |app| + Sprockets.register_transformer "text/x-elm", "application/javascript", Elm::Rails::Compiler + Sprockets.register_mime_type "text/x-elm", extensions: %w{.elm} + end + end + end +end diff --git a/lib/elm/rails/version.rb b/lib/elm/rails/version.rb new file mode 100644 index 0000000..ac6ee31 --- /dev/null +++ b/lib/elm/rails/version.rb @@ -0,0 +1,5 @@ +module Elm + module Rails + VERSION = "0.1.0" + end +end diff --git a/spec/elm/rails_spec.rb b/spec/elm/rails_spec.rb new file mode 100644 index 0000000..6bd526d --- /dev/null +++ b/spec/elm/rails_spec.rb @@ -0,0 +1,11 @@ +require 'spec_helper' + +describe Elm::Rails do + it 'has a version number' do + expect(Elm::Rails::VERSION).not_to be nil + end + + it 'does something useful' do + expect(false).to eq(true) + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..d0c1f95 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,2 @@ +$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__) +require 'elm/rails'