thermite-rails 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1ae814897593fc1121540933143ab4e453d060e4d48421f19f3fa160f1cddafc
+  data.tar.gz: 601bb63007275900c07f7e449029f8ea06f385b5dd68f11c3309bd3e942897ea
+SHA512:
+  metadata.gz: 7180d1df7f4e4b640e88952762e028ca5587ed522685eb7f8aa5388ce8beeedb3d0936a43f8c77f8e58eed037e9404c8cf5b671b4108b1d0ebb13e1d56021651
+  data.tar.gz: '091be81aeff326fa5812196832c3fb5a90c7a81229da61d5732fdb8e774a63c318bcf6c0f70d47b8618c407c1f4248fd714f86db0830a502fc5c022264703926'

data/.gitignore

@@ -0,0 +1,34 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Rails engine things
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+
+# tags
+.tags
+
+Gemfile.lock
+
+spec/dummy/crates/mkmf.log
+
+# Rust things
+spec/dummy/crates/*/mkmf.log
+spec/dummy/crates/*/target/*
+
+*.so
+
+tags

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,43 @@
+---
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - thermite-rails.gemspec
+    - spec/**/*_spec.rb
+
+Metrics/LineLength:
+  Max: 120
+
+Rails:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%i': '[]'
+    '%w': '[]'
+    '%W': '[]'
+
+Style/SymbolArray:
+  Enabled: true
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - spec/dummy/db/schema.rb
+    - vendor/bundle/**/*
+  TargetRubyVersion: 2.4

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+
+## [0.2.0] - 2018-03-28
+
+### Improvements
+
+* Moved `*Task` classes to `lib/thermite/rails/tasks/`.
+* Added rake task for running `cargo update` for all crates.
+
+## [0.1.0] - 2018-03-27
+
+### Improvements
+
+* Initial release!

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 steve@agrian.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,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+# Dummy apps don't get a Gemfile. Since thermite-rails has code for updating a
+# Gemfile, we should test that that works, thus we need to eval in the dummy
+# app's Gemfile to pick up the crates.
+eval_gemfile 'spec/dummy/Gemfile'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Steve Loveless
+
+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,131 @@
+# thermite-rails
+
+Integrate your Rust+Ruby [thermite](https://github.com/malept/thermite) projects
+into Rails. Like [helix-rails](https://github.com/tildeio/helix-rails), but for
+thermite.
+
+First things first: much of this project was initially "borrowed" from
+[helix](http://usehelix.com/) and `helix-rails`, which are wonderful
+projects for getting Rust and Ruby working together--you should check them out.
+
+Specs |
+------|
+[![Build Status](http://teamcity-build.agrian.com/app/rest/builds/buildType%3Aid%3AGems_ThermiteRails_Specs/statusIcon?guest=1)](http://teamcity-build.agrian.com/viewType.html?buildTypeId=Gems_ThermiteRails_Specs)
+
+## Usage
+
+### Generators
+
+There are two Rails generators that get you doing Rust-y things in your Rails app.
+
+#### `thermite:install`
+
+This does one simple thing: adds a line to `config/environments/development.rb`
+that checks to see if your crates have been updated since the last time you
+built them; if any of them have been updated, you'll get an exception letting
+you know.
+
+```bash
+$ rails generate thermite:install
+```
+
+...adds the following to `config/environments/development.rb`:
+
+```ruby
+config.thermite.outdated_error = :page_load
+```
+
+#### `thermite:crate [crate-name]`
+
+This generates a new Rust+Ruby project for you in `[Rails.root]/crates/[crate-name]`.
+The Rubygem part of the project is created using `bundle gem [crate-name]`; the
+Rust part of the project is created using `crate new [crate-name]`. Most of the
+basic stuff that `thermite` has you do for setting up is done for you.
+
+One main difference from `thermite`'s instructions, however, is that it does
+not set up the same `test` Rake task that `thermite` says to. This is because
+`thermite-rails` defines its own set of tasks for you. You can, of course,
+override those if you need to.
+
+Lastly, it also:
+
+* makes the crate `publish = false` so you don't accidentally publish it to
+  `crates.io`.
+* sets `crate-type = ["cdylib"]`, assuming you'll use something like
+  [ruru](https://github.com/d-unseductable/ruru) +
+  [fiddle](https://github.com/ruby/fiddle) for initializing your Rust+Ruby.
+
+### Rake Tasks
+
+`thermite-rails` defines a task for building, cleaning, updating, and (cargo)
+testing a) all of your projects at once, b) each of your projects separately.
+
+* `thermite:build_all`, `thermite:build:[crate-name]` leverage `thermite`'s
+  `thermite:build` task.
+* `thermite:clean_all`, `thermite:clean:[crate-name]` leverage `thermite`'s
+  `thermite:clean` task.
+* `thermite:test_all`, `thermite:test:[crate-name]` leverage `thermite`'s
+  `thermite:test` task.
+* `thermite:update_all`, `thermite:update:[crate-name]` are only defined in
+  `thermite-rails`. This simply runs `cargo update` for each of your crates.
+
+If you have `rspec` in your stack, you'll also get `spec:crates` and
+`spec:crates:[crate-name]`, where the latter will ensure
+`thermite:build:[crate-name]` is run before (to make sure specs are run against
+the latest Rust code). If you want to run all tests (Rust and Ruby ones) when
+you run `rake spec`, add this to the `Rakefile` in the root of your Rails
+project:
+
+```ruby
+Rake::Task['spec'].enhance do
+  Rake::Task['spec:crates'].invoke
+end
+```
+
+Note that Rake tasks will only be available for crates in `crates/` that use
+`thermite`. You can add Rust-only crates under `crates/` (perhaps you want to
+keep your crates/projects slim and extract out some functionality?) or use
+[helix](http://usehelix.com/) along side `thermite`/`thermite-rails`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thermite-rails'
+```
+
+And then execute:
+
+```bash
+$ bundle
+$ rails generate thermite:install
+```
+
+...then go add some crates/projects to your app:
+
+```bash
+$ rails generate thermite:crate new_fast_thingy
+```
+
+## 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).
+
+
+## Code of Conduct
+
+Everyone interacting in the Thermite::Rails project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://bitbucket.com/agrian/thermite-rails/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+load 'spec/dummy/Rakefile'
+RSpec::Core::RakeTask.new spec: %w[thermite:test_all]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'thermite/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(__FILE__)

data/bin/rails

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/thermite/rails/railtie', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150).match?(/This file was generated by Bundler/)
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150).match?(/This file was generated by Bundler/)
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')