ramaze-asset 0.2

data/spec/helper.rb

@@ -0,0 +1,4 @@
+require File.expand_path('../../lib/ramaze/asset', __FILE__)
+require File.expand_path('../../lib/ramaze/asset/spec/helper', __FILE__)
+
+Ramaze.options.roots.push(__DIR__('fixtures'))

data/spec/ramaze_asset/css.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../../helper', __FILE__)
+
+describe('Ramaze::Asset::CSS') do
+  behaves_like :asset_manager
+
+  before do
+    @file   = '/css/github'
+    @file_1 = '/css/reset'
+    @cache  = __DIR__('../fixtures/public/minified')
+    @public = __DIR__('../fixtures/public')
+  end
+
+  it('Build a single file') do
+    group = Ramaze::Asset::CSS.new(
+      [@file],
+      :cache_path => @cache,
+      :paths      => [@public]
+    )
+
+    group.build_html.should \
+      === %Q{<link rel="stylesheet" href="#{@file}.css" type="text/css" />}
+
+    # Now minify it
+    group = Ramaze::Asset::CSS.new(
+      [@file],
+      :cache_path => @cache,
+      :paths      => [@public],
+      :minify     => true,
+      :name       => 'github'
+    )
+
+    group.build
+
+    File.size?(File.join(@cache, 'github.min.css')).should != false
+
+    group.build_html.should \
+      === '<link rel="stylesheet" href="/minified/github.min.css" ' \
+        'type="text/css" />'
+  end
+
+  it('Build multiple files') do
+    group = Ramaze::Asset::CSS.new(
+      [@file, @file_1],
+      :cache_path => @cache,
+      :paths      => [@public]
+    )
+
+    group.build_html.should \
+      === %Q{<link rel="stylesheet" href="#{@file}.css" type="text/css" />} +
+        %Q{<link rel="stylesheet" href="#{@file_1}.css" type="text/css" />}
+
+    # Now minify it
+    group = Ramaze::Asset::CSS.new(
+      [@file, @file_1],
+      :cache_path => @cache,
+      :paths      => [@public],
+      :minify     => true,
+      :name       => 'github'
+    )
+
+    group.build
+
+    File.size?(File.join(@cache, 'github.min.css')).should != false
+
+    group.build_html.should \
+      === '<link rel="stylesheet" href="/minified/github.min.css" ' \
+        'type="text/css" />'
+  end
+end

data/spec/ramaze_asset/environment.rb

@@ -0,0 +1,148 @@
+require File.expand_path('../../helper', __FILE__)
+
+SpecEnv = Ramaze::Asset::Environment.new(
+  :cache_path => __DIR__('../fixtures/public/minified')
+)
+
+class SpecEnvironment < Ramaze::Controller
+  map '/'
+
+  def index
+    SpecEnv.build_html(:javascript)
+  end
+
+  def specific_method
+    SpecEnv.build_html(:javascript)
+  end
+end
+
+class SpecEnvironment2 < Ramaze::Controller
+  map '/2'
+
+  def index
+    SpecEnv.build_html(:javascript)
+  end
+end
+
+describe('Ramaze::Asset::Environment') do
+  behaves_like :asset_manager
+
+  after do
+    SpecEnv.reset!
+  end
+
+  it('Raise for an invalid cache path') do
+    should.raise?(Ramaze::Asset::AssetError) do
+      env = Ramaze::Asset::Environment.new(:cache_path => 'foobar')
+    end
+  end
+
+  it('Raise when no public directories are set') do
+    old_publics            = Ramaze.options.publics.dup
+    Ramaze.options.publics = []
+
+    should.raise?(Ramaze::Asset::AssetError) do
+      env = Ramaze::Asset::Environment.new(
+        :cache_path => __DIR__('../fixtures/public')
+      )
+    end
+
+    Ramaze.options.publics = old_publics
+  end
+
+  it('Generate the possible paths') do
+    path = __DIR__('../fixtures/public')
+    env  = Ramaze::Asset::Environment.new(:cache_path => path)
+
+    env.instance_variable_get(:@file_group_options)[:paths].include?(path) \
+      .should === true
+  end
+
+  it('Register a new type') do
+    Ramaze::Asset::Environment.register_type(:struct, Struct)
+
+    Ramaze::Asset::Environment::Types.key?(:struct).should === true
+    Ramaze::Asset::Environment::Types[:struct].should      == Struct
+
+    should.raise?(Ramaze::Asset::AssetError) do
+      Ramaze::Asset::Environment.register_type(:struct, Struct)
+    end
+
+    Ramaze::Asset::Environment::Types.delete(:struct)
+  end
+
+  it('Globally disable minifying of files') do
+    env = Ramaze::Asset::Environment.new(
+      :cache_path => __DIR__('../fixtures/public/minified'),
+      :minify     => false
+    )
+
+    env.serve(:javascript, ['js/mootools_core'], :minify => true)
+    env.serve(:css, ['css/github'])
+
+    env.files[:javascript][:global][:__all][0].options[:minify].should === false
+    env.files[:css][:global][:__all][0].options[:minify].should        === false
+  end
+
+  it('Serve a file globally') do
+    SpecEnv.serve(:javascript, ['js/mootools_core'], :controller => :global)
+
+    body1 = get('/').body
+    body2 = get('/2').body
+
+    body1.empty?.should === false
+    body1.should        === body2
+
+    body1.include?('js/mootools_core.js').should === true
+  end
+
+  it('Serve a file for a specific controller') do
+    SpecEnv.serve(
+      :javascript,
+      ['/js/mootools_core'],
+      :controller => SpecEnvironment
+    )
+
+    body1 = get('/').body
+    body2 = get('/2').body
+
+    body1.should != body2
+
+    body1.include?('js/mootools_core.js').should === true
+    body2.include?('js/mootools_core.js').should === false
+  end
+
+  it('Serve a file for a specific method') do
+    SpecEnv.serve(
+      :javascript,
+      ['/js/mootools_core'],
+      :controller => SpecEnvironment,
+      :methods    => [:specific_method]
+    )
+
+    body1 = get('/').body
+    body2 = get('/specific_method').body
+
+    body1.should != body2
+
+    body1.include?('/js/mootools_core.js').should === false
+    body2.include?('/js/mootools_core.js').should === true
+  end
+
+  it('Add an asset group and load it') do
+    SpecEnv.register_asset_group(:spec) do |env|
+      env.serve(:css, ['css/github', 'css/reset'])
+    end
+
+    SpecEnv.files[:css].nil?.should === true
+
+    should.not.raise?(Ramaze::Asset::AssetError) do
+      SpecEnv.load_asset_group(:spec)
+    end
+
+    files = SpecEnv.files[:css][:global][:__all][0].files
+
+    files.include?('/css/github.css').should === true
+    files.include?('/css/reset.css').should  === true
+  end
+end

data/spec/ramaze_asset/file_group.rb

@@ -0,0 +1,118 @@
+require File.expand_path('../../helper', __FILE__)
+
+class SpecFileGroup < Ramaze::Asset::FileGroup
+  extension '.js'
+
+  def minify(input)
+    return input
+  end
+
+  def html_tag(gestalt, path)
+    gestalt.p(path)
+  end
+end
+
+class SpecFileGroup2 < Ramaze::Asset::FileGroup
+  extension '.js'
+end
+
+describe('Ramaze::Asset::FileGroup') do
+  behaves_like :asset_manager
+
+  before do
+    @file   = '/js/mootools_core'
+    @file_1 = '/js/mootools_more'
+    @cache  = __DIR__('../fixtures/public/minified')
+    @public = __DIR__('../fixtures/public')
+  end
+
+  it('Initialize with invalid data') do
+    should.raise?(Ramaze::Asset::AssetError) do
+      Ramaze::Asset::FileGroup.new([])
+    end
+
+    should.raise?(Ramaze::Asset::AssetError) do
+      Ramaze::Asset::FileGroup.new([@file], :cache_path => __DIR__('foobar'))
+    end
+
+    # No extension specified
+    should.raise?(Ramaze::Asset::AssetError) do
+      Ramaze::Asset::FileGroup.new([@file], :cache_path => @public)
+    end
+  end
+
+  it('Generate a name for the minified file') do
+    name  = Digest::SHA1.new.hexdigest(@file + '.js') + '.min.js'
+    group = SpecFileGroup.new(
+      [@file],
+      :cache_path => @cache,
+      :paths      => [@public],
+      :minify     => true
+    )
+
+    group.options[:name].should       === name
+    group.extension[:source].should   === '.js'
+    group.extension[:minified].should === '.min.js'
+  end
+
+  it('Build a single file') do
+    group = SpecFileGroup.new(
+      [@file],
+      :cache_path => @cache,
+      :paths      => [@public]
+    )
+
+    group.build_html.should === "<p>#{@file}.js</p>"
+
+    # Minify it this time.
+    group = SpecFileGroup.new(
+      [@file],
+      :cache_path => @cache,
+      :paths      => [@public],
+      :name       => 'spec',
+      :minify     => true
+    )
+
+    group.build
+
+    content  = File.read(File.join(@public, @file + '.js'))
+    minified = File.read(File.join(@cache, 'spec.min.js'))
+
+    File.size?(File.join(@cache, 'spec.min.js')).should != false
+    minified.include?(content).should                   === true
+
+    group.build_html.should === '<p>/minified/spec.min.js</p>'
+  end
+
+  it('Build multiple files') do
+    group  = SpecFileGroup.new(
+      [@file, @file_1],
+      :cache_path => @cache,
+      :paths      => [@public]
+    )
+
+    group.build_html.should === "<p>#{@file}.js</p><p>#{@file_1}.js</p>"
+
+    # Minify it this time.
+    group = SpecFileGroup.new(
+      [@file, @file_1],
+      :cache_path => @cache,
+      :paths      => [@public],
+      :name       => 'spec',
+      :minify     => true
+    )
+
+    group.build
+
+    content   = File.read(File.join(@public, @file   + '.js'))
+    content_1 = File.read(File.join(@public, @file_1 + '.js'))
+    minified  = File.read(File.join(@cache, 'spec.min.js'))
+
+    File.size?(File.join(@cache, 'spec.min.js')).should != false
+
+    minified.include?(content).should   === true
+    minified.include?(content_1).should === true
+
+    group.build_html.should === "<p>/minified/spec.min.js</p>"
+  end
+end

data/spec/ramaze_asset/javascript.rb

@@ -0,0 +1,69 @@
+require File.expand_path('../../helper', __FILE__)
+
+describe('Ramaze::Asset::Javascript') do
+  behaves_like :asset_manager
+
+  before do
+    @file   = '/js/mootools_core'
+    @file_1 = '/js/mootools_more'
+    @cache  = __DIR__('../fixtures/public/minified')
+    @public = __DIR__('../fixtures/public')
+  end
+
+  it('Build a single file') do
+    group = Ramaze::Asset::Javascript.new(
+      [@file],
+      :cache_path => @cache,
+      :paths      => [@public]
+    )
+
+    group.build_html.should \
+      === %Q{<script src="#{@file}.js" type="text/javascript"></script>}
+
+    # Now minify it
+    group = Ramaze::Asset::Javascript.new(
+      [@file],
+      :cache_path => @cache,
+      :paths      => [@public],
+      :minify     => true,
+      :name       => 'mootools'
+    )
+
+    group.build
+
+    File.size?(File.join(@cache, 'mootools.min.js')).should != false
+
+    group.build_html.should \
+      === '<script src="/minified/mootools.min.js" ' \
+        'type="text/javascript"></script>'
+  end
+
+  it('Build multiple files') do
+    group = Ramaze::Asset::Javascript.new(
+      [@file, @file_1],
+      :cache_path => @cache,
+      :paths      => [@public]
+    )
+
+    group.build_html.should \
+      === %Q{<script src="#{@file}.js" type="text/javascript"></script>} +
+        %Q{<script src="#{@file_1}.js" type="text/javascript"></script>}
+
+    # Now minify it
+    group = Ramaze::Asset::Javascript.new(
+      [@file, @file_1],
+      :cache_path => @cache,
+      :paths      => [@public],
+      :minify     => true,
+      :name       => 'mootools'
+    )
+
+    group.build
+
+    File.size?(File.join(@cache, 'mootools.min.js')).should != false
+
+    group.build_html.should \
+      === '<script src="/minified/mootools.min.js" ' \
+        'type="text/javascript"></script>'
+  end
+end

data/task/build.rake

@@ -0,0 +1,35 @@
+# Task group used for building various elements such as the Gem and the
+# documentation.
+namespace :build do
+  desc 'Builds the documentation using YARD'
+  task :doc do
+    gem_path = File.expand_path('../../', __FILE__)
+    command  = "yard doc #{gem_path}/lib -m markdown -M rdiscount -o #{gem_path}/doc "
+    command += "-r #{gem_path}/README.md --private --protected"
+
+    sh(command)
+  end
+
+  desc 'Builds a new Gem'
+  task :gem do
+    gem_path     = File.expand_path('../../', __FILE__)
+    gemspec_path = File.join(
+      gem_path,
+      "#{Ramaze::Asset::Gemspec.name}-" \
+        "#{Ramaze::Asset::Gemspec.version.version}.gem"
+    )
+
+    pkg_path = File.join(
+      gem_path,
+      'pkg',
+      "#{Ramaze::Asset::Gemspec.name}-" \
+        "#{Ramaze::Asset::Gemspec.version.version}.gem"
+    )
+
+    # Build and install the gem
+    sh('gem', 'build'     , File.join(gem_path, 'ramaze-asset.gemspec'))
+    sh('mv' , gemspec_path, pkg_path)
+    sh('gem', 'install'   , pkg_path)
+  end
+end # namespace :build
+