stasis-extensions 0.0.2 → 1.0.0

data/.gitignore

@@ -12,6 +12,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/fixtures/project/public
 test/tmp
 test/version_tmp
 tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, all_on_start: true, cli: '--color --format doc' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -1,6 +1,7 @@
-# Stasis::Extensions
+# stasis-extensions [![Build Status](https://travis-ci.org/mosaicxm/stasis-extensions.png?branch=master)](https://travis-ci.org/mosaicxm/stasis-extensions)
+
+**stasis-extensions** is a gem that extends the functionality of **stasis** to support i18n and fingerprinting of assets.
 
-TODO: Write a gem description
 
 ## Installation
 
@@ -18,7 +19,39 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### i18n helpers
+
+#### body_class
+
+Use to generate classes for your body (or other html tag). The current locale and the current view name will be included.
+
+#### translate(key, options = {})
+
+Use in your views to localize text. Aliased as `t`. See [ActionView::Helpers::TranslationHelper](http://api.rubyonrails.org/classes/ActionView/Helpers/TranslationHelper.html).
+
+#### root_url
+
+Use in your views to generate a "root" url for your site by adding the protocol hostname (looked up as "hostname" in your locale .yml file).
+
+### asset support
+
+All files in the css, images and js folders will be fingerprinted with MD5 digests of the source content (allowing simpler use with caching or CDNs).
+
+### asset helpers
+
+In addition to compiling the fingerprinted asset files, helper methods have been added for use in views and in sass/scss.
+
+#### asset_path(file)
+
+Similar to the Rails asset_path helper, the specified path will be expanded to the fingerprinted version. 
+
+#### asset_url(file)
+
+Similar to the preceding asset_path helper, the specified path will be expanded to the fingerprinted version and will be prepended with the protocol and hostname (as provided by the root_url helper above).
+
+#### asset-url(file)
+
+Similar to the asset_path helper, but the path is rendered for css use (ie. wrapped in `url(...)`).
 
 ## Contributing
 

data/Rakefile

@@ -5,7 +5,7 @@ desc "Run all specs"
 RSpec::Core::RakeTask.new do |t|
   t.verbose = false
   t.pattern = ['spec/**/*_spec.rb']
-  t.rspec_opts = ['--options', 'spec/spec.opts']
+  t.rspec_opts = ['--color', '--format', 'doc']
 end
 
 task :default => [:spec]

data/lib/stasis/extensions/assets.rb

@@ -10,6 +10,10 @@ class Stasis
         reset
       end
 
+      def assets
+        @assets
+      end
+
       def before_all
         define_helpers
         fingerprint_assets
@@ -27,10 +31,6 @@ class Stasis
 
       protected
 
-      def assets
-        @assets
-      end
-
       def define_helpers
         @stasis.controller.helpers do
           def asset_path(path)
@@ -51,7 +51,7 @@ class Stasis
       end
 
       def fingerprint_assets
-        Dir['{css,images,js}/**/*'].each do |source|
+        Dir["{css,images,js}/**/*"].each do |source|
           next unless File.file?(source)
           fingerprint_asset(source)
         end
@@ -71,14 +71,3 @@ class Stasis
     end
   end
 end
-
-Stasis.register Stasis::Extensions::Assets
-
-module Sass::Script::Functions
-  def asset_url(path)
-    assert_type path, :String
-    Sass::Script::String.new("url(#{options[:asset_resolver].resolve_path(path.value, File.dirname(options[:original_filename]))})")
-  end
-
-  declare :asset_url, :args => [:string]
-end

data/lib/stasis/extensions/i18n.rb

@@ -42,15 +42,15 @@ class Stasis
             relative_path.sub(/\.\w+(\.(?:erb|haml|scss))?$/, '').split('/')
           end
 
-          def t(*args)
+          def translate(*args)
             options = args.last.is_a?(Hash) ? args.pop : {}
             options[:scope] ||= scope
             ::I18n.translate(*args, options)
           end
+
+          alias_method :t, :translate
         end
       end
     end
   end
 end
-
-Stasis.register Stasis::Extensions::I18n

data/lib/stasis/extensions/sass.rb

@@ -0,0 +1,10 @@
+require 'sass'
+
+module Sass::Script::Functions
+  def asset_url(path)
+    assert_type path, :String
+    Sass::Script::String.new("url(#{options[:asset_resolver].resolve_path(path.value, File.dirname(options[:original_filename]))})")
+  end
+
+  declare :asset_url, :args => [:string]
+end

data/lib/stasis/extensions/version.rb

@@ -1,5 +1,5 @@
 class Stasis
   module Extensions
-    VERSION = "0.0.2"
+    VERSION = "1.0.0"
   end
 end

data/lib/stasis/extensions.rb

@@ -1,4 +1,9 @@
-require "stasis/extensions/version"
+require 'stasis'
+require 'stasis/extensions/version'
 
 require 'stasis/extensions/assets'
 require 'stasis/extensions/i18n'
+require 'stasis/extensions/sass'
+
+Stasis.register Stasis::Extensions::Assets
+Stasis.register Stasis::Extensions::I18n

data/spec/fixtures/project/assets/asset_path.haml

@@ -0,0 +1 @@
+= asset_path('/images/stasis.png')

data/spec/fixtures/project/assets/asset_url.haml

@@ -0,0 +1 @@
+= asset_url('/images/stasis.png')

data/spec/fixtures/project/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  hostname: 'example.com'
+  i18n:
+    t:
+      hello: 'Hello'

data/spec/fixtures/project/controller.rb

@@ -0,0 +1 @@
+ignore %r"/config"

data/spec/fixtures/project/css/compiled.css.scss

@@ -0,0 +1,3 @@
+#stasis {
+  background: asset-url('../images/stasis.png');
+}

data/spec/fixtures/project/css/simple.css

@@ -0,0 +1 @@
+#stasis { color: black; }

data/spec/fixtures/project/i18n/body_class.haml

@@ -0,0 +1 @@
+= body_class

data/spec/fixtures/project/i18n/root_url.haml

@@ -0,0 +1 @@
+= root_url

data/spec/fixtures/project/i18n/t.haml

@@ -0,0 +1 @@
+= t('.hello')

data/spec/fixtures/project/js/compiled.js.erb

@@ -0,0 +1 @@
+var image_path = '<%= asset_path("/images/stasis.png") %>'

data/spec/fixtures/project/js/simple.js

@@ -0,0 +1 @@
+var simple = 'simple';

data/spec/lib/stasis/extensions/assets_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe Stasis::Extensions::Assets do
+
+  let(:project_folder) { File.expand_path('../../../../fixtures/project', __FILE__) }
+  let(:stasis) { Stasis.new(project_folder) }
+
+  describe "an instance of the plugin" do
+    before do
+      @plugin = Stasis::Extensions::Assets.new(stasis)
+    end
+
+    it "should have an empty assets Hash" do
+      expect(@plugin.assets).to eq({})
+    end
+
+    describe "#reset" do
+      it "should empty the assets Hash" do
+        @plugin.assets['test'] = 'test'
+        @plugin.reset
+        expect(@plugin.assets).to eq({})
+      end
+    end
+
+    describe "#before_all" do
+      before do
+        @plugin.before_all
+      end
+
+      it "should fingerprint css" do
+        expect(@plugin.assets).to include('css/simple.css')
+        expect(@plugin.assets['css/simple.css']).to eq("css/simple-#{digest_for('css/simple.css')}.css")
+      end
+
+      it "should fingerprint scss" do
+        expect(@plugin.assets).to include('css/compiled.css')
+        expect(@plugin.assets['css/compiled.css']).to eq("css/compiled-#{digest_for('css/compiled.css.scss')}.css")
+      end
+
+      it "should fingerprint images" do
+        expect(@plugin.assets).to include('images/stasis.png')
+        expect(@plugin.assets['images/stasis.png']).to eq("images/stasis-#{digest_for('images/stasis.png')}.png")
+      end
+
+      it "should fingerprint js" do
+        expect(@plugin.assets).to include('js/simple.js')
+        expect(@plugin.assets['js/simple.js']).to eq("js/simple-#{digest_for('js/simple.js')}.js")
+      end
+
+      it "should fingerprint erb" do
+        expect(@plugin.assets).to include('js/compiled.js')
+        expect(@plugin.assets['js/compiled.js']).to eq("js/compiled-#{digest_for('js/compiled.js.erb')}.js")
+      end
+    end
+  end
+
+  describe "when rendered" do
+    describe "the rendered assets" do
+      before do
+        stasis_render
+      end
+
+      it "should include css" do
+        expect(file_for("public/css/simple.css")).to exist
+      end
+
+      it "should include scss" do
+        expect(file_for("public/css/compiled.css")).to exist
+      end
+
+      it "should include images" do
+        expect(file_for("public/images/stasis.png")).to exist
+      end
+
+      it "should include js" do
+        expect(file_for("public/js/simple.js")).to exist
+      end
+
+      it "should include erb" do
+        expect(file_for("public/js/compiled.js")).to exist
+      end
+
+      it "should include fingerprinted css" do
+        expect(file_for("public/css/simple-#{digest_for('css/simple.css')}.css")).to exist
+      end
+
+      it "should include fingerprinted scss" do
+        expect(file_for("public/css/compiled-#{digest_for('css/compiled.css.scss')}.css")).to exist
+      end
+
+      it "should include fingerprinted images" do
+        expect(file_for("public/images/stasis-#{digest_for('images/stasis.png')}.png")).to exist
+      end
+
+      it "should include fingerprinted js" do
+        expect(file_for("public/js/simple-#{digest_for('js/simple.js')}.js")).to exist
+      end
+
+      it "should include fingerprinted erb" do
+        expect(file_for("public/js/compiled-#{digest_for('js/compiled.js.erb')}.js")).to exist
+      end
+    end
+
+    describe "#asset_path" do
+      it "should render the asset path" do
+        stasis_render 'assets/asset_path.haml'
+        expect(contents_of('public/assets/asset_path')).to eq("/images/stasis-#{digest_for('images/stasis.png')}.png")
+      end
+    end
+
+    describe "#asset_url" do
+      it "should render the asset url" do
+        stasis_render 'assets/asset_url.haml'
+        expect(contents_of('public/assets/asset_url')).to eq("http://example.com/images/stasis-#{digest_for('images/stasis.png')}.png")
+      end
+    end
+  end
+end

data/spec/lib/stasis/extensions/i18n_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Stasis::Extensions::I18n do
+
+  let(:project_folder) { File.expand_path('../../../../fixtures/project', __FILE__) }
+  let(:stasis) { Stasis.new(project_folder) }
+
+  describe "an instance of the plugin" do
+    before do
+      @plugin = Stasis::Extensions::I18n.new(stasis)
+    end
+
+    it "should set the I18n load_path" do
+      expect(::I18n.load_path).to include(project_path('config/locales/en.yml'))
+    end
+
+    it "should set the default locale" do
+      expect(::I18n.default_locale).to eq(:en)
+    end
+
+    it "should load the translations" do
+      expect(::I18n.translate('i18n.t.hello')).to eq('Hello')
+    end
+
+    describe "#reset" do
+      it "should set the I18n load_path" do
+        ::I18n.load_path = []
+        expect(::I18n.load_path).to_not include(project_path('config/locales/en.yml'))
+        @plugin.reset
+        expect(::I18n.load_path).to include(project_path('config/locales/en.yml'))
+      end
+
+      it "should set the default locale" do
+        ::I18n.default_locale = :fr
+        expect(::I18n.default_locale).to eq(:fr)
+        @plugin.reset
+        expect(::I18n.default_locale).to eq(:en)
+      end
+
+      it "should reload the translations" do
+        expect(::I18n.translate('i18n.t.hello')).to eq('Hello')
+        ::I18n.backend.store_translations('en', 'i18n' => {'t' => {'hello' => 'Hi'}})
+        expect(::I18n.translate('i18n.t.hello')).to eq('Hi')
+        @plugin.reset
+        expect(::I18n.translate('i18n.t.hello')).to eq('Hello')
+      end
+    end
+
+    describe "#before_all" do
+      it "should use the default locale" do
+        ::I18n.default_locale = :de
+        @plugin.before_all
+        expect(::I18n.locale).to eq(:de)
+      end
+
+      it "should use the locale in the LOCALE environment variable" do
+        ENV.stub(:[]).with('LOCALE').and_return('es')
+        @plugin.before_all
+        expect(::I18n.locale).to eq(:es)
+      end
+    end
+  end
+
+  describe "when rendered" do
+    describe "#body_class" do
+      it "should render the locale and the view name" do
+        stasis_render 'i18n/body_class.haml'
+        expect(contents_of('public/i18n/body_class')).to eq([:en, "body_class"].inspect)
+      end
+    end
+
+    describe "#root_url" do
+      it "should render the url" do
+        stasis_render 'i18n/root_url.haml'
+        expect(contents_of('public/i18n/root_url')).to eq('http://example.com')
+      end
+    end
+
+    describe "#t" do
+      it "should render the value" do
+        stasis_render 'i18n/t.haml'
+        expect(contents_of('public/i18n/t')).to eq('Hello')
+      end
+    end
+  end
+end

data/spec/lib/stasis/extensions/sass_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Sass::Script::Functions do
+
+  let(:project_folder) { File.expand_path('../../../../fixtures/project', __FILE__) }
+  let(:stasis) { Stasis.new(project_folder) }
+
+  describe "when scss is rendered" do
+    describe "#asset-path" do
+      it "should render the asset path" do
+        stasis_render 'css/compiled.css.scss'
+        expect(contents_of('public/css/compiled.css')).to include("url(/images/stasis-#{digest_for('images/stasis.png')}.png)")
+      end
+    end
+  end
+end

data/spec/lib/stasis/extensions_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Stasis::Extensions do
+  it "should register the Assets plugin" do
+    expect(Stasis::Plugin.plugins).to include(Stasis::Extensions::Assets)
+  end
+
+  it "should register the I18n plugin" do
+    expect(Stasis::Plugin.plugins).to include(Stasis::Extensions::I18n)
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,46 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter '/features/'
+  add_filter '/spec/'
+  add_filter '/autotest/'
+
+  add_group 'Binaries', '/bin/'
+  add_group 'Libraries', '/lib/'
+  add_group 'Extensions', '/ext/'
+  add_group 'Vendor Libraries', '/vendor/'
+end
+
 require 'rubygems'
 require 'bundler/setup'
 
+require 'stasis'
+require 'stasis/extensions'
+
 Bundler.require(:default)
 
 SPEC_DIR = File.dirname(__FILE__)
 
-require 'stasis/extensions'
+def contents_of(asset)
+  File.read(project_path(asset)).chomp
+end
+
+def digest_for(asset)
+  Digest::MD5.file project_path(asset)
+end
+
+def file_for(asset)
+  Pathname.new(project_path(asset))
+end
+
+def project_path(file)
+  File.expand_path(file, project_folder)
+end
+
+def stasis_render(*only)
+  wd = Dir.getwd
+  stasis.render *only
+ensure
+  Dir.chdir(wd)
+end

data/stasis-extensions.gemspec

@@ -18,7 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "i18n"
+  spec.add_dependency "sass"
+  spec.add_dependency "stasis"
+
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "haml"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stasis-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-23 00:00:00.000000000 Z
+date: 2013-11-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stasis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -27,6 +75,54 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +155,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: plugin(s) for stasis providing i18n support and asset fingerprinting
 email:
 - brent.faulkner@mosaic.com
@@ -67,14 +179,34 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/stasis/extensions.rb
 - lib/stasis/extensions/assets.rb
 - lib/stasis/extensions/i18n.rb
+- lib/stasis/extensions/sass.rb
 - lib/stasis/extensions/version.rb
+- spec/fixtures/project/assets/asset_path.haml
+- spec/fixtures/project/assets/asset_url.haml
+- spec/fixtures/project/config/locales/en.yml
+- spec/fixtures/project/controller.rb
+- spec/fixtures/project/css/.sass-cache/5c363f5deb88bb376880318aed5e301825a18d6e/compiled.css.scssc
+- spec/fixtures/project/css/compiled.css.scss
+- spec/fixtures/project/css/simple.css
+- spec/fixtures/project/i18n/body_class.haml
+- spec/fixtures/project/i18n/root_url.haml
+- spec/fixtures/project/i18n/t.haml
+- spec/fixtures/project/images/stasis.png
+- spec/fixtures/project/js/compiled.js.erb
+- spec/fixtures/project/js/simple.js
+- spec/lib/stasis/extensions/assets_spec.rb
+- spec/lib/stasis/extensions/i18n_spec.rb
+- spec/lib/stasis/extensions/sass_spec.rb
+- spec/lib/stasis/extensions_spec.rb
 - spec/spec_helper.rb
 - stasis-extensions.gemspec
 homepage: http://github.com/mosaicxm/stasis-extensions
@@ -92,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3445959049053357032
+      hash: -798725933815868513
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -101,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3445959049053357032
+      hash: -798725933815868513
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -109,4 +241,21 @@ signing_key:
 specification_version: 3
 summary: plugin(s) for stasis providing i18n support and asset fingerprinting
 test_files:
+- spec/fixtures/project/assets/asset_path.haml
+- spec/fixtures/project/assets/asset_url.haml
+- spec/fixtures/project/config/locales/en.yml
+- spec/fixtures/project/controller.rb
+- spec/fixtures/project/css/.sass-cache/5c363f5deb88bb376880318aed5e301825a18d6e/compiled.css.scssc
+- spec/fixtures/project/css/compiled.css.scss
+- spec/fixtures/project/css/simple.css
+- spec/fixtures/project/i18n/body_class.haml
+- spec/fixtures/project/i18n/root_url.haml
+- spec/fixtures/project/i18n/t.haml
+- spec/fixtures/project/images/stasis.png
+- spec/fixtures/project/js/compiled.js.erb
+- spec/fixtures/project/js/simple.js
+- spec/lib/stasis/extensions/assets_spec.rb
+- spec/lib/stasis/extensions/i18n_spec.rb
+- spec/lib/stasis/extensions/sass_spec.rb
+- spec/lib/stasis/extensions_spec.rb
 - spec/spec_helper.rb