envlogic 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c49436c445e6972158bc5a71d120d391f1fd7d4
+  data.tar.gz: c96464929defa28a9246f8381872ffa6cae68501
+SHA512:
+  metadata.gz: 7c1fc754d49f07e35507c30bc5e6d5962cbbcbe41787f39b69d036f9f7f20cfa06c62e6984e30389c084dc9576fc65f9dbf7924a80d990042c0bc2e5bee798c3
+  data.tar.gz: a8456e2b787f72a0083047acbc3bb593bda7834f7c91eb43d8692447b53cc14cbc01aef8bf036c31a4dd691362c37bda26e3e78168a76ec185854730cb0dd928

data/.gitignore

@@ -0,0 +1,56 @@
+# Created by .ignore support plugin (hsz.mobi)
+.idea
+
+### SublimeText template
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/app/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-gemset

@@ -0,0 +1 @@
+env_logic

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.7
+  - 2.2.2
+  - 2.2.3
+script:
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'polishgeeks-dev-tools'
+end

data/Gemfile.lock

@@ -0,0 +1,202 @@
+PATH
+  remote: .
+  specs:
+    envlogic (1.0.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    abstract_type (0.0.7)
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    adamantium (0.2.0)
+      ice_nine (~> 0.11.0)
+      memoizable (~> 0.4.0)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    brakeman (3.1.0)
+      erubis (~> 2.6)
+      fastercsv (~> 1.5)
+      haml (>= 3.0, < 5.0)
+      highline (~> 1.6)
+      multi_json (~> 1.2)
+      ruby2ruby (>= 2.1.1, < 2.3.0)
+      ruby_parser (~> 3.7.0)
+      sass (~> 3.0)
+      slim (>= 1.3.6, < 4.0)
+      terminal-table (~> 1.4.5)
+    bson (3.2.3)
+    builder (3.2.2)
+    coderay (1.1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concord (0.1.5)
+      adamantium (~> 0.2.0)
+      equalizer (~> 0.0.9)
+    connection_pool (2.2.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    faker (1.5.0)
+      i18n (~> 0.5)
+    fastercsv (1.5.5)
+    flay (2.4.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.2.1)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.4)
+    haml (4.0.7)
+      tilt
+    haml-lint (0.13.0)
+      haml (~> 4.0)
+      rubocop (>= 0.25.0)
+      sysexits (~> 1.1)
+    highline (1.7.3)
+    i18n (0.7.0)
+    ice_nine (0.11.1)
+    json (1.8.3)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.8.2)
+    minitest (5.8.0)
+    mongoid (4.0.2)
+      activemodel (~> 4.0)
+      moped (~> 2.0.0)
+      origin (~> 2.1)
+      tzinfo (>= 0.3.37)
+    mongoid-rspec (2.2.0)
+      mongoid (~> 4.0.0)
+      rake
+      rspec (~> 3.1)
+    moped (2.0.7)
+      bson (~> 3.0)
+      connection_pool (~> 2.0)
+      optionable (~> 0.2.0)
+    multi_json (1.11.2)
+    optionable (0.2.0)
+    origin (2.1.1)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    polishgeeks-dev-tools (1.1.2)
+      brakeman
+      faker
+      haml-lint
+      mongoid-rspec
+      pry
+      rspec
+      rubocop
+      rubycritic (= 1.2.1)
+      shoulda
+      simplecov
+      timecop
+      yard
+    powerpack (0.1.1)
+    procto (0.0.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    reek (1.6.3)
+      parser (~> 2.2.0.pre.7)
+      rainbow (>= 1.99, < 3.0)
+      unparser (~> 0.2.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.33.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    ruby2ruby (2.2.0)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.7.1)
+      sexp_processor (~> 4.1)
+    rubycritic (1.2.1)
+      flay (= 2.4.0)
+      flog (= 4.2.1)
+      parser (>= 2.2.0, < 3.0)
+      reek (= 1.6.3)
+      ruby2ruby (>= 2.1.1, < 3.0)
+      virtus (~> 1.0)
+    sass (3.4.18)
+    sexp_processor (4.6.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slim (3.0.6)
+      temple (~> 0.7.3)
+      tilt (>= 1.3.3, < 2.1)
+    slop (3.6.0)
+    sysexits (1.2.0)
+    temple (0.7.6)
+    terminal-table (1.4.5)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    timecop (0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unparser (0.2.4)
+      abstract_type (~> 0.0.7)
+      adamantium (~> 0.2.0)
+      concord (~> 0.1.5)
+      diff-lcs (~> 1.2.5)
+      equalizer (~> 0.0.9)
+      parser (~> 2.2.2)
+      procto (~> 0.0.2)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  envlogic!
+  polishgeeks-dev-tools
+
+BUNDLED WITH
+   1.10.6

data/MIT-LICENCE

@@ -0,0 +1,18 @@
+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,105 @@
+# Envlogic
+
+[![Build Status](https://travis-ci.org/karafka/envlogic.png)](https://travis-ci.org/karafka/envlogic)
+[![Code Climate](https://codeclimate.com/github/karafka/envlogic/badges/gpa.svg)](https://codeclimate.com/github/karafka/envlogic)
+
+Envlogic is a library used to manage environments for your Ruby application in a similar to Rails.env way.
+
+## Installation
+
+Add gem to your Gemfile
+```ruby
+  gem 'envlogic'
+```
+
+## Usage
+
+Extend your class or module in which you want to use this library with **Envlogic** module.
+
+```ruby
+module ExampleModule
+  extend Envlogic
+  # code of this module
+end
+```
+
+Once you extend your class/module with it, you will have two additional methods (with two aliases):
+
+ - *.env* (.environment) - obtain current env and work with it
+ - *.env=* (.environment=) - set your own environment
+
+```ruby
+  ExampleModule.env = 'development'
+  ExampleModule.env.development? # => true
+  ExampleModule.env.production? # => false
+```
+
+### ENV variables key names and default fallbacks
+
+#### Application root directory env key name
+
+By default gem is looking for ENV variable that is based on your application root directory.
+
+For example, if your application lies in */home/deploy/my_app* it will look for **MY_APP_ENV** variable.
+
+#### Module/class name based env key name
+
+If there's no env value under the app directory name key, it will fallback to the module/class based env variable name (including the whole namespace chain):
+
+```ruby
+module Basic
+  module Karafka
+    extend Envlogic
+    # code of Karafka module
+  end
+end
+```
+
+```ruby
+ENV['FACEBOOK_API_ENV'] = nil
+ENV['BASIC_KARAFKA_ENV'] = 'development'
+
+Basic::Karafka.env.production? # => false
+Basic::Karafka.env.development? # => true
+```
+
+#### Default fallbacks
+
+If there's no other way to determine the environment, Envlogic will fallback to ENV['RACK_ENV'] and if it fails, it will just assume that we're in 'development' mode.
+
+You can also assign the environment directly in Ruby:
+
+```ruby
+module Basic
+  module Karafka
+    extend Envlogic
+    # code of Karafka module
+  end
+end
+
+Basic::Karafka.env = :development
+Basic::Karafka.env.production? # => false
+Basic::Karafka.env.development? # => true
+```
+
+## References
+
+ * [Karafka framework](https://github.com/karafka/karafka)
+ * [Waterdrop](https://github.com/karafka/waterdrop)
+ * [Envlogic](https://github.com/karafka/envlogic)
+ * [Sidekiq Glass](https://github.com/karafka/sidekiq-glass)
+
+## Note on Patches/Pull Requests
+
+Fork the project.
+Make your feature addition or bug fix.
+Add tests for it. This is important so I don't break it in a future version unintentionally.
+Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull). Send me a pull request. Bonus points for topic branches.
+
+Each pull request must pass our quality requirements. To check if everything is as it should be, we use [PolishGeeks Dev Tools](https://github.com/polishgeeks/polishgeeks-dev-tools) that combine multiple linters and code analyzers. Please run:
+
+```bash
+bundle exec rake
+```
+
+to check if everything is in order. After that you can submit a pull request.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake'
+require 'polishgeeks-dev-tools'
+
+PolishGeeks::DevTools.setup do |config|
+  config.brakeman = false
+  config.haml_lint = false
+end
+
+desc 'Self check using polishgeeks-dev-tools'
+task :check do
+  PolishGeeks::DevTools::Runner.new.execute(
+    PolishGeeks::DevTools::Logger.new
+  )
+end
+
+task default: :check

data/envlogic.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake'
+require 'envlogic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "envlogic"
+  spec.platform      = Gem::Platform::RUBY
+  spec.version       = Envlogic::VERSION
+  spec.authors       = ['pavlo_vavruk', 'Maciej Mensfeld']
+  spec.email         = %w( pavlo.vavruk@gmail.com maciej@mensfeld.pl )
+
+  spec.summary       = %q{ Ruby based library which allows to set and get environments values
+                           and easily check environment }
+  spec.description   = %q{ Library used to manage environments for your Ruby application }
+  spec.homepage      = 'https://github.com/karafka/envlogic'
+
+  spec.add_dependency 'activesupport'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = %w( lib )
+end

data/lib/envlogic.rb

@@ -0,0 +1,38 @@
+%w(
+  active_support/inflector
+  active_support/string_inquirer
+  envlogic/version
+  envlogic/string_refinements
+  envlogic/env
+).each { |lib| require lib }
+
+# Main module that encapsulates logic that should be used to extend any class/module
+# @note This module should be extended into the class/module in which we want to have env support
+# @example Use it in RandomClass class
+#   class RandomClass
+#     extend Envlogic
+#   end
+#
+# RandomClass.env #=> Envlogic::Env instance
+# RandomClass.env.production? #=> false
+# RandomClass.env.development? #=> true
+module Envlogic
+  # @return [Envlogic::Env] envlogic env instance that allows us to check environment
+  # @example Invoke env in TestClass
+  #   TestClass.env #=> Envlogic::Env instance
+  def env
+    @env ||= Envlogic::Env.new(self)
+  end
+
+  # @param environment [String, Symbol] new environment that we want to set
+  # @return [Envlogic::Env] envlogic env instance
+  # @example Assign new environment to MyApp
+  #   MyApp.env = :production
+  def env=(environment)
+    env.update(environment.to_s)
+  end
+
+  # We alias this for backword compatibility with some code that uses full names
+  alias_method :environment, :env
+  alias_method :environment=, :env=
+end

data/lib/envlogic/env.rb

@@ -0,0 +1,46 @@
+# Main module
+module Envlogic
+  # Env module to get and set environment
+  class Env < ActiveSupport::StringInquirer
+    using StringRefinements
+
+    # What environment key should be used by default
+    FALLBACK_ENV_KEY = 'RACK_ENV'
+    # What default environment should be asumed when there's nothing else
+    FALLBACK_ENV = 'development'
+
+    # @param klass [Class, Module] class/module for which we want to build a Envlogic::Env object
+    # @return [Envlogic::Env] envlogic env object]
+    # @example
+    #   Envlogic::Env.new(User)
+    # @note Will load appropriate environment automatically
+    def initialize(klass)
+      env = ENV[app_dir_name.to_env_key]
+      env ||= ENV[klass.to_s.to_env_key]
+      env ||= ENV[FALLBACK_ENV_KEY]
+
+      update(env || FALLBACK_ENV)
+    end
+
+    # @param environment [String] new environment that we want to set
+    # @example
+    #   env.update('production')
+    def update(environment)
+      replace(
+        ActiveSupport::StringInquirer.new(environment)
+      )
+    end
+
+    private
+
+    # @return [String] name of the directory in which this application is
+    # @note Will return only the last part, so if the dir is /home/apps/my_app it will
+    #   only return the 'my_app' part
+    def app_dir_name
+      Pathname.new(ENV['BUNDLE_GEMFILE'])
+        .dirname
+        .basename
+        .to_s
+    end
+  end
+end

data/lib/envlogic/string_refinements.rb

@@ -0,0 +1,16 @@
+module Envlogic
+  # String refinements used in this library
+  module StringRefinements
+    # Postfix for ENV keys
+    ENV_KEY_POSTFIX = '_ENV'
+
+    refine String do
+      # Converts any string into a bash ENV key
+      def to_env_key
+        underscore
+          .tr('/', '_')
+          .upcase + Envlogic::StringRefinements::ENV_KEY_POSTFIX
+      end
+    end
+  end
+end

data/lib/envlogic/version.rb

@@ -0,0 +1,5 @@
+# Main module to encapsulate logic
+module Envlogic
+  # Current version of gem
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: envlogic
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- pavlo_vavruk
+- Maciej Mensfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " Library used to manage environments for your Ruby application "
+email:
+- pavlo.vavruk@gmail.com
+- maciej@mensfeld.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENCE
+- README.md
+- Rakefile
+- envlogic.gemspec
+- lib/envlogic.rb
+- lib/envlogic/env.rb
+- lib/envlogic/string_refinements.rb
+- lib/envlogic/version.rb
+homepage: https://github.com/karafka/envlogic
+licenses: []
+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.8
+signing_key: 
+specification_version: 4
+summary: Ruby based library which allows to set and get environments values and easily
+  check environment
+test_files: []
+has_rdoc: