bukin 0.8.0 → 0.9.0

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
 

data/README.md

@@ -40,12 +40,12 @@ Bukin is still a work in progress and is far from feature complete.  Currently i
   * Auto selection if none specified
 * Automatic or user specified filtering of downloaded files
 * Automatic or user specified extraction of zip files
+* Automatic detection of already installed plugins
 * 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
@@ -61,7 +61,7 @@ Usage
 Bukin works by reading a list of dependencies from a `Bukfile`.  The most basic usage would be:
 
 ```bash
-echo "server 'craftbukkit'" > Bukfile
+bukin init
 bukin install
 ```
 

data/lib/bukin.rb

@@ -48,7 +48,7 @@ module Bukin
 
   def self.with_friendly_errors
     yield
-  rescue Bukin::BukinError => error
+  rescue BukinError => error
     abort error.message
   rescue SocketError => error
     abort "#{error.message}\nCheck that you have a stable connection and the service is online"

data/lib/bukin/bukfile.rb

@@ -45,7 +45,7 @@ module Bukin
   private
     def add_resource(name, type, args)
       raise(
-        Bukin::BukinError,
+        BukinError,
         "Error: The #{type} '#{name}' is declared "\
         "more than once in your #{FILE_NAME}"
       ) if resource_exists?(name, type)

data/lib/bukin/cli.rb

@@ -7,6 +7,7 @@ require 'bukin/bukget'
 require 'bukin/bukkit_dl'
 require 'bukin/jenkins'
 require 'bukin/download'
+require 'bukin/state'
 
 module Bukin
   class CLI < Thor
@@ -18,13 +19,30 @@ module Bukin
       without = options[:without].map(&:to_sym)
       raw_resources = parse_resources(names, without)
 
-      # Get all the informatin needed to install
+      # Get all the information needed to install
       resources = prepare_resources(raw_resources)
 
       # Download and install all resources
       install_resources(resources)
     end
 
+    desc 'init', "Creates a new Bukfile with craftbukkit as a server and adds"\
+                 "the .bukin directory to any existing .gitignore file."
+    def init
+      path = File.join(Dir.pwd, Bukfile::FILE_NAME)
+      if File.exist?(path)
+        say 'Bukfile already exists'
+      else
+        say 'Creating Bukfile'
+        File.open(path, 'w') {|file| file.write("server 'craftbukkit'")}
+      end
+
+      if File.exist?('.gitignore') && File.readlines('.gitignore').grep(/\.bukin/).empty?
+        say 'Writing .bukin to gitignore'
+        File.open('.gitignore', 'a') {|file| file.write('.bukin')}
+      end
+    end
+
     def help(*)
       shell.say "Bukin is a plugin and server package manager for Minecraft.\n"
       super
@@ -32,7 +50,7 @@ module Bukin
 
   private
     def parse_resources(names, without)
-      resources = section('Parsing Bukfile') {Bukin::Bukfile.new.resources}
+      resources = section('Parsing Bukfile') {Bukfile.new.resources}
 
       # If name are specified, only install resources with those names
       resources.select! {|resource| names.include?(resource[:name])} if names.any?
@@ -43,7 +61,7 @@ module Bukin
           resource[:group].empty? || (resource[:group] - without).any?
         end
       end
-      raise Bukin::BukinError, "Nothing to install" if resources.empty?
+      raise BukinError, "Nothing to install" if resources.empty?
 
       resources
     end
@@ -59,13 +77,13 @@ module Bukin
       end
 
       downloads.each do |provider, datas|
-        fetching provider do
+        fetching_section provider do
           datas.each do |data|
             begin
               version, download = provider.find(data)
               final_resources << Resource.new(data, version, download)
             rescue OpenURI::HTTPError => ex
-              raise Bukin::BukinError,
+              raise BukinError,
                 "There was an error fetching information about "\
                 "'#{data[:name]} (#{data[:version]})'.\n"\
                 "#{ex.message}"
@@ -78,15 +96,24 @@ module Bukin
     end
 
     def install_resources(resources)
-      installer = Bukin::Installer.new(Dir.pwd, true)
+      installer = Installer.new(Dir.pwd)
+      state = State.new(Dir.pwd)
 
+      # Install new resources
       resources.each do |resource|
-        downloading resource.name, resource.version do
+        if state.files.installed?(resource.name, resource.version)
+          using_section(resource.name, resource.version)
+          next
+        else
+          state.files.delete(resource.name)
+        end
+
+        installing_section resource.name, resource.version do
           begin
             installer.install(resource)
           rescue OpenURI::HTTPError => ex
             raise(
-              Bukin::BukinError,
+              BukinError,
               "There was an error installing "\
               "'#{resource[:name]} (#{resource[:version]})'.\n"\
               "#{ex.message}"
@@ -94,6 +121,12 @@ module Bukin
           end
         end
       end
+
+      # Remove old resources
+      names = resources.map(&:name)
+      state.files.names.each do |name|
+        state.files.delete(name) unless names.include?(name)
+      end
     end
 
     PROVIDERS = {
@@ -131,13 +164,19 @@ module Bukin
       raise ex
     end
 
-    def downloading(name, version, &block)
-      msg = "Downloading #{name}"
+    def installing_section(name, version, &block)
+      msg = "Installing #{name}"
       msg << " (#{version})" if version
       section(msg, &block)
     end
 
-    def fetching(provider, &block)
+    def using_section(name, version)
+      msg = "Using #{name}"
+      msg << " (#{version})" if version
+      section(msg) {}
+    end
+
+    def fetching_section(provider, &block)
       if provider.is_a?(Download)
         yield
       else

data/lib/bukin/installer.rb

@@ -1,27 +1,29 @@
-require 'bukin/lockfile'
+require 'bukin/state'
 require 'zip'
 
 module Bukin
   class Installer
     PATHS = { :server => '.', :plugin => 'plugins' }
 
-    def initialize(path, use_lockfile = false)
-      @lockfile = Bukin::Lockfile.new if use_lockfile
+    def initialize(path)
+      @state = State.new(path)
     end
 
     def install(resource)
       path = PATHS[resource.type]
-      file_names = []
+      files = []
       dl_data, dl_name = download_file(resource.download)
 
       if File.extname(dl_name) == '.zip'
         match = self.get_match(resource[:extract])
-        file_names = extract_files(dl_data, path, match)
-        raise Bukin::InstallError, "The resource #{resource.name} (#{resources.version}) has no jar files in it's download (zip file)." if file_names.empty?
+        files = extract_files(dl_data, path, match)
+        raise InstallError, "The resource #{resource.name} (#{resources.version}) has no jar files in it's download (zip file)." if files.empty?
       else
-        save_download(dl_data, dl_name, path)
-        file_names << dl_name
+        files = save_download(dl_data, dl_name, path)
       end
+
+      @state.files[resource.name, resource.version] = files
+      @state.save
     end
 
     def extract_files(file_data, path, match)
@@ -34,8 +36,9 @@ module Bukin
         Zip::File.open(tempfile.path) do |zipfile|
           files = zipfile.find_all {|file| file.name =~ match}
           files.each do |file|
-            file.extract(File.join(path, file.name)) { true }
-            file_names << file.name
+            full_path = File.join(path, file.name)
+            file.extract(full_path) { true }
+            file_names << full_path
           end
         end
       ensure
@@ -47,9 +50,11 @@ module Bukin
 
     def save_download(data, name, path)
       FileUtils.mkdir_p(path)
-      open("#{path}/#{name}", "wb") do |file|
+      full_path = File.join(path, name)
+      open(full_path, 'wb') do |file|
         file.print data
       end
+      [full_path]
     end
 
     def download_file(url, content_disposition = false)
@@ -76,7 +81,7 @@ module Bukin
       when nil
         /\.jar$/
       else
-        raise Bukin::InstallError, "The extract option #{match} is not valid.  Please use a String, Regexp or :all"
+        raise InstallError, "The extract option #{match} is not valid.  Please use a String, Regexp or :all"
       end
     end
 

data/lib/bukin/state.rb

@@ -0,0 +1,77 @@
+require 'yaml'
+require 'fileutils'
+
+module Bukin
+  # State of the current install
+  class State
+    attr_reader :path, :files
+
+    def initialize(path = nil)
+      path ||= '.'
+      @path = File.join(path, '.bukin')
+      create_dir
+      @files = FileState.new(File.join(@path, 'files.yml'), path)
+    end
+
+    def save
+      create_dir
+      @files.save
+    end
+
+    private
+      def create_dir
+        FileUtils.mkdir_p(@path) unless Dir.exist?(@path)
+      end
+  end
+
+  class FileState
+    def initialize(path, base_path)
+      @path = path
+      @base_path = base_path
+      @files = (File.exist?(@path) ? YAML::load_file(@path) : {})
+    end
+
+    def [](name, version = nil)
+      if version
+        (@files[name] || {})[version]
+      else
+        @files[name]
+      end
+    end
+
+    def []=(name, version = nil, value)
+      if version
+        (@files[name] ||= {})[version] = value
+      else
+        @files[name] = value
+      end
+    end
+
+    def installed?(name, version)
+      files = self[name, version]
+      return false unless files
+
+      files.all? do |file|
+        File.exist?(File.join(@base_path, file))
+      end
+    end
+
+    def delete(name)
+      (self[name] || {}).each do |version, files|
+        files.each do |file|
+          FileUtils.rm_r(file) if File.exist?(file)
+        end
+      end
+
+      @files.delete(name)
+    end
+
+    def names
+      @files.keys
+    end
+
+    def save
+      File.open(@path, "w") {|file| file.write @files.to_yaml}
+    end
+  end
+end

data/lib/bukin/version.rb

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

data/spec/state_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'bukin/state'
+require 'fakefs/safe'
+require 'fileutils'
+require 'yaml'
+
+describe Bukin::State do
+  before(:all) do
+    FakeFS.activate!
+    @path = Bukin::State.new.path
+  end
+
+  before(:each) {FileUtils.rm_r(@path) if Dir.exist?(@path)}
+  after(:all) {FakeFS.deactivate!}
+
+  it 'assignes a default path if none is provided' do
+    state = Bukin::State.new
+    state.path.should == @path
+  end
+
+  it 'assignes the path provided in the constructor' do
+    state = Bukin::State.new('/test/path')
+    state.path.should == '/test/path/.bukin'
+  end
+  
+  it 'stores files by their name and version' do
+    state = Bukin::State.new
+    state.files['worldguard', '1.0.0'] = ['plugins/WorldGuard.jar']
+
+    state.files['worldguard'].should == { '1.0.0' => ['plugins/WorldGuard.jar'] }
+  end
+
+  it 'saves files to a yaml file' do
+    state = Bukin::State.new
+    state.files['worldguard', '1.0.0'] = ['plugins/WorldGuard.jar']
+    state.save
+
+    data = YAML::load_file(File.join(state.path,'files.yml'))
+    data.should == { 'worldguard' => { '1.0.0' => ['plugins/WorldGuard.jar'] } }
+  end
+
+  it 'loads files from a yaml file' do
+    data = { 'worldguard' => { '1.0.0' => ['plugins/WorldGuard.jar'] } }
+    FileUtils.mkdir_p(@path)
+    File.open(File.join(@path, 'files.yml'), 'w') {|file| file.write data.to_yaml}
+
+    state = Bukin::State.new
+    state.files['worldguard', '1.0.0'].should == ['plugins/WorldGuard.jar']
+  end
+
+  it 'checks for already instaled files' do
+    FileUtils.mkdir_p('plugins')
+    FileUtils.touch('plugins/WorldGuard.jar')
+
+    state = Bukin::State.new
+    state.files['worldguard', '1.0.0'] = ['plugins/WorldGuard.jar']
+
+    state.files.installed?('worldguard', '1.0.0').should be_true
+  end
+
+  it 'removes old installed files' do
+    FileUtils.mkdir_p('plugins')
+    FileUtils.touch('plugins/WorldGuard.jar')
+
+    state = Bukin::State.new
+    state.files['worldguard', '1.0.0'] = ['plugins/WorldGuard.jar']
+    state.files.delete('worldguard')
+
+    File.exist?('plugins/WorldGuard.jar').should be_false
+    state.files['worldguard', '1.0.0'].should be_nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bukin
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -70,8 +70,8 @@ files:
 - lib/bukin/file_match.rb
 - lib/bukin/installer.rb
 - lib/bukin/jenkins.rb
-- lib/bukin/lockfile.rb
 - lib/bukin/resource.rb
+- lib/bukin/state.rb
 - lib/bukin/version.rb
 - spec/bukfile_spec.rb
 - spec/bukget_spec.rb
@@ -97,8 +97,8 @@ files:
 - spec/file_match_spec.rb
 - spec/installer_spec.rb
 - spec/jenkins_spec.rb
-- spec/lockfile_spec.rb
 - spec/spec_helper.rb
+- spec/state_spec.rb
 homepage: http://github.com/Nullreff/bukin
 licenses: []
 post_install_message: 
@@ -148,6 +148,6 @@ test_files:
 - spec/file_match_spec.rb
 - spec/installer_spec.rb
 - spec/jenkins_spec.rb
-- spec/lockfile_spec.rb
 - spec/spec_helper.rb
+- spec/state_spec.rb
 has_rdoc: 

data/lib/bukin/lockfile.rb

@@ -1,31 +0,0 @@
-require 'yaml'
-
-module Bukin
-  class Lockfile
-    FILE_NAME = 'Bukfile.lock'
-    attr_reader :path
-
-    def initialize(path = nil)
-      @path = path || File.join(Dir.pwd, FILE_NAME)
-      @resources = File.exist?(@path) ? YAML::load_file(@path) : {}
-      @resources = { 'resources' => {} } if @resources['resources'].nil?
-    end
-
-    def add(data)
-      name = data[:name]
-      resources[name] = {
-        'version' => data[:version],
-        'files' => data[:files]
-      }
-      save
-    end
-
-    def resources
-      @resources['resources']
-    end
-
-    def save
-      File.open(@path, "w") {|file| file.write @resources.to_yaml}
-    end
-  end
-end

data/spec/lockfile_spec.rb

@@ -1,78 +0,0 @@
-require 'spec_helper'
-require 'bukin'
-require 'fakefs/safe'
-require 'yaml'
-
-describe Bukin::Lockfile do
-  before(:all) do
-    FakeFS.activate!
-    @path = File.join(Dir.pwd, Bukin::Lockfile::FILE_NAME)
-  end
-
-  before(:each) {File.delete(@path) if File.exist?(@path)}
-  after(:all) {FakeFS.deactivate!}
-
-  it 'assignes a default path if none is provided' do
-    lockfile = Bukin::Lockfile.new
-    lockfile.path.should == @path
-  end
-
-  it 'assignes the path provided in the constructor' do
-    lockfile = Bukin::Lockfile.new('/test/path')
-    lockfile.path.should == '/test/path'
-  end
-
-  it 'loads no resources for an empty or missing file' do
-    lockfile = Bukin::Lockfile.new('/non/existant/path')
-    lockfile.resources.should == {}
-  end
-
-  it 'loads resources from an already existing lockfile' do
-    resources = { 'resources' => 'value' }
-
-    File.open(@path, 'w') {|file| file.write resources.to_yaml}
-
-    lockfile = Bukin::Lockfile.new
-    lockfile.resources.should == 'value'
-  end
-
-  it 'saves resources to a lockfile' do
-    lockfile = Bukin::Lockfile.new
-    lockfile.add({
-      :name => 'resource_name',
-      :version => '1.0.0',
-      :files => ['file']
-    })
-    lockfile.save
-
-    path = File.join
-    data = YAML::load_file(@path)
-    data.should == {
-      'resources' => {
-        'resource_name' => {
-          'version' => '1.0.0',
-          'files' => ['file']
-        }
-      }
-    }
-
-    File.delete(@path)
-    lockfile = Bukin::Lockfile.new
-    lockfile.resources.should == {}
-  end
-
-  it 'adds resources to the lockfile' do
-    lockfile = Bukin::Lockfile.new
-    lockfile.resources.count.should == 0
-    lockfile.add({
-      :name => 'resource_name',
-      :version => '1.0.0',
-      :files => ['file1', 'file2']
-    })
-    lockfile.resources.count.should == 1
-    lockfile.resources['resource_name'].should == {
-      'version' => '1.0.0', 
-      'files' => ['file1', 'file2']
-    }
-  end
-end