jammer 0.0.1 → 0.8.0

data/README.md

@@ -0,0 +1,100 @@
+Jammer
+======
+
+Jammer provides a Ruby-based executable for managing Jam packages, 'cause let's be honest: JS is nice, but JS wrapped up with some Ruby is at least twice as nice. Jammer provides the ability to easily create, update, and publish Jam packages with a convenient command line interface. Jammer expects you to manage your source code using Git, so if you aren't, fork away and add other scm support.
+
+Dependencies
+------------
+
+* Ruby 1.9+ - http://ruby-lang.org
+* Jam - http://jamjs.org
+* Git - http://git-scm.com
+
+Installation
+------------
+
+0. Install Jam. NPM is recommended. `npm install -g jamjs` will install it globally if you have NPM.
+
+1. `gem install jammer` *You may need to preface this commmand with `sudo` depending on your Ruby installation*
+
+
+Usage
+-----
+
+### Creating a New Package
+
+To create a new jam package:
+
+    jammer new [package_name]
+
+This will prompt you for some basic information about the package (which you can always change later) and then create a new directory with the given name. Inside that directory will be the necessary structure for a basic jam package. The most important file created by this command is the `package.json` file.
+
+Running `jammer new test-lib` and providing responses for the following prompts:
+
+    Package description ('The test-lib package'): This is a description for the test-lib.
+    Package homepage (''): http://github.com/crymer11/test-lib
+
+would result in a `package.json` file that looks like this:
+
+    {
+      "name": "test-lib",
+      "version": "0.0.1",
+      "description": "This is a description for the test-lib.",
+      "homepage": "http://github.com/crymer11/test-lib",
+      "jam": {
+        "dependencies": {
+        },
+        "main": "test-lib.js",
+        "include": [
+          "test-lib.js",
+          "README"
+        ]
+      },
+      "maintainers": [
+        {
+          "name": "Colin Rymer",
+          "email": "colin.rymer@gmail.com"
+        }
+      ],
+      "contributors": [
+        {
+          "name": "Colin Rymer",
+          "email": "colin.rymer@gmail.com"
+        }
+      ],
+      "repositories": [
+        {
+          "type": "git",
+          "url": "http://github.com/crymer11/test-lib.git"
+        }
+      ],
+      "github": "http://github.com/crymer11/test-lib"
+    }
+
+Note that the github attribute was set based on the detection of a github package homepage. If the homepage is not a github url, then the repositories attribute will be left empty and the github attribute will not be added.
+
+### Publishing a Package
+
+To publish the package, run `jammer publish`. This command will exit with an error message if not on the master branch of a repository. If it is on the master branch, it will create a tag for the version number and publish the code to the repository specified in your `.jamrc` file.
+
+If the `jammer publish` command is run and the version number has not been updated, either manually or with `jammer bump major`, `jammer bump minor`, or `jammer bump patch`, then the command will exit with an error message specifying the version issue.
+
+### Updating a Package
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Authors
+-------
+
+* [Colin Rymer](http://github.com/crymer11)
+
+Acknowledgement
+---------------
+Huge thanks [Primedia](http://primedia.com) for encouraging open source contributions.

data/bin/jammer

@@ -0,0 +1,149 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'methadone'
+require 'jammer'
+require 'ostruct'
+require 'json'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+
+  main do |command, arg|
+    if command
+      process_command command, arg
+    else
+      install_jamfile
+    end
+  end
+
+  class << self
+    VERSION_LEVELS = ['major', 'minor', 'patch']
+
+    def process_command(command, arg)
+      case command.downcase
+      when "new"
+        create_package arg
+      when "install"
+        install_jamfile
+      when "publish"
+        location = arg ? arg : '.'
+        publish_package location
+      when "bump"
+        bump_package arg
+      end
+    end
+
+    def create_package(name)
+      if name && valid_name(name)
+        Jammer.create_package package_info(name)
+      else
+        exit_now! 64, "Whoops! A package name must be provided for the 'new' command."
+      end
+    end
+
+    def publish_package(package_location)
+      begin
+        if publishable_package(package_location)
+          repository = options[:repository] if options[:repository]
+          package_json_file = File.join package_location, 'package.json'
+          package_info = Jammer::PackageInfo.fromJSON(File.read(package_json_file))
+          Jammer.publish_package package_location, package_info, repository
+        end
+      rescue StandardError => e
+        exit_now! 1, e.message
+      end
+    end
+
+    def bump_package(version_level)
+      if VERSION_LEVELS.include? version_level
+        Jammer.bump_package version_level
+      else
+        exit_now! 1, "A valid version level (#{version_levels.join('|')}) must be provided."
+      end
+    end
+
+    def install_jamfile
+      Jammer.install_packages
+    end
+
+    def valid_name(name)
+        force || check_directory(name)
+    end
+
+    def force
+      options[:force]
+    end
+
+    def package_info(name, info = Jammer::PackageInfo, url = '')
+      info.new(name, package_description("The #{name} package."), package_url(url))
+    end
+
+    def package_description(default)
+      user_response "Package description", default
+    end
+
+    def package_url(default)
+      user_response "Package homepage", default
+    end
+
+    def user_response(query, default)
+      print "#{query} ('#{default}'):"
+      response = STDIN.gets.chomp
+      response.empty? ? default : response
+    end
+
+    def check_directory(name)
+      if file_exists(name)
+        exit_now! 1, "A directory named '#{name}' already exists. Use '--force' to overwrite the existing directory."
+      else
+        true
+      end
+    end
+
+    def file_exists(name)
+      File.exists? name
+    end
+
+    def publishable_package(package_location)
+      Dir.chdir(package_location) do
+        raise(StandardError, 'You must be in a package directory to publish a package.') unless file_exists 'package.json'
+
+        package = JSON.parse(File.read('package.json'))
+
+        package['jam']['include'].each do |included|
+          raise(StandardError, "#{included} was listed to be included but could not be found") unless file_or_source_exists(included)
+        end
+
+        git = File.exists?(File.join(package_location, '.git'))
+        raise(StandardError, "Package must be a git repository to publish") unless git
+
+        branch = `git rev-parse --abbrev-ref HEAD`
+        raise(StandardError, "You must be on the master branch for the package you want to publish.") unless branch == "master"
+
+        tag = "#{package['name']}-v#{package['version']}"
+        raise(StandardError, "#{package['version']} has already been tagged. Please increment the version number.") if `git tag`.match tag
+
+        return true
+      end
+    end
+
+    def file_or_source_exists(name)
+      file_exists name.match('js') ? "./src/#{name.sub('js', '')}coffee" : name
+    end
+  end
+
+  on "-f", "--force", "Force package creation on specified directory."
+  on "-r", "--repository", "Use specified repository for publishing"
+
+  arg :command, :optional
+  arg :arg, :optional
+
+  version Jammer::VERSION
+  description "Jam Package Creator"
+
+  use_log_level_option
+
+  go!
+end

data/features/jammer.feature

@@ -0,0 +1,37 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "jammer"
+    Then the exit status should be 0
+    And the banner should be present
+    And the banner should document that this app takes options
+    And the following options should be documented:
+      |--version|
+
+  Scenario: App creates new Jam packages
+    When I run `jammer new test` interactively
+    And I type "test description"
+    And I type "test.url"
+    Then the exit status should be 0
+    And a directory named "test" should exist
+    And the following files should exist:
+      | test/package.json |
+      | test/test.js      |
+      | test/README.md    |
+
+  Scenario: App doesn't overwrite directories
+    Given a directory named "test"
+    When I run `jammer new test`
+    Then the exit status should be 1
+
+  Scenario: App overwrites directories when forced
+    Given a directory named "test"
+    When I run `jammer --force new test` interactively
+    And I type ""
+    And I type ""
+    Then a directory named "test" should exist
+    And the following files should exist:
+      | test/package.json |

data/features/support/env.rb

@@ -0,0 +1,17 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end
+

data/lib/jammer.rb

@@ -1,5 +1,42 @@
 require 'jammer/version'
+require 'jammer/package_info'
+require 'jammer/package_creator'
+require 'jammer/package_installer'
+require 'jammer/package_manager'
+require 'jammer/package_publisher'
 
 module Jammer
+  class << self
+    def create_package(package_info)
+      creator.create_package package_info
+    end
 
+    def bump_package(version_level)
+      puts "TODO: implement version bumping"
+    end
+
+    def publish_package(package_location, package_info, repository = nil)
+      publisher.publish_package package_location, package_info, repository
+    end
+
+    def install_packages
+      installer.install_packages
+    end
+
+    def creator(default = Jammer::PackageCreator.new)
+      @creator ||= default
+    end
+
+    def installer(default = Jammer::PackageInstaller.new)
+      @installer ||= default
+    end
+
+    def manager(default = Jammer::PackageManager.new)
+      @manager ||= default
+    end
+
+    def publisher(default = Jammer::PackagePublisher.new)
+      @publisher ||= default
+    end
+  end
 end

data/lib/jammer/package_creator.rb

@@ -0,0 +1,100 @@
+require 'erb'
+require 'fileutils'
+require 'jammer/user'
+
+module Jammer
+  class PackageCreator
+    attr_reader :package
+
+    def initialize(file_utils = FileUtils, user = Jammer::User.new)
+      @file_utils = file_utils
+      @user = user
+    end
+
+    def create_package(package_info)
+      @package = package_info
+      prepare_directory
+      create_files
+    end
+
+    def prepare_directory
+      remove_dir(package.name) if File.exists? package.name
+    end
+
+    def remove_dir(name)
+      @file_utils.rm_rf name, verbose: false, secure: true
+    end
+
+    def create_files
+      create_directory base_destination_dir, base_template_dir
+    end
+
+    def create_directory(destination, template_dir)
+      make_dir destination
+      write_files destination, template_dir
+    end
+
+    def make_dir(name)
+      @file_utils.mkdir_p name
+    end
+
+    def write_files(destination, template_dir)
+      templates(template_dir).each do |template|
+        template_file = File.join(template_dir, template)
+        if File.directory?(template_file)
+          dir = file_path(destination, template)
+          create_directory(dir, template_file)
+        else
+          create_file destination, template_file
+        end
+      end
+    end
+
+    def create_file(destination, template_file)
+      file_destination = file_path(destination, file_name(template_file))
+      template = ERB.new(File.read(template_file))
+      write_file(file_destination, render(template))
+    end
+
+    def render(template)
+      template.result(template_binding)
+    end
+
+    def template_binding
+      @binding ||= get_binding(@package, @user)
+    end
+
+    def get_binding(package, user)
+      Kernel.binding
+    end
+
+    def file_name(file)
+      File.basename file, '.erb' #strip ".erb" off template file name
+    end
+
+    def file_path(dir, file_name)
+      file_name.sub! 'main', package.name
+      File.join dir, file_name
+    end
+
+    def templates(dir)
+      Dir.entries(dir).delete_if(&dot_dir)
+    end
+
+    def base_template_dir
+      File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def base_destination_dir
+      File.join Dir.pwd, package.name
+    end
+
+    def dot_dir
+      ->(dir) { dir == '.' || dir == '..' }
+    end
+
+    def write_file(file_destination, file_contents)
+      File.open(file_destination, 'w') { |file| file.write file_contents }
+    end
+  end
+end

data/lib/jammer/package_info.rb

@@ -0,0 +1,26 @@
+module Jammer
+  class PackageInfo
+    attr_reader :name, :description, :version, :url
+
+    def initialize(package_name, package_desc, package_url, package_version = nil)
+      @name, @description, @version, @url = package_name, package_desc, package_version, package_url
+    end
+
+    def repo_url
+      on_github? ? "#{url}.git" : ''
+    end
+
+    def repo_type
+      on_github? ? 'git' : ''
+    end
+
+    def on_github?
+      url.include? 'github.com'
+    end
+
+    def self.fromJSON(json_string)
+      package = JSON.parse json_string
+      new(package['name'], package['description'], nil, package['version'])
+    end
+  end
+end

data/lib/jammer/package_installer.rb

@@ -0,0 +1,26 @@
+module Jammer
+  class PackageInstaller
+
+    JAM_PACKAGE_REGEX = /jam\s[\'\"](\w+)[\'\"](?:,\s['"](.*)['"])?/
+
+    def install_packages
+      packages.each do |package|
+        puts "installing #{package}"
+        `jam install #{package.first}#{"@" + package.last if package.last}`
+      end
+    end
+
+    def packages
+      @packages ||= get_packages
+    end
+
+    def get_packages
+      package_file.scan(JAM_PACKAGE_REGEX)
+    end
+
+    def package_file
+      @package_file ||= File.read('Jamfile')
+    end
+
+  end
+end

data/lib/jammer/package_manager.rb

@@ -0,0 +1,6 @@
+module Jammer
+  class PackageManager
+    def bump_package(version_level)
+    end
+  end
+end

data/lib/jammer/package_publisher.rb

@@ -0,0 +1,20 @@
+require 'json'
+
+module Jammer
+  class PackagePublisher
+
+    def publish_package(package_location, package_info, repository = nil)
+      tag_name = "#{package_info.name}-v#{package_info.version}"
+      tag_message = "#{package_info.name} version #{package_info.version}"
+      repository_string = repository ? " --repository #{repository}" : ''
+      puts 'Compiling coffeescript...'
+      `coffee -c --output #{package_location} #{package_location}/src`
+
+      puts `jam publish --no-auth #{package_location}#{repository_string}`
+      puts "Creating tag: #{tag_name}"
+      `git tag -a #{tag_name} -m '#{tag_message}'`
+      puts `git push --tags`
+    end
+
+  end
+end

data/lib/jammer/templates/README.md.erb

@@ -0,0 +1,3 @@
+# <%= package.name %>
+
+<%= package.description %>

data/lib/jammer/templates/package.json.erb

@@ -0,0 +1,37 @@
+{
+  "name": "<%= package.name %>",
+  "version": "0.0.1",
+  "description": "<%= package.description %>",
+  "homepage": "<%= package.url %>",
+  "jam": {
+    "dependencies": {
+    },
+    "main": "<%= package.name %>.js",
+    "include": [
+    "<%= package.name %>.js",
+      "README.md"
+    ]
+  },
+  "maintainers": [
+    {
+    "name": "<%= user.name %>",
+    "email": "<%= user.email %>"
+    }
+  ],
+  "contributors": [
+    {
+    "name": "<%= user.name %>",
+    "email": "<%= user.email %>"
+    }
+  ],
+  "repositories": [
+    {
+        "type": "<%= package.repo_type %>",
+        "url": "<%= package.repo_url %>"
+    }
+  ]
+  <% if package.on_github? %>
+    , <%# JSON needs the comma for additional key/value pairs %>
+    "github": "<%= package.repo_url %>"
+  <% end %>
+}

data/lib/jammer/templates/src/main.coffee.erb

@@ -0,0 +1 @@
+define [], () ->

data/lib/jammer/user.rb

@@ -0,0 +1,15 @@
+module Jammer
+  class User
+    def name
+      git_user_attribute 'name'
+    end
+
+    def email
+      git_user_attribute 'email'
+    end
+
+    def git_user_attribute(attribute)
+      `git config --get user.#{attribute}`.strip
+    end
+  end
+end

data/lib/jammer/version.rb

@@ -1,3 +1,3 @@
 module Jammer
-  VERSION = '0.0.1'
+  VERSION = '0.8.0'
 end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+SimpleCov.start
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'jammer'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+

metadata

@@ -2,46 +2,30 @@
 name: jammer
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Colin Rymer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-  name: rake
-  type: :development
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-- !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.4
     none: false
-  name: rspec
-  type: :development
+  name: methadone
+  type: :runtime
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.4
     none: false
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,7 +34,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: cucumber
+  name: rdoc
   type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +50,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: aruba
+  name: rake
   type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: guard-rspec
+  name: rspec
   type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: guard-cucumber
+  name: cucumber
   type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +98,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: rb-fsevent
+  name: aruba
   type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +114,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: rb-inotify
+  name: simplecov
   type: :development
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +126,29 @@ dependencies:
 description: Create, publish, and maintain jam packages.
 email:
 - colin.rymer@gmail.com
-executables: []
+executables:
+- jammer
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/jammer
+- lib/jammer/package_creator.rb
+- lib/jammer/package_info.rb
+- lib/jammer/package_installer.rb
+- lib/jammer/package_manager.rb
+- lib/jammer/package_publisher.rb
+- lib/jammer/templates/package.json.erb
+- lib/jammer/templates/README.md.erb
+- lib/jammer/templates/src/main.coffee.erb
+- lib/jammer/user.rb
 - lib/jammer/version.rb
 - lib/jammer.rb
-- README.md
+- features/jammer.feature
+- features/step_definitions/jammer_steps.rb
+- features/support/env.rb
+- spec/spec_helper.rb
 - LICENSE
+- README.md
 homepage: http://github.com/primedia/jammer
 licenses:
 - MIT
@@ -169,10 +168,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
   none: false
-requirements: []
+requirements:
+- Jam, the JS package manager available via NPM
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Create, publish, and maintain jam packages.
-test_files: []
+test_files:
+- features/jammer.feature
+- features/step_definitions/jammer_steps.rb
+- features/support/env.rb
+- spec/spec_helper.rb