envyable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3200aedd3b04ed43ad9fd1e75564d81549ba4958
-  data.tar.gz: 9c48bca7830540999cfb5ee18e67edba2f411681
+  metadata.gz: 9af9099263d420d122e266e2342e8896eaa656e2
+  data.tar.gz: 838d6e0b501c7b82b101cddee16a5804cfd21029
 SHA512:
-  metadata.gz: 86fbe5ab7f712f6aadb458c04ce02e0e6e57bcc3a56315d269224890414524c08858da0b4d00984785fa96616efb209a7a4a173b3bdeec67a76d16c569c6b5a1
-  data.tar.gz: dd1db30e4fd41cf05533cd6ee4fe341f07836c2ae002fbdae3703f3a5c1a44532387c80c2ca4c8cbe4baa4768f9588483b900366c40b31a4df03835a395a55fb
+  metadata.gz: c15fcfebd3d6f87e7c5a6b3ddebfe0ae5c8ea374e696a49432cf6eb138706e72b65d9a30a712fd5052f52a831ae9a4b972db45d0da45c6c95b2f789072afdbd6
+  data.tar.gz: 816bad4d47b57e8830233288c814d2439766cdf587643186e62f71df69a93d340ee866d41d54c1ac5db31f656e1c6010ca86839e80b9442217f6f9608ba8b671

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/sandbox

data/.travis.yml

@@ -1,7 +1,12 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
   - jruby-19mode
-  - rbx
+  - rbx-3.56
+before_install: gem install bundler
+matrix:
+  allow_failures:
+  - rvm: rbx-3.56

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # ChangeLog
 
+## 1.1.0 / 2016-08-31
+
+* [FEATURE] New envyable executable with a single command: `envyable install`. Will setup a good default for envyable, including `config/env.yml` and `config/env.yml.example` files and gitignoring the `config/env.yml` file.
+* [ENHANCEMENT] Adds code coverage report
+* [ENHANCEMENT] Adds Code Climate score and coverage report badges to README
+
+## 1.0.0 / 2016-01-24
+
+* [FEATURE] If you have gems that require variables to be set earlier, then place `envyable` in the `Gemfile` before those gems and require `envyable/rails-now`. Thanks to @mikelkew.
+
 ## 0.2.0 / 2015-03-16
 
 * [FEATURE] Allows user to add default values and then override on an environment by environment basis

data/Gemfile

@@ -3,6 +3,11 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in envyable.gemspec
 gemspec
 
+group :test do
+  gem "codeclimate-test-reporter", :require => nil
+  gem "simplecov", "~> 0.12", :require => nil
+end
+
 platforms :rbx do
   gem 'racc'
   gem 'rubysl', '~> 2.0'

data/README.md

@@ -2,7 +2,7 @@
 
 The simplest yaml to ENV config loader.
 
-[![Build Status](https://travis-ci.org/philnash/envyable.png?branch=master)](https://travis-ci.org/philnash/envyable)
+[![Build Status](https://travis-ci.org/philnash/envyable.svg?branch=master)](https://travis-ci.org/philnash/envyable) [![Code Climate](https://codeclimate.com/github/philnash/envyable/badges/gpa.svg)](https://codeclimate.com/github/philnash/envyable) [![Test Coverage](https://codeclimate.com/github/philnash/envyable/badges/coverage.svg)](https://codeclimate.com/github/philnash/envyable/coverage)
 
 ## Installation
 
@@ -18,6 +18,25 @@ Or install it yourself as:
 
     $ gem install envyable
 
+### Install task
+
+Once the gem is included in your project, you can then use it to generate the
+default required files. Just run:
+
+```
+$ envyable install
+```
+
+and you will get a `config` directory containing an `env.yml` and a
+`env.yml.example` file. If you have a `.gitignore` file this will also append
+the line
+
+```yaml
+/config/env.yml
+```
+
+to your config so that you do not check in `/config/env.yml`.
+
 ## Usage
 
 ### YAML file

data/bin/envyable

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require "thor"
+
+require "./lib/envyable/cli"
+
+Envyable::CLI.start

data/envyable.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "thor", ">= 0.18.1", "< 2.0"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"

data/lib/envyable/cli.rb

@@ -0,0 +1,20 @@
+require "thor"
+
+module Envyable
+  class CLI < Thor
+    include Thor::Actions
+
+    namespace :envyable
+
+    desc "install", "Installs Envyable with sensible defaults"
+    def install
+      create_file("config/env.yml")
+      create_file("config/env.yml.example")
+      if File.exists?("#{destination_root}/.gitignore")
+        append_to_file(".gitignore") do
+          "\n# Don't check in credentials \nconfig/env.yml"
+        end
+      end
+    end
+  end
+end

data/lib/envyable/version.rb

@@ -1,3 +1,3 @@
 module Envyable
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/envyable/cli_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../../spec_helper', __FILE__)
+require File.expand_path('../../../lib/envyable/cli', __FILE__)
+
+describe Envyable::CLI do
+  before do
+    ::FileUtils.rm_rf(destination_root)
+  end
+
+  let(:cli) { Envyable::CLI.new([], {}, :destination_root => destination_root) }
+
+  describe "install" do
+    it "should create a file in config/env.yml" do
+      env_yml = "#{cli.destination_root}/config/env.yml"
+      File.exists?(env_yml).must_equal false
+      capture_io { cli.install }
+      File.exists?(env_yml).must_equal true
+    end
+
+    it "should create a file in config/env.yml.example" do
+      env_yml_example = "#{cli.destination_root}/config/env.yml.example"
+      File.exists?(env_yml_example).must_equal false
+      capture_io { cli.install }
+      File.exists?(env_yml_example).must_equal true
+    end
+
+    it "should not create a .gitignore" do
+      gitignore = "#{cli.destination_root}/.gitignore"
+      File.exists?(gitignore).must_equal false
+      capture_io { cli.install }
+      File.exists?(gitignore).must_equal false
+    end
+
+    it "should add config/env.yml to existing .gitignore" do
+      gitignore = "#{cli.destination_root}/.gitignore"
+      cli = Envyable::CLI.new([], {}, :destination_root => destination_root(:with_gitignore => true))
+      File.exists?(gitignore).must_equal true
+      File.readlines(gitignore).none? { |line| line == "config/env.yml" }.must_equal true
+      capture_io { cli.install }
+      File.readlines(gitignore).any? { |line|  line == "config/env.yml" }.must_equal true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,26 @@
+require 'fileutils'
 require 'rubygems'
+begin
+  require "simplecov"
+  require "codeclimate-test-reporter"
+  SimpleCov.start do
+    formatter SimpleCov::Formatter::MultiFormatter.new([
+      SimpleCov::Formatter::HTMLFormatter,
+      CodeClimate::TestReporter::Formatter
+    ])
+    add_filter "/spec/"
+  end
+rescue LoadError
+end
+
 gem 'minitest'
 require 'minitest/autorun'
 
 require File.join(File.dirname(__FILE__), '..', 'lib', 'envyable')
+
+def destination_root(opts={})
+  dir = File.join(File.dirname(__FILE__), "sandbox")
+  FileUtils.mkdir_p(dir)
+  FileUtils.touch("#{dir}/.gitignore") if opts[:with_gitignore]
+  dir
+end

metadata

@@ -1,22 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: envyable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Phil Nash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-24 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: thor
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+  name: bundler
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -25,12 +45,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  name: minitest
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -39,12 +59,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  name: rake
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -55,7 +75,8 @@ dependencies:
 description: The simplest yaml to ENV config loader
 email:
 - philnash@gmail.com
-executables: []
+executables:
+- envyable
 extensions: []
 extra_rdoc_files: []
 files:
@@ -66,12 +87,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/envyable
 - envyable.gemspec
 - lib/envyable.rb
+- lib/envyable/cli.rb
 - lib/envyable/loader.rb
 - lib/envyable/rails-now.rb
 - lib/envyable/railtie.rb
 - lib/envyable/version.rb
+- spec/envyable/cli_spec.rb
 - spec/envyable/loader_spec.rb
 - spec/envyable_spec.rb
 - spec/fixtures/default_env.yml
@@ -97,11 +121,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: The simplest yaml to ENV config loader
 test_files:
+- spec/envyable/cli_spec.rb
 - spec/envyable/loader_spec.rb
 - spec/envyable_spec.rb
 - spec/fixtures/default_env.yml