settings_js 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+spec/javascripts/generated/

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3-p327@settings-js --create

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    settings_js (0.0.1)
+      active_support
+      json
+      sprockets
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    addressable (2.3.2)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    childprocess (0.3.6)
+      ffi (~> 1.0, >= 1.0.6)
+    diff-lcs (1.1.3)
+    ffi (1.2.0)
+    hike (1.2.1)
+    jasmine (1.3.0)
+      jasmine-core (>= 1.3.0)
+      rack (~> 1.0)
+      rspec (>= 1.3.1)
+      selenium-webdriver (>= 0.1.3)
+    jasmine-core (1.3.0)
+    json (1.7.5)
+    libwebsocket (0.1.7.1)
+      addressable
+      websocket
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.4.0)
+    rack (1.4.1)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.26.0)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    settingslogic (2.0.8)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.1)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    sprockets (2.8.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+    websocket (1.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jasmine
+  rspec
+  settings_js!
+  settingslogic
+  shoulda

data/Rakefile

@@ -0,0 +1,9 @@
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/app/assets/javascripts/settings-js/settings.js.erb

@@ -0,0 +1 @@
+var Settings = <%= ::SettingsJs::Merger.new.to_json %>;

data/lib/settings_js/adapters/settings_logic.rb

@@ -0,0 +1,22 @@
+module SettingsJs
+  module Adapters
+    class SettingsLogic
+
+      attr_accessor :klass
+
+      def initialize(klass)
+        self.klass = klass
+      end
+
+      def to_hash(base_key)
+        keys      = base_key.split(/\./)
+        base_hash = klass.send(keys.shift)
+
+        keys.each { |key| base_hash = base_hash.send(key) }
+
+        base_hash
+      end
+
+    end
+  end
+end

data/lib/settings_js/config.rb

@@ -0,0 +1,12 @@
+require 'singleton'
+
+module SettingsJs
+  class Config
+    include ::Singleton
+
+    attr_accessor :adapter,
+                  :keys,
+                  :klass
+
+  end
+end

data/lib/settings_js/merger.rb

@@ -0,0 +1,32 @@
+require 'active_support/inflector'
+require 'json'
+
+module SettingsJs
+  class Merger
+
+    def to_hash
+      unless config.keys.respond_to?(:reduce)
+        raise TypeError.new('the configuration key "keys" must be reduceable')
+      end
+
+      config.keys.reduce({}) { |hash, base_key| hash.merge(adapter.to_hash(base_key)) }
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+
+  private
+
+    def config
+      SettingsJs::Config.instance
+    end
+
+    def adapter
+      adapter_proxy_path = "settings_js/adapters/#{config.adapter}"
+
+      require adapter_proxy_path
+      adapter_proxy_path.classify.constantize.new(config.klass)
+    end
+  end
+end

data/lib/settings_js.rb

@@ -0,0 +1,11 @@
+require 'settings_js/config'
+require 'settings_js/merger'
+
+module SettingsJs
+
+  def self.configuration(&block)
+    block.call(SettingsJs::Config.instance)
+  end
+
+end
+

data/settings_js.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = 'settings_js'
+  s.version     = '0.0.1'
+  s.date        = '2012-11-30'
+  s.summary     = 'Sharing same application settings between ruby and javascript'
+  s.authors     = ['Kevin Disneur']
+  s.email       = 'kevin.disneur@gmail.com'
+  s.files       = `git ls-files`.split(/\n/)
+  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 'sprockets'
+
+  s.add_development_dependency 'jasmine'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'settingslogic'
+  s.add_development_dependency 'shoulda'
+end

data/spec/fixtures/settings_js/adapters/settings_logic.yml

@@ -0,0 +1,9 @@
+key1:
+  sub_key1: sub_value1
+key2:
+  sub_key2_1: sub_value2_1
+  sub_key2_2:
+    sub_key2_2_1: sub_value2_2_1
+    sub_key2_2_2:
+      sub_key2_2_2_1: sub_value2_2_2_1
+key3: value3

data/spec/javascripts/settings-js/settings_js_spec.js

@@ -0,0 +1,13 @@
+describe('Settings ', function() {
+  it('Settings object contains a valid json', function() {
+    expected_json = {
+      sub_key1 :     'sub_value1',
+      sub_key2_2_1 : 'sub_value2_2_1',
+      sub_key2_2_2: {
+        sub_key2_2_2_1: 'sub_value2_2_2_1'
+      }
+    };
+
+    expect(Settings).toEqual(expected_json);
+  });
+});

data/spec/javascripts/support/jasmine.yml

@@ -0,0 +1,73 @@
+# src_files
+#
+# Return an array of filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# src_files:
+#   - lib/source1.js
+#   - lib/source2.js
+#   - dist/**/*.js
+#
+src_files:
+  - spec/javascripts/generated/**/*.js.erb
+
+# stylesheets
+#
+# Return an array of stylesheet filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# stylesheets:
+#   - css/style.css
+#   - stylesheets/*.css
+#
+stylesheets:
+
+# helpers
+#
+# Return an array of filepaths relative to spec_dir to include before jasmine specs.
+# Default: ["helpers/**/*.js"]
+#
+# EXAMPLE:
+#
+# helpers:
+#   - helpers/**/*.js
+#
+helpers:
+
+# spec_files
+#
+#  Return an array of filepaths relative to spec_dir to include.
+# Default: ["**/*[sS]pec.js"]
+#
+# EXAMPLE:
+#
+# spec_files:
+#   - **/*[sS]pec.js
+#
+spec_files:
+
+# src_dir
+#
+# Source directory path. Your src_files must be returned relative to this path. Will use root if left blank.
+# Default: project root
+#
+# EXAMPLE:
+#
+# src_dir: public
+#
+src_dir:
+
+# spec_dir
+#
+# Spec directory path. Your spec_files must be returned relative to this path.
+# Default: spec/javascripts
+#
+# EXAMPLE:
+#
+# spec_dir: spec/javascripts
+#
+spec_dir:

data/spec/javascripts/support/jasmine_config.rb

@@ -0,0 +1,57 @@
+Spec_root = File.expand_path(File.join('..', '..', '..'), __FILE__)
+
+$LOAD_PATH << File.join(Spec_root, '..', 'lib')
+require 'settingslogic'
+require 'settings_js'
+require 'sprockets'
+
+module Jasmine
+
+  class DummySettings < Settingslogic
+    source File.join(Spec_root, 'fixtures', 'settings_js', 'adapters', 'settings_logic.yml')
+  end
+
+
+  class Config
+
+    def js_files(spec_filter = nil)
+      gem_configuration
+
+      precompile_app_assets
+
+      # this is code from the original jasmine config js_files method - you could also just alias_method_chain it
+      spec_files_to_include = spec_filter.nil? ? spec_files : match_files(spec_dir, [spec_filter])
+      src_files.collect { |f| '/' + f } + helpers.collect { |f| File.join(spec_path, f) } + spec_files_to_include.collect { |f| File.join(spec_path, f) }
+    end
+
+  private
+
+    def gem_configuration
+      SettingsJs.configuration do |config|
+        config.adapter = 'settings_logic'
+        config.keys    = %w(key1 key2.sub_key2_2)
+        config.klass   = DummySettings
+      end
+    end
+
+    def precompile_app_assets
+      puts 'Precompiling assets...'
+
+      generated_files_directory = File.expand_path(File.join('..', '..', 'generated'), __FILE__)
+
+      sprockets = Sprockets::Environment.new(File.join(Spec_root, '..', 'app', 'assets', 'javascripts'))
+      sprockets.append_path('settings-js')
+
+      assets           = sprockets.find_asset('settings.js')
+      prefix, basename = assets.pathname.to_s.split('/')[-2..-1]
+
+      FileUtils.mkpath(File.join(generated_files_directory))
+
+      assets.write_to(File.join(generated_files_directory, basename))
+      assets.to_a.each do |asset|
+        realname = asset.pathname.basename.to_s.split('.')[0..1].join('.')
+        assets.write_to(File.join(generated_files_directory, basename))
+      end
+    end
+  end
+end

data/spec/settings_js/adapters/settings_js_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'settingslogic'
+require 'settings_js/adapters/settings_logic'
+
+describe 'SettingsJs::Adapters::SettingsLogic' do
+
+  let(:settings_klass) do
+    Class.new(Settingslogic) do
+      source File.join(Spec_root, 'fixtures', 'settings_js', 'adapters', 'settings_logic.yml')
+    end
+  end
+
+  let(:adapter_instance) { SettingsJs::Adapters::SettingsLogic.new(settings_klass) }
+
+  it { adapter_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' }
+    end
+
+    it 'returns subkeys when base key is under the settings root' do
+      expected_hash = {
+        'sub_key2_2_1' => 'sub_value2_2_1' ,
+        'sub_key2_2_2' => {
+          'sub_key2_2_2_1' => 'sub_value2_2_2_1'
+        }
+      }
+
+      adapter_instance.to_hash('key2.sub_key2_2').should == expected_hash
+    end
+  end
+end

data/spec/settings_js/config_spec.rb

@@ -0,0 +1,9 @@
+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 :keys }
+  it { config.should have_attr_accessor :klass }
+end

data/spec/settings_js/merger_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe SettingsJs::Merger do
+
+  let(:merger) { SettingsJs::Merger.new }
+
+  describe '#to_hash' do
+
+    context 'when config.keys does not respond to "#reduce"' do
+
+      it 'raises an TypeError' do
+        SettingsJs.configuration { |config| config.keys = mock(:not_reduceable_object) }
+        expect { merger.to_hash }.to raise_error(TypeError)
+      end
+    end
+
+    context 'when config.keys respond to "#reduce"' do
+      let(:reduceable_object) do
+        reduceable_object = mock(:reduceable_object)
+        reduceable_object.stub(:reduce)
+        reduceable_object
+      end
+
+      it 'does not raise a TypeError' do
+        SettingsJs.configuration { |config| config.keys = reduceable_object }
+        expect { merger.to_hash }.to_not raise_error(TypeError)
+      end
+    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' }})
+
+      config = mock(:config)
+      config.stub(:keys).and_return(%w(key1 key2))
+
+      merger.stub(:config).and_return(config)
+      merger.stub(:adapter).and_return(adapter)
+
+      expected_hash = {
+        key1: 'value1',
+        key2: {
+          key2_1: 'value2_1',
+          key2_2: 'value2_2',
+        }
+      }
+
+      merger.to_hash.should == expected_hash
+    end
+  end
+
+  describe '#to_json' do
+    it 'calls #to_json method on the #to_hash result' do
+      hash_mocked = mock(:hash)
+      hash_mocked.stub(:to_json)
+      merger.stub(:to_hash).and_return(hash_mocked)
+
+      hash_mocked.should_receive(:to_json).once
+
+      merger.to_json
+    end
+  end
+
+end

data/spec/settings_js_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe SettingsJs do
+
+  describe '.configuration' do
+    it 'calls block with configuration object in parameter' do
+      expect { |config| SettingsJs.configuration(&config) }.to yield_with_args(SettingsJs::Config.instance)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+Spec_root = File.expand_path('..', __FILE__)
+
+require File.join(Spec_root, '..', 'lib', 'settings_js')
+
+Dir[File.join(Spec_root, 'support', '**', '*.rb')].each { |support_helper| require support_helper }

data/spec/support/have_attr_accessor.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :have_attr_accessor do |attribute_name|
+  match do |subject|
+    subject.respond_to?(attribute_name) && subject.respond_to?("#{attribute_name}=")
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: settings_js
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Disneur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jasmine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: settingslogic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: kevin.disneur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- app/assets/javascripts/settings-js/settings.js.erb
+- lib/settings_js.rb
+- lib/settings_js/adapters/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/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/config_spec.rb
+- spec/settings_js/merger_spec.rb
+- spec/settings_js_spec.rb
+- spec/spec_helper.rb
+- spec/support/have_attr_accessor.rb
+homepage: http://rubygems.org/gems/settings_js
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+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/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/config_spec.rb
+- spec/settings_js/merger_spec.rb
+- spec/settings_js_spec.rb
+- spec/spec_helper.rb
+- spec/support/have_attr_accessor.rb