bpm 0.1.4 → 1.0.0.beta.4

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+
+  * Fixed issue with compile that would cause exceptions if you deleted the
+    global .bpm directory
+  * BPM now complains if you load a package whose directory name does not 
+    match the name in the package.json (this was causing exceptions in some
+    cases)
+  * BPM is more whiny now when it tries to load a package with invalid or
+    missing package.json.
+  * the version stored in the `bpm` key on new projects is a compatible 
+    version instead of the actual version.  Right now this means it is frozen
+    at 1.0.0
+  * merge `bpm new` into `bpm init`.  now this works like git.  If you
+    `bpm init` on an existing directory, bpm will try to update it.  If you
+    `bpm init` and pass a new path, bpm will create it.
+  * now showing version of bpm in bpm help
+
+# 1.0.0.beta.3.pre
+
+  * started changelog
+  

data/README.md

@@ -28,7 +28,7 @@ Then add jquery as a dependency:
 
     bpm add jquery
     
-This will create a file called `assets/bpm_packages.js` which will include
+This will create a file called `assets/bpm_libs` which will include
 jquery.  You can then create an index.html and reference that js.  Everytime
 you add a dependency, it will be based into this JS file . 
 

data/TODO.md

@@ -1,4 +1,92 @@
 
-* Better support for using plugins during builds.  Ideal solution would create a .js file for each plugin and load it in a separate context.  This would  allow each plugin to actually require other dependencies, etc.  This is required to properly support format plugins.
+* you should be able to place other projects into a vendor directory and 
+  have their packages appear.
 
-* Development dependencies
+* Multiple format support.  Format processors supplied by dependencies should
+  be used to resolve formats.
+  
+* minify then transport -> this will allow for string loading.
+
+* HTML manifest support [in general we need a way for packages to generate new assets]
+
+* cache-friendly URLs
+
+* HTML files should be able to process as templates using a template plugin
+
+* Should log clearly when fetching from remotes
+
+* Can we use YAML instead of JSON?
+
+* Changing a dependency in a package.json should rebuild all files in preview mode (in case the transport was modified)
+
+* Need to run bpm update before bpm preview for the first time
+
+* "directories" should be optional in package.json - we can infer it.
+
+----------------
+
+# SCENARIOS
+
+## New user with existing app using bpm to manage dependencies
+
+    bpm init .         # creates bpm.json, assets/bpm_libs.js etc.
+    
+    bpm add sproutcore # updates json & packages with sproutcore
+    > Fetching sproutcore...
+    > Building bpm_libs.js
+    > New library size ~24Kb
+    
+    # now just load assets/bpm_libs.js to get it all
+    
+    bpm remove sproutcore # updates json & packages to remove...
+    ...
+    
+## User migrates to use bpm to manage their app as well
+
+    bpm init --app  # enables app management, creates app dir for JS
+    
+    # now just make your index.html load assets/app_name/app_package.js
+    
+    bpm preview     # returns auto-compiled resources while working.
+                    # also we could publish a rails plugin that bakes in to 
+                    # rails app
+    
+    bpm compile     # generates a built app when you are ready to go to prod
+                    # maybe should build the entire thing into a different 
+                    # loc?
+                    
+    bpm update      # invoke if you modify the bpm.json to update settings
+    
+## User working with unit tests in their app
+
+    # to enable unit testing add a unit testing framework as a dev dependency
+    bpm add qunit --dev
+    
+    # you can also use the generator to introduce a unit test
+    bpm gen qunit test foo_test  # creates tests/foo_test.js
+    
+    # next time you update it will add a assets/app_name/bpm_tests.js file
+    # this isn't really necessary though because bpm preview runs this.
+    bpm update --no-fetch
+    
+    # start the preview app and then navigate to the qunit
+    bpm preview
+    
+    # then to run the unit tests - load the qunit viewer...
+    visit: http://localhost:4020/assets/qunit 
+    
+## Developer hacking on a package they intend to redistribute
+
+This works the same way whether you intend to redistribute or not; just put
+it inside of a project and name your development dependencies there.  Workflow
+is the same as unit testing an app except that the tests should be in the 
+package and the tests will be built into `assets/package_name/bpm_tests.js`
+
+## Including a developer package inside of another project
+
+All packages must be developed inside of a project - this means that a package
+you intend to distribute via bpm must itself be developed inside of a project.
+
+If you just want to include a developer package just add the project to your 
+'vendor' directory.
+     

data/bpm.gemspec

@@ -10,13 +10,13 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Charles Jolley", "Peter Wagenet"]
   s.email       = ["charles@sproutcore.com", "peterw@strobecorp.com"]
-  s.homepage    = "http://github.com/strobecorp/spade"
-  s.summary = s.description = "Package Manager for JavaScript"
+  s.homepage    = "http://github.com/getbpm/bpm"
+  s.summary = s.description = "Browser Package Manager"
 
   mswin = RbConfig::CONFIG["host_os"] =~ %r!(msdos|mswin|djgpp|mingw)!
   mri = !mswin && (!defined?(RUBY_ENGINE) || RUBY_ENGINE == "ruby")
 
-  s.add_dependency "libgems",      "~> 0.0.2"
+  s.add_dependency "libgems",      "~> 0.0.5"
   s.add_dependency "gemcutter",    "~> 0.6.1"
   s.add_dependency "highline",     "~> 1.6.1"
   s.add_dependency "json_pure",    "~> 1.4.6"

data/lib/bpm/cli/base.rb

@@ -1,4 +1,6 @@
 require 'thor'
+require 'json'
+require 'bpm/version'
 
 module BPM
   module CLI
@@ -10,6 +12,11 @@ module BPM
         :aliases => ['-V'],
         :desc => 'Show additional debug information while running'
 
+      def self.help(shell, subcommand = false)
+        shell.say "\nbpm (v#{BPM::VERSION}) - the browser package manager\n\n"
+        super shell, subcommand
+      end
+      
       desc "owner", "Manage users for a package"
       subcommand "owner", BPM::CLI::Owner
 
@@ -47,17 +54,19 @@ module BPM
       end
 
 
-      desc "fetched [PACKAGE]", "Shows what bpm packages are fetched"
+      desc "fetched [PACKAGE]", "Display locally fetched bpm packages"
       def fetched(*packages)
         local = BPM::Local.new
         index = local.installed(packages)
         print_specs(packages, index)
       end
 
-      desc "add [PACKAGE]", "Add package to project"
+      desc "add [PACKAGE]", "Add one or more packages to a bpm project"
       method_option :version,    :type => :string,  :default => nil, :aliases => ['-v'],    :desc => 'Specify a version to install'
       method_option :project,    :type => :string,  :default => nil, :aliases => ['-p'],    :desc => 'Specify project location other than working directory'
       method_option :prerelease, :type => :boolean, :default => false,  :aliases => ['--pre'], :desc => 'Install a prerelease version'
+      method_option :development, :type => :boolean, :default => false, :aliases => ['--dev'], :desc => "Add as a development dependency"
+      method_option :mode, :type => :string, :default => :production, :aliases => ['-m'], :desc => "Build mode for compile (default production)"
       def add(*package_names)
         # map to dependencies
         if package_names.empty?
@@ -81,13 +90,17 @@ module BPM
         # find project
         project = find_project
 
-        # This was wrapped in a begin/rescue Exception, but we should be selective if we rescue
-        project.add_dependencies deps, true
-        project.build :debug, true
+        begin
+          project.add_dependencies deps, options[:development], true
+          project.build options[:mode], true
+        rescue BPM::Error => e
+          abort e.message
+        end
       end
 
-      desc "remove [PACKAGE]", "Remove package from project"
+      desc "remove [PACKAGE]", "Remove one or more packages from a bpm project"
       method_option :project,    :type => :string,  :default => nil, :aliases => ['-p'],    :desc => 'Specify project location other than working directory'
+      method_option :mode, :type => :string, :default => :production, :aliases => ['-m'], :desc => "Build mode for compile (default production)"
       def remove(*package_names)
 
         # map to dependencies
@@ -99,37 +112,31 @@ module BPM
           project = find_project
           project.unbuild options[:verbose]
           project.remove_dependencies package_names, true
-          project.build :debug, true
-          
-        rescue Exception => e
+          project.build options[:mode], true
+        rescue BPM::Error => e
           abort e.message
         end
       end
 
-      desc "autocompile", "Preview server that will autocompile assets.  Useful for hacking"
-      method_option :mode, :type => :string, :default => :debug, :aliases => ['-m'], :desc => 'Set build mode for compile (default debug)'
+      desc "preview", "Preview server that will autocompile assets as you request them.  Useful for hacking"
+      method_option :mode, :type => :string, :default => :debug, :aliases => ['-m'], :desc => 'Build mode for compile (default debug)'
       method_option :project,    :type => :string,  :default => nil, :aliases => ['-p'],    :desc => 'Specify project location other than working directory'
       method_option :port,       :type => :string,  :default => '4020', :desc => "Port to host server on"
-      def autocompile
-        
+      def preview
         project = find_project
-        puts project
-        BPM::Server.start project, :Port => options[:port]
-        
+        project.verify_and_repair options[:mode], options[:verbose]
+        BPM::Server.start project, :Port => options[:port], :mode => options[:mode].to_sym
       end
       
-      desc "compile", "Build the bpm_package.js for development"
-      method_option :mode, :type => :string, :default => :debug, :aliases => ['-m'], :desc => 'Set build mode for compile (default debug)'
+      desc "rebuild", "Rebuilds bpm assets, does not update versions"
+      method_option :mode, :type => :string, :default => :production, :aliases => ['-m'], :desc => 'Build mode for compile (default production)'
       method_option :project,    :type => :string,  :default => nil, :aliases => ['-p'],    :desc => 'Specify project location other than working directory'
-      def compile
-        
-        begin
-          project = find_project
-          project.rebuild_dependencies nil, options[:verbose]
-          project.build options[:mode], options[:verbose]
-        rescue Exception => e
-          abort e.message
-        end
+      method_option :update, :type => :boolean, :default => false, :aliases => ['-u'], :desc => 'Updates dependencies to latest compatible version'
+      def rebuild
+        find_project.fetch_dependencies(true) if options[:update]
+        find_project.build options[:mode].to_sym, true
+      rescue BPM::Error => e
+        abort e.message
       end
       
       desc "login", "Log in with your BPM credentials"
@@ -208,23 +215,11 @@ module BPM
         print_specs(packages, index)
       end
 
-      desc "new [NAME]", "Generate a new project skeleton"
-      method_option :path, :type => :string, :default => nil, :desc => 'Specify a different name for the project'
-      method_option :package, :type => :string, :default => nil, :desc => 'Specify a package template to build from'
-      def new(name)
-        package = install_package(options[:package])
-        template_path = package ? package.template_path(:project) : nil
-
-        path = File.expand_path(options[:path] || underscore(name))
-        generator = get_generator(:project, package)
-        success = generator.new(self, name, path, template_path, package).run
-
-        run_init(name, path, package) if success
-      end
-
       desc "init [PATHS]", "Configure a project to use bpm for management"
       method_option :name, :type => :string, :default => nil, :desc => 'Specify a different name for the project'
       method_option :skip, :type => :boolean, :default => false, :desc => 'Skip any conflicting files'
+      method_option :app, :type => :boolean, :default => false, :desc => 'Manage app as well as packages'
+      method_option :package, :type => :string, :default => nil, :desc => 'Specify a package template to build from'
       def init(*paths)
         paths = [Dir.pwd] if paths.empty?
         paths.map!{|p| File.expand_path(p) }
@@ -234,19 +229,40 @@ module BPM
         end
 
         paths.each do |path|
-          run_init(options[:name] || File.basename(path), path)
+          name = options[:name] || File.basename(path)
+
+          # if someone specified both a name and path assume they meant 
+          # exactly what they said and don't normalize it.
+          if name == File.basename(path)
+            underscored = File.join(File.dirname(path), underscore(File.basename(path)))
+            path = underscored if !File.directory?(path)
+          end
+
+          if File.directory?(path)
+            run_init(name, options[:app], path)
+          else
+            package = install_package(options[:package])
+            template_path = package ? package.template_path(:project) : nil
+            generator = get_generator(:project, package)
+            success = generator.new(self, name, path, template_path, package).run
+            run_init(name, true, path, package) if success
+          end
+          
         end
+      
+      rescue BPM::Error => e
+        abort e.message
       end
 
-      desc "build [PACKAGE]", "Build a bpm package from a package.json"
+      desc "pack [PACKAGE]", "Build a bpm package from a package.json"
       method_option :email, :type => :string,  :default => nil,   :aliases => ['-e'],    :desc => 'Specify an author email address'
-      def build(package_path=nil)
+      def pack(package_path=nil)
         package_path ||= Dir.pwd
         local = BPM::Local.new
         package = local.pack(File.join(package_path, "package.json"), options[:email])
 
         if package.errors.empty?
-          puts "Successfully built package: #{package.to_ext}"
+          puts "Successfully built package: #{package.file_name}"
         else
           failure_message = "BPM encountered the following problems building your package:"
           package.errors.each do |error|
@@ -254,6 +270,8 @@ module BPM
           end
           abort failure_message
         end
+      rescue BPM::Error => e
+        abort e.message
       end
 
       desc "unpack [PACKAGE]", "Extract files from a bpm package"
@@ -264,7 +282,7 @@ module BPM
         paths.each do |path|
           begin
             package     = local.unpack(path, options[:target])
-            unpack_path = File.expand_path(File.join(Dir.pwd, options[:target], package.to_full_name))
+            unpack_path = File.expand_path(File.join(Dir.pwd, options[:target], package.full_name))
             puts "Unpacked package into: #{unpack_path}"
           rescue Errno::EACCES, LibGems::FilePermissionError => ex
             abort "There was a problem unpacking #{path}:\n#{ex.message}"
@@ -272,6 +290,21 @@ module BPM
         end
       end
 
+      desc "debug [OPTION]", "Display various options for debugging"
+      method_option :project,    :type => :string,  :default => nil, :aliases => ['-p'],    :desc => 'Specify project location other than working directory'
+      method_option :mode, :type => :string, :default => :debug, :aliases => ['-m'], :desc => 'Build mode (default debug)'
+      def debug(option)
+        case option
+        when 'build'
+          say JSON.pretty_generate find_project.build_settings(options[:mode].to_sym)
+        when 'repair'
+          say "Verifying and repairing project..."
+          find_project.verify_and_repair options[:mode].to_sym, true
+        else
+          abort "Do not know how to display #{option}"
+        end
+      end
+
       private
 
         def get_generator(type, package=nil)
@@ -280,15 +313,33 @@ module BPM
           package ? package.generator_for(type) : BPM.generator_for(type)
         end
 
-        def run_init(name, path, package=nil)
-          template_path = package ? package.template_path(:init) : nil
+        def run_init(name, include_app, path, package=nil)
+
+          # we only need to create a new project.json if one does not 
+          # already exist.
+          unless BPM::Project.is_project_root? path
+            template_path = package ? package.template_path(:init) : nil
 
-          generator = get_generator(:init, package)
-          generator.new(self, name, path, template_path, package).run
+            generator = get_generator(:init, package)
+            generator.new(self, name, path, template_path, package).run
+          end
 
+          # make sure the project app status matches
           project = BPM::Project.new(path, name)
-          project.fetch_dependencies true
-          project.build :debug, true
+
+          if project.build_app? != !!include_app
+            project.build_app = include_app
+            project.save!
+          end
+
+          project.build :production, true
+
+          if package
+            deps = {}
+            deps[package.name] = package.version
+            project.add_dependencies deps, false, true
+          end
+
         end
 
         def report_arity_error(name)

data/lib/bpm/errors.rb

@@ -0,0 +1,51 @@
+module BPM
+
+  class Error < StandardError
+    
+    def format_message(*args)
+      args.join ","
+    end
+    
+    def initialize(*args)
+      super format_message(*args)
+    end
+  end
+    
+  class InvalidPackageError < BPM::Error
+    def format_message(package, msg=nil)
+      msg = msg.nil? ? '' : ": #{msg}"
+      "There was a problem parsing #{File.basename(package.json_path)}#{msg}"
+    end
+  end
+  
+  class InvalidPackageNameError < BPM::InvalidPackageError
+    def format_message(package)
+      "Package at #{package.root_path} name and directory do not match. (name: #{package.name}).  Change the directory or package.json name to match."
+    end
+  end
+  
+  class PackageNotFoundError < BPM::Error
+    def format_message(name, version)
+      "Could not find eligible package for '#{name}' (#{version})"
+    end
+  end
+
+  class MinifierNotFoundError < PackageNotFoundError
+    def format_message(minifier_name)
+      "Minifier package #{minifier_name} was not found.  Try running bpm update to refresh."
+    end
+  end
+  
+  class PackageConflictError < BPM::Error
+    def format_message(name, version_a, version_b)
+      "Conflicting requirement for '#{name}' (requires #{version_a} and #{version_b})"
+    end
+  end
+  
+  class LocalPackageConflictError < PackageConflictError
+    def format_message(name, version_a, version_b)
+      "Local package '#{name}' (#{version_b}) is not compatible with required version #{version_a}"
+    end
+  end
+  
+end

data/lib/bpm/init_generator.rb

@@ -6,7 +6,7 @@ module BPM
     source_root File.join(::BPM::TEMPLATES_DIR, 'init')
 
     def bpm_version
-      BPM::VERSION
+      BPM::COMPAT_VERSION
     end
 
     def run
@@ -16,13 +16,6 @@ module BPM
         template "project.json", "#{name}.json"
       end
 
-      empty_directory "assets"
-
-      inside "assets" do
-        template "bpm_packages.js"
-        template "bpm_styles.css"
-      end
-
       true
     end
 

data/lib/bpm/libgems_ext/libgems.rb

@@ -36,4 +36,13 @@ module LibGems
     set_home(ENV['BPM_HOME'] || LibGems.configuration.home || default_dir) unless @gem_home
     @gem_home
   end
+
+  def self.with_silence
+    original_verbose = LibGems.configuration.verbose
+    LibGems.configuration.verbose = false
+    yield
+  ensure
+    LibGems.configuration.verbose = original_verbose
+  end
+
 end

data/lib/bpm/local.rb

@@ -29,9 +29,9 @@ module BPM
     end
 
     def unpack(path, target)
-      package       = BPM::Package.new
-      package.bpkg  = path
-      unpack_dir    = File.expand_path(File.join(Dir.pwd, target, package.to_full_name))
+      package = BPM::Package.new
+      package.fill_from_gemspec(path)
+      unpack_dir = File.expand_path(File.join(Dir.pwd, target, package.full_name))
       LibGems::Installer.new(path, :unpack => true).unpack unpack_dir
       package
     end
@@ -44,22 +44,17 @@ module BPM
       end
     end
     
-    def preferred_version(package, vers, prerelease)
+    def preferred_version(package, vers)
       dep = LibGems::Dependency.new package, vers
       specs = LibGems.source_index.search dep
       specs.last.version.to_s
     end
 
-    def source_root(package, vers, prerelease)
+    def source_root(package, vers)
       dep = LibGems::Dependency.new package, vers
       specs = LibGems.source_index.search dep
-
-      dep2 = LibGems::Dependency.new package, '>= 0'
-      specs2 = LibGems.source_index.search dep2 
-
       spec = specs.last
-      spec &&
-      File.join(spec.installation_path, 'gems', "#{spec.name}-#{spec.version}") 
+      spec && File.join(spec.installation_path, 'gems', "#{spec.name}-#{spec.version}")
     end
     
     private