flyml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0fe20edb9ba83305578c4917bc1bf56669fd68b2
+  data.tar.gz: db7863d9211bcdc8ebbc085de6eb5d4ad5c4818b
+SHA512:
+  metadata.gz: 2b76f265df05d57532a6d0a0a58b354fef3e82c565b4d6c2840babb96074c79117a48c1e0f83b150af4c2342298c61ca9188beba5446aae273422139d0caf727
+  data.tar.gz: e2289e9773435ff89ccaffe06ced8c56b6576a8daffe88c8ec537cf2433b3d38aa0b7badc674c7ae6edb7b5352484b020d0893f9f255788ebec58f166bd59d85

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at alvarobp@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 peerTransfer Tech
+
+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,81 @@
+# Flyml
+
+Application settings convention over YAML.
+
+## Build Status
+
+[![Build Status](https://travis-ci.org/peertransfer/flyml.svg?branch=master)](https://travis-ci.org/peertransfer/flyml)
+[![Coverage Status](https://coveralls.io/repos/github/peertransfer/flyml/badge.svg?branch=master)](https://coveralls.io/github/peertransfer/flyml?branch=master)
+[![Code Climate](https://codeclimate.com/github/peertransfer/flyml/badges/gpa.svg)](https://codeclimate.com/github/peertransfer/flyml)
+[![Dependency Status](https://gemnasium.com/peertransfer/flyml.svg)](https://gemnasium.com/peertransfer/flyml)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flyml'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flyml
+
+## Usage
+
+Flyml convention is based on the following premises:
+
+  - Configuration is stored in YAML files.
+  - Configuration files are stored in a ``config`` directory within your project root directory.
+  - Files are divided by application execution environment.
+
+Let's see an example. Imagine you have a configuration file ``your_project/config/redis.yml``, which content is:
+
+```ruby
+---
+development:
+  host: dev.local
+  port: 6379
+
+test:
+  host: test.local
+  port: 6379
+```
+
+Here's how you would use Flyml:
+
+```ruby
+require 'flyml'
+
+Flyml.env = 'development'
+Flyml.root = '/path/to/project_root'
+
+Flyml[:redis][:host] # 'dev.local'
+Flyml[:redis][:port] # 6379
+```
+
+## ToDo
+
+- Default env and root
+- Review and question Values implementation, seriously.
+- Rails magic?
+- DaemonKit magic?
+- Env vars magic?
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/peertransfer/flyml. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flyml"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flyml.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flyml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flyml"
+  spec.version       = Flyml::VERSION
+  spec.authors       = ["peerTransfer tech"]
+  spec.email         = ["tech@peertransfer.com"]
+
+  spec.summary       = %q{Application settings convention over YAML}
+  spec.description   = %q{Application settings convention over YAML}
+  spec.homepage      = "http://github.com/peertransfer/flyml"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ">= 3.2.0"
+
+  spec.add_development_dependency "bundler", ">= 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "coveralls"
+end

data/lib/flyml/core_ext/hash.rb

@@ -0,0 +1,25 @@
+require 'active_support/core_ext/hash/keys'
+
+class Hash
+  def recursive_symbolize_keys!
+    symbolize_keys!
+    # symbolize each hash in .values
+    values.each { |h| h.recursive_symbolize_keys! if h.is_a?(Hash) }
+    # symbolize each hash inside an array in .values
+    values.select { |v| v.is_a?(Array) }.flatten.each { |h| h.recursive_symbolize_keys! if h.is_a?(Hash) }
+    self
+  end
+
+  def deep_fetch(*args, &block)
+    return self if args.empty?
+    value = fetch(args.shift, &block)
+    if value.is_a?(Hash)
+      value.deep_fetch(*args, &block)
+    elsif value.is_a?(Array) && !args.empty?
+      value = value[args.shift]
+      value.deep_fetch(*args, &block)
+    else
+      value
+    end
+  end
+end

data/lib/flyml/values.rb

@@ -0,0 +1,44 @@
+require_relative 'core_ext/hash'
+
+module Flyml
+  class Values < Hash
+    attr_writer :file
+
+    def self.build(data, file=nil)
+      setting_values = new.merge(data)
+      setting_values.file = file
+      setting_values
+    end
+
+    def initialize(*args)
+      @symbolize_on_write = true
+      super
+    end
+
+    def merge(*args)
+      obj = super
+      obj.recursive_symbolize_keys! if @symbolize_on_write
+      obj
+    end
+
+    def merge!(*args)
+      obj = super
+      obj.recursive_symbolize_keys! if @symbolize_on_write
+      obj
+    end
+    alias read []
+
+    def recursive_symbolize_keys!
+      @symbolize_on_write = false
+      super
+      @symbolize_on_write = true
+    end
+
+    def []=(key, value)
+      super
+
+      recursive_symbolize_keys! if @symbolize_on_write
+    end
+    alias write []=
+  end
+end

data/lib/flyml/version.rb

@@ -0,0 +1,3 @@
+module Flyml
+  VERSION = "0.1.0"
+end

data/lib/flyml.rb

@@ -0,0 +1,39 @@
+require 'yaml'
+require 'flyml/version'
+require 'flyml/values'
+
+module Flyml
+  class << self
+    attr_accessor :env, :root
+
+    def [](file)
+      @config ||= {}
+      @config[file.to_sym] = load_settings(file) unless @config[file.to_sym]
+      @config[file.to_sym]
+    end
+
+    private
+
+    def prepare_hash(data)
+      hash = data.is_a?(Hash) && data[env.to_s] ? data[env.to_s] : {}
+      Values.build(hash)
+    end
+
+    def file_path(name)
+      File.join(root, 'config', "#{name}.yml")
+    end
+
+    def load_settings(file)
+      path = file_path(file)
+      return unless File.exist?(path)
+
+      content = load_file_content(path)
+      data = YAML.load(content)
+      prepare_hash(data)
+    end
+
+    def load_file_content(path)
+      File.read(path)
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: flyml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- peerTransfer tech
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: Application settings convention over YAML
+email:
+- tech@peertransfer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flyml.gemspec
+- lib/flyml.rb
+- lib/flyml/core_ext/hash.rb
+- lib/flyml/values.rb
+- lib/flyml/version.rb
+homepage: http://github.com/peertransfer/flyml
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Application settings convention over YAML
+test_files: []