zassets 0.2.3 → 0.2.4

data/README.md

@@ -1,9 +1,9 @@
 z'assets - standalone asset pipeline
 ====================================
 
-  z'assets is a tool based on [Sprockets][] for serving and compiling
+  z'assets is a tool based on [Sprockets][] for serving and building
 web assets. When serving over HTTP (intended for a development
-environment), compilation through various preprocessors will happen on
+environment), transpilation through various preprocessors will happen on
 the fly. For production environment all specified assets are built as
 files in a directory tree similar to their sources, except filenames
 will include a hash to help caching.
@@ -33,8 +33,8 @@ directory:
       - 'assets/styles'
       - 'assets/scripts'
     public_path: 'public'
-    compile_path: 'public/assets'
-    compile:
+    build_path: 'public/assets'
+    build:
       - 'main.css'
 
   Then you can launch development HTTP server with the following
@@ -44,7 +44,7 @@ command:
 
   And build your assets:
 
-    zassets compile
+    zassets build
 
   You can override some config options using command line arguments,
 the complete list is printed on the standard output on

data/features/builder/build.feature

@@ -5,7 +5,7 @@ Feature: Builder
       """
       paths:
         - app
-      compile:
+      build:
         - app.js
       """
     And a file named "app/app.js" with "some_content"

data/features/builder/manifest.feature

@@ -5,7 +5,7 @@ Feature: Manifest
       """
       paths:
         - app
-      compile:
+      build:
         - app.js
       """
     And an empty file named "app/app.js"

data/features/cli/default_action.feature

@@ -0,0 +1,5 @@
+Feature: Default action (build)
+
+  Scenario: uses build as the default action when none is provided
+    When I successfully run `zassets`
+    Then it should build

data/features/cli/usage.feature

@@ -4,5 +4,5 @@ Feature: CLI usage
     When I successfully run `zassets -h`
     Then the output must contain:
       """
-      Usage: zassets [options] compile|serve
+      Usage: zassets [options] [build|serve]
       """

data/features/config/file.feature

@@ -5,6 +5,6 @@ Feature: Config file loading
       """
       &* invalid yaml
       """
-    When I run `zassets compile`
+    When I run `zassets build`
     Then it must fail to parse the config
     And the output must contain "config/zassets.yaml"

data/features/engines/coffee.feature

@@ -5,7 +5,7 @@ Feature: CoffeeScript transpiler
       """
       paths:
         - app
-      compile:
+      build:
         - app.js
       """
     And a file named "app/app.coffee" with:

data/features/engines/sass.feature

@@ -5,7 +5,7 @@ Feature: SASS transpiler
       """
       paths:
         - app
-      compile:
+      build:
         - styles/main.css
       """
     And a file named "app/styles/main.sass" with:

data/features/step_definitions/builder_steps.rb

@@ -4,7 +4,7 @@ end
 
 
 When /^I build$/  do
-  run_simple 'zassets compile'
+  run_simple 'zassets build'
 end
 
 
@@ -33,3 +33,9 @@ Then /^the built file "([^"]*)" should match \/([^\/]*)\/$/ do |path, content|
     IO.read(Dir[path].first).should =~ regexp
   end
 end
+
+Then /^it should build$/ do
+  prep_for_fs_check do
+    File.exist?('public/assets/manifest.json').should be_true
+  end
+end

data/lib/zassets.rb

@@ -3,7 +3,7 @@ require 'coffee_script'
 
 module ZAssets
   autoload :CLI,          'zassets/cli'
-  autoload :Compiler,     'zassets/compiler'
+  autoload :Builder,      'zassets/builder'
   autoload :Config,       'zassets/config'
   autoload :MemoryFile,   'zassets/memory_file'
   autoload :Server,       'zassets/server'

data/lib/zassets/{compiler.rb → builder.rb}

@@ -1,7 +1,7 @@
 require 'sprockets'
 
 module ZAssets
-  class Compiler
+  class Builder
     MANIFEST_FILENAME = 'manifest.json'
 
     attr_writer :manifest
@@ -10,8 +10,8 @@ module ZAssets
       @config = config
     end
 
-    def compile
-      manifest.compile(@config[:compile])
+    def build
+      manifest.compile(@config[:build])
     end
 
     def manifest
@@ -19,7 +19,7 @@ module ZAssets
     end
 
     def manifest_path
-      [@config[:compile_path], MANIFEST_FILENAME].join '/'
+      [@config[:build_path], MANIFEST_FILENAME].join '/'
     end
 
     def environment

data/lib/zassets/cli.rb

@@ -2,17 +2,44 @@ require 'optparse'
 
 module ZAssets
   class CLI
-    attr_reader :options
+    ACTIONS = %w(build serve)
+
+    attr_reader :options, :action
 
     def initialize(args, stdout = $stdout)
       @stdout = stdout
-      @options = args_parse! args
+      @action = :build
+      args_parse! args
+    end
+
+    def config
+      @config ||= Config.new @options
+    end
+
+    def run
+      case @action
+      when :serve
+        server.run
+      when :build
+        builder.build
+      end
+    end
+
+    def builder
+      @builder ||= Builder.new config
+    end
+
+    def server
+      @server ||= Server.new config
     end
 
+
+    private
+
     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] [build|serve]"
 
         o.on '-v', '--verbose', 'Enable verbose mode' do |v|
           options[:verbose] = v
@@ -53,35 +80,8 @@ module ZAssets
         exit 64
       end
 
-      if args.last && %w(compile serve).include?(args.last)
-        options[:action] = args.last.to_sym
-      else
-        @stdout.puts parser
-        exit 64
-      end
-
-      options
-    end
-
-    def config
-      @config ||= Config.new @options
-    end
-
-    def run
-      case config[:action]
-      when :serve
-        server.run
-      when :compile
-        compiler.compile
-      end
-    end
-
-    def compiler
-      @compiler ||= Compiler.new config
-    end
-
-    def server
-      @server ||= Server.new config
+      @options  = options
+      @action   = args.last.to_sym if args.last && ACTIONS.include?(args.last)
     end
   end
 end

data/lib/zassets/config.rb

@@ -14,8 +14,8 @@ module ZAssets
       base_url:     '/assets',
       paths:        [],
       public_path:  'public',
-      compile_path: 'public/assets',
-      compile:      []
+      build_path:   'public/assets',
+      build:        []
     }
 
     def initialize(options = {})

data/lib/zassets/version.rb

@@ -1,3 +1,3 @@
 module ZAssets
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/spec/zassets/{compiler_spec.rb → builder_spec.rb}

@@ -1,38 +1,38 @@
 require 'spec_helper'
 
 module ZAssets
-  describe Compiler do
-    let(:config)        { Config.new }
-    subject(:compiler)  { Compiler.new(config) }
+  describe Builder do
+    let(:config)      { Config.new }
+    subject(:builder) { Builder.new(config) }
 
-    describe '#compile' do
+    describe '#build' do
       it 'compiles the manifest' do
-        compiler.manifest = double('manifest')
-        compiler.manifest.should_receive :compile
-        compiler.compile
+        builder.manifest = double('manifest')
+        builder.manifest.should_receive :compile
+        builder.build
       end
     end
 
     describe '#manifest' do
       it 'builds a sprockets manifest' do
         Sprockets::Manifest.should_receive(:new).with(
-          compiler.environment,
-          compiler.manifest_path
+          builder.environment,
+          builder.manifest_path
         )
-        compiler.manifest
+        builder.manifest
       end
 
       it 'returns the sprockets manifest' do
         manifest = double('manifest')
         Sprockets::Manifest.stub(:new) { manifest }
-        compiler.manifest.should == manifest
+        builder.manifest.should == manifest
       end
     end
 
     describe '#manifest_path' do
       it 'returns the manifest file path' do
-        compiler.manifest_path.should == File.join(
-          config[:compile_path],
+        builder.manifest_path.should == File.join(
+          config[:build_path],
           'manifest.json'
         )
       end
@@ -41,13 +41,13 @@ module ZAssets
     describe '#environment' do
       it 'builds a sprockets env' do
         SprocketsEnv.should_receive(:new).with(config)
-        compiler.environment
+        builder.environment
       end
 
       it 'returns the sprockets env' do
         environment = double('environment')
         SprocketsEnv.stub(:new) { environment }
-        compiler.environment.should == environment
+        builder.environment.should == environment
       end
     end
   end

data/spec/zassets/cli_spec.rb

@@ -5,78 +5,94 @@ module ZAssets
     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]
+    describe '#initialize' do
+      context 'action arguments parsing' do
+        it 'parses the action' do
+          cli.action.should == :serve
         end
-      end
 
-      it 'parses the -v option' do
-        with_option('-v').options[:verbose].should be_true
-      end
+        context 'when action is not provided' do
+          let(:args) { [] }
 
-      it 'parses the -c option' do
-        with_option('-c', 'config').options[:config_file].should == 'config'
+          it 'defaults to build' do
+            cli.action.should == :build
+          end
+        end
       end
 
-      it 'parses the -o option' do
-        with_option('-o', '::0').options[:host].should == '::0'
-      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 -p option' do
-        with_option('-p', '9393').options[:port].should == '9393'
-      end
+        it 'parses the -v option' do
+          with_option('-v').options[:verbose].should be_true
+        end
 
-      it 'parses the -s option' do
-        with_option('-s', 'thin').options[:server].should == 'thin'
-      end
+        it 'parses the -c option' do
+          with_option('-c', 'config').options[:config_file].should == 'config'
+        end
 
-      context '-h option' do
-        let(:args)    { ['-h'] }
-        let(:output)  { StringIO.new }
-        subject(:cli) { CLI.new(args, output) }
+        it 'parses the -o option' do
+          with_option('-o', '::0').options[:host].should == '::0'
+        end
 
-        it 'prints the usage help' do
-          begin
-            cli
-          rescue SystemExit
-          end
-          output.string.should =~ /\AUsage: /
+        it 'parses the -p option' do
+          with_option('-p', '9393').options[:port].should == '9393'
         end
 
-        it 'exits' do
-          lambda { cli }.should raise_error SystemExit
+        it 'parses the -s option' do
+          with_option('-s', 'thin').options[:server].should == 'thin'
         end
-      end
 
-      context '-V option' do
-        let(:args)    { ['-V'] }
-        let(:output)  { StringIO.new }
-        subject(:cli) { CLI.new(args, output) }
+        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 'prints the version' do
-          begin
-            cli
-          rescue SystemExit
+          it 'exits' do
+            lambda { cli }.should raise_error SystemExit
           end
-          output.string.chomp.should == VERSION
         end
 
-        it 'exits' do
-          lambda { cli }.should raise_error SystemExit
+        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
     end
 
+    describe '#action' do
+      it 'return the current action' do
+        cli.action.should == args.last.to_sym
+      end
+    end
+
     describe '#config' do
       it 'builds a config' do
         Config.should_receive(:new).with(cli.options)
@@ -100,28 +116,28 @@ module ZAssets
         end
       end
 
-      context 'compiler action' do
-        let(:args) { ['compile'] }
+      context 'build action' do
+        let(:args) { ['build'] }
 
-        it 'runs the compiler' do
-          compiler = double('compiler')
-          cli.stub(:compiler) { compiler }
-          compiler.should_receive :compile
+        it 'runs the builder' do
+          builder = double('builder')
+          cli.stub(:builder) { builder }
+          builder.should_receive :build
           cli.run
         end
       end
     end
 
-    describe '#compiler' do
-      it 'builds a compiler' do
-        Compiler.should_receive(:new).with(cli.config)
-        cli.compiler
+    describe '#builder' do
+      it 'builds a builder' do
+        Builder.should_receive(:new).with(cli.config)
+        cli.builder
       end
 
-      it 'returns the compiler' do
-        compiler = double('compiler')
-        Compiler.stub(:new) { compiler }
-        cli.compiler.should == compiler
+      it 'returns the builder' do
+        builder = double('builder')
+        Builder.stub(:new) { builder }
+        cli.builder.should == builder
       end
     end
 

data/spec/zassets/config_spec.rb

@@ -67,12 +67,12 @@ module ZAssets
         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'
+      it 'sets build_path to public/assets directory' do
+        config.default_options[:build_path].should == 'public/assets'
       end
 
-      it 'sets compile empty' do
-        config.default_options[:compile].should == []
+      it 'sets build empty' do
+        config.default_options[:build].should == []
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zassets
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -189,6 +189,7 @@ files:
 - bin/zassets
 - features/builder/build.feature
 - features/builder/manifest.feature
+- features/cli/default_action.feature
 - features/cli/usage.feature
 - features/cli/version.feature
 - features/config/file.feature
@@ -208,8 +209,8 @@ files:
 - features/support/env_cucumber-doc_string.rb
 - features/support/env_server.rb
 - lib/zassets.rb
+- lib/zassets/builder.rb
 - lib/zassets/cli.rb
-- lib/zassets/compiler.rb
 - lib/zassets/config.rb
 - lib/zassets/exceptions.rb
 - lib/zassets/memory_file.rb
@@ -223,8 +224,8 @@ files:
 - spec/spec_helper.rb
 - spec/support/fixtures_helpers.rb
 - spec/zassets-plugins-dummy.rb
+- spec/zassets/builder_spec.rb
 - spec/zassets/cli_spec.rb
-- spec/zassets/compiler_spec.rb
 - spec/zassets/config_spec.rb
 - spec/zassets/memory_file_spec.rb
 - spec/zassets/server_spec.rb
@@ -253,7 +254,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: zassets-0.2.3
+summary: zassets-0.2.4
 test_files:
 - spec/fixtures/assets/app.js
 - spec/fixtures/config/zassets.yaml
@@ -262,8 +263,8 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/fixtures_helpers.rb
 - spec/zassets-plugins-dummy.rb
+- spec/zassets/builder_spec.rb
 - spec/zassets/cli_spec.rb
-- spec/zassets/compiler_spec.rb
 - spec/zassets/config_spec.rb
 - spec/zassets/memory_file_spec.rb
 - spec/zassets/server_spec.rb