strada 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a981211dee0078b5673c81a679e548935bc96a89b5a276ad929a4f9f78fec62
-  data.tar.gz: 2a2b608ebbbe7278cd8c15e5e595d6e3c8ac1084700b163a3a7d919c234a49fe
+  metadata.gz: 41300d7c5eb1f56f0631a7820e9985c5acc0727dbb8db6b2b97a9850a2610351
+  data.tar.gz: 39f971b1074a5dcbf1b107427ff8bbe6a9b05c1dec498c58135b1e71b162d59e
 SHA512:
-  metadata.gz: dd490ff66da8df469d1c68d81a089af33f4bea7710c204800b2afc896629902554f8a1fd7aba7b81f350c5927527e4dc9a70aa9f0bd14db2a0ecb4d0dea9c716
-  data.tar.gz: 645f418feeef553fab68563d2490aa122dd170bcb275231efead05e485cb7dae05861001de383d804b612777059c605dc364b145b8454aaceeefbf23c3c1d934
+  metadata.gz: f67d1199c690c9bfb36f3cfd29f022a5300839532f4ae7cc37ce946cc24deeeca4bc767a9392adcdc952dae3efaf26bfb81f07230ac4b6e5183fbfb4ef9f0596
+  data.tar.gz: 06cc0d0b95db050c3e14d3eadfe238e2247016418533292633cc63bab172c37e1785fac4e4eeced7d5abe9df19afff009f8f8950f8e495a0fffbd1d711f21d80

data/.gitignore

@@ -1,2 +1,2 @@
 Gemfile.lock
-.*gems
+*gem

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 WENWU YAN
+
+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

@@ -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.2"
+  VERSION = "0.0.5"
 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
@@ -78,8 +109,8 @@ class Strada
   # @option opts [boolean] :load         load config once saved, by default false
   # @return [boolean] true if config didn't exist and was created, false if config already exists
   def create(opts = {})
-    src = opts.delete :source || :default
-    dst = opts.delete :destination || :user
+    src = opts.delete(:source) || :default
+    dst = opts.delete(:destination) || :user
 
     no_config = false
     no_config = true if @system.empty? && @user.empty?
@@ -87,42 +118,34 @@ 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
+  # 将 JSON|YAML|TOML 等数据格式转换为 RUBY 数据结构
+  def from(adapter, config)
+    name = "from_" + adapter
+    send name, config
+  end
+
+  # 将 RUBY 数据结构转换为 JSON|YAML|TOML 对象
+  def to(adapter, config)
+    name = "to_" + adapter
+    send name, config
+  end
 
-    # 加载配置文件
+  # 基础的配置标致名称
+  def meta_name
+    path = caller_locations[-1].path
+    File.basename path, File.extname(path)
+  rescue
+    raise NoName, "can't figure out name, specify explicitly"
+  end
+
+  private
     def load_cfg(dir)
+      # 加载配置文件
       @file = File.join dir, @cfg_file
       file  = File.read @file
       ConfigStruct.new(from(@adapter, file), key_to_s: @key_to_s)
@@ -134,7 +157,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,38 +168,18 @@ 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
     end
-
-    # 将 JSON|YAML|TOML 等数据格式转换为 RUBY 数据结构
-    def from(adapter, string)
-      name = "from_" + adapter
-      send name, string
-    end
-
-    # 将 RUBY 数据结构转换为 JSON|YAML|TOML 对象
-    def to(adapter, config)
-      name = "to_" + adapter
-      send name, config
-    end
-
-    # 基础的配置标致名称
-    def meta_name
-      path = caller_locations[-1].path
-      File.basename path, File.extname(path)
-    rescue
-      raise NoName, "can't figure out name, specify explicitly"
-    end
 end
 
 # 增加 HASH 方法
 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

data/strada.gemspec

@@ -2,16 +2,23 @@
 
 require_relative "lib/strada/version"
 Gem::Specification.new do |s|
-  s.name         = "strada"
-  s.version      = Strada::VERSION
-  s.licenses     = ["MIT"]
-  s.platform     = Gem::Platform::RUBY
-  s.authors      = ["WENWU.YAN"]
-  s.email        = "968826@gmail.com"
-  s.homepage     = "http://github.com/ciscolive/strada"
-  s.summary      = "configuration library"
-  s.description  = "configuration library with object access to YAML/JSON/TOML backends"
+  s.name        = "strada"
+  s.version     = Strada::VERSION
+  s.licenses    = ["MIT"]
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["WENWU.YAN"]
+  s.email       = "968826@gmail.com"
+  s.homepage    = "http://github.com/ciscolive/strada"
+  s.summary     = "configuration library"
+  s.description = "configuration library with object access to YAML/JSON/TOML backends"
+
+  s.required_ruby_version = ">= 2.6.0"
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  s.metadata["homepage_uri"]    = s.homepage
+  s.metadata["source_code_uri"] = "https://github.com/ciscolive/strada"
+  s.metadata["changelog_uri"]   = "https://github.com/ciscolive/strada/blob/main/README.md"
+
   s.files        = `git ls-files`.split("\n")
-  s.executables  = %w(  )
   s.require_path = "lib"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strada
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - WENWU.YAN
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-04-17 00:00:00.000000000 Z
 dependencies: []
 description: configuration library with object access to YAML/JSON/TOML backends
 email: 968826@gmail.com
@@ -26,6 +26,7 @@ files:
 - ".idea/vcs.xml"
 - ".rubocop.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/strada.rb
@@ -38,7 +39,10 @@ files:
 homepage: http://github.com/ciscolive/strada
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: http://github.com/ciscolive/strada
+  source_code_uri: https://github.com/ciscolive/strada
+  changelog_uri: https://github.com/ciscolive/strada/blob/main/README.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -47,7 +51,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="