ablerc 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ablerc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Spencer Markowski
+
+MIT License
+
+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 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

@@ -0,0 +1,121 @@
+ablerc
+======
+
+Add "rc" capabilities into your ruby libraries
+
+Installation
+------
+
+```ruby
+gem 'ablerc'
+```
+
+Usage
+------
+
+Add an ablerc.rb file to the root of your project. 
+
+If you use the option DSL you will be able to generate stub rc files and validate option values. However, you're free to 
+simply provide an `rc_file_name` and any option defined in that rc file will be available to you. 
+
+The scheme will control how your application's options are loaded and in what order.
+
+```ruby
+Ablerc.setup do 
+  # The name of the file to be used for the configuration of this app
+  # Include a dot if you expect hidden file behavior. 
+  rc_file_name = '.ablerc'
+  
+  # Describes the order in which configuration files are loaded. 
+  # Default is <tt>:global</tt>, <tt>:user</tt>, <tt>:local</tt> which 
+  # will search for <tt>rc_file_name</tt> in these directories:
+  #   /etc/.ablerc
+  #   ~/.ablerc
+  #  ./.ablerc
+  #
+  # Configuration options cascade and override previously loaded options. 
+  scheme :global, :user, :local
+  
+  # Describe the options available
+  # 
+  # ==== Parameters
+  # * <tt>name</tt>  - A valid name for the option
+  # * <tt>behaviors</tt>  - Behaviors used to for this option
+  # * <tt>block</tt>   - A proc that should be run against the option value.
+  # ==== Options
+  # * <tt>allow</tt>  - The option value must be in this list
+  # * <tt>boolean</tt>  - The option will accept <tt>true</tt>, <tt>false</tt>, <tt>0</tt>, <tt>1</tt>
+  option :username, :description => "Your github username", :disabled => true
+  option :color, :allow => [:red, :green, :blue], :default => :red
+  option :save_on_exit, :boolean
+  option :seven_digit_number do |number|
+    number =~ ^\d{7}$
+  end
+  option :memory_limit, :default => '10G', :description => 'If memory usage exceeds 10G the internet reboots'
+end
+```
+
+Accessing Configuration Options
+----------
+Options defined in the rc file are accessed through the `#configuration` method. All uncommented key-pair values within the rc file are parsed and made available through `#configuration` (or the alias `#config`), regardless of if you're using
+the options DSL to define specific options. 
+
+
+```ruby
+Ablerc.configuration.username 
+#=> "esmarkowski"
+
+Ablerc.configuration 
+#=> {username: 'esmarkowski', color: 'red', save_on_exit: true, seven_digit_number: '1234567'}
+```
+
+Options DSL
+----------
+
+### option(:name, behaviors = {})
+
+| Option Behaviors | Description |
+| ------------ | ------------ |
+| `:allow`  | An array of valid values. |
+|  `:refuse` | An array of invalid values. |
+|  `:boolean` | Only allows option to accept true, false, 1 or 0 |
+|  `:default` | The default value of this option |
+|  `:description` | Printed above the option as a comment |
+|  `:disabled`  | Controls if option is commented out in rc file |
+
+
+Providing Stub Configuration Files
+----------
+If you're using the option DSL you can expose `Ablerc.stub.generate` via
+a rake task. `Ablerc.stub.generate` 
+accepts an optional scheme argument if you wish to place the rc file in a specific context. 
+
+```ruby
+namespace :your_app do
+  task :stub
+    Ablerc.stub.generate :local
+  end
+end
+```
+
+Running this task will place your rc file in the local context (`./.ablerc`) and describe available options.
+
+```conf
+# Your github username.
+#username = ''
+
+# color accepts :red, :blue or :green
+#color = 'red'
+
+# save_on_exit accepts true, false, 1 or 0
+#save_on_exit = false
+
+#seven_digit_number = ''
+
+# If memory usage exceeds 10G the internet reboots
+memory_limit = 10G
+```
+
+License
+-------
+MIT License. Copyright 2012 The Able Few, LLC. http://theablefew.com

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ablerc.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ablerc/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ablerc"
+  gem.version       = Ablerc::VERSION
+  gem.authors       = ["Spencer Markowski"]
+  gem.email         = ["spencer@theablefew.com"]
+  gem.description   = %q{Provides cascading configuration files and helpers for generating configuration stubs.}
+  gem.summary       = %q{Quickly add "rc" capabilities into your ruby applications.}
+  gem.homepage      = "http://github.com/theablefew/ablerc"
+
+  gem.add_dependency "hashie"
+  gem.add_dependency "rainbow"
+  gem.add_dependency "activesupport"
+  #gem.add_development_dependency ""
+
+  gem.files         = `git ls-files`.split($/)
+  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"]
+end

data/lib/ablerc.rb

@@ -0,0 +1,97 @@
+require "ablerc/version"
+require "active_support/core_ext"
+require "rainbow"
+
+module Ablerc
+  autoload :Option,           'ablerc/option'
+  autoload :DSL,              'ablerc/dsl'
+  autoload :Context,          'ablerc/context'
+  autoload :Configuration,    'ablerc/configuration'
+  autoload :StubGenerator,    'ablerc/stub_generator'
+  autoload :Errors,           'ablerc/errors'
+
+
+  ABLE_RC_FILE      =   'able.rc'
+
+
+  mattr_accessor :scheme
+  self.scheme = []
+
+
+  mattr_accessor :options
+  self.options = []
+
+
+  mattr_accessor :rc_file_name
+  self.rc_file_name = ''
+
+
+  mattr_accessor :dsl
+  self.dsl = Ablerc::DSL.new
+
+
+  mattr_accessor :contexts
+  self.contexts = Ablerc::Context
+
+
+  mattr_accessor :stub_options
+  self.stub_options = {}
+
+
+  class << self
+
+
+    # Iniatializes Ablerc with values from DSL
+    def setup(&block)
+      Ablerc.dsl.instance_eval(&block)
+      scheme.each { |c| dsl.context(c, Ablerc::Context::DEFAULTS[c]) unless contexts.exists? c}
+    end
+
+
+    # Exposes option values from parsed rc files.
+    # Aliased as <tt>#config</tt>
+    def configuration
+      Ablerc::Configuration.instance
+    end
+
+
+    alias :config :configuration
+
+
+    # Prepares a stub rcfile with defined options
+    def stub
+      Ablerc::StubGenerator.new({:options => options}.merge(stub_options))
+    end
+
+
+    # Loads the rc files in the order and locations specified by scheme
+    def load_scheme
+      raise RcFileMissing, "You must provide a value to rc_file_name" if rc_file_name.blank?
+      self.scheme.each do |scheme|
+        configuration.load File.expand_path(File.join( contexts[scheme].path, rc_file_name))
+      end
+    end
+
+    def load!(path)
+      load_able_rc! File.expand_path( File.join( path, ABLE_RC_FILE))
+    end
+
+    private
+
+
+    def gem_root
+      File.expand_path '../..', __FILE__
+    end
+
+
+    def load_able_rc!(path)
+      instance_eval(File.read( path ))
+      load_scheme
+      return configuration
+    end
+  end
+
+  # Immediatly load options and rc file configurations
+  #load_able_rc!
+
+end

data/lib/ablerc/configuration.rb

@@ -0,0 +1,43 @@
+require 'hashie/mash'
+require 'singleton'
+
+module Ablerc
+  # Represents an rc file which consists
+  # of a series of key value pairs
+  class Configuration
+    include Singleton
+    attr_accessor :store
+
+
+    class << self
+      def load(path); self.instance.load(path); end
+    end
+
+
+    def read_values(&rc_file)
+      rc_file.call
+      yield(self)
+    end
+
+
+    def initialize
+      @store ||= Hashie::Mash.new
+    end
+
+
+    def method_missing(method, *args, &block)
+       store.send(method, *args, &block)
+    end
+
+
+    def load(path)
+      return unless File.exists? path
+      self.instance_eval do
+        File.read(File.expand_path(path)).each_line do |line|
+          next if line =~ /^[?\s]*\#/ || line.blank?
+          store.instance_eval("self."+line)
+        end
+      end
+    end
+  end
+end

data/lib/ablerc/context.rb

@@ -0,0 +1,53 @@
+require 'hashie/mash'
+module Ablerc
+  class Context
+
+    DEFAULTS = {global: {path: '/etc/'},
+                user:   {path: '~/'},
+                local:  {path: './'}}
+
+
+    attr_accessor :path, :name
+
+
+    def initialize(name, options={})
+      @name = name
+      @path = options.delete(:path)
+      Ablerc::Context << self
+    end
+
+
+    class << self
+
+      @@contexts = Hashie::Mash.new
+
+
+      def <<(context)
+        @@contexts.merge!(context.name => context)
+      end
+
+
+      def paths
+        @@contexts.collect { |name, context| context.path }
+      end
+
+
+      def list
+        @@contexts
+      end
+
+      def names
+        @@contexts.keys
+      end
+
+
+      def exists?(context)
+        @@contexts.has_key? context
+      end
+
+      def method_missing(method_name, *args, &block)
+        @@contexts.send(method_name, *args, &block) || super
+      end
+    end
+  end
+end

data/lib/ablerc/dsl.rb

@@ -0,0 +1,61 @@
+module Ablerc
+  class DSL
+
+
+    # The name of the file to be used for the configuration of this app
+    # Include a dot if you expect hidden file behavior. 
+    def rc_file_name(file_name)
+      Ablerc.rc_file_name = file_name
+    end
+
+
+    # Describes the order in which configuration files are loaded.
+    # Default is <tt>:global</tt>, <tt>:user</tt>, <tt>:local</tt> which
+    # will search for <tt>rc_file_name</tt> in these directories:
+    #   /etc/.ablerc
+    #   ~/.ablerc
+    #  ./.ablerc
+    #
+    # Configuration options cascade and override previously loaded options.
+    # scheme :global, :user, :local
+    def scheme(*contexts)
+      Ablerc.scheme = contexts
+    end
+
+
+    # Describe the options available
+    #
+    # ==== Parameters
+    # * <tt>name</tt>  - A valid name for the option
+    # * <tt>behaviors</tt>  - Behaviors used to for this option
+    # * <tt>block</tt>   - A proc that should be run against the option value.
+    # ==== Options
+    # * <tt>allow</tt>  - The option value must be in this list
+    # * <tt>boolean</tt>  - The option will accept <tt>true</tt>, <tt>false</tt>, <tt>0</tt>, <tt>1</tt>
+    def option(name, behaviors = {}, &block)
+      Ablerc.options << Ablerc::Option.new(name, behaviors, &block)
+    end
+
+
+    def context(name, options)
+      Ablerc::Context.new(name, options)
+    end
+
+    # Configures stub options for #generate
+    #
+    # ==== Options
+    # * <tt>header</tt>   - Text to be included at the beginning of the rc file
+    # * <tt>footer</tt>   - Text to be included at the end of the rc file
+    def stub(options)
+     Ablerc.stub_options = options
+    end
+
+
+    def method_missing(method_name, *args, &block)
+      raise "You tried to call the method #{method_name}. There is no such method."
+    end
+
+
+    def respond_to? *args; super; end
+  end
+end

data/lib/ablerc/errors.rb

@@ -0,0 +1,4 @@
+module Ablerc
+  class RcFileMissing < Exception; end
+  class AbleRCConfigMissing < Exception; end
+end

data/lib/ablerc/option.rb

@@ -0,0 +1,77 @@
+require 'hashie/dash'
+module Ablerc
+
+
+  # An option is a declared attribute within an rc file,
+  # in other words, an uncommented key-value pair.
+  #
+  # Options define how an attribute behaves (via behavior
+  # parameters), which are used to validate, explain and 
+  # control default values for the option.
+  class Option < Hashie::Dash
+
+
+    property :name, :required => true
+    attr_accessor :allows, :refuses, :boolean, :description, :default, :disabled
+
+    # Initialize the option
+    # 
+    # ==== Parameters
+    # * <tt>name</tt>  - A valid name for the option
+    # * <tt>behaviors</tt>  - Behaviors used to for this option
+    # * <tt>block</tt>   - A proc that should be run against the option value.
+    # ==== Options
+    # * <tt>allow</tt>  - The option value must be in this list
+    # * <tt>boolean</tt>  - The option will accept <tt>true</tt>, <tt>false</tt>, <tt>0</tt>, <tt>1</tt>
+    def initialize(name, behaviors = {}, &block)
+        self.name = name
+        extract_behaviors( behaviors )
+    end
+
+
+    def to_stub
+      stub = "## #{name}\n"
+      stub << "# #{description}\n" unless description.nil?
+      stub << "#{entry_for_refuse_allow_behavior}\n" unless refuses.nil? and allows.nil?
+      stub << "#{entry_for_key_value}\n"
+      stub << "\n"
+    end
+
+    private
+
+    def entry_for_key_value
+      line = ""
+      line << "# Default: #{default}\n" unless default.nil?
+      line << "#" if disabled
+      line << "#{name} = "
+      line << default unless default.nil?
+      line
+    end
+
+
+    def entry_for_boolean
+      line = ""
+      line << "# Accepts boolean values of true, false, 0 or 1" unless boolean.nil?
+      line
+    end
+
+
+    def entry_for_refuse_allow_behavior
+      line = ""
+      line << "# Allows \n# #{allows.join(',')}" unless allows.nil?
+      line << "# Refuses \n# #{refuses.join(',')}" unless refuses.nil?
+      line
+    end
+
+    def extract_behaviors(behaviors)
+      behaviors.tap do |b|
+        self.allows        = b.delete :allow
+        self.refuses       = b.delete :refuses
+        self.boolean       = b.delete :boolean
+        self.description   = b.delete :description
+        self.default       = b.delete :default
+        self.disabled      = b.delete(:disabled) || true
+      end
+    end
+  end
+end

data/lib/ablerc/stub_generator.rb

@@ -0,0 +1,44 @@
+module Ablerc
+  class StubGenerator
+
+    attr_accessor :options, :path, :header, :footer
+
+
+    def initialize(options)
+      self.header = options.delete :header
+      self.footer = options.delete :footer
+      self.options = options.delete :options
+    end
+
+
+    def generate(context = nil)
+      begin
+        context ||= Ablerc.contexts.names.last.to_sym
+        path = File.expand_path(Ablerc.contexts.send(context.to_sym).path)
+      rescue
+        raise "Context does not exist"
+      end
+
+      puts "Generating Stub for #{context} in #{path + '/' + Ablerc.rc_file_name}".color :green
+
+      begin
+        File.open(path + '/' + Ablerc.rc_file_name, 'w') do |rc_file|
+          rc_file << header.to_s unless header.nil?
+          self.options.each do |option|
+            rc_file << option.to_stub
+          end
+          rc_file << footer.to_s unless footer.nil?
+        end
+      rescue e
+        puts "Error".color :red
+        puts e
+      end
+
+      true
+    end
+
+    def write_description(description)
+    end
+
+  end
+end

data/lib/ablerc/version.rb

@@ -0,0 +1,3 @@
+module Ablerc
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: ablerc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Spencer Markowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides cascading configuration files and helpers for generating configuration
+  stubs.
+email:
+- spencer@theablefew.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ablerc.gemspec
+- lib/ablerc.rb
+- lib/ablerc/configuration.rb
+- lib/ablerc/context.rb
+- lib/ablerc/dsl.rb
+- lib/ablerc/errors.rb
+- lib/ablerc/option.rb
+- lib/ablerc/stub_generator.rb
+- lib/ablerc/version.rb
+homepage: http://github.com/theablefew/ablerc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Quickly add "rc" capabilities into your ruby applications.
+test_files: []