easyconf-rails 0.2 → 0.2.1

data/README.md

@@ -58,3 +58,33 @@ Now you're ready to use `config` in your application.
 
 	# You can reload your configuration file by with .reload!.
 	$config.reload!
+
+BIG RED WARNING
+---------------
+
+`$config` is a *mutable global variable*, and should therefore be treated with
+extreme caution. In particular, `$config.reload!` will reset the value of
+`$config` in *all* threads; it is therefore important to ensure that a program's
+corrent functioning does not rely on subsequent accesses to the `$config` value
+to be consistent.
+
+THE WRONG WAY
+^^^^^^^^^^^^^
+
+	Person[$config.good_guy].kill(Person[$config.bad_guy])
+
+is wrong because `$config.reload!` could have been called after evaluating the
+value of `Person[$config.good_guy]`, but *before* calling its _kill()_ method.
+If `$config.bad_guy` was set to the former value of `$config.good_guy`, we would
+be asking `Person[$config.bad_guy]` to kill itself.
+
+THE RIGHT WAY
+^^^^^^^^^^^^^
+
+	$config.lock do
+		Person[config.good_guy].kill(Person[config.bad_guy])
+	end
+
+is correct because this gaurantees that `config.bad_guy` and `config.good_guy`
+are consistent. Even if they're switched in the interim, no one will ever be
+asked to kill themselves.

data/lib/easyconf-rails.rb

@@ -41,6 +41,47 @@ class SemiOpenStruct < OpenStruct
 end
 
 class EasyConfRails < Rails::Railtie
+	# This is a base class for easyconf errors.
+	class EasyConfError < Exception
+	end
+
+	# NonexistentConfig is raise when config.yml doesn't exist.
+	class NonexistentConfig < EasyConfError
+		def initialize(msg="config.yml doesn't exist.")
+			super(msg)
+		end
+	end
+
+	# InvalidConfig is raised when config.yml is invalid YAML.
+	class InvalidConfig < EasyConfError
+		# @line is the line where the syntax error occurred.
+		attr_reader :line
+		# @coulumn is the column where the syntax error occurred.
+		attr_reader :column
+
+		def initialize(line, column, msg="Syntax error in config.yml at line "\
+		                                 "#{line}, column #{column}")
+			@line = line
+			@column = column
+			super(msg)
+		end
+	end
+
+	# InvalidDefaults is raised when config/defaults.yml is invalid YAML.
+	class InvalidDefaults < EasyConfError
+		# @line is the line where the syntax error occurred.
+		attr_reader :line
+		# @coulumn is the column where the syntax error occurred.
+		attr_reader :column
+
+		def initialize(line, column, msg="Syntax error in config/defaults.yml at "\
+		                                 "line #{line}, column #{column}")
+			@line = line
+			@column = column
+			super(msg)
+		end
+	end
+
 	# Turn a Hash or Array and all of its Hash children into OpenStructs.
 	def hash_to_openstruct(hash)
 		(hash.is_a?(Hash) ? hash.keys : (0...hash.length)).each do |key|
@@ -81,14 +122,22 @@ class EasyConfRails < Rails::Railtie
 	def load_config()
 		config_location = Rails.root + 'config.yml'
 		if File.exists?(config_location)
-			config_hash = YAML.load_file(config_location)
+			begin
+				config_hash = YAML.load_file(config_location)
+			rescue Psych::SyntaxError => ex
+				raise InvalidConfig.new(ex.line, ex.column)
+			end
 		else
-			config_hash = {}
+			raise(NonexistentConfig)
 		end
 
 		defaults_location = Rails.root + 'config' + 'defaults.yml'
 		if File.exists?(defaults_location)
-			defaults_hash = YAML.load_file(defaults_location)
+			begin
+				defaults_hash = YAML.load_file(defaults_location)
+			rescue Psych::SyntaxError => ex
+				raise InvalidDefaults.new(ex.line, ex.column)
+			end
 		else
 			defaults_hash = {}
 		end
@@ -104,6 +153,15 @@ class EasyConfRails < Rails::Railtie
 	end
 
 	config.before_initialize do
-		assign_config()
+		begin
+			assign_config()
+		rescue NonexistentConfig, InvalidConfig, InvalidDefaults
+			warn($!.message)
+			exit(1)
+		end
+	end
+
+	trap(:HUP) do
+		$config.reload!
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easyconf-rails
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,52 +9,39 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain:
-- ! '-----BEGIN CERTIFICATE-----
-
-  MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA90aGUu
-
-  bWFnaWNhbC5rYXQxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
-
-  ARkWA2NvbTAeFw0xMTA4MjEyMjMyMDFaFw0xMjA4MjAyMjMyMDFaMEYxGDAWBgNV
-
-  BAMMD3RoZS5tYWdpY2FsLmthdDEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
-
-  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
-
-  pBt20nwjs5W03djpRN6FAbpiio286NHMTk6HhmjV6GZKOi5ZUX5onTnKUg2Vc35z
-
-  /nK+aIPReyRfBgIcfSjhoXh1A1Dp+2laNgTtU/3eMupruatgORAPCSaG9Ns+HSyR
-
-  vySbz1QUrwvlvF0qkhhApNQ6dsLl2LMOV3QcluY+Y3CVccOWOSHdQcnAbPuzM9Hf
-
-  4ChI4OGL7+DwLA5OK2S5uewRAa2iLkJSN0WugnQlJqMT59GRaqTDOtnYQpiyKEBy
-
-  QjVPO4LNk7iDsJP22YBrveIzm8/YYRBTU4LTHMEMOyCszrYqD2S1Lwp2rtCJzQCl
-
-  BA0LtBKrZl5mwZm7qyj+TwIDAQABozkwNzAJBgNVHRMEAjAAMB0GA1UdDgQWBBSm
-
-  s5arhjp61kmGl6wsmLYkqerdqDALBgNVHQ8EBAMCBLAwDQYJKoZIhvcNAQEFBQAD
-
-  ggEBAA6cQNQMOPRy4yrj7Nh5Mb9qq8t/8ho/JQvjzVof9qRd+kfKrOoOhXfEO+Rm
-
-  sWcaOnBCVC4DnZuNDSLygVhCDtMnHjg/JsfO/GBF/QlNTJOO1jkoQiS6w0KARlBm
-
-  cpXaWg/oMtXJ2PaUga6WkNeXYf9Mad36P4yuGQScjs+WkUUy7DNZvTGReIcCWOR8
-
-  jteSvvCMobQKGr2DfFOU9Jiddh2FPpz/KOM2ijzwsVNUMUr7R58LoCnQZrZ/YaRW
-
-  ob6QnVgwqu5SUAKQxlFJ/aKlPMj735z8EogaZC1ZHgg3vkgGGyu57N/8BDDG0TzC
-
-  Zn3u2leVae/fJ03zYGArhuJKPgc=
-
-  -----END CERTIFICATE-----
-
-'
-date: 2012-02-25 00:00:00.000000000 Z
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURRRENDQWlpZ0F3SUJB
+  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREJHTVJnd0ZnWURWUVFEREE5MGFH
+  VXUKYldGbmFXTmhiQzVyWVhReEZUQVRCZ29Ka2lhSmsvSXNaQUVaRmdWbmJX
+  RnBiREVUTUJFR0NnbVNKb21UOGl4awpBUmtXQTJOdmJUQWVGdzB4TVRBNE1q
+  RXlNak15TURGYUZ3MHhNakE0TWpBeU1qTXlNREZhTUVZeEdEQVdCZ05WCkJB
+  TU1EM1JvWlM1dFlXZHBZMkZzTG10aGRERVZNQk1HQ2dtU0pvbVQ4aXhrQVJr
+  V0JXZHRZV2xzTVJNd0VRWUsKQ1pJbWlaUHlMR1FCR1JZRFkyOXRNSUlCSWpB
+  TkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4QU1JSUJDZ0tDQVFFQQpwQnQyMG53
+  anM1VzAzZGpwUk42RkFicGlpbzI4Nk5ITVRrNkhobWpWNkdaS09pNVpVWDVv
+  blRuS1VnMlZjMzV6Ci9uSythSVBSZXlSZkJnSWNmU2pob1hoMUExRHArMmxh
+  TmdUdFUvM2VNdXBydWF0Z09SQVBDU2FHOU5zK0hTeVIKdnlTYnoxUVVyd3Zs
+  dkYwcWtoaEFwTlE2ZHNMbDJMTU9WM1FjbHVZK1kzQ1ZjY09XT1NIZFFjbkFi
+  UHV6TTlIZgo0Q2hJNE9HTDcrRHdMQTVPSzJTNXVld1JBYTJpTGtKU04wV3Vn
+  blFsSnFNVDU5R1JhcVRET3RuWVFwaXlLRUJ5ClFqVlBPNExOazdpRHNKUDIy
+  WUJydmVJem04L1lZUkJUVTRMVEhNRU1PeUNzenJZcUQyUzFMd3AycnRDSnpR
+  Q2wKQkEwTHRCS3JabDVtd1ptN3F5aitUd0lEQVFBQm96a3dOekFKQmdOVkhS
+  TUVBakFBTUIwR0ExVWREZ1FXQkJTbQpzNWFyaGpwNjFrbUdsNndzbUxZa3Fl
+  cmRxREFMQmdOVkhROEVCQU1DQkxBd0RRWUpLb1pJaHZjTkFRRUZCUUFECmdn
+  RUJBQTZjUU5RTU9QUnk0eXJqN05oNU1iOXFxOHQvOGhvL0pRdmp6Vm9mOXFS
+  ZCtrZktyT29PaFhmRU8rUm0Kc1djYU9uQkNWQzREblp1TkRTTHlnVmhDRHRN
+  bkhqZy9Kc2ZPL0dCRi9RbE5USk9PMWprb1FpUzZ3MEtBUmxCbQpjcFhhV2cv
+  b010WEoyUGFVZ2E2V2tOZVhZZjlNYWQzNlA0eXVHUVNjanMrV2tVVXk3RE5a
+  dlRHUmVJY0NXT1I4Cmp0ZVN2dkNNb2JRS0dyMkRmRk9VOUppZGRoMkZQcHov
+  S09NMmlqendzVk5VTVVyN1I1OExvQ25RWnJaL1lhUlcKb2I2UW5WZ3dxdTVT
+  VUFLUXhsRkovYUtsUE1qNzM1ejhFb2dhWkMxWkhnZzN2a2dHR3l1NTdOLzhC
+  RERHMFR6QwpabjN1MmxlVmFlL2ZKMDN6WUdBcmh1SktQZ2M9Ci0tLS0tRU5E
+  IENFUlRJRklDQVRFLS0tLS0K
+date: 2012-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &78323930 !ruby/object:Gem::Requirement
+  requirement: &74240240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -62,7 +49,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *78323930
+  version_requirements: *74240240
 description: Configure Rails apps with a simple YAML file.
 email: the.magical.kat@gmail.com
 executables: []