dot_example 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f28ab67ad6f4d690e46f49d7f5c4c876021fd63
+  data.tar.gz: aa7c2ab482e6795f143486b38b6c9eacbbc09788
+SHA512:
+  metadata.gz: d1d13c541460c0846bf93b1774bf788484c4e7e3bcbe089c46c94822faf14a2bc15b7e3d06341b5b3b9d49b0c1eb712a844c6b2417ff1f2b3703111a251a57ea
+  data.tar.gz: 5aa94b267cd9c1641db8ce427744ba08f6cbaf314f4126c083f5aea7e9d8dd9871a4f964410b060e97b5037b877e7067c9b732eb2be7821ca197a6c6e8c3cd44

data/README.md

@@ -0,0 +1,81 @@
+# DotExample
+It's become common practice to use a tool like the `dotenv` gem to manage environment variables locally, keeping all environment variables in a key value store in a dotfile (`.env`) and then leaving this file out of version control. However when working on a team it's easy to lose track of the latest variables that need to be added to `.env`. Often it isn't obvious when one is needed until a problem arises. Adding the keys to the README and/or to a `.env.example` file is one way to share the ENV variables needed with the rest of the team, but like many kinds of documentation it is easy for these files to get out of date.
+
+Enter `dot_example`, a simple tool for automatically documenting the environment variables in use across the team and alerting team members when a new variable has been added. This is accomplished through the use of a `.env.example` file and setting up git hooks. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dot_example'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dot_example
+
+## Quick Start
+Most of the time you should only need to manually run one command
+
+```
+dot_example setup
+```
+
+And you're done. That was easy!
+
+Running this setup script will do the following:
+1. Create a new pre-commit git hook that will add the keys from your `.env` file to a `.env.example` file whenever you create a new commit.
+2. Create a new post-checkout git hook that will check for new variables in the `.env.example` whenever you checkout a branch.
+3. Create or add to a bin/setup file so that this setup script will be run automatically whenever anyone runs `./bin/setup`
+
+Now for anyone else who joins the project all they have to do is run `./bin/setup` and `dot_example` will get setup along with the rest of the app. They won't even need to know that it's there!
+
+## Usage
+
+dot_example ships with three commands `setup`, `sync` and `check`
+
+### Setup
+
+```
+$ dot_example setup
+```
+
+Sets up the githooks that will cause sync and check to run automatically. Assuming this works without a hitch this should keep you from having to manually run anything ever. You can even put a line in the bin/setup script to call this command:
+
+and then you won't even have to manually run `setup` just have everyone run `./bin/setup` when they start the project. In case you do need to run the commands for whatever reason you can run the other two commands are as follows:
+
+### Sync
+```
+$ dot_example snyc
+```
+sync will take the keys to the ENV variables are in your `.env` file and write them to a `.env.example` file. By keeping _this_ file in source control rather than the actual `.env` file you can make sure that other team members are always up to date on which ENV variables they are missing.
+
+### Check
+
+```
+$ dot_example check
+```
+
+`check` will look at the ENV variables you currently have defined in your `.env` file and ensure they are up to date with the keys in the latest `.env.example`. This doesn't guarantee that their _values_ are correct but at least you'll receive a warning if you're missing keys and you'll know to ask someone for the ENV variables you're missing.
+
+After running `dot_example setup` the `check` command will be run whenever you checkout code. This could easily be changed though if you'd rather the check happen in a different common task such as running tests with rake. All you'd need to do then is add `dot_example check` to your rake task.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/smcabrera/dot_example. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dot_example"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/dot_example

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require_relative '../lib/dot_example'
+
+program :name, 'dot_example'
+program :version, DotExample::VERSION
+program :description, DotExample::SUMMARY
+program :help, 'Author', 'Stephen Mariano Cabrera <smcabrera.github.io>'
+program :help, 'Version', "#{DotExample::VERSION} #{DotExample::DATE}"
+
+command :setup do |c|
+  c.syntax = 'dot_example setup [options]'
+  c.summary = 'Setup the githooks to automate the dot_example tasks'
+  c.description = 'Setup the githooks to automate the dot_example tasks'
+  #c.example 'description', 'command example'
+  #c.option '--some-switch', 'Some switch that does something'
+  c.action do |args, options|
+    dot_env_dot_example = DotEnvDotExample.new
+    DotExample.add_pre_commit_hook(dot_env_dot_example)
+    DotExample.add_post_checkout_hook
+  end
+end
+
+command :sync do |c|
+  c.syntax = 'dot_example sync [options]'
+  c.summary = 'Creates a new .env.example file with the keys from .env.'
+  c.description = 'Creates a new .env.example file with the keys from .env.'
+  #c.example 'dot_example sync', 'command example'
+  c.option '--dot-env-path FILEPATH', String, 'path to the .env file if different than current directory'
+  c.option '--dot-example-path FILEPATH', String, 'path to the .env.example file if different than current directory'
+  #c.option '--suffix STRING', String, 'Adds a suffix to bar'
+  c.action do |args, options|
+    dot_env = DotEnv.new(options.dot_env_path)
+    dot_env_dot_example = DotEnvDotExample.new(dot_env: dot_env, filename: options.dot_example_path)
+    dot_env_dot_example.write!
+  end
+end
+
+command :check do |c|
+  c.syntax = 'dot_example check_vars [options]'
+  c.summary = 'Checks ENV keys to make sure they are up to date with those found in .env.example'
+  c.description = ''
+  c.option '--dot-env-path FILEPATH', String, 'path to the .env file if different than current directory'
+  c.option '--dot-example-path FILEPATH', String, 'path to the .env.example file if different than current directory'
+  #c.example 'description', 'command example'
+  #c.option '--some-switch', 'Some switch that does something'
+  c.action do |args, options|
+    dot_env = DotEnv.new(options.dot_env_path)
+    dot_env_dot_example = DotEnvDotExample.new(dot_env: dot_env, filename: options.dot_example_path)
+    dot_env_dot_example.print_missing_keys_message
+  end
+end
+
+default_command :help

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+# Do any other automated setup that you need to do here

data/lib/dot_example.rb

@@ -0,0 +1,18 @@
+require_relative "dot_example/version"
+require_relative "dot_example/dot_env"
+require_relative "dot_example/dot_env_dot_example"
+require_relative "dot_example/pre_commit_hook"
+require_relative "dot_example/post_checkout_hook"
+require_relative "dot_example/hook"
+
+module DotExample
+  def self.add_pre_commit_hook(dot_env_dot_example)
+    pre_commit_hook = PreCommitHook.find_or_create
+    pre_commit_hook.write!
+  end
+
+  def self.add_post_checkout_hook
+    post_checkout_hook = PostCheckoutHook.find_or_create
+    post_checkout_hook.write!
+  end
+end

data/lib/dot_example/dot_env.rb

@@ -0,0 +1,30 @@
+class DotEnv
+  def initialize(filename = nil)
+    @filename = filename || ".env"
+  end
+
+  attr_reader :filename
+
+  def key_lines
+    keys.map { |key| key + "=" }.join("\n")
+  end
+  
+  def lint!
+    unless line.match(/^[^=\s]*=[^=\s]*$/)
+      # TODO: Don't know if this is the best error message
+        raise "Invalid Environment variable defintion"
+    end
+  end
+
+  def keys
+    lines.map do |line|
+      line.split("=")[0]
+    end
+  end
+
+  private
+
+  def lines
+    File.readlines(filename)
+  end
+end

data/lib/dot_example/dot_env_dot_example.rb

@@ -0,0 +1,65 @@
+class DotEnvDotExample
+  def initialize( options = {} )
+    @filename = options[:filename] || ".env.example"
+    @dot_env = options[:dot_env] || DotEnv.new
+  end
+
+  attr_reader :filename, :dot_env
+
+  def write!
+    if keys_new_to_example.any?
+      print_new_keys_message
+      File.open(filename, "a") do |file|
+        file.puts keys_new_to_example
+      end
+    end
+  end
+
+  def keys_new_to_example
+    dot_env.keys - keys
+  end
+
+  def print_new_keys_message
+    puts "*" * 60 
+    puts "New variables added to #{filename}"
+    puts keys_new_to_example
+    puts "*" * 60 
+  end
+
+  def missing_keys
+    keys.reject do |key|
+      dot_env.keys.include?(key)
+    end
+  end
+
+  def print_missing_keys_message
+    if missing_keys.any?
+      puts "*" * 60 
+      puts "missing ENV variables from #{dot_env.filename}"
+      puts missing_keys
+      puts "*" * 60 
+    end
+  end
+
+  def pre_commit_hook
+    # TODO: Make it possible to put .env and .env.example files somewhere else?
+    # Maybe later if people actually want this feature
+    [
+      "dot_example sync",
+      "git add .env.example"
+    ].join("\n")
+  end
+
+  private
+
+  def keys
+    lines.map{ |line| line.split("=")[0] }
+  end
+
+  def lines
+    unless Dir.glob(filename).any? 
+      `touch #{filename}`
+    end
+    File.readlines(filename)
+  end
+end

data/lib/dot_example/hook.rb

@@ -0,0 +1,2 @@
+class Hook
+end

data/lib/dot_example/post_checkout_hook.rb

@@ -0,0 +1,53 @@
+class PostCheckoutHook < Hook
+  FILEPATH = File.join(".git", "hooks", "post-checkout")
+
+  def initialize(dot_env_dot_example = nil)
+    @dot_env_dot_example = dot_env_dot_example || DotEnvDotExample.new
+    @name = "post-checkout"
+  end
+
+  attr_reader :dot_env_dot_example, :name
+
+  def self.find_or_create
+    unless Dir.glob(FILEPATH).any?
+      %x[ touch #{FILEPATH} ]
+      %x[ chmod +x #{FILEPATH} ]
+      self.print_new_hook_message
+    end
+    new
+  end
+
+  def write!
+    unless contains_steps? 
+      File.open(FILEPATH, "a") do |file|
+        file.puts steps
+      end
+    print_new_steps_message
+    end
+  end
+
+  def self.print_new_hook_message
+    puts "*" * 60 
+    puts "New #{name} hook created"
+    puts "*" * 60 
+  end
+
+  def print_new_steps_message
+    puts "*" * 60 
+    puts "New steps added to #{name} hook"
+    puts steps
+    puts "*" * 60 
+  end
+
+  def contains_steps?
+    contents.include?(steps)
+  end
+
+  def contents
+    File.read(FILEPATH)
+  end
+
+  def steps
+    "dot_example check"
+  end
+end

data/lib/dot_example/pre_commit_hook.rb

@@ -0,0 +1,49 @@
+require_relative './hook'
+
+class PreCommitHook < Hook
+  FILEPATH = File.join(".git", "hooks", "pre-commit")
+
+  def initialize(dot_env_dot_example = nil)
+    @dot_env_dot_example = dot_env_dot_example || DotEnvDotExample.new
+  end
+
+  attr_reader :dot_env_dot_example
+
+  def self.find_or_create
+    unless Dir.glob(FILEPATH).any?
+      %x[ touch #{FILEPATH} ]
+      %x[ chmod +x #{FILEPATH} ]
+      self.print_new_pre_commit_hook_message
+    end
+    new
+  end
+
+  def self.print_new_pre_commit_hook_message
+    puts "*" * 60 
+    puts "New pre-commit hook created"
+    puts "*" * 60 
+  end
+
+  def write!
+    unless contains_dot_example_steps? 
+      File.open(FILEPATH, "a") do |file|
+        file.puts dot_env_dot_example.pre_commit_hook
+      end
+    end
+  end
+
+  def print_new_steps_message
+    puts "*" * 60 
+    puts "New steps added to pre-commit hook"
+    puts dot_env_dot_example.pre_commit_hook
+    puts "*" * 60 
+  end
+
+  def contents
+    File.read(FILEPATH)
+  end
+
+  def contains_dot_example_steps?
+    contents.include?(dot_env_dot_example.pre_commit_hook)
+  end
+end

data/lib/dot_example/version.rb

@@ -0,0 +1,5 @@
+module DotExample
+  VERSION = "1.0.0.pre"
+  SUMMARY = %q(Keep your project's environment variables in snyc across your team.)
+  DATE = %q{2016-9-21}
+end

data/lib/tasks/dot_example.rake

@@ -0,0 +1,17 @@
+# TODO: Figure out whether it makes more sense to use rake tasks or just custom commands using commander.
+namespace :dot_example do
+  desc "Setup the githooks to automate the dot_example tasks"
+  task :setup => :environment do
+    # Call other classes and do stuff
+  end
+
+  desc "Creates a new .env.example file with the keys from .env."
+  task :sync => :environment do
+  end
+
+  desc "Checks ENV keys to make sure they are up to date with those found in .env.example"
+  task :check => :environment do
+    # Call other classes and do stuff
+  end
+
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: dot_example
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+platform: ruby
+authors:
+- Stephen Mariano Cabrera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: jazz_fingers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+description: Keep your project's environment variables in snyc across your team.
+email:
+- stephen.m.cabrera@gmail.com
+executables:
+- dot_example
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/dot_example
+- bin/setup
+- lib/dot_example.rb
+- lib/dot_example/dot_env.rb
+- lib/dot_example/dot_env_dot_example.rb
+- lib/dot_example/hook.rb
+- lib/dot_example/post_checkout_hook.rb
+- lib/dot_example/pre_commit_hook.rb
+- lib/dot_example/version.rb
+- lib/tasks/dot_example.rake
+homepage: https://www.github.com/smcabrera/dot_example
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Keep your project's environment variables in snyc across your team.
+test_files: []