settings_spec 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73c75fa0d47ef93ab5ff71705e0ef6ed18d24ace
-  data.tar.gz: 53674bca88cba8e549beb27caa892178ad55ea59
+  metadata.gz: 6f0c66fe5378c6861f66a445285d47022bbd94a1
+  data.tar.gz: c1f52bc7e4028265dc6f2263f65d765d7527db28
 SHA512:
-  metadata.gz: 06a40d1d51bf5497a05c65fb6de5a8a06c4822b83ffa63c2d110ee28f3a86ad38bd23028622e39e5517ffd22383bc5795878a3702924cfe1603706203dd6e03b
-  data.tar.gz: 054e05de667d00c3b51cd98c1d658d3e63489a491219138b0e836c1ac0eabe68735020764f17a8de6c460332a234962536a55b2f7d3bcbfe2ce9d0491df143cf
+  metadata.gz: 8b865a786ea1f6d7bb3d0bb9b076979c53b06aa16209a45210c962f8720dbdde8f7a98ae56ce1e6a3c8531cb80b2cae553ff8465a1754683fda9450905f1e906
+  data.tar.gz: e2e5b11db0e5cae4ac56afd2c69413b40afffae92921070418f0487a2b8469241df07d19fc69145263296ac5fdd99a3364c8967d9e48b1f3b60ff8e928e1442f

data/.gitignore

@@ -21,3 +21,4 @@ tmp
 *.a
 mkmf.log
 .DS_Store
+.ruby-version

data/.travis.yml

@@ -1,3 +1,7 @@
 language: ruby
 rvm:
+  - 1.9.3
   - 2.1.2
+
+script:
+  - bundle exec rake

data/README.md

@@ -1,5 +1,7 @@
 # SettingsSpec
 
+[![Build Status](https://travis-ci.org/YanhaoYang/settings_spec.svg?branch=master)](https://travis-ci.org/YanhaoYang/settings_spec)
+
 There are many tools to load configurations in Rails, such as
 [rais\_config](https://github.com/railsconfig/rails_config),
 [settingslogic](https://github.com/binarylogic/settingslogic).
@@ -22,6 +24,9 @@ you write rules to validate the configuration file, so that you know
 the configuration file is all right before an invalid configuration
 file breaks the application.
 
+It is tested on Ruby 1.9.3, 2.1.2. It should also work on Ruby 1.8.7,
+but you have to use `lambda` rather than `->`.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -101,7 +106,7 @@ Suppose the specification file is loaded this way:
 
 ## Contributing
 
-1. Fork it ( https://github.com/YanhaoYang/settings\_spec/fork )
+1. Fork it [https://github.com/YanhaoYang/settings\_spec/fork](https://github.com/YanhaoYang/settings_spec/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/settings_spec.rb

@@ -7,6 +7,21 @@ module SettingsSpec
 
   class InvalidSpec < StandardError; end
 
+  # Loads specifications from +spec_file+, a YAML file. The +spec_file+ can be
+  # composed of several sections for different environments, like:
+  #
+  #   defaults: &defaults
+  #     ...
+  #   development:
+  #     <<: *defaults
+  #     ...
+  #   test:
+  #     <<: *defaults
+  #     ...
+  #
+  # +namespace+ is used to specify the environment. In a Rails application, it
+  # may be +Rails.env+ usually.
+  #
   def self.load(spec_file, namespace)
     specs = YAML.load_file(spec_file)
     specs = specs[namespace] if namespace

data/lib/settings_spec/specs.rb

@@ -1,6 +1,7 @@
 module SettingsSpec
   class Specs
 
+    # A Hash whose keys are the keys of the invalid entries joined by "."
     attr_reader :errors
 
     def initialize(specs)
@@ -8,14 +9,23 @@ module SettingsSpec
       @errors = {}
     end
 
+    # Verifies the +settings+ against the specifications having been loaded.
+    #
+    # +settings+ can be a Hash, or any object responding to <tt>:[]</tt> or
+    # keys in the settings.
+    #
+    # Returns +true+ if there is no error, +false+ if there are errors. Errors can
+    # be accessed by <tt>Specs#errors</tt>.
     def verify(settings)
       if settings
         check([], @specs, settings)
       else
         @errors['.'] = 'Settings is a nil?!'
       end
+      @errors.empty?
     end
 
+    # Same as <tt>Specs#verify</tt>, but raises an exception when the settings are invalid.
     def verify!(settings)
       verify(settings)
       unless @errors.empty?

data/lib/settings_spec/version.rb

@@ -1,3 +1,3 @@
 module SettingsSpec
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/settings_spec.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.3.2"
-  spec.add_development_dependency "rspec", "~> 3.0.0"
-  spec.add_development_dependency "settingslogic", "~> 2.0.9"
-  spec.add_development_dependency "rails_config", "~> 0.4.2"
-  spec.add_development_dependency "app_config", "~> 2.5.1"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "settingslogic", "~> 2.0"
+  spec.add_development_dependency "rails_config", "~> 0.4"
+  spec.add_development_dependency "app_config", "~> 2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settings_spec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Yanhao Yang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-06 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,70 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: settingslogic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.9
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.9
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rails_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: app_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.1
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.1
+        version: '2.5'
 description: Verifies the configurations against the specifications in a YAML file
 email:
 - yanhao.yang@gmail.com