bpm 1.0.0.beta.13 → 1.0.0.rc.1

data/lib/bpm/server.rb

@@ -4,20 +4,27 @@ require 'sprockets'
 module BPM
 
   class Server < Rack::Server
-    
-    def initialize(project, options=nil)
+
+    def initialize(project, options={})
+      options = default_options.merge(options)
       @project = project
-      @mode    = (options && options[:mode]) || :debug 
+      @mode    = options[:mode] || :debug
       super options
     end
-    
+
     def self.start(project, options=nil)
       new(project, options).start
     end
-    
+
+    def start
+      super
+    rescue Errno::EADDRINUSE
+      raise BPM::Error, "Port #{options[:Port]} is already in use. Please use --port to specify a different port."
+    end
+
     attr_reader :project
     attr_reader :mode
-    
+
     def app
       cur_project = @project
       cur_mode    = @mode
@@ -26,13 +33,11 @@ module BPM
         map '/assets' do
           run BPM::Pipeline.new cur_project, cur_mode, true
         end
-        
+
         map '/' do
           run Rack::Directory.new cur_project.root_path
         end
-        
       end.to_app
     end
-    
   end
 end

data/lib/bpm/version.rb

@@ -1,4 +1,4 @@
 module BPM
-  VERSION = "1.0.0.beta.13"
+  VERSION = "1.0.0.rc.1"
   COMPAT_VERSION = '1.0.0'
 end

data/man/bpm.1.ronn

@@ -7,18 +7,120 @@ bpm(1) -- browser package manager
 
 ## DESCRIPTION
 
-## WORKFLOW
+bpm is a package manager for browser-based applications.  It is based 
+loosely on npm (node package manager), but designed to handle all the 
+different types of assets and optimizations you will need for the web 
+including packaging and minifying JavaScript as well as handling CSS and 
+image assets.
 
-bpm init | bpm new - create the new project
-bpm add spade - adds the dependency, fetches, compiles.
-bpm remove spade - removes the dependency, compiles
+You can use bpm both to manage the dependencies of an application you are
+building and to publish libraries of code for others to use.  This manual
+page will explain to you how to use bpm both different ways.
 
-bpm fetch - fetches any dependencies locally
-bpm compile - rebuilds the project; uses any current dependencies 
-bpm preview - allows you to preview the files. creates any needed files
+## GETTING STARTED (WITH AN EXISTING PROJECT)
 
+The most common way to use bpm is to manage the dependencies of your 
+application.  To configure bpm for an existing project, just cd into the project directory
+and type:
 
-## DISCUSSION
+    bpm init
+  
+This will setup a new project JSON file as well as create an empty set of 
+asset files in the `assets` directory of your project.  Inside of that 
+directory you will find two key files: `bpm_libs.js` and `bpm_styles.css`.
+
+These files will contain the JavaScript and CSS styles for all of your 
+dependencies, respectively.  Make sure you modify any HTML files to reference
+these two files so they load.  Typically you will want both files to load 
+before other JavaScript or CSS files in your page.
+
+As you add dependencies, additional assets may appear in this directory,
+including images.
+
+Now that you have setup your project, you can start adding dependencies.  See
+(ADDING DEPENDENCIES) below.
+
+## GETTING STARTED (WITH A NEW APP)
+
+If you are starting a new project, you can also use bpm to create your new
+project with:
+
+    bpm init [PROJECT_NAME]
+
+This will create a new project with the name that you gave it based on the
+HTML5 Boilerplate template.
+
+Your new project will also contain an assets directory that contains 
+`bpm_libs.js` and `bpm_styles.css` files.  These must be loaded in your HTML
+file for your dependencies to load.  The default index.html created by bpm
+will already do this for you.
+
+## ADDING AND REMOVING DEPENDENCIES
+
+Once you have configured your application, you can add and remove dependencies using the `bpm add` and `bpm remove` commands.  For example, to add jquery to
+your project just type:
+
+    bpm add jquery
+    
+This will fetch the jquery package and any dependencies (if they exist) and
+then rebuild the files in the `assets` directory.  Once the add is complete 
+bpm should display the new total file sizes of the files it built.  This 
+size represents the size after minification (if there is any) and gzipped.
+
+For more information on adding dependencies see the `bpm-add` manual.
+
+You can also remove dependencies by using the `bpm remove` command.  Just name
+the package you want to remove and all the assets will be rebuilt for you.
+For example:
+
+    bpm remove jquery
+    
+Would remove jquery from your project (if it was already added).  Calling
+bpm remove with the same package multiple times has no effect.
+
+For more information on remove dependencies see the `bpm-remove` manual.
+
+## MANAGING YOUR APP ITSELF
+
+In addition to handling dependencies, bpm can also be used to build your 
+actual app JavaScript and CSS.  To do this, you just need to run:
+
+    bpm init --app
+    
+Note that when you create new projects with bpm, the app will already be 
+built.
+
+The default configuration for this setup will build any JavaScript found in
+a `lib` directory in the root of your project and any CSS found in a `css`
+directory in the root of your project. You can change these settings by 
+modifying the project JSON.
+
+## PREVIEWING
+
+Sometimes while hacking on your app - especially if you are using BPM to
+build the app itself, you will want to see your changes in the browser 
+without having to constantly rebuild your app.  To do this you can use the
+`bpm preview` command.  
+
+Run this command from the root of your project and it will start a server on
+port 4020 that will simply load the files found in your project.  Any of the
+files found in the assets folder, however, will be automatically rebuilt from
+your installed packages on demand.  They will also be built in debug mode
+which means you will be able to see code uniminified, making things 
+far easier to debug.
+
+As an example, if you created a new app using bpm and then used bpm preview,
+you could just visit:
+
+    http://localhost:4020/index.html
+    
+To actually load the app in your browser.
+
+## REBUILDING
+
+If you have modified your app and you are ready to release it, you may want
+to do a new build in bpm to get the latest code.  You can use the
+`bpm rebuild` command for this.
 
 ## COPYRIGHT
 
@@ -26,6 +128,7 @@ bpm preview - allows you to preview the files. creates any needed files
 
 ## SEE ALSO
 
-bpm-add(1)  bpm-remove(1)
+bpm-add(1)  bpm-remove(1) bpm-rebuild(1) bpm-preview(1)
+
 
 

data/spec/cli/add_spec.rb

@@ -50,14 +50,14 @@ describe 'bpm add' do
     output.should include("Added package 'coffee' (1.0.1.pre)")
     output.should include("Added package 'jquery' (1.4.3)")
 
-    has_dependency 'coffee', '1.0.1.pre', '>= 0-pre'
+    has_dependency 'coffee', '1.0.1.pre', '>= 0.pre'
     has_soft_dependency 'jquery', '1.4.3'
   end
 
   it "adds no packages when any are invalid" do
     bpm "add", "jquery", "fake", :track_stderr => true
 
-    stderr.read.should == "Could not find eligible package for 'fake' (>= 0)\n"
+    stderr.read.should include("Could not find eligible package for 'fake' (>= 0)")
 
     no_dependency 'jquery'
     no_dependency 'fake'
@@ -66,7 +66,7 @@ describe 'bpm add' do
   it "fails when adding invalid package" do
     bpm "add", "fake", :track_stderr => true
 
-    stderr.read.should == "Could not find eligible package for 'fake' (>= 0)\n"
+    stderr.read.should include("Could not find eligible package for 'fake' (>= 0)")
     no_dependency 'fake'
   end
 
@@ -95,7 +95,6 @@ describe 'bpm add' do
     wait
     has_dependency 'rake', '0.8.6', '0.8.6' # precond
 
-    output = stdout.read
     bpm 'add', 'rake'
     wait
 
@@ -111,13 +110,13 @@ describe 'bpm add' do
     wait
     output = stdout.read
     output.should include("Added package 'bundler' (1.1.pre)")
-    has_dependency 'bundler', '1.1.pre', '>= 0-pre'
+    has_dependency 'bundler', '1.1.pre', '>= 0.pre'
   end
 
   it "does not add the normal package when asking for a prerelease" do
     bpm "add", "rake", "--pre", :track_stderr => true
     wait
-    stderr.read.should == "Could not find eligible package for 'rake' (>= 0-pre)\n"
+    stderr.read.should include("Could not find eligible package for 'rake' (>= 0.pre)")
     no_dependency 'rake'
   end
 
@@ -154,6 +153,16 @@ describe 'bpm add' do
     no_dependency 'custom_package'
   end
 
+  it "should add local prerelease package" do
+    no_dependency 'prerelease_package'
+
+    bpm "add", "prerelease_package", "--pre"
+    output = stdout.read
+
+    output.should include("Using local package 'prerelease_package'")
+    has_dependency 'prerelease_package', '1.0.0.pre', '>= 0.pre'
+  end
+
   it "should work with .bpkg file" do
     FileUtils.cp fixtures('gems', "custom_generator-1.0.bpkg"), '.'
     bpm "add", "custom_generator-1.0.bpkg" and wait

data/spec/cli/init_spec.rb

@@ -126,11 +126,11 @@ describe "bpm init on a non-existant directory" do
 
       files.each do |file|
         output.should =~ /create\s+#{file}$/
-        home("bpm_test", *file.split('/')).should exist
+        home("BpmTest", *file.split('/')).should exist
       end
 
       generated_files.each do |file|
-        home('bpm_test', *file.split('/')).should exist
+        home('BpmTest', *file.split('/')).should exist
       end
     end
 
@@ -140,7 +140,7 @@ describe "bpm init on a non-existant directory" do
       home("DifferentLocation").should exist
       home("DifferentLocation", "BpmTest.json").should exist
       home("DifferentLocation", "DifferentLocation.json").should_not exist
-      home("bpm_test").should_not exist
+      home("BpmTest").should_not exist
     end
 
   end
@@ -166,20 +166,20 @@ describe "bpm init on a non-existant directory" do
 
         files.each do |file|
           output.should =~ /create\s+#{file}$/
-          home("bpm_test", file).should exist
+          home("BpmTest", file).should exist
         end
       end
 
       it "should create custom app.js with explicit generator" do
         bpm 'init', 'BpmTest', '--package=custom_generator' and wait
 
-        File.read(home("bpm_test", "app.js")).should == "require('BpmTest/main.js')\n"
+        File.read(home("BpmTest", "app.js")).should == "require('BpmTest/main.js')\n"
       end
 
       it "should create custom project.json without explicit generator" do
         bpm 'init', 'BpmTest', '--package=core-test' and wait
 
-        File.read(home("bpm_test", "BpmTest.json")).should =~ /"core-test": "0.4.9"/
+        File.read(home("BpmTest", "BpmTest.json")).should =~ /"core-test": "0.4.9"/
       end
 
     end
@@ -196,7 +196,7 @@ describe "bpm init on a non-existant directory" do
       it "should add package as a dependency even if it doesn't have custom generator" do
         bpm 'init', 'BpmTest', '--package=jquery' and wait
 
-        File.read(home("bpm_test", "BpmTest.json")).should =~ /"dependencies": {\n\s+"jquery": "1.4.3"\n\s+}/
+        File.read(home("BpmTest", "BpmTest.json")).should =~ /"dependencies": {\n\s+"jquery": "1.4.3"\n\s+}/
       end
 
     end

data/spec/cli/pack_spec.rb

@@ -25,6 +25,16 @@ describe "bpm pack" do
       package.spec.version.should == LibGems::Version.new("0.4.9")
       package.spec.email.should == email
     end
+
+    it "should not complain about different directories" do
+      FileUtils.cp_r package_fixture("core-test"), "custom-path"
+      cd "custom-path"
+      bpm "pack"
+
+      exit_status.should be_success
+      stdout.read.should include("Successfully built package: core-test-0.4.9.bpkg")
+    end
+
   end
   
   describe "without logging in" do
@@ -99,11 +109,6 @@ describe "bpm pack" do
       exit_status.should be_success
     end
   
-    it "implies the summary field" do
-      package = LibGems::Format.from_file_by_path("backbone-0.5.1.bpkg")
-      package.spec.summary.should == package.spec.description
-    end
-  
     it "gets name and version" do
       package = LibGems::Format.from_file_by_path("backbone-0.5.1.bpkg")
       package.spec.name.should == "backbone"
@@ -120,11 +125,11 @@ describe "bpm pack" do
   describe "package with plugins" do
     before do
       goto_home
-      FileUtils.cp_r project_fixture('coffee', 'packages'), '.'
+      FileUtils.cp_r project_fixture('coffee', 'vendor'), '.'
     end
     
     it "should pack transports" do
-      cd home('packages', 'spade')
+      cd home('vendor', 'spade')
       bpm "pack" and wait
       puts stdout.read
       exit_status.should be_success
@@ -137,4 +142,4 @@ describe "bpm pack" do
   
 end
 
-    
+    

data/spec/cli/preview_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe "bpm preview" do
+
+  it "should work"
+
+  it "should preserve json settings"
+  # i.e. spade:format
+
+end

data/spec/cli/rebuild_spec.rb

@@ -52,7 +52,7 @@ EOF
 
     def test_include(does_include, build_file, *source_file)
       contents_path = home('hello_dev', 'assets', build_file)
-      expected_path = home('hello_dev', *source_file)
+      expected_path = home(*source_file)
 
       if does_include
         File.read(contents_path).should include(File.read(expected_path))
@@ -66,20 +66,20 @@ EOF
 
       js_reg = [
         # fetch regular dependency
-        %w(.bpm packages spade lib main.js)
+        %w(.bpm gems spade-0.5.0 lib main.js)
       ]
 
       js_dev = [
         # fetched development dependency
-        %w(.bpm packages uglify-js lib parse-js.js),
+        %w(.bpm gems uglify-js-1.0.4 lib parse-js.js),
 
         # required dependency of development dependency
-        %w(.bpm packages optparse lib optparse.js)
+        %w(.bpm gems optparse-1.0.1 lib optparse.js)
       ]
 
       css_dev = [
         # css of a locally installed development dependency
-        %w(packages style_package css some_style.css)
+        %w(hello_dev vendor style_package css some_style.css)
       ]
 
       if should_include

data/spec/cli/remove_spec.rb

@@ -75,7 +75,7 @@ describe 'bpm remove' do
     output = stdout.read
     
     no_dependency 'custom_package'
-    File.exists?(home('hello_world', 'packages', 'custom_package', 'package.json')).should be_true
+    File.exists?(home('hello_world', 'vendor', 'custom_package', 'package.json')).should be_true
   end
   
   it "should remove development dependencies"

data/spec/fixtures/packages/backbone/package.json

@@ -1,7 +1,7 @@
 {
   "name"          : "backbone",
-  "description"   : "Give your JS App some Backbone with Models, Views, Collections, and Events.",
-  "url"           : "http://documentcloud.github.com/backbone/",
+  "summary"       : "Give your JS App some Backbone with Models, Views, Collections, and Events.",
+  "homepage"      : "http://documentcloud.github.com/backbone/",
   "keywords"      : ["util", "functional", "server", "client", "browser"],
   "author"        : "Jeremy Ashkenas <jeremy@documentcloud.org>",
   "contributors"  : [],

data/spec/fixtures/packages/core-test/package.json

@@ -39,7 +39,7 @@
   
   "bpm:build": {
     "bpm_styles.css": {
-      "directories": ["resources"]
+      "files": ["resources"]
     },
     
     "core-test": {

data/spec/fixtures/projects/coffee/coffee.json

@@ -3,14 +3,14 @@
   "bpm":  "1.0.0",
   
   "dependencies": {
-    "spade":         "~> 1.0.0",
-    "coffee-script": "~> 1.0.0",
-    "handlebars":    "~> 1.0.0"
+    "coffee-script":    "~> 1.0.0",
+    "spade-handlebars": "~> 1.0.0",
+    "spade":            "~> 1.0.0"
   },
   
   "bpm:build": {
     "bpm_libs.js": {
-      "directories": ["lib", "templates"]
+      "files": ["lib", "templates"]
     }
   }
 }