higo 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6ef0dc27690d5b9720eb4c3266c4bf653c35df9
+  data.tar.gz: d0437735de76419825f3e8eb3f32159c830039f1
+SHA512:
+  metadata.gz: 4bdf1616d5634ef5e5955b12e6b1f5447ce76f1a0f9b56feb2e6cd8668da7cc504b08a4e906e3a8c67d78a88ad49ce4880b7b05d3bc4e1b28c15f67caabbf0e8
+  data.tar.gz: 32466bf5747e206bc9f0d64ce68d863b2a81949625cac0d1c9d6137e01fb663ab0cb9bff2b3e311fc2c3a9302727a2674ee970c982d902b4ce1eb0e79918cb21

data/README.md

@@ -0,0 +1,51 @@
+# Higo
+
+## Get started
+`gem install higo`
+
+Detailed usage examples can be found in the `/examples` directory.
+
+## Gem Story - TL;DR
+Higo creates 'config' objects dynamic using the well understood `configure` block:
+
+    class ConfigureFoo
+      configure do |conf|
+          conf.greatness = 'pending'
+          conf.host      = Hostname.new
+      end
+    end
+
+Except you don't _have_ to define those methods ahead of time.
+
+`Higo` creates __getter__ `(greatness)`, __setter__ `(host=)`and __predicate__ methods `(host?)`.
+
+## Gem Story -v
+`Higo` enables the developer to create `flexible` configuration objects. It returns a `Higo::Configurable` object with
+getter, setter and predicate methods based on the values passed to the block.
+
+Flexible meant two things (to me, at least). First, knowledge of the configuration values should not depend on static
+methods definition. Second, I prefer configuration that accepts multiple formats (like text, YAML)that could come from
+from remote sources.
+
+I settled on the name after finding that [fig](https://github.com/mfoemmel/fig), [figgy](https://github.com/pd/figgy)
+were taken. Sure I could've named it `figy`, but that would be too confusing. So I settled on `Higo`.
+
+
+__Note__-if you already defined `method_missing` in your class `Higo` will honor that and that is likely not what you
+want. Higo might now be right for you at this stage.
+
+### To Do List
+
+* ~~Generate arbitrary configuration values~~
+* Improve support for subclasses that define `method_missing`
+* Read from an external source
+* Improve documentation
+
+## Contributing
+If you are developing against this gem (yay!), run `bundle exec rake -T` for list of rake tasks.
+
+1. Fork it ( https://github.com/rhodee/higo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,40 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/test_*.rb'
+end
+
+namespace :stats do
+  Analyzers = [:flay, :flog, :reek]
+
+  desc 'Run flog to report your most tortured code'
+  task :flog do
+    puts "*" * 50
+    puts "Running flog..."
+    system './vendor/bundle/bin/flog -g lib/**'
+    puts " "
+  end
+
+  desc 'Run reek to examine ruby code for any code smells'
+  task :reek do
+    puts "*" * 50
+    puts "Running reek..."
+    system './vendor/bundle/bin/reek lib/**'
+    puts " "
+  end
+
+  desc 'Run flay for analyzing code for structural similarities.'
+  task :flay do
+    puts "*" * 50
+    puts "Running flay..."
+    system './vendor/bundle/bin/flay lib/**'
+    puts " "
+  end
+
+  desc 'Run tests and all analyzers'
+  task :all do
+    system 'bundle exec rake test'
+    Analyzers.each { |analyzer| Rake::Task["stats:#{analyzer}"].invoke }
+  end
+end

data/higo.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'higo/version'
+
+Gem::Specification.new do |s|
+  s.name          = "higo"
+  s.version       = Higo::Version::String
+  s.authors       = ["rhodee"]
+  s.email         = ["info@rhodee.us"]
+  s.summary       = %q{ A (soon) to be highly configurable configuration manager. }
+  s.description   = %q{ Configuration management gem. }
+  s.homepage      = "https://github.com/rhodee/higo"
+  s.license       = "MIT"
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  s.platform      = Gem::Platform::RUBY
+
+  s.files = Dir[
+      "LICENSE",
+      "AUTHORS",
+      "README.md",
+      "Rakefile",
+      "lib/**/*.rb",
+      "*.gemspec",
+      "test/**/*.rb"
+    ]
+
+  s.add_development_dependency "yard", "~> 0.8.7"
+  s.add_development_dependency "pry", "~> 0.9"
+  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "rake", "~> 10.1"
+  s.add_development_dependency "minitest", "~> 5.2"
+  s.add_development_dependency "reek", "~> 1.3"
+  s.add_development_dependency "flay", "~> 2.4"
+  s.add_development_dependency "flog", "~> 4.2"
+end

data/lib/higo/configurable.rb

@@ -0,0 +1,65 @@
+# Module can be subclass or composed to yields a Configurable object
+# that responds to any attributes defined inside the #configure block
+#
+module Higo
+    def self.included(mod)
+      mod.extend(Macros)
+    end
+
+  module Macros
+    def configure(&block)
+      configuration ||= Higo::Configurable.new
+      configuration.instance_eval(&block)
+      return configuration
+    end
+  end
+
+  class Configurable
+    # Takes any arbitrary code block which defines getter and setters and returns a Higo::Configurable
+    # object that returns instance variables, getter, setter and predicate methods
+    #
+    # @param [Proc]
+    # @return [Configurable] responds to getter, setter, predicate methods defined
+    def self.configure(&block)
+      configuration = generate_configurable
+      configuration.instance_eval(&block)
+      return configuration
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      super unless self.instance_variables.include?(convert_method_to_symbol(method_name))
+    end
+
+    # If an existing class defines, method_missing that incantation is run, otherwise
+    # all unknown methods are defined as getter, setters and predicate methods
+    def method_missing(meth, *args, &block)
+
+      if defined?(super)
+        klass = self.class
+        super(meth, *args, &block) if respond_to?(meth)
+
+        ivar = convert_method_to_symbol(meth)
+        data = args.size == 1 ? args.first : args
+
+        klass.__send__(:attr_accessor, ivar)
+        klass.__send__(:define_method, "#{ivar}?", proc { !!data })
+
+        instance_variable_set("@#{ivar}", data)
+
+        self
+      else
+        super
+      end
+    end
+
+
+    private
+      def convert_method_to_symbol(meth)
+        meth.to_s.gsub('=', '').to_sym
+      end
+
+      def self.generate_configurable
+        configuration ||= Configurable.new
+      end
+  end
+end

data/lib/higo/version.rb

@@ -0,0 +1,10 @@
+module Higo
+    module Version
+      Major = 0
+      Minor = 0
+      Tiny  = 1
+      Pre   = "alpha"
+
+      String = [Major, Minor, Tiny, Pre].compact.join(".")
+    end
+end

data/lib/higo.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+#
+# Copyright 2014 Denis Rhoden Jr.
+#
+# 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.
+#
+# See https://github.com/rhodee/higo for updates.
+#
+module Higo
+  autoload :Version,          'higo/version'
+  autoload :Configurable,     'higo/configurable'
+end

data/test/test_configurable.rb

@@ -0,0 +1,13 @@
+require_relative './test_helper'
+require 'higo/configurable'
+
+class TestConfigurable < Higo::TestCase
+
+  def test_config_methods
+    @configuration =  Higo::Configurable.configure { |c| c.foo = 'meh' }
+
+    assert_includes @configuration.methods, :foo
+    assert_includes @configuration.methods, :foo?
+    assert_includes @configuration.methods, :foo=
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require File.expand_path("../lib/higo", File.dirname(__FILE__))
+
+# Load support files
+Dir.glob(File.expand_path('./support/*', File.dirname(__FILE__))) {|file| require file }
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+module Higo
+  class TestCase < Minitest::Test
+  end
+end

data/test/test_higo_inheritance.rb

@@ -0,0 +1,18 @@
+require_relative './test_helper'
+require 'higo/configurable'
+
+class Configurator; include Higo; end
+
+class TestHigoInheritance < Higo::TestCase
+
+  def test_config_methods
+    @configuration =  Configurator.configure do |conf|
+                        conf.username = 'meh'
+                        conf.records =  Object.new
+                      end
+
+    assert_includes @configuration.methods, :username
+    assert_includes @configuration.methods, :records?
+    assert_includes @configuration.methods, :records=
+  end
+end

data/test/test_higo_subclass.rb

@@ -0,0 +1,19 @@
+require_relative './test_helper'
+require 'higo/configurable'
+
+class Configurable < Higo::Configurable;end
+
+class TestHigoSubClass < Higo::TestCase
+
+  def test_config_methods
+    @configuration = Configurable.configure do |conf|
+                      conf.port = 8080
+                      conf.hostname = 'testing'
+                      conf.password = '$3(r3t'
+                    end
+
+    assert_includes @configuration.methods, :port
+    assert_includes @configuration.methods, :password?
+    assert_includes @configuration.methods, :hostname=
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: higo
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- rhodee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: " Configuration management gem. "
+email:
+- info@rhodee.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- higo.gemspec
+- lib/higo.rb
+- lib/higo/configurable.rb
+- lib/higo/version.rb
+- test/test_configurable.rb
+- test/test_helper.rb
+- test/test_higo_inheritance.rb
+- test/test_higo_subclass.rb
+homepage: https://github.com/rhodee/higo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A (soon) to be highly configurable configuration manager.
+test_files: []
+has_rdoc: