bukin 0.7.0 → 0.8.0

data/README.md

@@ -1,7 +1,7 @@
 Bukin
 =====
 
-Plugin and server installer for Minecraft similar to [Bundler](http://gembundler.com/).  Still a work in progress...
+Plugin and server installer for Minecraft similar to [Bundler](http://gembundler.com/).
 
 [![Build Status](https://travis-ci.org/Nullreff/bukin.png)](https://travis-ci.org/Nullreff/bukin)
 [![Dependency Status](https://gemnasium.com/Nullreff/bukin.png)](https://gemnasium.com/Nullreff/bukin)
@@ -11,40 +11,131 @@ Plugin and server installer for Minecraft similar to [Bundler](http://gembundler
 Installation
 ------------
 
-Install [rubygems](http://docs.rubygems.org/read/chapter/3) then:
+Bukin requires Ruby 1.9 or greater.
 
-    gem install bukin
+### Debian/Ubuntu
 
+    apt-get install ruby
+    gem install bukin --no-ri --no-rdoc
 
+### CentOS/RHEL
+
+CentOS 6.x comes with Ruby 1.8 which is incompatable with Bukin.  You'll need to [download and install](http://www.ruby-lang.org/en/downloads/) a newer version.  After that just run
+
+    gem install bukin --no-ri --no-rdoc
+
+Features
+--------
+
+Bukin is still a work in progress and is far from feature complete.  Currently it supports:
+
+* Resource installation from
+  * [dev.bukkit.org](http://dev.bukkit.org/)
+  * [dl.bukkit.org](http://dl.bukkit.org/)
+  * [Jenkins](http://jenkins-ci.org/)
+  * Direct download
+* Versioning
+  * Specific versions
+  * Categories (ex: latest test build)
+  * Auto selection if none specified
+* Automatic or user specified filtering of downloaded files
+* Automatic or user specified extraction of zip files
+* Installation groups
+
+Eventually, I'd like to add some of the following:
+
+* A lockfile that tracks exactly what versions are installed
+* Automatic detection of already installed plugins
+* Dependency tracking and resolution
+* More complex version selectors
+* Modpack support
+* Resource installation from git
+* Top level 'source' directives
+* More commands for viewing information and updating plugins
+
+If you have features you'd like to see, pull request are welcome.
+    
 Usage
 -----
 
 Bukin works by reading a list of dependencies from a `Bukfile`.  The most basic usage would be:
 
-    echo "server 'craftbukkit'" > Bukfile
-    bukin install
+```bash
+echo "server 'craftbukkit'" > Bukfile
+bukin install
+```
+
+Specify a server using the `server` keyword and a plugin using the `plugin` keyword.
 
-Currently only [Craftbukkit](http://bukkit.org/) is available as a server and [BukkitDev](http://dev.bukkit.org/) is the only plugin api supported.  Specify a server using the `server` keyword and a plugin using the `plugin` keyword.
+```ruby
+server 'craftbukkit'
+plugin 'worldedit'
+plugin 'worldguard'
+```
 
-    server 'craftbukkit'
-    plugin 'worldedit'
-    plugin 'worldguard'
+You can specify groups that resources should be placed in.  This allows you to only install specific plugins depending on your environment or server setup.
+
+```ruby
+# Will not be installed if the group 'test' is excluded
+plugin 'worldedit', group: :test
+
+group :test do
+  plugin 'worldguard'
+  plugin 'worldedit'
+end
+
+# Will not be installed if both the groups 'test' and 'development' are excluded
+plugin 'worldedit', group: [:test, :development]
+
+group :test, :development do
+  plugin 'worldguard'
+  plugin 'worldedit'
+end
+
+# Will be installed regardless of what groups are specified
+plugin 'worldguard'
+```
+
+When installing, resources that exist only in excluded groups will not be installed.
+
+```bash
+bukin install --without development test
+```
 
 You can specify specific versions of a plugin or server to install.  Craftbukkit uses its own [special version naming](http://dl.bukkit.org/about/) (artifact slugs).
 
-    server 'craftbukkit', 'build-2754'
-    plugin 'worldedit', '5.5.5'
-    plugin 'worldguard', '5.7.3'
+```ruby
+server 'craftbukkit', 'build-2754'
+plugin 'worldedit', '5.5.5'
+plugin 'worldguard', '5.7.3'
+```
 
 By default, bukin will try to download jar files from bukkit dev.  If only zip files are available, it will automatically extract all jar files from it.  If you want to specify what files are extracted from a zip file, use the `extract` option.  It takes a string or [ruby regular expression](http://ruby-doc.org/core-1.9.3/Regexp.html) used to match file names in the zip file.
 
-    plugin 'permissionsex', '1.19.5', extract: /PermissionsEx.*\.jar/
+```ruby
+plugin 'permissionsex', '1.19.5', extract: /PermissionsEx.*\.jar/
+```
 
 Plugins or servers can also be downloaded from Jenkins. Just specify the base url for Jenkins and a [ruby regular expression](http://ruby-doc.org/core-1.9.3/Regexp.html) matching the file you want to download.  If no file is specified, bukin will download the first one listed.
 
-    server 'spigot', 'build-844', jenkins: 'http://ci.md-5.net', file: /spigot\.jar/
+```ruby
+server 'spigot', 'build-844', jenkins: 'http://ci.md-5.net', file: /spigot\.jar/
+```
 
 Need something custom?  Use the `download` option.  Version is optional but will display when the plugin is downloading.
 
-    plugin 'mycustomplugin', '2.4', download: 'http://example.com/My-Custom-Plugin.jar'
+```ruby
+plugin 'mycustomplugin', '2.4', download: 'http://example.com/My-Custom-Plugin.jar'
+```
+
+When installing, the entire Bukfile is evaluated as ruby code.  This means that you can do just about anything with it.  For instance, if you wanted to conditionally install spigot if the file `spigot.yml` exists, you could do
+
+```ruby
+if File.exist? 'spigot.yml'
+  server 'spigot', jenkins: 'http://ci.md-5.net'
+else
+  server 'craftbukkit'
+end
+```
 
+Just make sure that you read and trust any Bukfile you download before running `bukin install`.

data/lib/bukin.rb

@@ -4,7 +4,15 @@ require 'socket'
 
 module Bukin
   class BukinError < StandardError; end
-  class BukfileError < BukinError; end
+  class BukfileError < BukinError
+    def self.not_symbol(group)
+      BukfileError.new("The group name '#{group}' must be a Symbol")
+    end
+
+    def self.nested_groups
+      BukfileError.new("Nesing 'group' statements is not supported")
+    end
+  end
   class InstallError < BukinError; end
 
   class VersionError < BukinError

data/lib/bukin/bukfile.rb

@@ -6,6 +6,8 @@ module Bukin
     def initialize(path = nil, &block)
       @resources = []
       @path = path || File.join(Dir.pwd, FILE_NAME)
+      @groups = []
+
       if block
        instance_eval(&block)
       else
@@ -21,6 +23,17 @@ module Bukin
       add_resource name, :plugin, args
     end
 
+    def group(*groups)
+      raise BukfileError.nested_groups unless @groups.empty?
+      groups.each do |group|
+        raise BukfileError.not_symbol(group) unless group.is_a?(Symbol)
+      end
+
+      @groups = groups
+      yield
+      @groups = []
+    end
+
   def to_s
     @reources.map do |resource|
       result = "#{resource[:name]}"
@@ -46,6 +59,8 @@ module Bukin
         :version => version
       }.merge(options)
 
+      resource[:group] = build_groups(resource[:group])
+
       @resources << resource
     end
 
@@ -54,5 +69,18 @@ module Bukin
         resource[:name] == name && resource[:type] == type
       end
     end
+
+    def build_groups(group)
+      case group
+      when nil
+        @groups.uniq
+      when Symbol
+        [group] | @groups
+      when Array
+        group | @groups
+      else
+        raise BukfileError.not_symbol(group)
+      end
+    end
   end
 end

data/lib/bukin/cli.rb

@@ -13,8 +13,10 @@ module Bukin
     desc 'install [NAMES]', "Download and install the resources specified in a "\
                             "Bukfile.\nOptionally specify the names of specific "\
                             "plugins to install."
+    option :without, type: :array, default: [], desc: 'Groups to exclude when installing'
     def install(*names) # Parse in the Bukfile
-      raw_resources = parse_resources(names)
+      without = options[:without].map(&:to_sym)
+      raw_resources = parse_resources(names, without)
 
       # Get all the informatin needed to install
       resources = prepare_resources(raw_resources)
@@ -29,11 +31,18 @@ module Bukin
     end
 
   private
-    def parse_resources(names)
+    def parse_resources(names, without)
       resources = section('Parsing Bukfile') {Bukin::Bukfile.new.resources}
 
       # If name are specified, only install resources with those names
       resources.select! {|resource| names.include?(resource[:name])} if names.any?
+
+      # Skip any resources that only exist in excluded groups
+      if without.any?
+        resources.select! do |resource|
+          resource[:group].empty? || (resource[:group] - without).any?
+        end
+      end
       raise Bukin::BukinError, "Nothing to install" if resources.empty?
 
       resources

data/lib/bukin/version.rb

@@ -1,3 +1,3 @@
 module Bukin
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/spec/bukfile_spec.rb

@@ -3,7 +3,6 @@ require 'bukin'
 
 describe Bukin::Bukfile do
   [:server, :plugin].each do |type|
-
     it "adds a #{type} by method" do
       bukfile = Bukin::Bukfile.new{}
       bukfile.resources.size.should == 0
@@ -88,4 +87,128 @@ describe Bukin::Bukfile do
     bukfile.resources.size.should == 0
     bukfile.resources.find{|resource| resource[:name] == 'missing_plugin'}.should be_nil
   end
+
+  it 'attaches a single group to a resource' do
+    bukfile = Bukin::Bukfile.new do
+      plugin 'test', group: :test
+    end
+
+    bukfile.resources.first[:group].should == [:test]
+  end
+
+  it 'attaches multiple groups to a resource' do
+    bukfile = Bukin::Bukfile.new do
+      plugin 'test', group: [:test, :development]
+    end
+
+    bukfile.resources.first[:group].should == [:test, :development]
+  end
+
+  it 'attaches a single group to multiple resources' do
+    bukfile = Bukin::Bukfile.new do
+      group :test do
+        plugin 'test1'
+        plugin 'test2'
+      end
+    end
+
+    bukfile.resources[0][:group].should == [:test]
+    bukfile.resources[1][:group].should == [:test]
+  end
+
+  it 'attaches multiple groups to multiple resources' do
+    bukfile = Bukin::Bukfile.new do
+      group :test, :development do
+        plugin 'test1'
+        plugin 'test2'
+      end
+    end
+
+    bukfile.resources[0][:group].should == [:test, :development]
+    bukfile.resources[1][:group].should == [:test, :development]
+  end
+
+  it 'attaches groups to multiple resources' do
+    bukfile = Bukin::Bukfile.new do
+      group :test do
+        plugin 'test1', group: :development
+        plugin 'test2'
+      end
+    end
+
+    bukfile.resources[0][:group].should =~ [:test, :development]
+    bukfile.resources[1][:group].should == [:test]
+  end
+
+  it 'combines duplicate groups' do
+    bukfile = Bukin::Bukfile.new do
+      group :test do
+        plugin 'test1', group: [:development, :test]
+        plugin 'test2', group: :test
+      end
+    end
+
+    bukfile.resources[0][:group].should =~ [:test, :development]
+    bukfile.resources[1][:group].should == [:test]
+  end
+
+  it 'combines duplicate method groups' do
+    bukfile = Bukin::Bukfile.new do
+      group :test, :test do
+        plugin 'test'
+      end
+    end
+
+    bukfile.resources.first[:group].should == [:test]
+  end
+
+  it 'combines duplicate resource groups' do
+    bukfile = Bukin::Bukfile.new do
+      plugin 'test', group: [:test, :test]
+    end
+
+    bukfile.resources.first[:group].should == [:test]
+  end
+
+  it 'only adds groups inside a block' do
+    bukfile = Bukin::Bukfile.new do
+      group :development do
+        plugin 'test1'
+      end
+      plugin 'test2'
+    end
+
+    bukfile.resources[0][:group].should == [:development]
+    bukfile.resources[1][:group].should == []
+  end
+
+  it 'throws an error when groups are nested' do
+    expect do
+      Bukin::Bukfile.new do
+        group :test do
+          group :development do
+            plugin 'test'
+          end
+        end
+      end
+    end.to raise_error(Bukin::BukfileError)
+  end
+
+  it 'throws an error when group is not a symbol' do
+    expect do
+      Bukin::Bukfile.new do
+        group 'test' do
+          plugin 'test'
+        end
+      end
+    end.to raise_error(Bukin::BukfileError)
+  end
+
+  it 'throws an error when resource group is not a symbol' do
+    expect do
+      Bukin::Bukfile.new do
+        plugin 'test', group: 'test'
+      end
+    end.to raise_error(Bukin::BukfileError)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bukin
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-19 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor