frecon 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32a4ee26258a1b975894a81d75809b24b43a9aa9
-  data.tar.gz: 8f9606273f1db4c0dbf21530eed797f938ba1016
+  metadata.gz: 0c15dc8d788fbf1dad75cfa15fd8b55d65001061
+  data.tar.gz: f4990a2a88b29a723cb4ea4a004df2e88ab212ef
 SHA512:
-  metadata.gz: a4eebfa9d7e7ae1e7de4d98dbd8ebe9f7f2a9fadda4dbccb17f69053aba542c1070fc24364b949e8e36a2205b014173c89da31ecc61d36de68246f5b88049b15
-  data.tar.gz: 2a3a2cce693fe7d486957c8478314679f5f6ab00908fabdc56167c223975310e778cecd2024af165f5212e3eb260f6dde287eb93a0636d7645b8efbe55fb5c9f
+  metadata.gz: b38dbdbab7c04883d046ba31318f83b8bf29d3e963e5b91b13bd6bba64570f54cfe3709c93b74e360df89d8075eba44d429d660fcb784b5e36bc314a91466769
+  data.tar.gz: 288a1aee3ac64c651f629d56c363a35f46b09390b5d0fbeaee5a9848f9c45ef94329923b79f87b1c14bbf1521fac9265805ea0f9e45c1ec107822e56e1d2d862

data/bin/frecon

@@ -19,11 +19,9 @@ require "optparse"
 
 options = {
 	mode: :server,
-	configuration: {}
+	environment: FReCon::ENVIRONMENT
 }
 
-defaults = FReCon::ConfigurationFile.default.read
-
 optparse = OptionParser.new do |opts|
 	opts.banner = <<EOF
 Usage: #{$0} [OPTIONS] [MODE]
@@ -36,44 +34,21 @@ 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
+	opts.on("-o", "--host HOST", "Bind to HOST (default: #{options[:environment].server["host"]})") do |host|
+		options[:environment].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
+	opts.on("-p", "--port PORT", "Bind to port PORT (default: #{options[:environment].server["port"]})") do |port|
+		options[:environment].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
+	opts.on("-E", "--env ENVIRONMENT", "Run in the ENVIRONMENT environment (default: #{options[:environment].variable})") do |environment|
+		options[:environment].variable = environment.to_sym
 	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
@@ -89,11 +64,9 @@ ARGV.select do |arg|
 	end
 end
 
-configuration = FReCon::Configuration.construct!(argument_configuration: options[:configuration])
-
 case options[:mode]
 when :server
-	FReCon::Server.start(configuration: configuration)
+	FReCon::Server.start
 when :console
-	FReCon::Console.start(configuration: configuration)
+	FReCon::Console.start
 end

data/config/default.yml

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

data/lib/frecon/base/bson.rb

@@ -9,9 +9,11 @@
 
 # Public: An extension for the BSON module.
 module BSON
+
 	# Public: A monkey-patch for the BSON::ObjectId class which introduces an
 	# #as_json method.
 	class ObjectId
+
 		# Public: Get produce a JSON representation of this ObjectId.
 		#
 		# Since we don't want to produce a JSON Object for every ID, this method
@@ -21,5 +23,7 @@ module BSON
 		def as_json(*args)
 			to_s
 		end
+
 	end
+
 end

data/lib/frecon/base/environment.rb

@@ -0,0 +1,173 @@
+require "yaml"
+
+module FReCon
+
+	# Public: A class to represent the operational constraints for the FReCon
+	# instance.
+	class Environment
+
+		# Public: The configuration Hash for the server-related configuration.
+		#
+		# Keys will typically include "port", "host", etc.
+		attr_accessor :server
+
+		# Public: The configuration Hash for the console-related configuration.
+		attr_accessor :console
+
+		# Public: The configuration Hash for the database-related configuration.
+		#
+		# Keys will typically include "mongoid", which should be a Hash
+		# representation of a valid mongoid.yml file.
+		attr_accessor :database
+
+		# Public: Get the configuration variable.
+		#
+		# Returns the value of @variable.
+		attr_reader :variable
+
+		# Public: Validate, then set the configuration variable.
+		def variable=(symbol)
+			@variable = symbol if validate_symbol(symbol)
+		end
+
+		# Public: Initialize an Environment.
+		def initialize(symbol, server: {}, console: {}, database: {})
+			@variable = symbol if validate_symbol(symbol)
+
+			read_configurations
+
+			@server = @server.merge(server)
+			@console = @console.merge(console)
+			@database = @database.merge(database)
+
+			@server = @server.merge(server_defaults)
+			@console = @console.merge(console_defaults)
+			@database = @database.merge(database_defaults)
+		end
+
+		# Public: Read the various configurations on a system.
+		#
+		# Reads, then merges, the configurations present on a system.  Then, splices
+		# out the server, console, and database configurations and assigns them.
+		#
+		# If a configuration cannot be found, a value of {} is used for the merging,
+		# and it is considered to be simply noneffectual.  Defaults should always be
+		# specified in the default configuration file.
+		#
+		# Returns the merged configuration.
+		def read_configurations
+			# Read the configurations
+			default = default_configuration
+			system = system_configuration
+			user = user_configuration
+
+			# Create a configuration, initialize it to the default configuration.
+			#
+			# Then, merge with the system configuration, then the user configuration.
+			configuration = default || {}
+			configuration.merge(system || {})
+			configuration.merge(user || {})
+
+			# Grab out the "server", "console", and "database" values from the
+			# configuration and store those in the appropriate instance variables.
+			@server = configuration["server"] || {}
+			@console = configuration["console"] || {}
+			@database = configuration["database"] || {}
+
+			configuration
+		end
+
+		# Public: Read a configuration from a given filename.
+		#
+		# Uses YAML to parse the given filename.
+		#
+		# filename - String containing the path to a file.
+		#
+		# Returns a Hash containing the parsed data from the given file.
+		def read_configuration(filename)
+			YAML.load_file(filename) if (filename &&
+			                             File.exist?(filename) &&
+			                             File.readable?(filename))
+		end
+
+
+		# Public: Read and parse the defaults configuration file.
+		def default_configuration
+			read_configuration(default_configuration_filename)
+		end
+
+		# Public: Read and parse the system configuration file.
+		def system_configuration
+			read_configuration(system_configuration_filename)
+		end
+
+		# Public: Read and parse the user configuration file.
+		def user_configuration
+			read_configuration(user_configuration_filename)
+		end
+
+		protected
+
+		# Public: Generate the filename for the defaults configuration file.
+		def default_configuration_filename
+			File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "..", "config", "default.yml"))
+		end
+
+		# Public: Generate the filename for the system configuration file.
+		def system_configuration_filename
+			directories = (ENV['XDG_CONFIG_DIRS'] || '').split(':') ||
+				[File.join('', 'usr', 'share'),
+				 File.join('', 'usr', 'local', 'share')]
+
+			file = nil
+
+			directories.each do |directory|
+				check_file = File.join(directory, 'frecon', 'config.yml')
+				file = check_file if File.exist?(check_file)
+			end
+
+			file
+		end
+
+		# Public: Generate the filename for the user configuration file.
+		def user_configuration_filename
+			configuration_home = ENV['XDG_CONFIG_HOME'] || File.join(Dir.home, '.config')
+
+			if File.exist?(file = File.join(configuration_home, 'frecon.yml'))
+				file
+			end
+		end
+
+		# Public: Validate a value for @variable.
+		# 
+		# Checks the value for @variable against a list of valid environments.
+		def validate_symbol(symbol)
+			raise ArgumentError, "Environment variable is not one of #{self.valid_environments}" unless
+				valid_environments.include?(symbol)
+
+			true
+		end
+
+		# Public: Produce a list of valid environments.
+		def valid_environments
+			[:development, :production, :test]
+		end
+
+		# Public: Return a Hash representing the default server settings.
+		def server_defaults
+			{"host" => "localhost", "port" => 4567}
+		end
+
+		# Public: Return a Hash representing the default console settings.
+		def console_defaults
+			{}
+		end
+
+		# Public: Return a Hash representing the default database settings.
+		def database_defaults
+			{}
+		end
+
+	end
+
+end

data/lib/frecon/base/variables.rb

@@ -7,24 +7,13 @@
 # license with this program.  If not, please see
 # <http://opensource.org/licenses/MIT>.
 
+require "frecon/base/environment"
+
 # Public: The FReCon API module.
 module FReCon
 	# Public: A String representing the current version of FReCon.
-	VERSION = "1.2.0"
-
-	@environment_variable = :development
-
-	# Public: Returns the current environment.
-	def self.environment
-		@environment_variable
-	end
+	VERSION = "1.3.0"
 
-	# Public: Sets the environment.
-	#
-	# arg - The new environment.
-	#
-	# Returns the result from setting the current environment.
-	def self.environment=(arg)
-		@environment_variable = arg
-	end
+	# Public: An Environment representing the system execution environment.
+	ENVIRONMENT = Environment.new(:development)
 end

data/lib/frecon/base.rb

@@ -9,4 +9,5 @@
 
 require "frecon/base/bson"
 require "frecon/base/object"
+require "frecon/base/environment"
 require "frecon/base/variables"

data/lib/frecon/console.rb

@@ -8,7 +8,6 @@
 # <http://opensource.org/licenses/MIT>.
 
 require "frecon/base/variables"
-require "frecon/configuration"
 require "frecon/database"
 require "frecon/server"
 
@@ -17,13 +16,9 @@ module FReCon
 	class Console
 		# Public: Starts the FReCon console.
 		#
-		# :configuration - The Configuration to use when starting the console.
-		#
 		# Returns the result of running pry on FReCon.
-		def self.start(configuration: Configuration.construct!)
-			environment = configuration["frecon"]["console"]["environment"]
-			mongoid = configuration["frecon"]["database"]["mongoid"]
-			Database.setup(environment, mongoid)
+		def self.start
+			Database.setup!
 
 			require "pry"
 

data/lib/frecon/database.rb

@@ -9,6 +9,8 @@
 
 require "logger"
 
+require "frecon/base/variables"
+
 require "mongoid"
 require "frecon/mongoid/criteria"
 
@@ -21,25 +23,10 @@ module FReCon
 	# Public: A system to set up the database.
 	class Database
 		# Public: Set up the database.
-		#
-		# environment - Symbol containing environment to start the database in.
-		# mongoid     - Hash containing the configuration for Mongoid. If not
-		#               present, the lib/frecon/mongoid.yml file is given to
-		#               Mongoid.load!.  If present, the Hash is dumped to a
-		#               tempfile which is given to Mongoid.load!.
-		def self.setup(environment = FReCon.environment, mongoid = nil)
-			if mongoid.is_a?(Hash)
-				mongoid_tempfile = Tempfile.new("FReCon")
-
-				mongoid_tempfile.write(mongoid.to_h.to_yaml)
-				mongoid_tempfile.rewind
-
-				Mongoid.load!(mongoid_tempfile.path, environment)
-			else
-				Mongoid.load!(File.join(File.dirname(__FILE__), "mongoid.yml"), environment)
-			end
+		def self.setup!
+			Mongoid.load!(File.join(File.dirname(__FILE__), "mongoid.yml"), FReCon::ENVIRONMENT.variable)
 
-			if environment == :development
+			if FReCon::ENVIRONMENT.console["level"]
 				Mongoid.logger.level = Logger::DEBUG
 				Mongoid.logger = Logger.new($stdout)
 

data/lib/frecon/server.rb

@@ -10,7 +10,6 @@
 require "sinatra/base"
 
 require "frecon/base/variables"
-require "frecon/configuration"
 require "frecon/database"
 require "frecon/routes"
 require "frecon/controllers"
@@ -26,45 +25,32 @@ module FReCon
 
 		# Public: Start the Server.
 		#
-		# keyword_arguments - The Hash of arguments to use.
-		#                     :configuration - The Configuration to use when
-		#                                      setting up the server.
-		#
 		# Returns the result of starting the server.
-		def self.start(**keyword_arguments)
-			run!(**keyword_arguments)
+		def self.start(*arguments)
+			run!(*arguments)
 		end
 
 		protected
 
 		# Internal: Set up the server.
 		#
-		# Sets the various Thin and Sinatra options, and sets up the database.
-		#
-		# :configuration - The Configuration to use when starting the server.
+		# Sets various Thin and Sinatra options, and sets up the database.
 		#
 		# Returns the result of setting up the database.
-		def self.setup!(configuration: Configuration.construct!)
+		def self.setup!
 			# Set the Thin and Sinatra options.
 			set :server, %w[thin HTTP webrick]
-			set :bind, configuration["frecon"]["server"]["host"]
-			set :port, configuration["frecon"]["server"]["port"]
-			set :environment, configuration["frecon"]["server"]["environment"]
-
-			# Grab out the mongoid configuration.
-			mongoid = configuration["frecon"]["database"]["mongoid"]
+			set :bind, FReCon::ENVIRONMENT.server["host"]
+			set :port, FReCon::ENVIRONMENT.server["port"]
+			set :environment, FReCon::ENVIRONMENT.variable.to_s
 
 			# Set up the database.
-			Database.setup(environment, mongoid)
+			Database.setup!
 		end
 
 		# Internal: Set up the server and start it.
-		#
-		# keyword_arguments - The Hash of arguments to use.
-		#                     :configuration - The Configuration to use when
-		#                                      setting up the server.
-		def self.run!(**keyword_arguments)
-			setup!(**keyword_arguments)
+		def self.run!(*arguments)
+			setup!(*arguments)
 
 			super
 		end

data/lib/frecon.rb

@@ -18,8 +18,6 @@ require "frecon/models"
 require "frecon/scraper"
 require "frecon/scrapers"
 
-require "frecon/configuration"
-require "frecon/configuration_file"
 require "frecon/match_number"
 require "frecon/position"
 require "frecon/request_error"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frecon
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sam Craig
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-12 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -184,10 +184,9 @@ files:
 - lib/frecon.rb
 - lib/frecon/base.rb
 - lib/frecon/base/bson.rb
+- lib/frecon/base/environment.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

data/lib/frecon/configuration.rb

@@ -1,91 +0,0 @@
-# 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
-	# Public: A wrapper to allow the manipulation of configurations.
-	class Configuration < Hash
-		# Public: Initialize a Configuration.
-		#
-		# data - a Hash representing the data.
-		def initialize(data)
-			data.each do |key, value|
-				self[key] = value
-			end
-		end
-
-		# Public: Convert self to a Hash.
-		#
-		# Recursively converts instances of Configuration within self
-		# to hashes by calling this method.
-		#
-		# Returns a Hash representing self.
-		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
-
-		# Public: Merge with another Configuration.
-		#
-		# Sets all key-value pairs within Configuration to the same within self.
-		#
-		# other - A Configuration or Hash to be merged with.
-		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
-
-		# Public: Constructs a configuration.
-		#
-		# options - A Hash containing various configurations.
-		#           :default_configuration  - The default configuration's values
-		#           :system_configuration   - The system's configuration's values
-		#           :user_configuration     - The user's configuration's values
-		#           :argument_configuration - The configuration values from command-line arguments
-		#
-		# Returns a Configuration generated by merging all of the given
-		# configurations together.
-		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

@@ -1,68 +0,0 @@
-# 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
-	# Public: A class to handle configuration files.
-	class ConfigurationFile
-		# Public: The filename for the file.
-		attr_accessor :filename
-
-		# Public: Initialize a ConfigurationFile.
-		#
-		# filename - The name of the file.
-		def initialize(filename)
-			@filename = filename
-		end
-
-		# Public: Read from the file and generate a Configuration
-		# from the YAML data therein.
-		#
-		# Returns a Configuration representing the file's data or nil if it didn't
-		# exist.
-		def read
-			begin
-				data = open(@filename, "rb") do |io|
-					io.read
-				end
-
-				Configuration.new(YAML.load(data))
-			rescue Errno::ENOENT
-				nil
-			end
-		end
-
-		# Public: Create a new ConfigurationFile corresponding to the default
-		# defaults configuration location.
-		def self.default
-			self.new(File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "config", "default.yml")))
-		end
-
-		# Public: Create a new ConfigurationFile corresponding to the default
-		# system configuration location.
-		def self.system
-			self.new(File.join("", "etc", "frecon", "config.yml"))
-		end
-
-		# Public: Create a new ConfigurationFile corresponding to the default
-		# user configuration location.
-		def self.user
-			self.new(File.join(config_directory, "frecon.yml"))
-		end
-
-		protected
-
-		# Public: Returns the User's config home directory.
-		def self.config_directory
-			ENV['XDG_CONFIG_HOME'] || File.join(Dir.home, '.config')
-		end
-	end
-end