envlogic 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8a09f4a02ecb4aa854f21c30620be8670fc22f41eb3eb464ec5d8bb67dda98d
-  data.tar.gz: 706f85a46eb589b93492e3a0b3fa08cbd5c4685471305c60fa6dd0d6745f6981
+  metadata.gz: 111d26f3d2e7c8bdcccf966cb4290d6fd5f019e57ba616111a1131790499aa8b
+  data.tar.gz: 9b5e99b1e28a507730ab7c1e14b195302e272ac2ea5294d6f7a8a65c32c197ee
 SHA512:
-  metadata.gz: d47e67ed63559fa4a23f5a28952fd0ee63bab890ed24e79e126e15b52c1fe09fa51343463b8396d3d4e58f9cbd14ebb1a8d4522d0c5b052a8b00308589c3096d
-  data.tar.gz: 8be0454147aa97749c5ff9c1e0832dd5173d596abdda9f58865065b5b6c1a248b02da1413b1c6fda16f2ef77158a9080aa2d4eff5e246f9664a0e51f90675d18
+  metadata.gz: 8e15698e86e7f54148262f668e4d612dc6b3a02e164a8f99692c47ae5a4337b0b045ebb3f95fef7cba59d1098ab43785b6fdd4294bba1fac9f9bba0e7db37d80
+  data.tar.gz: 4bcd82c8dd5e64964283d453f884c34effea553121d05ea1541d51c46afc237a11c399ff9b8a4d70c4b4d170a7d94e1992a5111d36c018e289e3629787484423

data/.coditsu/ci.yml

@@ -0,0 +1,3 @@
+repository_id: '8e9c10ac-336a-485a-9f9b-69ea15075c2b'
+api_key: <%= ENV['CODITSU_API_KEY'] %>
+api_secret: <%= ENV['CODITSU_API_SECRET'] %>

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+open_collective: karafka

data/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: ci
+
+on:
+  push:
+    paths:
+      - '**'
+  schedule:
+    - cron:  '0 1 * * *'
+
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.7"
+          - "2.6"
+          - "2.5"
+    steps:
+      - uses: actions/checkout@v1
+      - name: Install package dependencies
+        run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+      - name: Install latest bundler
+        run: |
+          gem install bundler --no-document
+          bundle config set without 'tools benchmarks docs'
+      - name: Bundle install
+        run: bundle install --jobs 4 --retry 3
+      - name: Run all tests
+        run: bundle exec rspec
+  coditsu:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v1
+      - name: Run Coditsu
+        run: \curl -sSL https://api.coditsu.io/run/ci | bash

data/.gitignore

@@ -54,3 +54,4 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+.coditsu/local.yml

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.7.1

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Envlogic gem changelog
 
+## Unreleased (master)
+- drop jruby support
+- drop Ruby 2.2 support
+- drop Ruby 2.3 support
+- drop Ruby 2.4 support
+- Ruby 2.6.5 support
+- Ruby 2.7.1 support
+- Replace travis with GH actions
+- Update docs to show per instance support
+
 ## 1.1.0
 - Ruby 2.4.2 support
 - Ruby 2.5.0 support
@@ -11,7 +21,7 @@
 - Quality improvements
 - Gems cleanup
 - Ruby dump to 2.4.1
-- Better specs (less internal, more integrational)
+- Better specs (less internal, more integration)
 - License added to the gemspec file
 
 ## 1.0.3

data/Gemfile

@@ -6,6 +6,9 @@ gemspec
 
 group :development, :test do
   gem 'rake'
+end
+
+group :test do
   gem 'rspec'
   gem 'simplecov'
 end

data/Gemfile.lock

@@ -1,35 +1,33 @@
 PATH
   remote: .
   specs:
-    envlogic (1.1.0)
+    envlogic (1.1.1)
       dry-inflector (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    docile (1.3.0)
-    dry-inflector (0.1.1)
-    json (2.1.0)
-    rake (12.3.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    docile (1.3.2)
+    dry-inflector (0.2.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    simplecov (0.16.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
 
 PLATFORMS
   ruby
@@ -41,4 +39,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

data/README.md

@@ -1,19 +1,21 @@
 # Envlogic
 
-[![Build Status](https://travis-ci.org/karafka/envlogic.png)](https://travis-ci.org/karafka/envlogic)
+[![Build Status](https://github.com/karafka/envlogic/workflows/ci/badge.svg)](https://github.com/karafka/envlogic/actions?query=workflow%3Aci)
 [![Join the chat at https://gitter.im/karafka/karafka](https://badges.gitter.im/karafka/karafka.svg)](https://gitter.im/karafka/karafka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 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
+Add the gem to your Gemfile
 ```ruby
   gem 'envlogic'
 ```
 
 ## Usage
 
+### On a class/module level
+
 Extend your class or module in which you want to use this library with **Envlogic** module.
 
 ```ruby
@@ -34,11 +36,34 @@ Once you extend your class/module with it, you will have two additional methods
   ExampleModule.env.production? # => false
 ```
 
+### On a per instance basis
+
+Include the **Envlogic** module in the class for which instances you want to use it.
+
+```ruby
+class ExampleClass
+  include Envlogic
+  # code of this class
+end
+```
+
+Once you include it in your class, 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
+  instance = ExampleClass.new
+  instance.env = 'development'
+  instance.env.development? # => true
+  instance.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.
+By default, the 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.
 
@@ -92,7 +117,7 @@ Basic::Karafka.env.development? # => true
 
 First, thank you for considering contributing to Envlogic! It's people like you that make the open source community such a great community!
 
-Each pull request must pass all the rspec specs and meet our quality requirements.
+Each pull request must pass all the RSpec specs and meet our quality requirements.
 
 To check if everything is as it should be, we use [Coditsu](https://coditsu.io) that combines multiple linters and code analyzers for both code and documentation. Once you're done with your changes, submit a pull request.
 

data/envlogic.gemspec

@@ -17,8 +17,13 @@ Gem::Specification.new do |spec|
   spec.license     = 'MIT'
 
   spec.add_dependency 'dry-inflector', '~> 0.1'
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
+  if $PROGRAM_NAME.end_with?('gem')
+    spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
+  end
+
+  spec.cert_chain    = %w[certs/mensfeld.pem]
   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]

data/lib/envlogic.rb

@@ -7,15 +7,27 @@
 ].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
+# @note This module should be extended/included 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
+#   RandomClass.env #=> Envlogic::Env instance
+#   RandomClass.env.production? #=> false
+#   RandomClass.env.development? #=> true
+#
+# @example Use it for instances of objects
+#   class RandomClass
+#     include Envlogic
+#   end
+#
+#   instance = RandomClass.new
+#   instance.env #=> Envlogic::Env instance
+#   instance.env.production? #=> false
+#   instance.env.development? #=> true
 module Envlogic
   # @return [Envlogic::Env] envlogic env instance that allows us to check environment
   # @example Invoke env in TestClass
@@ -32,7 +44,7 @@ module Envlogic
     env.update(environment.to_s)
   end
 
-  # We alias this for backword compatibility with some code that uses full names
+  # We alias this for backward compatibility with some code that uses full names
   alias environment env
   alias environment= env=
 end

data/lib/envlogic/env.rb

@@ -6,7 +6,7 @@ module Envlogic
   class Env < String
     # What environment key should be used by default
     FALLBACK_ENV_KEY = 'RACK_ENV'
-    # What default environment should be asumed when there's nothing else
+    # What default environment should be assumed when there's nothing else
     FALLBACK_ENV = 'development'
     # Postfix for ENV keys
     ENV_KEY_POSTFIX = '_ENV'
@@ -20,9 +20,9 @@ module Envlogic
 
     # @param klass [Class, Module] class/module for which we want to build a Envlogic::Env object
     # @return [Envlogic::Env] envlogic env object]
+    # @note Will load appropriate environment automatically
     # @example
     #   Envlogic::Env.new(User)
-    # @note Will load appropriate environment automatically
     def initialize(klass)
       env = ENV[to_env_key(app_dir_name)]
       env ||= ENV[to_env_key(klass.to_s)]
@@ -38,7 +38,7 @@ module Envlogic
       (method_name[-1] == '?') || super
     end
 
-    # Reacts to missing methods, from which some might be the env checkings.
+    # Reacts to missing methods, from which some might be the env checks.
     # If the method ends with '?' we assume, that it is an env check
     # @param method_name [String] method name for missing or env name with question mark
     # @param arguments [Array] any arguments that we pass to the method
@@ -60,6 +60,8 @@ module Envlogic
     end
 
     # Converts any string into a bash ENV key
+    # @param string [String] string we want to convert into an env key
+    # @return [String] converted name that can be an ENV key
     def to_env_key(string)
       INFLECTOR
         .underscore(string)

data/lib/envlogic/version.rb

@@ -3,5 +3,5 @@
 # Main module to encapsulate logic
 module Envlogic
   # Current version of gem
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,15 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: envlogic
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - pavlo_vavruk
 - Maciej Mensfeld
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhtYWNp
+  ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMTkwNzMwMTQ1NDU0WhcNMjAwNzI5MTQ1
+  NDU0WjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
+  CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC9fCwtaHZG2SyyNXiH8r0QbJQx/xxl
+  dkvwWz9QGJO+O8rEx20FB1Ab+MVkfOscwIv5jWpmk1U9whzDPl1uFtIbgu+sk+Zb
+  uQlZyK/DPN6c+/BbBL+RryTBRyvkPLoCVwm7uxc/JZ1n4AI6eF4cCZ2ieZ9QgQbU
+  MQs2QPqs9hT50Ez/40GnOdadVfiDDGz+NME2C4ms0BriXwZ1tcRTfJIHe2xjIbbb
+  y5qRGfsLKcgMzvLQR24olixyX1MR0s4+Wveq3QL/gBhL4veUcv+UABJA8IJR0kyB
+  seHHutusiwZ1v3SjjjW1xLLrc2ARV0mgCb0WaK2T4iA3oFTGLh6Ydz8LNl31KQFv
+  94nRd8IhmJxrhQ6dQ/WT9IXoa5S9lfT5lPJeINemH4/6QPABzf9W2IZlCdI9wCdB
+  TBaw57MKneGAYZiKjw6OALSy2ltQUCl3RqFl3VP7n8uFy1U987Q5VIIQ3O1UUsQD
+  Oe/h+r7GUU4RSPKgPlrwvW9bD/UQ+zF51v8CAwEAAaN3MHUwCQYDVR0TBAIwADAL
+  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJNIBHdfEUD7TqHqIer2YhWaWhwcMB0GA1Ud
+  EQQWMBSBEm1hY2llakBtZW5zZmVsZC5wbDAdBgNVHRIEFjAUgRJtYWNpZWpAbWVu
+  c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBAKA4eqko6BTNhlysip6rfBkVTGri
+  ZXsL+kRb2hLvsQJS/kLyM21oMlu+LN0aPj3qEFR8mE/YeDD8rLAfruBRTltPNbR7
+  xA5eE1gkxY5LfExUtK3b2wPqfmo7mZgfcsMwfYg/tUXw1WpBCnrhAJodpGH6SXmp
+  A40qFUZst0vjiOoO+aTblIHPmMJXoZ3K42dTlNKlEiDKUWMRKSgpjjYGEYalFNWI
+  hHfCz2r8L2t+dYdMZg1JGbEkq4ADGsAA8ioZIpJd7V4hI17u5TCdi7X5wh/0gN0E
+  CgP+nLox3D+l2q0QuQEkayr+auFYkzTCkF+BmEk1D0Ru4mcf3F4CJvEmW4Pzbjqt
+  i1tsCWPtJ4E/UUKnKaWKqGbjrjHJ0MuShYzHkodox5IOiCXIQg+1+YSzfXUV6WEK
+  KJG/fhg1JV5vVDdVy6x+tv5SQ5ctU0feCsVfESi3rE3zRd+nvzE9HcZ5aXeL1UtJ
+  nT5Xrioegu2w1jPyVEgyZgTZC5rvD0nNS5sFNQ==
+  -----END CERTIFICATE-----
+date: 2020-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-inflector
@@ -33,11 +59,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coditsu/ci.yml"
+- ".github/FUNDING.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -60,15 +88,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Library which allows to set and get environments values

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.3.0
-  - 2.3.1
-  - 2.3.2
-  - 2.3.3
-  - 2.3.4
-  - 2.4.0
-  - 2.4.1
-  - 2.4.2
-  - 2.5.0
-  - jruby-head
-script: bundle exec rspec spec/
-env:
-  global:
-    - JRUBY_OPTS='--debug'
-install: bundle install --jobs=3 --retry=3