work-bench 1.0.7 → 1.0.8

data/lib/work_bench/application.rb

@@ -1,11 +1,14 @@
 module Workbench
 
+  # Web-server class
 	class Application
 
 		attr_reader :app
 
+    # Initialize class
+    #
+    # @param [String] path path to working directory
 		def initialize path
-
 			@app = Rack::Builder.new {
 				use Rack::Reloader, 0
 				use Rack::CommonLogger
@@ -36,6 +39,10 @@ module Workbench
 			}.to_app
 		end
 
+    # Start Unicorn server
+    #
+    # @param port [Numeric] port number
+    # @param workers [Number] workers count
 		def start port, workers
 			Unicorn::HttpServer.new(@app, {
 				:listeners => [port],

data/lib/work_bench/cli.rb

@@ -1,5 +1,6 @@
 module Workbench
 
+  # CLI application for Workbench
 	class Cli < Thor
 
 		include Thor::Actions
@@ -10,6 +11,16 @@ module Workbench
 			File.join(File.dirname(__FILE__), '..', '..', 'template')
 		end
 
+    # Start Unicorn server
+    #
+    # @param [String] path path to new project directory
+    #
+    # @example
+    #  workbench start
+    #
+    # @example
+    #  workbench start project/
+    #
 		desc 'start [PATH] [--port] [--workers]', 'Start server in current directory'
 		long_desc 'Start server in current directory'
 		method_option :port, :aliases => '-p', :type => :numeric, :default => 4000, :desc => 'Port'
@@ -21,6 +32,16 @@ module Workbench
       app.start options[:port], options[:workers]
 		end
 
+    # Create empty project from template in current directory or specific path
+    #
+    # @param [String] path path to new project directory
+    #
+    # @example
+    #  workbench init
+    #
+    # @example
+    #  workbench init project/
+    #
 		desc 'init [PATH] [--js=frameworks]', 'Initialize empty project in current directory'
 		long_desc 'Initialize empty project in current directory'
 		method_option :js, :type => :array, :default => ['jquery'], :desc => 'Install specific JS frameworks', :banner => 'jquery jquery-ui json'
@@ -42,9 +63,9 @@ module Workbench
 
 			unless options[:js].include? 'jquery'
 				options[:js].push('jquery')
-			end
+      end
 
-			js_libs = Workbench::JSLibs.list
+			js_libs = Workbench::JSLibs::LIST
 			options[:js].each do |js|
 				if js_libs[js]
 					get js_libs[js], "public/js/#{File.basename(js_libs[js])}"
@@ -57,25 +78,35 @@ module Workbench
 			copy_file 'Gemfile', 'Gemfile'
 		end
 
-		desc 'js', 'Show available frameworks'
-		def js
-			js_libs = Workbench::JSLibs.list
-      puts 'Available JS library'
-      js_libs.each do |index, item|
-        puts " * #{index} => #{item}"
-      end
-		end
-
+    # Export project to specific directory
+    #
+    # @param [String] path export directory
 		desc 'export [PATH]', 'Export project'
 		method_option :fix, :type => :boolean, :desc => 'Fix relative urls'
 		def export path = 'export'
-			export = Workbench::Exporter.new $root, File.join($root, path), options[:fix]
+  		export = Workbench::Exporter.new File.expand_path('.'), File.join(File.expand_path('.'), path), options[:fix]
 			export.process
 		end
 
+    # Get available JS frameworks
+    #
+    # @example
+    #  workbench js
+    #
+    desc 'js', 'Show available JS frameworks'
+    def js
+      puts 'Available JS frameworks'.color(:green)
+      Workbench::JSLibs::LIST.each { |index, item| puts " * #{index.color(:blue)} => #{item}" }
+    end
+
+    # Get version number
+    #
+    # @example
+    #  workbench version
+    #
 		desc 'version', 'Show gem version'
 		def version
-			puts "Version: #{Workbench::VERSION}"
+			puts "Version: #{Workbench::VERSION.color(:blue)}"
 		end
 
 	end

data/lib/work_bench/dependencies.rb

@@ -5,3 +5,4 @@ require 'compass'
 require 'rack/contrib'
 require 'rack/test'
 require 'thor'
+require 'rainbow'

data/lib/work_bench/exporter.rb

@@ -1,16 +1,21 @@
 module Workbench
 
+  # Export project to specific directory
 	class Exporter
 
-		def initialize src, dest, fix = false
+    # @param [String] src source directory
+    # @param [String] dst destination directory
+    # @param [Boolean] fix fix relative url
+		def initialize src, dst, fix = false
 			@fix = fix
 			@src = src
-			@dest = dest
-			@browser = Rack::Test::Session.new(Rack::MockSession.new(Workbench::Application.new.app))
+			@dst = dst
+			@browser = Rack::Test::Session.new(Rack::MockSession.new(Workbench::Application.new(src).app))
 		end
 
+    # Process export
 		def process
-			puts 'Export project'
+			puts 'Exporting project'.color(:green)
 			compile_sass
 			copy_public_folder
 			copy_views
@@ -18,6 +23,10 @@ module Workbench
 
 		private
 
+      # Save file to filesystem
+      #
+      # @param [String] path path to file
+      # @param [String] content file content
 			def save_file path, content
 				if @fix
 					content = content.gsub "url('/", "url('"
@@ -27,16 +36,23 @@ module Workbench
 				File.open(path, 'w+') { |f| f.puts content }
 			end
 
+      # Log action to STDOUT
+      #
+      # @param msg [String] message
 			def log_action msg
 				puts '=> ' + msg
 			end
 
+      # Virtually get URL without starting server
+      #
+      # @param [String] path path to file
 			def get_url path
 				@browser.get path, {}, {'REQUEST_URI' => ['http://example.org', path].join('/')}
 				response = @browser.last_response
 				response.body
 			end
 
+      # Compile SASS directory
 			def compile_sass
 				sass_files = get_file_list 'sass'
 				sass_files.each do |file|
@@ -47,29 +63,35 @@ module Workbench
 				end
 			end
 
+      # Export Public folder content
 			def copy_public_folder
-				FileUtils.mkdir(@dest) unless Dir.exist? @dest
+				FileUtils.mkdir(@dst) unless Dir.exist? @dst
 				file_list = get_file_list 'public'
 				file_list.each do |filename|
-					dirname =  File.join(@dest, File.dirname(filename))
+					dirname =  File.join(@dst, File.dirname(filename))
 					FileUtils.mkdir_p(dirname) unless Dir.exist? dirname
-					FileUtils.cp( File.join(@src, 'public', filename), File.join(@dest, filename))
-					log_action "Copy #{filename}"
+					FileUtils.cp( File.join(@src, 'public', filename), File.join(@dst, filename))
+					log_action "Copy #{filename.color(:blue)}"
 				end
 			end
 
+      # Parse views and compile to export folder
 			def copy_views
 				file_list = get_file_list 'haml'
 				file_list.each do |filename|
 					body = get_url filename
 					filename = filename.gsub('.haml', '.html')
-					dirname = File.dirname(File.join(@dest, filename))
+					dirname = File.dirname(File.join(@dst, filename))
 					FileUtils.mkdir_p(dirname) unless Dir.exist? dirname
-					save_file "#{@dest}/#{filename}", body
-					log_action "Copy #{filename}"
+					save_file "#{@dst}/#{filename}", body
+					log_action "Copy #{filename.color(:blue)}"
 				end
 			end
 
+      # Recursively get file list
+      #
+      # @param [String] relative_path path to directory
+      # @return [Array] file list
 			def get_file_list relative_path
 				path = File.join(@src, relative_path)
 				result = nil

data/lib/work_bench/haml_renderer.rb

@@ -1,8 +1,9 @@
 module Workbench
 
+  # Parse HAML file with options
   class HamlRenderer
 
-    @options = {
+    DEFAULT_HAML_OPTIONS = {
       :escape_attrs => true,
       :attr_wrapper => '"',
       :format => :html4
@@ -10,9 +11,6 @@ module Workbench
 
     class << self
 
-      # @return [Hash] the list of options
-      attr_accessor :options
-
       # Parse HAML file with options
       #
       # @param [String] filename path to file
@@ -23,8 +21,7 @@ module Workbench
       #   result = Workbench::HamlRenderer.render 'index.haml', { :attr_wrapper => "'", :escape_attrs => false }
       #
       def render filename, options = {}
-        options = @options.merge(options)
-        Haml::Engine.new(File.read(filename), options).render
+        Haml::Engine.new(File.read(filename), DEFAULT_HAML_OPTIONS.merge(options)).render
       end
 
     end

data/lib/work_bench/js_libs.rb

@@ -1,17 +1,16 @@
 module Workbench
 
-	class JSLibs
+  # Available JS libraries
+  class JSLibs
 
-		def self.list
-			{
-				'jquery' 				=> 'http://code.jquery.com/jquery.js', # latest jQuery
-				'jquery-ui' 		=> 'http://yandex.st/jquery-ui/1.8.16/jquery-ui.js',
-				'jquery-cookie' => 'http://yandex.st/jquery/cookie/1.0/jquery.cookie.js',
-				'jquery-easing' => 'http://yandex.st/jquery/easing/1.3/jquery.easing.js',
-				'json' 					=> 'http://yandex.st/json2/2011-01-18/json2.js'
-			}
-		end
+    LIST = {
+        'jquery'        => 'http://code.jquery.com/jquery.js', # latest jQuery
+        'jquery-ui'     => 'http://yandex.st/jquery-ui/1.8.16/jquery-ui.js',
+        'jquery-cookie' => 'http://yandex.st/jquery/cookie/1.0/jquery.cookie.js',
+        'jquery-easing' => 'http://yandex.st/jquery/easing/1.3/jquery.easing.js',
+        'json'          => 'http://yandex.st/json2/2011-01-18/json2.js'
+      }
 
-	end
+  end
 
 end

data/lib/work_bench/version.rb

@@ -1,3 +1,3 @@
 module Workbench
-  VERSION = "1.0.7"
+  VERSION = "1.0.8"
 end

data/spec/cli_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Workbench::Cli do
+
+  describe '#version' do
+
+    it 'вернуть номер версии' do
+      capture(:stdout){ Workbench::Cli.start(['version']) }.should =~ /Version: #{Workbench::VERSION}/
+    end
+
+  end
+
+  describe '#js' do
+
+    it 'вернуть список JSбиблиотек' do
+      capture(:stdout){ Workbench::Cli.start(['js']) }.should =~ /jquery =>/
+    end
+
+  end
+
+end

data/spec/haml_renderer_spec.rb

@@ -7,12 +7,12 @@ describe Workbench::HamlRenderer do
     @root = File.dirname(__FILE__) + '/fixtures'
   end
 
-  it 'должен рендерить HAML файл' do
+  it 'HAML файл' do
     result = Workbench::HamlRenderer.render "#{@root}/index.haml"
     result.should == "<h1 style=\"color: red\" title=\"&amp;\">Hello world!</h1>\n"
   end
 
-  it 'должен рендерить HAML файл с указанными опциями' do
+  it 'файл с опциями' do
     result = Workbench::HamlRenderer.render "#{@root}/index.haml", { :attr_wrapper => "'", :escape_attrs => false }
     result.should == "<h1 style='color: red' title='&'>Hello world!</h1>\n"
   end

data/spec/spec_helper.rb

@@ -4,3 +4,24 @@ require 'rubygems'
 
 require 'work_bench'
 require 'rspec'
+require 'stringio'
+
+RSpec.configure do |config|
+
+  config.before :each do
+    ARGV.replace []
+  end
+
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+    result
+  end
+
+end

data/template/index.haml

@@ -3,7 +3,7 @@
 	%head
 		%meta{:content => "text/html; charset=utf-8", "http-equiv" => "Content-Type"}
 		%title Example project
-		<%- l = Workbench::JSLibs.list -%>
+		<%- l = Workbench::JSLibs::LIST -%>
 		<%- unless options[:js].empty? then -%>
 		<%- options[:js].each do |lib| -%>
 		%script{:src => "/js/<%= File.basename(l[lib]) %>", :type => "text/javascript"}

data/work_bench.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |s|
 	s.add_dependency "rack-cache"
 	s.add_dependency "rack-contrib"
 	s.add_dependency "thor"
+  s.add_dependency "rainbow"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: work-bench
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-11 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70227779148420 !ruby/object:Gem::Requirement
+  requirement: &70319118173280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70227779148420
+  version_requirements: *70319118173280
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &70227779147860 !ruby/object:Gem::Requirement
+  requirement: &70319118172120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70227779147860
+  version_requirements: *70319118172120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70227779147420 !ruby/object:Gem::Requirement
+  requirement: &70319118170800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70227779147420
+  version_requirements: *70319118170800
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70227779146960 !ruby/object:Gem::Requirement
+  requirement: &70319118169380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227779146960
+  version_requirements: *70319118169380
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70227779146460 !ruby/object:Gem::Requirement
+  requirement: &70319118163920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227779146460
+  version_requirements: *70319118163920
 - !ruby/object:Gem::Dependency
   name: unicorn
-  requirement: &70227779145940 !ruby/object:Gem::Requirement
+  requirement: &70319118162960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227779145940
+  version_requirements: *70319118162960
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70227779145380 !ruby/object:Gem::Requirement
+  requirement: &70319118161700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227779145380
+  version_requirements: *70319118161700
 - !ruby/object:Gem::Dependency
   name: compass
-  requirement: &70227779144700 !ruby/object:Gem::Requirement
+  requirement: &70319118160680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227779144700
+  version_requirements: *70319118160680
 - !ruby/object:Gem::Dependency
   name: rack-cache
-  requirement: &70227779142920 !ruby/object:Gem::Requirement
+  requirement: &70319118159740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227779142920
+  version_requirements: *70319118159740
 - !ruby/object:Gem::Dependency
   name: rack-contrib
-  requirement: &70227779142460 !ruby/object:Gem::Requirement
+  requirement: &70319118159060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227779142460
+  version_requirements: *70319118159060
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70227779141900 !ruby/object:Gem::Requirement
+  requirement: &70319118158220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227779141900
+  version_requirements: *70319118158220
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: &70319118157720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70319118157720
 description: A quick and simple local web server for prototyping web applications
   with HAML, SASS and Compass support.
 email: konstantin.savelyev@gmail.com
@@ -156,6 +167,7 @@ files:
 - lib/work_bench/js_libs.rb
 - lib/work_bench/server.rb
 - lib/work_bench/version.rb
+- spec/cli_spec.rb
 - spec/fixtures/index.haml
 - spec/haml_renderer_spec.rb
 - spec/spec_helper.rb
@@ -191,6 +203,7 @@ specification_version: 3
 summary: A quick and simple local web server for prototyping web applications with
   HAML, SASS and Compass support.
 test_files:
+- spec/cli_spec.rb
 - spec/fixtures/index.haml
 - spec/haml_renderer_spec.rb
 - spec/spec_helper.rb