fwissr 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,15 @@
---- 
-SHA1: 
-  metadata.gz: 7b60e1c93fd5fdd4b3d8b81f044bf954eebe4983
-  data.tar.gz: 540b15881e2030ec311ea5872e77e8704a98f4d4
-SHA512: 
-  metadata.gz: f66e1dc7a1ceca8a2ca76b45ea97a02d2eaaf28d25f6e12b20e1789c83ea039fa13192502fd3bb2bbc70e1c07c2d2c5e90efa084bd82ca5b9a4d3db5f9be1ea1
-  data.tar.gz: 147b2802a910e2aba9ae169c6bd8769ec6c584699ad337e005039d339f9a0a6e155745bc206be8acac5e37bbd1299ec0d92d2a6e22b34eeeda5a3a3e2976b3fe
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjAwYWY0ZDQ1ODQwZWM2ZGY5MDEwZDFlMmUwODM5OGYzYWU0ZWEzZQ==
+  data.tar.gz: !binary |-
+    NzNiZjU0MzQwOTRiZDkzYzIwNGNhMDMyODk3OGU5MjFmYzg0MjZkMw==
+SHA512:
+  metadata.gz: !binary |-
+    ODU1NmM4ZDFhZjU2NmMzMmQ3YTVmMzZjY2UyMjVlMTI4ODJlYzc4MmJjOTY4
+    NjVlMDFjY2VmMTBhZGUyZDcyZDE3ODBlMzhkZjNlZjU1YWU3OTJiYTAwYjAz
+    M2VjOGNjYjQxYzgzYjU2NTQ0MGE5NWJlNjQ3NjU0MGMzN2Y4ZGU=
+  data.tar.gz: !binary |-
+    MDA0NmIzM2RlYzI1Mzg0NjE0NGY3M2ZlOTc2YTEyODUxODVjMWE3YzMwMjVm
+    MzgxODAwYzhjYzcyMzZjOGQ3MGE0MmNjMDJhNzViMWExZGE0MDRkMzc0OGMx
+    OTU4YWFmZjgwYTRiNjJkOTMwNTRiZWE5MzFhMTJkZGE0YzQyMzE=

data/lib/fwissr.rb

@@ -17,17 +17,14 @@ require 'fwissr/source'
 require 'fwissr/registry'
 
 #
-# Global Registry
-# ===============
+# Fwissr loads all conf files in directories: +/etc/fwissr/+ and +~/.fwissr/+
 #
-# Fwissr loads all conf files in main directories: +/etc/fwissr/+ and +~/.fwissr/+
+# Two conf files are handled differently: +/etc/fwissr/fwissr.json+ and +~/.fwissr/fwissr.json+
 #
-# Two conf files are treated differently: +/etc/fwissr/fwissr.json+ and +~/.fwissr/fwissr.json+
+# These two main conf files are 'top_level' ones and so their settings are added to registry root. They can
+# too contain a +fwissr_sources+ setting that is used to setup additional sources.
 #
-# These two main conf files are 'top_level' ones and so their settings are added to global registry root. They can
-# too contain a +fwissr_sources+ setting that is then used to setup additional sources.
-#
-# Global registry is accessed with Fwissr#[] method
+# Registry is accessed with Fwissr#[] method
 #
 # @example +/etc/fwissr/fwissr.json+ file:
 #
@@ -38,7 +35,7 @@ require 'fwissr/registry'
 #      { 'mongodb': 'mongodb://db1.example.net/my_app', 'collection': 'config', 'refresh': true },
 #    ],
 #    'fwissr_refresh_period': 30
-# }
+#  }
 #
 module Fwissr
 
@@ -55,13 +52,19 @@ module Fwissr
     attr_writer :main_conf_path, :main_user_conf_path
 
     # Main config files directory
+    #
     # @api private
+    #
+    # @return [String] Directory path
     def main_conf_path
       @main_conf_path ||= DEFAULT_MAIN_CONF_PATH
     end
 
     # User's specific config files directory
+    #
     # @api private
+    #
+    # @return [String] Directory path
     def main_user_conf_path
       @main_user_conf_path ||= File.join(Fwissr.find_home, DEFAULT_MAIN_USER_CONF_DIR)
     end
@@ -70,6 +73,8 @@ module Fwissr
     #
     # @note Borrowed from rubygems
     # @api private
+    #
+    # @return [String] Directory path
     def find_home
       ['HOME', 'USERPROFILE'].each do |homekey|
         return ENV[homekey] if ENV[homekey]
@@ -91,6 +96,7 @@ module Fwissr
     end
 
     # Parse command line arguments
+    #
     # @api private
     def parse_args!(argv)
       args = {
@@ -149,8 +155,11 @@ module Fwissr
       args
     end
 
-    # Load global registry
+    # Load registry
+    #
     # @api private
+    #
+    # @return [Hash] Registry
     def global_registry
       @global_registry ||= begin
         result = Fwissr::Registry.new('refresh_period' => self.main_conf['fwissr_refresh_period'])
@@ -179,7 +188,10 @@ module Fwissr
     end
 
     # Main config
+    #
     # @api private
+    #
+    # @return [Hash] Configuration from main +fwissr.json+ files
     def main_conf
       @main_conf ||= begin
         result = { }
@@ -197,34 +209,42 @@ module Fwissr
     end
 
     # Main config file
+    #
     # @api private
+    #
+    # @return [String] File path
     def main_conf_file
       @main_conf_file ||= File.join(self.main_conf_path, MAIN_CONF_FILE)
     end
 
     # Main user's config file
+    #
     # @api private
+    #
+    # @return [String] File path
     def main_user_conf_file
       @main_user_conf_file ||= File.join(self.main_user_conf_path, MAIN_CONF_FILE)
     end
 
-    # Global registry accessor
+    # Registry accessor
     #
-    # @param key [String] setting key
-    # @return [Object] setting value
+    # @param key [String] Setting key
+    # @return [Object] Setting value
     def [](key)
       self.global_registry[key]
     end
 
     alias :get :[]
 
-    # Dumps global registry keys
+    # Dumps registry keys
     #
     # @return [Array] Keys list
     def keys
       self.global_registry.keys
     end
 
+    # Dumps registry
+    #
     # @return [Hash] The entire registry
     def dump
       self.global_registry.dump
@@ -237,9 +257,10 @@ module Fwissr
 
     # Parse a configuration file
     #
-    # @param conf_file_path [String] Configuration file path
-    # @return [Hash] Parse configuration
     # @api private
+    #
+    # @param conf_file_path [String] Configuration file path
+    # @return [Hash] Parsed configuration
     def parse_conf_file(conf_file_path)
       conf_file_ext = File.extname(conf_file_path)
 
@@ -259,14 +280,26 @@ module Fwissr
       end
     end
 
+    # Merge two conf files
+    #
     # @note Borrowed from rails
     # @api private
+    #
+    # @param to_hash [Hash] Merge to this conf
+    # @param other_hash [Hash] Merge this conf
+    # @return [Hash] Merged configuration
     def merge_conf(to_hash, other_hash)
       self.merge_conf!(to_hash.dup, other_hash)
     end
 
+    # Merge two conf files (in place)
+    #
     # @note Borrowed from rails
     # @api private
+    #
+    # @param to_hash [Hash] Merge to this conf
+    # @param other_hash [Hash] Merge this conf
+    # @return [Hash] Merged configuration
     def merge_conf!(to_hash, other_hash)
       other_hash.each_pair do |k,v|
         tv = to_hash[k]
@@ -276,7 +309,11 @@ module Fwissr
     end
 
     # Simple deep freezer
+    #
     # @api private
+    #
+    # @param obj [Object] Object to freeze
+    # @return [Object] Deep frozen object
     def deep_freeze(obj)
       if obj.is_a?(Hash)
         obj.each do |k, v|

data/lib/fwissr/registry.rb

@@ -11,8 +11,10 @@ module Fwissr
     # API
     #
 
+    # [Integer] Refresh period
     attr_reader :refresh_period
 
+    # Init
     def initialize(options = { })
       @refresh_period = options['refresh_period'] || DEFAULT_REFRESH_PERIOD
 
@@ -54,6 +56,7 @@ module Fwissr
     # Get a registry key value
     #
     # @param key [String] Key
+    # @return [Object] Value
     def get(key)
       # split key
       key_ary = key.split('/')
@@ -99,6 +102,8 @@ module Fwissr
     end
 
     # @api private
+    #
+    # @return [true,false] Is there at least one refreshable source ?
     def have_refreshable_source?
       @semaphore.synchronize do
         !@sources.find { |source| source.can_refresh? }.nil?
@@ -160,6 +165,7 @@ module Fwissr
     end
 
     # Helper for #keys
+    #
     # @api private
     def _keys(result, key_ary, hash)
       hash.each do |key, value|

data/lib/fwissr/source.rb

@@ -5,6 +5,10 @@ class Fwissr::Source
   autoload :Mongodb, 'fwissr/source/mongodb'
 
   class << self
+    # Instanciate source from settings
+    #
+    # @param settings [Hash] Source settings
+    # @return [Fwissr::Source::File, Fwissr::Source::Mongodb] Source instance
     def from_settings(settings)
       raise "Unexpected source settings class: #{settings.inspect}" unless settings.is_a?(Hash)
 
@@ -23,8 +27,10 @@ class Fwissr::Source
   # API
   #
 
+  # [Hash] Source options
   attr_reader :options
 
+  # Init
   def initialize(options = { })
     @options = options
 
@@ -38,7 +44,7 @@ class Fwissr::Source
 
   # Source can be refreshed ?
   #
-  # @return [Boolean] Is it a refreshable source ?
+  # @return [true,false] Is it a refreshable source ?
   def can_refresh?
     @options && (@options['refresh'] == true)
   end
@@ -59,6 +65,7 @@ class Fwissr::Source
   # Fetch conf from source
   #
   # @abstract MUST be implemented by child class
+  #
   # @return [Hash] The source's configuration
   def fetch_conf
     raise "not implemented"

data/lib/fwissr/source/file.rb

@@ -30,8 +30,10 @@ class Fwissr::Source::File < Fwissr::Source
   end # class << self
 
 
+  # [Array] Files names corresponding to 'top level' configurations
   TOP_LEVEL_CONF_FILES = [ 'fwissr' ].freeze
 
+  # [String] File path
   attr_reader :path
 
   #
@@ -71,7 +73,12 @@ class Fwissr::Source::File < Fwissr::Source
   # PRIVATE
   #
 
+  # Merge two conf files
+  #
   # @api private
+  #
+  # @param result [Hash] Merge to that existing conf
+  # @param conf_file_path [String] File path
   def merge_conf_file!(result, conf_file_path)
     # parse conf file
     conf = Fwissr.parse_conf_file(conf_file_path)

data/lib/fwissr/source/mongodb.rb

@@ -17,8 +17,10 @@ class Fwissr::Source::Mongodb < Fwissr::Source
   # @api private
   class Connection
 
+    # [String] Database name
     attr_reader :db_name
 
+    # Init
     def initialize(uri)
       raise "URI is missing: #{uri}" if (uri.nil? || uri == '')
 
@@ -59,6 +61,9 @@ class Fwissr::Source::Mongodb < Fwissr::Source
     end
 
     # Database collection
+    #
+    # @param col_name [String] Collection name
+    # @return [Object] Collection handler
     def collection(col_name)
       @collections[col_name] ||= begin
         case @kind
@@ -71,6 +76,9 @@ class Fwissr::Source::Mongodb < Fwissr::Source
     end
 
     # Returns an Enumerator for all documents from given collection
+    #
+    # @param col_name [String] Collection name
+    # @return [Enumerator] Collection enumerator
     def fetch(col_name)
       case @kind
       when :moped, :mongo
@@ -79,6 +87,9 @@ class Fwissr::Source::Mongodb < Fwissr::Source
     end
 
     # Insert document in collection
+    #
+    # @param col_name [String] Collection name
+    # @param doc [Hash] Document to insert
     def insert(col_name, doc)
       case @kind
       when :moped, :mongo
@@ -87,6 +98,8 @@ class Fwissr::Source::Mongodb < Fwissr::Source
     end
 
     # Create a collection
+    #
+    # @param col_name [String] Collection name
     def create_collection(col_name)
       case @kind
       when :moped
@@ -97,6 +110,8 @@ class Fwissr::Source::Mongodb < Fwissr::Source
     end
 
     # Drop database
+    #
+    # @param db_name [String] Database name
     def drop_database(db_name)
       case @kind
       when :moped
@@ -127,7 +142,12 @@ class Fwissr::Source::Mongodb < Fwissr::Source
       self.new(conn, settings['collection'], options)
     end
 
+    # Get a memoized connection
+    #
     # @api private
+    #
+    # @param uri [String] Connection URI
+    # @return [Fwissr::Source::Mongodb::Connection] Connection handler
     def connection_for_uri(uri)
       @connections ||= { }
       @connections[uri] ||= Fwissr::Source::Mongodb::Connection.new(uri)
@@ -135,7 +155,7 @@ class Fwissr::Source::Mongodb < Fwissr::Source
 
   end # class << self
 
-
+  # [Array] Collection names corresponding to 'top level' configurations
   TOP_LEVEL_COLLECTIONS = [ 'fwissr' ].freeze
 
   attr_reader :conn, :collection_name

data/lib/fwissr/version.rb

@@ -1,3 +1,4 @@
 module Fwissr
-  VERSION = '1.0.1'
+  # [String] Fwissr version
+  VERSION = '1.0.2'
 end

metadata

@@ -1,46 +1,54 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: fwissr
-version: !ruby/object:Gem::Version 
-  version: 1.0.1
+version: !ruby/object:Gem::Version
+  version: 1.0.2
 platform: ruby
-authors: 
+authors:
 - Fotonauts Team
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-12-03 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: yajl-ruby
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id002 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-description: "  A simple configuration registry tool by Fotonauts.\n"
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! '  A simple configuration registry tool by Fotonauts.
+
+'
+email:
 - aymerick@fotonauts.com
 - oct@fotonauts.com
-executables: 
+executables:
 - fwissr
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - LICENSE
 - Rakefile
 - README.md
@@ -53,26 +61,25 @@ files:
 - lib/fwissr.rb
 homepage: https://github.com/fotonauts/fwissr
 licenses: []
-
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id002
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id002
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Fwissr
 test_files: []
-