js-text-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b11dad2c06afa837ca4d482b5d77e3c6984785a8
+  data.tar.gz: ba00a457af07ca514ae2655d8c6bdb72d1bbeb7b
+SHA512:
+  metadata.gz: 91265429b56ebd440e9ad1d4555d8678b4eb37a6e4a220d1cc0bc1a13011328ab7e4faf72be3dbc46639c88f21487b1a105ad4c793fcadb9387c0b9c579fb11f
+  data.tar.gz: 7c60e731f68d7b52c7c55f72ba0a26dbb1e413a4bfa6a7a0d95d35a9ce4884f1b661a37449ea68e387f1745334cb9dd12f459016b40546a95c7910c693eeeed8

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.1
+  - 2.3.3
+  - 2.4.1
+cache: bundler
+gemfile:
+  - sprockets3.gemfile
+  - sprockets4.gemfile
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1 @@
+eval_gemfile "#{ File.dirname(__FILE__) }/sprockets4.gemfile"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Clover Sites
+
+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 @@
+# JsTextRails
+
+Transform text files into strings on a global JavaScript object.
+
+Why do this?  Your Rails application might serve up a single-page web
+application, which requires text assets (like SVGs).  You need these assets to
+render your application, and you don't want to fetch them via AJAX (to avoid
+lag), nor embed them in the returned HTML (to keep the HTML response small).
+
+Especially in the case of SVGs, their contents are needed so they can be
+inserted into the document inline, so they can be styled with CSS.
+
+Support is currently available for the following text file types:
+
+- ".svg" files
+
+If you'd like more, please submit a PR.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'js-text-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install js-text-rails
+
+## Usage
+
+### Ruby on Rails
+
+After adding the gem to your Gemfile, clear your cache:
+
+```sh
+rake tmp:clear
+```
+
+Normally, text file contents are stored in a global object named `TEXT` or `SVG`
+(for ".svg" files).  You may customize the namespace used by all text files by
+setting `config.js_text_rails.namespace`.  e.g., in `app/config/application.rb`:
+
+```ruby
+module App
+  class Application < Rails::Application
+    config.js_text_rails.namespace = 'App.Text'
+  end
+end
+```
+
+Then all text file contents would instead be stored in the global object `App`
+on a property called `Text`.
+
+To disable the gem, just remove transformer:
+
+```ruby
+JsTextRails.uninstall(Rails.application.assets)
+```
+
+### Sprockets
+
+If you use Sinatra or other non-Rails frameworks with Sprockets,
+just connect your Sprockets environment with it:
+
+```ruby
+assets = Sprockets::Environment.new do |env|
+  # Your assets settings
+end
+
+require 'js-text-rails'
+JsTextRails.install(assets, namespace: 'App.Text')
+```
+
+### In your application
+
+`require` your files, e.g. in `app/assets/javascripts/application.js`:
+
+```js
+//= require_tree ../images/icons
+```
+
+Where `app/assets/images/icons` contains the file `envelope.svg`.
+
+Anywhere in your application's JavaScript code, access the text file contents
+via the global `SVG` variable:
+
+```js
+var envelopeIcon = SVG['icons/envelope'];
+// Do something with `envelopeIcon`...
+```
+
+Here is a practical example of inserting an SVG inline:
+
+```js
+document.querySelector('#email-icon').innerHTML = SVG['icons/envelope'];
+```
+
+Or, in a JST template:
+
+```html
+<span id="email-icon"><%- SVG['icons/envelope'] %></span> Email me at <%= @email %>!
+```
+
+## 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/cloversites/js-text-rails.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "js-text-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/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/js-text-rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'js-text-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "js-text-rails"
+  spec.version       = JsTextRails::VERSION
+  spec.authors       = ["Jackson Ray Hamilton"]
+  spec.email         = ["jackson@jacksonrayhamilton.com"]
+
+  spec.summary       = %q{Transform text files into strings on a global JavaScript object.}
+  spec.homepage      = "https://github.com/cloversites/js-text-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.5"
+end

data/lib/js-text-rails.rb

@@ -0,0 +1,24 @@
+# Transform text files into strings on a global JavaScript object.
+module JsTextRails
+  autoload :SvgSprockets, 'js-text-rails/svg_sprockets'
+
+  # Add JsText to Sprockets environment in `assets`.
+  def self.install(assets, params = {})
+    SvgSprockets.register_transformer(svg_transformer(params))
+    SvgSprockets.install(assets)
+  end
+
+  # Disable installed JsText.
+  def self.uninstall(assets)
+    SvgSprockets.uninstall(assets)
+  end
+
+  # Cache transformer instances.
+  def self.svg_transformer(params = {})
+    SvgTransformer.new(params)
+  end
+end
+
+require_relative 'js-text-rails/svg_transformer'
+
+require_relative 'js-text-rails/railtie' if defined?(Rails)

data/lib/js-text-rails/railtie.rb

@@ -0,0 +1,23 @@
+module JsTextRails
+  class Railtie < ::Rails::Railtie
+    config.js_text_rails = ActiveSupport::OrderedOptions.new
+
+    if config.respond_to?(:assets) and not config.assets.nil?
+      config.assets.configure do |env|
+        JsTextRails.install(env, params)
+      end
+    else
+      initializer :setup_js_text, group: :all do |app|
+        if defined? app.assets and not app.assets.nil?
+          JsTextRails.install(app.assets, params)
+        end
+      end
+    end
+
+    def params
+      hash = {}
+      hash[:namespace] = config.js_text_rails.namespace if not config.js_text_rails.namespace.nil?
+      hash
+    end
+  end
+end

data/lib/js-text-rails/svg_sprockets.rb

@@ -0,0 +1,8 @@
+require_relative 'text_sprockets'
+
+module JsTextRails
+  class SvgSprockets < TextSprockets
+    @extension = 'svg'
+    @mime_type = 'image/svg+xml'
+  end
+end

data/lib/js-text-rails/svg_transformer.rb

@@ -0,0 +1,21 @@
+require_relative 'text_transformer'
+
+module JsTextRails
+  class SvgTransformer < TextTransformer
+    def self.default_namespace
+      'this.SVG'
+    end
+
+    def sanitize_js_string(text)
+      text = strip_xml_declaration(text)
+      text = escape_js_string(text)
+      text
+    end
+
+    # Strips <?xml ...?> declarations so that external SVG and XML documents can
+    # be added to a document without worry.
+    def strip_xml_declaration(text)
+      text.gsub(/^\s*<\?xml.*?\?>\s*/im, '')
+    end
+  end
+end

data/lib/js-text-rails/text_sprockets.rb

@@ -0,0 +1,34 @@
+module JsTextRails
+  # Register transformer in Sprockets.
+  class TextSprockets
+    def self.register_transformer(transformer)
+      @transformer = transformer
+    end
+
+    # Sprockets 3 and 4 API
+    def self.call(input)
+      name = input[:name]
+      data = input[:data]
+      run(name, data)
+    end
+
+    # Transform `data` into a JS object value at `key`.
+    def self.run(key, data)
+      @transformer.transform(key, data)
+    end
+
+    def self.install(env)
+      # TODO: Is the original extension for the mime type also needed as an
+      # extension?  (Does the array override the old one, or get merged?)
+      env.register_mime_type(@mime_type, extensions: [".#{@extension}"])
+      env.register_transformer(@mime_type, 'application/javascript', self)
+    end
+
+    def self.uninstall(env)
+      # TODO: Is the original extension for the mime type also needed as an
+      # extension?  (What would be the consequences of unregistering?)
+      env.unregister_mime_type(@mime_type, extensions: [".#{@extension}"])
+      env.unregister_transformer(@mime_type, 'application/javascript', self)
+    end
+  end
+end

data/lib/js-text-rails/text_transformer.rb

@@ -0,0 +1,39 @@
+module JsTextRails
+  class TextTransformer
+    def self.default_namespace
+      'this.TEXT'
+    end
+
+    def initialize(options = {})
+      @namespace = options[:namespace] || self.class.default_namespace
+    end
+
+    # Take `data` and store it at a `key` in a JS namespace.
+    def transform(key, data)
+      key = sanitize_js_string(key)
+      data = sanitize_js_string(data)
+      <<-TEXT
+(function() { #{@namespace} || (#{@namespace} = {}); #{@namespace}['#{key}'] = '#{data}';
+}).call(this);
+      TEXT
+    end
+
+    # Can be overridden by subclasses.
+    def sanitize_js_string(text)
+      escape_js_string(text)
+    end
+
+    # Make text content safe and correct when evaluated in JS.
+    def escape_js_string(text)
+      text
+        .gsub(/(['\\])/, "\\\\\\1")
+        .gsub(/[\f]/, '\f')
+        .gsub(/[\b]/, '\b')
+        .gsub(/[\n]/, '\n')
+        .gsub(/[\t]/, '\t')
+        .gsub(/[\r]/, '\r')
+        .gsub(/[\u2028]/, '\u2028')
+        .gsub(/[\u2029]/, '\u2029')
+    end
+  end
+end

data/lib/js-text-rails/version.rb

@@ -0,0 +1,3 @@
+module JsTextRails
+  VERSION = "1.0.0"
+end

data/sprockets3.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails',     '< 5'
+gem 'sprockets', '>= 3.4.0', '< 4.0'
+gem 'sprockets-rails'

data/sprockets4.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rails',     '>= 5.0.0.beta2'
+gem 'sprockets', '>= 4.0.0.beta1'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: js-text-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jackson Ray Hamilton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: 
+email:
+- jackson@jacksonrayhamilton.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- js-text-rails.gemspec
+- lib/js-text-rails.rb
+- lib/js-text-rails/railtie.rb
+- lib/js-text-rails/svg_sprockets.rb
+- lib/js-text-rails/svg_transformer.rb
+- lib/js-text-rails/text_sprockets.rb
+- lib/js-text-rails/text_transformer.rb
+- lib/js-text-rails/version.rb
+- sprockets3.gemfile
+- sprockets4.gemfile
+homepage: https://github.com/cloversites/js-text-rails
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Transform text files into strings on a global JavaScript object.
+test_files: []