settings_js 0.0.1 → 0.1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: bundle exec rspec

data/Gemfile

@@ -1,3 +1,7 @@
 source :rubygems
 
 gemspec
+
+group :test do
+  gem 'rake'
+end

data/Gemfile.lock

@@ -2,8 +2,8 @@ PATH
   remote: .
   specs:
     settings_js (0.0.1)
-      active_support
-      json
+      active_support (> 1.0)
+      json (> 0)
       sprockets
 
 GEM

data/README.markdown

@@ -0,0 +1,55 @@
+# 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)
+
+Use application specific settings with Javascript.
+
+As modern web applications rely more and more on javascript and frameworks like backbone/angular, it can be quite a hussle to maintain duplicate values in javascript and ruby.
+
+`Settings-js` is designed to work with different settings backends. As of today, only [Settingslogic](https://github.com/binarylogic/settingslogic) is supported.
+
+## Getting started
+
+Add this to your Gemfile
+
+```ruby
+gem 'settings_js'
+```
+
+Add the following to an initializer:
+
+* Settings Backend (for the moment, only [settingslogic](https://github.com/binarylogic/settingslogic) is implemented)
+* Settings Class used by the application
+* List the keys that must be accessible in the javascript
+
+```ruby
+SettingsJs.configuration do |config|
+  config.backend = 'settings_logic'      # backend used
+  config.klass   = Settings              # your own settings class
+  config.keys    = %w(hosts custom.keys) # imported keys
+end
+```
+
+Load the Javascript file and access the `Settings` class:
+
+```javascript
+// = require settings-js/settings
+
+Settings.host_name
+# => 'http://localhost:8080'
+```
+
+## Contributing
+
+Once you've made your great commits:
+
+1. Fork settings_js
+2. Create a topic branch - git checkout -b my_branch
+3. Push to your branch - git push origin my_branch
+4. Create a Pull Request from your branch
+5. That's it!
+
+## License
+
+`Settings-js` is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/settings_js/{adapters → backends}/settings_logic.rb

@@ -1,5 +1,5 @@
 module SettingsJs
-  module Adapters
+  module Backends
     class SettingsLogic
 
       attr_accessor :klass

data/lib/settings_js/config.rb

@@ -4,7 +4,7 @@ module SettingsJs
   class Config
     include ::Singleton
 
-    attr_accessor :adapter,
+    attr_accessor :backend,
                   :keys,
                   :klass
 

data/lib/settings_js/merger.rb

@@ -9,7 +9,7 @@ module SettingsJs
         raise TypeError.new('the configuration key "keys" must be reduceable')
       end
 
-      config.keys.reduce({}) { |hash, base_key| hash.merge(adapter.to_hash(base_key)) }
+      config.keys.reduce({}) { |hash, base_key| hash.merge(backend.to_hash(base_key)) }
     end
 
     def to_json
@@ -22,11 +22,11 @@ module SettingsJs
       SettingsJs::Config.instance
     end
 
-    def adapter
-      adapter_proxy_path = "settings_js/adapters/#{config.adapter}"
+    def backend
+      backend_proxy_path = "settings_js/backends/#{config.backend}"
 
-      require adapter_proxy_path
-      adapter_proxy_path.classify.constantize.new(config.klass)
+      require backend_proxy_path
+      backend_proxy_path.classify.constantize.new(config.klass)
     end
   end
 end

data/settings_js.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'settings_js'
-  s.version     = '0.0.1'
+  s.version     = '0.1.0'
   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'
-  s.add_dependency 'json'
+  s.add_dependency 'active_support', '> 1.0'
+  s.add_dependency 'json',           '> 0'
   s.add_dependency 'sprockets'
 
   s.add_development_dependency 'jasmine'

data/spec/javascripts/support/jasmine_config.rb

@@ -8,7 +8,7 @@ require 'sprockets'
 module Jasmine
 
   class DummySettings < Settingslogic
-    source File.join(Spec_root, 'fixtures', 'settings_js', 'adapters', 'settings_logic.yml')
+    source File.join(Spec_root, 'fixtures', 'settings_js', 'backends', 'settings_logic.yml')
   end
 
 
@@ -28,7 +28,7 @@ module Jasmine
 
     def gem_configuration
       SettingsJs.configuration do |config|
-        config.adapter = 'settings_logic'
+        config.backend = 'settings_logic'
         config.keys    = %w(key1 key2.sub_key2_2)
         config.klass   = DummySettings
       end

data/spec/settings_js/{adapters → backends}/settings_js_spec.rb

@@ -1,22 +1,22 @@
 require 'spec_helper'
 require 'settingslogic'
-require 'settings_js/adapters/settings_logic'
+require 'settings_js/backends/settings_logic'
 
-describe 'SettingsJs::Adapters::SettingsLogic' do
+describe 'SettingsJs::Backends::SettingsLogic' do
 
   let(:settings_klass) do
     Class.new(Settingslogic) do
-      source File.join(Spec_root, 'fixtures', 'settings_js', 'adapters', 'settings_logic.yml')
+      source File.join(Spec_root, 'fixtures', 'settings_js', 'backends', 'settings_logic.yml')
     end
   end
 
-  let(:adapter_instance) { SettingsJs::Adapters::SettingsLogic.new(settings_klass) }
+  let(:backend_instance) { SettingsJs::Backends::SettingsLogic.new(settings_klass) }
 
-  it { adapter_instance.should have_attr_accessor(:klass) }
+  it { backend_instance.should have_attr_accessor(:klass) }
 
   describe '#to_hash' do
     it 'returns subkeys when base key is in settings root' do
-      adapter_instance.to_hash('key1').should == { 'sub_key1' => 'sub_value1' }
+      backend_instance.to_hash('key1').should == { 'sub_key1' => 'sub_value1' }
     end
 
     it 'returns subkeys when base key is under the settings root' do
@@ -27,7 +27,7 @@ describe 'SettingsJs::Adapters::SettingsLogic' do
         }
       }
 
-      adapter_instance.to_hash('key2.sub_key2_2').should == expected_hash
+      backend_instance.to_hash('key2.sub_key2_2').should == expected_hash
     end
   end
 end

data/spec/settings_js/config_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'SettingsJs::Config' do
   let(:config) { SettingsJs::Config.instance }
 
-  it { config.should have_attr_accessor :adapter }
+  it { config.should have_attr_accessor :backend }
   it { config.should have_attr_accessor :keys }
   it { config.should have_attr_accessor :klass }
 end

data/spec/settings_js/merger_spec.rb

@@ -28,14 +28,14 @@ describe SettingsJs::Merger do
     end
 
     it 'returns a hash which merge all keys hash response' do
-      adapter = mock(:adapter)
-      adapter.stub(:to_hash).and_return({ key1: 'value1', key2: 'value2' }, { key2: { key2_1: 'value2_1', key2_2: 'value2_2' }})
+      backend = mock(:backend)
+      backend.stub(:to_hash).and_return({ key1: 'value1', key2: 'value2' }, { key2: { key2_1: 'value2_1', key2_2: 'value2_2' }})
 
       config = mock(:config)
       config.stub(:keys).and_return(%w(key1 key2))
 
       merger.stub(:config).and_return(config)
-      merger.stub(:adapter).and_return(adapter)
+      merger.stub(:backend).and_return(backend)
 
       expected_hash = {
         key1: 'value1',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: settings_js
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -16,23 +16,23 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ! '>'
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ! '>'
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -131,21 +131,23 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
+- README.markdown
 - Rakefile
 - app/assets/javascripts/settings-js/settings.js.erb
 - lib/settings_js.rb
-- lib/settings_js/adapters/settings_logic.rb
+- lib/settings_js/backends/settings_logic.rb
 - lib/settings_js/config.rb
 - lib/settings_js/merger.rb
 - settings_js.gemspec
-- spec/fixtures/settings_js/adapters/settings_logic.yml
+- spec/fixtures/settings_js/backends/settings_logic.yml
 - spec/javascripts/helpers/SpecHelper.js
 - spec/javascripts/settings-js/settings_js_spec.js
 - spec/javascripts/support/jasmine.yml
 - spec/javascripts/support/jasmine_config.rb
-- spec/settings_js/adapters/settings_js_spec.rb
+- spec/settings_js/backends/settings_js_spec.rb
 - spec/settings_js/config_spec.rb
 - spec/settings_js/merger_spec.rb
 - spec/settings_js_spec.rb
@@ -176,12 +178,12 @@ signing_key:
 specification_version: 3
 summary: Sharing same application settings between ruby and javascript
 test_files:
-- spec/fixtures/settings_js/adapters/settings_logic.yml
+- spec/fixtures/settings_js/backends/settings_logic.yml
 - spec/javascripts/helpers/SpecHelper.js
 - spec/javascripts/settings-js/settings_js_spec.js
 - spec/javascripts/support/jasmine.yml
 - spec/javascripts/support/jasmine_config.rb
-- spec/settings_js/adapters/settings_js_spec.rb
+- spec/settings_js/backends/settings_js_spec.rb
 - spec/settings_js/config_spec.rb
 - spec/settings_js/merger_spec.rb
 - spec/settings_js_spec.rb