starenv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d259f537e28341d2ba00408a875e0267b7874cca
+  data.tar.gz: 8e1a771716fb1535fd133e01f26202a0d92f796d
+SHA512:
+  metadata.gz: 5e546387c1e7ac165fa2c6bc91509f8b8b27b30655553b22e82a65e90872b104b7ac0234ffa2df94cf4ea64b0c99333aa0a792afc4bfb9683f0b1537d1060bb8
+  data.tar.gz: 487ef54e34937b2671cff7c9f21feba0307bcbc371787f6ee80e5de782db4202becf7db029d706faf1365510759550f6c694c8cfedb092bd6221d539a9da3c92

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+envs/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in starenv.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,25 @@
+> **Copyright (c) 2015 Chris Keele**
+
+MIT License
+-----------
+
+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,31 @@
+Starenv
+=======
+
+> **Load and manage suites of environment variables.**
+
+
+
+Synopsis
+--------
+
+One of the tenants of building [12-factor apps](http://12factor.net/) is loading your [configuration from the environment](http://12factor.net/config).
+
+However, developing complicated applications, entirely configured from the environment, comes with some pitfalls:
+
+1. *Environment variables aren't easy to manage*
+
+1. *Environment variables aren't easy to reproduce*
+
+1. *Environment variables aren't easy to reason about*
+
+1. *Environment variables aren't easy to tweak*
+
+Starenv was created to alleviate these problems.
+
+1. *Starenv supports multiple, project-defined env files.*
+
+1. *Starenv allows declaring dependencies files.*
+
+1. *Starenv allows conditionally and contextually loading files.*
+
+1. *Starenv comes with rake tasks for managing and documenting environment variables.*

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+
+desc 'Open a pry console preloaded with this library'
+task console: 'console:pry'
+
+namespace :console do
+
+  task :pry do
+    sh 'bundle exec pry -I lib -r starenv.rb'
+  end
+
+  task :irb do
+    sh 'bundle exec irb -I lib -r starenv.rb'
+  end
+
+end
+
+require_relative 'lib/starenv/tasks'

data/bin/rake

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+
+load Gem.bin_path('rake', 'rake')
+
+require 'rake'
+Rake.application.run

data/lib/starenv/env_file.rb

@@ -0,0 +1,85 @@
+require 'starenv/results'
+
+class EnvFile < Struct.new(:name, :dependencies, :pattern, :hook)
+
+  def load
+    (hook || default_hook).call self do
+      Dotenv.load(filename).tap do |results|
+        puts info results
+      end
+    end
+  end
+
+  def filename
+    format pattern, name
+  end
+
+  alias_method :to_s, :filename
+
+  def info(results)
+    longest = results.keys.group_by(&:size).max
+    length = longest.nil? ? 0 : longest.first
+    applied, ignored = results.partition do |key, value|
+      ENV[key] == value
+    end
+    [
+      Results.for(:applied).new(self, applied, length),
+      Results.for(:ignored).new(self, ignored, length),
+    ].map(&:to_s).compact.push("\n").join("\n")
+  end
+
+private
+
+  @@default_hook = -> file, &loader { loader.call }
+
+  def default_hook
+    @@default_hook
+  end
+
+  module Utils
+
+    def without_leading_comments(file)
+      file.each_line.drop_while do |line|
+        comment? line
+      end
+    end
+
+    def comment?(line)
+      line.start_with? '#'
+    end
+
+    def variable(line)
+      line.match(/^\s*?(?<name>\b.*\b)=(?<value>\b\S*\b)?\s*?$/)
+    end
+
+  end
+
+  class Template < self
+
+    include Utils
+
+    attr_reader :content
+
+    def initialize(name, pattern =  Starenv.pattern, content = [])
+      @content = content
+      super name, [], pattern, nil
+    end
+
+    def parse
+      File.open(filename) do |lines|
+        yield without_leading_comments lines
+      end
+    end
+
+    def write
+      File.open(filename, 'w') do |file|
+        content.each do |line|
+          line = yield line
+          file.puts line if line
+        end
+      end
+    end
+
+  end
+
+end

data/lib/starenv/environment.rb

@@ -0,0 +1,50 @@
+require 'delegate'
+
+module Starenv
+  class Environment
+
+    attr_reader :variables, :applied, :ignored
+
+    def initialize(source = nil)
+      @source = source ? source : ENV
+      @variables, @applied, @ignored = {}
+    end
+
+    def [] key
+      @source[key].tap do |value|
+        @variables[key] ||= Variable.new(key, value) if value
+      end
+    end
+
+    def []= key, value
+      @source.store(key, value.to_s).tap do |value|
+        @variables[key] = Variable.new(key, value)
+      end
+    end
+
+    def apply(hash)
+      self.tap do |env|
+        hash.each do |key, value|
+          self[key] ||= value
+        end
+      end
+    end
+
+    def respond_to_missing?(method)
+      @source.respond_to?(method) or super
+    end
+
+    def method_missing(method, *args)
+      if @source.respond_to? method
+        if block_given?
+          @source.send method, *args, &Proc.new
+        else
+          @source.send method, *args
+        end
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/starenv/file/node.rb

@@ -0,0 +1,35 @@
+require 'starenv/file'
+
+module Starenv
+  class File < ::File
+    class Node < Struct.new(:name, :dependencies, :hook)
+
+      attr_reader :environment
+
+      def initialize(name, dependencies = [], hook = nil)
+        super name, dependencies, hook
+      end
+
+      def load
+        tap do
+          unless loaded?
+            (hook || default_hook).call self do
+              File.parse(name).environment
+            end
+          end
+        end
+      end
+
+      def loaded?
+        !!file
+      end
+
+    private
+
+      def default_hook
+        @@default_hook ||= -> file, &loader { loader.call }
+      end
+
+    end
+  end
+end

data/lib/starenv/file/parser.rb

@@ -0,0 +1,29 @@
+require 'starenv/environment'
+require 'starenv/variable'
+
+module Starenv
+  class File < ::File
+    class Parser
+
+      attr_accessor :lines
+
+      def initialize(lines)
+        @lines = lines
+      end
+
+      def call
+        Environment.new(
+          Hash[
+            lines.map(&:strip).select do |line|
+              line =~ Variable.line
+            end.compact.map do |line|
+              variable = Variable.from line
+              [ variable.name, variable ]
+            end
+          ]
+        )
+      end
+
+    end
+  end
+end

data/lib/starenv/file/set.rb

@@ -0,0 +1,23 @@
+require 'tsort'
+
+require 'starenv/file/node'
+
+module Starenv
+  class File < ::File
+    class Set < Hash
+
+      include TSort
+
+      alias_method :tsort_each_node, :each_key
+
+      def tsort_each_child(node)
+        fetch(node).dependencies.each(&Proc.new)
+      end
+
+      def add(name, dependencies, hook)
+        store name, Node.new(name, Array(dependencies).flatten, hook)
+      end
+
+    end
+  end
+end

data/lib/starenv/file/template.rb

@@ -0,0 +1,34 @@
+module Starenv
+  class File < ::File
+    class Template < self
+
+      def initialize(name, mode = 'r+', *args)
+        super name, mode, *args
+      end
+
+      attr_reader :files
+
+      def header
+        %r{^#\sfile:\s(\w+).*?$}mi
+      end
+
+      def parse
+        tap do
+          unless parsed?
+            require 'pry'; binding.pry
+            @files = Hash[
+              read.split(header).drop(1).each_slice(2).map do |key, value|
+                [ key.to_sym, Parser.new(value.strip.lines).call ]
+              end
+            ]
+          end
+        end
+      end
+
+      def parsed?
+        !!files
+      end
+
+    end
+  end
+end

data/lib/starenv/file.rb

@@ -0,0 +1,133 @@
+require 'fileutils'
+require 'pathname'
+
+require 'starenv/file/parser'
+
+module Starenv
+  class File < ::File
+
+    class << self
+
+      def parse(name, *args)
+        open name, *args, &:parse
+      end
+
+      def touch(name, *args)
+        new(name, *args).touch(*args)
+      end
+
+    end
+
+    attr_reader :name, :filename, :environment
+
+    def initialize(name, mode = 'r', *args)
+      @name = name
+      @filename = Pathname.new Starenv.format @name
+      super @filename, mode, *args
+    end
+
+    def parse
+      tap do |file|
+        unless parsed?
+          @environment = Parser.new(each_line).call
+        end
+      end
+    end
+
+    def parsed?
+      !!environment
+    end
+
+    def touch(*args)
+      tap do |file|
+        FileUtils.mkpath file.filename.dirname, *args
+        FileUtils.touch  file.filename,         *args
+      end
+    end
+
+  end
+end
+
+# class EnvFile < Struct.new(:name, :dependencies, :pattern, :hook)
+#
+#   def load
+#     (hook || default_hook).call self do
+#       Dotenv.load(filename).tap do |results|
+#         puts info results
+#       end
+#     end
+#   end
+#
+#   def filename
+#     format pattern, name
+#   end
+#
+#   alias_method :to_s, :filename
+#
+#   def info(results)
+#     longest = results.keys.group_by(&:size).max
+#     length = longest.nil? ? 0 : longest.first
+#     applied, ignored = results.partition do |key, value|
+#       ENV[key] == value
+#     end
+#     [
+#       Results.for(:applied).new(self, applied, length),
+#       Results.for(:ignored).new(self, ignored, length),
+#     ].map(&:to_s).compact.push("\n").join("\n")
+#   end
+#
+# private
+#
+#   @@default_hook = -> file, &loader { loader.call }
+#
+#   def default_hook
+#     @@default_hook
+#   end
+#
+#   module Utils
+#
+#     def without_leading_comments(file)
+#       file.each_line.drop_while do |line|
+#         comment? line
+#       end
+#     end
+#
+#     def comment?(line)
+#       line.start_with? '#'
+#     end
+#
+#     def variable(line)
+#       line.match(/^\s*?(?<name>\b.*\b)=(?<value>\b\S*\b)?\s*?$/)
+#     end
+#
+#   end
+#
+#   class Template < self
+#
+#     include Utils
+#
+#     attr_reader :content
+#
+#     def initialize(name, pattern =  Starenv.pattern, content = [])
+#       @content = content
+#       super name, [], pattern, nil
+#     end
+#
+#     def parse
+#       File.open(filename) do |lines|
+#         yield without_leading_comments lines
+#       end
+#     end
+#
+#     def write
+#       File.open(filename, 'w') do |file|
+#         content.each do |line|
+#           line = yield line
+#           file.puts line if line
+#         end
+#       end
+#     end
+#
+#   end
+#
+# end

data/lib/starenv/results.rb

@@ -0,0 +1,49 @@
+class Results < Struct.new(:file, :variables, :name_length)
+
+  class << self
+    def for(type)
+      const_get type.to_s.capitalize
+    end
+  end
+
+  def display
+    formatted(variables).unshift(header).join("\n") unless variables.empty?
+  end
+
+  def to_s
+    display or ''
+  end
+
+private
+
+  def formatted(variables)
+    variables.map do |name, value|
+      format_variable name, value
+    end
+  end
+
+  class Applied < self
+
+    def header
+      "Applied variables from #{file}:"
+    end
+
+    def format_variable(name, value)
+      format "  %-#{name_length}s => %s", name, value
+    end
+
+  end
+
+  class Ignored < self
+
+    def header
+      'Ignored already set variables:'
+    end
+
+    def format_variable(name, value)
+      format "  %-#{name_length}s => %s\n   %-#{length-1}s => %s", name, value, 'already', ENV[name]
+    end
+
+  end
+
+end

data/lib/starenv/tasks.rb

@@ -0,0 +1,112 @@
+require 'rake' unless defined? Rake
+
+require 'highline'
+
+require 'starenv'
+require 'starenv/file/template'
+
+module Starenv
+  module Tasks
+
+    extend self
+    extend Rake::DSL
+
+    task starenv: 'starenv:load'
+
+    namespace :starenv do
+
+      task :require do
+        require 'starenv'
+      end
+
+      task load: :require do
+        Starenv.load
+      end
+
+      task dry_run: :require do
+        Starenv.load Hash.new
+      end
+
+    end
+
+    namespace :envs do
+
+      desc "Creates starenv files according to template file."
+      task :init, %i[template] => %i[starenv] do |t, args|
+        init_from args.with_defaults(template: :example)
+      end
+      #
+      # desc "Adds a new environment variable to starenv."
+      # task new: :starenv, %i[name value file] do |t, args|
+      #   new_variable args.with_defaults(file: Starenv.files.tsort.last)
+      # end
+      #
+      # desc "Sets a starenv variable."
+      # task set: :starenv, %i[name value file] do |t, args|
+      #   set_variable args.with_defaults(file: Starenv.files.tsort.first)
+      # end
+      #
+      # desc "Shows the value of a starenv variable."
+      # task get: :starenv, %i[name file] do |t, args|
+      #   get_variable args.with_defaults(file: Starenv.files.tsort.first)
+      # end
+
+    end
+
+    def init_from(template: :example, noop: false, verbose: true)
+      File::Template.touch(template, noop: noop, verbose: verbose).parse.files.each do |file, env|
+        require 'pry'; binding.pry
+      end
+    end
+
+    # def init_from(template: :example, pattern: Starenv.pattern)
+    #   EnvFile::Template.new(file, pattern).parse do |lines|
+    #     chunk_into_files(lines).each do |file, lines|
+    #       file = EnvFile::Template.new(file, pattern, lines)
+    #       if not File.exists?(file.filename) or console.agree(console.color("Do you want to override your current #{file.filename}?", [:bold, :yellow]))
+    #         console.say "Generating #{file.filename}..."
+    #         file.write do |line|
+    #           line.tap do |line|
+    #             if variable = file.variable(line) and not variable[:value]
+    #               line[-1] = console.ask("Enter a value for #{variable[:name]}:")
+    #             end
+    #           end
+    #         end
+    #       end
+    #     end
+    #   end
+    # end
+
+    def new_variable(name:, value:, file: Starenv.files.tsort.last || :core)
+      file = EnvFile.new(file, [], pattern, nil)
+    end
+
+    def set_variable(name, value:, file: Starenv.files.tsort.last || :core)
+      file = EnvFile.new(file, [], pattern, nil)
+    end
+
+    def get_variable(name, value:, file: Starenv.files.tsort.last || :core)
+      file = EnvFile.new(file, [], pattern, nil)
+    end
+
+  private
+
+    def console(*args)
+      @@console ||= HighLine.new(*args)
+    end
+
+    def chunk_into_files(lines)
+      lines.reduce({initial: []}) do |files, line|
+        if file = line[/^#\s+?FILE:\s+?(?<file>\w+)/, :file]
+          previous = files[files.keys.last]
+          files[file] = []
+          files[file] << previous.pop if previous
+          files.delete(:initial)
+        end
+        files[files.keys.last] << line
+        files
+      end
+    end
+
+  end
+end

data/lib/starenv/variable.rb

@@ -0,0 +1,39 @@
+module Starenv
+  class Variable < Struct.new(:name, :value, :default)
+
+    class << self
+
+      def line
+        %r{
+          \A
+          (?:export\s+)?    # optional export
+          ([\w\.]+)         # key
+          (?:\s*=\s*|:\s+?) # separator
+          (                 # optional value begin
+            '(?:\'|[^'])*'  #   single quoted value
+            |               #   or
+            "(?:\"|[^"])*"  #   double quoted value
+            |               #   or
+            [^#\n]+         #   unquoted value
+          )?                # value end
+          (?:\s*\#.*)?      # optional comment
+          \z
+        }x
+      end
+
+      def from(input)
+        new *line.match(input).captures
+      end
+
+    end
+
+    def initialize(name, value, default = nil)
+      super name, value, default
+    end
+
+    def to_s
+      value.to_s
+    end
+
+  end
+end

data/lib/starenv.rb

@@ -0,0 +1,41 @@
+require 'starenv/file/set'
+
+module Starenv
+
+  extend self
+
+  def format(name)
+    Kernel.format pattern, name
+  end
+
+  def pattern
+    @@pattern ||= default_pattern
+  end
+
+  def pattern= string
+    @@pattern = string.to_s
+  end
+
+  def files
+    @@env_files ||= File::Set.new
+  end
+
+  def register(names, dependencies: [])
+    Array(names).flatten.each do |name|
+      files.add name, dependencies, block_given? ? Proc.new : nil
+    end
+  end
+
+  def load(env = nil)
+    files.tsort.reduce(Environment.new(env)) do |environment, node|
+      environment.apply files[node].load.environment
+    end
+  end
+
+private
+
+  def default_pattern
+    'envs/%s.env'
+  end
+
+end

data/starenv.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "starenv"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Chris Keele"]
+  spec.email         = ["dev@chriskeele.com"]
+  spec.summary       = 'Load and manage suites of environment variables.'
+  spec.description   = "Declare multiple '.env' files, set up dynamic load orders between them, and use rake tasks to keep them up to date and documented."
+  spec.homepage      = "https://github.com/christhekeele/starenv"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.add_runtime_dependency "rake"
+  spec.add_runtime_dependency "highline"
+
+  spec.add_development_dependency "bundler", "> 1.3"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: starenv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Keele
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: highline
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Declare multiple '.env' files, set up dynamic load orders between them,
+  and use rake tasks to keep them up to date and documented.
+email:
+- dev@chriskeele.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/rake
+- lib/starenv.rb
+- lib/starenv/env_file.rb
+- lib/starenv/environment.rb
+- lib/starenv/file.rb
+- lib/starenv/file/node.rb
+- lib/starenv/file/parser.rb
+- lib/starenv/file/set.rb
+- lib/starenv/file/template.rb
+- lib/starenv/results.rb
+- lib/starenv/tasks.rb
+- lib/starenv/variable.rb
+- starenv.gemspec
+homepage: https://github.com/christhekeele/starenv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Load and manage suites of environment variables.
+test_files: []