credentials_for_rails_env 1.0.1 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78d5383e7b8cdd80b1f71e67458b4e011aefce866884f0097a19a319f3b740e7
-  data.tar.gz: 0f824a80f6efb86a5d84e96cc114f6d7d904d6de4e41128fcce9ca5a72a46673
+  metadata.gz: 8d4baa163cf9728a3bb695b0b6ca6285946da9317c2073c9e6ca42996637a86b
+  data.tar.gz: 0cf7b53577839548b6dba8d1ce9954aad1d50ee154fe731c58f05470b71aa980
 SHA512:
-  metadata.gz: 6986fcd834221e93dd32415a4916ddeee1e665047817e53a1705462adc4c7cc2ba0dce206204f203b8ce4b80fc3ab37428de81bbb218cb28c53ce8010c8fd17f
-  data.tar.gz: 9f6bdb04342eaf6916602221110f0967fa7c36283ec80f8ed7f7004085997b7e715957fc1af53795d3987354dc7e3e378988da7d3183f5075ec00e86ca19d9c6
+  metadata.gz: 9c48591d067e32656bd0f4c3e4c54e0c26203a7b43ac57f52852218f82726db603ecdb9050814ebe312c4a9d2679dc837d8c56d91c7bf8438cf10f897d88f29f
+  data.tar.gz: 83f2af9737961f1c5291bc2919bf2c662c27c6fcd947f46a9b436039c9411e94daa04983bb8426b42feaadd37f3465256aab366166ace316572c1f78a8a02e8b

data/.rubocop.yml

@@ -0,0 +1,210 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - '**/templates/**/*'
+    - '**/vendor/**/*'
+    - 'actionpack/lib/action_dispatch/journey/parser.rb'
+    - 'railties/test/fixtures/tmp/**/*'
+
+Performance:
+  Exclude:
+    - '**/test/**/*'
+
+Rails:
+  Enabled: true
+
+# Prefer assert_not over assert !
+Rails/AssertNot:
+  Include:
+    - '**/test/**/*'
+
+# Prefer assert_not_x over refute_x
+Rails/RefuteMethods:
+  Include:
+    - '**/test/**/*'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Do not use braces for hash literals when they are the last argument of a
+# method call.
+Style/BracesAroundHashParameters:
+  Enabled: true
+  EnforcedStyle: context_dependent
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Layout/FirstParameterIndentation:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: rails
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+    Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+    Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+  Exclude:
+    - 'actionview/test/**/*.builder'
+    - 'actionview/test/**/*.ruby'
+    - 'actionpack/test/**/*.builder'
+    - 'actionpack/test/**/*.ruby'
+    - 'activestorage/db/migrate/**/*.rb'
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/StringConversionInInterpolation:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/RedundantMerge:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/RegexpMatch:
+  Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    credentials_for_rails_env (1.0.0)
+    credentials_for_rails_env (2.0)
       rails (~> 5.2)
 
 GEM
@@ -64,7 +64,7 @@ GEM
       nokogiri (>= 1.5.9)
     mail (2.7.0)
       mini_mime (>= 0.1.1)
-    marcel (0.3.2)
+    marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (0.9.0)
     mimemagic (0.3.2)

data/README.md

@@ -9,7 +9,7 @@ $ EDITOR=vim rails credentials:edit
 ```yaml
 foo: global foo
 development:
-  foo: development foo
+  foo: <%= ["development", "foo"].join(" ") %>
 production:
   foo: production foo
 ```
@@ -24,7 +24,7 @@ Rails.application.credentials.env.fetch(:foo) => "development foo"
 Rails.application.credentials.env.config      => { foo: "development foo" }
 ```
 
-This makes it very easy to migrate from the deprecated Rails 5.1 secrets convention to the new Rails 5.2 credentials convention. Just add the contents of your secrets file to your credentials file and replace all calls to "Rails.application.secrets" with calls to "Rails.application.credentials.env". Then you can delete your secrets files.
+This makes it very easy to migrate from the deprecated Rails 5.1 encrypted secrets convention to the new Rails 5.2 credentials convention. Just add the contents of your secrets file to your credentials file and replace all calls to "Rails.application.secrets" with calls to "Rails.application.credentials.env". Then you can delete your secrets files.
 
 You can still call "Rails.application.credentials" as usual to see the global credentials view.
 
@@ -32,7 +32,7 @@ You can still call "Rails.application.credentials" as usual to see the global cr
 Rails.application.credentials.foo => "global foo"
 ```
 
-This works by extending ActiveSupport::EncryptedConfiguration to take an optional rails_env parameter.
+This works by extending ActiveSupport::EncryptedConfiguration to filter files with ERB to interpret "<%= ... %>" marks in ruby and to take an optional rails_env parameter.
 
 ```ruby
 module Rails
@@ -69,7 +69,7 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself:
 
     $ gem install credentials_for_rails_env
 
@@ -89,6 +89,20 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+## Versions
+
+##### Version 0.1.0 2018-09-09
+
+Provided Rails.application.credentials_env interface.
+
+##### Version 1.0.0 2018-09-13
+
+Provided Rails.application.credentials.env interface.
+
+##### Version 2.0 2018-09-16
+
+Implemented ERB filtering <%= :ruby %>.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jgorman/credentials_for_rails_env.

data/credentials_for_rails_env.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Convenient access to credentials[Rails.env][:foo]."
   spec.description   =
     "Fetch the current RAILS_ENV specific credentials from" +
-    " Rails.application.credentials_env.foo just like" +
+    " Rails.application.credentials.env.foo just like" +
     " Rails.application.secrets.foo."
   spec.homepage      = "https://github.com/jgorman/credentials_for_rails_env"
   spec.license       = "MIT"

data/lib/active_support/encrypted_configuration_env.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
-require "yaml"
-require "active_support/encrypted_file"
-require "active_support/ordered_options"
-require "active_support/core_ext/object/inclusion"
-require "active_support/core_ext/module/delegation"
+require "active_support/encrypted_configuration"
+require "erb"
 
 module ActiveSupport
   class EncryptedConfiguration < EncryptedFile
-
     def initialize(config_path:, key_path:, env_key:, raise_if_missing_key:,
                    rails_env: nil)
       super content_path: config_path, key_path: key_path,
@@ -16,20 +12,13 @@ module ActiveSupport
       @rails_env = rails_env
     end
 
-    def write(contents)
-      deserialize(contents)
-      @config = @options = @env = nil # Reinitialize for changed content.
-
-      super
-    end
-
     class RailsEnv < BasicObject
       delegate :[], :fetch, to: :config
       delegate_missing_to :options
 
       def initialize(full_config, rails_env)
         @full_config = full_config || {}
-        @rails_env = rails_env || ''
+        @rails_env = rails_env || ""
       end
 
       def config
@@ -45,5 +34,12 @@ module ActiveSupport
     def env
       @env ||= RailsEnv.new(config, @rails_env)
     end
+
+    private
+
+      def deserialize(config)
+        @config = @options = @env = nil # Reinitialize for changed content.
+        config.present? ? YAML.load(ERB.new(config).result, content_path) : {}
+      end
   end
 end

data/lib/credentials_for_rails_env.rb

@@ -1,7 +1,5 @@
-# Rails.application.credentials.env fetches Rails.env slice of the credentials.
+# frozen_string_literal: true
 
 require "credentials_for_rails_env/version"
-require "active_support/encrypted_configuration"
 require "active_support/encrypted_configuration_env"
-require "rails/application"
 require "rails/application_encrypted"

data/lib/credentials_for_rails_env/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CredentialsForRailsEnv
-  VERSION = "1.0.1"
+  VERSION = "2.0"
 end

data/lib/rails/application_encrypted.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require "rails/application"
 
 module Rails
   class Application < Engine

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: credentials_for_rails_env
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: '2.0'
 platform: ruby
 authors:
 - John Gorman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-14 00:00:00.000000000 Z
+date: 2018-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Fetch the current RAILS_ENV specific credentials from Rails.application.credentials_env.foo
+description: Fetch the current RAILS_ENV specific credentials from Rails.application.credentials.env.foo
   just like Rails.application.secrets.foo.
 email:
 - johngorman2@gmail.com
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - Gemfile.lock