localconfig 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69720f49e2aaf298ba101c6cf4b62d19896ccabc
+  data.tar.gz: 08cdc94023f7e7c30c61d0b876c109c625806786
+SHA512:
+  metadata.gz: 899ffc8ed6c89e921ba45511ef76a3f93e3bb166b819916f19e5ce71afb05502c9dd2d4eeda10da6797008bba7f1bd1907cae4cfef854a097bf436ed4f2e7dda
+  data.tar.gz: 5056aaf7eb5d76e79a57619a989ca3d47dc040a64e2959f35ce34972473f7e958dacb287a26ec1d8b81ae34eb938957bbc6d860df614762eca57f31743e1b9e9

data/README.md

@@ -2,13 +2,15 @@
 
     File        : README.md
     Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-    Date        : 2013-09-01
+    Date        : 2014-10-21
 
-    Copyright   : Copyright (C) 2013  Felix C. Stegerman
-    Version     : v0.2.0
+    Copyright   : Copyright (C) 2014  Felix C. Stegerman
+    Version     : v0.3.0
 
 []: }}}1
 
+[![Gem Version](https://badge.fury.io/rb/localconfig.png)](https://rubygems.org/gems/localconfig)
+
 ## Description
 []: {{{1
 
@@ -20,7 +22,7 @@
   files from this directory.
 
   Additionally, it allows rails applications to easily define
-  admin:exists and admin:create rake tasks to make it easier to
+  `admin:exists` and `admin:create` rake tasks to make it easier to
   automate application setup.
 
   Just about everything is configurable: see the docs.
@@ -33,19 +35,24 @@
 ## Examples
 []: {{{1
 
-Gemfile
-
-```
+```ruby
+# Gemfile
 gem 'localconfig', require: 'localconfig/rails'
 ```
 
-config/localconfig.rb
-
 ```ruby
+# config/localconfig.rb
 LocalConfig['rails'].configure do |c|
   puts "env: #{c.env}, #{Rails.env}"
+
   c.require 'init.rb'
+
   c.load_json 'pg.json'
+  c.load_yaml 'git.yml'   # repo:, branch:
+  c.git_repo 'more', c.git.repo, branch: c.git.branch
+  c.load_dir 'more'       # more/foo.yml, more/bar.json
+  puts "more: #{c.more.foo.key1} #{c.more.bar.key2}"
+
   c.on_admin_exists do |username|
     # ...
   end
@@ -58,37 +65,24 @@ end
 []: }}}1
 
 ## Specs & Docs
-[]: {{{1
 
-    $ rake spec
-    $ rake docs
-
-[]: }}}1
+```bash
+rake spec
+rake docs
+```
 
 ## TODO
-[]: {{{1
 
   * more specs/docs?
   * ...
 
-[]: }}}1
-
 ## License
-[]: {{{1
 
-  GPLv2 [1] or EPLv1 [2].
-
-[]: }}}1
+  LGPLv3+ [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
+  [1] GNU Lesser General Public License, version 3
+  --- http://www.gnu.org/licenses/lgpl-3.0.html
 
 []: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )

data/lib/localconfig.rb

@@ -2,10 +2,10 @@
 #
 # File        : localconfig.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-09-01
+# Date        : 2014-10-21
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2 or EPLv1
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/lib/localconfig/admin.rb

@@ -2,10 +2,10 @@
 #
 # File        : localconfig/admin.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-09-01
+# Date        : 2014-10-21
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2 or EPLv1
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/lib/localconfig/config.rb

@@ -2,10 +2,10 @@
 #
 # File        : localconfig/config.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-09-01
+# Date        : 2014-10-21
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2 or EPLv1
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 
@@ -23,6 +23,9 @@ module LocalConfig
   # configuration
   class Config                                                  # {{{1
 
+    # something went wrong calling `system`
+    class RunError < StandardError; end
+
     # dir
     attr_accessor :dir
 
@@ -36,6 +39,11 @@ module LocalConfig
       @name   = opts[:name] || derive_name
     end
 
+    # access setting by key
+    def [](k)
+      @config[k.to_s]
+    end
+
     # configure; self is passed to the block
     # @return self
     def configure(&b)
@@ -58,7 +66,7 @@ module LocalConfig
       end
     end                                                         # }}}2
 
-    # `<dir>/<name>/...`
+    # `dir/name/...`
     def path(*paths)
       ([dir,name] + paths)*'/'
     end
@@ -70,21 +78,94 @@ module LocalConfig
 
     # require relative to path
     def require(*files)
-      _files(files).map { |f| Kernel.require f }
+      _files(files).each { |f| Kernel.require f[:path] }
+      nil
     end
 
     # load json file relative to path and store as Hashie::Mash in
-    # self.<basename>
+    # self; for example:
+    #
+    # ```
+    # lc.load_json 'foo.json'
+    # lc.foo.key1
+    # lc.load_json 'bar/baz.json'
+    # lc.bar.baz.key2
+    # ```
     def load_json(*files)
-      _load '.json', (-> x { JSON.parse x }), files
+      _load %w{ .json }, (-> x { JSON.parse x }), files
     end
 
     # load yaml file relative to path and store as Hashie::Mash in
-    # self.<basename>
+    # self; for example:
+    #
+    # ```
+    # lc.load_yaml 'foo.yaml'
+    # lc.foo.key1
+    # lc.load_yaml 'bar/baz.yml'
+    # lc.bar.baz.key2
+    # ```
     def load_yaml(*files)
-      _load '.yaml', (-> x { YAML.load x }), files
+      _load %w{ .yml .yaml }, (-> x { YAML.load x }), files
+    end
+
+    # `load_{json,yaml}` `*.json`, `*.y{a,}ml` in dir; for example:
+    #
+    # ```
+    # lc.load_dir 'more'  # more/foo.json, more/bar.yml
+    # lc.more.foo.key1
+    # lc.more.bar.key2
+    # ```
+    def load_dir(*dirs)
+      dirs.flat_map do |d|
+        j = glob "#{d}/*.json"; y = glob "#{d}/*.y{a,}ml"
+        load_json *j; load_yaml *y; j + y
+      end
     end
 
+    # <!-- {{{1 -->
+    #
+    # clone/fetch git repo in dir (to load more config files from
+    # elsewhere); for example:
+    #
+    # ```
+    # lc.load_yaml 'git.yml'  # repo:, branch:
+    # lc.git_repo 'more', c.git.repo, branch: c.git.branch
+    # lc.load_dir 'more'      # more/foo.yml, more/bar.json
+    # ```
+    #
+    # You can't use more than one of `:rev`, `:tag`, `:branch`; if you
+    # specify none, the default is `branch: 'master'`.
+    #
+    # @param [String] path  subpath to clone to
+    # @param [String] url   url to clone from
+    #
+    # @param [Hash] opts options
+    # @option opts [Bool]   :quiet  (true)  whether to be quiet
+    # @option opts [String] :rev            specific revision (SHA1)
+    # @option opts [String] :tag            specific tag
+    # @option opts [String] :branch         specific branch
+    #
+    # <!-- }}}1 -->
+    def git_repo(path, url, opts = {})                          # {{{1
+      q       = opts.fetch(:quiet, true) ? %w{ --quiet } : []
+      b       = opts[:branch]; b = "origin/#{b}" if b && !b['/']
+      rev     = opts[:rev] || opts[:tag]
+      ref     = rev || b || 'origin/master'
+      dest    = path path
+      if File.exist? dest
+        Dir.chdir(dest) do
+          _sys *(%w{ git fetch --force --tags } + q) \
+            unless rev && %x[ git rev-parse HEAD ] ==
+                          %x[ git rev-parse --revs-only #{rev}^0 -- ]
+        end
+      else
+        _sys *(%w{ git clone } + q + [url, dest])
+      end
+      Dir.chdir(dest) do
+        _sys *(%w{ git reset --hard } + q + [ref] + %w{ -- })
+      end
+    end                                                         # }}}1
+
     # --
 
     # LocalConfig.branch
@@ -97,20 +178,31 @@ module LocalConfig
 
     # files relative to path
     def _files(files)
-      files.map { |f| "#{path}/#{f}" }
+      files.map { |f| { f: f, path: "#{path}/#{f}" } }
     end
 
-    # load file relative to path and store as Hashie::Mash in
-    # self.<basename>
-    def _load(ext, parse, files)                                # {{{2
+    # load file relative to path and store as Hashie::Mash in self
+    def _load(exts, 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] }
+        *pre, b = all = Pathname.new(f[:f]).each_filename.to_a
+        ext     = exts.find { |x| b.end_with? x } || ''
+        k       = File.basename b, ext  ; c_k = (pre+[k]).first
+        o       = @config
+        pre.each { |x| o = o[x] ||= Hashie::Mash.new }
+        raise "self.#{(pre+[k])*'.'} already set" if o[k]
+        o[k]    = Hashie::Mash.new parse[File.read(f[:path])]
+        define_singleton_method(c_k) { @config[c_k] } \
+          unless self.respond_to? c_k
       end
+      nil
     end                                                         # }}}2
 
+    # run!
+    def _sys(cmd, *args)
+      system([cmd, cmd], *args) or \
+        raise RunError, "failed to run command #{[cmd]+args} (#$?)"
+    end
+
   end                                                           # }}}1
 
   # --

data/lib/localconfig/rails.rb

@@ -2,10 +2,10 @@
 #
 # File        : localconfig/rails.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-09-01
+# Date        : 2014-10-21
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2 or EPLv1
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/lib/localconfig/rake.rb

@@ -2,10 +2,10 @@
 #
 # File        : localconfig/rake.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-09-01
+# Date        : 2014-10-21
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2 or EPLv1
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

data/lib/localconfig/version.rb

@@ -1,4 +1,4 @@
 module LocalConfig
-  VERSION = '0.2.0'
-  DATE    = '2013-09-01'
+  VERSION = '0.3.0'
+  DATE    = '2014-10-21'
 end

data/localconfig.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.authors     = [ 'Felix C. Stegerman' ]
   s.email       = %w{ flx@obfusk.net }
 
-  s.licenses    = %w{ GPLv2 EPLv1 }
+  s.licenses    = %w{ LGPLv3+ }
 
   s.files       = %w{ .yardopts README.md Rakefile } \
                 + %w{ localconfig.gemspec } \

data/spec/localconfig/config_spec.rb

@@ -2,10 +2,10 @@
 #
 # File        : localconfig/config_spec.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2013-09-01
+# Date        : 2014-10-21
 #
-# Copyright   : Copyright (C) 2013  Felix C. Stegerman
-# Licence     : GPLv2 or EPLv1
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
 #
 # --                                                            ; }}}1
 

metadata

@@ -1,97 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: localconfig
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Felix C. Stegerman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-01 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &19213920 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19213920
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &19212440 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19212440
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19209980 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19209980
-description: ! 'local configuration for ruby (web) apps
-
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  local configuration for ruby (web) apps
 
   ...
-
-'
 email:
 - flx@obfusk.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .yardopts
+- ".yardopts"
 - README.md
 - Rakefile
-- localconfig.gemspec
+- lib/localconfig.rb
+- lib/localconfig/admin.rb
+- lib/localconfig/config.rb
+- lib/localconfig/rails.rb
 - lib/localconfig/rake.rb
 - lib/localconfig/version.rb
-- lib/localconfig/rails.rb
-- lib/localconfig/config.rb
-- lib/localconfig/admin.rb
-- lib/localconfig.rb
+- localconfig.gemspec
 - spec/localconfig/config_spec.rb
 homepage: https://github.com/obfusk/rb-localconfig
 licenses:
-- GPLv2
-- EPLv1
+- LGPLv3+
+metadata: {}
 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
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: local configuration for ruby (web) apps
 test_files: []
 has_rdoc: