config_core 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b5cd635aa34e0630c433d3806168917f4d00e12
+  data.tar.gz: d7dcc97440fde85bdf42a7669045470936f88f43
+SHA512:
+  metadata.gz: f524e0a0189b3b9f79f72a68a6b5b2435d496a4f0b605f5eb941a4a2ed0719bd562bf97c0e9a97001938bc9183a0fea3d41bdc3a8b7f6a3932bb3bbe83b781af
+  data.tar.gz: 7fa8fb0fc2b0ba7f2e3378cf33a10ea6acc81cf0deaff54288ee54f370051089247101b5254a1ac8c435e3d5478f1f3d14fc00402ef4b2f835ca617e8757ad73

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nano_config.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 egoholic
+
+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,31 @@
+[![Code Climate](https://codeclimate.com/github/egoholic/config_core.png)](https://codeclimate.com/github/egoholic/config_core)
+
+# ConfigCore
+
+Simple configuration solution. Don't use FCKN_CONSTANTS - use ConfigCore.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'config_core'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install config_core
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/config_core.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'config_core/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "config_core"
+  spec.version       = ConfigCore::VERSION
+  spec.authors       = ["Vladimir Melnick"]
+  spec.email         = ["egotraumatic@gmail.com"]
+  spec.description   = %q{ConfigCore provides super simple configuration solution.}
+  spec.summary       = %q{ConfigCore provides super simple configuration solution.}
+  spec.homepage      = "http://rubydev.ru"
+  spec.license       = "MIT"
+
+  # Всегда удивлялся зачем здесь git.
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/config_core/parameter.rb

@@ -0,0 +1,33 @@
+module ConfigCore
+  class Parameter
+    attr_reader :name, :value, :default_value
+
+    def initialize(name, value)
+      @name = name
+      @default_value = value
+      
+      begin
+        @value = value.dup
+      rescue TypeError
+        @value = value
+      end
+
+      @editable = true
+    end
+
+    def disable_editing!
+      @editable = false
+      @value.freeze
+    end
+
+    def editable?
+      @editable
+    end
+
+    def value=(value)
+      raise TryingToModifyUneditableParameterError unless editable?
+
+      @value = value
+    end
+  end
+end

data/lib/config_core/scope.rb

@@ -0,0 +1,46 @@
+module ConfigCore
+ class Scope
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+      @parameters = {}
+    end
+
+    def empty?
+      @parameters.empty?
+    end
+
+    def has_parameter?(name)
+      @parameters.has_key?(name)
+    end
+
+    def define_parameter(name, value, editable: true)
+      raise ParameterAlreadyExistsError if has_parameter?(name)
+
+      parameter = Parameter.new(name, value)
+      parameter.disable_editing! unless editable
+
+      @parameters[name] = parameter
+
+      define_parameter_reader(name)
+      define_parameter_value_reader(name)
+      define_parameter_value_writer(name)
+
+      return parameter
+    end
+
+    private
+    def define_parameter_reader(name)
+      define_singleton_method(:"#{name}_parameter") { @parameters[name] }
+    end
+
+    def define_parameter_value_reader(name)
+      define_singleton_method(name) { @parameters[name].value }
+    end
+
+    def define_parameter_value_writer(name)
+      define_singleton_method(:"#{name}=") { |value| @parameters[name].value = value }
+    end
+  end
+end

data/lib/config_core/scopes_collection.rb

@@ -0,0 +1,36 @@
+module ConfigCore
+  class ScopesCollection
+    def initialize
+      @scopes = {}
+    end
+
+    def to_h
+      @scopes
+    end
+
+    def [](name)
+      @scopes[name]
+    end
+
+    def has_scope?(name)
+      @scopes.has_key?(name)
+    end
+
+    def define(name)
+      raise ScopeAlreadyExistsError if has_scope?(name)
+
+      scope = Scope.new(name)
+      yield(scope) if block_given?
+      @scopes[name] = scope
+
+      define_scope_reader(name)
+
+      return scope
+    end
+
+    private
+    def define_scope_reader(name)
+      define_singleton_method(name) { @scopes[name] }
+    end
+  end
+end

data/lib/config_core/version.rb

@@ -0,0 +1,3 @@
+module ConfigCore
+  VERSION = "0.0.1"
+end

data/lib/config_core.rb

@@ -0,0 +1,20 @@
+require 'config_core/version'
+require 'config_core/scopes_collection'
+require 'config_core/scope'
+require 'config_core/parameter'
+
+module ConfigCore
+  class ScopeAlreadyExistsError < StandardError; end
+  class ParameterAlreadyExistsError < StandardError; end
+  class TryingToModifyUneditableParameterError < StandardError; end
+
+  def self.extended(klass)
+    klass.instance_variable_set(:@config_scopes_collection, ScopesCollection.new)
+  end
+
+  def scopes
+    @config_scopes_collection
+  end
+
+  alias config scopes
+end

data/spec/config_core/parameter_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ConfigCore::Parameter do
+  let(:value) { 'value' }
+  let(:new_value) { 'new value' }
+  let(:parameter) { ConfigCore::Parameter.new(:name, value) }
+
+  subject { parameter}
+
+  its(:name) { should be :name }
+  its(:value) { should eq value }
+  its(:default_value) { should eq value }
+  its(:default_value) { should_not be subject.value }
+  
+  it { expect { parameter.value = new_value }.to_not change { parameter.default_value }.from(value) }
+
+  context 'when editable' do
+    its(:editable?) { should be_true }
+
+    it { expect { parameter.value = new_value }.to change { parameter.value }.from(value).to(new_value) }
+  end
+
+  context 'when uneditable' do
+    before { parameter.disable_editing! }
+
+    its(:editable?) { should be_false }
+
+    it { expect { parameter.value = new_value }.to raise_error(ConfigCore::TryingToModifyUneditableParameterError) }
+  end
+end

data/spec/config_core/scope_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe ConfigCore::Scope do
+  let(:scope) { ConfigCore::Scope.new(:core) }
+  let(:value) { 'value' }
+  let(:new_value) { 'new_value' }
+
+  subject { scope }
+
+  its(:name) { should be :core }
+
+  describe '#empty?' do
+    it { expect { scope.define_parameter(:items_per_page, 10) }.to change { scope.empty? }.from(true).to(false) }
+  end
+
+  describe '#has_parameter?' do
+    it { expect { scope.define_parameter(:items_per_page, 10) }.to change { scope.has_parameter?(:items_per_page) }.from(false).to(true) }
+  end
+
+  describe '#define_parameter' do
+    it { expect { scope.define_parameter(:param, value) }.to change { scope.has_parameter?(:param) }.to(true) }
+
+    context 'when parameter already exists' do
+      before { scope.define_parameter(:param, value) }
+
+      it { expect { scope.define_parameter(:param, value) }.to raise_error(ConfigCore::ParameterAlreadyExistsError) }
+    end
+
+    describe 'parameter/parameter value accessors' do
+      context 'when editable parameter' do
+        before { scope.define_parameter(:param, value) }
+
+        its(:param_parameter) { should be_a ConfigCore::Parameter }
+        its(:param) { should == value }
+        it { expect { scope.param = new_value }.to change { scope.param }.to(new_value) }
+      end
+
+      context 'when uneditable parameter' do
+        before { scope.define_parameter(:param, value, editable: false) }
+
+        its(:param_parameter) { should be_a ConfigCore::Parameter }
+        its(:param) { should == value }
+        it { expect { scope.param = new_value }.to raise_error(ConfigCore::TryingToModifyUneditableParameterError) }
+      end
+    end
+  end
+
+end

data/spec/config_core/scopes_collection_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe ConfigCore::ScopesCollection do
+  let!(:scopes_collection) { ConfigCore::ScopesCollection.new }
+
+  subject { scopes_collection }
+
+  describe '#to_h' do
+    context 'when empty' do
+      its(:to_h) { should == {} }
+    end
+
+    context 'when scopes defined' do
+      before { scopes_collection.define(:core) }
+
+      it { scopes_collection.to_h.should have(1).scope }
+    end
+  end
+
+  describe '#[]' do
+    context 'when empty' do
+      it { scopes_collection[:core].should be_nil }
+    end
+
+    context 'when scopes defined' do
+      before { scopes_collection.define(:core) }
+
+      it { scopes_collection[:core].should be_a ConfigCore::Scope }
+    end
+  end
+
+  describe '#has_scope?' do
+    it { expect { scopes_collection.define(:core).to change { scopes_collection.has_scope?(:core) }.from(false).to(true) } }
+  end
+
+  describe '#define' do
+    context 'when scope already exists' do
+      before { scopes_collection.define(:core) }
+
+      it { expect { scopes_collection.define(:core) }.to raise_error(ConfigCore::ScopeAlreadyExistsError) }
+    end
+
+    context 'when scope not exists' do
+      it { expect { scopes_collection.define(:core) }.to change { scopes_collection.has_scope?(:core) }.from(false).to(true)}
+      
+      describe 'scope reader' do
+        before { scopes_collection.define(:core) }
+
+        it { scopes_collection.should respond_to(:core) }
+        its(:core) { should be_a ConfigCore::Scope }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require(:default)
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:each) do
+    # do something
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: config_core
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vladimir Melnick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ConfigCore provides super simple configuration solution.
+email:
+- egotraumatic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config_core.gemspec
+- lib/config_core.rb
+- lib/config_core/parameter.rb
+- lib/config_core/scope.rb
+- lib/config_core/scopes_collection.rb
+- lib/config_core/version.rb
+- spec/config_core/parameter_spec.rb
+- spec/config_core/scope_spec.rb
+- spec/config_core/scopes_collection_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubydev.ru
+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.0.3
+signing_key: 
+specification_version: 4
+summary: ConfigCore provides super simple configuration solution.
+test_files:
+- spec/config_core/parameter_spec.rb
+- spec/config_core/scope_spec.rb
+- spec/config_core/scopes_collection_spec.rb
+- spec/spec_helper.rb