direct_inject 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9e281f54fb9f6b80e88e0341cc921f30ac69114
-  data.tar.gz: bc35d48472e01577272e3af63e25eba9bb30cc7c
+  metadata.gz: dcb2cd60c4f467df942817fbc5f399722edef425
+  data.tar.gz: 1e18df2187f5dc604934fdface110d179acd2c4f
 SHA512:
-  metadata.gz: 30d7c17427ecce6b6a226d4a76d6665c07cc84044ea5329a8b719a822364b57d8a653470e13ceac92b1b63603df82175f6d62f7119fe9a3b82f8b60228c98536
-  data.tar.gz: b93c1a99a8c07585381b69f2d53d1df5908abd49f243a5dee527d46647957e2db47cc7fef8d3d7021c4817e81b73055ae5700a3419982d983131aed8e5afc933
+  metadata.gz: edbe0119bdfda86cd0e14d76d0f20650606cab17911a1fc9aa0127bc130140e349dd5be557ba834636ef6438f3167133de0cb4316b4c5d48f352b47a0e190c0b
+  data.tar.gz: f89eeed4b1cbb26fac0c703ea1846c7e794fb7395eb329d8934f15a4ec435ad93a07bfaa7351a2fd830e9d9e5d2617ec779a92a6ee5f16e3337d54141bce4224

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright 2014 Ryan Cook
+Copyright 2014 Ryan Cook <cookrn@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,16 +1,140 @@
 DirectInject
 ============
 
-A Sprockets add-on helping you inject assets into your HTML inline.
+A Sprockets-aware library that helps you inject assets inline into your HTML.
 
 ## Installation
 
-WIP
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'direct_inject'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install direct_inject
 
 ## Usage
 
-WIP
+### Why?
+
+Recently I was working on a application experimenting with public-key
+cryptography in Javascript. I didn't want to manually manage my assets
+or hand-roll them into HTML. You might be saying to yourself: "Why in
+FSM's name would you be doing crypto in the browser?!" Just know that it
+was only an experiment. Anyhow, it would have been great to have a way
+to utilize Sprockets for managing all of the assets, but be able to
+use them directly inline on the page. Hence, DirectInject was born.
+
+### Usage from Rails
+
+DirectInject detects whether it has been loaded in Rails automagically.
+The only requirement is that you're using Rails >= 3.1.
+
+Once you're up and running, you have a few extra helpers in your views
+now:
+
+1. `direct_inject_image`: This will find the image in your environment,
+    encode it, and place it in your view inline.
+2. `direct_inject_javascript`: This will find the script in your environment,
+    and place it in your view inline.
+3. `direct_inject_stylesheet`: This will find the stylesheet in your environment,
+    and place it in your view inline.
+
+### Usage Elsewhere
+
+DirectInject can be used in any Sprockets-enabled application, but it'll
+need a bit more help to get setup.
+
+First, let's configure the environment:
+
+```ruby
+DirectInject.sprockets_environment = MyApp.assets
+```
+
+Next, we're able to render images, javascript, and stylesheets using the
+following API:
+
+```ruby
+image_tag      = DirectInject.render_image( 'logo.png' )
+javascript_tag = DirectInject.render_javascript( 'main' )
+stylesheet_tag = DirectInject.render_stylesheet( 'application' )
+```
+
+```html
+<img src="data:image/png;base64,MUMBOJUMBO">
+<script type="text/javascript">/* the codez */</script>
+<style type="text/css">/* the stylez */</style>
+```
+
+The output is just strings containing HTML that you can use as needed.
+
+### Miscellaneous
+
+DirectInject's API accepts an options hash as the final argument to any
+of the functions. This has is converted into HTML attributes for the
+resulting markup. For example, to add a CSS class:
+
+```ruby
+DirectInject.render_stylesheet \
+  'application',
+  :class => 'the-fanciest-styles-in-the-world'
+```
+
+```html
+<style class="the-fanciest-styles-in-the-world">/* styles */</style>
+```
+
+Or, for another example, a few data attributes:
+
+```ruby
+DirectInject.render_stylesheet \
+  'application',
+  :data => { 'attr1' => 'val1' , 'attr2' => 'val2' }
+```
+
+```html
+<style data-attr1="val1" data-attr2="val2">/* styles */</style>
+```
+
+DirectInject will automatically add some data attributes to all of the
+HTML it outputs:
+
+* `data-direct_inject_source`: the specified asset source
+* `data-direct_inject_type`: the asset type that defined the compilation code path for the source
+
+```html
+<img data-direct_inject_source="headshot.png" data-direct_inject_type="image">
+<script data-direct_inject_source="application" data-direct_inject_type="javascript"></script>
+<style data-direct_inject_source="site" data-direct_inject_type="stylesheet"></style>
+```
+
+DirectInject supports injecting multiple assets simultaneously.
+
+```ruby
+DirectInject.render_javascript \
+  'core.js.coffee',
+  'utils.js.coffee'
+```
+
+```html
+<script data-direct_inject_source="core.js.coffee">/* the codez */</script>
+<script data-direct_inject_source="utils.js.coffee">/* the codez */</script>
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/cookrn/direct_inject/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
 
 ## License
 
-MIT. See: MIT-LICENSE
+MIT. See: [LICENSE](https://github.com/cookrn/direct_inject/blob/master/LICENSE)

data/Rakefile

@@ -1,34 +1,24 @@
 begin
   require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
+APP_RAKEFILE =
+  File.expand_path \
+    '../test/dummy/Rakefile',
+    __FILE__
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'DirectInject'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
-
-
-Bundler::GemHelper.install_tasks
-
 require 'rake/testtask'
 
-Rake::TestTask.new(:test) do |t|
+Rake::TestTask.new :test do | t |
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
 end
 
-
-task default: :test
+task :default => :test

data/direct_inject.gemspec

@@ -22,6 +22,9 @@ Gem::Specification.new do | spec |
   spec.add_dependency 'tagz'
 
   spec.add_development_dependency 'bundler' , '~> 1.7'
-  spec.add_development_dependency 'rails'   , '>= 3.1'
-  spec.add_development_dependency 'rake'    , '~> 10.0'
+  spec.add_development_dependency 'coffee-script'
+  spec.add_development_dependency 'nokogiri'
+  spec.add_development_dependency 'rails'     , '>= 3.1'
+  spec.add_development_dependency 'rake'      , '~> 10.0'
+  spec.add_development_dependency 'sprockets' , '~> 2.12'
 end

data/lib/direct_inject/internal_helpers.rb

@@ -1,6 +1,8 @@
+require 'base64'
 require 'direct_inject'
 require 'direct_inject/errors'
 require 'map'
+require 'uri'
 
 module DirectInject
   module InternalHelpers
@@ -12,9 +14,15 @@ module DirectInject
 
     private
 
+    def data_uri_for( asset )
+      prefix  = "data:#{ asset.content_type };base64,"
+      encoded = Base64.encode64( asset.to_s ).gsub( /\s+/ , '' )
+      "#{ prefix }#{ URI.encode_www_form_component encoded }"
+    end
+
     def asset_for!( source , options )
       environment =
-        options.fetch 'sprockets_environment' do
+        options.delete 'sprockets_environment' do
           DirectInject.sprockets_environment
         end
 
@@ -39,10 +47,6 @@ module DirectInject
       extname if extname && File.extname( source ) != extname
     end
 
-    def image_prefix_for( asset )
-      "data:image/#{ asset.pathname.extname[ 1 .. -1 ] };base64,"
-    end
-
     def render( *sources )
       options = Map.opts! sources
 
@@ -54,12 +58,11 @@ module DirectInject
           'direct_inject_source',
           source
 
-        result =
-          if block_given?
-            yield( asset , options ).to_s
-          else
-            ''
-          end
+        if block_given?
+          yield( asset , options ).to_s
+        else
+          ''
+        end
       end.join "\n"
     end
   end

data/lib/direct_inject/public_api.rb

@@ -1,4 +1,3 @@
-require 'base64'
 require 'direct_inject/internal_helpers'
 require 'direct_inject/templates'
 require 'map'
@@ -14,8 +13,7 @@ module DirectInject
           'direct_inject_type',
           'image'
 
-        prefix  = image_prefix_for asset
-        encoded = "#{ prefix }#{ Base64.encode64( asset.to_s ) }"
+        encoded = data_uri_for asset
 
         Templates::Image.render \
           encoded,

data/lib/direct_inject/railtie.rb

@@ -9,7 +9,7 @@ module DirectInject
 
     initializer 'direct_inject.view_helpers' do
       ActiveSupport.on_load :action_view do
-        include Rails::ViewHelpers
+        include DirectInject::Rails::ViewHelpers
       end
     end
   end

data/lib/direct_inject/templates/javascript.rb

@@ -4,7 +4,7 @@ module DirectInject
   module Templates
     class Javascript < Abstract
       def render
-        tagz { script_( tag_options( options ) ){ source } }
+        tagz { script_( tag_options options ){ source } }
       end
     end
   end

data/lib/direct_inject/templates/stylesheet.rb

@@ -4,7 +4,7 @@ module DirectInject
   module Templates
     class Stylesheet < Abstract
       def render
-        tagz { style_( tag_options( options ) ){ source } }
+        tagz { style_( tag_options options ){ source } }
       end
     end
   end

data/lib/direct_inject/version.rb

@@ -1,3 +1,3 @@
 module DirectInject
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/test/direct_inject_api_test.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+
+class DirectInjectApiTest < ActiveSupport::TestCase
+  test 'apis' do
+    tests =
+      [
+        {
+          :api     => :render_image,
+          :matches => [ /base64/ , /image\/png/ , /iVBORw0KGgoAAAANSUhEUgAAAncAAANrCA/ ],
+          :source  => 'face.png',
+          :tag     => 'img',
+          :type    => 'image'
+        },
+
+        {
+          :api     => :render_javascript,
+          :matches => [ /alert/ , /\d+/ ],
+          :source  => 'main',
+          :tag     => 'script',
+          :type    => 'javascript'
+        },
+
+        {
+          :api     => :render_stylesheet,
+          :matches => [ /div span\.highlight/ , /yellowgreen/ ],
+          :source  => 'site',
+          :tag     => 'style',
+          :type    => 'stylesheet'
+        }
+      ]
+
+    tests.each do | test |
+      result =
+        DirectInject.send \
+          test.fetch( :api ),
+          test.fetch( :source ),
+          :sprockets_environment => LOCAL_SPROCKETS,
+          :class => 'wat'
+
+      assert \
+        test.fetch( :matches ).all? do | regexp |
+          result =~ regexp
+        end
+
+      el = Nokogiri::HTML::DocumentFragment.parse( result ).children.first
+
+      assert_equal \
+        test.fetch( :tag ),
+        el.name
+
+      expected_keys =
+        %w(
+          class
+          data-direct_inject_source
+          data-direct_inject_type
+        )
+
+      expected_keys.each do | expected_key |
+        assert_includes \
+          el.attributes.keys,
+          expected_key
+      end
+
+      refute_includes \
+        el.attributes.keys,
+        'sprockets_environment'
+
+      assert_equal \
+        test.fetch( :source ),
+        el.attributes.fetch( 'data-direct_inject_source' ).value
+
+      assert_equal \
+        test.fetch( :type ),
+        el.attributes.fetch( 'data-direct_inject_type' ).value
+    end
+  end
+end

data/test/direct_inject_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+class DirectInjectTest < ActiveSupport::TestCase
+  test 'has api methods' do
+    %i(
+      render_image
+      render_javascript
+      render_stylesheet
+    ).each do | public_api_method |
+      assert_respond_to \
+        DirectInject,
+        public_api_method
+    end
+  end
+
+  test 'does not respond to internal helpers' do
+    # a sample of the internal helper methods
+    %i(
+      asset_for!
+      data_uri_for
+      render
+    ).each do | public_api_method |
+      refute_respond_to \
+        DirectInject,
+        public_api_method
+    end
+  end
+
+  test 'has a sprockets_environment accessor' do
+    old_env = DirectInject.sprockets_environment
+
+    assert_respond_to \
+      DirectInject,
+      :sprockets_environment
+
+    env = Object.new
+
+    assert_respond_to \
+      DirectInject,
+      :sprockets_environment=
+
+    DirectInject.sprockets_environment = env
+
+    assert_equal \
+      env,
+      DirectInject.sprockets_environment
+
+    DirectInject.sprockets_environment = old_env
+  end
+end

data/test/dummy/app/views/pages/javascript_test.html.erb

@@ -1 +1,2 @@
+View source to see result.
 <%= direct_inject_javascript 'application' %>

data/test/dummy/app/views/pages/stylesheet_test.html.erb

@@ -1 +1,2 @@
+View source to see result.
 <%= direct_inject_stylesheet 'application' %>

data/test/support/local_sprockets/assets/javascripts/main.js.coffee.erb

@@ -0,0 +1,2 @@
+@x = <%= rand 42 %>
+alert @x

data/test/support/local_sprockets/assets/stylesheets/site.css.scss

@@ -0,0 +1,10 @@
+$color: yellowgreen;
+
+div {
+  background-color: $color;
+
+  span.highlight {
+    color: white;
+    text-decoration: underline;
+  }
+}

data/test/support/local_sprockets/environment.rb

@@ -0,0 +1,10 @@
+require 'coffee_script'
+
+path = File.dirname __FILE__
+
+env = Sprockets::Environment.new
+env.append_path "#{ path }/assets/images"
+env.append_path "#{ path }/assets/javascripts"
+env.append_path "#{ path }/assets/stylesheets"
+
+LOCAL_SPROCKETS = env

data/test/test_helper.rb

@@ -1,15 +1,17 @@
-# Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-require "rails/test_help"
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+require 'rails/test_help'
+
+require 'minitest/hell'
+require 'minitest/pride'
 
 Rails.backtrace_cleaner.remove_silencers!
 
+# Comment out this line to turn the `test` log level back to `debug`
+Rails.logger.level = 4
+
 # Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir[ "#{ File.dirname __FILE__ }/support/**/*.rb" ].each { |f| require f }
 
-# Load fixtures from the engine
-if ActiveSupport::TestCase.method_defined?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
-end
+require 'nokogiri'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: direct_inject
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryan Cook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-18 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: map
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coffee-script
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
 description: Sprockets/Rails helpers for directly injecting assets onto the page as
   an alternative to linking/sourcing an asset by URL.
 email:
@@ -90,7 +132,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- MIT-LICENSE
+- LICENSE
 - README.md
 - Rakefile
 - direct_inject.gemspec
@@ -108,6 +150,8 @@ files:
 - lib/direct_inject/templates/javascript.rb
 - lib/direct_inject/templates/stylesheet.rb
 - lib/direct_inject/version.rb
+- test/direct_inject_api_test.rb
+- test/direct_inject_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/assets/images/.keep
 - test/dummy/app/assets/images/headshot.png
@@ -145,6 +189,10 @@ files:
 - test/integration/image_test.rb
 - test/integration/javascript_test.rb
 - test/integration/stylesheet_test.rb
+- test/support/local_sprockets/assets/images/face.png
+- test/support/local_sprockets/assets/javascripts/main.js.coffee.erb
+- test/support/local_sprockets/assets/stylesheets/site.css.scss
+- test/support/local_sprockets/environment.rb
 - test/test_helper.rb
 homepage: https://github.com/cookrn/direct_inject
 licenses:
@@ -171,6 +219,8 @@ signing_key:
 specification_version: 4
 summary: Sprockets/Rails helpers for directly injecting assets onto the page.
 test_files:
+- test/direct_inject_api_test.rb
+- test/direct_inject_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/assets/images/.keep
 - test/dummy/app/assets/images/headshot.png
@@ -208,4 +258,8 @@ test_files:
 - test/integration/image_test.rb
 - test/integration/javascript_test.rb
 - test/integration/stylesheet_test.rb
+- test/support/local_sprockets/assets/images/face.png
+- test/support/local_sprockets/assets/javascripts/main.js.coffee.erb
+- test/support/local_sprockets/assets/stylesheets/site.css.scss
+- test/support/local_sprockets/environment.rb
 - test/test_helper.rb