cdn_tags 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40db6c3cff7b7b1221071e969234d08e5920f171
-  data.tar.gz: fc3fa476e90c84bf6fd348f161128a4d3c6f0fc7
+  metadata.gz: f16dcecb7ea4d331c0a0ccad04f682f83b5e1908
+  data.tar.gz: dfede84d60cd1dd5e689661de92c9b940bb8d9dd
 SHA512:
-  metadata.gz: 97e4ff29b52d62d9f90c8b19f46e4e97cfa57562a167401c83ecf0180711e8e532617736eeb23030ab485e6a5c7562a3bc8192f28cf064aab5d8448cb60bdaa0
-  data.tar.gz: 9e6687ecd2b253e669f61355ee6186c16c3ee245ed93f081d03fff8f081f4868ea6b7097916471bf5c5f04cd2bbb54520e0863708cca4dedd9a30846eb8f444d
+  metadata.gz: 0f87e288f2dbff52e0206d276a12616aeef19112985367755e43a8b93f4d6a77abc43c593be41c1070dfe63250f2a0668200904e12dd8f05157fadf2ab564351
+  data.tar.gz: 9b9f020514e4864235662dc973b16996b2744590f87a7dd76f4820c3cb1229a73341a8a2f8ef453880c7cbc1e8c334c0ba8053351c86de3341de81ce81389fa6

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Claude Tech
+
+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,53 @@
+# CdnTags
+
+Using a CDN in development is kind of painful when the 
+network is unstable, however in production common libraries
+should generally be served via a CDN.
+This gem helps to automatize this process.
+
+## Installation
+
+Add 
+
+```
+gem 'cdn_tags'
+```
+
+to your Gemfile.
+
+## Configuration
+
+Create config/initializers/cdn_tags.rb and configure your assets.
+
+```ruby
+CdnTags.configure do |c|
+  c.scripts_urls = {
+    '/path/to/jquery' => '//code.jquery.com/jquery-2.1.1.min.js',
+  }
+  c.stylesheets_urls = {
+    '/path/to/bootstrap' => '//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css'
+  }
+end
+```
+
+This will automatically add the files to `Rails.application.config.assets.precompile`. If you want to disable this behavior, you can set
+`add_to_precompile` to `false` in the configuration.
+
+## Usage
+
+Just replace `javascript_include_tag` and `stylesheet_link_tag`
+by `javascript_cdn_include_tag` and `stylesheet_cdn_link_tag`.
+
+For example, 
+
+```erb
+<%= javascript_include_tag '/path/to/jquery' %>
+<%= stylesheet_link_tag '/path/to/bootstrap' %>
+```
+
+becomes 
+
+```erb
+<%= javascript_cdn_include_tag '/path/to/jquery' %>
+<%= stylesheet_cdn_link_tag '/path/to/bootstrap' %>
+```

data/lib/cdn_tags/version.rb

@@ -1,3 +1,3 @@
 module CdnTags
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/generators/initializer_geenrator.rb

@@ -0,0 +1,7 @@
+class InitializerGeenrator < Rails::Generators::NamedBase
+  source_root File.expand_path("../templates", __FILE__)
+
+  def copy_initializer_file
+    copy_file "cdn_tags.rb", "config/initializers/cdn_tags.rb"
+  end
+end

data/lib/generators/templates/cdn_tags.rb

@@ -0,0 +1,19 @@
+CdnTags.configure do |c|
+  # Add scripts using CDN here
+  c.scripts_urls = {
+    # 'jquery-1.9.1' => 'http://code.jquery.com/jquery-1.9.1.js'
+  }
+
+  # Add stylesheets using CDN here
+  c.stylesheets_urls = {
+    # 'bootstrap' => '//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css'
+  }
+
+  # Set to true to raise an exception if the demanded
+  # asset is not defined above
+  # c.raise_on_missing = false
+
+  # Set to false to avoid adding the above assets
+  # to Rails.config.assets.precompile automatically
+  # c.add_to_precompile = true
+end

data/specs/cdn_tags_spec.rb

@@ -0,0 +1,118 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'cdn_tags'
+
+def script_src(html)
+  doc = Nokogiri::HTML(html)
+  doc.xpath('//script')[0].attr('src')
+end
+
+def link_href(html)
+  doc = Nokogiri::HTML(html)
+  doc.xpath('//link')[0].attr('href')
+end
+
+describe CdnTags do
+  describe CdnTags::Configuration do
+    it 'should have default values' do
+      expect(CdnTags.configuration.stylesheets_urls).to eq({})
+      expect(CdnTags.configuration.scripts_urls).to eq({})
+    end
+
+    it 'should bet settable' do
+      CdnTags.configure do |c|
+        c.scripts_urls["foo"] = "bar"
+      end
+      expect(CdnTags.configuration.scripts_urls["foo"]).to eq("bar")
+    end
+
+    it 'should update Rails assets precompile' do
+      expect(Rails.application.config.assets.precompile).not_to include('jquery-1.9.1.js')
+      expect(Rails.application.config.assets.precompile).not_to include('bootstrap.css')
+      CdnTags.configure do |c|
+        c.scripts_urls["jquery-1.9.1"] = "foobar"
+        c.stylesheets_urls["bootstrap"] = "foobar"
+      end
+      expect(Rails.application.config.assets.precompile).to include('jquery-1.9.1.js')
+      expect(Rails.application.config.assets.precompile).to include('bootstrap.css')
+    end
+
+    it 'should not update Rails assets precompile if disabled' do
+      expect(Rails.application.config.assets.precompile).not_to include('angular.js')
+      CdnTags.configure do |c|
+        c.scripts_urls["angular"] = "foobar"
+        c.add_to_precompile = false
+      end
+      expect(Rails.application.config.assets.precompile).not_to include('angular.js')
+    end
+  end
+
+  describe CdnTags::Helpers do
+    view = ActionView::Base.new
+    subject { view }
+
+    before(:each) do
+      CdnTags.configure do |c|
+        c.scripts_urls = {
+          'jquery' => '//code.jquery.com/jquery-2.1.1.min.js',
+        }
+        c.stylesheets_urls = {
+          'bootstrap' => '//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css'
+        }
+        c.raise_on_missing = false
+      end
+    end
+
+    tests = [
+      {
+        method: 'javascript_cdn_include_tag',
+        path_helper: 'javascript_path',
+        extracter: 'script_src',
+        asset: 'jquery',
+        config_key: 'scripts_urls'
+      },
+      {
+        method: 'stylesheet_cdn_link_tag',
+        path_helper: 'stylesheet_path',
+        extracter: 'link_href',
+        asset: 'bootstrap',
+        config_key: 'stylesheets_urls'
+      }
+    ]
+
+    tests.each do |t|
+      it { should respond_to(t[:method]) }
+
+      describe "##{t[:method]}" do
+        it 'should not replace sources in development and test envs' do
+          CdnTags.configuration.environment = "development"
+          tag = view.send(t[:method], "foo")
+          expected = view.send(t[:path_helper], "foo")
+          expect(send(t[:extracter], tag)).to eq(expected)
+        end
+
+        it 'should replace sources in production' do
+          CdnTags.configuration.environment = "production"
+          tag = view.send(t[:method], t[:asset])
+          urls = CdnTags.configuration.send(t[:config_key])
+          expected = urls[t[:asset]]
+          expect(send(t[:extracter], tag)).to eq(expected)
+        end
+
+        it 'should ignore unconfigured sources' do
+          CdnTags.configuration.environment = "production"
+          tag = view.send(t[:method], "foo")
+          expected = view.send(t[:path_helper], "foo")
+          expect(send(t[:extracter], tag)).to eq(expected)
+        end
+
+        it 'should raise error when configured' do
+          CdnTags.configure do |c|
+            c.raise_on_missing = true
+          end
+          CdnTags.configuration.environment = "production"
+          expect { view.send(t[:method], "foo") }.to raise_error(CdnTags::Error)
+        end
+      end
+    end
+  end
+end

data/specs/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'action_view'
+require 'nokogiri'
+require 'rails'
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = 'documentation'
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+class DummyApp < Rails::Application
+end
+
+Rails.application = DummyApp.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cdn_tags
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Daniel Perez
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: jazz_hands
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +59,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - Rakefile
 - lib/cdn_tags.rb
 - lib/cdn_tags/configuration.rb
 - lib/cdn_tags/error.rb
 - lib/cdn_tags/helpers.rb
 - lib/cdn_tags/version.rb
-- lib/tasks/cdn_tags_tasks.rake
-homepage: https://github.com/claude-tech/rails-cdn-tags
+- lib/generators/initializer_geenrator.rb
+- lib/generators/templates/cdn_tags.rb
+- specs/cdn_tags_spec.rb
+- specs/spec_helper.rb
+homepage: https://github.com/claude-tech/cdn-tags-rails
 licenses:
 - MIT
 metadata: {}
@@ -104,5 +95,7 @@ rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Helpers to use CDN scripts in Rails production.
-test_files: []
+test_files:
+- specs/cdn_tags_spec.rb
+- specs/spec_helper.rb
 has_rdoc: 

data/lib/tasks/cdn_tags_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :cdn_tags do
-#   # Task goes here
-# end