zassets 0.1.4 → 0.1.5

data/Gemfile

@@ -1,3 +1,11 @@
 source :rubygems
 
 gemspec
+
+group :development, :test do
+  gem 'guard',        '~> 1.4'
+  gem 'guard-rspec',  '~> 2.0'
+  if RbConfig::CONFIG['target_os'] =~ /linux/i
+    gem 'rb-inotify', '~> 0.8'
+  end
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{\Aspec/.+_spec\.rb\z})
+  watch(%r{\Alib/(.+)\.rb\z})         { |m| "spec/#{m[1]}_spec.rb" }
+
+  watch(%r{\Aspec/support/.+\.rb\z})  { 'spec' }
+end

data/README.md

@@ -1,5 +1,5 @@
-z'assets
-========
+z'assets - standalone asset pipeline
+====================================
 
   z'assets is a tool based on [Sprockets][] for serving and compiling
 web assets. When serving over HTTP (intended for a development
@@ -57,20 +57,3 @@ Installation
   Assuming you have a working rubygems installation:
 
     gem install zassets
-
-
-Similar projects
-----------------
-
-  FIXME
-
-
-TODO
-----
-
-  * *Test* all that code!
-
-  * Replace compile argument (config?) with build?
-
-  * Verify how sprockets-helpers is useful and either add usages
-    in documentation or remove it.

data/lib/zassets/cli.rb

@@ -2,14 +2,17 @@ require 'optparse'
 
 module ZAssets
   class CLI
-    def initialize(args)
+    attr_reader :options
+
+    def initialize(args, stdout = $stdout)
+      @stdout = stdout
       @options = args_parse! args
     end
 
     def args_parse!(args)
       options = {}
       parser = OptionParser.new do |o|
-        o.banner = "Usage: #{File.basename $0} [options] [compile|serve]"
+        o.banner = "Usage: #{File.basename $0} [options] compile|serve"
 
         o.on '-v', '--verbose', 'Enable verbose mode' do |v|
           options[:verbose] = v
@@ -32,12 +35,12 @@ module ZAssets
         end
 
         o.on '-h', '--help', 'Show this message' do
-          puts o
+          @stdout.puts o
           exit
         end
 
         o.on '-V', '--version', 'Show version' do
-          puts VERSION
+          @stdout.puts VERSION
           exit
         end
       end
@@ -46,14 +49,14 @@ module ZAssets
         parser.parse! args
       rescue OptionParser::InvalidOption => e
         warn e.message
-        puts parser
+        @stdout.puts parser
         exit 64
       end
 
       if args.last && %w(compile serve).include?(args.last)
         options[:action] = args.last.to_sym
       else
-        puts parser
+        @stdout.puts parser
         exit 64
       end
 

data/lib/zassets/compiler.rb

@@ -2,16 +2,14 @@ require 'sprockets'
 
 module ZAssets
   class Compiler
+    attr_writer :manifest
+
     def initialize(config)
       @config = config
     end
 
     def compile
-      if @config[:compile]
-        manifest.compile(@config[:compile])
-      else
-        manifest.compile
-      end
+      manifest.compile(@config[:compile])
     end
 
     def manifest

data/lib/zassets/config.rb

@@ -2,14 +2,14 @@ require 'yaml'
 
 module ZAssets
   class Config
-    def initialize(options)
-      o = defaults_options
+    def initialize(options = {})
+      o = default_options
       o.merge! load_options(options[:config_file]) if options[:config_file]
       o.merge! options
       @options = o
     end
 
-    def defaults_options
+    def default_options
       {
         :verbose      => false,
         :host         => '::1',

data/lib/zassets/sprockets_env.rb

@@ -1,5 +1,4 @@
 require 'sprockets'
-require 'sprockets-helpers'
 
 module Sprockets
   autoload :LessTemplate, 'sprockets/less_template'
@@ -19,13 +18,6 @@ module ZAssets
       require 'handlebars_assets'
       append_path HandlebarsAssets.path
       self.register_engine '.hbs', ::HandlebarsAssets::TiltHandlebars
-
-      Sprockets::Helpers.configure do |c|
-        c.environment = self
-        c.prefix      = config[:base_url]
-        c.digest      = true
-        c.public_path = config[:public_path]
-      end
     end
   end
 end

data/lib/zassets/version.rb

@@ -1,3 +1,3 @@
 module ZAssets
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/spec/fixtures/assets/app.js

@@ -0,0 +1 @@
+console.log('hello!');

data/spec/fixtures/config/zassets.yaml

@@ -0,0 +1 @@
+file_option: :file_value

data/spec/fixtures/public/hello.txt

@@ -0,0 +1 @@
+hello!

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'zassets'
+
+require 'support/fixtures_helpers'

data/spec/support/fixtures_helpers.rb

@@ -0,0 +1,13 @@
+module FixturesHelpers
+  FIXTURE_PATH = File.join(File.dirname(__FILE__), '..', 'fixtures')
+
+  def fixture_path_for(path)
+    File.join(FIXTURE_PATH, path)
+  end
+
+  def within_fixture_path
+    Dir.chdir FIXTURE_PATH do
+      yield
+    end
+  end
+end

data/spec/zassets/cli_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+module ZAssets
+  describe CLI do
+    let(:args)    { ['serve'] }
+    subject(:cli) { CLI.new(args) }
+
+    context 'action arguments parsing' do
+      it 'parses the action' do
+        cli.options[:action].should == :serve
+      end
+    end
+
+    context 'option arguments parsing ' do
+      def with_option(option, value = nil)
+        if value
+          CLI.new [option, value, *args]
+        else
+          CLI.new [option, *args]
+        end
+      end
+
+      it 'parses the -v option' do
+        with_option('-v').options[:verbose].should be_true
+      end
+
+      it 'parses the -c option' do
+        with_option('-c', 'config').options[:config_file].should == 'config'
+      end
+
+      it 'parses the -o option' do
+        with_option('-o', '::0').options[:host].should == '::0'
+      end
+
+      it 'parses the -p option' do
+        with_option('-p', '9393').options[:port].should == '9393'
+      end
+
+      it 'parses the -s option' do
+        with_option('-s', 'thin').options[:server].should == 'thin'
+      end
+
+      context '-h option' do
+        let(:args)    { ['-h'] }
+        let(:output)  { StringIO.new }
+        subject(:cli) { CLI.new(args, output) }
+
+        it 'prints the usage help' do
+          begin
+            cli
+          rescue SystemExit
+          end
+          output.string.should =~ /\AUsage: /
+        end
+
+        it 'exits' do
+          lambda { cli }.should raise_error SystemExit
+        end
+      end
+
+      context '-V option' do
+        let(:args)    { ['-V'] }
+        let(:output)  { StringIO.new }
+        subject(:cli) { CLI.new(args, output) }
+
+        it 'prints the version' do
+          begin
+            cli
+          rescue SystemExit
+          end
+          output.string.chomp.should == VERSION
+        end
+
+        it 'exits' do
+          lambda { cli }.should raise_error SystemExit
+        end
+      end
+    end
+
+    describe '#config' do
+      it 'builds a config' do
+        Config.should_receive(:new).with(cli.options)
+        cli.config
+      end
+
+      it 'returns the config' do
+        config = double('config')
+        Config.stub(:new) { config }
+        cli.config.should == config
+      end
+    end
+
+    describe '#run' do
+      context 'serve action' do
+        it 'runs the server' do
+          server = double('server')
+          cli.stub(:server) { server }
+          server.should_receive :run
+          cli.run
+        end
+      end
+
+      context 'compiler action' do
+        let(:args) { ['compile'] }
+
+        it 'runs the compiler' do
+          compiler = double('compiler')
+          cli.stub(:compiler) { compiler }
+          compiler.should_receive :compile
+          cli.run
+        end
+      end
+    end
+
+    describe '#compiler' do
+      it 'builds a compiler' do
+        Compiler.should_receive(:new).with(cli.config)
+        cli.compiler
+      end
+
+      it 'returns the compiler' do
+        compiler = double('compiler')
+        Compiler.stub(:new) { compiler }
+        cli.compiler.should == compiler
+      end
+    end
+
+    describe '#server' do
+      it 'builds a server' do
+        Server.should_receive(:new).with(cli.config)
+        cli.server
+      end
+
+      it 'returns the server' do
+        server = double('server')
+        Server.stub(:new) { server }
+        cli.server.should == server
+      end
+    end
+  end
+end

data/spec/zassets/compiler_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module ZAssets
+  describe Compiler do
+    let(:config)        { Config.new }
+    subject(:compiler)  { Compiler.new(config) }
+
+    describe '#compile' do
+      it 'compiles the manifest' do
+        compiler.manifest = double('manifest')
+        compiler.manifest.should_receive :compile
+        compiler.compile
+      end
+    end
+
+    describe '#manifest' do
+      it 'builds a sprockets manifest' do
+        Sprockets::Manifest.should_receive(:new).with(
+          compiler.environment,
+          config[:compile_path]
+        )
+        compiler.manifest
+      end
+
+      it 'returns the sprockets manifest'do
+        manifest = double('manifest')
+        Sprockets::Manifest.stub(:new) { manifest }
+        compiler.manifest.should == manifest
+      end
+    end
+
+    describe '#environment' do
+      it 'builds a sprockets env' do
+        SprocketsEnv.should_receive(:new).with(config)
+        compiler.environment
+      end
+
+      it 'returns the sprockets env' do
+        environment = double('environment')
+        SprocketsEnv.stub(:new) { environment }
+        compiler.environment.should == environment
+      end
+    end
+  end
+end

data/spec/zassets/config_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+module ZAssets
+  describe Config do
+    include FixturesHelpers
+
+    subject(:config)
+
+    let(:config_file) { fixture_path_for 'config/zassets.yaml' }
+
+    describe '#initialize' do
+      context 'with an empty option hash' do
+        it 'assigns #default_options to @options' do
+          config.instance_eval { @options }.should == config.default_options
+        end
+      end
+
+      context 'with a non-empty option hash' do
+        subject(:config) { Config.new(some_option: :some_value)}
+
+        it 'merges the option hash' do
+          config[:some_option].should == :some_value
+        end
+
+        it 'merges the option hash after default options' do
+          Config.any_instance.stub(:default_options) {
+            { some_option: :default_value }
+          }
+          config = Config.new(some_option: :argument_value)
+          config[:some_option].should == :argument_value
+        end
+      end
+
+      context 'with config_file option' do
+        subject(:config) { Config.new(config_file: config_file) }
+
+        it 'merges the config file options in @options' do
+          config[:file_option].should == :file_value
+        end
+
+        it 'merges the config file options before argument options' do
+          config = Config.new(file_option: :argument_value)
+          config[:file_option].should == :argument_value
+        end
+      end
+    end
+
+    describe '#default_options' do
+      it 'sets verbose to false' do
+        config.default_options[:verbose].should be_false
+      end
+
+      it 'sets host to ::1' do
+        config.default_options[:host].should == '::1'
+      end
+
+      it 'sets port to 9292' do
+        config.default_options[:port].should == 9292
+      end
+
+      it 'sets server to puma' do
+        config.default_options[:server].should == :puma
+      end
+
+      it 'sets base_url to /assets' do
+        config.default_options[:base_url].should == '/assets'
+      end
+
+      it 'sets paths empty' do
+        config.default_options[:paths].should == []
+      end
+
+      it 'sets public_path to public directory' do
+        config.default_options[:public_path].should == 'public'
+      end
+
+      it 'sets compile_path to public/assets directory' do
+        config.default_options[:compile_path].should == 'public/assets'
+      end
+
+      it 'sets compile empty' do
+        config.default_options[:compile].should == []
+      end
+    end
+
+    describe '#load_options' do
+      it 'loads symbolized options from YAML file' do
+        config.load_options(config_file).should == {
+          file_option: :file_value
+        }
+      end
+    end
+
+    describe '#[]' do
+      it 'returns an @options value from its key' do
+        config.instance_eval { @options[:foo] = :bar }
+        config[:foo].should == :bar
+      end
+    end
+  end
+end

data/spec/zassets/server_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+module ZAssets
+  describe Server do
+    let(:config)      { Config.new }
+    subject(:server)  { Server.new(config) }
+
+    describe '#run' do
+      let(:handler) { double 'handler' }
+
+      it 'runs the rack app' do
+        server.stub(:handler) { handler }
+        handler.should_receive(:run).with(server.app, server.options)
+        server.run
+      end
+    end
+
+    describe '#handler' do
+      it 'returns the configured rack handler' do
+        server.handler.should == Rack::Handler::Puma
+      end
+    end
+
+    describe '#options' do
+      it 'sets rack environment to development' do
+        server.options[:environment].should == :development
+      end
+
+      it 'sets rack handler host to configured host' do
+        server.options[:Host].should == config[:host]
+      end
+
+      it 'sets rack handler port to configured port' do
+        server.options[:Port].should == config[:port]
+      end
+    end
+
+    describe '#app' do
+      it 'returns a rack application' do
+        server.app.should respond_to(:call)
+      end
+
+      it 'builds the rack app once' do
+        # When building a rack app with Rack::Builder.new, the app will be
+        # built on each request. We dont want that so we need to either build
+        # using Rack::Builder.app or call #to_app on the returned instance. We
+        # can test if it was done by checking #to_app method absence.
+        server.app.should_not respond_to(:to_app)
+      end
+
+      context 'Rack application' do
+        include FixturesHelpers
+
+        let(:app) { Rack::MockRequest.new(server.app) }
+
+        it 'logs queries' do
+          app.get('/').errors.should =~ /GET \/.+404.+/
+        end
+
+        it 'shows exceptions' do
+          SprocketsEnv.any_instance.stub(:call) { raise RuntimeError }
+          response = app.get(config[:base_url])
+          response.should be_server_error
+          response.should =~ /RuntimeError/
+        end
+
+        context 'assets mount point' do
+          let(:config) { Config.new(paths: [fixture_path_for('assets')]) }
+
+          it 'maps the sprockets env' do
+            within_fixture_path do
+              response = app.get([config[:base_url], 'app.js'].join('/'))
+              response.should be_ok
+              response.content_type.should == 'application/javascript'
+              response.body.should == "console.log('hello!');\n"
+            end
+          end
+        end
+
+        context 'root mount point' do
+          it 'maps the static file handler' do
+            within_fixture_path do
+              response = app.get('/hello.txt')
+              response.should be_ok
+              response.content_type.should == 'text/plain'
+              response.body.should == "hello!\n"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/zassets/sprockets_env_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module ZAssets
+  describe SprocketsEnv do
+    let(:config)  { Config.new }
+    subject(:env) { SprocketsEnv.new(config) }
+
+    describe 'working directory' do
+      it 'initializes with current working directory' do
+        env.root.should == Dir.pwd
+      end
+    end
+
+    describe 'logger level' do
+      context 'by default' do
+        it 'defaults to fatal' do
+          env.logger.level.should == Logger::FATAL
+        end
+      end
+
+      context 'in verbose mode' do
+        let(:config) { Config.new(verbose: true)}
+
+        it 'is set to debug' do
+          env.logger.level.should == Logger::DEBUG
+        end
+      end
+    end
+
+    describe 'search paths' do
+      let(:paths)   { ['assets/scripts', 'assets/styles'] }
+      let(:config)  { Config.new(paths: paths) }
+
+      it 'registers the configured search paths' do
+        env.paths.should include(File.join(env.root, paths[0]))
+        env.paths.should include(File.join(env.root, paths[1]))
+      end
+    end
+  end
+end

data/zassets.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.version     = ZAssets::VERSION
   s.summary     = "zassets-#{ZAssets::VERSION}"
   s.description = <<-eoh.gsub(/^ +/, '')
-    Standalone asset manager based on sprockets and sprockets-helpers.
+    Standalone asset pipeline based on sprockets.
   eoh
   s.homepage    = 'https://rubygems.org/gems/zassets'
 
@@ -26,4 +26,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'coffee-script',     '~> 2.2'
   s.add_dependency 'less',              '~> 2.2'
   s.add_dependency 'handlebars_assets', '~> 0.6'
+
+  s.add_development_dependency 'rspec', '~> 2.11'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zassets
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-19 00:00:00.000000000 Z
+date: 2012-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -139,7 +139,23 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
-description: ! 'Standalone asset manager based on sprockets and sprockets-helpers.
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: ! 'Standalone asset pipeline based on sprockets.
 
 '
 email: tj@a13.fr
@@ -150,6 +166,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- Guardfile
 - README.md
 - bin/zassets
 - lib/sprockets/less_template.rb
@@ -161,6 +178,16 @@ files:
 - lib/zassets/server.rb
 - lib/zassets/sprockets_env.rb
 - lib/zassets/version.rb
+- spec/fixtures/assets/app.js
+- spec/fixtures/config/zassets.yaml
+- spec/fixtures/public/hello.txt
+- spec/spec_helper.rb
+- spec/support/fixtures_helpers.rb
+- spec/zassets/cli_spec.rb
+- spec/zassets/compiler_spec.rb
+- spec/zassets/config_spec.rb
+- spec/zassets/server_spec.rb
+- spec/zassets/sprockets_env_spec.rb
 - zassets.gemspec
 homepage: https://rubygems.org/gems/zassets
 licenses: []
@@ -185,6 +212,6 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: zassets-0.1.4
+summary: zassets-0.1.5
 test_files: []
 has_rdoc: