sanultari-config 0.1.0.RC1 → 0.1.0

data/Gemfile

@@ -6,12 +6,13 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "ZenTest", "~> 4.8.1"
+  gem "ZenTest",        "~> 4.8.1"
   gem "autotest-growl", "~> 0.2.16"
-  gem "rspec", "~> 2.11"
-  gem "yard", "~> 0.7"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.1"
-  gem "jeweler", "~> 1.8.3"
-  gem "rcov", ">= 0", :platform => [:ruby_18, :mingw_18]
+  gem "rspec",          "~> 2.11"
+  gem "yard",           "~> 0.7"
+  gem "redcarpet",      "~> 2.1"
+  gem "rdoc",           "~> 3.12"
+  gem "bundler",        "~> 1.1"
+  gem "jeweler",        "~> 1.8.3"
+  gem "rcov",           ">= 0", :platform => [:ruby_18, :mingw_18]
 end

data/Gemfile.lock

@@ -15,6 +15,7 @@ GEM
     rcov (1.0.0)
     rdoc (3.12)
       json (~> 1.4)
+    redcarpet (2.1.1)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -36,5 +37,6 @@ DEPENDENCIES
   jeweler (~> 1.8.3)
   rcov
   rdoc (~> 3.12)
+  redcarpet (~> 2.1)
   rspec (~> 2.11)
   yard (~> 0.7)

data/LICENSE.txt

@@ -1,20 +1,26 @@
-Copyright (c) 2012 Jeong, Jiung
+Copyright (c) 2012, Team SanUltari
+All rights reserved.
 
-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:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met: 
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer. 
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution. 
 
-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.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those
+of the authors and should not be interpreted as representing official policies, 
+either expressed or implied, of the FreeBSD Project.

data/README.md

@@ -1,9 +1,20 @@
-= sanconfig
+# SanUltari Configuration
+[![Gemnasium](https://gemnasium.com/sanultari/config.png)](https://gemnasium.com/sanultari/config)
 
-Description goes here.
+오브젝트를 이용하여 계층형 설정 정보를 관리하기 위한 라이브러리.
 
-== Contributing to sanconfig
- 
+## 사용방식
+```ruby
+require 'sanultari-config'
+config = SanUltari::Config.new
+config.init!
+config.develop.db.type = 'mysql'
+config.develop.db.host = 'localhost'
+config.develop.db.port = ...
+config.production.db.type = 'postgresql'
+config.production.db.host = 'localhost'
+```
+## Contributing to sanultari-config 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
@@ -12,8 +23,5 @@ Description goes here.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
-
-Copyright (c) 2012 Jeong, Jiung. See LICENSE.txt for
-further details.
-
+## Copyright
+Copyright (c) 2012 Team SanUltari. See LICENSE.txt for further details.

data/Rakefile

@@ -16,7 +16,7 @@ Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "sanultari-config"
   gem.homepage = "https://github.com/sanultari/config"
-  gem.license = "AFL"
+  gem.license = "FreeBSD"
   gem.summary = %Q{Simple configuration}
   gem.description = %Q{This library provides simple configuration management with object's attributes. sanconfig support yaml as datastore.}
   gem.email = "ethernuiel@sanultari.com"

data/VERSION

@@ -1 +1 @@
-0.1.0.RC1
+0.1.0

data/lib/sanultari/config/store.rb

@@ -1,6 +1,15 @@
+# coding: utf-8
 module SanUltari
   class Config
+    # SanUltari::Config의 설정값들을 실제로 저장하기 위한 객체
+    # method 기반으로 동작하므로, method 이름을 격리하기 위하여 상속받은 동적 타입을 생성하여 사용한다.
+    #
+    # @author Jeong, Jiung
+    # @see SanUltari::Config
     class Store
+      # 기본 인덱서
+      #
+      # @param [String] name 실제로 저장된 값에 접근하기 위한 접근자
       def [] name
         @values ||= {}
 
@@ -8,17 +17,23 @@ module SanUltari
         @values[name]
       end
 
+      # 기본 인덱서 세터
+      #
+      # @param [String] name 값을 저장할 이름. 메서드 이름으로 변경된다.
+      # @param [Object] value 저장될 값. 현재 테스트된 타입은 Primary types과 List, Hash에 한한다.
       def []= name, value
         @values ||= {}
 
         @values[name] = value
       end
 
+      # 현재 저장되어 있는 설정의 Key값 컬렉션을 반환한다.
       def keys
         return [] if @values == nil
         @values.keys
       end
 
+      # 설정값에 대해서 Getter와 Setter를 동적으로 생성하기 위한 Handler.
       def method_missing(method_name, *args, &block)
         name = method_name.to_s
         name.chomp!('=')

data/lib/sanultari/config.rb

@@ -1,10 +1,16 @@
+# coding: utf-8
 require 'sanultari/config/store'
 require 'yaml'
 
+# @author Jeong, Jiung
 module SanUltari
+  # @author Jeong, Jiung
   class Config
     attr_accessor :name, :path
 
+    # 생성자
+    #
+    # @param [String] name 설정 Key의 이름. 넘기지 않으면 nil이 설정된다.
     def initialize name = nil
       @name = name || nil
       @path = File.expand_path '.'
@@ -12,6 +18,9 @@ module SanUltari
       @store = @store_class.new
     end
 
+    # Config 객체 초기화
+    #
+    # @param [String] path 읽어 들일 설정 파일의 위치. 넘기지 않으면 아무것도 설정하지 않는다.
     def init! path = nil
       return nil if path == nil
       if @name == nil
@@ -22,6 +31,12 @@ module SanUltari
       from_hash(config_hash)
     end
 
+    # Config 객체를 지정된 위치에 YAML 포맷으로 덤프한다.
+    #
+    # @param [String] path 기록할 파일의 위치. 넘기지 않을 경우 기본값이 셋팅된다. {#init!}을 통해 파일을 읽은 경우에는 읽었던 파일의 위치. 그렇지 않으면 현재 디렉토리내의 config.yml을 대상으로 한다. {#path=}가 설정된 경우에는 {#path}하위에 config.yml을 만든다.
+    # @see SanUltari::Config#init!
+    # @see SanUltari::Config#path=
+    # @see SanUltari::Config#path
     def save path = nil
       @name = 'config' if @name == nil
       path = make_path if path == nil
@@ -31,6 +46,10 @@ module SanUltari
       end
     end
 
+    # Config 객체를 {Hash Ruby Hash}로부터 생성한다.
+    #
+    # @param [Hash] hash {SanUltari::Config}로 변환할 Hash객체
+    # @see Hash
     def from_hash hash
       raise Exception.new unless hash.instance_of?(Hash)
 
@@ -45,6 +64,10 @@ module SanUltari
       end
     end
 
+    # 현재 Config 객체를 {Hash Ruby Hash}로 변환한다.
+    #
+    # @return [SanUltari::Config] {SanUltari::Config}객체가 변환된 Hash객체
+    # @see Hash
     def to_hash
       hash = {}
       @store.keys.each do |key|
@@ -55,6 +78,9 @@ module SanUltari
       hash
     end
 
+    # 현재 패스로부터 적절한 YAML 파일 경로를 만들어낸다.
+    #
+    # @param [String] path YAML 파일의 위치. 지정되지 않으면, {#name}, {#path}로부터 기본 패스를 만들어낸다.
     def make_path path = nil
       return File.expand_path "#{@name}.yml", @path if path == nil
       if path.start_with?('/', '\\')
@@ -64,6 +90,7 @@ module SanUltari
       end
     end
 
+    # 존재하지 않는 메소드 처리를 위한 핸들러
     def method_missing(method_name, *args, &block)
       @store.send method_name, *args, &block
     end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sanultari-config
 version: !ruby/object:Gem::Version
-  version: 0.1.0.RC1
-  prerelease: 6
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Jeong, Jiung
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2012-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ZenTest
@@ -75,6 +75,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -167,7 +183,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/sanultari/config
 licenses:
-- AFL
+- FreeBSD
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -180,13 +196,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 805368188006248101
+      hash: -539915354181194909
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24