tree_config 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0acdbdd68faf35290409c21419d9cd959bbb210
+  data.tar.gz: 22f33ea5cc1b2c098609d4e5f271b01546abe16a
+SHA512:
+  metadata.gz: 03a7324b648ddcc40032f3c9da99b0224e4651332cfa79ff0b73e5bc8ac49c1d1746269420539577cbdfaf496c25a52a05f780879ba1be2d9556c6df471755c4
+  data.tar.gz: 010754a3702b5d258c389cec9e9869a7606c272192fede9d5178853dde2887c928ece8fad35d518231cd25354747eaff985af8249540721bdd4672ef602bcdee

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,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tree_config.gemspec
+gemspec
+
+group :development do
+  gem "rake", "~> 10.0"
+  gem "rspec", "~> 2.14"
+  gem "awesome_print", "~> 1.2"
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 huydx
+
+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,50 @@
+# TreeConfig
+Rails very simple configuration gem, which use "folder structure" as settings key
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tree_config'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tree_config
+
+## Usage
+Use rails generator to generate default config folder
+```
+rails g tree_config:install 
+```
+
+This will generate `config/initializers/rails_config.rb` and generate a default config folder `config/settings` with `common.yml` file.
+
+## Accessing the Settings object
+Generally, all settings will be set into global `Settings` variable.
+Folder name, file name will be use as key, and content of file will be set as this key's value. For example, given the follow settings folder structure
+
+```
+-config
+  |-folder1
+    -A.yml
+    -B.yml
+  |-folder2
+    |-folder3
+      -C.yml
+```
+
+Then we can access A.yml content by `Settings.folder1.A`.
+The content of A is access by properties notation (For example Settings.folder1.A.var1)
+
+## Contributing
+
+1. Fork it ( http://github.com/tree/tree_config/fork )
+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
+. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/lib/tree_config'

data/lib/generators/tree_config/install_generator.rb

@@ -0,0 +1,19 @@
+module TreeConfig
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Generates a custom Hekk Config initializer file."
+
+      def self.source_root
+        @_tree_config_source_root ||= File.expand_path('../templates', __FILE__)
+      end
+      
+      def copy_initializer
+        template "tree_config.rb", "config/initializers/tree_config.rb"
+      end
+
+      def copy_settings 
+        directory "settings", "config/settings"
+      end
+    end
+  end
+end

data/lib/generators/tree_config/templates/tree_config.rb

@@ -0,0 +1,3 @@
+TreeConfig.setup do |config|
+  config.const_name = "Settings"
+end

data/lib/tree_config/error.rb

@@ -0,0 +1,7 @@
+module TreeConfig
+  class Error < StandardError; end
+  class RailsNotInitialized < Error; end
+  class KeyIsFixNum < Error; end
+  class FolderNotDefine < Error; end
+end
+

data/lib/tree_config/integration/rails.rb

@@ -0,0 +1,16 @@
+module TreeConfig
+  module Rails
+    if defined?(Rails::Railtie)
+      class Railtie < Rails::Railtie
+        initializer :load_custom_hekk_config, :before => :load_environment_config, :group => :all do
+          initializer = Rails.root.join("config", "initializer", "hekk_config.rb")
+          require initializer if File.exists?(initializer)
+        end
+
+        initializer :load_hekk_config_settings, :after => :load_custom_rails_config, :before => :load_environment_config, :group => :all do
+          HekkConfig.load(Rails.root.join("config", "settings"))
+        end
+      end
+    end
+  end
+end

data/lib/tree_config/vendor/deep_struct.rb

@@ -0,0 +1,31 @@
+module TreeConfig 
+  class DeepStruct < OpenStruct
+    def initialize(hash=nil)
+      @table = {}
+      @hash_table = {}
+
+      if hash
+        hash.each do |k,v|
+          raise KeyIsFixNum if k.instance_of?(Fixnum)
+          @table[k.to_sym] = (v.is_a?(Hash) ? self.class.new(v) : v)
+          @hash_table[k.to_sym] = v
+          new_ostruct_member(k)
+        end
+      end
+    end
+
+    def to_h
+      @hash_table
+    end
+
+    def empty?
+      self.hash == 0
+    end
+
+    def size
+      sum = 0
+      self.each_pair { |p| sum += 1 }
+      sum
+    end
+  end
+end

data/lib/tree_config/vendor/directory_tree.rb

@@ -0,0 +1,27 @@
+require 'ostruct'
+require 'yaml'
+
+module TreeConfig
+  class DirectoryTree
+    def self.load(dir, struct_obj)
+      Dir.foreach(dir) do |entry|
+        next if (entry == '..' || entry == '.')
+        full_path = File.join(dir, entry)
+        if File.directory? (full_path)
+          struct_obj.send("#{entry}=", DeepStruct.new)
+          struct_obj.send("#{entry}=", self.load(full_path, struct_obj.send("#{entry}")))
+        else
+          hash = ActiveSupport::HashWithIndifferentAccess.new(
+            begin 
+              YAML.load(File.open(full_path))
+            rescue
+            end
+          )
+          name = File.basename(entry, '.*')
+          struct_obj.send("#{name}=", DeepStruct.new(hash))
+        end
+      end
+      return struct_obj
+    end
+  end
+end

data/lib/tree_config/version.rb

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

data/lib/tree_config.rb

@@ -0,0 +1,33 @@
+require "tree_config/version"
+require 'active_support/core_ext'
+require 'tree_config/vendor/directory_tree'
+require 'tree_config/vendor/deep_struct'
+require 'tree_config/error'
+
+module TreeConfig
+  @@_ran_once = false
+
+  mattr_accessor :const_name
+  @@const_name = "Settings"
+  
+  def default_config_folder
+    @@folder = "setting"
+  end
+  
+  def self.setup
+    yield self if @@_ran_once == false
+    @@_ran_once = true
+  end
+
+  def self._load(root_folder)
+    return DirectoryTree.load(root_folder, DeepStruct.new)
+  end
+
+  def self.load(root_folder=nil)
+    raise FolderNotDefine unless root_folder and File.directory? root_folder
+    Kernel.send(:remove_const, TreeConfig.const_name) if Kernel.const_defined?(TreeConfig.const_name)
+    Kernel.const_set(TreeConfig.const_name, TreeConfig._load(root_folder))
+  end
+end
+
+require('tree_config/integration/rails') if defined?(::Rails)

data/spec/fixtures/nest1/A1/test.yml

@@ -0,0 +1,6 @@
+A:
+  a1: bar
+  a2: baz
+B:
+  a3:
+    a4: foo

data/spec/fixtures/nest2/A/C/test.yml

@@ -0,0 +1,6 @@
+A:
+  a1: bar
+  a2: baz
+B:
+  a3:
+    a4: foo

data/spec/fixtures/nest2/A/test.yml

@@ -0,0 +1,6 @@
+A:
+  a1: bar
+  a2: baz
+B:
+  a3:
+    a4: foo

data/spec/fixtures/onefile/test.yml

@@ -0,0 +1,6 @@
+A:
+  a1: bar
+  a2: baz
+B:
+  a3:
+    a4: foo

data/spec/fixtures/onefile_num/test.yml

@@ -0,0 +1,3 @@
+size: 1
+server: google.com
+1: "one"

data/spec/fixtures/twofile/test1.yml

@@ -0,0 +1,6 @@
+A:
+  a1: bar
+  a2: baz
+B:
+  a3:
+    a4: foo

data/spec/fixtures/twofile/test2.yml

@@ -0,0 +1,6 @@
+A:
+  a1: bar
+  a2: baz
+B:
+  a3:
+    a4: foo

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'tree_config'
+require 'pathname'
+require 'bundler/setup'
+
+RSpec.configure do |c|
+  c.color = true
+  c.run_all_when_everything_filtered = true
+  c.before(:all) do
+    @fixture_path = Pathname.new(File.join(File.dirname(__FILE__), '/fixtures'))
+    raise "Fixture folder not found" unless @fixture_path.directory?
+  end
+
+  def setting_folder(folder_name)
+    @fixture_path.join(folder_name)
+  end
+end

data/spec/tree_config_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe TreeConfig do
+  it "should load common setting file" do
+    config = TreeConfig.load(setting_folder("empty"))
+    config.size.should == 0
+  end
+
+  it "should not load fixnum key in yml" do
+    expect { TreeConfig.load(setting_folder("onefile_num")) }.to raise_error(TreeConfig::KeyIsFixNum)
+  end
+
+  it "should load one file" do
+    config = TreeConfig.load(setting_folder("onefile"))
+    config.test.size.should == 2
+    config.test.A.size.should == 2
+    config.test.A.a1.should == "bar"
+    config.test.A.a2.should == "baz"
+    config.test.B.a3.a4.should == "foo"
+  end
+
+  it "should load two file" do
+    config = TreeConfig.load(setting_folder("twofile"))
+    config.size.should == 2
+    config.test1.A.a1.should == "bar"
+    config.test2.A.a1.should == "bar"
+  end
+
+  it "should load nested folder" do
+    config = TreeConfig.load(setting_folder("nest1"))
+    config.size.should == 1
+    config.A1.test.A.a1.should == "bar"
+  end
+
+  it "should load complex nested folder" do
+    config = TreeConfig.load(setting_folder("nest2"))
+    config.size.should == 2
+    config.B.size.should == 0
+    config.A.size.should == 2
+    config.A.test.A.a1.should == "bar"
+    config.A.C.test.A.a1.should == "bar"
+  end
+end

data/tree_config.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tree_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tree_config"
+  spec.version       = TreeConfig::VERSION
+  spec.authors       = ["huydx"]
+  spec.email         = ["doxuanhuy@gmail.com"]
+  spec.summary       = %q{Rails config store gem}
+  spec.description   = %q{Rails config store gem used for project has complex config structure}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "activesupport", ">=3.0"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: tree_config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- huydx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: Rails config store gem used for project has complex config structure
+email:
+- doxuanhuy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- init.rb
+- lib/generators/tree_config/install_generator.rb
+- lib/generators/tree_config/templates/settings/common.yml
+- lib/generators/tree_config/templates/tree_config.rb
+- lib/tree_config.rb
+- lib/tree_config/error.rb
+- lib/tree_config/integration/rails.rb
+- lib/tree_config/vendor/deep_struct.rb
+- lib/tree_config/vendor/directory_tree.rb
+- lib/tree_config/version.rb
+- spec/fixtures/nest1/A1/test.yml
+- spec/fixtures/nest2/A/C/test.yml
+- spec/fixtures/nest2/A/test.yml
+- spec/fixtures/onefile/test.yml
+- spec/fixtures/onefile_num/test.yml
+- spec/fixtures/twofile/test1.yml
+- spec/fixtures/twofile/test2.yml
+- spec/spec_helper.rb
+- spec/tree_config_spec.rb
+- tree_config.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rails config store gem
+test_files:
+- spec/fixtures/nest1/A1/test.yml
+- spec/fixtures/nest2/A/C/test.yml
+- spec/fixtures/nest2/A/test.yml
+- spec/fixtures/onefile/test.yml
+- spec/fixtures/onefile_num/test.yml
+- spec/fixtures/twofile/test1.yml
+- spec/fixtures/twofile/test2.yml
+- spec/spec_helper.rb
+- spec/tree_config_spec.rb
+has_rdoc: