frecon 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53470115c1a7a01b3b7850dd9f803951bd3cb407
-  data.tar.gz: 820d7bc082d1bad50aac2aed9ea3c9b422fb8508
+  metadata.gz: 3695507c98a8055222ee241b01a4811d02f0aa96
+  data.tar.gz: 152e3d581b3f941762b1cba4b6dfb871408b042d
 SHA512:
-  metadata.gz: edc0bebe5fbda796d7e4689db9cceff2eb4f91869e5ec38bf441eed9237ab51709cd065775cb6dd95d6729d8e28e87c55f20d46a03c2cec75a53e3fde86f8476
-  data.tar.gz: 82e6c63b5d4b6650bc85ba1119ea565c7b82f7c1c24acc7ba5eb00dde28d18fcc4eb1b6b25690e656c834fbc1e3f02adfd804a2a346bf3982000b6d243da661c
+  metadata.gz: e8da7107dd168433d62a49c08104e3c4f675543e0837c6c3041b67edcfd78710ea2b9ec3c0608f46ac4fc2c39269c005e4536258bd6a17be324cea4f6502757b
+  data.tar.gz: f9811d2b31a5c30fc0597a9357be77122df2d052686857e506a7945b0e85b8635e7626e14b4b1f7312e3774c464508b23c2b6bdc62056609905d35251aa9ca7c

data/bin/frecon

@@ -15,8 +15,85 @@ $LOAD_PATH.unshift(lib_directory) unless $LOAD_PATH.map { |directory| File.expan
 
 require "frecon"
 
-unless ARGV.include?("c") || ARGV.include?("console")
-	FReCon::Server.start
-else
-	FReCon::Console.start
+require "optparse"
+
+options = {
+	mode: :server,
+	configuration: {}
+}
+
+defaults = FReCon::ConfigurationFile.default.read
+
+optparse = OptionParser.new do |opts|
+	opts.banner = <<EOF
+Usage: #{$0} [OPTIONS] [MODE]
+
+If MODE is not present, FReCon starts the Server.  If MODE is present, starts
+with "c", and contains any of the letters of the word "console" in order, FReCon
+instead starts the Console.
+EOF
+
+	opts.separator ""
+	opts.separator "Server OPTIONS:"
+
+	opts.on("-o", "--host HOST", "Bind to HOST (default: #{defaults["frecon"]["server"]["host"]})") do |host|
+		options[:configuration] ||= {}
+		options[:configuration]["frecon"] ||= {}
+		options[:configuration]["frecon"]["server"] ||= {}
+		options[:configuration]["frecon"]["server"]["host"] = host
+	end
+
+	opts.on("-p", "--port PORT", "Bind to port PORT (default: #{defaults["frecon"]["server"]["port"]})") do |port|
+		options[:configuration] ||= {}
+		options[:configuration]["frecon"] ||= {}
+		options[:configuration]["frecon"]["server"] ||= {}
+		options[:configuration]["frecon"]["server"]["port"] = port
+	end
+
+	opts.separator ""
+	opts.separator "General OPTIONS:"
+
+	server_environment = defaults["frecon"]["server"]["environment"]
+	console_environment = defaults["frecon"]["console"]["environment"]
+	default_environment_string = server_environment == console_environment ? server_environment : "server: #{server_environment}, console: #{console_environment}"
+
+	opts.on("-E", "--env ENVIRONMENT", "Run in the ENVIRONMENT environment (default: #{default_environment_string})") do |environment|
+		options[:configuration] ||= {}
+		options[:configuration]["frecon"] ||= {}
+		options[:configuration]["frecon"]["server"] ||= {}
+		options[:configuration]["frecon"]["server"]["environment"] = environment
+		options[:configuration]["frecon"]["console"] ||= {}
+		options[:configuration]["frecon"]["console"]["environment"] = environment
+	end
+
+	# opts.on("-v", "--verbose", "Run more verbosely.") do
+	# 	options[:output_level] = :verbose
+	# end
+
+	# opts.on("-d", "--debug", "Print debugging messages.") do
+	# 	options[:output_level] = :debug
+	# end
+
+	opts.on("-h", "--help", "Print this usage message.") do
+		puts opts
+		exit
+	end
+end
+
+optparse.parse!
+
+ARGV.select do |arg|
+	case arg
+	when /^co?n?s?o?l?e?$/i
+		options[:mode] = :console
+	end
+end
+
+configuration = FReCon::Configuration.construct!(argument_configuration: options[:configuration])
+
+case options[:mode]
+when :server
+	FReCon::Server.start(configuration: configuration)
+when :console
+	FReCon::Console.start(configuration: configuration)
 end

data/config/default.yml

@@ -0,0 +1,32 @@
+frecon:
+  server:
+    host: "localhost"
+    port: 4567
+    environment: "development"
+
+  console:
+    environment: "development"
+
+  database:
+    mongoid:
+      development:
+        sessions:
+          default:
+            database: frecon
+            hosts:
+              - localhost:27017
+
+        options:
+          use_utc: true
+          raise_not_found_error: false
+
+      production:
+        sessions:
+          default:
+            database: frecon
+            hosts:
+              - localhost:27017
+
+        options:
+          use_utc: true
+          raise_not_found_error: false

data/lib/frecon/base/variables.rb

@@ -8,7 +8,7 @@
 # <http://opensource.org/licenses/MIT>.
 
 module FReCon
-	VERSION = "0.4.0"
+	VERSION ||= "0.5.0"
 
 	@environment_variable = :development
 

data/lib/frecon/configuration.rb

@@ -0,0 +1,67 @@
+# lib/frecon/configuration.rb
+#
+# Copyright (C) 2015 Christopher Cooper, Sam Craig, Tiger Huang, Vincent Mai, Sam Mercier, and Kristofer Rye
+#
+# This file is part of FReCon, an API for scouting at FRC Competitions, which is
+# licensed under the MIT license.  You should have received a copy of the MIT
+# license with this program.  If not, please see
+# <http://opensource.org/licenses/MIT>.
+
+require "frecon/configuration_file"
+
+module FReCon
+	class Configuration < Hash
+		def initialize(data)
+			data.each do |key, value|
+				self[key] = value
+			end
+		end
+
+		def to_h
+			hash = {}
+
+			self.each do |key, value|
+				case value
+				when Configuration
+					hash[key] = value.to_h
+				else
+					hash[key] = value
+				end
+			end
+
+			hash
+		end
+
+		def merge(other)
+			case other
+			when Configuration, Hash
+				other.each do |key, value|
+					case value
+					when Configuration, Hash
+						me = Configuration.new(self[key] || {})
+						me.merge(Configuration.new(value))
+						self[key] = me
+					else
+						self[key] = value
+					end
+				end
+			when nil
+			end
+		end
+
+		def self.construct!(default_configuration: ConfigurationFile.default.read,
+		                    system_configuration: ConfigurationFile.system.read,
+		                    user_configuration: ConfigurationFile.user.read,
+		                    argument_configuration: nil)
+
+			configuration_hierarchy = [default_configuration, system_configuration, user_configuration, argument_configuration]
+
+			configuration = Configuration.new({})
+			configuration_hierarchy.each do |other_configuration|
+				configuration.merge(other_configuration)
+			end
+
+			configuration
+		end
+	end
+end

data/lib/frecon/configuration_file.rb

@@ -0,0 +1,45 @@
+# lib/frecon/configuration_file.rb
+#
+# Copyright (C) 2015 Christopher Cooper, Sam Craig, Tiger Huang, Vincent Mai, Sam Mercier, and Kristofer Rye
+#
+# This file is part of FReCon, an API for scouting at FRC Competitions, which is
+# licensed under the MIT license.  You should have received a copy of the MIT
+# license with this program.  If not, please see
+# <http://opensource.org/licenses/MIT>.
+
+require "yaml"
+require "frecon/configuration"
+
+module FReCon
+	class ConfigurationFile
+		attr_accessor :filename
+
+		def initialize(filename)
+			@filename = filename
+		end
+
+		def read
+			begin
+				data = open(@filename, "rb") do |io|
+					io.read
+				end
+
+				Configuration.new(YAML.load(data))
+			rescue Errno::ENOENT
+				nil
+			end
+		end
+
+		def self.default
+			self.new(File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "config", "default.yml")))
+		end
+
+		def self.system
+			self.new(File.join("", "etc", "frecon", "config.yml"))
+		end
+
+		def self.user
+			self.new(File.join(Dir.home, "config", "frecon.yml"))
+		end
+	end
+end

data/lib/frecon/console.rb

@@ -7,13 +7,17 @@
 # license with this program.  If not, please see
 # <http://opensource.org/licenses/MIT>.
 
+require "frecon/base/variables"
+require "frecon/configuration"
 require "frecon/database"
 require "frecon/server"
 
 module FReCon
 	class Console
-		def self.start
-			Database.setup(FReCon.environment)
+		def self.start(configuration: Configuration.construct!)
+			environment = configuration["frecon"]["console"]["environment"]
+			mongoid = configuration["frecon"]["database"]["mongoid"]
+			Database.setup(environment: environment, mongoid: mongoid)
 
 			require "pry"
 

data/lib/frecon/database.rb

@@ -19,10 +19,11 @@ require "frecon/models"
 
 module FReCon
 	class Database
-		def self.setup(environment, mongoid_hash = nil)
-			if mongoid_hash.is_a?(Hash)
+		def self.setup(environment: FReCon.environment, mongoid: nil)
+			if mongoid.is_a?(Hash)
 				mongoid_tempfile = Tempfile.new("FReCon")
-				mongoid_tempfile.write(mongoid_hash.to_yaml)
+
+				mongoid_tempfile.write(mongoid.to_h.to_yaml)
 				mongoid_tempfile.rewind
 
 				Mongoid.load!(mongoid_tempfile.path, environment)

data/lib/frecon/server.rb

@@ -9,6 +9,8 @@
 
 require "sinatra/base"
 
+require "frecon/base/variables"
+require "frecon/configuration"
 require "frecon/database"
 require "frecon/routes"
 require "frecon/controllers"
@@ -21,15 +23,27 @@ module FReCon
 			content_type "application/json"
 		end
 
-		def self.run!
-			set :environment, FReCon.environment
-			Database.setup(FReCon.environment)
+		def self.start(**keyword_arguments)
+			run!(**keyword_arguments)
+		end
 
-			super
+		protected
+
+		def self.setup!(configuration: Configuration.construct!)
+			set :server, %w[thin HTTP webrick]
+			set :bind, configuration["frecon"]["server"]["host"]
+			set :port, configuration["frecon"]["server"]["port"]
+			set :environment, configuration["frecon"]["server"]["environment"]
+
+			mongoid = configuration["frecon"]["database"]["mongoid"]
+
+			Database.setup(environment: environment, mongoid: mongoid)
 		end
 
-		def self.start
-			run!
+		def self.run!(**keyword_arguments)
+			setup!(**keyword_arguments)
+
+			super
 		end
 	end
 end

data/lib/frecon.rb

@@ -11,6 +11,8 @@ require "mongoid"
 
 require "frecon/base"
 
+require "frecon/configuration"
+require "frecon/configuration_file"
 require "frecon/database"
 require "frecon/server"
 require "frecon/console"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frecon
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Sam Craig
@@ -80,11 +80,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/frecon
+- config/default.yml
 - lib/frecon.rb
 - lib/frecon/base.rb
 - lib/frecon/base/bson.rb
 - lib/frecon/base/object.rb
 - lib/frecon/base/variables.rb
+- lib/frecon/configuration.rb
+- lib/frecon/configuration_file.rb
 - lib/frecon/console.rb
 - lib/frecon/controller.rb
 - lib/frecon/controllers.rb