strada 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 477e7c0ce3435ec1a093c37b84b2acfef8b4066af4f2bfe0844ac026579cd890
-  data.tar.gz: 930f254c50b58c986c53586b5c6d139687dae7afbceaa1b8352566cd0c32d226
+  metadata.gz: 01c182cd152dc864606ef204f15b86d5770d214b305d760f508e721f74a491a3
+  data.tar.gz: 57bf00a4987bb3f4b2022c2797c7281315c1a160fbb97633008d77880ee91b3e
 SHA512:
-  metadata.gz: c0bcef4d04513deb233b58845d921419c95d00d665277578e3e378f2c162da33100a8618b6210864c2e30fe309c2a4cfaed0d2a09618e134d7b31bcfaed3b902
-  data.tar.gz: 3f3ca72c326f29d98c2f82b33359e6953f1e611d6accab9a17021b5dd3f12dea66866fdc17c16d3cdf70a8e440dd965f8a8b7a030a80b54d8ef4beadce0b916a
+  metadata.gz: 9626789a1430f15384df5d926b20402bbf806127c8fdc4bbe02de8f44fa6889132ff00cafb8afbf89623fc4a28b77c5b1ea8a4c4dbf119f2f9a681fd68d1b132
+  data.tar.gz: 1461a09fb18ea04770d282cf9f2df8c0e0d3b2d2c12b9a9344c6b9831c4cab61ba2db66665710ab18fdbaa134364973d05e190cd2df1d95561b00f41329c044a

data/README.md

@@ -1,59 +1,76 @@
 # Strada
-Configuration library for ruby with YAML/JSON/TOML backends with unified object
-access
+
+Configuration library for ruby with YAML/JSON/TOML backends with unified object access
 
 ## Install
-```
- % gem install Strada
+
+```shell
+ % gem install strada
 ```
 
 ## Use
+
 ### Simple
-```
-require 'Strada'
+
+```ruby
+require 'strada'
+require 'pp'
 cfg  = Strada.cfg
+# print cfg datastructure
+PP.pp cfg
+
 port = cfg.server.port
 user = cfg.auth.user
 pw   = cfg.auth.password
+
+PP.pp cfg
 ```
+
 It tried to detect your software name via caller_locations if no ':name'
 argument was given.
 It automatically loads /etc/name/config and ~/.config/name/config and merges
 them together.
 
 ### Advanced
-```
-require 'Strada'
+
+```ruby
+require 'strada'
+
 Strada = Strada.new name:    'mykewlapp',
-                    default: {'poop'=>'xyzzy'},
+                    default: { 'poop' => 'xyzzy' },
                     adapter: 'yaml',
                     usrdir:  '/home/app/config/',
                     sysdir:  '/System/config/',
                     load:    false
-Strada.default.poop2 = [1, 2, 3, 4]
+
+Strada.default.poop2            = [1, 2, 3, 4]
 Strada.default.starship.poopers = 42
 Strada.load :user
+
 if Strada.user.empty?
   Strada.user = Strada.default
   Strada.save :user
 end
-Strada.load    # load+merges cfg, takes argument :default, :system, :user
-Strada.cfg     # merged default + system + user  (merged on load)
+
+Strada.load # load+merges cfg, takes argument :default, :system, :user
+Strada.cfg # merged default + system + user  (merged on load)
 Strada.default # default only
-Strada.system  # system only
-Strada.user    # user only
+Strada.system # system only
+Strada.user # user only
 ```
 
 ## Reserved methods
 
-* each           - iterate all config keys in current level
+* each - iterate all config keys in current level
 * has_key?(arg)  - check if current level has key arg
 * [arg]          - fetch arg (useful for non-literal retrieval, instead of using #send)
-* key?           - all keys have question mark version reserved, checks if key exists+true (true), exists+false (false), not-exists (nil)
+* key? - all keys have question mark version reserved, checks if key exists+true (true), exists+false (false),
+  not-exists (nil)
+
 + all object class methods
 
 ## TODO
 
-  * should I add feature to raise on unconfigured/unset?
-  * should I always merge to 'cfg' when default/system/config is set?
+* should I add feature to raise on unconfigured/unset?
+* should I always merge to 'cfg' when default/system/config is set?
   

data/lib/strada/adapter/json.rb

@@ -13,13 +13,14 @@ class Strada
     class JSON
       # 定义类方法
       class << self
-        require "json"
         # 将 RUBY(HASH) 数据结构转换为 JSON
         def to(hash)
+          require "json"
           ::JSON.pretty_generate hash
         end
         # 将 JSON 转换为 RUBY 数据结构
         def from(json)
+          require "json"
           ::JSON.load json
         end
       end

data/lib/strada/adapter/toml.rb

@@ -13,14 +13,14 @@ class Strada
     class TOML
       # 定义类方法
       class << self
-        require "toml"
-
         # 将 RUBY(HASH) 数据结构转换为 TOML
         def to(hash)
+          require "toml"
           ::TOML::Generator.new(hash).body
         end
         # 将 TOML 转换为 RUBY 数据结构
         def from(toml)
+          require "toml"
           ::TOML.load toml
         end
       end

data/lib/strada/adapter/yaml.rb

@@ -13,14 +13,14 @@ class Strada
     class YAML
       # 定义类方法
       class << self
-        require "yaml"
-
         # 将 RUBY(HASH) 数据结构转换为 YAML
         def to(hash)
+          require "yaml"
           ::YAML.dump hash
         end
         # 将 YAML 转换为 RUBY(HASH) 数据结构
         def from(yaml)
+          require "yaml"
           ::YAML.load yaml
         end
       end

data/lib/strada/config_struct.rb

@@ -2,6 +2,39 @@
 
 class Strada
   class ConfigStruct
+    # 类对象初始化函数入口
+    def initialize(hash = nil, opts = {})
+      @key_to_s = opts.delete(:key_to_s) || false
+      @cfg      = hash ? _config_from_hash(hash) : {}
+    end
+
+    # 方法反射
+    def method_missing(name, *args, &block)
+      name = name.to_s
+      # 检索 ConfigStruct 键值对
+      # strada.cfg['foo']
+      name = args.shift if name[0..1] == "[]"
+      arg  = args.first
+
+      if name[-1..-1] == "?"
+        # 查询是否包含某个 KEY
+        # strada.cfg.foo.bar?
+        if @cfg.has_key? name[0..-2]
+          @cfg[name[0..-2]]
+        else
+          nil
+        end
+      elsif name[-1..-1] == "="
+        # strada.cfg.foo.bar = 'bala'
+        # ConfigStruct 键值对赋值
+        _config_set name[0..-2], arg
+      else
+        # strada.cfg.foo.bar
+        # ConfigStruct 查询某个属性
+        _config_get name, arg
+      end
+    end
+
     # 将配置信息转换为 HASH 对象
     def _config_to_hash
       hash = {}
@@ -9,7 +42,9 @@ class Strada
         if value.class == ConfigStruct
           value = value._config_to_hash
         end
-        key       = key.to_s if @key_to_s
+        # 是否需要将 key 转为 to_s
+        key = key.to_s if @key_to_s
+        # 保存键值对数据到 HASH
         hash[key] = value
       end
       hash
@@ -36,37 +71,13 @@ class Strada
     end
 
     private
-      def initialize(hash = nil, opts = {})
-        @key_to_s = opts.delete :key_to_s
-        @cfg      = hash ? _config_from_hash(hash) : {}
-      end
-
-      # 方法反射
-      def method_missing(name, *args, &block)
-        name = name.to_s
-        name = args.shift if name[0..1] == "[]" # strada.cfg['foo']
-        arg  = args.first
-
-        if name[-1..-1] == "?" # strada.cfg.foo.bar?
-          if @cfg.has_key? name[0..-2]
-            @cfg[name[0..-2]]
-          else
-            nil
-          end
-        elsif name[-1..-1] == "=" # strada.cfg.foo.bar = 'quux'
-          _config_set name[0..-2], arg
-        else
-          _config_get name, arg # strada.cfg.foo.bar
-        end
-      end
-
-      # 设置键值对
       def _config_set(key, value)
+        # 设置键值对
         @cfg[key] = value
       end
 
-      # 查询 KEY VALUE
       def _config_get(key, value)
+        # 查询 KEY VALUE
         if @cfg.has_key? key
           @cfg[key]
         else
@@ -74,8 +85,8 @@ class Strada
         end
       end
 
-      # 转换 HASH 数据为配置对象
       def _config_from_hash(hash)
+        # 转换 HASH 数据为配置对象
         cfg = {}
         hash.each do |key, value|
           if value.class == Hash

data/lib/strada/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Strada
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/strada.rb

@@ -28,11 +28,6 @@ class UnknownOption < StradaError; end
 #   ssh_hosts = CFG.ssh.hosts
 
 class Strada
-  CONFIG_FILE = "config"
-  # 类对象属性
-  attr_reader :cfg, :default, :file
-  attr_accessor :system, :user
-
   # 类方法
   class << self
     def cfg(*args)
@@ -40,6 +35,42 @@ class Strada
     end
   end
 
+  # 类变量 - 常量，配置保存文件名
+  CONFIG_FILE = "config"
+
+  # 类对象属性
+  attr_reader :cfg, :default, :file, :usr_dir, :sys_dir
+  attr_accessor :system, :user
+
+  # 类对象实例化函数入口
+  def initialize(opts = {})
+    # @param [Hash] opts options for Strada.new
+    # @option opts [String]  :name     name to use for strada (/etc/name/, ~/.config/name/) - autodetected if not defined
+    # @option opts [String]  :adapter  adapter to use 'yaml', 'json' or 'toml' for now
+    # @option opts [String]  :usr_dir   directory for storing user config ~/.config/name/ by default
+    # @option opts [String]  :sys_dir   directory for storing system config /etc/name/ by default
+    # @option opts [String]  :cfg_file  configuration filename, by default CONFIG_FILE
+    # @option opts [Hash]    :default  default settings to use
+    # @option opts [boolean] :load     automatically load+merge system+user config with defaults in #cfg
+    # @option opts [boolean] :key_to_s convert keys to string by calling #to_s for keys
+    @name     = opts.delete(:name) || meta_name
+    @adapter  = opts.delete(:adapter) || "yaml"
+    @usr_dir  = opts.delete(:usr_dir) || File.join(Dir.home, ".config", @name)
+    @sys_dir  = opts.delete(:sys_dir) || File.join("/etc", @name)
+    @cfg_file = opts.delete(:cfg_file) || CONFIG_FILE
+
+    # 配置对象属性
+    @default  = ConfigStruct.new opts.delete(:default)
+    @system   = ConfigStruct.new
+    @user     = ConfigStruct.new
+    @cfg      = ConfigStruct.new
+    @load     = true
+    @load     = opts.delete(:load) if opts.has_key?(:load)
+    @key_to_s = opts.delete(:key_to_s)
+    raise UnknownOption, "option '#{opts}' not recognized" unless opts.empty?
+    load :all if @load
+  end
+
   # When this is called, by default :system and :user are loaded from
   # filesystem and merged with default, so that user overrides system which
   # overrides default
@@ -87,40 +118,12 @@ class Strada
       src = instance_variable_get "@" + src.to_s
       instance_variable_set("@" + dst.to_s, src.dup)
       save dst
-      load if opts.delete :load
+      load if opts.delete(:load)
     end
     no_config
   end
 
   private
-    def initialize(opts = {})
-      # @param [Hash] opts options for Strada.new
-      # @option opts [String]  :name     name to use for strada (/etc/name/, ~/.config/name/) - autodetected if not defined
-      # @option opts [String]  :adapter  adapter to use 'yaml', 'json' or 'toml' for now
-      # @option opts [String]  :usr_dir   directory for storing user config ~/.config/name/ by default
-      # @option opts [String]  :sys_dir   directory for storing system config /etc/name/ by default
-      # @option opts [String]  :cfg_file  configuration filename, by default CONFIG_FILE
-      # @option opts [Hash]    :default  default settings to use
-      # @option opts [boolean] :load     automatically load+merge system+user config with defaults in #cfg
-      # @option opts [boolean] :key_to_s convert keys to string by calling #to_s for keys
-      @name     = opts.delete(:name) || meta_name
-      @adapter  = opts.delete(:adapter) || "yaml"
-      @usr_dir  = opts.delete(:usr_dir) || File.join(Dir.home, ".config", @name)
-      @sys_dir  = opts.delete(:sys_dir) || File.join("/etc", @name)
-      @cfg_file = opts.delete(:cfg_file) || CONFIG_FILE
-
-      # 配置对象属性
-      @default  = ConfigStruct.new opts.delete(:default)
-      @system   = ConfigStruct.new
-      @user     = ConfigStruct.new
-      @cfg      = ConfigStruct.new
-      @load     = true
-      @load     = opts.delete(:load) if opts.has_key?(:load)
-      @key_to_s = opts.delete(:key_to_s)
-      raise UnknownOption, "option '#{opts}' not recognized" unless opts.empty?
-      load :all if @load
-    end
-
     # 加载配置文件
     def load_cfg(dir)
       @file = File.join dir, @cfg_file
@@ -134,7 +137,9 @@ class Strada
     def save_cfg(dir, config)
       config = to(@adapter, config)
       file   = File.join dir, @cfg_file
-      FileUtils.mkdir_p dir
+
+      # 判断目标文件夹是否存在，不存在则新建
+      FileUtils.mkdir_p dir unless Dir.exist? dir
       File.write file, config
     end
 
@@ -143,7 +148,7 @@ class Strada
       hash = {}
       # 将相关配置依次迭代并转换为 RUBY HASH 对象
       configs.each do |config|
-        hash = hash._config_deep_merge config._config_to_hash
+        hash = hash._config_deep_merge(config._config_to_hash)
       end
       # 将合并后的 HASH 数据结构转换为配置对象
       ConfigStruct.new hash
@@ -174,7 +179,7 @@ end
 class Hash
   def _config_deep_merge(new_hash)
     merger = proc do |key, old_val, new_val|
-      Hash === old_val && Hash === new_val ? old_val.merge(new_val, &merger) : new_val
+      (Hash === old_val && Hash === new_val) ? old_val.merge(new_val, &merger) : new_val
     end
     merge new_hash, &merger
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strada
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - WENWU.YAN