spigoter 0.3.0 → 0.4.0

data/README.md

@@ -1,6 +1,7 @@
 # Spigoter
 
-[![Gem Version](https://img.shields.io/gem/v/spigoter.svg?style=flat-square)](https://badge.fury.io/rb/spigoter)
+[![Gem Version](https://img.shields.io/gem/v/spigoter.svg?style=flat-square)](https://rubygems.org/gems/spigoter)
+[![Gem Downloads](https://img.shields.io/gem/dt/spigoter.svg?style=flat-square)](https://rubygems.org/gems/spigoter)
 [![Build Status](https://img.shields.io/travis/DanielRamosAcosta/spigoter.svg?style=flat-square)](https://travis-ci.org/DanielRamosAcosta/spigoter)
 [![Coverage Status](https://img.shields.io/coveralls/DanielRamosAcosta/spigoter.svg?style=flat-square)](https://coveralls.io/github/DanielRamosAcosta/spigoter?branch=master)
 [![Code Climate](https://img.shields.io/codeclimate/github/DanielRamosAcosta/spigoter.svg?style=flat-square)](https://codeclimate.com/github/DanielRamosAcosta/spigoter)

data/exe/spigoter

@@ -7,49 +7,49 @@ options = {}
 
 subtext = <<HELP
 COMMAND are:
-   start [options]    starts the server
-   update [options]   updates plugin
-   compile [options]  compiles spigot and replaces as the current version
+    start [options]    starts the server
+    update [options]   updates plugin
+    compile [options]  compiles spigot and replaces as the current version
 
-See '#{File.basename $0} COMMAND --help' for more information on a specific command.
+See '#{File.basename $PROGRAM_NAME} COMMAND --help' for more information on a specific command.
 HELP
 
 global = OptionParser.new do |opts|
-    opts.banner = "Usage: #{File.basename $0} <COMMAND> [options]"
-    opts.separator ""
-    opts.separator subtext
-    opts.on_tail("-v", "--version", "Show version information about this program and quit.") do
-        puts "Spigoter v#{Spigoter::VERSION}"
-        exit
-    end
+  opts.banner = "Usage: #{File.basename $PROGRAM_NAME} <COMMAND> [options]"
+  opts.separator ''
+  opts.separator subtext
+  opts.on_tail('-v', '--version', 'Show version information about this program and quit.') do
+    puts "Spigoter v#{Spigoter::VERSION}"
+    exit
+  end
 end
 
 subcommands = {
-    'init' => OptionParser.new do |opts|
-        opts.banner = "Usage: #{File.basename $0} init"
-        opts.separator "\nCreates a new spigoter.yml for you"
-    end,
-    'start' => OptionParser.new do |opts|
-        opts.banner = "Usage: #{File.basename $0} start"
-        opts.separator "\nStarts the server"
-    end,
-    'update' => OptionParser.new do |opts|
-        opts.banner = "Usage: #{File.basename $0} update [options]"
-        opts.on("-l", "--list=[x,y,z]", Array, "list of plugins to update") do |par|
-            options[:list] = par
-        end
-        opts.on("-f", "--force", "forces to updates all plugins, even if no new version was found") do |par|
-            options[:force] = par
-        end
-        opts.separator "\nUpdates the plugins"
-    end,
-    'compile' => OptionParser.new do |opts|
-        opts.banner = "Usage: #{File.basename $0} update [options]"
-        opts.on("-v", "--version version", "version of spigot to compile (lastest by default)") do |par|
-            options[:version] = par
-        end
-        opts.separator "\nCompiles spigot and sets it as the current version"
+  'init' => OptionParser.new do |opts|
+    opts.banner = "Usage: #{File.basename $PROGRAM_NAME} init"
+    opts.separator "\nCreates a new spigoter.yml for you"
+  end,
+  'start' => OptionParser.new do |opts|
+    opts.banner = "Usage: #{File.basename $PROGRAM_NAME} start"
+    opts.separator "\nStarts the server"
+  end,
+  'update' => OptionParser.new do |opts|
+    opts.banner = "Usage: #{File.basename $PROGRAM_NAME} update [options]"
+    opts.on('-l', '--list=[x,y,z]', Array, 'list of plugins to update') do |par|
+      options[:list] = par
+    end
+    opts.on('-f', '--force', 'forces to updates all plugins, even if no new version was found') do |par|
+      options[:force] = par
+    end
+    opts.separator "\nUpdates the plugins"
+  end,
+  'compile' => OptionParser.new do |opts|
+    opts.banner = "Usage: #{File.basename $PROGRAM_NAME} update [options]"
+    opts.on('-v', '--version version', 'version of spigot to compile (lastest by default)') do |par|
+      options[:version] = par
     end
+    opts.separator "\nCompiles spigot and sets it as the current version"
+  end
 }
 
 global.order!
@@ -57,15 +57,15 @@ global.order!
 command = ARGV.shift
 
 begin
-    subcommands[command].order!
+  subcommands[command].order!
 rescue
-    Log.error "Unrecognized subcommand or param, do #{File.basename $0} --help"
-    exit(1)
+  Log.error "Unrecognized subcommand or param, do #{File.basename $PROGRAM_NAME} --help"
+  exit(1)
 end
 
-#puts "Command: #{command} "
-#p options
-#puts "ARGV:"
-#p ARGV
+# puts "Command: #{command} "
+# p options
+# puts "ARGV:"
+# p ARGV
 
-Spigoter::CLI::run(command, options)
+Spigoter::CLI.run(command).call(options)

data/lib/spigoter/cli/cli.rb

@@ -1,18 +1,23 @@
 module Spigoter
-	module CLI
-		def self.run(command, opts={})
-			Run.new.task[command].call(opts)
-		end
+  # This module encloses all CLI commands.
+  # @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
+  module CLI
+    def self.run(command)
+      Run.new.task[command]
+    end
 
-		class Run
-			attr_reader :task
-			def initialize
-				@task = {
-					'update' => Spigoter::CLI.update,
-					'compile' => Spigoter::CLI.compile,
-					'start' => Spigoter::CLI.start
-				}
-			end
-		end
-	end
-end
+    # Class for running tasks.
+    # @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
+    class Run
+      attr_reader :task
+      def initialize
+        @task = {
+          'update' => Spigoter::CLI.update,
+          'compile' => Spigoter::CLI.compile,
+          'start' => Spigoter::CLI.start,
+          'init' => Spigoter::CLI.init
+        }
+      end
+    end
+  end
+end

data/lib/spigoter/cli/cli_compile.rb

@@ -1,36 +1,62 @@
 module Spigoter
-	module CLI
-		def self.compile
-			return Compile::compile
-		end
-		module Compile
-			def self.compile
-				return lambda do |opts|
-					main(opts)
-				end
-			end
-			def self.main(opts = {})
-				if !Spigoter::Utils.which('java').nil? and !Spigoter::Utils.which('git').nil?
-					Log.info "Compiling Spigot!"
-					FileUtils.mkdir_p 'build'
-					Dir.chdir('build')
-					unless File.exist?('BuildTools.jar')
-						file = Spigoter::Utils.download('https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar')
-						File.open('BuildTools.jar', 'wb').write(file)
-					end
-					if opts[:version].nil?
-						Log.info "Compiling lastest spigot version"
-						system("java -jar BuildTools.jar")
-					else
-						Log.info "Compiling spigot version #{opts[:version]}"
-						system("java -jar BuildTools.jar --rev #{opts[:version]}")
-					end
-					Dir.chdir('..')
-					FileUtils.cp(Dir['build/spigot*.jar'].first, 'spigot.jar')
-				else
-					Log.error "You don't have java or git in PATH"
-				end
-			end
-		end
-	end
-end
+  # This module encloses all CLI commands.
+  # @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
+  module CLI
+    def self.compile
+      Compile.compile
+    end
+    # Module for compiling Spigot
+    # @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
+    module Compile
+      def self.compile
+        ->(*) { main }
+      end
+
+      def self.main(*)
+        Log.info 'Compiling Spigot!'
+        dependencies
+        opts = import_opts
+
+        FileUtils.mkdir_p 'build'
+        Dir.chdir('build') do
+          download_buildtools
+          FileUtils.rm_rf(Dir.glob('spigot*.jar'))
+          compile_spigot(opts)
+        end
+
+        FileUtils.cp(Dir['build/spigot*.jar'].first, 'spigot.jar')
+      end
+
+      def self.dependencies
+        if Spigoter::Utils.which('javac').nil? || Spigoter::Utils.which('git').nil?
+          Log.error "You don't have javac or git in PATH"
+          exit(1)
+        end
+      end
+
+      def self.import_opts
+        Spigoter::Utils.fill_opts_config
+      rescue
+        Log.error 'There is an error in spigoter.yml'
+        exit(1)
+      end
+
+      def self.download_buildtools
+        unless File.exist?('BuildTools.jar')
+          file = Spigoter::Utils.download('https://hub.spigotmc.org/jenkins/job/BuildTools/lastSuccessfulBuild/artifact/target/BuildTools.jar')
+          File.open('BuildTools.jar', 'wb').write(file)
+        end
+      end
+
+      def self.compile_spigot(opts)
+        Log.info "Compiling spigot version #{opts[:spigot_version]}"
+        exit_status = system("java -jar BuildTools.jar --rev #{opts[:spigot_version]}")
+
+        if exit_status != true
+          Log.error 'There was an error while compiling Spigot'
+          exit(1)
+        end
+      end
+    end
+  end
+end

data/lib/spigoter/cli/cli_init.rb

@@ -0,0 +1,63 @@
+module Spigoter
+  # This module encloses all CLI commands.
+  # @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
+  module CLI
+    def self.init
+      Init.init
+    end
+    # Module for generating the necessary files.
+    # @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
+    module Init
+      def self.init
+        ->(*) { main }
+      end
+
+      def self.main(*)
+        Log.info 'Generating files!'
+        File.exist?('spigoter.yml') ? Log.warn('spigoter.yml alredy exists') : generate_spigoter
+        File.exist?('plugins.yml')  ? Log.warn('plugins.yml alredy exists')  : generate_plugins
+      end
+
+      def self.generate_spigoter
+        open('spigoter.yml', 'w+') do |f|
+          f << "---\n"
+          f << "Spigoter:\n"
+          f << "  build_dir: build\n"
+          f << "  plugins_dir: plugins\n"
+          f << "  javaparams: \"-Xms1G -Xmx2G\"\n"
+          f << "  spigot_version: latest\n"
+        end
+      end
+
+      def self.generate_plugins
+        if Dir.exist?('plugins') && !Dir['plugins/*.jar'].empty?
+          generate_with_plugins
+        else
+          generate_empty
+        end
+      end
+
+      def self.generate_with_plugins
+        open('plugins.yml', 'w+') do |f|
+          f << "---\n"
+          f << "Plugins:\n"
+          Dir['plugins/*.jar'].each do |plg|
+            f << "  #{File.basename(plg).gsub(/.jar/, '')}:\n"
+            f << "    # type: {curse|devbukkit|....}\n"
+            f << "    # url: http://something.com\n"
+          end
+        end
+      end
+
+      def self.generate_empty
+        open('plugins.yml', 'w+') do |f|
+          f << "---\n"
+          f << "Plugins:\n"
+          f << "  # Plugin1:\n"
+          f << "    # type: {curse|devbukkit|....}\n"
+          f << "    # url: http://something.com\n"
+        end
+      end
+    end
+  end
+end

data/lib/spigoter/cli/cli_start.rb

@@ -1,22 +1,36 @@
 module Spigoter
-	module CLI
-		def self.start
-			return Start::start
-		end
-		module Start
-			def self.start
-				return lambda do |opts|
-					main(opts)
-				end
-			end
-			def self.main(opts = {})
-				unless Spigoter::Utils.which('java').nil?
-					Log.info "Starting the server!"
-					system("java #{opts[:javaparm]} -jar spigot.jar")
-				else
-					Log.error "You don't have java in PATH"
-				end
-			end
-		end
-	end
-end
+  # This module encloses all CLI commands.
+  # @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
+  module CLI
+    def self.start
+      Start.start
+    end
+    # Module for starting the server.
+    # @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
+    module Start
+      def self.start
+        ->(opts = {}) { main(opts) }
+      end
+
+      def self.main(opts)
+        Log.info 'Starting the server!'
+        dependencies
+        opts = {}
+        begin
+          opts = Spigoter::Utils.fill_opts_config
+        rescue => e
+          Log.error e.message
+          exit(1)
+        end
+        system("java #{opts[:javaparms]} -jar spigot.jar")
+      end
+
+      def self.dependencies
+        if Spigoter::Utils.which('java').nil?
+          Log.error "You don't have java in PATH"
+          exit(1)
+        end
+      end
+    end
+  end
+end

data/lib/spigoter/cli/cli_update.rb

@@ -1,46 +1,57 @@
 module Spigoter
-	module CLI
-		def self.update
-			return Update::update
-		end
-		module Update
-			def self.update
-				return lambda do |opts|
-					main(opts)
-				end
-			end
-			def self.main(opts)
-				Log.info "Updating!"
-				unless File.exist?('plugins.yml')
-					Log.error "plugins.yml doesn't exists, please, create one (you can use spigoter init)"
-					exit(1)
-				end
-				unless Dir.exist?('plugins')
-					Log.error "plugins directory doesn't exists, please, create it"
-					exit(1)
-				end
-
-				file = File.read('plugins.yml')
-				plugins_data = YAML.load(file)
-				list = plugins_data.keys
-				unless opts[:list].nil?
-					unless opts[:list].empty?
-						list = opts[:list]
-					end
-				end
-
-				list.each do |plugin|
-					begin
-						Log.info "Starting to download #{plugin}"
-						hash = Plugins.get_plugin(plugin, plugins_data[plugin])
-						plugin_file = File.open("plugins/#{plugin}.jar", 'wb')
-						plugin_file.write(hash[:file])
-						Log.info "#{plugin} was downloaded correctly"
-					rescue
-						Log.error "Unkown source #{plugins_data[plugin]['type']}"
-					end
-				end
-			end
-		end
-	end
-end
+  # This module encloses all CLI commands.
+  # @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
+  module CLI
+    def self.update
+      Update.update
+    end
+    # Module for updating plugins
+    # @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
+    module Update
+      def self.update
+        ->(opts = {}) { main(opts) }
+      end
+
+      def self.main(opts = {})
+        Log.info 'Updating!'
+        dependencies
+        plugins_data = Spigoter::Utils.get_plugins(opts)
+
+        plugins_data.each do |name, data|
+          objeto = get_plugin(name, data)
+          next unless !objeto.nil? && (objeto.class < Spigoter::Plugin)
+
+          File.open("plugins/#{name}.jar", 'w+b') do |f|
+            f.write(objeto.file)
+          end
+        end
+      end
+
+      def self.dependencies
+        unless File.exist?('plugins.yml')
+          Log.error "plugins.yml doesn't exists, please, create one (you can use spigoter init)"
+          exit(1)
+        end
+
+        unless Dir.exist?('plugins')
+          Log.error "plugins directory doesn't exists, please, create it"
+          exit(1)
+        end
+      end
+
+      def self.get_plugin(name, data)
+        Log.info "Updating plugin: #{name}"
+        plugin_type = data[:type]
+
+        if Spigoter::Plugin.list[plugin_type].nil?
+          Log.error "Plugin type #{plugin_type} doesn't exists!"
+          exit(1)
+        end
+
+        Spigoter::Plugin.list[plugin_type].new(data[:url])
+      rescue => e
+        Log.error e.message
+      end
+    end
+  end
+end

data/lib/spigoter/log/log.rb

@@ -1,37 +1,39 @@
 require 'logging'
 
-  Logging.color_scheme( 'bright',
-    :levels => {
-      :info  => :green,
-      :warn  => :yellow,
-      :error => :red,
-      :fatal => [:white, :on_red]
-    },
-    :date => :blue,
-    :logger => :cyan,
-    :message => :magenta
-  )
+Logging.color_scheme('bright',
+                     levels: {
+                       info: :green,
+                       warn: :yellow,
+                       error: :red,
+                       fatal: [:white, :on_red]
+                     },
+                     date: :blue,
+                     logger: :cyan,
+                     message: :magenta
+                    )
 
-  Logging.appenders.stdout(
-    'stdout',
-    :layout => Logging.layouts.pattern(
-      :pattern => '[%d] %-5l %c: %m\n',
-      :color_scheme => 'bright'
-    )
-  )
+Logging.appenders.stdout('stdout',
+                         layout: Logging.layouts.pattern(pattern: '[%l] %c: %m\n',
+                                                         color_scheme: 'bright'
+                                                        )
+                        )
 
+# Module for logging all things, info warnings and errors.
+# @author Daniel Ramos Acosta <danielramosacosta@hotmail.com>
 module Log
-    @log = Logging.logger['Spigoter']
-    @log.add_appenders 'stdout'
-    @log.level = :info
+  @log = Logging.logger['Spigoter']
+  @log.add_appenders 'stdout'
+  @log.level = :info
 
-    def self.info(msg)
-        @log.info msg
-    end
-    def self.warn(msg)
-        @log.warn msg
-    end
-    def self.error(msg)
-        @log.error msg
-    end
-end
+  def self.info(msg)
+    @log.info msg
+  end
+
+  def self.warn(msg)
+    @log.warn msg
+  end
+
+  def self.error(msg)
+    @log.error msg
+  end
+end