greenenvy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ef6e6a05847bc6b1ddc07008875c81ee8d18e28266efe4b77dad7ed072e14dfc
+  data.tar.gz: 69465094b55506dc57e17587aed0fd1f5b3cb36370945a163c76450a8b964a98
+SHA512:
+  metadata.gz: 3ad5ac56fe219b61300ecc20e2bb978908cc3ef7522e2456ccaa442be06fada9af40d16ee1d9d7feedfdb69a4e4ad9e2bbd3132ab893ff9e85356c7285ed8580
+  data.tar.gz: 671d36ea27656ffe82c9430aa82f3b5f6e49d4aa5e1032a5eee85859615e0d9b0fb8e446a9d1b32a7a7e9489403a3859e068c6dff3a5ffd5be3d007c3f958f57

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aaron.gibralter@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in greenenvy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    greenenvy (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  greenenvy!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Aaron Gibralter
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Aaron Gibralter
+
+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,102 @@
+# Greenenvy
+
+Greenenvy is yet another configuration DSL for Ruby applications. It provides a system for clearly
+declaring environment-specific settings, such as third-party API keys and endpoints.
+
+This project was heavily inspired by https://github.com/jcmuller/figleaf and others.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'greenenvy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install greenenvy
+
+## Usage
+
+For example, for use in a Rails application, you could add Greenenvy to your
+`config/application.rb`:
+
+```ruby
+require_relative 'boot'
+
+require "rails"
+# ...
+
+Bundler.require(*Rails.groups)
+
+module MyApp
+  class Application < Rails::Application
+
+    # Load config/settings/*.rb with Greenenvy gem
+    ::Settings = Greenenvy.load_env(
+      Rails.env,
+      Rails.root.join("config", "settings"),
+    )
+
+    config.load_defaults 5.2
+  end
+end
+```
+
+Given the following file in `config/settings/some_settings.rb`:
+
+```ruby
+
+# Default applies to all environments
+default do
+  set :enabled, false
+  set :api_key, ENV["SOME_API_KEY"]
+end
+
+# Env-specific takes precedence over the defaults
+env :production do
+  set :enabled, true
+end
+```
+
+You could call the following in your Rails code:
+
+```ruby
+# Note `some_settings` is the name of the `.rb` file above.
+api_key = Settings.some_settings.api_key
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` 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/agibralter/greenenvy. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Greenenvy project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/agibralter/greenenvy/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "greenenvy"
+
+# 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(__FILE__)

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/greenenvy.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "greenenvy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "greenenvy"
+  spec.version       = Greenenvy::VERSION
+  spec.authors       = ["Aaron Gibralter"]
+  spec.email         = ["aaron.gibralter@gmail.com"]
+
+  spec.summary       = %q{Greenenvy is yet another configuration DSL for Ruby applications.}
+  spec.homepage      = "https://github.com/agibralter/greenenvy"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/greenenvy.rb

@@ -0,0 +1,15 @@
+require "greenenvy/context"
+require "greenenvy/exceptions"
+require "greenenvy/loader"
+require "greenenvy/name_checker"
+require "greenenvy/name_validator"
+require "greenenvy/open_struct_like"
+require "greenenvy/version"
+
+module Greenenvy
+  def self.load_env(env, dir)
+    name_validator = NameValidator.new(NameChecker.new)
+    loader = Loader.new(Context, name_validator, env, dir).load
+    OpenStructLike.new(loader)
+  end
+end

data/lib/greenenvy/context.rb

@@ -0,0 +1,60 @@
+module Greenenvy
+  class Context
+    def initialize(name_validator, env, code, container_class=OpenStructLike)
+      @name_validator = name_validator
+      @env = env
+      @code = code
+      @container_class = container_class
+    end
+
+    def load_settings
+      default_settings = {}
+      env_settings = {}
+
+      outer_context = OuterContext.new(
+          @name_validator,
+          @env,
+          default_settings,
+          env_settings,
+      )
+      outer_context.instance_eval(@code)
+
+      @container_class.new(default_settings.merge(env_settings))
+    end
+  end
+
+  class OuterContext
+    def initialize(name_validator, env, default_settings, env_settings)
+      @name_validator = name_validator
+      @env = env
+      @default_settings = default_settings
+      @env_settings = env_settings
+    end
+
+    def env(env_name, &block)
+      if env_name.to_s == @env.to_s
+        @name_validator.validate!(env_name)
+        inner_context = InnerContext.new(@name_validator, @env_settings)
+        inner_context.instance_eval(&block)
+      end
+    end
+
+    def default(&block)
+      inner_context = InnerContext.new(@name_validator, @default_settings)
+      inner_context.instance_eval(&block)
+    end
+  end
+
+  class InnerContext
+
+    def initialize(name_validator, settings)
+      @name_validator = name_validator
+      @settings = settings
+    end
+
+    def set(name, value)
+      @name_validator.validate!(name)
+      @settings[name.to_sym] = value
+    end
+  end
+end

data/lib/greenenvy/exceptions.rb

@@ -0,0 +1,6 @@
+module Greenenvy
+  module Exceptions
+    MissingKey = Class.new(StandardError)
+    InvalidKey = Class.new(StandardError)
+  end
+end

data/lib/greenenvy/loader.rb

@@ -0,0 +1,31 @@
+module Greenenvy
+  class Loader
+    def initialize(context_class, name_validator, env, dir)
+      @context_class = context_class
+      @name_validator = name_validator
+      @env = env
+      @dir = dir
+    end
+
+    def load
+      settings = {}
+
+      each_file do |property_name, file_contents|
+        context = @context_class.new(@name_validator, @env, file_contents)
+        settings[property_name] = context.load_settings
+      end
+
+      settings
+    end
+
+    private
+
+    def each_file
+      Dir.glob(File.join(@dir, "*.rb")) do |file_path|
+        property_name = File.basename(file_path, ".rb").to_sym
+        file_contents = File.read(file_path)
+        yield(property_name, file_contents)
+      end
+    end
+  end
+end

data/lib/greenenvy/name_checker.rb

@@ -0,0 +1,35 @@
+module Greenenvy
+  class NameChecker
+    BASIC_OBJECT_METHODS = [
+        :!,
+        :!=,
+        :==,
+        :__id__,
+        :__send__,
+        :equal?,
+        :instance_eval,
+        :instance_exec,
+        :method_missing,
+        :singleton_method_added,
+        :singleton_method_removed,
+        :singleton_method_undefined,
+        :initialize,
+        :inspect,
+    ].freeze
+
+    def valid?(name)
+      name = name.to_s
+      !reserved_method?(name) && valid_pattern?(name)
+    end
+
+    private
+
+    def reserved_method?(name)
+      BASIC_OBJECT_METHODS.include?(name)
+    end
+
+    def valid_pattern?(name)
+      %r{\A[A-Za-z]+\w+\z}.match?(name)
+    end
+  end
+end

data/lib/greenenvy/name_validator.rb

@@ -0,0 +1,13 @@
+module Greenenvy
+  class NameValidator
+    def initialize(name_checker)
+      @name_checker = name_checker
+    end
+
+    def validate!(name)
+      unless @name_checker.valid?(name)
+        raise Exceptions::InvalidKey, "Invalid key, #{name}."
+      end
+    end
+  end
+end

data/lib/greenenvy/open_struct_like.rb

@@ -0,0 +1,52 @@
+module Greenenvy
+  class OpenStructLike < BasicObject
+    def initialize(hash)
+      @hash = hash
+      @method_missing_handler = MethodMissingHandler.new(hash)
+    end
+
+    def method_missing(name, *_)
+      @method_missing_handler.call(name)
+    end
+
+    def inspect
+      @hash.inspect
+    end
+
+    class MethodMissingHandler
+      def initialize(hash)
+        @hash = hash
+      end
+
+      def call(name)
+        name, predicate = process_predicate(name.to_s)
+
+        name = name.to_sym
+
+        if @hash.key?(name)
+          result_with_predicate(name, predicate)
+        else
+          raise Exceptions::MissingKey, missing_key_message(name)
+        end
+      end
+
+      private
+
+      def process_predicate(name)
+        if name[-1] == "?"
+          [name[0..-2], true]
+        else
+          [name, false]
+        end
+      end
+
+      def result_with_predicate(key, predicate)
+        predicate ? !!@hash[key] : @hash[key]
+      end
+
+      def missing_key_message(name)
+        "Unknown key: #{name}. Valid keys: #{@hash.keys.join(", ")}."
+      end
+    end
+  end
+end

data/lib/greenenvy/version.rb

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

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: greenenvy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Gibralter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- aaron.gibralter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- greenenvy.gemspec
+- lib/greenenvy.rb
+- lib/greenenvy/context.rb
+- lib/greenenvy/exceptions.rb
+- lib/greenenvy/loader.rb
+- lib/greenenvy/name_checker.rb
+- lib/greenenvy/name_validator.rb
+- lib/greenenvy/open_struct_like.rb
+- lib/greenenvy/version.rb
+homepage: https://github.com/agibralter/greenenvy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Greenenvy is yet another configuration DSL for Ruby applications.
+test_files: []