envied 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 501198780ddc5bf4762c604f90938baad9258ee4
-  data.tar.gz: 3027a30c7815e8925246e7f14d3e7ffcc7a3bfef
+  metadata.gz: edcedc4d8c20ce9daebc7a4850197705ea88e0d1
+  data.tar.gz: 76db142dc7ae98934704145a788617b2c62948f0
 SHA512:
-  metadata.gz: 826a2dfaa0ac7730c2fcaa14e14ea997b3c5b665774eed3ed91110e5950a29d982c6eb761e783a7eee4be6b3d1629483b068e5a1971b0d9eccabb9dc329c41c2
-  data.tar.gz: ad53e3a25cb8a9c817eb14fb0a0f0a8d815fd8dd87b54dfdf0653f920dd6e8f963014d2efdb9fd56405b8ec67d40f5df36930752c6d7794bdce41d61df8c2556
+  metadata.gz: cd8ca76d1dda0a489be8b5c97ddf2d4c75a3e10a8eafe9d64a14c00432b40025948f62f782069228b64029494fb8544ea9b9c9e11ac02c96f032feb51132949d
+  data.tar.gz: 3e523db66a464e6b3a236908f5439d38d877aa6cf867ad5754e7555b1e20edb99e2f6f15f3757026c999d8cc7e43b550212a4ea0fa940bb1b9734fc1ea7cfdb7

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# 0.7.2 / 2014-9-7
+
+## Added:
+* extract-task: see all ENV-variables used in your project.
+
+  ```bash
+  $ bin/envied extract
+  Found 63 occurrences of 45 variables:
+  BUNDLE_GEMFILE
+  * config/boot.rb:4
+  * config/boot.rb:6
+  ...
+  ```
+
+* version-task (i.e. bin/envied --version)
+
 # 0.7.1 / 2014-08-29
 
 * Total refactor (TM).

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'pry'
+gem 'benchmark-ips'

data/README.md

@@ -184,9 +184,11 @@ end
 ```bash
 $ envied help
 Commands:
+  envied --version             # Shows version number
   envied check                 # Checks whether you environment contains the defined variables
   envied check:heroku          # Checks whether a Heroku config contains the defined variables
   envied check:heroku:binstub  # Generates a shell script for the check:heroku-task
+  envied extract               # Shows candidate variables (i.e. occurences of ENV['X'])
   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

data/lib/envied.rb

@@ -1,5 +1,6 @@
 require 'envied/version'
 require 'envied/cli'
+require 'envied/env_proxy'
 require 'envied/coercer'
 require 'envied/variable'
 require 'envied/configuration'
@@ -9,14 +10,21 @@ class ENVied
     attr_reader :env, :config
   end
 
-  def self.require(*groups)
-    @config ||= Configuration.load
-    @env ||= EnvProxy.new(@config, groups: required_groups(*groups))
-
+  def self.require(*args)
+    env!(*args)
     error_on_missing_variables!
     error_on_uncoercible_variables!
   end
 
+  def self.env!(*args)
+    @env = begin
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      config = options.fetch(:config) { Configuration.load }
+      groups = required_groups(*args)
+      EnvProxy.new(config, groups: groups)
+    end
+  end
+
   def self.error_on_missing_variables!
     names = env.missing_variables.map(&:name)
     raise "The following environment variables should be set: #{names * ', '}" if names.any?

data/lib/envied/cli.rb

@@ -1,10 +1,32 @@
 require 'thor'
+require 'envied/env_var_extractor'
 
 class ENVied
   class Cli < Thor
     include Thor::Actions
     source_root File.expand_path('../templates', __FILE__)
 
+    desc "--version", "Shows version number"
+    def version
+      puts ENVied::VERSION
+    end
+    map %w(-v --version) => :version
+
+    desc "extract", "Shows candidate variables (i.e. occurences of ENV['X'])"
+    option :globs, type: :array, default: ENVied::EnvVarExtractor.defaults[:globs], banner: "*.* lib/*"
+    def extract
+      var_occurences = ENVied::EnvVarExtractor.new(globs: options[:globs]).extract
+
+      puts "Found %d occurrences of %d variables:" % [var_occurences.values.flatten.size, var_occurences.size]
+      var_occurences.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 new Envfile to #{File.expand_path('Envfile')}"
@@ -17,9 +39,9 @@ class ENVied
       template("rails-initializer.tt", 'config/initializers/envied.rb')
     end
 
-    desc "check", "Checks whether you environment contains the defined variables"
+    desc "check", "Checks whether you environment contains required variables"
     long_desc <<-LONG
-      Checks whether defined variables are present and valid in your shell.
+      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.
@@ -30,7 +52,7 @@ class ENVied
       puts "All variables for group(s) #{options[:groups]} are present and valid"
     end
 
-    desc "check:heroku", "Checks whether a Heroku config contains the defined variables"
+    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.

data/lib/envied/coercer.rb

@@ -38,7 +38,7 @@ class ENVied::Coercer
 
   def self.supported_types
     @supported_types ||= begin
-      [:hash, :array, :time, :date, :symbol, :boolean, :integer, :string]
+      [:hash, :array, :time, :date, :symbol, :boolean, :integer, :string].sort
     end
   end
 
@@ -59,6 +59,10 @@ class ENVied::Coercer
     self.class.supported_type?(type)
   end
 
+  def supported_types
+    self.class.supported_types
+  end
+
   def coercer
     @coercer ||= Coercible::Coercer.new[String]
   end

data/lib/envied/configuration.rb

@@ -1,14 +1,17 @@
 class ENVied
   class Configuration
-    attr_reader :current_group, :defaults_enabled
+    attr_reader :current_group, :defaults_enabled, :coercer
 
-    def initialize(options = {})
+    def initialize(options = {}, &block)
       @defaults_enabled = options.fetch(:enable_defaults, false)
+      @coercer = options.fetch(:coercer, Coercer.new)
+      instance_eval(&block) if block_given?
     end
 
-    def self.load
-      new.tap do |v|
-        v.instance_eval(File.read(File.expand_path('Envfile')))
+    def self.load(options = {})
+      envfile = File.expand_path('Envfile')
+      new(options).tap do |v|
+        v.instance_eval(File.read(envfile), envfile)
       end
     end
 
@@ -23,6 +26,10 @@ class ENVied
     end
 
     def variable(name, type = :String, options = {})
+      unless coercer.supported_type?(type)
+        raise ArgumentError,
+          "Variable type (of #{name}) should be one of #{coercer.supported_types}"
+      end
       options[:group] = current_group if current_group
       variables << ENVied::Variable.new(name, type, options)
     end
@@ -39,71 +46,4 @@ class ENVied
     end
   end
 
-  # Responsible for anything related to the ENV.
-  class EnvProxy
-    attr_reader :config, :coercer, :groups
-
-    def initialize(config, options = {})
-      @config = config
-      @coercer = options.fetch(:coercer, ENVied::Coercer.new)
-      @groups = options.fetch(:groups, [])
-    end
-
-    def missing_variables
-      variables.select(&method(:missing?))
-    end
-
-    def uncoercible_variables
-      variables.reject(&method(:coerced?)).reject(&method(:coercible?))
-    end
-
-    def variables
-      @variables ||= begin
-        config.variables.select {|v| groups.include?(v.group) }
-      end
-    end
-
-    def variables_by_name
-      Hash[variables.map {|v| [v.name, v] }]
-    end
-
-    def [](name)
-      coerce(variables_by_name[name.to_sym])
-    end
-
-    def has_key?(name)
-      variables_by_name[name.to_sym]
-    end
-
-    def env_value_of(var)
-      ENV[var.name.to_s]
-    end
-
-    def default_value_of(var)
-      var.default_value(ENVied, var)
-    end
-
-    def value_to_coerce(var)
-      return env_value_of(var) unless env_value_of(var).nil?
-      config.defaults_enabled? ? default_value_of(var) : nil
-    end
-
-    def coerce(var)
-      coerced?(var) ?
-        value_to_coerce(var) :
-        coercer.coerce(value_to_coerce(var), var.type)
-    end
-
-    def coercible?(var)
-      coercer.coercible?(value_to_coerce(var), var.type)
-    end
-
-    def missing?(var)
-      value_to_coerce(var).nil?
-    end
-
-    def coerced?(var)
-      coercer.coerced?(value_to_coerce(var))
-    end
-  end
 end

data/lib/envied/env_proxy.rb

@@ -0,0 +1,69 @@
+class ENVied
+  # Responsible for anything related to the ENV.
+  class EnvProxy
+    attr_reader :config, :coercer, :groups
+
+    def initialize(config, options = {})
+      @config = config
+      @coercer = options.fetch(:coercer, ENVied::Coercer.new)
+      @groups = options.fetch(:groups, [])
+    end
+
+    def missing_variables
+      variables.select(&method(:missing?))
+    end
+
+    def uncoercible_variables
+      variables.reject(&method(:coerced?)).reject(&method(:coercible?))
+    end
+
+    def variables
+      @variables ||= begin
+        config.variables.select {|v| groups.include?(v.group) }
+      end
+    end
+
+    def variables_by_name
+      Hash[variables.map {|v| [v.name, v] }]
+    end
+
+    def [](name)
+      coerce(variables_by_name[name.to_sym])
+    end
+
+    def has_key?(name)
+      variables_by_name[name.to_sym]
+    end
+
+    def env_value_of(var)
+      ENV[var.name.to_s]
+    end
+
+    def default_value_of(var)
+      var.default_value(ENVied, var)
+    end
+
+    def value_to_coerce(var)
+      return env_value_of(var) unless env_value_of(var).nil?
+      config.defaults_enabled? ? default_value_of(var) : nil
+    end
+
+    def coerce(var)
+      coerced?(var) ?
+        value_to_coerce(var) :
+        coercer.coerce(value_to_coerce(var), var.type)
+    end
+
+    def coercible?(var)
+      coercer.coercible?(value_to_coerce(var), var.type)
+    end
+
+    def missing?(var)
+      value_to_coerce(var).nil?
+    end
+
+    def coerced?(var)
+      coercer.coerced?(value_to_coerce(var))
+    end
+  end
+end

data/lib/envied/env_var_extractor.rb

@@ -0,0 +1,76 @@
+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,test,spec}/*)
+        }
+      end
+    end
+
+    def defaults
+      self.class.defaults
+    end
+
+    def self.env_var_re
+      @env_var_re ||= begin
+        /^[^\#]*           # not matching comments
+          ENV
+          (?:              # non-capture...
+            \[['"] |       # either ENV['
+            \.fetch\(['"]  # or ENV.fetch('
+          )
+          ([a-zA-Z_]+)     # capture variable name
+        /x
+      end
+    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
+
+
+    # Extract all keys recursively from files found via `globs`.
+    # Any occurence of `ENV['A']` or `ENV.fetch('A')` in code (not in comments), 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, :encoding=>"UTF-8").each_with_index do |line, ix|
+              if variable = line[self.class.env_var_re, 1]
+                results[variable] << { :path => item, :line => ix.succ }
+              end
+            end
+          end
+        end
+      end
+
+      results
+    end
+  end
+end

data/lib/envied/version.rb

@@ -1,3 +1,3 @@
 class ENVied
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/spec/envied_spec.rb

@@ -16,7 +16,7 @@ describe ENVied do
   end
 
   def reset_configuration
-    ENVied.instance_eval { @config = nil }
+    @config = ENVied::Configuration.new
   end
 
   def reset_env
@@ -30,20 +30,21 @@ describe ENVied do
       self
     end
 
+    def config
+      @config
+    end
+
     def configure(options = {}, &block)
-      ENVied.instance_eval do
-        @config = ENVied::Configuration.new(options).tap{|c| c.instance_eval(&block)}
-      end
+      @config = ENVied::Configuration.new(options, &block)
       self
     end
 
     def configured_with(hash = {})
-      config = ENVied::Configuration.new.tap do |c|
+      @config = ENVied::Configuration.new.tap do |c|
         hash.each do |name, type|
           c.variable(name, *type)
         end
       end
-      ENVied.instance_eval{ @config = config }
       self
     end
 
@@ -56,16 +57,23 @@ describe ENVied do
       and_ENV
     end
 
+    def envied_require(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:config] = options[:config] || config
+
+      ENVied.require(*args, options)
+    end
+
     it 'responds to configured variables' do
       configured_with(a: :Integer).and_ENV({'a' => '1'})
-      described_class.require
+      envied_require
 
       expect(described_class).to respond_to :a
     end
 
     it 'responds not to unconfigured variables' do
       unconfigured.and_ENV({'A' => '1'})
-      described_class.require
+      envied_require
 
       expect(described_class).to_not respond_to :B
     end
@@ -75,7 +83,7 @@ describe ENVied do
 
       specify do
         expect {
-          ENVied.require
+          envied_require
         }.to raise_error(/The following environment variables should be set: a/)
       end
     end
@@ -85,11 +93,19 @@ describe ENVied do
 
       specify do
         expect {
-          ENVied.require
+          envied_require
         }.to raise_error(/A \('NaN' can't be coerced to Integer/)
       end
     end
 
+    context 'configuring' do
+      it 'raises error when configuring variable of unknown type' do
+        expect {
+          configured_with(A: :Fixnum)
+        }.to raise_error
+      end
+    end
+
     context 'bug: default value "false" is not coercible' do
       before {
         configure(enable_defaults: true) do
@@ -99,19 +115,18 @@ describe ENVied do
 
       specify do
         expect {
-          ENVied.require
+          envied_require
         }.not_to raise_error
       end
     end
 
     describe 'defaults' do
       describe 'setting' do
-        subject { described_class.config }
-        #subject { ENVied::Configuration.new }
+        subject { config }
 
-        #it 'is disabled by default' do
-        #  expect(subject.defaults_enabled?).to_not be
-        #end
+        it 'is disabled by default' do
+          expect(subject.defaults_enabled?).to_not be
+        end
 
         it 'can be enabled via #configure' do
           configure(enable_defaults: true){ }
@@ -137,7 +152,7 @@ describe ENVied do
           configure(enable_defaults: true) do
             variable :A, :Integer, default: '1'
           end
-          described_class.require
+          envied_require
 
           expect(described_class.A).to eq 1
         end
@@ -146,7 +161,7 @@ describe ENVied do
           configure(enable_defaults: true) do
             variable :A, :Integer, default: proc { "1" }
           end
-          described_class.require
+          envied_require
 
           expect(described_class.A).to eq 1
         end
@@ -157,7 +172,7 @@ describe ENVied do
           end.and_no_ENV
 
           expect {
-            described_class.require
+            envied_require
           }.to raise_error
         end
 
@@ -165,7 +180,7 @@ describe ENVied do
           configure(enable_defaults: true) do
             variable :A, :Integer, default: "1"
           end.and_ENV('A' => '2')
-          described_class.require
+          envied_require
 
           expect(described_class.A).to eq 2
         end
@@ -175,7 +190,7 @@ describe ENVied do
             variable :A, :Integer
             variable :B, :Integer, default: proc {|env| env.A * 2 }
           end.and_ENV('A' => '1')
-          described_class.require
+          envied_require
 
           expect(described_class.B).to eq 2
         end
@@ -196,19 +211,19 @@ describe ENVied do
 
         it 'is required when requiring the group' do
           expect {
-            described_class.require(:foo)
+            envied_require(:foo)
           }.to raise_error(/bar/)
         end
 
         it 'is not required when requiring another group' do
           expect {
-            described_class.require(:bat)
+            envied_require(:bat)
           }.to_not raise_error
         end
 
         it 'wont define non-required variables on ENVied' do
           stub_const("ENV", {'moar' => 'yes'})
-          described_class.require(:default)
+          envied_require(:default)
 
           expect {
             described_class.bar
@@ -218,7 +233,7 @@ describe ENVied do
         it 'requires variables without a group when requiring the default group' do
           [:default, 'default'].each do |groups|
             expect {
-              described_class.require(*groups)
+              envied_require(*groups)
             }.to raise_error(/moar/)
           end
         end
@@ -230,7 +245,7 @@ describe ENVied do
             variable :foo, :Hash
             variable :bar, :Hash
           end.and_ENV('foo' => 'a=1&b=&c', 'bar' => '')
-          ENVied.require
+          envied_require
         end
 
         it 'yields hash from string' do
@@ -251,7 +266,7 @@ describe ENVied do
           it 'has no default by default' do
             # fixes a bug where variables of type :Hash had a default even
             # when none was configured.
-            expect { ENVied.require(:default) }.to raise_error
+            expect { envied_require }.to raise_error
           end
         end
       end
@@ -261,7 +276,7 @@ describe ENVied do
           configure do
             variable :moar, :Array
           end.and_ENV('moar' => 'a, b, and\, c')
-          ENVied.require
+          envied_require
         end
 
         it 'yields array from string' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envied
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Gert Goet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-28 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coercible
@@ -117,6 +117,8 @@ files:
 - lib/envied/cli.rb
 - lib/envied/coercer.rb
 - lib/envied/configuration.rb
+- lib/envied/env_proxy.rb
+- lib/envied/env_var_extractor.rb
 - lib/envied/templates/Envfile.tt
 - lib/envied/templates/heroku-env-check.tt
 - lib/envied/templates/rails-initializer.tt