exportr 0.3.0 → 0.4.0

data/.gitignore

@@ -1,4 +1,19 @@
 *.gem
+*.rbc
 .bundle
+.config
+.yardoc
 Gemfile.lock
-pkg/*
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+lib/*.so
+lib/*.bundle
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in export.gemspec
+# Specify your gem's dependencies in exportr.gemspec
 gemspec

data/LICENSE

@@ -1,18 +1,22 @@
-Copyright (C) 2012 Richard Calahan, All Day Everyday
+Copyright (c) 2013 richardcalahan
 
-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:
+MIT License
 
-The above copyright notice and this permission notice shall be included in all 
-copies or substantial portions of the Software.
+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 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 
+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

@@ -1,73 +1,56 @@
-# Exportr: An environment manager for Rails development
+## Exportr: An environment manager for Ruby development
 
-## Description
+### Description
 
-Managing environment variables locally is kind of a drag. If you only build one application at a time, you *could* simply export environment variables in your .bashrc. But in reality you're working on 5 apps at a time, each requiring different settings for Facebook, Google, AmazonS3, etc. 
+Exportr is a simple environment variable manager for Ruby development. It reads key-value pairs from a yaml file and merges these pairs into Ruby's ENV hash when you `require 'exportr'`.
 
-If you set environment variables on your production servers to store configuration options for these services, you might also hard code 'default' options to fall back to on your local machine. Hardcoding default configuation options, especially private keys and passwords for third party apis is an *insane* security risk.
+The yaml file must be in one of Exportr's predefined locations. The paths are relative to the present working directory of the Ruby process. (The list will grow as Exportr is tested in various frameworks.)
 
-**Problem solved**.
+```
+/exportr.yml
+/config/exportr.yml
+```
 
-Exportr helps you manage *local* environment variables. Each set is scoped to a specific rails application in `config/exportr.yml`. The file is 'git ignored' when created, so it never leaves your machine. Its key:value pairs are loaded as environment variables right before your application initializes.  
+### Basic Usage
 
-### Setup
+Install the gem.
 
-Add the gem to your Gemfile.
-    
-    group :development do
-      gem 'exportr'
-    end   
+`$ gem install exportr`
 
-Install it!
+Create an exportr.yml file in one of the predefined locations.
 
-    $ bundle install
-    
-Run the generator.
+Require the gem.
 
-    $ rails generate exportr
-    
-The generator creates a yaml file in your config directory. It will store key:value pairs to be loaded as environment variables when your app launches. You can edit it manually, or use the command line interface.
+`require 'exportr'`
 
-### CLI
+### Rails
 
-You can edit the yaml config file directly, or use the handy CLI. There are several simple options for managing your configuration.  
-You can use flags longform *e.g.* `--add, --remove, --clear, --list` or shorhand *e.g.* `-a, -r, -c, -l`.
+Exportr comes with a rails generator that will create `config/exportr.yml` and add it to your `.gitignore` file.
 
-**Add**
+Add the gem to your Gemfile
 
-    $ exportr --add KEY=VALUE
+```
+group :development do
+  gem 'exportr'
+end   
+```
 
-**Remove**
+Run bundle install.
 
-    $ exportr --remove KEY
+`$ bundle install`
 
-**Clear**    
+Start your app server. 
 
-    $ exportr --clear
+`$ rails server`
 
-**List**
+**Notes**
 
-    $ exportr --list
+You will need to restart your server/ruby process after changing the yaml file. You can optionally manually load additions to the yaml file by calling `Exportr.export`.
 
-**Version**
 
-    $ exportr --version
 
-**Help**
 
-    $ exportr --help
 
-    
-### FYI
 
-You'll need to restart your webserver for the changes to take effect. 
 
-### New Updates!
 
-Exportr now supports system configuration files for production deployments of rails apps. By default, exportr will load the YAML file in /etc/#{application_name}_#{rails_env}.yml. The prefix, '/etc', can be overridden by setting the environment variable EXPORTR_PREFIX. 
-
-Make sure the file is readable by your web process.
-    
-### License
-
-Exportr © 2012 by Richard Calahan and contributors at [All Day Every Day](http://alldayeveryday.com). It is licensed under the MIT license. See the include LICENSE file for details.

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+require 'rake'
+require 'rake/extensiontask'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+Rake::ExtensionTask.new 'exportr'
+
+task :default => [ :compile, :spec ]

data/config/exportr.yml

@@ -0,0 +1,2 @@
+---
+FOO: bar

data/exportr.gemspec

@@ -1,25 +1,21 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "exportr/version"
 
-Gem::Specification.new do |s|
-  s.name        = "exportr"
-  s.version     = Exportr::VERSION
-  s.authors     = ["Richard Calahan"]
-  s.email       = ["richard@alldayeveryday.com"]
-  s.homepage    = ""
-  s.summary     = 'Rails environment variable manager'
-  s.description = 'Helps manage rails application specific environment variables for multiple apps in development.'
-
-  s.rubyforge_project = "exportr"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  # specify any dependencies here; for example:
-  #s.add_development_dependency "optparse"
-  # s.add_runtime_dependency "optparse"
+require 'exportr/version'
 
+Gem::Specification.new do |gem|
+  gem.name          = 'exportr'
+  gem.version       = Exportr::VERSION
+  gem.authors       = ['Richard Calahan']
+  gem.email         = ['richard@calahan.me']
+  gem.description   = 'Helps manage ruby application specific environment variables for multiple apps in development.'
+  gem.summary       = 'Ruby environment variable manager'
+  gem.homepage      = 'https://github.com/richardcalahan/exportr'
+  gem.files         = `git ls-files`.split($/)
+  gem.extensions    = Dir.glob 'ext/**/extconf.rb'
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rake-compiler'
+  gem.add_development_dependency 'rspec'
 end

data/ext/exportr/exportr.c

@@ -0,0 +1,109 @@
+#include "ruby.h"
+#include "ruby/util.h"
+#include <stdio.h>
+#include <unistd.h>
+
+#define FILE "exportr.yml"
+
+static const char *d_scan[] = { "", "config", 0 };
+
+static VALUE File = Qnil; 
+static VALUE rb_file ( void )
+{   
+    if ( TYPE(File) == T_NIL ) {
+        File = rb_const_get(rb_cObject, rb_intern("File")); 
+    }
+    
+    return File;
+}
+
+static VALUE Yaml = Qnil;
+static VALUE rb_yaml ( void )
+{
+    if ( TYPE(Yaml) == T_NIL ) {
+        Yaml = rb_const_get(rb_cObject, rb_intern("YAML"));
+    }
+    
+    return Yaml;
+}
+
+static VALUE exportr_config_file ( void ) 
+{
+    VALUE filepath, frag;
+    VALUE exists = Qfalse;
+
+    int i;
+    for ( i=0; 1; i++ ) {
+        if ( d_scan[i] == 0 ) break;
+
+        frag = rb_str_new2(d_scan[i]);
+        if ( strlen(d_scan[i]) > 0 ) rb_str_cat2(frag, "/");
+        rb_str_cat2(frag, FILE);
+
+        filepath = rb_funcall(rb_file(), rb_intern("expand_path"), 1, frag);
+        exists = rb_funcall(rb_file(), rb_intern("exists?"), 1, filepath);
+
+        if ( TYPE(exists) == T_TRUE ) break;
+
+        filepath = Qnil;
+    }
+    
+    return filepath;
+}
+
+static int exportr_set_env ( VALUE k, VALUE v, VALUE data )
+{   
+    if ( TYPE(v) != T_STRING ) {
+        v = rb_funcall(v, rb_intern("to_s"), 0);
+    }
+
+    Check_Type(k, T_STRING);
+    Check_Type(v, T_STRING);
+
+    ruby_setenv(StringValuePtr(k), StringValuePtr(v));
+
+    return ST_CONTINUE;
+}
+
+static VALUE exportr_read ( void )
+{
+    VALUE data;
+    VALUE config = exportr_config_file();
+    VALUE hash = Qnil;
+
+    if ( TYPE(config) != T_NIL ) {
+        data = rb_funcall(rb_file(), rb_intern("read"), 1, config);
+        hash = rb_funcall(rb_yaml(), rb_intern("load"), 1, data);
+        return hash;
+    }    
+    return Qnil;
+}
+
+static VALUE exportr_export ( void )
+{
+    VALUE hash = exportr_read();
+
+    if ( TYPE(hash) == T_HASH ) {
+        rb_hash_foreach(hash, *exportr_set_env, Qnil);
+        return Qtrue;
+    }    
+
+    return Qfalse;
+}
+
+void Init_exportr ( void )
+{
+    rb_require("yaml");
+
+    VALUE rb_mExportr;
+
+    rb_mExportr = rb_define_module("Exportr");
+    rb_define_singleton_method(rb_mExportr, "export", exportr_export, 0);
+    rb_define_singleton_method(rb_mExportr, "read", exportr_read, 0);
+    rb_define_singleton_method(rb_mExportr, "config_file", exportr_config_file, 0);
+    
+    /* 
+     * Manually call read on Exportr module when lib is loaded
+     */
+    rb_funcall(rb_mExportr, rb_intern("export"), 0);
+}

data/ext/exportr/extconf.rb

@@ -0,0 +1,2 @@
+require 'mkmf'
+create_makefile 'exportr'

data/lib/exportr/version.rb

@@ -1,3 +1,3 @@
 module Exportr
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/exportr.rb

@@ -1,4 +1,4 @@
-require 'exportr/railtie'
-require 'exportr/version'
+require 'exportr.bundle'
+require 'exportr.so'
 
 module Exportr; end

data/lib/generators/exportr/templates/exportr.yml

@@ -1,7 +1,7 @@
-# This file is loaded before app initialization to set app specific environment variables
-# set environment variables in the format [KEY]: [VALUE], each separated by a newline
+# This file is loaded with ruby's environment to set app specific environment variables.
+# Set environment variables in the format [KEY]: [VALUE]
 # 
 # FACEBOOK_APP_KEY: '234443366312034'
 # S3_BUCKET: 'myapp-production'
 
----
+---

data/spec/exportr_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'exportr'
+
+describe Exportr do
+
+  it 'finds configuration file' do
+    File.exists?(Exportr.config_file).should == true
+  end
+
+  it 'reads configuration file' do
+    Exportr.read['FOO'].should == 'bar'
+  end
+
+  it 'wrote configuration file to ENV' do
+    ENV['FOO'].should == 'bar'
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+RSpec.configure do |config|
+  # config.treat_symbols_as_metadata_keys_with_true_values = true
+  # config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exportr
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,35 +9,82 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
-dependencies: []
-description: Helps manage rails application specific environment variables for multiple
+date: 2013-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helps manage ruby application specific environment variables for multiple
   apps in development.
 email:
-- richard@alldayeveryday.com
-executables:
-- exportr
-extensions: []
+- richard@calahan.me
+executables: []
+extensions:
+- ext/exportr/extconf.rb
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- bin/exportr
+- config/exportr.yml
 - exportr.gemspec
+- ext/exportr/exportr.c
+- ext/exportr/extconf.rb
 - lib/exportr.rb
-- lib/exportr/base.rb
-- lib/exportr/command.rb
-- lib/exportr/command/core.rb
-- lib/exportr/command/helpers.rb
-- lib/exportr/command/messages.rb
-- lib/exportr/railtie.rb
 - lib/exportr/version.rb
 - lib/generators/exportr/exportr_generator.rb
 - lib/generators/exportr/templates/exportr.yml
-homepage: ''
+- spec/exportr_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/richardcalahan/exportr
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -56,9 +103,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: exportr
+rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Rails environment variable manager
-test_files: []
+summary: Ruby environment variable manager
+test_files:
+- spec/exportr_spec.rb
+- spec/spec_helper.rb

data/bin/exportr

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'exportr/command'
-
-Exportr::Command.run *ARGV

data/lib/exportr/base.rb

@@ -1,38 +0,0 @@
-module Exportr
-
-  module Base
-
-    # Default config file location. 
-    CONFIG_FILE       = 'config/exportr.yml'
-
-    SYSTEM_FILE_PATH = '/etc'
-    
-    def self.extended base
-      constants.each do |const| 
-        base.const_set const, const_get(const)
-      end
-    end
-
-    def rails_root
-      begin
-        return Dir.pwd if File.exists?('script/rails')
-        raise
-      rescue
-        Dir.chdir '..'
-        retry unless Dir.pwd == '/'
-        return false
-      end      
-    end
-
-    def config_file
-      File.expand_path(CONFIG_FILE, rails_root)
-    end
-
-    def system_config_file
-      prefix = ENV['EXPORTR_PREFIX'] || SYSTEM_FILE_PATH
-      "#{prefix}/#{Rails.application.class.to_s.split('::')[0].downcase}_#{ENV['RAILS_ENV'] || 'development'}.yml"
-    end
-
-  end
-
-end

data/lib/exportr/command/core.rb

@@ -1,52 +0,0 @@
-module Exportr
-
-  module Command
-
-    module Core
-
-      def add val
-        log
-        log "Adding #{val.to_a[0][0]}=#{val.to_a[0][1]} to your environment..."
-        write_config load_config.merge(val)
-      end
-
-      def remove val
-        log
-        log "Removing #{val.to_a[0][0]} from your environment..."
-        write_config load_config.reject { |k,v| k == val.to_a[0][0] }
-      end
-
-      def clear
-        log
-        log "Clearing environment variables..."
-        write_config Hash.new
-      end
-
-      def list
-        log
-        log "Exportr Environment Variables"
-        log "--------------------------------------------------"
-        vars = load_config.to_a
-        vars.each { |var| log "#{var[0]}=#{var[1]}" }
-        log("none.") unless vars.any?
-        log
-      end
-
-      def version
-        log
-        log "Version #{Exportr::VERSION}"
-        log
-      end
-
-      def help
-        STDOUT.puts
-        STDOUT.puts parser.help
-        STDOUT.puts
-      end
-
-    end
-
-  end
-
-end
-

data/lib/exportr/command/helpers.rb

@@ -1,30 +0,0 @@
-require 'exportr/base'
-
-module Exportr
-
-  module Command
-    
-    module Helpers
-
-      extend Exportr::Base
-
-      def log msg=nil
-        STDOUT.puts msg ? " | #{msg}" : ""
-      end
-
-      def error msg
-        STDERR.puts
-        STDERR.puts " | ERROR: #{msg}"
-        STDERR.puts
-        exit 1
-      end
-
-      def in_rails_application?
-        !!rails_root
-      end
-
-    end
-
-  end
-
-end

data/lib/exportr/command/messages.rb

@@ -1,23 +0,0 @@
-module Exportr
-  
-  module Command
-
-    module Messages
-
-      # Default error message if CLI is run outside rails
-      NOT_RAILS       = 'Could not detect rails application.'
-      
-      # Default error message if there is no config file present.
-      NO_CONFIG_FILE  = 'You must run `rails generate exportr` first.'
-
-      def self.extended base
-        constants.each do |const| 
-          base.const_set const, const_get(const)
-        end
-      end
-
-    end
-
-  end
-
-end

data/lib/exportr/command.rb

@@ -1,85 +0,0 @@
-require 'exportr/base'
-require 'exportr/command/core'
-require 'exportr/command/helpers'
-require 'exportr/command/messages'
-require 'exportr/version'
-require 'optparse'
-require 'yaml'
-
-module Exportr
-
-  module Command
-
-    extend Exportr::Base
-    extend Exportr::Command::Core
-    extend Exportr::Command::Helpers
-    extend Exportr::Command::Messages
-
-    def self.core_options
-      @global_options ||= []
-    end
-
-    def self.core_option name, *args
-      core_options << { :name => name, :args => args }
-    end
-
-    core_option :add, '-a', '--add KEY=VALUE', 'Add environment variable'
-    core_option :remove, '-r', '--remove KEY', 'Remove environment variable'
-    core_option :clear, '-c', '--clear', 'Clear out all environment variables'
-    core_option :list, '-l', '--list', 'List all environment variables'
-    core_option :version, '-v', '--version', 'Get exportr version number'
-    core_option :help, '-h', '--help', 'Print this message'
-
-    def self.run *argv
-      error NOT_RAILS unless in_rails_application?
-      argv.any? ? parser.parse!(argv) : help
-    end
-
-    def self.parser
-      OptionParser.new do |parser|
-        parser.banner = "Usage:\n    exportr [options]"
-        parser.separator "\nOptions: "
-        core_options.each do |opt|
-          parser.on *opt[:args] do |val| 
-            send(opt[:name], hashify(val)) rescue send opt[:name]
-          end
-        end
-      end
-    end
-
-    def self.read_config
-      error NO_CONFIG_FILE unless File.exists?(config_file)
-      File.read config_file
-    end
-
-    def self.write_config vars
-      cm = comments
-      File.open config_file, 'w+' do |f|
-        f.write cm << "\n" << dump_config(vars)
-      end
-      log "Done."
-      log
-    end
-
-    def self.load_config
-      YAML.load(read_config) || Hash.new
-    end
-
-    def self.dump_config vars
-      YAML.dump(vars)
-    end
-
-    def self.comments
-      read_config.match(/(^\#.*\n)+/).to_s
-    end
-
-    def self.hashify str
-      arr = str.split('=') rescue []
-      hash = Hash.new
-      hash[arr[0]] = arr[1]
-      hash
-    end
-
-  end
-
-end

data/lib/exportr/railtie.rb

@@ -1,25 +0,0 @@
-require 'exportr/base'
-
-module Exportr
-  
-  class Railtie < Rails::Railtie
-
-    extend Exportr::Base
-
-    config.before_configuration do
-
-      if File.exists? config_file
-        config = YAML.load(File.open(config_file))
-        config.each_pair { |key,value| ENV[key] = value } if config
-      end
-
-      if File.exists? system_config_file
-        config = YAML.load(File.open(system_env_file))
-        config.each_pair { |key,value| ENV[key] = value } if config
-      end
-
-    end
-
-  end
-
-end