settings_js 0.1.2 → 0.2.0

data/.gitignore

@@ -1 +1,2 @@
 spec/javascripts/generated/
+Gemfile.lock

data/README.markdown

@@ -1,7 +1,8 @@
 # Welcome to Settings-js
 
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kdisneur/settings-js)
-[![Travis CI](https://secure.travis-ci.org/kdisneur/settings-js.png)](http://travis-ci.org/kdisneur/settings-js)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/fanaticio/settings-js)
+[![Travis CI](https://secure.travis-ci.org/fanaticio/settings-js.png)](http://travis-ci.org/fanaticio/settings-js)
+[![Dependency Status](https://gemnasium.com/fanaticio/settings-js.png)](https://gemnasium.com/fanaticio/settings-js)
 
 Use application specific settings with Javascript.
 

data/lib/settings_js/backends/settings_logic.rb

@@ -1,5 +1,14 @@
 module SettingsJs
   module Backends
+
+    # Public: SettingsLogic backend implementation to get values of Settings from string.
+    #
+    # klass - Class which is SettingsLogic in the application.
+    #
+    # Examples
+    #
+    #   settingsjs_backend = Settings::Backends::SettingsLogic.new(MySettings)
+    #
     class SettingsLogic
 
       attr_accessor :klass
@@ -8,16 +17,16 @@ module SettingsJs
         self.klass = klass
       end
 
-      # Public: Use application settings logic class to get values of a key.
+      # Public: Use application Settingslogic class to get values of a key.
       #
-      # base_key - String formatted.
+      # base_key - String with path keys seperated by dots.
       #
       # Examples
       #
-      #   multiplex('Tom', 4)
-      #   # => 'TomTomTomTom'
+      #   Settingsjs::Backends::SettingsLogic.new(MySettings).to_hash('key1.subkey1_1')
+      #   # => 'Awesome value!'
       #
-      # Returns the duplicated String.
+      # Returns the Hash value.
       def to_hash(base_key)
         keys      = base_key.split(/\./)
         base_hash = klass.send(keys.shift)

data/lib/settings_js/engine.rb

@@ -0,0 +1,4 @@
+module SettingsJS
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/settings_js/merger.rb

@@ -2,9 +2,10 @@ require 'active_support/inflector'
 require 'json'
 
 module SettingsJs
+
   class Merger
 
-    # Public: Get all values for keys defined in settins and merged it to a hash.
+    # Public: Get all values for keys defined in settings and merged it to a hash.
     #
     # Examples
     #
@@ -22,7 +23,7 @@ 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.
+    # Public: Get all values for keys defined in settings and merged it to a json.
     #
     # Examples
     #

data/lib/settings_js.rb

@@ -3,6 +3,10 @@ require 'settings_js/merger'
 
 module SettingsJs
 
+  if defined?(::Rails) && defined?(::Rails::Engine)
+    require 'settings_js/engine'
+  end
+
   # Public: Configuration initializer.
   #
   # block - block with configuration object in parameter.

data/settings_js.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'settings_js'
-  s.version     = '0.1.2'
-  s.date        = '2012-11-30'
+  s.version     = '0.2.0'
+  s.date        = '2013-02-13'
   s.summary     = 'Sharing same application settings between ruby and javascript'
   s.authors     = ['Kevin Disneur']
   s.email       = 'kevin.disneur@gmail.com'

data/spec/settings_js_spec.rb

@@ -8,4 +8,32 @@ describe SettingsJs do
     end
   end
 
+  describe 'Engine' do
+    context 'when Rails constant does not exist' do
+      it 'does not make the gem an engine' do
+        reload_gem
+        defined?(::SettingsJS::Engine).should be_false
+      end
+    end
+
+    context 'when Rails constant exists' do
+      before(:each) { stub_const('Rails', Class.new) }
+
+      it 'does not make the gem an engine' do
+        reload_gem
+        defined?(::SettingsJS::Engine).should be_false
+      end
+
+      context 'when Rails::Engine constant exists' do
+        before(:each) { stub_const('Rails::Engine', Class.new) }
+
+        it 'makes the gem an engine' do
+          reload_gem
+          defined?(::SettingsJS::Engine).should be_true
+        end
+      end
+
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -2,4 +2,9 @@ Spec_root = File.expand_path('..', __FILE__)
 
 require File.join(Spec_root, '..', 'lib', 'settings_js')
 
+def reload_gem
+  load File.join(Spec_root, '..', 'lib', 'settings_js.rb')
+end
+
 Dir[File.join(Spec_root, 'support', '**', '*.rb')].each { |support_helper| require support_helper }
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: settings_js
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2013-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -139,6 +139,7 @@ files:
 - lib/settings_js.rb
 - lib/settings_js/backends/settings_logic.rb
 - lib/settings_js/config.rb
+- lib/settings_js/engine.rb
 - lib/settings_js/merger.rb
 - settings_js.gemspec
 - spec/fixtures/settings_js/backends/settings_logic.yml