settings_js 0.1.1 → 0.1.2

data/lib/settings_js/backends/settings_logic.rb

@@ -8,6 +8,16 @@ module SettingsJs
         self.klass = klass
       end
 
+      # Public: Use application settings logic class to get values of a key.
+      #
+      # base_key - String formatted.
+      #
+      # Examples
+      #
+      #   multiplex('Tom', 4)
+      #   # => 'TomTomTomTom'
+      #
+      # Returns the duplicated String.
       def to_hash(base_key)
         keys      = base_key.split(/\./)
         base_hash = klass.send(keys.shift)

data/lib/settings_js/merger.rb

@@ -4,6 +4,16 @@ require 'json'
 module SettingsJs
   class Merger
 
+    # Public: Get all values for keys defined in settins and merged it to a hash.
+    #
+    # Examples
+    #
+    #   merger = SettingsJs::Merger.new
+    #   merger.to_hash
+    #   # => { key1: 'value', key2: { sub_key2: 'other value' }}
+    #
+    # Returns Hash.
+    # Raises TypeError if keys defined in config is not a reduceable object (Array,...)
     def to_hash
       unless config.keys.respond_to?(:reduce)
         raise TypeError.new('the configuration key "keys" must be reduceable')
@@ -12,6 +22,17 @@ module SettingsJs
       config.keys.reduce({}) { |hash, base_key| hash.merge(backend.to_hash(base_key)) }
     end
 
+    # Public: Get all values for keys defined in settins and merged it to a json.
+    #
+    # Examples
+    #
+    #   merger = SettingsJs::Merger.new
+    #   merger.to_hash
+    #   # => { key1: 'value', key2: { sub_key2: 'other value' }}
+    #   merger.to_json
+    #   # => { 'key1': 'value', 'key2': { 'sub_key2': 'other value' }}
+    #
+    # Returns Json.
     def to_json
       to_hash.to_json
     end

data/lib/settings_js.rb

@@ -3,6 +3,19 @@ require 'settings_js/merger'
 
 module SettingsJs
 
+  # Public: Configuration initializer.
+  #
+  # block - block with configuration object in parameter.
+  #
+  # Examples
+  #
+  #   SettingsJs.condiguration do |config|
+  #     config.backend = 'awesome_backend'
+  #     config.klass   = ApplicationSettings
+  #     config.keys    = %w(key.key2 key3)
+  #   end
+  #
+  # Returns Nothing.
   def self.configuration(&block)
     block.call(SettingsJs::Config.instance)
   end

data/settings_js.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'settings_js'
-  s.version     = '0.1.1'
+  s.version     = '0.1.2'
   s.date        = '2012-11-30'
   s.summary     = 'Sharing same application settings between ruby and javascript'
   s.authors     = ['Kevin Disneur']
@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.test_files  = `git ls-files -- spec/*`.split(/\n/)
   s.homepage    = 'http://rubygems.org/gems/settings_js'
 
-  s.add_dependency 'active_support', '> 1.0'
-  s.add_dependency 'json',           '> 0'
+  s.add_dependency 'activesupport', '> 0'
+  s.add_dependency 'json',          '> 0'
   s.add_dependency 'sprockets'
 
   s.add_development_dependency 'jasmine'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: settings_js
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -12,13 +12,13 @@ cert_chain: []
 date: 2012-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: active_support
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>'
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement