ijs-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78b4a993a974212cdf99c5cc8bcd4a43523b01fcc9a8095a4587cdef34f9d134
+  data.tar.gz: c4901a93c48ebb118f6880335b9a976e50736f745fe541759f3303f086fee802
+SHA512:
+  metadata.gz: 6ab97488d8ecb9a9f6424383f4370a9300dbfb2e405094cd16c7a529a4ad3c8b2bb7c368e2d3eec57d2f6f5697beb2f5a62fea427301e6d550f6957ee32a1695
+  data.tar.gz: c71f8301f4ab085f0c2590acba06052a3d390b1339f4e3b25a268d875216ffa3e782f01e8f4fbb301dbef77c57a87b9ef9794fb0427a9e5bcd205fc98c393742

data/.gitignore

@@ -0,0 +1,46 @@
+##
+# OS Files
+##
+
+.DS_Store
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+##
+# Databases
+##
+
+*.sqlite
+
+##
+# Logs
+##
+
+*.log
+
+##
+# Packages
+##
+
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+##
+# Ruby Files
+##
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/pkg/
+/spec/internal/log/
+/spec/internal/tmp/
+/tmp/
+/travis/gemfiles/*.gemfile.lock

data/.rbenv-gemsets

@@ -0,0 +1 @@
+ijs-rails

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require rails_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'lib/ijs-rails.rb'
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.6.5
+gemfile:
+  - travis/gemfiles/6.0.gemfile
+before_install:
+  - gem update --system
+  - gem install bundler
+env:
+  global:
+    - RSPEC_DEFAULT_FORMATTER=doc

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,169 @@
+PATH
+  remote: .
+  specs:
+    ijs-rails (0.1.0)
+      activerecord (>= 3.0.0)
+      activesupport (>= 3.0.0)
+      uglifier (>= 2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.2.1)
+      activesupport (= 6.0.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activerecord (6.0.2.1)
+      activemodel (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ast (2.4.0)
+    builder (3.2.4)
+    coderay (1.1.2)
+    combustion (1.1.2)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    execjs (2.7.0)
+    ffi (1.12.2)
+    formatador (0.2.5)
+    guard (2.16.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.2.4)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nenv (0.3.0)
+    nokogiri (1.10.8)
+      mini_portile2 (~> 2.4.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-html-matchers (0.9.2)
+      nokogiri (~> 1)
+      rspec (>= 3.0.0.a, < 4)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    uglifier (4.2.0)
+      execjs (>= 0.3.0, < 3)
+    unicode-display_width (1.6.1)
+    yard (0.9.24)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  combustion (~> 1.1)
+  guard-rspec (~> 4.7)
+  ijs-rails!
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rspec-html-matchers (~> 0.9.2)
+  rspec-rails (~> 3.9)
+  rubocop (~> 0.80.0)
+  yard (~> 0.9.24)
+
+BUNDLED WITH
+   2.1.4

data/Guardfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Nialto Services
+
+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,41 @@
+# Inline JS for Rails
+
+[![Build Status](https://travis-ci.org/NialtoServices/ijs-rails.svg?branch=master)](https://travis-ci.org/NialtoServices/ijs-rails)
+
+Inline JS can be used to include JavaScript files in your views in a minified format.
+
+## Installation
+
+You can install **Inline JS for Rails** using the following command:
+
+  $ gem install ijs-rails
+
+Or, by adding the following to your `Gemfile`:
+
+```ruby
+gem 'ijs-rails', '~> 0.1'
+```
+
+### Usage
+
+Let's start with an example script *hello.js* which should be saved in the *app/javascript/inline* directory.
+
+```js
+//
+// Example Script
+//
+
+alert('Hello, World!');
+```
+
+Next in a view, use the *render_ijs* method to render a *<script>* tag containing the minified script:
+
+```ruby
+<%= render_ijs 'hello' %>
+```
+
+## Development
+
+After checking out the repo, run `bundle exec rake spec` to run the tests.
+
+To install this gem onto your machine, run `bundle exec rake install`.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/ijs-rails.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'ijs-rails/constants'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ijs-rails'
+  spec.version       = IJSRails::VERSION
+  spec.authors       = ['Nialto Services']
+  spec.email         = ['support@nialtoservices.co.uk']
+
+  spec.summary       = 'Inline JavaScript helper for Ruby on Rails.'
+  spec.homepage      = 'https://github.com/nialtoservices/ijs-rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.metadata['yard.run'] = 'yri'
+
+  spec.add_runtime_dependency 'activerecord',  '>= 3.0.0'
+  spec.add_runtime_dependency 'activesupport', '>= 3.0.0'
+  spec.add_runtime_dependency 'uglifier',      '>= 2.3'
+
+  spec.add_development_dependency 'bundler',             '~> 2.1'
+  spec.add_development_dependency 'combustion',          '~> 1.1'
+  spec.add_development_dependency 'guard-rspec',         '~> 4.7'
+  spec.add_development_dependency 'rake',                '~> 13.0'
+  spec.add_development_dependency 'rspec',               '~> 3.9'
+  spec.add_development_dependency 'rspec-html-matchers', '~> 0.9.2'
+  spec.add_development_dependency 'rspec-rails',         '~> 3.9'
+  spec.add_development_dependency 'rubocop',             '~> 0.80.0'
+  spec.add_development_dependency 'yard',                '~> 0.9.24'
+end

data/lib/ijs-rails.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'uglifier'
+require 'zlib'
+
+require 'ijs-rails/constants'
+require 'ijs-rails/errors/base'
+require 'ijs-rails/errors/script_not_found'
+require 'ijs-rails/action_view_helpers'
+require 'ijs-rails/script'
+require 'ijs-rails/railtie'

data/lib/ijs-rails/action_view_helpers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module IJSRails
+  # Helper methods to include into action view.
+  #
+  module ActionViewHelpers
+    extend ActiveSupport::Concern
+
+    # Render an HTML <script> tag containing the compiled script.
+    #
+    # @param  script  [String] The name of the inline script to render.
+    # @param  options [Hash]   The options to pass to the compiler.
+    # @return         [String] An HTML <script> tag containing the compiled script.
+    #
+    def render_ijs(script, options = {})
+      type = options.delete(:type)
+      compiled_script = IJSRails::Script.new(script, options).compiled.html_safe
+      content_tag(:script, compiled_script, type: type)
+    end
+  end
+end

data/lib/ijs-rails/constants.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module IJSRails
+  # @return [String] The gem's semantic version number.
+  #
+  VERSION = '0.1.0'
+end

data/lib/ijs-rails/errors/base.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module IJSRails
+  # The standard error used as the base class for custom errors implemented by the 'ijs-rails' gem.
+  #
+  class BaseError < StandardError; end
+end

data/lib/ijs-rails/errors/script_not_found.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module IJSRails
+  # Raised when attempting to use an inline script that can't be found.
+  #
+  class ScriptNotFound < BaseError
+    # @return [String] The name of the script.
+    #
+    attr_reader :script
+
+    # Create a new instance of this error.
+    #
+    # @param script [String] The name of the script.
+    #
+    def initialize(script)
+      @script = script
+    end
+
+    # @return [String] The error message.
+    #
+    def to_s
+      "The inline script '#{script}' could not be found."
+    end
+  end
+end

data/lib/ijs-rails/railtie.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+raise 'ijs-rails is an extension for Rails.' unless defined?(Rails::Railtie)
+
+module IJSRails
+  # The railtie which ties the gem into the Rails system.
+  #
+  class Railtie < Rails::Railtie
+    initializer 'inline_js.set_configs' do |app|
+      app.configure do
+        config.inline_js = ActiveSupport::OrderedOptions.new
+        config.inline_js.path = Rails.root.join('app/javascript/inline')
+        config.inline_js.cache_path = Rails.root.join('tmp/ijs')
+        config.inline_js.isolate_scripts = true
+      end
+    end
+
+    initializer 'inline_js.action_view_helpers' do
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Base.include(IJSRails::ActionViewHelpers)
+      end
+    end
+  end
+end

data/lib/ijs-rails/script.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module IJSRails
+  # Represents an inline script stored in the inline scripts directory.
+  #
+  class Script
+    # @return [String] The name of a script within the inline scripts directory.
+    #
+    attr_reader :script
+
+    # @return [Hash] The options to use when compiling the script.
+    #
+    attr_reader :options
+
+    # Create a new `Script` instance.
+    #
+    # @param script  [String] The name of a script within the inline scripts directory.
+    # @param options [Hash]   The options to use when compiling the script.
+    #
+    def initialize(script, options = {})
+      @script = script
+      @options = options
+
+      raise IJSRails::ScriptNotFound, script unless File.file?(file_path)
+    end
+
+    # @return [String] The path to the script file.
+    #
+    def file_path
+      @file_path ||= File.join(Rails.application.config.inline_js.path, "#{script}.js")
+    end
+
+    # @return [String] The fingerprint representing the script and current options.
+    #
+    def fingerprint
+      @fingerprint ||= Zlib.crc32(options.to_json + File.read(file_path)).to_s
+    end
+
+    # @return [String] The path to the compiled script in the cache directory.
+    #
+    def cache_file_path
+      @cache_file_path ||= File.join(Rails.application.config.inline_js.cache_path, "#{script}-#{fingerprint}.min.js")
+    end
+
+    # @return [Boolean] `true` when the cache contains a copy of the compiled script, `false` otherwise.
+    #
+    def cached?
+      File.file?(cache_file_path)
+    end
+
+    # @return [Boolean] `true` when the script should be wrapped isolated in an anonymous function, `false` otherwise.
+    #
+    def isolate?
+      if options.key?(:isolate)
+        options[:isolate]
+      else
+        Rails.application.config.inline_js.isolate_scripts
+      end
+    end
+
+    # Compile the script and cache it for reuse.
+    #
+    # @return [String] The contents of the compiled script.
+    #
+    def compile!
+      # Compile the script.
+      script = File.read(file_path)
+      script = "!function(){\n#{script}\n}();" if isolate?
+      script = Uglifier.compile(script, options.except(:isolate))
+
+      # Create the cache directory for the script (unless it already exists).
+      cache_directory_path = File.dirname(cache_file_path)
+      FileUtils.mkdir_p(cache_directory_path) unless File.directory?(cache_directory_path)
+
+      # Write the script to the determined cache file path.
+      File.write(cache_file_path, script)
+
+      script
+    end
+
+    # Retrieve the compiled script either from the cache or by compiling it.
+    #
+    # @return [String] The contents of the compiled script.
+    #
+    def compiled
+      return File.read(cache_file_path) if cached?
+
+      compile!
+    end
+  end
+end

data/spec/ijs-rails/action_view_helpers_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+RSpec.describe IJSRails::ActionViewHelpers do
+  subject(:view) { ActionController::Base.new.view_context }
+
+  describe '#render_ijs' do
+    let(:name) { 'demo/hello' }
+
+    subject { view.render_ijs(name) }
+
+    it 'returns an HTML <script> tag containing the script' do
+      expect(subject).to have_tag(:script, text: 'alert("Hello, World!");')
+    end
+
+    context 'when :type is provided' do
+      let(:type) { 'application/type' }
+
+      subject { view.render_ijs(name, type: type) }
+
+      it 'sets the :type attribute on the <script> element' do
+        expect(subject).to have_tag(:script, with: { type: type })
+      end
+    end
+  end
+end

data/spec/ijs-rails/constants_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.describe IJSRails do
+  describe '::VERSION' do
+    subject { described_class::VERSION }
+
+    it 'is semantic' do
+      expect(subject).to match(/[0-9]+\.[0-9]+\.[0-9]+/)
+    end
+  end
+end

data/spec/ijs-rails/script_spec.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+RSpec.describe IJSRails::Script do
+  def rails_path(*options)
+    Rails.root.join(*options).to_s
+  end
+
+  def add_cache_file(data = '')
+    FileUtils.mkdir_p(File.dirname(cache_file_path))
+    File.write(cache_file_path, data)
+  end
+
+  def read_cache_file
+    File.read(cache_file_path)
+  end
+
+  def remove_cache_file
+    FileUtils.rm_f(cache_file_path)
+  end
+
+  after { remove_cache_file }
+
+  let(:name)            { 'demo/hello' }
+  let(:fingerprint)     { '453138908' }
+  let(:file_name)       { "#{name}.js" }
+  let(:file_path)       { rails_path('app/javascript/inline', file_name) }
+  let(:cache_file_name) { "#{name}-#{fingerprint}.min.js" }
+  let(:cache_file_path) { rails_path('tmp/ijs', cache_file_name) }
+  let(:options) do
+    {}
+  end
+
+  subject(:script) { described_class.new(name, options) }
+
+  it { is_expected.to respond_to(:script) }
+  it { is_expected.to respond_to(:options) }
+
+  describe '#file_path' do
+    subject { script.file_path }
+
+    it 'returns the correct path' do
+      expect(subject).to eq(file_path)
+    end
+
+    it 'uses the path from the Rails configuration' do
+      expect(Rails.application.config.inline_js).to receive(:path).and_return(rails_path('app/ijs'))
+      expect(subject).to eq(rails_path('app/ijs', file_name))
+    end
+  end
+
+  describe '#fingerprint' do
+    subject { script.fingerprint }
+
+    it 'computes the correct fingerprint' do
+      expect(subject).to eq(fingerprint)
+    end
+  end
+
+  describe '#cache_file_path' do
+    subject { script.cache_file_path }
+
+    it 'returns the correct path' do
+      expect(subject).to eq(cache_file_path)
+    end
+
+    it 'uses the path from the Rails configuration' do
+      expect(Rails.application.config.inline_js).to receive(:cache_path).and_return(rails_path('tmp/cache/ijs'))
+      expect(subject).to eq(rails_path('tmp/cache/ijs', cache_file_name))
+    end
+  end
+
+  describe '#cached?' do
+    subject { script.cached? }
+
+    context 'when not cached' do
+      it { is_expected.to eq(false) }
+    end
+
+    context 'when cached' do
+      before { add_cache_file }
+
+      it { is_expected.to eq(true) }
+    end
+  end
+
+  describe '#isolate?' do
+    subject { script.isolate? }
+
+    context 'with defaults' do
+      it { is_expected.to eq(true) }
+    end
+
+    context 'when #options[:isolate] is true' do
+      let(:options) do
+        { isolate: true }
+      end
+
+      it { is_expected.to eq(true) }
+    end
+
+    context 'when #options[:isolate] is false' do
+      let(:options) do
+        { isolate: false }
+      end
+
+      it { is_expected.to eq(false) }
+    end
+  end
+
+  describe '#compile!' do
+    let(:result) { 'alert("Hello, World!");' }
+
+    subject { script.compile! }
+
+    it 'returns the compiled script' do
+      expect(subject).to eq(result)
+    end
+
+    it 'caches the compiled script' do
+      subject
+      expect(read_cache_file).to eq(result)
+    end
+  end
+
+  describe '#compiled' do
+    subject { script.compiled }
+
+    context 'when cached' do
+      before { add_cache_file '// JS' }
+
+      it 'returns the contents of the cached file' do
+        expect(subject).to eq('// JS')
+      end
+    end
+
+    context 'when not cached' do
+      it 'compiles the script' do
+        expect(script).to receive(:compile!)
+        subject
+      end
+    end
+  end
+end

data/spec/internal/app/ijs/demo/hello.js

@@ -0,0 +1,5 @@
+//
+// This is a sample JavaScript file to say hello!
+//
+
+alert('Hello, World!');

data/spec/internal/app/javascript/inline/demo/hello.js

@@ -0,0 +1,5 @@
+//
+// This is a sample JavaScript file to say hello!
+//
+
+alert('Hello, World!');

data/spec/rails_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'bundler'
+require 'combustion'
+
+Bundler.require :default, :test
+Combustion.initialize! :action_controller, :action_view
+
+# Prevent database truncation if the environment is production.
+abort 'The Rails environment is running in production mode!' if Rails.env.production?
+
+require 'rspec/rails'
+require 'spec_helper'
+
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in spec/support/ and its subdirectories.
+# Files matching `spec/**/*_spec.rb` are run as spec files by default.
+# This means that files in spec/support that end in _spec.rb will both be required and run as specs, causing the specs
+# to be run twice.
+# It is recommended that you do not name files matching this glob to end with _spec.rb.
+# You can configure this pattern with the --pattern option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes.
+# It has the downside of increasing the boot-up time by auto-requiring all files in the support directory.
+# Alternatively, in the individual `*_spec.rb` files, manually require only the support files necessary.
+#
+Dir[Rails.root.join('../support/**/*.rb')].sort.each { |f| require f }

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Conventionally, all specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+#
+# The generated `.rspec` file contains `--require spec_helper` which will cause this file to always be loaded, without
+# a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as light-weight as possible.
+# Requiring heavyweight dependencies from this file will add to the boot time of your test suite on EVERY test run,
+# even for an individual file that may not need all of that loaded.
+# Instead, consider making a separate helper file that requires the additional dependencies and performs the additional
+# setup, and require it from the spec files that actually need it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate assertion/expectation library such as wrong or the
+  # stdlib/minitest assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4.
+    # It makes the `description` and `failure_message` of custom matchers include text for helper methods defined using
+    # `chain`, e.g.:
+    #   be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here.
+  # You can use an alternate test double library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on a real object.
+    # This is generally recommended, and will default to `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will have no way to turn it off -- the option
+  # exists only for backwards compatibility in RSpec 3).
+  # It causes shared context metadata to be inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # This allows you to limit a spec run to individual examples or groups you care about by tagging them with `:focus`
+  # metadata.
+  # When nothing is tagged with `:focus`, all examples get run.
+  # RSpec also provides aliases for `it`, `describe`, and `context` that include `:focus` metadata: `fit`, `fdescribe`
+  # and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support the `--only-failures` and `--next-failure` CLI
+  # options.
+  # We recommend you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'tmp/rspec_history.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual file, and it's useful to allow more verbose
+  # output when running an individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output, unless a formatter has already been configured (e.g. via a
+    # command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an order dependency and want to debug it, you
+  # can fix the order by providing the seed, which is printed after each run.
+  #   --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce test failures related to randomization by
+  # passing the same `--seed` value as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/html-matchers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rspec-html-matchers'
+
+RSpec.configure do |config|
+  config.include RSpecHtmlMatchers
+end

data/travis/gemfiles/6.0.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec path: '../../'
+
+gem 'activerecord',  '~> 6.0.0'
+gem 'activesupport', '~> 6.0.0'

metadata

@@ -0,0 +1,250 @@
+--- !ruby/object:Gem::Specification
+name: ijs-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nialto Services
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
+description: 
+email:
+- support@nialtoservices.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rbenv-gemsets"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- config.ru
+- ijs-rails.gemspec
+- lib/ijs-rails.rb
+- lib/ijs-rails/action_view_helpers.rb
+- lib/ijs-rails/constants.rb
+- lib/ijs-rails/errors/base.rb
+- lib/ijs-rails/errors/script_not_found.rb
+- lib/ijs-rails/railtie.rb
+- lib/ijs-rails/script.rb
+- spec/ijs-rails/action_view_helpers_spec.rb
+- spec/ijs-rails/constants_spec.rb
+- spec/ijs-rails/script_spec.rb
+- spec/internal/app/ijs/demo/hello.js
+- spec/internal/app/javascript/inline/demo/hello.js
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/support/html-matchers.rb
+- travis/gemfiles/6.0.gemfile
+homepage: https://github.com/nialtoservices/ijs-rails
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Inline JavaScript helper for Ruby on Rails.
+test_files:
+- spec/ijs-rails/action_view_helpers_spec.rb
+- spec/ijs-rails/constants_spec.rb
+- spec/ijs-rails/script_spec.rb
+- spec/internal/app/ijs/demo/hello.js
+- spec/internal/app/javascript/inline/demo/hello.js
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/support/html-matchers.rb