mongoid-settings 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ae3b889017f9e5749eb896f92395ffe76975bb2
+  data.tar.gz: 1ed412e073e1030f1cccda291243e396855e4410
+SHA512:
+  metadata.gz: 61d83bd51b893ec02ff3afc8c49a74459cb0da1ef355786bc898f5ca36714abff225e89eafdc55080207b8f944d71422f3940dc5e90c561adb80d71bcd04450e
+  data.tar.gz: c1bd5f8185345f25b759b87e054e4f65a6334125877979bf31023f91a102dcc14cadff1d43a04ac3cea035589303b1001bb9868077712ae1b9a5e4f5ae41ad0c

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg
+.idea
+.DS_Store
+doc
+.yardoc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+services: mongodb
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrei Gladkyi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# mongoid-settings
+
+A simple gem to store application settings into a MongoDB collection.
+
+[![Build Status](https://travis-ci.org/agladkyi/mongoid-settings.png)](https://travis-ci.org/agladkyi/mongoid-settings)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-settings'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-settings
+
+## Usage
+
+Create a model which includes `Mongoid::Settings`.
+
+    class ApplicationSettings
+      include Mongoid::Settings
+
+      setting :some_name, type: String, default: 'some value'
+      setting :another
+    end
+
+It will allow to use:
+
+    ApplicationSettings.some_name
+    => 'some value'
+
+    ApplicationSettings.some_name = 'another value'
+    ApplicationSettings.some_name
+    => 'another value'
+
+    ApplicationSettings[:another] = 100
+    ApplicationSettings[:another]
+    => 100
+
+## License
+
+Licensed under the MIT license.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/lib/mongoid-settings.rb

@@ -0,0 +1,50 @@
+require 'mongoid'
+require 'mongoid-settings/version'
+
+module Mongoid
+  module Settings
+    extend ActiveSupport::Concern
+
+    class Storage
+      include Mongoid::Document
+      store_in(collection: 'settings')
+    end
+
+    module ClassMethods
+      def [](name)
+        storage[name].presence || defaults[name]
+      end
+
+      def []= (name, value)
+        storage.update_attribute(name, value) if defaults.include?(name)
+      end
+
+      def reload!
+        @storage = load_storage
+      end
+
+      private
+
+      def setting(name, options = {})
+        Storage.class_eval do
+          field(name, options)
+        end
+        defaults[name] = options[:default]
+        define_singleton_method(name) { self[name] }
+        define_singleton_method("#{name}=") { |value| self[name] = value }
+      end
+
+      def defaults
+        @defaults ||= {}
+      end
+
+      def storage
+        @storage ||= load_storage
+      end
+
+      def load_storage
+        Storage.first_or_create
+      end
+    end
+  end
+end

data/lib/mongoid-settings/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Settings
+    VERSION = '0.5.0'
+  end
+end

data/mongoid-settings.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid-settings/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'mongoid-settings'
+  spec.version = Mongoid::Settings::VERSION
+  spec.authors = ['Andrei Gladkyi']
+  spec.email = ['arg@arglabs.net']
+  spec.description = 'A simple gem to store application settings into a MongoDB collection.'
+  spec.summary = 'A simple gem to store application settings into a MongoDB collection.'
+  spec.homepage = 'https://github.com/agladkyi/mongoid-settings'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files`.split($/)
+  spec.test_files = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'mongoid', '>= 3.0.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 2.0.0'
+end

data/spec/mongoid-settings_spec.rb

@@ -0,0 +1,41 @@
+class Settings
+  include Mongoid::Settings
+  setting :some_integer, type: Integer, default: 100
+end
+
+describe Mongoid::Settings do
+  before do
+    Settings.reload!
+  end
+
+  it 'fills settings with their default values' do
+    expect(Settings.some_integer).to eq(100)
+  end
+
+  it 'allows to set values' do
+    Settings.some_integer = 200
+    expect(Settings.some_integer).to eq(200)
+  end
+
+  describe '[]' do
+    it 'returns correct values' do
+      expect(Settings[:some_integer]).to eq(100)
+    end
+
+    it 'returns nil for non-existent settings' do
+      expect(Settings[:other]).to be_nil
+    end
+  end
+
+  describe '[]=' do
+    it 'correctly sets the new value' do
+      Settings[:some_integer] = 300
+      expect(Settings[:some_integer]).to eq(300)
+    end
+
+    it "doesn't set value for non-existent setting" do
+      Settings[:other] = 'test'
+      expect(Settings[:other]).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'mongoid-settings'
+
+Mongoid.configure do |config|
+  config.connect_to 'mongoid_settings_test'
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before :each do
+    Mongoid.purge!
+    Mongoid::IdentityMap.clear
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-settings
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Andrei Gladkyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  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: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: A simple gem to store application settings into a MongoDB collection.
+email:
+- arg@arglabs.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid-settings.rb
+- lib/mongoid-settings/version.rb
+- mongoid-settings.gemspec
+- spec/mongoid-settings_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/agladkyi/mongoid-settings
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.3
+signing_key: 
+specification_version: 4
+summary: A simple gem to store application settings into a MongoDB collection.
+test_files:
+- spec/mongoid-settings_spec.rb
+- spec/spec_helper.rb