envied 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0511e3b0eba9370a6b0bd51ef3a3642bbfafa30f12b92a5a007b5ce2293b3c14
-  data.tar.gz: 62100f8640f1b5fc14ac46e8d5a916cf5ba2d3c3f7b14c99a246d06e3482a551
+  metadata.gz: 4c89d26111e6602a893f100be175cf566d663f8b03cb3ca6c611ba45946dd8b3
+  data.tar.gz: ac3a0f53199ff5410a015ea54567c7f634e07f89e47fe24627a61a80fda6d94e
 SHA512:
-  metadata.gz: f92d02db070a5bc4f600ccc360c5d41af97c4766e537d3d29880944b45a7e8d7357d5bf01ea16d9167c1cab44398e14db2e4d7691de9c6e622f6035a322d27dc
-  data.tar.gz: 2ccb1f56a3a626d1177a9a27829e718c344ada5293dd12dd4577d384efd030219adfed807f7f9615f456307c89a7f6f8fe308ea70f2e5d720c6500864b643b8e
+  metadata.gz: d2fa4e30dfcf94c8ba245dee67df569e7e413200e5cda7ab37f12c4031cb8a1e7cd889f56cab79198fd0648c0143d658a3a394345c721596495f1c3b0689aefb
+  data.tar.gz: f467aa666631da78d11758304adaec9eb170489ae2d8845319e9ddf4b5d04af9f41e70f37e4bd48f3918955038214ec386735b27fa8b95a3e9e18dc32bb6fbd6

data/README.md

@@ -8,7 +8,6 @@ For the rationale behind this project, see this [blogpost](http://www.gertgoet.c
 
 * check for presence and correctness of ENV-variables
 * access to typed ENV-variables (integers, booleans etc. instead of just strings)
-* check the presence and correctness of a Heroku config
 
 ## Contents
 
@@ -19,8 +18,6 @@ For the rationale behind this project, see this [blogpost](http://www.gertgoet.c
   * [Groups](#groups)
   * [Defaults](#defaults)
   * [More examples](#more-examples)
-* [Command-line interface](#command-line-interface)
-* [How do I...?](#how-do-i)
 * [Development](#development)
 
 ## Quickstart
@@ -183,58 +180,6 @@ As a rule of thumb you should only use defaults:
 * See the [examples](/examples)-folder for a more extensive Envfile
 * See [the Envfile](https://github.com/eval/bunny_drain/blob/c54d7d977afb5e23a92da7a2fd0d39f6a7e29bf1/Envfile) for the bunny_drain application
 
-## Command-line interface
-
-For help on a specific command, use `envied help <command>`.
-
-```bash
-$ envied help
-Commands:
-  envied check                   # Checks whether you environment contains required variables
-  envied check:heroku            # Checks whether a Heroku config contains required variables
-  envied check:heroku:binstub    # Generates a shell script for the check:heroku-task
-  envied extract                 # Grep code to find ENV-variables
-  envied help [COMMAND]          # Describe available commands or one specific command
-  envied init                    # Generates a default Envfile in the current working directory
-  envied init:rails              # Generate all files needed for a Rails project
-  envied version, --version, -v  # Shows version number
-```
-
-## How do I
-
-### ...find all ENV-variables my app is currently using?
-
-```
-$ bundle exec envied extract
-```
-
-This comes in handy when you're not using ENVied yet. It will find all `ENV['KEY']` and `ENV.fetch('KEY')` statements in your project.
-
-It assumes a standard project layout (see the default value for the globs-option).
-
-### ...check the config of a Heroku app?
-
-The easiest/quickest is to run:
-
-```
-$ heroku config --json | bundle exec envied check:heroku
-```
-
-This is equivalent to having the heroku config as your local environment and running `envied check:heroku --groups default production`.
-
-You want to run this right before a deploy to Heroku. This prevents that your app will crash during bootup because ENV-variables are missing from heroku config.
-
-You can turn the above into a handy binstub like so:
-```
-$ bundle exec envied check:heroku:binstub
-# created bin/heroku-env-check
-```
-
-This way you can do stuff like:
-```
-$ ./bin/heroku-env-check && git push live master
-```
-
 ## Development
 
 - `bin/setup`

data/lib/envied/version.rb

@@ -1,3 +1,3 @@
 class ENVied
-  VERSION = '0.10.0'
+  VERSION = '1.0.0'
 end

data/lib/envied.rb

@@ -1,5 +1,4 @@
 require 'envied/version'
-require 'envied/cli'
 require 'envied/env_proxy'
 require 'envied/coercer'
 require 'envied/coercer/envied_string'
@@ -62,7 +61,7 @@ class ENVied
     if defined?(ActiveSupport::Deprecation.warn) && !required?
       ActiveSupport::Deprecation.warn(<<~MSG)
         It's no longer recommended to `ENVied.require` within ENVied.springify's
-        block. Please re-run `envied init:rails` to upgrade.
+        block.
       MSG
     end
     if spring_enabled?

metadata

@@ -1,61 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gert Goet
 - Javier Julio
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.15'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.15'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+date: 2024-08-17 00:00:00.000000000 Z
+dependencies: []
 description: Ensure presence and type of your app's ENV-variables.
 email:
 - gert@thinkcreate.nl
 - jjfutbol@gmail.com
-executables:
-- envied
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
-- exe/envied
 - lib/envied.rb
-- lib/envied/cli.rb
 - lib/envied/coercer.rb
 - lib/envied/coercer/envied_string.rb
 - lib/envied/configuration.rb
 - lib/envied/env_proxy.rb
-- lib/envied/env_var_extractor.rb
 - lib/envied/variable.rb
 - lib/envied/version.rb
 homepage: https://github.com/javierjulio/envied
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/javierjulio/envied
+  source_code_uri: https://github.com/javierjulio/envied.git
+  bug_tracker_uri: https://github.com/javierjulio/envied/issues
+  changelog_uri: https://github.com/javierjulio/envied/blob/master/CHANGELOG.md
+  wiki_uri: https://github.com/javierjulio/envied/wiki
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/exe/envied

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'envied'
-
-ENVied::Cli.start

data/lib/envied/cli.rb

@@ -1,130 +0,0 @@
-require 'thor'
-require 'json'
-require 'envied/env_var_extractor'
-
-class ENVied
-  class Cli < Thor
-    include Thor::Actions
-    source_root File.expand_path('../templates', __FILE__)
-
-    desc "version, --version, -v", "Shows version number"
-    def version
-      puts ENVied::VERSION
-    end
-    map %w(-v --version) => :version
-
-    desc "extract", "Grep code to find ENV-variables"
-    long_desc <<-LONG
-      Greps source-files to find all ENV-variables your code is using.
-
-      This task helps you find variables to put in your Envfile.
-
-      By default the test/spec-folders are excluded. Use `--tests` to include them.
-    LONG
-    option :globs, type: :array, default: ENVied::EnvVarExtractor.defaults[:globs], banner: "*.* lib/*"
-    option :tests, type: :boolean, default: false, desc: "include tests/specs"
-    def extract
-      globs = options[:globs]
-      globs << "{test,spec}/*" if options[:tests]
-      var_occurrences = ENVied::EnvVarExtractor.new(globs: globs).extract
-
-      puts "Found %d occurrences of %d variables:" % [var_occurrences.values.flatten.size, var_occurrences.size]
-      var_occurrences.sort.each do |var, occs|
-        puts var
-        occs.sort_by{|i| i[:path].size }.each do |occ|
-          puts "* %s:%s" % occ.values_at(:path, :line)
-        end
-        puts
-      end
-    end
-
-    desc "init", "Generates a default Envfile in the current working directory"
-    def init
-      puts "Writing Envfile to #{File.expand_path('Envfile')}"
-      template("Envfile.tt")
-
-      puts "Add the following snippet (or similar) to your app's initialization:"
-      puts "ENVied.require(*ENV['ENVIED_GROUPS'] || [:default, ENV['RACK_ENV']])"
-    end
-
-    desc "init:rails", "Generate all files needed for a Rails project"
-    define_method "init:rails" do
-      puts "Writing Envfile to #{File.expand_path('Envfile')}"
-      template("Envfile.tt")
-      inject_into_file "config/application.rb", "\nENVied.require(*ENV['ENVIED_GROUPS'] || Rails.groups)", after: /^ *Bundler.require.+$/
-      legacy_initializer = Dir['config/initializers/*envied*.rb'].first
-      if legacy_initializer && File.exists?(legacy_initializer)
-        puts "Removing 'ENVied.require' from #{legacy_initializer.inspect}."
-        puts "(you might want to remove the whole file)"
-        comment_lines legacy_initializer, /ENVied.require/
-      end
-    end
-
-    desc "check", "Checks whether you environment contains required variables"
-    long_desc <<-LONG
-      Checks whether required variables are present and valid in your shell.
-
-      On success the process will exit with status 0.
-      Else the missing/invalid variables will be shown, and the process will exit with status 1.
-    LONG
-    option :groups, type: :array, desc: "uses ENV['ENVIED_GROUPS'] as default if present", default: ENV['ENVIED_GROUPS'] || %w(default), banner: 'default production'
-    option :quiet, type: :boolean, desc: 'Communicate success of the check only via the exit status.'
-    def check
-      ENVied.require(*options[:groups])
-      unless options[:quiet]
-        puts "All variables for group(s) #{options[:groups]} are present and valid"
-      end
-    end
-
-    desc "check:heroku", "Checks whether a Heroku config contains required variables"
-    long_desc <<-LONG
-      Checks the config of your Heroku app against the local Envfile.
-
-      The Heroku config should be piped to this task:
-
-      heroku config --json | bundle exec envied check:heroku
-
-      Use the check:heroku:binstub-task to turn this into a bash-script.
-
-      On success the process will exit with status 0.
-      Else the missing/invalid variables will be shown, and the process will exit with status 1.
-    LONG
-    option :groups, type: :array, default: %w(default production), banner: 'default production'
-    option :quiet, type: :boolean, desc: 'Communicate success of the check only via the exit status.'
-    define_method "check:heroku" do
-      if STDIN.tty?
-        error "Please pipe to this task i.e. `heroku config --json | bundle exec envied check:heroku`"
-        exit 1
-      end
-      heroku_env = JSON.parse(STDIN.read)
-      ENV.replace(heroku_env)
-
-      requested_groups = ENV['ENVIED_GROUPS'] || options[:groups]
-      ENVied.require(*requested_groups)
-      unless options[:quiet]
-        puts "All variables for group(s) #{requested_groups} are present and valid in your Heroku app"
-      end
-    end
-
-    desc "check:heroku:binstub", "Generates a shell script for the check:heroku-task"
-    long_desc <<-LONG
-      Generates a shell script to check the Heroku config against the local Envfile.
-
-      The same as the check:heroku-task, but all in one script (no need to pipe `heroku config --json` to it etc.).
-    LONG
-    option :dest, banner: "where to put the script", desc: "Default: bin/<app>-env-check or bin/heroku-env-check"
-    option :app, banner: "name of Heroku app", desc: "uses ENV['HEROKU_APP'] as default if present", default: ENV['HEROKU_APP']
-    option :groups, type: :array, default: %w(default production), banner: 'default production'
-    define_method "check:heroku:binstub" do
-      require 'fileutils'
-      @app = options[:app]
-      @dest = options[:dest]
-      @dest ||= File.join(*%W(bin #{(@app || 'heroku')}-env-check))
-      @groups = options[:groups]
-
-      full_dest = File.expand_path(@dest)
-      template("heroku-env-check.tt", full_dest)
-      FileUtils.chmod 0755, full_dest
-    end
-  end
-end

data/lib/envied/env_var_extractor.rb

@@ -1,76 +0,0 @@
-class ENVied
-  class EnvVarExtractor
-    def self.defaults
-      @defaults ||= begin
-        {
-          extensions: %w(ru thor rake rb yml ruby yaml erb builder markerb haml),
-          globs: %w(*.* Thorfile Rakefile {app,config,db,lib,script}/*)
-        }
-      end
-    end
-
-    def defaults
-      self.class.defaults
-    end
-
-    attr_reader :globs, :extensions
-
-    def initialize(**options)
-      @globs = options.fetch(:globs, self.defaults[:globs])
-      @extensions = options.fetch(:extensions, self.defaults[:extensions])
-    end
-
-    def self.extract_from(globs, **options)
-      new(options.merge(globs: Array(globs))).extract
-    end
-
-    # Greps all ENV-variables from a line of text.
-    # Captures 'A' in lines like `ENV['A']`, but also `ENV.fetch('A')`.
-    #
-    # @param line [String] the line to grep
-    #
-    # @example
-    #   extractor.new.capture_variables("config.force_ssl = ENV['FORCE_SSL']")
-    #   # => ["FORCE_SSL"]
-    #
-    # @return [Array<String>] the names o
-    def capture_variables(line)
-      line.scan(/ENV(?:\[|\.fetch\()['"]([^'"]+)['"]/).flatten
-    end
-
-    # Extract all keys recursively from files found via `globs`.
-    # Any occurrence of `ENV['A']` or `ENV.fetch('A')`, will result
-    # in 'A' being extracted.
-    #
-    # @param globs [Array<String>] the collection of globs
-    #
-    # @example
-    #   EnvVarExtractor.new.extract(*%w(app lib))
-    #   # => {'A' => [{:path => 'app/models/user.rb', :line => 2}, {:path => ..., :line => ...}],
-    #         'B' => [{:path => 'config/application.rb', :line => 12}]}
-    #
-    # @return [<Hash{String => Array<String => Array>}>] the list of items.
-    def extract(globs = self.globs)
-      results = Hash.new { |hash, key| hash[key] = [] }
-
-      Array(globs).each do |glob|
-        Dir.glob(glob).each do |item|
-          next if File.basename(item)[0] == ?.
-
-          if File.directory?(item)
-            results.merge!(extract("#{item}/*"))
-          else
-            next unless extensions.detect {|ext| File.extname(item)[ext] }
-            File.readlines(item).each_with_index do |line, ix|
-              capture_variables(line).each do |variable|
-                results[variable] << { :path => item, :line => ix.succ }
-              end
-            end
-          end
-        end
-      end
-
-      results
-    end
-  end
-end