localconfig 0.2.0

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -0,0 +1,94 @@
+[]: {{{1
+
+    File        : README.md
+    Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+    Date        : 2013-09-01
+
+    Copyright   : Copyright (C) 2013  Felix C. Stegerman
+    Version     : v0.2.0
+
+[]: }}}1
+
+## Description
+[]: {{{1
+
+  [rb-]localconfig - local configuration for ruby (web) apps
+
+  localconfig makes it easy to load (additional) configuration files
+  from `~/.apps/<name>`, where name is determined by the current
+  directory.  You can easily require ruby files and load json and yaml
+  files from this directory.
+
+  Additionally, it allows rails applications to easily define
+  admin:exists and admin:create rake tasks to make it easier to
+  automate application setup.
+
+  Just about everything is configurable: see the docs.
+
+  For an example w/ rails, see
+  https://github.com/obfusk/localconfig-rails-example.
+
+[]: }}}1
+
+## Examples
+[]: {{{1
+
+Gemfile
+
+```
+gem 'localconfig', require: 'localconfig/rails'
+```
+
+config/localconfig.rb
+
+```ruby
+LocalConfig['rails'].configure do |c|
+  puts "env: #{c.env}, #{Rails.env}"
+  c.require 'init.rb'
+  c.load_json 'pg.json'
+  c.on_admin_exists do |username|
+    # ...
+  end
+  c.on_admin_create do |username, password, email|
+    # ...
+  end
+end
+```
+
+[]: }}}1
+
+## Specs & Docs
+[]: {{{1
+
+    $ rake spec
+    $ rake docs
+
+[]: }}}1
+
+## TODO
+[]: {{{1
+
+  * more specs/docs?
+  * ...
+
+[]: }}}1
+
+## License
+[]: {{{1
+
+  GPLv2 [1] or EPLv1 [2].
+
+[]: }}}1
+
+## References
+[]: {{{1
+
+  [1] GNU General Public License, version 2
+  --- http://www.opensource.org/licenses/GPL-2.0
+
+  [2] Eclipse Public License, version 1
+  --- http://www.opensource.org/licenses/EPL-1.0
+
+[]: }}}1
+
+[]: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )

data/Rakefile

@@ -0,0 +1,59 @@
+desc 'Run specs'
+task :spec do
+  sh 'rspec -c'
+end
+
+desc 'Run specs verbosely'
+task 'spec:verbose' do
+  sh 'rspec -cfd'
+end
+
+desc 'Run specs verbosely, view w/ less'
+task 'spec:less' do
+  sh 'rspec -cfd --tty | less -R'
+end
+
+desc 'Check for warnings'
+task :warn do
+  reqs = %w{ config }.map { |x| "-r localconfig/#{x}" } * ' '
+  sh "ruby -w -I lib #{reqs} -e ''"
+end
+
+desc 'Check for warnings in specs'
+task 'warn:spec' do
+  reqs = Dir['spec/**/*.rb'].sort.map { |x| "-r ./#{x}" } * ' '
+  sh "ruby -w -I lib -r rspec #{reqs} -e ''"
+end
+
+desc 'Check for warnings in specs (but not void context)'
+task 'warn:spec:novoid' do
+  sh 'rake warn:spec 2>&1 | grep -v "void context"'
+end
+
+desc 'Generate docs'
+task :docs do
+  sh 'yardoc | cat'
+end
+
+desc 'List undocumented objects'
+task 'docs:undoc' do
+  sh 'yard stats --list-undoc'
+end
+
+desc 'Cleanup'
+task :clean do
+  sh 'rm -rf .yardoc/ doc/ *.gem'
+end
+
+desc 'Build SNAPSHOT gem'
+task :snapshot do
+  v = Time.new.strftime '%Y%m%d%H%M%S'
+  f = 'lib/localconfig/version.rb'
+  sh "sed -ri~ 's!(SNAPSHOT)!\\1.#{v}!' #{f}"
+  sh 'gem build localconfig.gemspec'
+end
+
+desc 'Undo SNAPSHOT gem'
+task 'snapshot:undo' do
+  sh 'git checkout -- lib/localconfig/version.rb'
+end

data/lib/localconfig/admin.rb

@@ -0,0 +1,56 @@
+# --                                                            ; {{{1
+#
+# File        : localconfig/admin.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-09-01
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'localconfig/config'
+
+# namespace
+module LocalConfig
+
+  class Config                                                  # {{{1
+
+    # set to true to disable rake tasks in railtie
+    attr_accessor :no_rake
+
+    # block will be run on admin_exists
+    def on_admin_exists(&b)
+      @admin_exists = b
+    end
+
+    # block will be run on admin_create
+    def on_admin_create(&b)
+      @admin_create = b
+    end
+
+    # run block set w/ on_admin_exists
+    def admin_exists(username)
+      @admin_exists[username]
+    end
+
+    # run block set w/ on_admin_create
+    def admin_create(username, password, email)
+      @admin_create[username, password, email]
+    end
+
+    # run admin_exists w/ $USERNAME
+    def admin_exists_from_env
+      admin_exists ENV['USERNAME']
+    end
+
+    # run admin_create w/ $USERNAME, $PASSWORD, $EMAIL
+    def admin_create_from_env
+      admin_create ENV['USERNAME'], ENV['PASSWORD'], ENV['EMAIL']
+    end
+
+  end                                                           # }}}1
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/localconfig/config.rb

@@ -0,0 +1,148 @@
+# --                                                            ; {{{1
+#
+# File        : localconfig/config.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-09-01
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'hashie/mash'
+require 'json'
+require 'yaml'
+
+# namespace
+module LocalConfig
+
+  CONFIGS = {}
+
+  # --
+
+  # configuration
+  class Config                                                  # {{{1
+
+    # dir
+    attr_accessor :dir
+
+    # name
+    attr_accessor :name
+
+    # set dir to ~/.apps, derive name
+    def initialize(opts = {})
+      @config = {}
+      @dir    = opts[:dir] || "#{Dir.home}/.apps"
+      @name   = opts[:name] || derive_name
+    end
+
+    # configure; self is passed to the block
+    # @return self
+    def configure(&b)
+      b[self]; self
+    end
+
+    # derive name
+    # @option opts [String]   :dir  (Dir.pwd)
+    # @option opts [<String>] :up   (%w{ app })
+    # @option opts [String]   :env  (ENV['LOCALCONFIG_NAME'])
+    # @return [String] env (if not empty) or basename of dir; if
+    #                  basename of dir in up, uses one dir up
+    def derive_name(opts = {})                                  # {{{2
+      dir = opts[:dir] || Dir.pwd; up = opts[:up] || %w{ app }
+      env = opts.fetch(:env) { ENV['LOCALCONFIG_NAME'] }
+      if env && !env.empty?
+        env
+      else
+        d, b = File.split dir; up.include?(b) ? File.basename(d) : b
+      end
+    end                                                         # }}}2
+
+    # `<dir>/<name>/...`
+    def path(*paths)
+      ([dir,name] + paths)*'/'
+    end
+
+    # glob in path
+    def glob(*args, &b)
+      Dir.chdir(path) { Dir.glob(*args, &b) }
+    end
+
+    # require relative to path
+    def require(*files)
+      _files(files).map { |f| Kernel.require f }
+    end
+
+    # load json file relative to path and store as Hashie::Mash in
+    # self.<basename>
+    def load_json(*files)
+      _load '.json', (-> x { JSON.parse x }), files
+    end
+
+    # load yaml file relative to path and store as Hashie::Mash in
+    # self.<basename>
+    def load_yaml(*files)
+      _load '.yaml', (-> x { YAML.load x }), files
+    end
+
+    # --
+
+    # LocalConfig.branch
+    def branch; LocalConfig.branch; end
+
+    # LocalConfig.env
+    def env; LocalConfig.env; end
+
+    # --
+
+    # files relative to path
+    def _files(files)
+      files.map { |f| "#{path}/#{f}" }
+    end
+
+    # load file relative to path and store as Hashie::Mash in
+    # self.<basename>
+    def _load(ext, parse, files)                                # {{{2
+      _files(files).each do |f|
+        b = File.basename f, ext
+        raise "@config[#{b}] already defined" if @config[b]
+        @config[b] = Hashie::Mash.new parse[File.read(f)]
+        define_singleton_method(b) { @config[b] }
+      end
+    end                                                         # }}}2
+
+  end                                                           # }}}1
+
+  # --
+
+  # get (new) Config by name
+  def self.[](name)
+    CONFIGS[name] ||= Config.new
+  end
+
+  # either the current git branch, '(HEAD)' for a detached head, or
+  # nil if not in a git repo; (cached);
+  #
+  # to use this in a Gemfile, you will need to have the localconfig
+  # gem installed locally before running bundle
+  def self.branch
+    @branch ||= _branch
+  end
+
+  # like Rails.env; (cached)
+  def self.env
+    @env ||= ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+  end
+
+  # --
+
+  # current git branch
+  def self._branch
+    c = 'git symbolic-ref -q HEAD 2>/dev/null'
+    b = %x[#{c}].chomp.sub %r{^refs/heads/}, ''
+    [0,1].include?($?.exitstatus) ? (b.empty? ? '(HEAD)' : b) : nil
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/localconfig/rails.rb

@@ -0,0 +1,29 @@
+# --                                                            ; {{{1
+#
+# File        : localconfig/rails.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-09-01
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'rails'
+
+require 'localconfig'
+
+# namespace
+module LocalConfig
+
+  # railtie that sets config.local to LocalConfig['rails'] and adds
+  # the rake tasks
+  class Railtie < Rails::Railtie
+    config.local = LocalConfig['rails']
+    rake_tasks { LocalConfig::Rake.define_tasks } \
+      unless LocalConfig['rails'].no_rake
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/localconfig/rake.rb

@@ -0,0 +1,47 @@
+# --                                                            ; {{{1
+#
+# File        : localconfig/rake.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-09-01
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'rake/dsl_definition'
+
+require 'localconfig/admin'
+
+# namespace
+module LocalConfig
+
+  # rake tasks
+  module Rake
+    extend ::Rake::DSL
+
+    # define rake tasks `<namespace>:{exists,create}` that use
+    # `LocalConfig[name].admin_{exists,create}_from_env`
+    #
+    # @option opts [String] :name      ('rails')
+    # @option opts [String] :namespace ('admin')
+    def self.define_tasks(opts = {})
+      name = opts[:name]      || 'rails'
+      ns   = opts[:namespace] || 'admin'
+
+      desc 'exit w/ status 2 if the admin user does not exist'
+      task "#{ns}:exists" => :environment do
+        exit 2 unless LocalConfig[name].admin_exists_from_env
+      end
+
+      desc 'create the admin user'
+      task "#{ns}:create" => :environment do
+        LocalConfig[name].admin_create_from_env
+      end
+    end
+
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/localconfig/version.rb

@@ -0,0 +1,4 @@
+module LocalConfig
+  VERSION = '0.2.0'
+  DATE    = '2013-09-01'
+end

data/lib/localconfig.rb

@@ -0,0 +1,15 @@
+# --                                                            ; {{{1
+#
+# File        : localconfig.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-09-01
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'localconfig/rake'
+require './config/localconfig'
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/localconfig.gemspec

@@ -0,0 +1,32 @@
+require File.expand_path('../lib/localconfig/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'localconfig'
+  s.homepage    = 'https://github.com/obfusk/rb-localconfig'
+  s.summary     = 'local configuration for ruby (web) apps'
+
+  s.description = <<-END.gsub(/^ {4}/, '')
+    local configuration for ruby (web) apps
+
+    ...
+  END
+
+  s.version     = LocalConfig::VERSION
+  s.date        = LocalConfig::DATE
+
+  s.authors     = [ 'Felix C. Stegerman' ]
+  s.email       = %w{ flx@obfusk.net }
+
+  s.licenses    = %w{ GPLv2 EPLv1 }
+
+  s.files       = %w{ .yardopts README.md Rakefile } \
+                + %w{ localconfig.gemspec } \
+                + Dir['{lib,spec}/**/*.rb']
+
+  s.add_runtime_dependency 'hashie'
+  s.add_runtime_dependency 'rake'
+
+  s.add_development_dependency 'rspec'
+
+  s.required_ruby_version = '>= 1.9.1'
+end

data/spec/localconfig/config_spec.rb

@@ -0,0 +1,98 @@
+# --                                                            ; {{{1
+#
+# File        : localconfig/config_spec.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-09-01
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'localconfig/config'
+
+lcc = LocalConfig::Config
+
+describe lcc do
+
+  apps  = "#{Dir.pwd}/test/apps"
+  d1    = "#{apps}/test1"
+  d2    = "#{apps}/test2"
+  d3    = "#{apps}/test3"
+  test1 = Dir.chdir('test/test1')     { lcc.new dir: apps }
+  test2 = Dir.chdir('test/test2/app') { lcc.new dir: apps }
+  test3 = Dir.chdir('test/test1') do
+    old = ENV['LOCALCONFIG_NAME']; ENV['LOCALCONFIG_NAME'] = 'test3'
+    x = lcc.new dir: apps; ENV['LOCALCONFIG_NAME'] = old; x
+  end
+
+  context 'dir, name, path' do                                  # {{{1
+    it 'test1 is OK' do
+      expect(test1.dir).to eq apps
+      expect(test1.name).to eq 'test1'
+      expect(test1.path).to eq d1
+    end
+    it 'test2 is OK' do
+      expect(test2.dir).to eq apps
+      expect(test2.name).to eq 'test2'
+      expect(test2.path).to eq d2
+    end
+    it 'test3 is OK' do
+      expect(test3.dir).to eq apps
+      expect(test3.name).to eq 'test3'
+      expect(test3.path).to eq d3
+    end
+  end                                                           # }}}1
+
+  context 'configure' do                                        # {{{1
+    it 'is passed self and returns self' do
+      x = nil
+      y = test1.configure { |c| x = c }
+      expect(x).to be test1
+      expect(y).to be test1
+    end
+  end                                                           # }}}1
+
+  context 'path' do                                             # {{{1
+    it 'joins' do
+      expect(test1.path 'foo', 'bar').to eq "#{d1}/foo/bar"
+    end
+  end                                                           # }}}1
+
+  context 'glob' do                                             # {{{1
+    it '* -> init.rb pg.json x.yaml' do
+      expect(test1.glob('*').sort).to eq \
+        %w{ init.rb pg.json x.yaml }
+    end
+    it '*.json -> pg.json' do
+      expect(test1.glob('*.json').sort).to eq %w{ pg.json }
+    end
+  end                                                           # }}}1
+
+  context 'require' do                                          # {{{1
+    it 'requires init.rb' do
+      old = $stdout; $stdout = out = StringIO.open('', 'w')
+      begin test1.require 'init.rb' rescue $stdout = old end
+      expect(out.string).to eq "init!\n"
+    end
+  end                                                           # }}}1
+
+  context 'load_json' do                                        # {{{1
+    it 'loads pg.json' do
+      x = test1.dup; x.load_json 'pg.json'
+      expect(x.pg.to_hash).to eq \
+        ({ 'database' => 'foo', 'username' => 'foo',
+           'password' => 'bar' })
+    end
+  end                                                           # }}}1
+
+  context 'load_yaml' do                                        # {{{1
+    it 'loads x.yaml' do
+      x = test1.dup; x.load_yaml 'x.yaml'
+      expect(x.x.to_hash).to eq({ 'foo' => 99, 'bar' => 'hi!' })
+    end
+  end                                                           # }}}1
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: localconfig
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Felix C. Stegerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &19213920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19213920
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &19212440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *19212440
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &19209980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19209980
+description: ! 'local configuration for ruby (web) apps
+
+
+  ...
+
+'
+email:
+- flx@obfusk.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .yardopts
+- README.md
+- Rakefile
+- localconfig.gemspec
+- lib/localconfig/rake.rb
+- lib/localconfig/version.rb
+- lib/localconfig/rails.rb
+- lib/localconfig/config.rb
+- lib/localconfig/admin.rb
+- lib/localconfig.rb
+- spec/localconfig/config_spec.rb
+homepage: https://github.com/obfusk/rb-localconfig
+licenses:
+- GPLv2
+- EPLv1
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: local configuration for ruby (web) apps
+test_files: []
+has_rdoc: