sequoia 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e551c4ff8d48406a2b15d204b91d02f785213d6
+  data.tar.gz: 5d37ac750c81303c32ec9acaea660a33beb34631
+SHA512:
+  metadata.gz: c4f214533793f0399bdd852ad6373ba333274b5e6eab74ac4d5948189771a799efaddf7dc5e0d271bbdf4b357f9bfe03697d1b92df0be36862499cab646eede4
+  data.tar.gz: 3c9d2510b2fbe0c52d886d0e1830fe47f4346f1f44fd60653e1c081358e5c41802b7a2a6b6d5ed870237b0d6ee74f62f1b9ed9d88bae3df36ca31f87bf3538d7

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - jruby-19mode
+
+branches:
+  only:
+    - master

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrey Savchenko
+
+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,58 @@
+# Sequoia
+
+Sequoia is a gem for building environment-aware structures like configs, translations etc.
+
+- [![Build Status](https://travis-ci.org/Ptico/sequoia.png)](https://travis-ci.org/Ptico/sequoia)
+- [![Code Climate](https://codeclimate.com/github/Ptico/sequoia.png)](https://codeclimate.com/github/Ptico/sequoia)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequoia'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequoia
+
+## Usage
+
+```ruby
+tree = Sequoia::Configurator.new
+tree.configure do
+  working_folder '/srv'
+  timeout 30
+  database do
+    adapter  'postgres'
+    user     'app'
+    password 'secret'
+  end
+end
+
+instance.configure :production do
+  timeout 60
+  cache true
+  database do
+    user 'root'
+  end
+end
+
+config = instance.build(:production)
+
+config.working_folder #=> '/srv'
+config.timeout #=> 60
+config.database.user #=> 'root'
+```
+
+## 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,20 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'reek/rake/task'
+
+task :default => :spec
+
+desc 'Test sequoia'
+RSpec::Core::RakeTask.new('spec')
+
+namespace :metrics do
+  desc 'Generate code coverage'
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['spec'].execute
+  end
+
+  Reek::Rake::Task.new do |reek|
+    reek.reek_opts = '--quiet'
+  end
+end

data/lib/sequoia/builder.rb

@@ -0,0 +1,92 @@
+module Sequoia
+
+  ##
+  # Class: Config builder
+  #
+  # Yields the block with definitions and then build keys and values
+  # Also works as a chainable builder
+  #
+  class Builder
+
+    ##
+    # Storage for builded attributes
+    #
+    attr_reader :attrs
+
+  private
+
+    ##
+    # Private: Initialize a new Builder
+    #
+    # Params:
+    # - attrs {Sequoia::Store} For internal use only (optional)
+    #
+    # Yields: block with key-value definitions
+    #
+    def initialize(attrs=Store.new, &block)
+      @attrs = attrs
+
+      instance_eval(&block) if block_given?
+    end
+
+    ##
+    # Private: Method missing handler
+    #
+    # This is where all the magic happens
+    #
+    # Params:
+    # - method_name {Symbol} Method name
+    # - args        {Array}  Array of arguments sended to the method
+    #
+    # Yields: Block with nested definitions
+    #
+    def method_missing(method_name, *args, &block)
+      key   = normalize_method_name(method_name)
+      value = normalize_arguments(args, &block)
+
+      result = attrs[key] ||= (args.length > 0 || block_given? ? value : Store.new)
+      result.class == Store ? self.class.new(result) : result
+    end
+
+    ##
+    # Private: Of course we respond to any key name
+    #
+    def respond_to_missing?(*)
+      true
+    end
+
+    ##
+    # Private: Remove trailing `=` from getter name if exists
+    #
+    # Params:
+    # - method_name {Symbol} Method name
+    #
+    # Returns: {Symbol} Normalized method name
+    #
+    def normalize_method_name(method_name)
+      method_string = method_name.to_s
+      method_string.chop! if method_string.end_with?('=')
+      method_string.to_sym
+    end
+
+    ##
+    # Private: Get value for assignment
+    #
+    # Params:
+    # - args {Array} Array of arguments
+    #
+    # Yields: Block with nested definitions
+    #
+    # Returns: Result of nested Builder#attrs or first argument from args or
+    #          array of arguments if args.length > 1 or nil
+    #
+    def normalize_arguments(args, &block)
+      if block_given?
+        self.class.new(&block).attrs
+      else
+        args.length > 1 ? args : args[0]
+      end
+    end
+
+  end
+end

data/lib/sequoia/configurable.rb

@@ -0,0 +1,47 @@
+require 'sequoia/entity'
+
+module Sequoia
+  ##
+  # Module: Configurable mixin
+  #
+  module Configurable
+
+    ##
+    # Add or merge environment configuration
+    #
+    # Params:
+    # - env {Symbol} Environment to set (optional, default: :default)
+    #
+    # Yields: block with key-value definitions
+    #
+    # Returns: {Sequoia::Builder} builder instance
+    #
+    def configure(env=:default, &block)
+      environment = @config_attributes[env.to_sym] ||= Store.new
+
+      Builder.new(environment, &block)
+    end
+
+    ##
+    # Build configuration object
+    #
+    # Params:
+    # - env {Symbol} Environment to build
+    #
+    # Returns: {Sequoia::Entity} builded configuration object
+    #
+    def build(env=nil)
+      result = @config_attributes[:default]
+      result.deep_merge(@config_attributes[env.to_sym]) if env
+      Entity.create(result)
+    end
+
+  private
+
+    def initialize(*)
+      @config_attributes = { default: Store.new }
+      super
+    end
+
+  end
+end

data/lib/sequoia/configurator.rb

@@ -0,0 +1,7 @@
+require 'sequoia/configurable'
+
+module Sequoia
+  class Configurator
+    include Configurable
+  end
+end

data/lib/sequoia/entity.rb

@@ -0,0 +1,65 @@
+require 'sequoia/store'
+
+module Sequoia
+
+  ##
+  # Class: Resulting storage of configuration data
+  #
+  # Once it initialized - it can't be modified
+  #
+  class Entity < Struct
+
+    ##
+    # Factory: Create new instance of entity
+    #
+    # Returns: {Sequoia::Entity}
+    def self.create(store)
+      keys = store.keys
+
+      values = store.values.map do |value|
+        value.class == Store ? create(value) : value
+      end
+
+      new(*keys).new(*values)
+    end
+
+    ##
+    # Convert content of entity to hash
+    #
+    # TODO: Deep #to_hash
+    #
+    # Returns: {Hash} Hash of all keys and values
+    #
+    def to_hash
+      members.each_with_object({}) { |key, obj| obj[key] = self[key] }
+    end
+
+    ##
+    # Represent content of entity as hash string
+    #
+    # Returns: {String} String with keys and values in hash format
+    #
+    def to_s
+      to_hash.to_s
+    end
+    alias :inspect :to_s
+
+    ##
+    # Returns: {String} a pretty printed object
+    #
+    def pretty_inspect
+      PP.pp(to_hash, '')
+    end
+
+  private
+
+    ##
+    # Private: Initialize and freeze the struct class
+    #
+    def initialize(*)
+      super
+      freeze
+    end
+
+  end
+end

data/lib/sequoia/store.rb

@@ -0,0 +1,34 @@
+module Sequoia
+  ##
+  # Class: Simple container to store internal config
+  #
+  # It exists only to make a difference between hash value and internal data
+  #
+  class Store < ::Hash
+
+    def deep_merge(store)
+      store.each_pair do |key, value|
+        if self[key].class == Store && value.class == Store
+          self[key].deep_merge(value)
+        else
+          self[key] = value
+        end
+      end
+
+      self
+    end
+
+  private
+
+    ##
+    # Private: Initialize new Store
+    #
+    # Params:
+    # - hash {Hash} Hash object to convert
+    #
+    def initialize(hash={})
+      super(nil)
+      self.merge!(hash)
+    end
+  end
+end

data/lib/sequoia/version.rb

@@ -0,0 +1,3 @@
+module Sequoia
+  VERSION = '0.0.1'
+end

data/lib/sequoia.rb

@@ -0,0 +1,9 @@
+require 'sequoia/version'
+require 'sequoia/store'
+require 'sequoia/entity'
+require 'sequoia/builder'
+require 'sequoia/configurator'
+
+module Sequoia
+  # Your code goes here...
+end

data/sequoia.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequoia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sequoia'
+  spec.version       = Sequoia::VERSION
+  spec.authors       = ['Andrey Savchenko', 'Dima Lunich']
+  spec.email         = ['andrey@aejis.eu', 'dima.lunich@gmail.com']
+  spec.summary       = %q{Gem for building data structures}
+  spec.description   = %q{Sequoia is a gem for building environment-aware structures like configs, translations etc.}
+  spec.homepage      = 'https://github.com/Ptico/sequoia'
+  spec.license       = 'MIT'
+
+  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'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'simplecov'
+end

data/spec/integration/configurator_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Sequoia::Configurator do
+  let(:instance) { described_class.new }
+
+  let(:config) do
+    instance.configure do
+      working_folder '/srv'
+      timeout 30
+      database do
+        adapter 'postgres'
+      end
+    end
+
+    instance.configure :development do
+      timeout 60
+      cache false
+      database do
+        user 'dev'
+        pass 'null'
+      end
+    end
+
+    instance.configure :production do
+      timeout 20
+      production true
+      database do
+        user 'admin'
+        pass 'secret'
+      end
+    end
+
+    instance
+  end
+
+  let(:result) { config.build(env) }
+
+  context 'without env' do
+    let(:env) { nil }
+
+    it 'should build config' do
+      expect(result.working_folder).to eql('/srv')
+      expect(result.timeout).to eql(30)
+    end
+  end
+
+  context 'with env' do
+    let(:env) { :development }
+
+    it 'should merge config' do
+      expect(result.working_folder).to eql('/srv')
+      expect(result.timeout).to eql(60)
+      expect(result.cache).to be_false
+    end
+
+    it 'should merge namespaces' do
+      expect(result.database.adapter).to eql('postgres')
+      expect(result.database.user).to eql('dev')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'sequoia'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/unit/builder_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Sequoia::Builder do
+
+  let(:result) { instance.attrs }
+
+  shared_examples 'block_attributes' do
+    it 'should set values' do
+      expect(result[:working_folder]).to eql('/srv')
+      expect(result[:timeout]).to        eql(30)
+    end
+
+    it 'should set namespaces' do
+      expect(result[:database][:name]).to eql('test_db')
+    end
+
+    it 'should manage deep namespaces' do
+      expect(result[:database][:creds][:user]).to eql('admin')
+      expect(result[:database][:creds][:pass]).to eql('secret')
+    end
+
+    it 'should handle booleans' do
+      expect(result[:async]).to be_false
+    end
+
+    it 'should store hashes as hashes' do
+      expect(result[:database].class).to eql(Sequoia::Store)
+      expect(result[:creds].class).to    eql(Hash)
+    end
+  end
+
+  describe 'Block-style' do
+    let(:instance) do
+      described_class.new do
+        working_folder '/srv'
+        timeout 30
+        async false
+        creds(user: 'admin', pass: 'secret')
+
+        database do
+          creds do
+            user 'admin'
+            pass 'secret'
+          end
+          name 'test_db'
+        end
+      end
+    end
+
+    it_behaves_like 'block_attributes'
+  end
+
+  describe 'Object-style' do
+    let(:instance) do
+      inst = described_class.new
+
+      inst.working_folder = '/srv'
+      inst.timeout = 30
+      inst.async = false
+      inst.creds = { user: 'admin', pass: 'secret' }
+
+      inst.database.creds.user = 'admin'
+      inst.database.creds.pass = 'secret'
+      inst.database.name = 'test_db'
+
+      inst
+    end
+
+    it_behaves_like 'block_attributes'
+  end
+end

data/spec/unit/entity_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Sequoia::Entity do
+  let(:instance) { Sequoia::Entity.create(hash) }
+
+  let(:hash) do
+    Sequoia::Store.new({
+      working_folder: '/srv',
+      database: Sequoia::Store.new(name: 'test_db', user: 'inferno'),
+      creds: { user: 'admin', pass: 'secret' }
+    })
+  end
+
+  it 'should be frozen' do
+    expect(instance).to be_frozen
+  end
+
+  it 'should respond to keys' do
+    expect(instance).to respond_to(:working_folder)
+  end
+
+  it 'should keep hashes' do
+    expect { instance.creds.user }.to raise_error
+    expect(instance.creds[:user]).to eql('admin')
+  end
+
+  context 'as object' do
+    it 'should get keys' do
+      expect(instance.working_folder).to eql('/srv')
+    end
+
+    it 'should get namespaces' do
+      expect(instance.database.name).to eql('test_db')
+    end
+  end
+
+  context 'as hash' do
+    it 'should get keys as hash keys' do
+      expect(instance[:working_folder]).to eql('/srv')
+    end
+
+    it 'should get namespaces' do
+      expect(instance[:database][:name]).to eql('test_db')
+    end
+  end
+end

data/spec/unit/store_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Sequoia::Store do
+  let(:instance) { described_class.new(hash) }
+  let(:hash) do
+    {
+      working_folder: '/srv',
+      database: { name: 'test_db' },
+      creds: Sequoia::Store.new(name: 'admin')
+    }
+  end
+
+  it 'should create instance from hash' do
+    expect(instance[:working_folder]).to eql('/srv')
+  end
+
+  it 'should set nested hashes' do
+    expect(instance[:database]).to be_a(Hash)
+  end
+
+  it 'should merge nested stores' do
+    instance.deep_merge(Sequoia::Store.new(creds: Sequoia::Store.new(pass: 'secret')))
+    expect(instance[:creds][:name]).to eql('admin')
+    expect(instance[:creds][:pass]).to eql('secret')
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: sequoia
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrey Savchenko
+- Dima Lunich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-04 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'
+- !ruby/object:Gem::Dependency
+  name: reek
+  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: simplecov
+  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: Sequoia is a gem for building environment-aware structures like configs,
+  translations etc.
+email:
+- andrey@aejis.eu
+- dima.lunich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequoia.rb
+- lib/sequoia/builder.rb
+- lib/sequoia/configurable.rb
+- lib/sequoia/configurator.rb
+- lib/sequoia/entity.rb
+- lib/sequoia/store.rb
+- lib/sequoia/version.rb
+- sequoia.gemspec
+- spec/integration/configurator_spec.rb
+- spec/spec_helper.rb
+- spec/unit/builder_spec.rb
+- spec/unit/entity_spec.rb
+- spec/unit/store_spec.rb
+homepage: https://github.com/Ptico/sequoia
+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: Gem for building data structures
+test_files:
+- spec/integration/configurator_spec.rb
+- spec/spec_helper.rb
+- spec/unit/builder_spec.rb
+- spec/unit/entity_spec.rb
+- spec/unit/store_spec.rb